CleanRoomsService / Paginator / ListMembers

ListMembers

class CleanRoomsService.Paginator.ListMembers

paginator = client.get_paginator('list_members')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CleanRoomsService.Client.list_members().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    collaborationIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• collaborationIdentifier (string) –

  [REQUIRED]

  The identifier of the collaboration in which the members are listed.

• 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:

dict

Returns:

Response Syntax

{
    'memberSummaries': [
        {
            'accountId': 'string',
            'status': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
            'displayName': 'string',
            'abilities': [
                'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
            ],
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'membershipId': 'string',
            'membershipArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • memberSummaries (list) –

    The list of members returned by the ListMembers operation.

    • (dict) –

      The member object listed by the request.

      • accountId (string) –

        The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

      • status (string) –

        The status of the member. Valid values are INVITED, ACTIVE, LEFT, and REMOVED.

      • displayName (string) –

        The member’s display name.

      • abilities (list) –

        The abilities granted to the collaboration member.

        • (string) –

      • createTime (datetime) –

        The time when the member was created.

      • updateTime (datetime) –

        The time the member metadata was last updated.

      • membershipId (string) –

        The unique ID for the member’s associated membership, if present.

      • membershipArn (string) –

        The unique ARN for the member’s associated membership, if present.

  • NextToken (string) –

    A token to resume pagination.