Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Glue.GetTables

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the definitions of some or all of the tables in a given Database.

This operation returns paginated results.

Synopsis

data GetTables = GetTables' {
- catalogId :: Maybe Text
- nextToken :: Maybe Text
- expression :: Maybe Text
- maxResults :: Maybe Natural
- databaseName :: Text
}
newGetTables :: Text -> GetTables
getTables_catalogId :: Lens' GetTables (Maybe Text)
getTables_nextToken :: Lens' GetTables (Maybe Text)
getTables_expression :: Lens' GetTables (Maybe Text)
getTables_maxResults :: Lens' GetTables (Maybe Natural)
getTables_databaseName :: Lens' GetTables Text
data GetTablesResponse = GetTablesResponse' {
- tableList :: Maybe [Table]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetTablesResponse :: Int -> GetTablesResponse
getTablesResponse_tableList :: Lens' GetTablesResponse (Maybe [Table])
getTablesResponse_nextToken :: Lens' GetTablesResponse (Maybe Text)
getTablesResponse_httpStatus :: Lens' GetTablesResponse Int

Creating a Request

data GetTables Source #

See: newGetTables smart constructor.

Constructors

GetTables'

Fields

catalogId :: Maybe Text
The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.
nextToken :: Maybe Text
A continuation token, included if this is a continuation call.
expression :: Maybe Text
A regular expression pattern. If present, only those tables whose names match the pattern are returned.
maxResults :: Maybe Natural
The maximum number of tables to return in a single response.
databaseName :: Text
The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.

Instances

Instances details

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

newGetTables Source #

Arguments

:: Text	`$sel:databaseName:GetTables'`
-> GetTables

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

$sel:catalogId:GetTables', getTables_catalogId - The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.

$sel:nextToken:GetTables', getTables_nextToken - A continuation token, included if this is a continuation call.

$sel:expression:GetTables', getTables_expression - A regular expression pattern. If present, only those tables whose names match the pattern are returned.

$sel:maxResults:GetTables', getTables_maxResults - The maximum number of tables to return in a single response.

$sel:databaseName:GetTables', getTables_databaseName - The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.

Request Lenses

getTables_catalogId :: Lens' GetTables (Maybe Text) Source #

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

getTables_nextToken :: Lens' GetTables (Maybe Text) Source #

A continuation token, included if this is a continuation call.

getTables_expression :: Lens' GetTables (Maybe Text) Source #

A regular expression pattern. If present, only those tables whose names match the pattern are returned.

getTables_maxResults :: Lens' GetTables (Maybe Natural) Source #

The maximum number of tables to return in a single response.

getTables_databaseName :: Lens' GetTables Text Source #

The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.

Destructuring the Response

data GetTablesResponse Source #

See: newGetTablesResponse smart constructor.

Constructors

GetTablesResponse'
Fields tableList :: Maybe [Table] A list of the requested `Table` objects. nextToken :: Maybe Text A continuation token, present if the current list segment is not the last. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetTablesResponse Source #

Arguments

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

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

$sel:tableList:GetTablesResponse', getTablesResponse_tableList - A list of the requested Table objects.

$sel:nextToken:GetTables', getTablesResponse_nextToken - A continuation token, present if the current list segment is not the last.

$sel:httpStatus:GetTablesResponse', getTablesResponse_httpStatus - The response's http status code.

Response Lenses

getTablesResponse_tableList :: Lens' GetTablesResponse (Maybe [Table]) Source #

A list of the requested Table objects.

getTablesResponse_nextToken :: Lens' GetTablesResponse (Maybe Text) Source #

A continuation token, present if the current list segment is not the last.

getTablesResponse_httpStatus :: Lens' GetTablesResponse Int Source #

The response's http status code.