Glue / Client / get_table_versions

get_table_versions

Glue.Client.get_table_versions(**kwargs)

Retrieves a list of strings that identify available versions of a specified table.

See also: AWS API Documentation

Request Syntax

response = client.get_table_versions(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    NextToken='string',
    MaxResults=123,
    AuditContext={
        'AdditionalAuditContext': 'string',
        'RequestedColumns': [
            'string',
        ],
        'AllColumnsRequested': True|False
    }
)

Parameters:

• CatalogId (string) – The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.

• DatabaseName (string) –

  [REQUIRED]

  The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

• TableName (string) –

  [REQUIRED]

  The name of the table. For Hive compatibility, this name is entirely lowercase.

• NextToken (string) – A continuation token, if this is not the first call.

• MaxResults (integer) – The maximum number of table versions to return in one response.

• AuditContext (dict) –

  A structure containing the Lake Formation audit context.

  • AdditionalAuditContext (string) –

    A string containing the additional audit context information.

  • RequestedColumns (list) –

    The requested columns for audit.

    • (string) –

  • AllColumnsRequested (boolean) –

    All columns request for audit.

Return type:

dict

Returns:

Response Syntax

{
    'TableVersions': [
        {
            'Table': {
                'Name': 'string',
                'DatabaseName': 'string',
                'Description': 'string',
                'Owner': 'string',
                'CreateTime': datetime(2015, 1, 1),
                'UpdateTime': datetime(2015, 1, 1),
                'LastAccessTime': datetime(2015, 1, 1),
                'LastAnalyzedTime': datetime(2015, 1, 1),
                'Retention': 123,
                'StorageDescriptor': {
                    'Columns': [
                        {
                            'Name': 'string',
                            'Type': 'string',
                            'Comment': 'string',
                            'Parameters': {
                                'string': 'string'
                            }
                        },
                    ],
                    'Location': 'string',
                    'AdditionalLocations': [
                        'string',
                    ],
                    'InputFormat': 'string',
                    'OutputFormat': 'string',
                    'Compressed': True|False,
                    'NumberOfBuckets': 123,
                    'SerdeInfo': {
                        'Name': 'string',
                        'SerializationLibrary': 'string',
                        'Parameters': {
                            'string': 'string'
                        }
                    },
                    'BucketColumns': [
                        'string',
                    ],
                    'SortColumns': [
                        {
                            'Column': 'string',
                            'SortOrder': 123
                        },
                    ],
                    'Parameters': {
                        'string': 'string'
                    },
                    'SkewedInfo': {
                        'SkewedColumnNames': [
                            'string',
                        ],
                        'SkewedColumnValues': [
                            'string',
                        ],
                        'SkewedColumnValueLocationMaps': {
                            'string': 'string'
                        }
                    },
                    'StoredAsSubDirectories': True|False,
                    'SchemaReference': {
                        'SchemaId': {
                            'SchemaArn': 'string',
                            'SchemaName': 'string',
                            'RegistryName': 'string'
                        },
                        'SchemaVersionId': 'string',
                        'SchemaVersionNumber': 123
                    }
                },
                'PartitionKeys': [
                    {
                        'Name': 'string',
                        'Type': 'string',
                        'Comment': 'string',
                        'Parameters': {
                            'string': 'string'
                        }
                    },
                ],
                'ViewOriginalText': 'string',
                'ViewExpandedText': 'string',
                'TableType': 'string',
                'Parameters': {
                    'string': 'string'
                },
                'CreatedBy': 'string',
                'IsRegisteredWithLakeFormation': True|False,
                'TargetTable': {
                    'CatalogId': 'string',
                    'DatabaseName': 'string',
                    'Name': 'string',
                    'Region': 'string'
                },
                'CatalogId': 'string',
                'VersionId': 'string',
                'FederatedTable': {
                    'Identifier': 'string',
                    'DatabaseIdentifier': 'string',
                    'ConnectionName': 'string',
                    'ConnectionType': 'string'
                },
                'ViewDefinition': {
                    'IsProtected': True|False,
                    'Definer': 'string',
                    'ViewVersionId': 123,
                    'ViewVersionToken': 'string',
                    'RefreshSeconds': 123,
                    'LastRefreshType': 'FULL'|'INCREMENTAL',
                    'SubObjects': [
                        'string',
                    ],
                    'SubObjectVersionIds': [
                        123,
                    ],
                    'Representations': [
                        {
                            'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
                            'DialectVersion': 'string',
                            'ViewOriginalText': 'string',
                            'ViewExpandedText': 'string',
                            'ValidationConnection': 'string',
                            'IsStale': True|False
                        },
                    ]
                },
                'IsMultiDialectView': True|False,
                'IsMaterializedView': True|False,
                'IcebergTableMetadata': {
                    'FormatVersion': 'string',
                    'TableUuid': 'string',
                    'Location': 'string',
                    'Properties': {
                        'string': 'string'
                    },
                    'Schemas': [
                        {
                            'SchemaId': 123,
                            'IdentifierFieldIds': [
                                123,
                            ],
                            'Type': 'struct',
                            'Fields': [
                                {
                                    'Id': 123,
                                    'Name': 'string',
                                    'Type': {...}|[...]|123|123.4|'string'|True|None,
                                    'Required': True|False,
                                    'Doc': 'string',
                                    'InitialDefault': {...}|[...]|123|123.4|'string'|True|None,
                                    'WriteDefault': {...}|[...]|123|123.4|'string'|True|None
                                },
                            ]
                        },
                    ],
                    'CurrentSchemaId': 123,
                    'LastColumnId': 123,
                    'PartitionSpecs': [
                        {
                            'Fields': [
                                {
                                    'SourceId': 123,
                                    'Transform': 'string',
                                    'Name': 'string',
                                    'FieldId': 123
                                },
                            ],
                            'SpecId': 123
                        },
                    ],
                    'DefaultSpecId': 123,
                    'LastPartitionId': 123,
                    'SortOrders': [
                        {
                            'OrderId': 123,
                            'Fields': [
                                {
                                    'SourceId': 123,
                                    'Transform': 'string',
                                    'Direction': 'asc'|'desc',
                                    'NullOrder': 'nulls-first'|'nulls-last'
                                },
                            ]
                        },
                    ],
                    'DefaultSortOrderId': 123
                },
                'Status': {
                    'RequestedBy': 'string',
                    'UpdatedBy': 'string',
                    'RequestTime': datetime(2015, 1, 1),
                    'UpdateTime': datetime(2015, 1, 1),
                    'Action': 'UPDATE'|'CREATE',
                    'State': 'QUEUED'|'IN_PROGRESS'|'SUCCESS'|'STOPPED'|'FAILED',
                    'Error': {
                        'ErrorCode': 'string',
                        'ErrorMessage': 'string'
                    },
                    'Details': {
                        'RequestedChange': {'... recursive ...'},
                        'ViewValidations': [
                            {
                                'Dialect': 'REDSHIFT'|'ATHENA'|'SPARK',
                                'DialectVersion': 'string',
                                'ViewValidationText': 'string',
                                'UpdateTime': datetime(2015, 1, 1),
                                'State': 'QUEUED'|'IN_PROGRESS'|'SUCCESS'|'STOPPED'|'FAILED',
                                'Error': {
                                    'ErrorCode': 'string',
                                    'ErrorMessage': 'string'
                                }
                            },
                        ]
                    }
                }
            },
            'VersionId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • TableVersions (list) –

    A list of strings identifying available versions of the specified table.

    • (dict) –

      Specifies a version of a table.

      • Table (dict) –

        The table in question.

        • Name (string) –

          The table name. For Hive compatibility, this must be entirely lowercase.

        • DatabaseName (string) –

          The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.

        • Description (string) –

          A description of the table.

        • Owner (string) –

          The owner of the table.

        • CreateTime (datetime) –

          The time when the table definition was created in the Data Catalog.

        • UpdateTime (datetime) –

          The last time that the table was updated.

        • LastAccessTime (datetime) –

          The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.

        • LastAnalyzedTime (datetime) –

          The last time that column statistics were computed for this table.

        • Retention (integer) –

          The retention time for this table.

        • StorageDescriptor (dict) –

          A storage descriptor containing information about the physical storage of this table.

          • Columns (list) –

            A list of the Columns in the table.

            • (dict) –

              A column in a Table.

              • Name (string) –

                The name of the Column.

              • Type (string) –

                The data type of the Column.

              • Comment (string) –

                A free-form text comment.

              • Parameters (dict) –

                These key-value pairs define properties associated with the column.

                • (string) –

                  • (string) –

          • Location (string) –

            The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

          • AdditionalLocations (list) –

            A list of locations that point to the path where a Delta table is located.

            • (string) –

          • InputFormat (string) –

            The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

          • OutputFormat (string) –

            The output format: 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) –

            Must be specified if the table contains any dimension columns.

          • SerdeInfo (dict) –

            The serialization/deserialization (SerDe) information.

            • Name (string) –

              Name of the SerDe.

            • SerializationLibrary (string) –

              Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

            • Parameters (dict) –

              These key-value pairs define initialization parameters for the SerDe.

              • (string) –

                • (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.

            • (dict) –

              Specifies the sort order of a sorted column.

              • Column (string) –

                The name of the column.

              • SortOrder (integer) –

                Indicates that the column is sorted in ascending order ( == 1), or in descending order ( ==0).

          • Parameters (dict) –

            The user-supplied properties in key-value form.

            • (string) –

              • (string) –

          • SkewedInfo (dict) –

            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 (dict) –

              A mapping of skewed values to the columns that contain them.

              • (string) –

                • (string) –

          • StoredAsSubDirectories (boolean) –

            True if the table data is stored in subdirectories, or False if not.

          • SchemaReference (dict) –

            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 (dict) –

              A structure that contains schema identity fields. Either this or the SchemaVersionId has to be provided.

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

            • SchemaVersionId (string) –

              The unique ID assigned to a version of the schema. Either this or the SchemaId has to be provided.

            • SchemaVersionNumber (integer) –

              The version number of the schema.

        • 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": []

          • (dict) –

            A column in a Table.

            • Name (string) –

              The name of the Column.

            • Type (string) –

              The data type of the Column.

            • Comment (string) –

              A free-form text comment.

            • Parameters (dict) –

              These key-value pairs define properties associated with the column.

              • (string) –

                • (string) –

        • ViewOriginalText (string) –

          Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.

        • ViewExpandedText (string) –

          Included for Apache Hive compatibility. Not used in the normal course of Glue operations.

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

          EXTERNAL_TABLE

          Hive compatible attribute - indicates a non-Hive managed table.

          GOVERNED

          Used by Lake Formation. The Glue Data Catalog understands GOVERNED.

        • Parameters (dict) –

          These key-value pairs define properties associated with the table.

          • (string) –

            • (string) –

        • CreatedBy (string) –

          The person or entity who created the table.

        • IsRegisteredWithLakeFormation (boolean) –

          Indicates whether the table has been registered with Lake Formation.

        • TargetTable (dict) –

          A TableIdentifier structure that describes a target table for resource linking.

          • CatalogId (string) –

            The ID of the Data Catalog in which the table resides.

          • DatabaseName (string) –

            The name of the catalog database that contains the target table.

          • Name (string) –

            The name of the target table.

          • Region (string) –

            Region of the target table.

        • CatalogId (string) –

          The ID of the Data Catalog in which the table resides.

        • VersionId (string) –

          The ID of the table version.

        • FederatedTable (dict) –

          A FederatedTable structure that references an entity outside the Glue Data Catalog.

          • Identifier (string) –

            A unique identifier for the federated table.

          • DatabaseIdentifier (string) –

            A unique identifier for the federated database.

          • ConnectionName (string) –

            The name of the connection to the external metastore.

          • ConnectionType (string) –

            The type of connection used to access the federated table, specifying the protocol or method for connecting to the external data source.

        • ViewDefinition (dict) –

          A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.

          • IsProtected (boolean) –

            You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine’s documentation to understand the guarantees provided, if any.

          • Definer (string) –

            The definer of a view in SQL.

          • ViewVersionId (integer) –

            The ID value that identifies this view’s version. For materialized views, the version ID is the Apache Iceberg table’s snapshot ID.

          • ViewVersionToken (string) –

            The version ID of the Apache Iceberg table.

          • RefreshSeconds (integer) –

            Auto refresh interval in seconds for the materialized view. If not specified, the view will not automatically refresh.

          • LastRefreshType (string) –

            Sets the method used for the most recent refresh.

          • SubObjects (list) –

            A list of table Amazon Resource Names (ARNs).

            • (string) –

          • SubObjectVersionIds (list) –

            List of the Apache Iceberg table versions referenced by the materialized view.

            • (integer) –

          • Representations (list) –

            A list of representations.

            • (dict) –

              A structure that contains the dialect of the view, and the query that defines the view.

              • Dialect (string) –

                The dialect of the query engine.

              • DialectVersion (string) –

                The version of the dialect of the query engine. For example, 3.0.0.

              • ViewOriginalText (string) –

                The 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) –

                The name of the connection to be used to validate the specific representation of the view.

              • IsStale (boolean) –

                Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.

        • IsMultiDialectView (boolean) –

          Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.

        • IsMaterializedView (boolean) –

          Indicates a table is a MaterializedView.

        • IcebergTableMetadata (dict) –

          The latest Apache Iceberg table metadata for the table, including format version, schemas, partition specifications, and sort orders. This field is populated for Iceberg tables and reflects the current state of the table’s Iceberg metadata.

          • FormatVersion (string) –

            The Apache Iceberg table format version, such as 1 or 2. Determines the set of features and on-disk layout supported by the table.

          • TableUuid (string) –

            The unique identifier (UUID) for the Iceberg table, assigned when the table is created and used to track the table across metadata updates.

          • Location (string) –

            The base S3 location where the Iceberg table’s data and metadata files are stored.

          • Properties (dict) –

            A map of key-value pairs that define table-level properties and configuration settings for the Iceberg table.

            • (string) –

              • (string) –

          • Schemas (list) –

            The list of schemas that have been associated with the Iceberg table over its history, supporting schema evolution.

            • (dict) –

              Defines the schema structure for an Iceberg table, including field definitions, data types, and schema metadata.

              • SchemaId (integer) –

                The unique identifier for this schema version within the Iceberg table’s schema evolution history.

              • IdentifierFieldIds (list) –

                The list of field identifiers that uniquely identify records in the table, used for row-level operations and deduplication.

                • (integer) –

              • Type (string) –

                The root type of the schema structure, typically “struct” for Iceberg table schemas.

              • Fields (list) –

                The list of field definitions that make up the table schema, including field names, types, and metadata.

                • (dict) –

                  Defines a single field within an Iceberg table schema, including its identifier, name, data type, nullability, and documentation.

                  • Id (integer) –

                    The unique identifier assigned to this field within the Iceberg table schema, used for schema evolution and field tracking.

                  • Name (string) –

                    The name of the field as it appears in the table schema and query operations.

                  • Type (document) –

                    The data type definition for this field, specifying the structure and format of the data it contains.

                  • Required (boolean) –

                    Indicates whether this field is required (non-nullable) or optional (nullable) in the table schema.

                  • Doc (string) –

                    Optional documentation or description text that provides additional context about the purpose and usage of this field.

                  • InitialDefault (document) –

                    Default value used to populate the field’s value for all records that were written before the field was added to the schema. This enables backward compatibility when adding new fields to existing Iceberg tables.

                  • WriteDefault (document) –

                    Default value used to populate the field’s value for any records written after the field was added to the schema, if the writer does not supply the field’s value. This can be changed through schema evolution.

          • CurrentSchemaId (integer) –

            The identifier of the schema that is currently active for the Iceberg table. Matches an entry in Schemas.

          • LastColumnId (integer) –

            The highest column identifier that has been assigned in the Iceberg table’s schema, used to ensure unique IDs as new columns are added.

          • PartitionSpecs (list) –

            The list of partition specifications that have been associated with the Iceberg table over its history, supporting partition evolution.

            • (dict) –

              Defines the partitioning specification for an Iceberg table, determining how table data will be organized and partitioned for optimal query performance.

              • Fields (list) –

                The list of partition fields that define how the table data should be partitioned, including source fields and their transformations.

                • (dict) –

                  Defines a single partition field within an Iceberg partition specification, including the source field, transformation function, partition name, and unique identifier.

                  • SourceId (integer) –

                    The identifier of the source field from the table schema that this partition field is based on.

                  • Transform (string) –

                    The transformation function applied to the source field to create the partition, such as identity, bucket, truncate, year, month, day, or hour.

                  • Name (string) –

                    The name of the partition field as it will appear in the partitioned table structure.

                  • FieldId (integer) –

                    The unique identifier assigned to this partition field within the Iceberg table’s partition specification.

              • SpecId (integer) –

                The unique identifier for this partition specification within the Iceberg table’s metadata history.

          • DefaultSpecId (integer) –

            The identifier of the partition specification that is currently used by default when writing new data to the Iceberg table.

          • LastPartitionId (integer) –

            The highest partition field identifier that has been assigned across the table’s partition specifications.

          • SortOrders (list) –

            The list of sort order specifications that have been associated with the Iceberg table over its history.

            • (dict) –

              Defines the sort order specification for an Iceberg table, determining how data should be ordered within partitions to optimize query performance.

              • OrderId (integer) –

                The unique identifier for this sort order specification within the Iceberg table’s metadata.

              • Fields (list) –

                The list of fields and their sort directions that define the ordering criteria for the Iceberg table data.

                • (dict) –

                  Defines a single field within an Iceberg sort order specification, including the source field, transformation, sort direction, and null value ordering.

                  • SourceId (integer) –

                    The identifier of the source field from the table schema that this sort field is based on.

                  • Transform (string) –

                    The transformation function applied to the source field before sorting, such as identity, bucket, or truncate.

                  • Direction (string) –

                    The sort direction for this field, either ascending or descending.

                  • NullOrder (string) –

                    The ordering behavior for null values in this field, specifying whether nulls should appear first or last in the sort order.

          • DefaultSortOrderId (integer) –

            The identifier of the sort order that is currently used by default when writing new data to the Iceberg table.

        • Status (dict) –

          Indicates the the state of an asynchronous change to a table.

          • RequestedBy (string) –

            The ARN of the user who requested the asynchronous change.

          • UpdatedBy (string) –

            The ARN of the user to last manually alter the asynchronous change (requesting cancellation, etc).

          • RequestTime (datetime) –

            An ISO 8601 formatted date string indicating the time that the change was initiated.

          • UpdateTime (datetime) –

            An ISO 8601 formatted date string indicating the time that the state was last updated.

          • Action (string) –

            Indicates which action was called on the table, currently only CREATE or UPDATE.

          • State (string) –

            A generic status for the change in progress, such as QUEUED, IN_PROGRESS, SUCCESS, or FAILED.

          • Error (dict) –

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

              The code associated with this error.

            • ErrorMessage (string) –

              A message describing the error.

          • Details (dict) –

            A StatusDetails object with information about the requested change.

            • RequestedChange (dict) –

              A Table object representing the requested changes.

            • ViewValidations (list) –

              A list of ViewValidation objects that contain information for an analytical engine to validate a view.

              • (dict) –

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

                  The dialect of the query engine.

                • DialectVersion (string) –

                  The version of the dialect of the query engine. For example, 3.0.0.

                • ViewValidationText (string) –

                  The SELECT query that defines the view, as provided by the customer.

                • UpdateTime (datetime) –

                  The time of the last update.

                • State (string) –

                  The state of the validation.

                • Error (dict) –

                  An error associated with the validation.

                  • ErrorCode (string) –

                    The code associated with this error.

                  • ErrorMessage (string) –

                    A message describing the error.

      • VersionId (string) –

        The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1.

  • NextToken (string) –

    A continuation token, if the list of available versions does not include the last one.

Exceptions

• Glue.Client.exceptions.EntityNotFoundException

• Glue.Client.exceptions.InvalidInputException

• Glue.Client.exceptions.InternalServiceException

• Glue.Client.exceptions.OperationTimeoutException

• Glue.Client.exceptions.GlueEncryptionException