get-table-version
Description
Retrieves a specified version of a table.
See also: AWS API Documentation
Synopsis
get-table-version
[--catalog-id <value>]
--database-name <value>
--table-name <value>
[--version-id <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
--catalog-id (string)
--database-name (string)
--table-name (string)
--version-id (string)
VersionID is a string representation of an integer. Each version is incremented by 1.--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
TableVersion -> (structure)
The requested table version.
Table -> (structure)
The table in question.
Name -> (string)
DatabaseName -> (string)
Description -> (string)
Owner -> (string)
CreateTime -> (timestamp)
UpdateTime -> (timestamp)
LastAccessTime -> (timestamp)
LastAnalyzedTime -> (timestamp)
Retention -> (integer)
StorageDescriptor -> (structure)
A storage descriptor containing information about the physical storage of this table.
Columns -> (list)
A list of the Columns in the table.
(structure)
A column in a Table .
Name -> (string)
Column .Type -> (string)
Column .Comment -> (string)
Parameters -> (map)
These key-value pairs define properties associated with the column.
key -> (string)
value -> (string)
Location -> (string)
AdditionalLocations -> (list)
A list of locations that point to the path where a Delta table is located.
(string)
InputFormat -> (string)
SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.OutputFormat -> (string)
SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.Compressed -> (boolean)
True if the data in the table is compressed, or False if not.NumberOfBuckets -> (integer)
SerdeInfo -> (structure)
The serialization/deserialization (SerDe) information.
Name -> (string)
SerializationLibrary -> (string)
org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .Parameters -> (map)
These key-value pairs define initialization parameters for the SerDe.
key -> (string)
value -> (string)
BucketColumns -> (list)
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string)
SortColumns -> (list)
A list specifying the sort order of each bucket in the table.
(structure)
Specifies the sort order of a sorted column.
Column -> (string)
SortOrder -> (integer)
== 1 ), or in descending order (==0 ).Parameters -> (map)
The user-supplied properties in key-value form.
key -> (string)
value -> (string)
SkewedInfo -> (structure)
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames -> (list)
A list of names of columns that contain skewed values.
(string)
SkewedColumnValues -> (list)
A list of values that appear so frequently as to be considered skewed.
(string)
SkewedColumnValueLocationMaps -> (map)
A mapping of skewed values to the columns that contain them.
key -> (string)
value -> (string)
StoredAsSubDirectories -> (boolean)
True if the table data is stored in subdirectories, or False if not.SchemaReference -> (structure)
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId -> (structure)
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn -> (string)
SchemaArn or SchemaName has to be provided.SchemaName -> (string)
SchemaArn or SchemaName has to be provided.RegistryName -> (string)
SchemaVersionId -> (string)
SchemaId has to be provided.SchemaVersionNumber -> (long)
PartitionKeys -> (list)
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": [](structure)
A column in a Table .
Name -> (string)
Column .Type -> (string)
Column .Comment -> (string)
Parameters -> (map)
These key-value pairs define properties associated with the column.
key -> (string)
value -> (string)
ViewOriginalText -> (string)
VIRTUAL_VIEW , certain Athena configuration encoded in base64.ViewExpandedText -> (string)
TableType -> (string)
The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
Hive compatible attribute - indicates a non-Hive managed table.
Used by Lake Formation. The Glue Data Catalog understands GOVERNED .
Parameters -> (map)
These key-value pairs define properties associated with the table.
key -> (string)
value -> (string)
CreatedBy -> (string)
IsRegisteredWithLakeFormation -> (boolean)
TargetTable -> (structure)
A TableIdentifier structure that describes a target table for resource linking.
CatalogId -> (string)
DatabaseName -> (string)
Name -> (string)
Region -> (string)
CatalogId -> (string)
VersionId -> (string)
FederatedTable -> (structure)
A FederatedTable structure that references an entity outside the Glue Data Catalog.
Identifier -> (string)
DatabaseIdentifier -> (string)
ConnectionName -> (string)
ViewDefinition -> (structure)
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected -> (boolean)
Definer -> (string)
SubObjects -> (list)
A list of table Amazon Resource Names (ARNs).
(string)
Representations -> (list)
A list of representations.
(structure)
A structure that contains the dialect of the view, and the query that defines the view.
Dialect -> (string)
DialectVersion -> (string)
ViewOriginalText -> (string)
SELECT query provided by the customer during CREATE VIEW DDL . This SQL is not used during a query on a view (ViewExpandedText is used instead). ViewOriginalText is used for cases like SHOW CREATE VIEW where users want to see the original DDL command that created the view.ViewExpandedText -> (string)
The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText to ViewExpandedText . For example:
- Fully qualified identifiers:
SELECT * from table1 -> SELECT * from db1.table1
ValidationConnection -> (string)
IsStale -> (boolean)
IsMultiDialectView -> (boolean)
Status -> (structure)
A structure containing information about the state of an asynchronous change to a table.
RequestedBy -> (string)
UpdatedBy -> (string)
RequestTime -> (timestamp)
UpdateTime -> (timestamp)
Action -> (string)
CREATE or UPDATE .State -> (string)
Error -> (structure)
An error that will only appear when the state is “FAILED”. This is a parent level exception message, there may be different Error s for each dialect.
ErrorCode -> (string)
ErrorMessage -> (string)
Details -> (structure)
A StatusDetails object with information about the requested change.
RequestedChange -> (structure)
A Table object representing the requested changes.
Name -> (string)
DatabaseName -> (string)
Description -> (string)
Owner -> (string)
CreateTime -> (timestamp)
UpdateTime -> (timestamp)
LastAccessTime -> (timestamp)
LastAnalyzedTime -> (timestamp)
Retention -> (integer)
StorageDescriptor -> (structure)
A storage descriptor containing information about the physical storage of this table.
Columns -> (list)
A list of the Columns in the table.
(structure)
A column in a Table .
Name -> (string)
Column .Type -> (string)
Column .Comment -> (string)
Parameters -> (map)
These key-value pairs define properties associated with the column.
key -> (string)
value -> (string)
Location -> (string)
AdditionalLocations -> (list)
A list of locations that point to the path where a Delta table is located.
(string)
InputFormat -> (string)
SequenceFileInputFormat (binary), or TextInputFormat , or a custom format.OutputFormat -> (string)
SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat , or a custom format.Compressed -> (boolean)
True if the data in the table is compressed, or False if not.NumberOfBuckets -> (integer)
SerdeInfo -> (structure)
The serialization/deserialization (SerDe) information.
Name -> (string)
SerializationLibrary -> (string)
org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe .Parameters -> (map)
These key-value pairs define initialization parameters for the SerDe.
key -> (string)
value -> (string)
BucketColumns -> (list)
A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
(string)
SortColumns -> (list)
A list specifying the sort order of each bucket in the table.
(structure)
Specifies the sort order of a sorted column.
Column -> (string)
SortOrder -> (integer)
== 1 ), or in descending order (==0 ).Parameters -> (map)
The user-supplied properties in key-value form.
key -> (string)
value -> (string)
SkewedInfo -> (structure)
The information about values that appear frequently in a column (skewed values).
SkewedColumnNames -> (list)
A list of names of columns that contain skewed values.
(string)
SkewedColumnValues -> (list)
A list of values that appear so frequently as to be considered skewed.
(string)
SkewedColumnValueLocationMaps -> (map)
A mapping of skewed values to the columns that contain them.
key -> (string)
value -> (string)
StoredAsSubDirectories -> (boolean)
True if the table data is stored in subdirectories, or False if not.SchemaReference -> (structure)
An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId -> (structure)
A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.
SchemaArn -> (string)
SchemaArn or SchemaName has to be provided.SchemaName -> (string)
SchemaArn or SchemaName has to be provided.RegistryName -> (string)
SchemaVersionId -> (string)
SchemaId has to be provided.SchemaVersionNumber -> (long)
PartitionKeys -> (list)
A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any partitionKeys , you must at least set the value of partitionKeys to an empty list. For example:
"PartitionKeys": [](structure)
A column in a Table .
Name -> (string)
Column .Type -> (string)
Column .Comment -> (string)
Parameters -> (map)
These key-value pairs define properties associated with the column.
key -> (string)
value -> (string)
ViewOriginalText -> (string)
VIRTUAL_VIEW , certain Athena configuration encoded in base64.ViewExpandedText -> (string)
TableType -> (string)
The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.
Glue related table types:
Hive compatible attribute - indicates a non-Hive managed table.
Used by Lake Formation. The Glue Data Catalog understands GOVERNED .
Parameters -> (map)
These key-value pairs define properties associated with the table.
key -> (string)
value -> (string)
CreatedBy -> (string)
IsRegisteredWithLakeFormation -> (boolean)
TargetTable -> (structure)
A TableIdentifier structure that describes a target table for resource linking.
CatalogId -> (string)
DatabaseName -> (string)
Name -> (string)
Region -> (string)
CatalogId -> (string)
VersionId -> (string)
FederatedTable -> (structure)
A FederatedTable structure that references an entity outside the Glue Data Catalog.
Identifier -> (string)
DatabaseIdentifier -> (string)
ConnectionName -> (string)
ViewDefinition -> (structure)
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected -> (boolean)
Definer -> (string)
SubObjects -> (list)
A list of table Amazon Resource Names (ARNs).
(string)
Representations -> (list)
A list of representations.
(structure)
A structure that contains the dialect of the view, and the query that defines the view.
Dialect -> (string)
DialectVersion -> (string)
ViewOriginalText -> (string)
SELECT query provided by the customer during CREATE VIEW DDL . This SQL is not used during a query on a view (ViewExpandedText is used instead). ViewOriginalText is used for cases like SHOW CREATE VIEW where users want to see the original DDL command that created the view.ViewExpandedText -> (string)
The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText to ViewExpandedText . For example:
- Fully qualified identifiers:
SELECT * from table1 -> SELECT * from db1.table1
ValidationConnection -> (string)
IsStale -> (boolean)
IsMultiDialectView -> (boolean)
Status -> (structure)
A structure containing information about the state of an asynchronous change to a table.
RequestedBy -> (string)
UpdatedBy -> (string)
RequestTime -> (timestamp)
UpdateTime -> (timestamp)
Action -> (string)
CREATE or UPDATE .State -> (string)
Error -> (structure)
An error that will only appear when the state is “FAILED”. This is a parent level exception message, there may be different Error s for each dialect.
ErrorCode -> (string)
ErrorMessage -> (string)
Details -> (structure)
A StatusDetails object with information about the requested change.
( … recursive … )ViewValidations -> (list)
A list of ViewValidation objects that contain information for an analytical engine to validate a view.
(structure)
A structure that contains information for an analytical engine to validate a view, prior to persisting the view metadata. Used in the case of direct UpdateTable or CreateTable API calls.
Dialect -> (string)
DialectVersion -> (string)
ViewValidationText -> (string)
SELECT query that defines the view, as provided by the customer.UpdateTime -> (timestamp)
State -> (string)
Error -> (structure)
An error associated with the validation.
ErrorCode -> (string)
ErrorMessage -> (string)
ViewValidations -> (list)
A list of ViewValidation objects that contain information for an analytical engine to validate a view.
(structure)
A structure that contains information for an analytical engine to validate a view, prior to persisting the view metadata. Used in the case of direct UpdateTable or CreateTable API calls.
Dialect -> (string)
DialectVersion -> (string)
ViewValidationText -> (string)
SELECT query that defines the view, as provided by the customer.UpdateTime -> (timestamp)
State -> (string)
Error -> (structure)
An error associated with the validation.
ErrorCode -> (string)
ErrorMessage -> (string)
VersionId -> (string)
VersionId is a string representation of an integer. Each version is incremented by 1.
© Copyright 2025, Amazon Web Services. Created using Sphinx.
