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.Athena.ListTableMetadata

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the metadata for the tables in the specified data catalog database.

This operation returns paginated results.

Synopsis

data ListTableMetadata = ListTableMetadata' {
- nextToken :: Maybe Text
- expression :: Maybe Text
- maxResults :: Maybe Natural
- catalogName :: Text
- databaseName :: Text
}
newListTableMetadata :: Text -> Text -> ListTableMetadata
listTableMetadata_nextToken :: Lens' ListTableMetadata (Maybe Text)
listTableMetadata_expression :: Lens' ListTableMetadata (Maybe Text)
listTableMetadata_maxResults :: Lens' ListTableMetadata (Maybe Natural)
listTableMetadata_catalogName :: Lens' ListTableMetadata Text
listTableMetadata_databaseName :: Lens' ListTableMetadata Text
data ListTableMetadataResponse = ListTableMetadataResponse' {
- nextToken :: Maybe Text
- tableMetadataList :: Maybe [TableMetadata]
- httpStatus :: Int
}
newListTableMetadataResponse :: Int -> ListTableMetadataResponse
listTableMetadataResponse_nextToken :: Lens' ListTableMetadataResponse (Maybe Text)
listTableMetadataResponse_tableMetadataList :: Lens' ListTableMetadataResponse (Maybe [TableMetadata])
listTableMetadataResponse_httpStatus :: Lens' ListTableMetadataResponse Int

Creating a Request

data ListTableMetadata Source #

See: newListTableMetadata smart constructor.

Constructors

ListTableMetadata'

Fields

nextToken :: Maybe Text
A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
expression :: Maybe Text
A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.
maxResults :: Maybe Natural
Specifies the maximum number of results to return.
catalogName :: Text
The name of the data catalog for which table metadata should be returned.
databaseName :: Text
The name of the database for which table metadata should be returned.

Instances

Instances details

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

newListTableMetadata Source #

Arguments

:: Text	`$sel:catalogName:ListTableMetadata'`
-> Text	`$sel:databaseName:ListTableMetadata'`
-> ListTableMetadata

Create a value of ListTableMetadata 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:nextToken:ListTableMetadata', listTableMetadata_nextToken - A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

$sel:expression:ListTableMetadata', listTableMetadata_expression - A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.

$sel:maxResults:ListTableMetadata', listTableMetadata_maxResults - Specifies the maximum number of results to return.

$sel:catalogName:ListTableMetadata', listTableMetadata_catalogName - The name of the data catalog for which table metadata should be returned.

$sel:databaseName:ListTableMetadata', listTableMetadata_databaseName - The name of the database for which table metadata should be returned.

Request Lenses

listTableMetadata_nextToken :: Lens' ListTableMetadata (Maybe Text) Source #

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

listTableMetadata_expression :: Lens' ListTableMetadata (Maybe Text) Source #

A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.

listTableMetadata_maxResults :: Lens' ListTableMetadata (Maybe Natural) Source #

Specifies the maximum number of results to return.

listTableMetadata_catalogName :: Lens' ListTableMetadata Text Source #

The name of the data catalog for which table metadata should be returned.

listTableMetadata_databaseName :: Lens' ListTableMetadata Text Source #

The name of the database for which table metadata should be returned.

Destructuring the Response

data ListTableMetadataResponse Source #

See: newListTableMetadataResponse smart constructor.

Constructors

ListTableMetadataResponse'
Fields nextToken :: Maybe Text A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call. tableMetadataList :: Maybe [TableMetadata] A list of table metadata. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListTableMetadataResponse Source #

Arguments

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

Create a value of ListTableMetadataResponse 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:nextToken:ListTableMetadata', listTableMetadataResponse_nextToken - A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

$sel:tableMetadataList:ListTableMetadataResponse', listTableMetadataResponse_tableMetadataList - A list of table metadata.

$sel:httpStatus:ListTableMetadataResponse', listTableMetadataResponse_httpStatus - The response's http status code.

Response Lenses

listTableMetadataResponse_nextToken :: Lens' ListTableMetadataResponse (Maybe Text) Source #

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

listTableMetadataResponse_tableMetadataList :: Lens' ListTableMetadataResponse (Maybe [TableMetadata]) Source #

A list of table metadata.

listTableMetadataResponse_httpStatus :: Lens' ListTableMetadataResponse Int Source #

The response's http status code.