Schemas / Paginator / ListSchemas

ListSchemas

class Schemas.Paginator.ListSchemas

paginator = client.get_paginator('list_schemas')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    RegistryName='string',
    SchemaNamePrefix='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• RegistryName (string) –

  [REQUIRED]

  The name of the registry.

• SchemaNamePrefix (string) – Specifying this limits the results to only those schema names that start with the specified prefix.

• 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

{
    'Schemas': [
        {
            'LastModified': datetime(2015, 1, 1),
            'SchemaArn': 'string',
            'SchemaName': 'string',
            'Tags': {
                'string': 'string'
            },
            'VersionCount': 123
        },
    ]
}

Response Structure

• (dict) –

  200 response

  • Schemas (list) –

    An array of schema summaries.

    • (dict) –

      A summary of schema details.

      • LastModified (datetime) –

        The date and time that schema was modified.

      • SchemaArn (string) –

        The ARN of the schema.

      • SchemaName (string) –

        The name of the schema.

      • Tags (dict) –

        Tags associated with the schema.

        • (string) –

          • (string) –

      • VersionCount (integer) –

        The number of versions available for the schema.