CleanRoomsService / Paginator / ListSchemas

ListSchemas

class CleanRoomsService.Paginator.ListSchemas

paginator = client.get_paginator('list_schemas')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• collaborationIdentifier (string) –

  [REQUIRED]

  A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.

• schemaType (string) – If present, filter schemas by schema type. The only valid schema type is currently TABLE.

• 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

{
    'schemaSummaries': [
        {
            'name': 'string',
            'type': 'TABLE'|'ID_MAPPING_TABLE',
            'creatorAccountId': 'string',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'collaborationId': 'string',
            'collaborationArn': 'string',
            'analysisRuleTypes': [
                'AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE',
            ],
            'analysisMethod': 'DIRECT_QUERY'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • schemaSummaries (list) –

    The retrieved list of schemas.

    • (dict) –

      The schema summary for the objects listed by the request.

      • name (string) –

        The name for the schema object.

      • type (string) –

        The type of schema object. The only valid schema type is currently TABLE.

      • creatorAccountId (string) –

        The unique account ID for the Amazon Web Services account that owns the schema.

      • createTime (datetime) –

        The time the schema object was created.

      • updateTime (datetime) –

        The time the schema object was last updated.

      • collaborationId (string) –

        The unique ID for the collaboration that the schema belongs to.

      • collaborationArn (string) –

        The unique ARN for the collaboration that the schema belongs to.

      • analysisRuleTypes (list) –

        The types of analysis rules that are associated with this schema object.

        • (string) –

      • analysisMethod (string) –

        The analysis method for the associated schema. The only valid value is currently DIRECT_QUERY.

  • NextToken (string) –

    A token to resume pagination.