Skip to content

DescribeClustersRequest

Source code in docs_src/capo_memorydb/types/describe_clusters_request.py 
13
14
15
16
17
18
19
20
21
22
23
class DescribeClustersRequest(TypedDict, closed=True):
    cluster_name: NotRequired["capo_memorydb.types.string.String"]
    """<p>The name of the cluster.</p>"""
    max_results: NotRequired["capo_memorydb.types.integer_optional.IntegerOptional"]
    """<p>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.</p>"""
    next_token: NotRequired["capo_memorydb.types.string.String"]
    """<p>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. </p>"""
    show_shard_details: NotRequired[
        "capo_memorydb.types.boolean_optional.BooleanOptional"
    ]
    """<p>An optional flag that can be included in the request to retrieve information about the individual shard(s).</p>"""

cluster_name instance-attribute 

cluster_name: NotRequired[String]

The name of the cluster.

max_results instance-attribute 

max_results: NotRequired[IntegerOptional]

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.

next_token instance-attribute 

next_token: NotRequired[String]

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.

show_shard_details instance-attribute 

show_shard_details: NotRequired[BooleanOptional]

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