CleanRoomsService / Paginator / ListProtectedQueries

ListProtectedQueries

class CleanRoomsService.Paginator.ListProtectedQueries

paginator = client.get_paginator('list_protected_queries')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    membershipIdentifier='string',
    status='SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'TIMED_OUT',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• membershipIdentifier (string) –

  [REQUIRED]

  The identifier for the membership in the collaboration.

• status (string) – A filter on the status of the protected query.

• 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

{
    'protectedQueries': [
        {
            'id': 'string',
            'membershipId': 'string',
            'membershipArn': 'string',
            'createTime': datetime(2015, 1, 1),
            'status': 'SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'TIMED_OUT'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • protectedQueries (list) –

    A list of protected queries.

    • (dict) –

      The protected query summary for the objects listed by the request.

      • id (string) –

        The unique ID of the protected query.

      • membershipId (string) –

        The unique ID for the membership that initiated the protected query.

      • membershipArn (string) –

        The unique ARN for the membership that initiated the protected query.

      • createTime (datetime) –

        The time the protected query was created.

      • status (string) –

        The status of the protected query. Value values are SUBMITTED, STARTED, CANCELLED, CANCELLING, FAILED, SUCCESS, TIMED_OUT.

  • NextToken (string) –

    A token to resume pagination.