GetSchemaByDefinition - AWS Glue

GetSchemaByDefinition

Retrieves a schema by the SchemaDefinition. The schema definition is sent to the Schema Registry, canonicalized, and hashed. If the hash is matched within the scope of the SchemaName or ARN (or the default registry, if none is supplied), that schema’s metadata is returned. Otherwise, a 404 or NotFound error is returned. Schema versions in Deleted statuses will not be included in the results.

Request Syntax

{ "SchemaDefinition": "string", "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.

SchemaDefinition

The definition of the schema for which schema details are required.

Type: String

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

Pattern: .*\S.*

Required: Yes

SchemaId

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

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

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

Type: SchemaId object

Required: Yes

Response Syntax

{ "CreatedTime": "string", "DataFormat": "string", "SchemaArn": "string", "SchemaVersionId": "string", "Status": "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.

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

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

SchemaVersionId

The schema ID 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

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: