CleanRoomsService / Paginator / ListCollaborations

ListCollaborations#

class CleanRoomsService.Paginator.ListCollaborations#
paginator = client.get_paginator('list_collaborations')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    memberStatus='INVITED'|'ACTIVE',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • memberStatus (string) – The caller’s status in a collaboration.

  • 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

{
    'collaborationList': [
        {
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'creatorAccountId': 'string',
            'creatorDisplayName': 'string',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'memberStatus': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
            'membershipId': 'string',
            'membershipArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • collaborationList (list) –

      The list of collaborations.

      • (dict) –

        The metadata of the collaboration.

        • id (string) –

          The identifier for the collaboration.

        • arn (string) –

          The ARN of the collaboration.

        • name (string) –

          A human-readable identifier provided by the collaboration owner. Display names are not unique.

        • creatorAccountId (string) –

          The identifier used to reference members of the collaboration. Currently only supports AWS Account ID.

        • creatorDisplayName (string) –

          The display name of the collaboration creator.

        • createTime (datetime) –

          The time when the collaboration was created.

        • updateTime (datetime) –

          The time the collaboration metadata was last updated.

        • memberStatus (string) –

          The status of a member in a collaboration.

        • membershipId (string) –

          The identifier of a member in a collaboration.

        • membershipArn (string) –

          The ARN of a member in a collaboration.

    • NextToken (string) –

      A token to resume pagination.