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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all global tables that have a replica in the specified Region.

This operation only applies to Version 2017.11.29 of global tables.

Synopsis

data ListGlobalTables = ListGlobalTables' {
- regionName :: Maybe Text
- exclusiveStartGlobalTableName :: Maybe Text
- limit :: Maybe Natural
}
newListGlobalTables :: ListGlobalTables
listGlobalTables_regionName :: Lens' ListGlobalTables (Maybe Text)
listGlobalTables_exclusiveStartGlobalTableName :: Lens' ListGlobalTables (Maybe Text)
listGlobalTables_limit :: Lens' ListGlobalTables (Maybe Natural)
data ListGlobalTablesResponse = ListGlobalTablesResponse' {
- lastEvaluatedGlobalTableName :: Maybe Text
- globalTables :: Maybe [GlobalTable]
- httpStatus :: Int
}
newListGlobalTablesResponse :: Int -> ListGlobalTablesResponse
listGlobalTablesResponse_lastEvaluatedGlobalTableName :: Lens' ListGlobalTablesResponse (Maybe Text)
listGlobalTablesResponse_globalTables :: Lens' ListGlobalTablesResponse (Maybe [GlobalTable])
listGlobalTablesResponse_httpStatus :: Lens' ListGlobalTablesResponse Int

Creating a Request

data ListGlobalTables Source #

See: newListGlobalTables smart constructor.

Constructors

ListGlobalTables'

Fields

regionName :: Maybe Text
Lists the global tables in a specific Region.
exclusiveStartGlobalTableName :: Maybe Text
The first global table name that this operation will evaluate.
limit :: Maybe Natural
The maximum number of table names to return, if the parameter is not specified DynamoDB defaults to 100.
If the number of global tables DynamoDB finds reaches this limit, it stops the operation and returns the table names collected up to that point, with a table name in the LastEvaluatedGlobalTableName to apply in a subsequent operation to the ExclusiveStartGlobalTableName parameter.

Instances

Instances details

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

newListGlobalTables :: ListGlobalTables Source #

Create a value of ListGlobalTables 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:regionName:ListGlobalTables', listGlobalTables_regionName - Lists the global tables in a specific Region.

$sel:exclusiveStartGlobalTableName:ListGlobalTables', listGlobalTables_exclusiveStartGlobalTableName - The first global table name that this operation will evaluate.

$sel:limit:ListGlobalTables', listGlobalTables_limit - The maximum number of table names to return, if the parameter is not specified DynamoDB defaults to 100.

If the number of global tables DynamoDB finds reaches this limit, it stops the operation and returns the table names collected up to that point, with a table name in the LastEvaluatedGlobalTableName to apply in a subsequent operation to the ExclusiveStartGlobalTableName parameter.

Request Lenses

listGlobalTables_regionName :: Lens' ListGlobalTables (Maybe Text) Source #

Lists the global tables in a specific Region.

listGlobalTables_exclusiveStartGlobalTableName :: Lens' ListGlobalTables (Maybe Text) Source #

The first global table name that this operation will evaluate.

listGlobalTables_limit :: Lens' ListGlobalTables (Maybe Natural) Source #

The maximum number of table names to return, if the parameter is not specified DynamoDB defaults to 100.

If the number of global tables DynamoDB finds reaches this limit, it stops the operation and returns the table names collected up to that point, with a table name in the LastEvaluatedGlobalTableName to apply in a subsequent operation to the ExclusiveStartGlobalTableName parameter.

Destructuring the Response

data ListGlobalTablesResponse Source #

See: newListGlobalTablesResponse smart constructor.

Constructors

ListGlobalTablesResponse'
Fields lastEvaluatedGlobalTableName :: Maybe Text Last evaluated global table name. globalTables :: Maybe [GlobalTable] List of global table names. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListGlobalTablesResponse Source #

Arguments

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

Create a value of ListGlobalTablesResponse 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:lastEvaluatedGlobalTableName:ListGlobalTablesResponse', listGlobalTablesResponse_lastEvaluatedGlobalTableName - Last evaluated global table name.

$sel:globalTables:ListGlobalTablesResponse', listGlobalTablesResponse_globalTables - List of global table names.

$sel:httpStatus:ListGlobalTablesResponse', listGlobalTablesResponse_httpStatus - The response's http status code.

Response Lenses

listGlobalTablesResponse_lastEvaluatedGlobalTableName :: Lens' ListGlobalTablesResponse (Maybe Text) Source #

Last evaluated global table name.

listGlobalTablesResponse_globalTables :: Lens' ListGlobalTablesResponse (Maybe [GlobalTable]) Source #

List of global table names.

listGlobalTablesResponse_httpStatus :: Lens' ListGlobalTablesResponse Int Source #

The response's http status code.