Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . glue ]

get-schema

Description

Describes the specified schema in detail.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-schema
--schema-id <value>
[--cli-input-json <value>]
[--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"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

RegistryName -> (string)

The name of the registry.

RegistryArn -> (string)

The Amazon Resource Name (ARN) of the registry.

SchemaName -> (string)

The name of the schema.

SchemaArn -> (string)

The Amazon Resource Name (ARN) of the schema.

Description -> (string)

A description of schema if specified when created

DataFormat -> (string)

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

Compatibility -> (string)

The compatibility mode of the schema.

SchemaCheckpoint -> (long)

The version number of the checkpoint (the last time the compatibility mode was changed).

LatestSchemaVersion -> (long)

The latest version of the schema associated with the returned schema definition.

NextSchemaVersion -> (long)

The next version of the schema associated with the returned schema definition.

SchemaStatus -> (string)

The status of the schema.

CreatedTime -> (string)

The date and time the schema was created.

UpdatedTime -> (string)

The date and time the schema was updated.