CleanRoomsService / Paginator / ListCollaborationChangeRequests

ListCollaborationChangeRequests

class CleanRoomsService.Paginator.ListCollaborationChangeRequests

paginator = client.get_paginator('list_collaboration_change_requests')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    collaborationIdentifier='string',
    status='PENDING'|'APPROVED'|'CANCELLED'|'DENIED'|'COMMITTED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• collaborationIdentifier (string) –

  [REQUIRED]

  The identifier of the collaboration that the change request is made against.

• status (string) – A filter to only return change requests with 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

{
    'collaborationChangeRequestSummaries': [
        {
            'id': 'string',
            'collaborationId': 'string',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'status': 'PENDING'|'APPROVED'|'CANCELLED'|'DENIED'|'COMMITTED',
            'isAutoApproved': True|False,
            'changes': [
                {
                    'specificationType': 'MEMBER',
                    'specification': {
                        'member': {
                            'accountId': 'string',
                            'memberAbilities': [
                                'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
                            ],
                            'displayName': 'string'
                        }
                    },
                    'types': [
                        'ADD_MEMBER',
                    ]
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • collaborationChangeRequestSummaries (list) –

    The list of collaboration change request summaries.

    • (dict) –

      Summary information about a collaboration change request.

      • id (string) –

        The unique identifier for the change request.

      • collaborationId (string) –

        The unique identifier for the collaboration.

      • createTime (datetime) –

        The time when the change request was created.

      • updateTime (datetime) –

        The time when the change request was last updated.

      • status (string) –

        The current status of the change request.

      • isAutoApproved (boolean) –

        Whether the change request was automatically approved.

      • changes (list) –

        Summary of the changes in this change request.

        • (dict) –

          Represents a single change within a collaboration change request, containing the change identifier and specification.

          • specificationType (string) –

            The type of specification for this change.

          • specification (dict) –

            The specification details for this change.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: member. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            

            • member (dict) –

              The member change specification when the change type is MEMBER.

              • accountId (string) –

                The Amazon Web Services account ID of the member to add to the collaboration.

              • memberAbilities (list) –

                The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.

                Note

                The following values are currently not supported: CAN_QUERY, CAN_RECEIVE_RESULTS, and CAN_RUN_JOB.

                Set the value of memberAbilities to [] to allow a member to contribute data.

                • (string) –

              • displayName (string) –

                Specifies the display name that will be shown for this member in the collaboration. While this field is required when inviting new members, it becomes optional when modifying abilities of existing collaboration members.

          • types (list) –

            The list of change types that were applied.

            • (string) –

  • NextToken (string) –

    A token to resume pagination.