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.Glue.GetTable

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the Table definition in a Data Catalog for a specified table.

Synopsis

data GetTable = GetTable' {
- catalogId :: Maybe Text
- queryAsOfTime :: Maybe POSIX
- transactionId :: Maybe Text
- databaseName :: Text
- name :: Text
}
newGetTable :: Text -> Text -> GetTable
getTable_catalogId :: Lens' GetTable (Maybe Text)
getTable_queryAsOfTime :: Lens' GetTable (Maybe UTCTime)
getTable_transactionId :: Lens' GetTable (Maybe Text)
getTable_databaseName :: Lens' GetTable Text
getTable_name :: Lens' GetTable Text
data GetTableResponse = GetTableResponse' {
- table :: Maybe Table
- httpStatus :: Int
}
newGetTableResponse :: Int -> GetTableResponse
getTableResponse_table :: Lens' GetTableResponse (Maybe Table)
getTableResponse_httpStatus :: Lens' GetTableResponse Int

Creating a Request

data GetTable Source #

See: newGetTable smart constructor.

Constructors

GetTable'

Fields

catalogId :: Maybe Text
The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.
queryAsOfTime :: Maybe POSIX
The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.
transactionId :: Maybe Text
The transaction ID at which to read the table contents.
databaseName :: Text
The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
name :: Text
The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.

Instances

Instances details

ToJSON GetTable Source #
Instance details Defined in Amazonka.Glue.GetTable Methods toJSON :: GetTable -> Value # toEncoding :: GetTable -> Encoding # toJSONList :: [GetTable] -> Value # toEncodingList :: [GetTable] -> Encoding #
ToHeaders GetTable Source #
Instance details Defined in Amazonka.Glue.GetTable Methods toHeaders :: GetTable -> [Header] #
ToPath GetTable Source #
Instance details Defined in Amazonka.Glue.GetTable Methods toPath :: GetTable -> ByteString #
ToQuery GetTable Source #
Instance details Defined in Amazonka.Glue.GetTable Methods toQuery :: GetTable -> QueryString #
AWSRequest GetTable Source #
Instance details Defined in Amazonka.Glue.GetTable Associated Types type AWSResponse GetTable # Methods request :: (Service -> Service) -> GetTable -> Request GetTable # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetTable -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetTable))) #
Generic GetTable Source #
Instance details Defined in Amazonka.Glue.GetTable Associated Types type Rep GetTable :: Type -> Type # Methods from :: GetTable -> Rep GetTable x # to :: Rep GetTable x -> GetTable #
Read GetTable Source #
Instance details Defined in Amazonka.Glue.GetTable Methods readsPrec :: Int -> ReadS GetTable # readList :: ReadS [GetTable] # readPrec :: ReadPrec GetTable # readListPrec :: ReadPrec [GetTable] #
Show GetTable Source #
Instance details Defined in Amazonka.Glue.GetTable Methods showsPrec :: Int -> GetTable -> ShowS # show :: GetTable -> String # showList :: [GetTable] -> ShowS #
NFData GetTable Source #
Instance details Defined in Amazonka.Glue.GetTable Methods rnf :: GetTable -> () #
Eq GetTable Source #
Instance details Defined in Amazonka.Glue.GetTable Methods (==) :: GetTable -> GetTable -> Bool # (/=) :: GetTable -> GetTable -> Bool #
Hashable GetTable Source #
Instance details Defined in Amazonka.Glue.GetTable Methods hashWithSalt :: Int -> GetTable -> Int # hash :: GetTable -> Int #
type AWSResponse GetTable Source #
Instance details Defined in Amazonka.Glue.GetTable type AWSResponse GetTable = GetTableResponse
type Rep GetTable Source #
Instance details Defined in Amazonka.Glue.GetTable type Rep GetTable = D1 ('MetaData "GetTable" "Amazonka.Glue.GetTable" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetTable'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "catalogId") '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 "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetTable Source #

Arguments

:: Text	`GetTable`
-> Text	`GetTable`
-> GetTable

Create a value of GetTable 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:

GetTable, getTable_catalogId - The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.

$sel:queryAsOfTime:GetTable', getTable_queryAsOfTime - The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.

$sel:transactionId:GetTable', getTable_transactionId - The transaction ID at which to read the table contents.

GetTable, getTable_databaseName - The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

GetTable, getTable_name - The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.

Request Lenses

getTable_catalogId :: Lens' GetTable (Maybe Text) Source #

The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.

getTable_queryAsOfTime :: Lens' GetTable (Maybe UTCTime) Source #

The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.

getTable_transactionId :: Lens' GetTable (Maybe Text) Source #

The transaction ID at which to read the table contents.

getTable_databaseName :: Lens' GetTable Text Source #

The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

getTable_name :: Lens' GetTable Text Source #

The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.

Destructuring the Response

data GetTableResponse Source #

See: newGetTableResponse smart constructor.

Constructors

GetTableResponse'
Fields table :: Maybe Table The `Table` object that defines the specified table. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetTableResponse Source #
Instance details Defined in Amazonka.Glue.GetTable Associated Types type Rep GetTableResponse :: Type -> Type # Methods from :: GetTableResponse -> Rep GetTableResponse x # to :: Rep GetTableResponse x -> GetTableResponse #
Read GetTableResponse Source #
Instance details Defined in Amazonka.Glue.GetTable Methods readsPrec :: Int -> ReadS GetTableResponse # readList :: ReadS [GetTableResponse] # readPrec :: ReadPrec GetTableResponse # readListPrec :: ReadPrec [GetTableResponse] #
Show GetTableResponse Source #
Instance details Defined in Amazonka.Glue.GetTable Methods showsPrec :: Int -> GetTableResponse -> ShowS # show :: GetTableResponse -> String # showList :: [GetTableResponse] -> ShowS #
NFData GetTableResponse Source #
Instance details Defined in Amazonka.Glue.GetTable Methods rnf :: GetTableResponse -> () #
Eq GetTableResponse Source #
Instance details Defined in Amazonka.Glue.GetTable Methods (==) :: GetTableResponse -> GetTableResponse -> Bool # (/=) :: GetTableResponse -> GetTableResponse -> Bool #
type Rep GetTableResponse Source #
Instance details Defined in Amazonka.Glue.GetTable type Rep GetTableResponse = D1 ('MetaData "GetTableResponse" "Amazonka.Glue.GetTable" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetTableResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "table") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Table)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetTableResponse Source #

Arguments

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

Create a value of GetTableResponse 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:

GetTableResponse, getTableResponse_table - The Table object that defines the specified table.

$sel:httpStatus:GetTableResponse', getTableResponse_httpStatus - The response's http status code.

Response Lenses

getTableResponse_table :: Lens' GetTableResponse (Maybe Table) Source #

The Table object that defines the specified table.

getTableResponse_httpStatus :: Lens' GetTableResponse Int Source #

The response's http status code.