Schemas / Client / list_schema_versions

list_schema_versions#

Schemas.Client.list_schema_versions(**kwargs)#

Provides a list of the schema versions and related information.

Request Syntax

response = client.list_schema_versions(
    Limit=123,
    NextToken='string',
    RegistryName='string',
    SchemaName='string'
)

Parameters:

Limit (integer) –
NextToken (string) – The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
RegistryName (string) –
[REQUIRED]

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

The name of the schema.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –

200 response
- NextToken (string) –
  
  The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts.
- 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.

Exceptions

Schemas.Client.exceptions.BadRequestException
Schemas.Client.exceptions.UnauthorizedException
Schemas.Client.exceptions.InternalServerErrorException
Schemas.Client.exceptions.ForbiddenException
Schemas.Client.exceptions.NotFoundException
Schemas.Client.exceptions.ServiceUnavailableException