Member - Amazon Macie

Member

The Member resource provides information about an individual account that's associated with your Amazon Macie account, typically a Macie master account. This information includes details such as the AWS account ID for the account, and the current status of the relationship between your accounts. If you sent a Macie membership invitation to an account, this resource also indicates when you sent that invitation.

You can use the Member resource to retrieve information about an account that's associated with your Macie account. You can also use this resource to delete an existing association between your Macie account and another account. To use this resource, you have to specify the AWS account ID for the account that your request applies to. To find this ID, you can use the Member List resource.

URI

/members/id

HTTP Methods

GET

Operation ID: GetMember

Retrieves information about a member account that's associated with an Amazon Macie master account.

Path Parameters
Name Type Required Description
id String True

The unique identifier for the Amazon Macie resource or account that the request applies to.

Responses
Status Code Response Model Description
200 GetMemberResponse

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.

DELETE

Operation ID: DeleteMember

Deletes the association between an Amazon Macie master account and an account.

Path Parameters
Name Type Required Description
id String True

The unique identifier for the Amazon Macie resource or account that the request applies to.

Responses
Status Code Response Model Description
200 Empty Schema

The request succeeded. The association was deleted and there isn't any content to include in the body of the response (No Content).

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 GetMemberResponse

{ "accountId": "string", "relationshipStatus": enum, "arn": "string", "masterAccountId": "string", "email": "string", "tags": { }, "invitedAt": "string", "updatedAt": "string" }

Example Empty Schema

{ }

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.

Empty

The request succeeded and there isn't any content to include in the body of the response (No Content).

GetMemberResponse

Provides information about an account that's associated with an Amazon Macie master account.

Property Type Required Description
accountId

string

False

The AWS account ID for the account.

relationshipStatus

RelationshipStatus

False

The current status of the relationship between the account and the master account.

arn

string

False

The Amazon Resource Name (ARN) of the account.

masterAccountId

string

False

The AWS account ID for the master account.

email

string

False

The email address for the account.

tags

TagMap

False

A map of key-value pairs that identifies the tags (keys and values) that are associated with the member account in Amazon Macie.

invitedAt

string

Format: date-time

False

The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.

updatedAt

string

Format: date-time

False

The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the master account.

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.

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.

TagMap

A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.

Property Type Required Description

*

string

False

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:

GetMember

DeleteMember