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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names.

This operation returns paginated results.

Creating a Request

data ListTables Source #

Represents the input of a ListTables operation.

See: newListTables smart constructor.

Constructors

ListTables'
Fields exclusiveStartTableName :: Maybe Text The first table name that this operation will evaluate. Use the value that was returned for `LastEvaluatedTableName` in a previous operation, so that you can obtain the next page of results. limit :: Maybe Natural A maximum number of table names to return. If this parameter is not specified, the limit is 100.

Instances

Instances details

ToJSON ListTables Source #
Instance details Defined in Amazonka.DynamoDB.ListTables Methods toJSON :: ListTables -> Value # toEncoding :: ListTables -> Encoding # toJSONList :: [ListTables] -> Value # toEncodingList :: [ListTables] -> Encoding #
ToHeaders ListTables Source #
Instance details Defined in Amazonka.DynamoDB.ListTables Methods toHeaders :: ListTables -> [Header] #
ToPath ListTables Source #
Instance details Defined in Amazonka.DynamoDB.ListTables Methods toPath :: ListTables -> ByteString #
ToQuery ListTables Source #
Instance details Defined in Amazonka.DynamoDB.ListTables Methods toQuery :: ListTables -> QueryString #
AWSPager ListTables Source #
Instance details Defined in Amazonka.DynamoDB.ListTables Methods page :: ListTables -> AWSResponse ListTables -> Maybe ListTables #
AWSRequest ListTables Source #
Instance details Defined in Amazonka.DynamoDB.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.DynamoDB.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.DynamoDB.ListTables Methods readsPrec :: Int -> ReadS ListTables # readList :: ReadS [ListTables] # readPrec :: ReadPrec ListTables # readListPrec :: ReadPrec [ListTables] #
Show ListTables Source #
Instance details Defined in Amazonka.DynamoDB.ListTables Methods showsPrec :: Int -> ListTables -> ShowS # show :: ListTables -> String # showList :: [ListTables] -> ShowS #
NFData ListTables Source #
Instance details Defined in Amazonka.DynamoDB.ListTables Methods rnf :: ListTables -> () #
Eq ListTables Source #
Instance details Defined in Amazonka.DynamoDB.ListTables Methods (==) :: ListTables -> ListTables -> Bool # (/=) :: ListTables -> ListTables -> Bool #
Hashable ListTables Source #
Instance details Defined in Amazonka.DynamoDB.ListTables Methods hashWithSalt :: Int -> ListTables -> Int # hash :: ListTables -> Int #
type AWSResponse ListTables Source #
Instance details Defined in Amazonka.DynamoDB.ListTables type AWSResponse ListTables = ListTablesResponse
type Rep ListTables Source #
Instance details Defined in Amazonka.DynamoDB.ListTables type Rep ListTables = D1 ('MetaData "ListTables" "Amazonka.DynamoDB.ListTables" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "ListTables'" 'PrefixI 'True) (S1 ('MetaSel ('Just "exclusiveStartTableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))

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:

$sel:exclusiveStartTableName:ListTables', listTables_exclusiveStartTableName - The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.

$sel:limit:ListTables', listTables_limit - A maximum number of table names to return. If this parameter is not specified, the limit is 100.

Request Lenses

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

The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.

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

A maximum number of table names to return. If this parameter is not specified, the limit is 100.

Destructuring the Response

data ListTablesResponse Source #

Represents the output of a ListTables operation.

See: newListTablesResponse smart constructor.

Constructors

ListTablesResponse'

Fields

lastEvaluatedTableName :: Maybe Text
The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned.
If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.
tableNames :: Maybe [Text]
The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.
If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListTablesResponse Source #
Instance details Defined in Amazonka.DynamoDB.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.DynamoDB.ListTables Methods readsPrec :: Int -> ReadS ListTablesResponse # readList :: ReadS [ListTablesResponse] # readPrec :: ReadPrec ListTablesResponse # readListPrec :: ReadPrec [ListTablesResponse] #
Show ListTablesResponse Source #
Instance details Defined in Amazonka.DynamoDB.ListTables Methods showsPrec :: Int -> ListTablesResponse -> ShowS # show :: ListTablesResponse -> String # showList :: [ListTablesResponse] -> ShowS #
NFData ListTablesResponse Source #
Instance details Defined in Amazonka.DynamoDB.ListTables Methods rnf :: ListTablesResponse -> () #
Eq ListTablesResponse Source #
Instance details Defined in Amazonka.DynamoDB.ListTables Methods (==) :: ListTablesResponse -> ListTablesResponse -> Bool # (/=) :: ListTablesResponse -> ListTablesResponse -> Bool #
type Rep ListTablesResponse Source #
Instance details Defined in Amazonka.DynamoDB.ListTables type Rep ListTablesResponse = D1 ('MetaData "ListTablesResponse" "Amazonka.DynamoDB.ListTables" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "ListTablesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lastEvaluatedTableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tableNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: 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:

$sel:lastEvaluatedTableName:ListTablesResponse', listTablesResponse_lastEvaluatedTableName - The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned.

If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.

$sel:tableNames:ListTablesResponse', listTablesResponse_tableNames - The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.

If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.

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

Response Lenses

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

The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned.

If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.

listTablesResponse_tableNames :: Lens' ListTablesResponse (Maybe [Text]) Source #

The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.

If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.

listTablesResponse_httpStatus :: Lens' ListTablesResponse Int Source #

The response's http status code.