Macie2 / Client / list_invitations



Retrieves information about the Amazon Macie membership invitations that were received by an account.

See also: AWS API Documentation

Request Syntax

response = client.list_invitations(
  • maxResults (integer) – The maximum number of items to include in each page of a paginated response.

  • nextToken (string) – The nextToken string that specifies which page of results to return in a paginated response.

Return type:



Response Syntax

    'invitations': [
            'accountId': 'string',
            'invitationId': 'string',
            'invitedAt': datetime(2015, 1, 1),
            'relationshipStatus': 'Enabled'|'Paused'|'Invited'|'Created'|'Removed'|'Resigned'|'EmailVerificationInProgress'|'EmailVerificationFailed'|'RegionDisabled'|'AccountSuspended'
    'nextToken': 'string'

Response Structure

  • (dict) –

    The request succeeded.

    • invitations (list) –

      An array of objects, one for each invitation that was received by the account.

      • (dict) –

        Provides information about an Amazon Macie membership invitation.

        • accountId (string) –

          The Amazon Web Services account ID for the account that sent the invitation.

        • invitationId (string) –

          The unique identifier for the invitation.

        • invitedAt (datetime) –

          The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.

        • relationshipStatus (string) –

          The status of the relationship between the account that sent the invitation and the account that received the invitation.

    • nextToken (string) –

      The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.


  • Macie2.Client.exceptions.ValidationException

  • Macie2.Client.exceptions.InternalServerException

  • Macie2.Client.exceptions.ServiceQuotaExceededException

  • Macie2.Client.exceptions.AccessDeniedException

  • Macie2.Client.exceptions.ResourceNotFoundException

  • Macie2.Client.exceptions.ThrottlingException

  • Macie2.Client.exceptions.ConflictException