URI HTTP methods Schemas Properties See also

Invitation List

In Amazon Macie, an invitation, also referred to as a membership invitation, is a request to become a member of an organization in Macie. An organization is a set of Macie accounts that are centrally managed as a group of related accounts. For more information, see Managing multiple accounts in the Amazon Macie User Guide.

You can use the Invitation List resource to retrieve information about all the Macie membership invitations that you've received and haven't deleted. For each invitation, this information includes:

The unique identifier for the invitation.
The account ID for the AWS account that sent the invitation.
The current status of the relationship between your account and the account that sent the invitation.

You can also use this resource to send a membership invitation to other AWS accounts. To send an invitation to another account, you first have to associate the account with your account. You can do this by using the Members resource.

URI

/invitations

HTTP methods

GET

Operation ID: ListInvitations

Retrieves information about 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 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.

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

Request bodies


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

Response bodies


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


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


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

CreateInvitationsRequest

Specifies the settings for an Amazon Macie membership invitation. When you send an invitation, Macie notifies the recipient by creating an AWS Health event for the recipient's account and, if Macie is already enabled for the account, displaying an Accounts badge and notification on the recipient's console. You can optionally notify the recipient by also sending the invitation as an email message.

Property	Type	Required	Description
`accountIds`	Array of type string	True	An array that lists AWS account IDs, one for each account to send the invitation to.
`disableEmailNotification`	boolean	False	Specifies whether to send the invitation as an email message. If this value is `false`, Amazon Macie sends the invitation (as an email message) to the email address that you specified for the recipient's account when you associated the account with your account. The default value is `false`.
`message`	string	False	Custom text to include in the email message that contains the invitation. The text can contain as many as 80 alphanumeric characters.

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

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.

ListInvitationsResponse

Provides information about 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 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.

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.
`errorCode`	ErrorCode	False	The source of the issue or delay in processing the request.
`errorMessage`	string	False	The reason why the request hasn't been processed.

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.