[ aws . glue ]

query-schema-version-metadata

Description

Queries for the schema version metadata information.

See also: AWS API Documentation

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>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input 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.