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.TimeStreamWrite.ListTables

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

A list of tables, along with the name, status and retention properties of each table. See code sample for details.

Synopsis

Creating a Request

data ListTables Source #

See: newListTables smart constructor.

Constructors

ListTables'

Fields

databaseName :: Maybe Text
The name of the Timestream database.
maxResults :: Maybe Natural
The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
nextToken :: Maybe Text
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

Instances

Instances details

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

newListTables :: ListTables Source #

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

ListTables, listTables_databaseName - The name of the Timestream database.

$sel:maxResults:ListTables', listTables_maxResults - The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

ListTables, listTables_nextToken - The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

Request Lenses

listTables_databaseName :: Lens' ListTables (Maybe Text) Source #

The name of the Timestream database.

listTables_maxResults :: Lens' ListTables (Maybe Natural) Source #

The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

listTables_nextToken :: Lens' ListTables (Maybe Text) Source #

The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

Destructuring the Response

data ListTablesResponse Source #

See: newListTablesResponse smart constructor.

Constructors

ListTablesResponse'
Fields nextToken :: Maybe Text A token to specify where to start paginating. This is the NextToken from a previously truncated response. tables :: Maybe [Table] A list of tables. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListTablesResponse Source #

Arguments

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

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

ListTables, listTablesResponse_nextToken - A token to specify where to start paginating. This is the NextToken from a previously truncated response.

$sel:tables:ListTablesResponse', listTablesResponse_tables - A list of tables.

$sel:httpStatus:ListTablesResponse', listTablesResponse_httpStatus - The response's http status code.

Response Lenses

listTablesResponse_nextToken :: Lens' ListTablesResponse (Maybe Text) Source #

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

listTablesResponse_tables :: Lens' ListTablesResponse (Maybe [Table]) Source #

A list of tables.

listTablesResponse_httpStatus :: Lens' ListTablesResponse Int Source #

The response's http status code.