Skip to content

GetTableObjectsRequest

Source code in docs_src/capo_lakeformation/types/get_table_objects_request.py
class GetTableObjectsRequest(TypedDict, closed=True):
    catalog_id: NotRequired[
        "capo_lakeformation.types.catalog_id_string.CatalogIdString"
    ]
    """<p>The catalog containing the governed table. Defaults to the caller’s account.</p>"""
    database_name: "capo_lakeformation.types.name_string.NameString"
    """<p>The database containing the governed table.</p>"""
    table_name: "capo_lakeformation.types.name_string.NameString"
    """<p>The governed table for which to retrieve objects.</p>"""
    transaction_id: NotRequired[
        "capo_lakeformation.types.transaction_id_string.TransactionIdString"
    ]
    """<p>The transaction ID at which to read the governed table contents. If this transaction has aborted, an error is returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with <code>QueryAsOfTime</code>.</p>"""
    query_as_of_time: NotRequired["capo_lakeformation.types.timestamp.Timestamp"]
    """<p>The time as of when to read the governed table contents. If not set, the most recent transaction commit time is used. Cannot be specified along with <code>TransactionId</code>.</p>"""
    partition_predicate: NotRequired[
        "capo_lakeformation.types.predicate_string.PredicateString"
    ]
    """<p>A predicate to filter the objects returned based on the partition keys defined in the governed table.</p> <ul> <li> <p>The comparison operators supported are: =, >, <, >=, <=</p> </li> <li> <p>The logical operators supported are: AND</p> </li> <li> <p>The data types supported are integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss"), string and decimal.</p> </li> </ul>"""
    max_results: NotRequired["capo_lakeformation.types.page_size.PageSize"]
    """<p>Specifies how many values to return in a page.</p>"""
    next_token: NotRequired["capo_lakeformation.types.token_string.TokenString"]
    """<p>A continuation token if this is not the first call to retrieve these objects.</p>"""

catalog_id instance-attribute

catalog_id: NotRequired[CatalogIdString]

The catalog containing the governed table. Defaults to the caller’s account.

database_name instance-attribute

database_name: NameString

The database containing the governed table.

max_results instance-attribute

max_results: NotRequired[PageSize]

Specifies how many values to return in a page.

next_token instance-attribute

next_token: NotRequired[TokenString]

A continuation token if this is not the first call to retrieve these objects.

partition_predicate instance-attribute

partition_predicate: NotRequired[PredicateString]

A predicate to filter the objects returned based on the partition keys defined in the governed table.

  • The comparison operators supported are: =, >, <, >=, <=

  • The logical operators supported are: AND

  • The data types supported are integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss"), string and decimal.

query_as_of_time instance-attribute

query_as_of_time: NotRequired[Timestamp]

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

table_name instance-attribute

table_name: NameString

The governed table for which to retrieve objects.

transaction_id instance-attribute

transaction_id: NotRequired[TransactionIdString]

The transaction ID at which to read the governed table contents. If this transaction has aborted, an error is returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with QueryAsOfTime.