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.ElastiCache.DescribeGlobalReplicationGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeGlobalReplicationGroups Source #

See: newDescribeGlobalReplicationGroups smart constructor.

Constructors

DescribeGlobalReplicationGroups'

Fields

globalReplicationGroupId :: Maybe Text
The name of the Global datastore
marker :: Maybe Text
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
maxRecords :: Maybe Int
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
showMemberInfo :: Maybe Bool
Returns the list of members that comprise the Global datastore.

Instances

Instances details

ToHeaders DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods toHeaders :: DescribeGlobalReplicationGroups -> [Header] #
ToPath DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods toPath :: DescribeGlobalReplicationGroups -> ByteString #
ToQuery DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods toQuery :: DescribeGlobalReplicationGroups -> QueryString #
AWSPager DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods page :: DescribeGlobalReplicationGroups -> AWSResponse DescribeGlobalReplicationGroups -> Maybe DescribeGlobalReplicationGroups #
AWSRequest DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Associated Types type AWSResponse DescribeGlobalReplicationGroups # Methods request :: (Service -> Service) -> DescribeGlobalReplicationGroups -> Request DescribeGlobalReplicationGroups # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeGlobalReplicationGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeGlobalReplicationGroups))) #
Generic DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Associated Types type Rep DescribeGlobalReplicationGroups :: Type -> Type # Methods from :: DescribeGlobalReplicationGroups -> Rep DescribeGlobalReplicationGroups x # to :: Rep DescribeGlobalReplicationGroups x -> DescribeGlobalReplicationGroups #
Read DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods readsPrec :: Int -> ReadS DescribeGlobalReplicationGroups # readList :: ReadS [DescribeGlobalReplicationGroups] # readPrec :: ReadPrec DescribeGlobalReplicationGroups # readListPrec :: ReadPrec [DescribeGlobalReplicationGroups] #
Show DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods showsPrec :: Int -> DescribeGlobalReplicationGroups -> ShowS # show :: DescribeGlobalReplicationGroups -> String # showList :: [DescribeGlobalReplicationGroups] -> ShowS #
NFData DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods rnf :: DescribeGlobalReplicationGroups -> () #
Eq DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods (==) :: DescribeGlobalReplicationGroups -> DescribeGlobalReplicationGroups -> Bool # (/=) :: DescribeGlobalReplicationGroups -> DescribeGlobalReplicationGroups -> Bool #
Hashable DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods hashWithSalt :: Int -> DescribeGlobalReplicationGroups -> Int # hash :: DescribeGlobalReplicationGroups -> Int #
type AWSResponse DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups type AWSResponse DescribeGlobalReplicationGroups = DescribeGlobalReplicationGroupsResponse
type Rep DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups type Rep DescribeGlobalReplicationGroups = D1 ('MetaData "DescribeGlobalReplicationGroups" "Amazonka.ElastiCache.DescribeGlobalReplicationGroups" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "DescribeGlobalReplicationGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "globalReplicationGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "showMemberInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newDescribeGlobalReplicationGroups :: DescribeGlobalReplicationGroups Source #

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

DescribeGlobalReplicationGroups, describeGlobalReplicationGroups_globalReplicationGroupId - The name of the Global datastore

DescribeGlobalReplicationGroups, describeGlobalReplicationGroups_marker - An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:maxRecords:DescribeGlobalReplicationGroups', describeGlobalReplicationGroups_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

$sel:showMemberInfo:DescribeGlobalReplicationGroups', describeGlobalReplicationGroups_showMemberInfo - Returns the list of members that comprise the Global datastore.

Request Lenses

describeGlobalReplicationGroups_globalReplicationGroupId :: Lens' DescribeGlobalReplicationGroups (Maybe Text) Source #

The name of the Global datastore

describeGlobalReplicationGroups_marker :: Lens' DescribeGlobalReplicationGroups (Maybe Text) Source #

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeGlobalReplicationGroups_maxRecords :: Lens' DescribeGlobalReplicationGroups (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

describeGlobalReplicationGroups_showMemberInfo :: Lens' DescribeGlobalReplicationGroups (Maybe Bool) Source #

Returns the list of members that comprise the Global datastore.

Destructuring the Response

data DescribeGlobalReplicationGroupsResponse Source #

See: newDescribeGlobalReplicationGroupsResponse smart constructor.

Constructors

DescribeGlobalReplicationGroupsResponse'

Fields

globalReplicationGroups :: Maybe [GlobalReplicationGroup]
Indicates the slot configuration and global identifier for each slice group.
marker :: Maybe Text
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeGlobalReplicationGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Associated Types type Rep DescribeGlobalReplicationGroupsResponse :: Type -> Type # Methods from :: DescribeGlobalReplicationGroupsResponse -> Rep DescribeGlobalReplicationGroupsResponse x # to :: Rep DescribeGlobalReplicationGroupsResponse x -> DescribeGlobalReplicationGroupsResponse #
Read DescribeGlobalReplicationGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods readsPrec :: Int -> ReadS DescribeGlobalReplicationGroupsResponse # readList :: ReadS [DescribeGlobalReplicationGroupsResponse] # readPrec :: ReadPrec DescribeGlobalReplicationGroupsResponse # readListPrec :: ReadPrec [DescribeGlobalReplicationGroupsResponse] #
Show DescribeGlobalReplicationGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods showsPrec :: Int -> DescribeGlobalReplicationGroupsResponse -> ShowS # show :: DescribeGlobalReplicationGroupsResponse -> String # showList :: [DescribeGlobalReplicationGroupsResponse] -> ShowS #
NFData DescribeGlobalReplicationGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods rnf :: DescribeGlobalReplicationGroupsResponse -> () #
Eq DescribeGlobalReplicationGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods (==) :: DescribeGlobalReplicationGroupsResponse -> DescribeGlobalReplicationGroupsResponse -> Bool # (/=) :: DescribeGlobalReplicationGroupsResponse -> DescribeGlobalReplicationGroupsResponse -> Bool #
type Rep DescribeGlobalReplicationGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups type Rep DescribeGlobalReplicationGroupsResponse = D1 ('MetaData "DescribeGlobalReplicationGroupsResponse" "Amazonka.ElastiCache.DescribeGlobalReplicationGroups" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "DescribeGlobalReplicationGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalReplicationGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GlobalReplicationGroup])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeGlobalReplicationGroupsResponse Source #

Arguments

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

Create a value of DescribeGlobalReplicationGroupsResponse 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:globalReplicationGroups:DescribeGlobalReplicationGroupsResponse', describeGlobalReplicationGroupsResponse_globalReplicationGroups - Indicates the slot configuration and global identifier for each slice group.

DescribeGlobalReplicationGroups, describeGlobalReplicationGroupsResponse_marker - An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

$sel:httpStatus:DescribeGlobalReplicationGroupsResponse', describeGlobalReplicationGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeGlobalReplicationGroupsResponse_globalReplicationGroups :: Lens' DescribeGlobalReplicationGroupsResponse (Maybe [GlobalReplicationGroup]) Source #

Indicates the slot configuration and global identifier for each slice group.

describeGlobalReplicationGroupsResponse_marker :: Lens' DescribeGlobalReplicationGroupsResponse (Maybe Text) Source #

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

describeGlobalReplicationGroupsResponse_httpStatus :: Lens' DescribeGlobalReplicationGroupsResponse Int Source #

The response's http status code.