[ aws . glue ]

query-schema-version-metadata

Description

Queries for the schema version metadata information.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  query-schema-version-metadata
[--schema-id <value>]
[--schema-version-number <value>]
[--schema-version-id <value>]
[--metadata-list <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--schema-id (structure)

A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).

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

--schema-version-id (string)

The unique version ID of the schema version.

--metadata-list (list)

Search key-value pairs for metadata, if they are not provided all the metadata information will be fetched.

(structure)

A structure containing a key value pair for metadata.

MetadataKey -> (string)

A metadata key.

MetadataValue -> (string)

A metadata key’s corresponding value.

Shorthand Syntax:

MetadataKey=string,MetadataValue=string ...

JSON Syntax:

[
  {
    "MetadataKey": "string",
    "MetadataValue": "string"
  }
  ...
]

--max-results (integer)

Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.

--next-token (string)

A continuation token, if this is a continuation call.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

MetadataInfoMap -> (map)

A map of a metadata key and associated values.

key -> (string)

value -> (structure)

A structure containing metadata information for a schema version.

MetadataValue -> (string)

The metadata key’s corresponding value.

CreatedTime -> (string)

The time at which the entry was created.

OtherMetadataValueList -> (list)

Other metadata belonging to the same metadata key.

(structure)

A structure containing other metadata for a schema version belonging to the same metadata key.

MetadataValue -> (string)

The metadata key’s corresponding value for the other metadata belonging to the same metadata key.

CreatedTime -> (string)

The time at which the entry was created.

SchemaVersionId -> (string)

The unique version ID of the schema version.

NextToken -> (string)

A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.