Glue / Client / get_schema_version

get_schema_version#

Glue.Client.get_schema_version(**kwargs)#

Get the specified schema by its unique ID assigned when a version of the schema is created or registered. Schema versions in Deleted status will not be included in the results.

See also: AWS API Documentation

Request Syntax

response = client.get_schema_version(
    SchemaId={
        'SchemaArn': 'string',
        'SchemaName': 'string',
        'RegistryName': 'string'
    },
    SchemaVersionId='string',
    SchemaVersionNumber={
        'LatestVersion': True|False,
        'VersionNumber': 123
    }
)
Parameters:

  • SchemaId (dict) –

    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.

  • SchemaVersionId (string) – The SchemaVersionId of the schema version. This field is required for fetching by schema ID. Either this or the SchemaId wrapper has to be provided.

  • SchemaVersionNumber (dict) –

    The version number of the schema.

    • LatestVersion (boolean) –

      The latest version available for the schema.

    • VersionNumber (integer) –

      The version number of the schema.

Return type:

dict

Returns:

Response Syntax

{
    'SchemaVersionId': 'string',
    'SchemaDefinition': 'string',
    'DataFormat': 'AVRO'|'JSON'|'PROTOBUF',
    'SchemaArn': 'string',
    'VersionNumber': 123,
    'Status': 'AVAILABLE'|'PENDING'|'FAILURE'|'DELETING',
    'CreatedTime': 'string'
}

Response Structure

  • (dict) –

    • SchemaVersionId (string) –

      The SchemaVersionId of the schema version.

    • SchemaDefinition (string) –

      The schema definition for the schema ID.

    • DataFormat (string) –

      The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

    • SchemaArn (string) –

      The Amazon Resource Name (ARN) of the schema.

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

Exceptions