Member List - Amazon Macie

Member List

The Member List resource provides information about all the accounts that are associated with your Amazon Macie account, typically a Macie master account. This includes member accounts, which are accounts that are part of your Macie organization, and non-member accounts. For each account, this resource provides 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.

The Member List resource also enables you to associate additional accounts with your Macie account. You can then invite those accounts to enable Macie and allow you to administer and manage certain Macie settings and resources on their behalf. If an invitation is accepted, your account is designated as the master account for a Macie organization. The account that accepted the invitation then becomes a member account of your Macie organization.

You can use the Member List resource to associate one or more accounts with your Macie account. You can also use this resource to retrieve information about the accounts that are currently associated with your Macie account.

URI

/members

HTTP Methods

GET

Operation ID: ListMembers

Retrieves information about the accounts that are associated with an Amazon Macie master account.

Query Parameters
Name Type Required Description
onlyAssociated String False

Specifies which accounts to include in the response, based on the status of an account's relationship with the master account. By default, the response includes only current member accounts. To include all accounts, set the value for this parameter to false.

nextToken String False

The nextToken string that specifies which page of results to return in a paginated response.

maxResults String False

The maximum number of items to include in each page of a paginated response.

Responses
Status Code Response Model Description
200 ListMembersResponse

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.

POST

Operation ID: CreateMember

Associates an account with an Amazon Macie master account.

Responses
Status Code Response Model Description
200 CreateMemberResponse

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

Request Bodies

Example POST

{ "account": { "accountId": "string", "email": "string" }, "tags": { } }

Response Bodies

Example ListMembersResponse

{ "nextToken": "string", "members": [ { "accountId": "string", "relationshipStatus": enum, "arn": "string", "masterAccountId": "string", "email": "string", "tags": { }, "invitedAt": "string", "updatedAt": "string" } ] }

Example CreateMemberResponse

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

AccountDetail

Specifies details for an account to associate with an Amazon Macie master account.

Property Type Required Description
accountId

string

True

The AWS account ID for the account.

email

string

True

The email address for the account.

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.

CreateMemberRequest

Specifies an account to associate with an Amazon Macie master account.

Property Type Required Description
account

AccountDetail

True

The details for the account to associate with the master account.

tags

TagMap

False

A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie.

An account can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

CreateMemberResponse

Provides information about a request to associate an account with an Amazon Macie master account.

Property Type Required Description
arn

string

False

The Amazon Resource Name (ARN) of the account that was associated with 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.

ListMembersResponse

Provides information about the accounts that are associated with an Amazon Macie master account.

Property Type Required Description
nextToken

string

False

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

members

Array of type Member

False

An array of objects, one for each account that's associated with the master account and meets the criteria specified by the onlyAssociated request parameter.

Member

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

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:

ListMembers

CreateMember