Skip to content

Get Schema By Definition

glue_get_schema_by_definition R Documentation

Retrieves a schema by the SchemaDefinition

Description

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.

Usage

glue_get_schema_by_definition(SchemaId, SchemaDefinition)

Arguments

SchemaId

[required] 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.
SchemaDefinition

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

Value

A list with the following syntax:

list(
  SchemaVersionId = "string",
  SchemaArn = "string",
  DataFormat = "AVRO"|"JSON"|"PROTOBUF",
  Status = "AVAILABLE"|"PENDING"|"FAILURE"|"DELETING",
  CreatedTime = "string"
)

Request syntax

svc$get_schema_by_definition(
  SchemaId = list(
    SchemaArn = "string",
    SchemaName = "string",
    RegistryName = "string"
  ),
  SchemaDefinition = "string"
)