Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1467365253.0 KB

Obtains information about the directory snapshots that belong to this account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

post/#X-Amz-Target=DirectoryService_20150416.DescribeSnapshots

Query parameters

Limitstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'DirectoryService_20150416.DescribeSnapshots' required

Request body

DirectoryIdstring

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

SnapshotIdsSnapshotId[]

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.

NextTokenstring

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

Limitinteger

The maximum number of objects to return.

Response

Success

NextTokenstring

If not null, more results are available. Pass this value in the <i>NextToken</i> member of a subsequent call to <a>DescribeSnapshots</a>.