Invitation Count - Amazon Macie

Invitation Count

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 Count resource reports the total number of membership invitations that you've received. If you accepted an invitation and your account is currently part of a Macie organization, this number doesn't include that invitation. In addition, this number doesn't include invitations that you've received for AWS organizations. It's limited 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. To learn more about this service, see the AWS Organizations User Guide.

You can use the Invitation Count resource to retrieve the count of Macie membership invitations that you've received, not including the currently accepted invitation.

URI

/invitations/count

HTTP Methods

GET

Operation ID: GetInvitationsCount

Retrieves the count of Amazon Macie membership invitations that were received by an account.

Responses
Status Code Response Model Description
200 GetInvitationsCountResponse

The request succeeded.

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

Response Bodies

Example GetInvitationsCountResponse

{ "invitationsCount": integer }

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.

GetInvitationsCountResponse

Provides the count of all the Amazon Macie membership invitations that were received by an account, not including the currently accepted invitation.

Property Type Required Description
invitationsCount

integer

Format: int64

False

The total number of invitations that were received by the account, not including the currently accepted invitation.

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:

GetInvitationsCount