CheckSchemaVersionValidity - AWS Glue

CheckSchemaVersionValidity

Validates the supplied schema. This call has no side effects, it simply validates using the supplied schema using DataFormat as the format. Since it does not take a schema set name, no compatibility checks are performed.

Request Syntax

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

DataFormat

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

Type: String

Valid Values: AVRO

Required: Yes

SchemaDefinition

The definition of the schema that has to be validated.

Type: String

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

Pattern: .*\S.*

Required: Yes

Response Syntax

{ "Error": "string", "Valid": boolean }

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.

Error

A validation failure error message.

Type: String

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

Valid

Return true, if the schema is valid and false otherwise.

Type: Boolean

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

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: