Skip to content

DescribeSnapshotsRequest

Source code in docs_src/capo_directory_service/types/describe_snapshots_request.py 
14
15
16
17
18
19
20
21
22
class DescribeSnapshotsRequest(TypedDict, closed=True):
    directory_id: NotRequired["capo_directory_service.types.directory_id.DirectoryId"]
    """<p>The identifier of the directory for which to retrieve snapshot information.</p>"""
    snapshot_ids: NotRequired["capo_directory_service.types.snapshot_ids.SnapshotIds"]
    """<p>A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the <i>Limit</i> and <i>NextToken</i> members.</p>"""
    next_token: NotRequired["capo_directory_service.types.next_token.NextToken"]
    """<p>The <i>DescribeSnapshotsResult.NextToken</i> value from a previous call to <a>DescribeSnapshots</a>. Pass null if this is the first call.</p>"""
    limit: NotRequired["capo_directory_service.types.limit.Limit"]
    """<p>The maximum number of objects to return.</p>"""

directory_id instance-attribute 

directory_id: NotRequired[DirectoryId]

The identifier of the directory for which to retrieve snapshot information.

limit instance-attribute 

limit: NotRequired[Limit]

The maximum number of objects to return.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

snapshot_ids instance-attribute 

snapshot_ids: NotRequired[SnapshotIds]

A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.