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

Amazonka.LakeFormation.GetTableObjects

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Synopsis

data GetTableObjects = GetTableObjects' {
- catalogId :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- partitionPredicate :: Maybe Text
- queryAsOfTime :: Maybe POSIX
- transactionId :: Maybe Text
- databaseName :: Text
- tableName :: Text
}
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.

Constructors

GetTableObjects'

Fields

catalogId :: Maybe Text
The catalog containing the governed table. Defaults to the caller’s account.
maxResults :: Maybe Natural
Specifies how many values to return in a page.
nextToken :: Maybe Text
A continuation token if this is not the first call to retrieve these objects.
partitionPredicate :: Maybe Text
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.
queryAsOfTime :: Maybe POSIX
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.
transactionId :: Maybe Text
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.
databaseName :: Text
The database containing the governed table.
tableName :: Text
The governed table for which to retrieve objects.

Instances

Instances details

ToJSON GetTableObjects Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects Methods toJSON :: GetTableObjects -> Value # toEncoding :: GetTableObjects -> Encoding # toJSONList :: [GetTableObjects] -> Value # toEncodingList :: [GetTableObjects] -> Encoding #
ToHeaders GetTableObjects Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects Methods toHeaders :: GetTableObjects -> [Header] #
ToPath GetTableObjects Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects Methods toPath :: GetTableObjects -> ByteString #
ToQuery GetTableObjects Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects Methods toQuery :: GetTableObjects -> QueryString #
AWSRequest GetTableObjects Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects Associated Types type AWSResponse GetTableObjects # Methods request :: (Service -> Service) -> GetTableObjects -> Request GetTableObjects # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetTableObjects -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetTableObjects))) #
Generic GetTableObjects Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects Associated Types type Rep GetTableObjects :: Type -> Type # Methods from :: GetTableObjects -> Rep GetTableObjects x # to :: Rep GetTableObjects x -> GetTableObjects #
Read GetTableObjects Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects Methods readsPrec :: Int -> ReadS GetTableObjects # readList :: ReadS [GetTableObjects] # readPrec :: ReadPrec GetTableObjects # readListPrec :: ReadPrec [GetTableObjects] #
Show GetTableObjects Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects Methods showsPrec :: Int -> GetTableObjects -> ShowS # show :: GetTableObjects -> String # showList :: [GetTableObjects] -> ShowS #
NFData GetTableObjects Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects Methods rnf :: GetTableObjects -> () #
Eq GetTableObjects Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects Methods (==) :: GetTableObjects -> GetTableObjects -> Bool # (/=) :: GetTableObjects -> GetTableObjects -> Bool #
Hashable GetTableObjects Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects Methods hashWithSalt :: Int -> GetTableObjects -> Int # hash :: GetTableObjects -> Int #
type AWSResponse GetTableObjects Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects type AWSResponse GetTableObjects = GetTableObjectsResponse
type Rep GetTableObjects Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects type Rep GetTableObjects = D1 ('MetaData "GetTableObjects" "Amazonka.LakeFormation.GetTableObjects" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "GetTableObjects'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "catalogId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "partitionPredicate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "queryAsOfTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "transactionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetTableObjects Source #

Arguments

:: Text	`GetTableObjects`
-> Text	`GetTableObjects`
-> GetTableObjects

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.

Constructors

GetTableObjectsResponse'
Fields nextToken :: Maybe Text A continuation token indicating whether additional data is available. objects :: Maybe [PartitionObjects] A list of objects organized by partition keys. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetTableObjectsResponse Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects Associated Types type Rep GetTableObjectsResponse :: Type -> Type # Methods from :: GetTableObjectsResponse -> Rep GetTableObjectsResponse x # to :: Rep GetTableObjectsResponse x -> GetTableObjectsResponse #
Read GetTableObjectsResponse Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects Methods readsPrec :: Int -> ReadS GetTableObjectsResponse # readList :: ReadS [GetTableObjectsResponse] # readPrec :: ReadPrec GetTableObjectsResponse # readListPrec :: ReadPrec [GetTableObjectsResponse] #
Show GetTableObjectsResponse Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects Methods showsPrec :: Int -> GetTableObjectsResponse -> ShowS # show :: GetTableObjectsResponse -> String # showList :: [GetTableObjectsResponse] -> ShowS #
NFData GetTableObjectsResponse Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects Methods rnf :: GetTableObjectsResponse -> () #
Eq GetTableObjectsResponse Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects Methods (==) :: GetTableObjectsResponse -> GetTableObjectsResponse -> Bool # (/=) :: GetTableObjectsResponse -> GetTableObjectsResponse -> Bool #
type Rep GetTableObjectsResponse Source #
Instance details Defined in Amazonka.LakeFormation.GetTableObjects type Rep GetTableObjectsResponse = D1 ('MetaData "GetTableObjectsResponse" "Amazonka.LakeFormation.GetTableObjects" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "GetTableObjectsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "objects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PartitionObjects])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetTableObjectsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetTableObjectsResponse'`
-> GetTableObjectsResponse

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.