Get Table Objects

lakeformation_get_table_objects

R Documentation

Returns the set of Amazon S3 objects that make up the specified governed table¶

Description¶

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.

Usage¶

lakeformation_get_table_objects(CatalogId, DatabaseName, TableName,
  TransactionId, QueryAsOfTime, PartitionPredicate, MaxResults, NextToken)

Arguments¶

CatalogId

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

DatabaseName

[required] The database containing the governed table.

TableName

[required] The governed table for which to retrieve objects.

TransactionId

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

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

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

Specifies how many values to return in a page.

NextToken

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

Value¶

A list with the following syntax:

list(
  Objects = list(
    list(
      PartitionValues = list(
        "string"
      ),
      Objects = list(
        list(
          Uri = "string",
          ETag = "string",
          Size = 123
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$get_table_objects(
  CatalogId = "string",
  DatabaseName = "string",
  TableName = "string",
  TransactionId = "string",
  QueryAsOfTime = as.POSIXct(
    "2015-01-01"
  ),
  PartitionPredicate = "string",
  MaxResults = 123,
  NextToken = "string"
)