URI HTTP methods Schemas Properties See also

Administrator

If your account is an Amazon Macie member account in an organization, the Administrator resource provides information about the Macie administrator account for your account. If you joined the organization by accepting a Macie membership invitation, this resource also provides information about that invitation. For information about the relationship between your account and its Macie administrator account, see Managing multiple accounts in the Amazon Macie User Guide.

You can use the Administrator resource to retrieve information about the Macie administrator account for your account.

URI

/administrator

HTTP methods

GET

Operation ID: GetAdministratorAccount

Retrieves information about the Amazon Macie administrator account for an account.

Responses
Status code	Response model	Description
`200`	`GetAdministratorAccountResponse`	The request succeeded.
`400`	`ValidationException`	The request failed because the input doesn't satisfy the constraints specified by the service.
`402`	`ServiceQuotaExceededException`	The request failed because fulfilling the request would exceed one or more service quotas for your account.
`403`	`AccessDeniedException`	The request was denied because you don't have sufficient access to the specified resource.
`404`	`ResourceNotFoundException`	The request failed because the specified resource wasn't found.
`409`	`ConflictException`	The request failed because it conflicts with the current state of the specified resource.
`429`	`ThrottlingException`	The request failed because you sent too many requests during a certain amount of time.
`500`	`InternalServerException`	The request failed due to an unknown internal server error, exception, or failure.

Schemas

Response bodies


{
  "administrator": {
    "accountId": "string",
    "invitationId": "string",
    "invitedAt": "string",
    "relationshipStatus": enum
  }
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}

Properties

AccessDeniedException

Provides information about an error that occurred due to insufficient access to a specified resource.

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.

ConflictException

Provides information about an error that occurred due to a versioning conflict for a specified resource.

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.

GetAdministratorAccountResponse

Provides information about the Amazon Macie administrator account for an account. If the accounts are associated by a Macie membership invitation, the response also provides information about that invitation.

Property	Type	Required	Description
`administrator`	Invitation	False	The AWS account ID for the administrator account. If the accounts are associated by an Amazon Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.

InternalServerException

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.

Invitation

Provides information about an Amazon Macie membership invitation.

Property	Type	Required	Description
`accountId`	string	False	The AWS account ID for the account that sent the invitation.
`invitationId`	string	False	The unique identifier for the invitation.
`invitedAt`	string Format: date-time	False	The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.
`relationshipStatus`	RelationshipStatus	False	The status of the relationship between the account that sent the invitation and the account that received the invitation.

RelationshipStatus

The current status of the relationship between an account and an associated Amazon Macie administrator account. Possible values are:

Enabled
Paused
Invited
Created
Removed
Resigned
EmailVerificationInProgress
EmailVerificationFailed
RegionDisabled
AccountSuspended

ResourceNotFoundException

Provides information about an error that occurred because a specified resource wasn't found.

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.

ServiceQuotaExceededException

Provides information about an error that occurred due to one or more service quotas for an account.

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.

ThrottlingException

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.

ValidationException

Provides information about an error that occurred due to a syntax error in a request.

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.