GetSchema - AWS Glue

GetSchema

Describes the specified schema in detail.

Request Syntax

{ "SchemaId": { "RegistryName": "string", "SchemaArn": "string", "SchemaName": "string" } }

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: Yes

Response Syntax

{ "Compatibility": "string", "CreatedTime": "string", "DataFormat": "string", "Description": "string", "LatestSchemaVersion": number, "NextSchemaVersion": number, "RegistryArn": "string", "RegistryName": "string", "SchemaArn": "string", "SchemaCheckpoint": number, "SchemaName": "string", "SchemaStatus": "string", "UpdatedTime": "string" }

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.

Compatibility

The compatibility mode of the schema.

Type: String

Valid Values: NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL

CreatedTime

The date and time the schema was created.

Type: String

DataFormat

The data format of the schema definition. Currently only AVRO is supported.

Type: String

Valid Values: AVRO

Description

A description of schema if specified when created

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

LatestSchemaVersion

The latest version of the schema associated with the returned schema definition.

Type: Long

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

NextSchemaVersion

The next version of the schema associated with the returned schema definition.

Type: Long

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

RegistryArn

The Amazon Resource Name (ARN) of the registry.

Type: String

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

Pattern: arn:aws:glue:.*

RegistryName

The name of the registry.

Type: String

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

Pattern: [a-zA-Z0-9-_$#]+

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:.*

SchemaCheckpoint

The version number of the checkpoint (the last time the compatibility mode was changed).

Type: Long

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

SchemaName

The name of the schema.

Type: String

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

Pattern: [a-zA-Z0-9-_$#]+

SchemaStatus

The status of the schema.

Type: String

Valid Values: AVAILABLE | PENDING | DELETING

UpdatedTime

The date and time the schema was updated.

Type: String

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: