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 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 Acceptance resource provides access to membership invitations that you've received and haven't responded to, and it enables you to accept one of those invitations.

Note that this resource doesn't provide access to invitations for AWS organizations. It provides access only 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 Acceptance resource to accept a Macie membership invitation that you received. If you do this, you have to specify the AWS account ID for the account that sent the invitation, and the unique identifier for 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 Code Response Model Description
200 Empty Schema

The request succeeded 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

Request Bodies

Example POST

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

Response Bodies

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

AcceptInvitationRequest

Specifies an Amazon Macie membership invitation to accept.

Property Type Required Description
masterAccount

string

True

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

invitationId

string

True

The unique identifier for the invitation to accept.

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

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.

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.

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:

AcceptInvitation