CleanRoomsService / Paginator / ListMemberships

ListMemberships

class CleanRoomsService.Paginator.ListMemberships

paginator = client.get_paginator('list_memberships')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    status='ACTIVE'|'REMOVED'|'COLLABORATION_DELETED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• status (string) – A filter which will return only memberships in the specified status.

• 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

{
    'membershipSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'collaborationArn': 'string',
            'collaborationId': 'string',
            'collaborationCreatorAccountId': 'string',
            'collaborationCreatorDisplayName': 'string',
            'collaborationName': 'string',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'status': 'ACTIVE'|'REMOVED'|'COLLABORATION_DELETED',
            'memberAbilities': [
                'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
            ],
            'paymentConfiguration': {
                'queryCompute': {
                    'isResponsible': True|False
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • membershipSummaries (list) –

    The list of memberships returned from the ListMemberships operation.

    • (dict) –

      The membership object listed by the request.

      • id (string) –

        The unique ID for the membership’s collaboration.

      • arn (string) –

        The unique ARN for the membership.

      • collaborationArn (string) –

        The unique ARN for the membership’s associated collaboration.

      • collaborationId (string) –

        The unique ID for the membership’s collaboration.

      • collaborationCreatorAccountId (string) –

        The identifier of the Amazon Web Services principal that created the collaboration. Currently only supports Amazon Web Services account ID.

      • collaborationCreatorDisplayName (string) –

        The display name of the collaboration creator.

      • collaborationName (string) –

        The name for the membership’s collaboration.

      • createTime (datetime) –

        The time when the membership was created.

      • updateTime (datetime) –

        The time the membership metadata was last updated.

      • status (string) –

        The status of the membership.

      • memberAbilities (list) –

        The abilities granted to the collaboration member.

        • (string) –

      • paymentConfiguration (dict) –

        The payment responsibilities accepted by the collaboration member.

        • queryCompute (dict) –

          The payment responsibilities accepted by the collaboration member for query compute costs.

          • isResponsible (boolean) –

            Indicates whether the collaboration member has accepted to pay for query compute costs ( TRUE) or has not accepted to pay for query compute costs ( FALSE).

            If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.

            An error message is returned for the following reasons:

            • If you set the value to FALSE but you are responsible to pay for query compute costs.

            • If you set the value to TRUE but you are not responsible to pay for query compute costs.

  • NextToken (string) –

    A token to resume pagination.