Skip to content

DescribeSnapshotsRequest

Source code in docs_src/capo_fsx/types/describe_snapshots_request.py 
15
16
17
18
19
20
21
22
23
class DescribeSnapshotsRequest(TypedDict, closed=True):
    snapshot_ids: NotRequired["capo_fsx.types.snapshot_ids.SnapshotIds"]
    """<p>The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a <code>SnapshotNotFound</code> error occurs.</p>"""
    filters: NotRequired["capo_fsx.types.snapshot_filters.SnapshotFilters"]
    """<p>The filters structure. The supported names are <code>file-system-id</code> or <code>volume-id</code>.</p>"""
    max_results: NotRequired["capo_fsx.types.max_results.MaxResults"]
    next_token: NotRequired["capo_fsx.types.next_token.NextToken"]
    include_shared: NotRequired["capo_fsx.types.include_shared.IncludeShared"]
    """<p>Set to <code>false</code> (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to <code>true</code> if you want to see the snapshots in your account and the ones shared with you from another account.</p>"""

filters instance-attribute 

filters: NotRequired[SnapshotFilters]

The filters structure. The supported names are file-system-id or volume-id.

include_shared instance-attribute 

include_shared: NotRequired[IncludeShared]

Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to true if you want to see the snapshots in your account and the ones shared with you from another account.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

next_token instance-attribute 

next_token: NotRequired[NextToken]

snapshot_ids instance-attribute 

snapshot_ids: NotRequired[SnapshotIds]

The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a SnapshotNotFound error occurs.