[ aws . glue ]

get-schema-version

Description

Get the specified schema by its unique ID assigned when a version of the schema is created or registered. Schema versions in Deleted status will not be included in the results.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-schema-version
[--schema-id <value>]
[--schema-version-id <value>]
[--schema-version-number <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--schema-id (structure)

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.

SchemaArn -> (string)

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

SchemaName -> (string)

The name of the schema. One of SchemaArn or SchemaName has to be provided.

RegistryName -> (string)

The name of the schema registry that contains the schema.

Shorthand Syntax:

SchemaArn=string,SchemaName=string,RegistryName=string

JSON Syntax:

{
  "SchemaArn": "string",
  "SchemaName": "string",
  "RegistryName": "string"
}

--schema-version-id (string)

The SchemaVersionId of the schema version. This field is required for fetching by schema ID. Either this or the SchemaId wrapper has to be provided.

--schema-version-number (structure)

The version number of the schema.

LatestVersion -> (boolean)

The latest version available for the schema.

VersionNumber -> (long)

The version number of the schema.

Shorthand Syntax:

LatestVersion=boolean,VersionNumber=long

JSON Syntax:

{
  "LatestVersion": true|false,
  "VersionNumber": long
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

SchemaVersionId -> (string)

The SchemaVersionId of the schema version.

SchemaDefinition -> (string)

The schema definition for the schema ID.

DataFormat -> (string)

The data format of the schema definition. Currently AVRO and JSON are supported.

SchemaArn -> (string)

The Amazon Resource Name (ARN) of the schema.

VersionNumber -> (long)

The version number of the schema.

Status -> (string)

The status of the schema version.

CreatedTime -> (string)

The date and time the schema version was created.