Macie2 / Paginator / ListInvitations


class Macie2.Paginator.ListInvitations#
paginator = client.get_paginator('list_invitations')

Creates an iterator that will paginate through responses from Macie2.Client.list_invitations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous 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) –

      A token to resume pagination.