Amazonka.Athena.ListTableMetadata

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

This operation returns paginated results.

Creating a Request

data ListTableMetadata

See: newListTableMetadata smart constructor.

Constructors

ListTableMetadata'

Fields

• 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.

• 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.

• 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

ToJSON ListTableMetadata

Defined in Amazonka.Athena.ListTableMetadata

Methods

toJSON :: ListTableMetadata -> Value

toEncoding :: ListTableMetadata -> Encoding

toJSONList :: [ListTableMetadata] -> Value

toEncodingList :: [ListTableMetadata] -> Encoding

ToHeaders ListTableMetadata

Defined in Amazonka.Athena.ListTableMetadata

Methods

toHeaders :: ListTableMetadata -> [Header]

ToPath ListTableMetadata

Defined in Amazonka.Athena.ListTableMetadata

Methods

toPath :: ListTableMetadata -> ByteString

ToQuery ListTableMetadata

Defined in Amazonka.Athena.ListTableMetadata

Methods

toQuery :: ListTableMetadata -> QueryString

AWSPager ListTableMetadata

Defined in Amazonka.Athena.ListTableMetadata

Methods

page :: ListTableMetadata -> AWSResponse ListTableMetadata -> Maybe ListTableMetadata

AWSRequest ListTableMetadata

Defined in Amazonka.Athena.ListTableMetadata

Associated Types

type AWSResponse ListTableMetadata

Methods

request :: (Service -> Service) -> ListTableMetadata -> Request ListTableMetadata

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListTableMetadata -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTableMetadata)))

Generic ListTableMetadata

Defined in Amazonka.Athena.ListTableMetadata

Associated Types

type Rep ListTableMetadata :: Type -> Type

Methods

from :: ListTableMetadata -> Rep ListTableMetadata x

to :: Rep ListTableMetadata x -> ListTableMetadata

Read ListTableMetadata

Defined in Amazonka.Athena.ListTableMetadata

Methods

readsPrec :: Int -> ReadS ListTableMetadata

readList :: ReadS [ListTableMetadata]

readPrec :: ReadPrec ListTableMetadata

readListPrec :: ReadPrec [ListTableMetadata]

Show ListTableMetadata

Defined in Amazonka.Athena.ListTableMetadata

Methods

showsPrec :: Int -> ListTableMetadata -> ShowS

show :: ListTableMetadata -> String

showList :: [ListTableMetadata] -> ShowS

NFData ListTableMetadata

Defined in Amazonka.Athena.ListTableMetadata

Methods

rnf :: ListTableMetadata -> ()

Eq ListTableMetadata

Defined in Amazonka.Athena.ListTableMetadata

Methods

(==) :: ListTableMetadata -> ListTableMetadata -> Bool

(/=) :: ListTableMetadata -> ListTableMetadata -> Bool

Hashable ListTableMetadata

Defined in Amazonka.Athena.ListTableMetadata

Methods

hashWithSalt :: Int -> ListTableMetadata -> Int

hash :: ListTableMetadata -> Int

type AWSResponse ListTableMetadata

Defined in Amazonka.Athena.ListTableMetadata

type AWSResponse ListTableMetadata = ListTableMetadataResponse

type Rep ListTableMetadata

Defined in Amazonka.Athena.ListTableMetadata

type Rep ListTableMetadata = D1 ('MetaData "ListTableMetadata" "Amazonka.Athena.ListTableMetadata" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "ListTableMetadata'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "expression") '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 "catalogName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListTableMetadata

Arguments

:: Text

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: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.

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.

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_expression :: Lens' ListTableMetadata (Maybe Text)

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)

Specifies the maximum number of results to return.

listTableMetadata_nextToken :: Lens' ListTableMetadata (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.

listTableMetadata_catalogName :: Lens' ListTableMetadata Text

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

listTableMetadata_databaseName :: Lens' ListTableMetadata Text

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

Destructuring the Response

data ListTableMetadataResponse

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

Generic ListTableMetadataResponse

Defined in Amazonka.Athena.ListTableMetadata

Associated Types

type Rep ListTableMetadataResponse :: Type -> Type

Methods

from :: ListTableMetadataResponse -> Rep ListTableMetadataResponse x

to :: Rep ListTableMetadataResponse x -> ListTableMetadataResponse

Read ListTableMetadataResponse

Defined in Amazonka.Athena.ListTableMetadata

Methods

readsPrec :: Int -> ReadS ListTableMetadataResponse

readList :: ReadS [ListTableMetadataResponse]

readPrec :: ReadPrec ListTableMetadataResponse

readListPrec :: ReadPrec [ListTableMetadataResponse]

Show ListTableMetadataResponse

Defined in Amazonka.Athena.ListTableMetadata

Methods

showsPrec :: Int -> ListTableMetadataResponse -> ShowS

show :: ListTableMetadataResponse -> String

showList :: [ListTableMetadataResponse] -> ShowS

NFData ListTableMetadataResponse

Defined in Amazonka.Athena.ListTableMetadata

Methods

rnf :: ListTableMetadataResponse -> ()

Eq ListTableMetadataResponse

Defined in Amazonka.Athena.ListTableMetadata

Methods

(==) :: ListTableMetadataResponse -> ListTableMetadataResponse -> Bool

(/=) :: ListTableMetadataResponse -> ListTableMetadataResponse -> Bool

type Rep ListTableMetadataResponse

Defined in Amazonka.Athena.ListTableMetadata

type Rep ListTableMetadataResponse = D1 ('MetaData "ListTableMetadataResponse" "Amazonka.Athena.ListTableMetadata" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" '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

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:

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)

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])

A list of table metadata.

listTableMetadataResponse_httpStatus :: Lens' ListTableMetadataResponse Int

The response's http status code.