Skip to content

DescribeSnapshotsMessage

Source code in docs_src/capo_elasticache/types/describe_snapshots_message.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class DescribeSnapshotsMessage(TypedDict, closed=True):
    replication_group_id: NotRequired["capo_elasticache.types.string.String"]
    """<p>A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.</p>"""
    cache_cluster_id: NotRequired["capo_elasticache.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_elasticache.types.string.String"]
    """<p>A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.</p>"""
    snapshot_source: NotRequired["capo_elasticache.types.string.String"]
    """<p>If set to <code>system</code>, the output shows snapshots that were automatically created by ElastiCache. If set to <code>user</code> the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.</p>"""
    marker: NotRequired["capo_elasticache.types.string.String"]
    """<p>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 <code>MaxRecords</code>.</p>"""
    max_records: NotRequired["capo_elasticache.types.integer_optional.IntegerOptional"]
    """<p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</p> <p>Default: 50</p> <p>Constraints: minimum 20; maximum 50.</p>"""
    show_node_group_config: NotRequired[
        "capo_elasticache.types.boolean_optional.BooleanOptional"
    ]
    """<p>A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.</p>"""

cache_cluster_id instance-attribute 

cache_cluster_id: NotRequired[String]

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

marker instance-attribute 

marker: NotRequired[String]

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.

max_records instance-attribute 

max_records: NotRequired[IntegerOptional]

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.

Default: 50

Constraints: minimum 20; maximum 50.

replication_group_id instance-attribute 

replication_group_id: NotRequired[String]

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

show_node_group_config instance-attribute 

show_node_group_config: NotRequired[BooleanOptional]

A Boolean value which if true, the node group (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 snapshot are described.

snapshot_source instance-attribute 

snapshot_source: NotRequired[String]

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