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
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
- data DescribeGlobalReplicationGroups = DescribeGlobalReplicationGroups' {}
- newDescribeGlobalReplicationGroups :: DescribeGlobalReplicationGroups
- describeGlobalReplicationGroups_showMemberInfo :: Lens' DescribeGlobalReplicationGroups (Maybe Bool)
- describeGlobalReplicationGroups_marker :: Lens' DescribeGlobalReplicationGroups (Maybe Text)
- describeGlobalReplicationGroups_maxRecords :: Lens' DescribeGlobalReplicationGroups (Maybe Int)
- describeGlobalReplicationGroups_globalReplicationGroupId :: Lens' DescribeGlobalReplicationGroups (Maybe Text)
- data DescribeGlobalReplicationGroupsResponse = DescribeGlobalReplicationGroupsResponse' {}
- newDescribeGlobalReplicationGroupsResponse :: Int -> DescribeGlobalReplicationGroupsResponse
- describeGlobalReplicationGroupsResponse_marker :: Lens' DescribeGlobalReplicationGroupsResponse (Maybe Text)
- describeGlobalReplicationGroupsResponse_globalReplicationGroups :: Lens' DescribeGlobalReplicationGroupsResponse (Maybe [GlobalReplicationGroup])
- describeGlobalReplicationGroupsResponse_httpStatus :: Lens' DescribeGlobalReplicationGroupsResponse Int
Creating a Request
data DescribeGlobalReplicationGroups Source #
See: newDescribeGlobalReplicationGroups
smart constructor.
Constructors
DescribeGlobalReplicationGroups' | |
Fields
|
Instances
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
|
Instances
newDescribeGlobalReplicationGroupsResponse Source #
Arguments
:: Int | |
-> 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.