Skip to content

DescribeSnapshotsRequest

Source code in docs_src/capo_memorydb/types/describe_snapshots_request.py
class DescribeSnapshotsRequest(TypedDict, closed=True):
    cluster_name: NotRequired["capo_memorydb.types.string.String"]
    """<p>A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.</p>"""
    snapshot_name: NotRequired["capo_memorydb.types.string.String"]
    """<p>A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.</p>"""
    source: NotRequired["capo_memorydb.types.string.String"]
    """<p>If set to system, the output shows snapshots that were automatically created by MemoryDB. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.</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>"""
    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>"""
    show_detail: NotRequired["capo_memorydb.types.boolean_optional.BooleanOptional"]
    """<p>A Boolean value which if true, the shard configuration is included in the snapshot description.</p>"""

cluster_name instance-attribute

cluster_name: NotRequired[String]

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

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_detail instance-attribute

show_detail: NotRequired[BooleanOptional]

A Boolean value which if true, the shard configuration is included in the snapshot description.

snapshot_name instance-attribute

snapshot_name: NotRequired[String]

A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.

source instance-attribute

source: NotRequired[String]

If set to system, the output shows snapshots that were automatically created by MemoryDB. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.