Invitation Deletion - Amazon Macie

Invitation Deletion

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 Deletion resource provides access to membership invitations that you received and declined, and it enables you to delete one or more 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 Deletion resource to delete Macie membership invitations that you received from specific accounts and previously declined. If you do this, you have to specify the AWS account ID for each account that sent an invitation to delete. To find these IDs, you can use the Invitation List resource.

URI

/invitations/delete

HTTP Methods

POST

Operation ID: DeleteInvitations

Deletes Amazon Macie membership invitations that were received from specific accounts.

Responses
Status Code Response Model Description
200 DeleteInvitationsResponse

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

{ "accountIds": [ "string" ] }

Response Bodies

Example DeleteInvitationsResponse

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

DeleteInvitationsRequest

Specifies one or more accounts that sent Amazon Macie membership invitations to delete.

Property Type Required Description
accountIds

Array of type string

True

An array that lists AWS account IDs, one for each account that sent an invitation to delete.

DeleteInvitationsResponse

Provides information about unprocessed requests to delete Amazon Macie membership invitations that were received from specific accounts.

Property Type Required Description
unprocessedAccounts

Array of type UnprocessedAccount

False

An array of objects, one for each account whose invitation hasn't been deleted. Each object identifies the account and explains why the request hasn't been processed for that 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.

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:

DeleteInvitations