Schemas / Client / list_schemas

list_schemas#

Schemas.Client.list_schemas(**kwargs)#

List the schemas.

See also: AWS API Documentation

Request Syntax

response = client.list_schemas(
    Limit=123,
    NextToken='string',
    RegistryName='string',
    SchemaNamePrefix='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.

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

Return type:

dict

Returns:

Response Syntax

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

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.

    • 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.

Exceptions

  • Schemas.Client.exceptions.ServiceUnavailableException

  • Schemas.Client.exceptions.BadRequestException

  • Schemas.Client.exceptions.UnauthorizedException

  • Schemas.Client.exceptions.InternalServerErrorException

  • Schemas.Client.exceptions.ForbiddenException