Master Account - Amazon Macie

Master Account

The Master Account resource provides information about the Amazon Macie master account for your account, as part of a Macie organization. If you joined the organization by accepting a Macie membership invitation, this resource also provides information about that invitation. After you join an organization, the master account can administer and manage certain Macie settings and resources on your behalf and the behalf of other members of the same organization.

You can use the Master Account resource to retrieve information about the Macie master account for your account. You can also use this resource to accept an invitation to join a Macie organization. If you do this, you have to specify the unique identifier for the invitation and the AWS account ID for the account that sent the invitation. To find these identifiers, you can use the Invitation List resource.

URI

/master

HTTP Methods

GET

Operation ID: GetMasterAccount

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

Responses
Status Code Response Model Description
200 GetMasterAccountResponse

The request succeeded.

400 ValidationException

The request failed because it contains a syntax error.

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

Example GetMasterAccountResponse

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

Example ValidationException

{ "message": "string" }

Example ServiceQuotaExceededException

{ "message": "string" }

Example AccessDeniedException

{ "message": "string" }

Example ResourceNotFoundException

{ "message": "string" }

Example ConflictException

{ "message": "string" }

Example ThrottlingException

{ "message": "string" }

Example InternalServerException

{ "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.

GetMasterAccountResponse

Provides information about the Amazon Macie master 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
master

Invitation

False

The AWS account ID for the master account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent and accepted 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 that was received by an account.

Property Type Required Description
accountId

string

False

The AWS account ID for the account that sent the invitation.

relationshipStatus

RelationshipStatus

False

The status of the relationship between the account that sent the invitation (inviter account) and the account that received the invitation (invitee account).

invitationId

string

False

The unique identifier for the invitation. Amazon Macie uses this identifier to validate the inviter account with the invitee account.

invitedAt

string

Format: date-time

False

The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.

RelationshipStatus

The current status of the relationship between an account and an associated Amazon Macie master account (inviter 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.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetMasterAccount