Invitation Acceptance - Amazon Macie

Invitation Acceptance

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 Amazon Macie accounts in the Amazon Macie User Guide.

You can use the Invitation Acceptance resource to access membership invitations that you've received and haven't responded to, and to accept one of those invitations. To accept an invitation, you have to specify the unique identifier for the invitation and the account ID for the AWS account that sent the invitation. To find these IDs, you can use the Invitation List resource.

URI

/invitations/accept

HTTP methods

POST

Operation ID: AcceptInvitation

Accepts an Amazon Macie membership invitation that was received from a specific account.

Responses
Status codeResponse modelDescription
200Empty Schema

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

400ValidationException

The request failed because it contains a syntax error.

402ServiceQuotaExceededException

The request failed because fulfilling the request would exceed one or more service quotas for your account.

403AccessDeniedException

The request was denied because you don't have sufficient access to the specified resource.

404ResourceNotFoundException

The request failed because the specified resource wasn't found.

409ConflictException

The request failed because it conflicts with the current state of the specified resource.

429ThrottlingException

The request failed because you sent too many requests during a certain amount of time.

500InternalServerException

The request failed due to an unknown internal server error, exception, or failure.

Schemas

Request bodies

{ "masterAccount": "string", "invitationId": "string", "administratorAccountId": "string" }

Response bodies

{ }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }

Properties

AcceptInvitationRequest

Specifies an Amazon Macie membership invitation to accept. In the request, you have to specify the ID for the AWS account that sent the invitation. Otherwise, a validation error occurs. To specify this ID, we recommend that you use the administratorAccountId property instead of the masterAccount property. The masterAccount property has been deprecated and is retained only for backward compatibility.

PropertyTypeRequiredDescription
administratorAccountId

string

False

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

invitationId

string

True

The unique identifier for the invitation to accept.

masterAccount

string

False

(Deprecated) The AWS account ID for the account that sent the invitation. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.

AccessDeniedException

Provides information about an error that occurred due to insufficient access to a specified resource.

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

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

InternalServerException

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

ResourceNotFoundException

Provides information about an error that occurred because a specified resource wasn't found.

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

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

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

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

AcceptInvitation