Invitation List - Amazon Macie

Invitation List

In Amazon Macie, an invitation, also referred to as a membership invitation, is a request to become a member of a Macie organization. A Macie organization is a set of Amazon Macie accounts that are created and managed as a group by using Macie.

The Invitation List resource provides information about all the membership invitations that you've received. For each invitation, this includes the unique identifier for the invitation, the AWS account ID for the account that sent it, and the current status of the relationship between your account and the account that sent it. This resource also enables you to send invitations to other accounts.

Note that this resource doesn't provide information about invitations for AWS organizations. It's limited to invitations for Macie organizations. An AWS organization is a set of AWS accounts that are managed as a group by using the AWS Organizations service. AWS Organizations is an account management service that enables administrators to consolidate and centrally manage multiple AWS accounts as a single organization. To learn more about this service, see the AWS Organizations User Guide.

You can use the Invitation List resource to retrieve information about all the Macie membership invitations that you've received. You can also use this resource to send a membership invitation to other accounts.

URI

/invitations

HTTP Methods

GET

Operation ID: ListInvitations

Retrieves information about all the Amazon Macie membership invitations that were received by an account.

Query Parameters
Name Type Required Description
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 ListInvitationsResponse

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: CreateInvitations

Sends an Amazon Macie membership invitation to one or more accounts.

Responses
Status Code Response Model Description
200 CreateInvitationsResponse

The request succeeded. Processing might not be complete.

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

{ "disableEmailNotification": boolean, "accountIds": [ "string" ], "message": "string" }

Response Bodies

Example ListInvitationsResponse

{ "invitations": [ { "accountId": "string", "relationshipStatus": enum, "invitationId": "string", "invitedAt": "string" } ], "nextToken": "string" }

Example CreateInvitationsResponse

{ "unprocessedAccounts": [ { "accountId": "string", "errorMessage": "string", "errorCode": enum } ] }

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.

CreateInvitationsRequest

Specifies the settings for an Amazon Macie membership invitation.

Property Type Required Description
disableEmailNotification

boolean

False

Specifies whether to send an email notification to the root user of each account that the invitation will be sent to. This notification is in addition to an alert that the root user receives in AWS Personal Health Dashboard. To send an email notification to the root user of each account, set this value to true.

accountIds

Array of type string

True

An array that lists AWS account IDs, one for each account to send the invitation to.

message

string

False

A custom message to include in the invitation. Amazon Macie adds this message to the standard content that it sends for an invitation.

CreateInvitationsResponse

Provides information about an unprocessed request to send an Amazon Macie membership invitation to a specific account.

Property Type Required Description
unprocessedAccounts

Array of type UnprocessedAccount

False

An array of objects, one for each account whose invitation hasn't been processed. Each object identifies the account and explains why the invitation hasn't been processed for the account.

ErrorCode

The source of an error, issue, or delay. Possible values are:

  • ClientError

  • InternalError

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.

ListInvitationsResponse

Provides information about all the Amazon Macie membership invitations that were received by an account.

Property Type Required Description
invitations

Array of type Invitation

False

An array of objects, one for each invitation that was received by the account.

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.

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.

UnprocessedAccount

Provides information about an account-related request that hasn't been processed.

Property Type Required Description
accountId

string

False

The AWS account ID for the account that the request applies to.

errorMessage

string

False

The reason why the request hasn't been processed.

errorCode

ErrorCode

False

The source of the issue or delay in processing the request.

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:

ListInvitations

CreateInvitations