Schemas / Paginator / ListSchemaVersions

ListSchemaVersions¶

class Schemas.Paginator.ListSchemaVersions¶

paginator = client.get_paginator('list_schema_versions')

paginate(**kwargs)¶

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

Request Syntax

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

Parameters:

RegistryName (string) –
[REQUIRED]

The name of the registry.
SchemaName (string) –
[REQUIRED]

The name of the schema.
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

{
    'SchemaVersions': [
        {
            'SchemaArn': 'string',
            'SchemaName': 'string',
            'SchemaVersion': 'string',
            'Type': 'OpenApi3'|'JSONSchemaDraft4'
        },
    ]
}

Response Structure

(dict) –

200 response
- SchemaVersions (list) –
  
  An array of schema version summaries.
  - (dict) –
    - SchemaArn (string) –
      
      The ARN of the schema version.
    - SchemaName (string) –
      
      The name of the schema.
    - SchemaVersion (string) –
      
      The version number of the schema.
    - Type (string) –
      
      The type of schema.