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

describe-schema

Description

Retrieve the schema definition.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-schema
--registry-name <value>
--schema-name <value>
[--schema-version <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--registry-name (string)

The name of the registry.

--schema-name (string)

The name of the schema.

--schema-version (string)

Specifying this limits the results to only this schema version.

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

Content -> (string)

The source of the schema definition.

Description -> (string)

The description of the schema.

LastModified -> (timestamp)

The date and time that schema was modified.

SchemaArn -> (string)

The ARN of the schema.

SchemaName -> (string)

The name of the schema.

SchemaVersion -> (string)

The version number of the schema

Tags -> (map)

Tags associated with the resource.

key -> (string)

value -> (string)

Type -> (string)

The type of the schema.

VersionCreatedDate -> (timestamp)

The date the schema version was created.