Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data GetTableObjects = GetTableObjects' {}
- newGetTableObjects :: Text -> Text -> GetTableObjects
- getTableObjects_catalogId :: Lens' GetTableObjects (Maybe Text)
- getTableObjects_maxResults :: Lens' GetTableObjects (Maybe Natural)
- getTableObjects_nextToken :: Lens' GetTableObjects (Maybe Text)
- getTableObjects_partitionPredicate :: Lens' GetTableObjects (Maybe Text)
- getTableObjects_queryAsOfTime :: Lens' GetTableObjects (Maybe UTCTime)
- getTableObjects_transactionId :: Lens' GetTableObjects (Maybe Text)
- getTableObjects_databaseName :: Lens' GetTableObjects Text
- getTableObjects_tableName :: Lens' GetTableObjects Text
- data GetTableObjectsResponse = GetTableObjectsResponse' {
- nextToken :: Maybe Text
- objects :: Maybe [PartitionObjects]
- httpStatus :: Int
- newGetTableObjectsResponse :: Int -> GetTableObjectsResponse
- getTableObjectsResponse_nextToken :: Lens' GetTableObjectsResponse (Maybe Text)
- getTableObjectsResponse_objects :: Lens' GetTableObjectsResponse (Maybe [PartitionObjects])
- getTableObjectsResponse_httpStatus :: Lens' GetTableObjectsResponse Int
Creating a Request
data GetTableObjects Source #
See: newGetTableObjects
smart constructor.
GetTableObjects' | |
|
Instances
Create a value of GetTableObjects
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTableObjects
, getTableObjects_catalogId
- The catalog containing the governed table. Defaults to the caller’s
account.
$sel:maxResults:GetTableObjects'
, getTableObjects_maxResults
- Specifies how many values to return in a page.
GetTableObjects
, getTableObjects_nextToken
- A continuation token if this is not the first call to retrieve these
objects.
$sel:partitionPredicate:GetTableObjects'
, getTableObjects_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.
GetTableObjects
, getTableObjects_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
.
GetTableObjects
, getTableObjects_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
.
GetTableObjects
, getTableObjects_databaseName
- The database containing the governed table.
GetTableObjects
, getTableObjects_tableName
- The governed table for which to retrieve objects.
Request Lenses
getTableObjects_catalogId :: Lens' GetTableObjects (Maybe Text) Source #
The catalog containing the governed table. Defaults to the caller’s account.
getTableObjects_maxResults :: Lens' GetTableObjects (Maybe Natural) Source #
Specifies how many values to return in a page.
getTableObjects_nextToken :: Lens' GetTableObjects (Maybe Text) Source #
A continuation token if this is not the first call to retrieve these objects.
getTableObjects_partitionPredicate :: Lens' GetTableObjects (Maybe Text) Source #
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.
getTableObjects_queryAsOfTime :: Lens' GetTableObjects (Maybe UTCTime) Source #
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
.
getTableObjects_transactionId :: Lens' GetTableObjects (Maybe Text) Source #
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
.
getTableObjects_databaseName :: Lens' GetTableObjects Text Source #
The database containing the governed table.
getTableObjects_tableName :: Lens' GetTableObjects Text Source #
The governed table for which to retrieve objects.
Destructuring the Response
data GetTableObjectsResponse Source #
See: newGetTableObjectsResponse
smart constructor.
GetTableObjectsResponse' | |
|
Instances
newGetTableObjectsResponse Source #
Create a value of GetTableObjectsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTableObjects
, getTableObjectsResponse_nextToken
- A continuation token indicating whether additional data is available.
GetTableObjectsResponse
, getTableObjectsResponse_objects
- A list of objects organized by partition keys.
$sel:httpStatus:GetTableObjectsResponse'
, getTableObjectsResponse_httpStatus
- The response's http status code.
Response Lenses
getTableObjectsResponse_nextToken :: Lens' GetTableObjectsResponse (Maybe Text) Source #
A continuation token indicating whether additional data is available.
getTableObjectsResponse_objects :: Lens' GetTableObjectsResponse (Maybe [PartitionObjects]) Source #
A list of objects organized by partition keys.
getTableObjectsResponse_httpStatus :: Lens' GetTableObjectsResponse Int Source #
The response's http status code.