Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1445255198.7 KB

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.

post/#X-Amz-Target=AmazonMemoryDB.DescribeClusters

Headers

X-Amz-Target'AmazonMemoryDB.DescribeClusters' required

Request body

ClusterNamestring

The name of the cluster.

MaxResultsinteger

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

NextTokenstring

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

ShowShardDetailsboolean

An optional flag that can be included in the request to retrieve information about the individual shard(s).

Response

Success

NextTokenstring

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.