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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

This operation is valid for Redis only.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeReplicationGroups Source #

Represents the input of a DescribeReplicationGroups operation.

See: newDescribeReplicationGroups smart constructor.

Constructors

DescribeReplicationGroups'

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.
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.
Default: 100
Constraints: minimum 20; maximum 100.
replicationGroupId :: Maybe Text
The identifier for the replication group to be described. This parameter is not case sensitive.
If you do not specify this parameter, information about all replication groups is returned.

Instances

Instances details

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

newDescribeReplicationGroups :: DescribeReplicationGroups Source #

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

DescribeReplicationGroups, describeReplicationGroups_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:DescribeReplicationGroups', describeReplicationGroups_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.

Default: 100

Constraints: minimum 20; maximum 100.

DescribeReplicationGroups, describeReplicationGroups_replicationGroupId - The identifier for the replication group to be described. This parameter is not case sensitive.

If you do not specify this parameter, information about all replication groups is returned.

Request Lenses

describeReplicationGroups_marker :: Lens' DescribeReplicationGroups (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.

describeReplicationGroups_maxRecords :: Lens' DescribeReplicationGroups (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.

Default: 100

Constraints: minimum 20; maximum 100.

describeReplicationGroups_replicationGroupId :: Lens' DescribeReplicationGroups (Maybe Text) Source #

The identifier for the replication group to be described. This parameter is not case sensitive.

If you do not specify this parameter, information about all replication groups is returned.

Destructuring the Response

data DescribeReplicationGroupsResponse Source #

Represents the output of a DescribeReplicationGroups operation.

See: newDescribeReplicationGroupsResponse smart constructor.

Constructors

DescribeReplicationGroupsResponse'
Fields marker :: Maybe Text Provides an identifier to allow retrieval of paginated results. replicationGroups :: Maybe [ReplicationGroup] A list of replication groups. Each item in the list contains detailed information about one replication group. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeReplicationGroupsResponse Source #

Arguments

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

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

DescribeReplicationGroups, describeReplicationGroupsResponse_marker - Provides an identifier to allow retrieval of paginated results.

DescribeReplicationGroupsResponse, describeReplicationGroupsResponse_replicationGroups - A list of replication groups. Each item in the list contains detailed information about one replication group.

$sel:httpStatus:DescribeReplicationGroupsResponse', describeReplicationGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeReplicationGroupsResponse_marker :: Lens' DescribeReplicationGroupsResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.

describeReplicationGroupsResponse_replicationGroups :: Lens' DescribeReplicationGroupsResponse (Maybe [ReplicationGroup]) Source #

A list of replication groups. Each item in the list contains detailed information about one replication group.

describeReplicationGroupsResponse_httpStatus :: Lens' DescribeReplicationGroupsResponse Int Source #

The response's http status code.