Invitation Deletion
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 Deletion resource to access membership invitations that you've received and declined, and to delete one or more of those invitations. If you accepted an invitation to join your current organization, you cannot delete that invitation.
To delete an invitation, you have to specify the account ID for the AWS account that sent the invitation. To find this ID, 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.
| Status code | Response model | Description |
|---|---|---|
200 | DeleteInvitationsResponse | 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 accountIds": [ "string" ] }
Response bodies
{ "unprocessedAccounts unprocessedAccounts": [ { "accountId accountId": "string", "errorCode errorCode": enum, "errorMessage errorMessage": "string" } ] }
{ "message message": "string" }
{ "message message": "string" }
{ "message message": "string" }
{ "message message": "string" }
{ "message message": "string" }
{ "message message": "string" }
{ "message 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. |
message
The explanation of the error that occurred.
Type: string
Required: False
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. |
message
The explanation of the error that occurred.
Type: string
Required: False
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. |
accountIds
An array that lists AWS account IDs, one for each account that sent an invitation to delete.
Type: Array of type string
Required: True
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. |
unprocessedAccounts
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.
Type: Array of type UnprocessedAccount
Required: False
ErrorCode
The source of an issue or delay. Possible values are:
ClientErrorInternalError
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. |
message
The explanation of the error that occurred.
Type: string
Required: False
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. |
message
The explanation of the error that occurred.
Type: string
Required: False
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. |
message
The explanation of the error that occurred.
Type: string
Required: False
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. |
message
The explanation of the error that occurred.
Type: string
Required: False
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 | False | The source of the issue or delay in processing the request. | |
errorMessage | string | False | The reason why the request hasn't been processed. |
accountId
The AWS account ID for the account that the request applies to.
Type: string
Required: False
errorMessage
The reason why the request hasn't been processed.
Type: string
Required: False
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. |
message
The explanation of the error that occurred.
Type: string
Required: False
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: