Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetTableObjects

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.

Request Syntax


{
   "CatalogId": "string",
   "DatabaseName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "PartitionPredicate": "string",
   "QueryAsOfTime": number,
   "TableName": "string",
   "TransactionId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CatalogId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

DatabaseName

The database containing the governed table.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

MaxResults

Specifies how many values to return in a page.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

NextToken

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

Type: String

Length Constraints: Maximum length of 4096.

Required: No

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

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.

Type: Timestamp

Required: No

TableName

The governed table for which to retrieve objects.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\p{L}\p{N}\p{P}]*

Required: No

Response Syntax


{
   "NextToken": "string",
   "Objects": [ 
      { 
         "Objects": [ 
            { 
               "ETag": "string",
               "Size": number,
               "Uri": "string"
            }
         ],
         "PartitionValues": [ "string" ]
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

A continuation token indicating whether additional data is available.

Type: String

Length Constraints: Maximum length of 4096.

Objects

A list of objects organized by partition keys.

Type: Array of PartitionObjects objects

Errors

For information about the errors that are common to all actions, see Common Errors.

EntityNotFoundException

A specified entity does not exist.

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400

ResourceNotReadyException

Contains details about an error related to a resource which is not ready for a transaction.

HTTP Status Code: 400

TransactionCanceledException

Contains details about an error related to a transaction that was cancelled.

HTTP Status Code: 400

TransactionCommittedException

Contains details about an error where the specified transaction has already been committed and cannot be used for UpdateTableObjects.

HTTP Status Code: 400