Skip to content

Register Schema Version

glue_register_schema_version R Documentation

Adds a new version to the existing schema

Description

Adds a new version to the existing schema. Returns an error if new version of schema does not meet the compatibility requirements of the schema set. This API will not create a new schema set and will return a 404 error if the schema set is not already present in the Schema Registry.

If this is the first schema definition to be registered in the Schema Registry, this API will store the schema version and return immediately. Otherwise, this call has the potential to run longer than other operations due to compatibility modes. You can call the get_schema_version API with the SchemaVersionId to check compatibility modes.

If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller.

Usage

glue_register_schema_version(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. 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.

SchemaDefinition

[required] The schema definition using the DataFormat setting for the SchemaName.

Value

A list with the following syntax: 

list(
  SchemaVersionId = "string",
  VersionNumber = 123,
  Status = "AVAILABLE"|"PENDING"|"FAILURE"|"DELETING"
)

Request syntax

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