schema_by_definitions

Creates, updates, deletes, gets or lists a schema_by_definitions resource.

Overview

Name	schema_by_definitions
Type	Resource
Id	aws.glue.schema_by_definitions

Fields

The following fields are returned by SELECT queries:

get_schema_by_definition

Name	Datatype	Description
created_time	string	The date and time the schema was created.
data_format	string	The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported. (AVRO, JSON, PROTOBUF)
schema_arn	string	The Amazon Resource Name (ARN) of the schema. (pattern: <code>arn:aws(-(cn|us-gov|iso(-[bef])?))?:glue:.*</code>)
schema_version_id	string	The schema ID of the schema version. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
status	string	The status of the schema version. (AVAILABLE, PENDING, FAILURE, DELETING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_schema_by_definition	select	region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_schema_by_definition

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.

SELECT
created_time,
data_format,
schema_arn,
schema_version_id,
status
FROM aws.glue.schema_by_definitions
WHERE region = '{{ region }}' -- required
;