Glue / Client / list_schema_versions

list_schema_versions#

Glue.Client.list_schema_versions(**kwargs)#

Returns a list of schema versions that you have created, with minimal information. Schema versions in Deleted status will not be included in the results. Empty results will be returned if there are no schema versions available.

See also: AWS API Documentation

Request Syntax

response = client.list_schema_versions(
    SchemaId={
        'SchemaArn': 'string',
        'SchemaName': 'string',
        'RegistryName': 'string'
    },
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • SchemaId (dict) –

    [REQUIRED]

    This is a wrapper structure to contain schema identity fields. The structure contains:

    • SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.

    • SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.

    • SchemaArn (string) –

      The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.

    • SchemaName (string) –

      The name of the schema. One of SchemaArn or SchemaName has to be provided.

    • RegistryName (string) –

      The name of the schema registry that contains the schema.

  • MaxResults (integer) – Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.

  • NextToken (string) – A continuation token, if this is a continuation call.

Return type:

dict

Returns:

Response Syntax

{
    'Schemas': [
        {
            'SchemaArn': 'string',
            'SchemaVersionId': 'string',
            'VersionNumber': 123,
            'Status': 'AVAILABLE'|'PENDING'|'FAILURE'|'DELETING',
            'CreatedTime': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Schemas (list) –

      An array of SchemaVersionList objects containing details of each schema version.

      • (dict) –

        An object containing the details about a schema version.

        • SchemaArn (string) –

          The Amazon Resource Name (ARN) of the schema.

        • SchemaVersionId (string) –

          The unique identifier of the schema version.

        • VersionNumber (integer) –

          The version number of the schema.

        • Status (string) –

          The status of the schema version.

        • CreatedTime (string) –

          The date and time the schema version was created.

    • NextToken (string) –

      A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

Exceptions