LakeFormation / Client / get_table_objects

get_table_objects#

LakeFormation.Client.get_table_objects(**kwargs)#

Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.

See also: AWS API Documentation

Request Syntax

response = client.get_table_objects(
    CatalogId='string',
    DatabaseName='string',
    TableName='string',
    TransactionId='string',
    QueryAsOfTime=datetime(2015, 1, 1),
    PartitionPredicate='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • CatalogId (string) – The catalog containing the governed table. Defaults to the caller’s account.

  • DatabaseName (string) –

    [REQUIRED]

    The database containing the governed table.

  • TableName (string) –

    [REQUIRED]

    The governed table for which to retrieve objects.

  • TransactionId (string) – 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.

  • QueryAsOfTime (datetime) – 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.

  • PartitionPredicate (string) –

    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.

  • MaxResults (integer) – Specifies how many values to return in a page.

  • NextToken (string) – A continuation token if this is not the first call to retrieve these objects.

Return type:

dict

Returns:

Response Syntax

{
    'Objects': [
        {
            'PartitionValues': [
                'string',
            ],
            'Objects': [
                {
                    'Uri': 'string',
                    'ETag': 'string',
                    'Size': 123
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Objects (list) –

      A list of objects organized by partition keys.

      • (dict) –

        A structure containing a list of partition values and table objects.

        • PartitionValues (list) –

          A list of partition values.

          • (string) –

        • Objects (list) –

          A list of table objects

          • (dict) –

            Specifies the details of a governed table.

            • Uri (string) –

              The Amazon S3 location of the object.

            • ETag (string) –

              The Amazon S3 ETag of the object. Returned by GetTableObjects for validation and used to identify changes to the underlying data.

            • Size (integer) –

              The size of the Amazon S3 object in bytes.

    • NextToken (string) –

      A continuation token indicating whether additional data is available.

Exceptions

  • LakeFormation.Client.exceptions.EntityNotFoundException

  • LakeFormation.Client.exceptions.InternalServiceException

  • LakeFormation.Client.exceptions.InvalidInputException

  • LakeFormation.Client.exceptions.OperationTimeoutException

  • LakeFormation.Client.exceptions.TransactionCommittedException

  • LakeFormation.Client.exceptions.TransactionCanceledException

  • LakeFormation.Client.exceptions.ResourceNotReadyException