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

showMemberInfo :: Maybe Bool
Returns the list of members that comprise 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.
globalReplicationGroupId :: Maybe Text
The name of the Global datastore

Instances

Instances details

Eq DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods (==) :: DescribeGlobalReplicationGroups -> DescribeGlobalReplicationGroups -> Bool # (/=) :: DescribeGlobalReplicationGroups -> DescribeGlobalReplicationGroups -> Bool #
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 #
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 #
NFData DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods rnf :: DescribeGlobalReplicationGroups -> () #
Hashable DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods hashWithSalt :: Int -> DescribeGlobalReplicationGroups -> Int # hash :: DescribeGlobalReplicationGroups -> Int #
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 :: DescribeGlobalReplicationGroups -> Request DescribeGlobalReplicationGroups # response :: MonadResource m => Logger -> Service -> Proxy DescribeGlobalReplicationGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeGlobalReplicationGroups))) #
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 #
type Rep DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups type Rep DescribeGlobalReplicationGroups = D1 ('MetaData "DescribeGlobalReplicationGroups" "Amazonka.ElastiCache.DescribeGlobalReplicationGroups" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DescribeGlobalReplicationGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "showMemberInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "globalReplicationGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse DescribeGlobalReplicationGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups type AWSResponse DescribeGlobalReplicationGroups = DescribeGlobalReplicationGroupsResponse

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:

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

$sel:marker: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:globalReplicationGroupId:DescribeGlobalReplicationGroups', describeGlobalReplicationGroups_globalReplicationGroupId - The name of the Global datastore

Request Lenses

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

Returns the list of members that comprise 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_globalReplicationGroupId :: Lens' DescribeGlobalReplicationGroups (Maybe Text) Source #

The name of the Global datastore

Destructuring the Response

data DescribeGlobalReplicationGroupsResponse Source #

See: newDescribeGlobalReplicationGroupsResponse smart constructor.

Constructors

DescribeGlobalReplicationGroupsResponse'

Fields

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. >
globalReplicationGroups :: Maybe [GlobalReplicationGroup]
Indicates the slot configuration and global identifier for each slice group.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeGlobalReplicationGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods (==) :: DescribeGlobalReplicationGroupsResponse -> DescribeGlobalReplicationGroupsResponse -> Bool # (/=) :: DescribeGlobalReplicationGroupsResponse -> DescribeGlobalReplicationGroupsResponse -> Bool #
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 #
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 #
NFData DescribeGlobalReplicationGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups Methods rnf :: DescribeGlobalReplicationGroupsResponse -> () #
type Rep DescribeGlobalReplicationGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeGlobalReplicationGroups type Rep DescribeGlobalReplicationGroupsResponse = D1 ('MetaData "DescribeGlobalReplicationGroupsResponse" "Amazonka.ElastiCache.DescribeGlobalReplicationGroups" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DescribeGlobalReplicationGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "globalReplicationGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GlobalReplicationGroup])) :: 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:marker: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:globalReplicationGroups:DescribeGlobalReplicationGroupsResponse', describeGlobalReplicationGroupsResponse_globalReplicationGroups - Indicates the slot configuration and global identifier for each slice group.

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

Response Lenses

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_globalReplicationGroups :: Lens' DescribeGlobalReplicationGroupsResponse (Maybe [GlobalReplicationGroup]) Source #

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

describeGlobalReplicationGroupsResponse_httpStatus :: Lens' DescribeGlobalReplicationGroupsResponse Int Source #

The response's http status code.