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

Creating a Request

data ListGlobalTables Source #

See: newListGlobalTables smart constructor.

Constructors

ListGlobalTables'

Fields

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.
regionName :: Maybe Text
Lists the global tables in a specific Region.

Instances

Instances details

ToJSON ListGlobalTables Source #
Instance details Defined in Amazonka.DynamoDB.ListGlobalTables Methods toJSON :: ListGlobalTables -> Value # toEncoding :: ListGlobalTables -> Encoding # toJSONList :: [ListGlobalTables] -> Value # toEncodingList :: [ListGlobalTables] -> Encoding #
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 #
AWSRequest ListGlobalTables Source #
Instance details Defined in Amazonka.DynamoDB.ListGlobalTables Associated Types type AWSResponse ListGlobalTables # Methods request :: (Service -> Service) -> ListGlobalTables -> Request ListGlobalTables # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListGlobalTables -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListGlobalTables))) #
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 #
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 #
NFData ListGlobalTables Source #
Instance details Defined in Amazonka.DynamoDB.ListGlobalTables Methods rnf :: ListGlobalTables -> () #
Eq ListGlobalTables Source #
Instance details Defined in Amazonka.DynamoDB.ListGlobalTables Methods (==) :: ListGlobalTables -> ListGlobalTables -> Bool # (/=) :: ListGlobalTables -> ListGlobalTables -> Bool #
Hashable ListGlobalTables Source #
Instance details Defined in Amazonka.DynamoDB.ListGlobalTables Methods hashWithSalt :: Int -> ListGlobalTables -> Int # hash :: ListGlobalTables -> Int #
type AWSResponse ListGlobalTables Source #
Instance details Defined in Amazonka.DynamoDB.ListGlobalTables type AWSResponse ListGlobalTables = ListGlobalTablesResponse
type Rep ListGlobalTables Source #
Instance details Defined in Amazonka.DynamoDB.ListGlobalTables type Rep ListGlobalTables = D1 ('MetaData "ListGlobalTables" "Amazonka.DynamoDB.ListGlobalTables" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "ListGlobalTables'" 'PrefixI 'True) (S1 ('MetaSel ('Just "exclusiveStartGlobalTableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "regionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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

ListGlobalTables, listGlobalTables_regionName - Lists the global tables in a specific Region.

Request Lenses

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.

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

Lists the global tables in a specific Region.

Destructuring the Response

data ListGlobalTablesResponse Source #

See: newListGlobalTablesResponse smart constructor.

Constructors

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

Instances

Instances details

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 #
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 #
NFData ListGlobalTablesResponse Source #
Instance details Defined in Amazonka.DynamoDB.ListGlobalTables Methods rnf :: ListGlobalTablesResponse -> () #
Eq ListGlobalTablesResponse Source #
Instance details Defined in Amazonka.DynamoDB.ListGlobalTables Methods (==) :: ListGlobalTablesResponse -> ListGlobalTablesResponse -> Bool # (/=) :: ListGlobalTablesResponse -> ListGlobalTablesResponse -> Bool #
type Rep ListGlobalTablesResponse Source #
Instance details Defined in Amazonka.DynamoDB.ListGlobalTables type Rep ListGlobalTablesResponse = D1 ('MetaData "ListGlobalTablesResponse" "Amazonka.DynamoDB.ListGlobalTables" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "ListGlobalTablesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalTables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GlobalTable])) :: (S1 ('MetaSel ('Just "lastEvaluatedGlobalTableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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:globalTables:ListGlobalTablesResponse', listGlobalTablesResponse_globalTables - List of global table names.

$sel:lastEvaluatedGlobalTableName:ListGlobalTablesResponse', listGlobalTablesResponse_lastEvaluatedGlobalTableName - Last evaluated global table name.

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

Response Lenses

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

List of global table names.

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

Last evaluated global table name.

listGlobalTablesResponse_httpStatus :: Lens' ListGlobalTablesResponse Int Source #

The response's http status code.