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.
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 <value>]
[--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>]
--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 ofSchemaArn
orSchemaName
has to be provided.SchemaName -> (string)
The name of the schema. One ofSchemaArn
orSchemaName
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
(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.
--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.
--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.
--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.
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.