Skip to content

GetTableRequest

Source code in docs_src/capo_glue/types/get_table_request.py
class GetTableRequest(TypedDict, closed=True):
    catalog_id: NotRequired["capo_glue.types.catalog_id_string.CatalogIdString"]
    """<p>The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.</p>"""
    database_name: "capo_glue.types.name_string.NameString"
    """<p>The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.</p>"""
    name: "capo_glue.types.name_string.NameString"
    """<p>The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.</p>"""
    transaction_id: NotRequired[
        "capo_glue.types.transaction_id_string.TransactionIdString"
    ]
    """<p>The transaction ID at which to read the table contents. </p>"""
    query_as_of_time: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with <code>TransactionId</code>.</p>"""
    audit_context: NotRequired["capo_glue.types.audit_context.AuditContext"]
    """<p>A structure containing the Lake Formation <a href="https://docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html">audit context</a>.</p>"""
    include_status_details: NotRequired[
        "capo_glue.types.boolean_nullable.BooleanNullable"
    ]
    """<p>Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.</p>"""
    attributes_to_get: NotRequired[
        "capo_glue.types.table_attributes_list.TableAttributesList"
    ]
    """<p>Specifies the table fields returned by the <code>GetTable</code> call. This parameter doesn't accept an empty list.</p> <p>The following are the valid combinations of values:</p> <ul> <li> <p> <code>DEFAULT</code> - Returns the Hive-style table definition only.</p> </li> <li> <p> <code>LATEST_ICEBERG_METADATA</code> - Returns only the latest Apache Iceberg table metadata.</p> </li> <li> <p> <code>DEFAULT</code>, <code>LATEST_ICEBERG_METADATA</code> - Returns both the Hive-style table definition and the latest Apache Iceberg table metadata.</p> </li> </ul>"""

attributes_to_get instance-attribute

attributes_to_get: NotRequired[TableAttributesList]

Specifies the table fields returned by the GetTable call. This parameter doesn't accept an empty list.

The following are the valid combinations of values:

  • DEFAULT - Returns the Hive-style table definition only.

  • LATEST_ICEBERG_METADATA - Returns only the latest Apache Iceberg table metadata.

  • DEFAULT, LATEST_ICEBERG_METADATA - Returns both the Hive-style table definition and the latest Apache Iceberg table metadata.

audit_context instance-attribute

audit_context: NotRequired[AuditContext]

A structure containing the Lake Formation audit context.

catalog_id instance-attribute

catalog_id: NotRequired[CatalogIdString]

The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.

database_name instance-attribute

database_name: NameString

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

include_status_details instance-attribute

include_status_details: NotRequired[BooleanNullable]

Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.

name instance-attribute

name: NameString

The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.

query_as_of_time instance-attribute

query_as_of_time: NotRequired[Timestamp]

The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.

transaction_id instance-attribute

transaction_id: NotRequired[TransactionIdString]

The transaction ID at which to read the table contents.