DescribeGlobalReplicationGroups - Amazon ElastiCache

DescribeGlobalReplicationGroups

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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

GlobalReplicationGroupId

The name of the Global Datastore

Type: String

Required: No

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.

Type: String

Required: No

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.

Type: Integer

Required: No

ShowMemberInfo

Returns the list of members that comprise the Global Datastore.

Type: Boolean

Required: No

Response Elements

The following elements are returned by the service.

GlobalReplicationGroups.GlobalReplicationGroup.N

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

Type: Array of GlobalReplicationGroup objects

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

GlobalReplicationGroupNotFoundFault

The Global Datastore does not exist

HTTP Status Code: 404

InvalidParameterCombination

Two or more incompatible parameters were specified.

HTTP Status Code: 400

InvalidParameterValue

The value for a parameter is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: