GetSchemaVersion - AWS Glue

GetSchemaVersion

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.

Request Syntax

{ "SchemaId": { "RegistryName": "string", "SchemaArn": "string", "SchemaName": "string" }, "SchemaVersionId": "string", "SchemaVersionNumber": { "LatestVersion": boolean, "VersionNumber": number } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

SchemaId

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.

Type: SchemaId object

Required: No

SchemaVersionId

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.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: No

SchemaVersionNumber

The version number of the schema.

Type: SchemaVersionNumber object

Required: No

Response Syntax

{ "CreatedTime": "string", "DataFormat": "string", "SchemaArn": "string", "SchemaDefinition": "string", "SchemaVersionId": "string", "Status": "string", "VersionNumber": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreatedTime

The date and time the schema version was created.

Type: String

DataFormat

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

Type: String

Valid Values: AVRO | JSON

SchemaArn

The Amazon Resource Name (ARN) of the schema.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10240.

Pattern: arn:aws:glue:.*

SchemaDefinition

The schema definition for the schema ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 170000.

Pattern: .*\S.*

SchemaVersionId

The SchemaVersionId of the schema version.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Status

The status of the schema version.

Type: String

Valid Values: AVAILABLE | PENDING | FAILURE | DELETING

VersionNumber

The version number of the schema.

Type: Long

Valid Range: Minimum value of 1. Maximum value of 100000.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access to a resource was denied.

HTTP Status Code: 400

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: