Network.AWS.DirectoryService.DescribeSnapshots

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.

See: AWS API Reference for DescribeSnapshots.

Creating a Request

describeSnapshots :: DescribeSnapshots

Creates a value of DescribeSnapshots with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dsDirectoryId
• dsNextToken
• dsSnapshotIds
• dsLimit

data DescribeSnapshots

Contains the inputs for the DescribeSnapshots operation.

See: describeSnapshots smart constructor.

Instances

Eq DescribeSnapshots

Data DescribeSnapshots

Read DescribeSnapshots

Show DescribeSnapshots

Generic DescribeSnapshots

ToJSON DescribeSnapshots

AWSRequest DescribeSnapshots

ToPath DescribeSnapshots

ToHeaders DescribeSnapshots

ToQuery DescribeSnapshots

type Rep DescribeSnapshots

type Rs DescribeSnapshots = DescribeSnapshotsResponse

Request Lenses

dsDirectoryId :: Lens' DescribeSnapshots (Maybe Text)

The identifier of the directory to retrieve snapshot information for.

dsNextToken :: Lens' DescribeSnapshots (Maybe Text)

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

dsSnapshotIds :: Lens' DescribeSnapshots [Text]

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.

dsLimit :: Lens' DescribeSnapshots (Maybe Natural)

The maximum number of objects to return.

Destructuring the Response

describeSnapshotsResponse

Arguments

:: Int

dssrsResponseStatus

-> DescribeSnapshotsResponse

Creates a value of DescribeSnapshotsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dssrsNextToken
• dssrsSnapshots
• dssrsResponseStatus

data DescribeSnapshotsResponse

Contains the results of the DescribeSnapshots operation.

See: describeSnapshotsResponse smart constructor.

Instances

Eq DescribeSnapshotsResponse

Data DescribeSnapshotsResponse

Read DescribeSnapshotsResponse

Show DescribeSnapshotsResponse

Generic DescribeSnapshotsResponse

type Rep DescribeSnapshotsResponse

Response Lenses

dssrsNextToken :: Lens' DescribeSnapshotsResponse (Maybe Text)

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

dssrsSnapshots :: Lens' DescribeSnapshotsResponse [Snapshot]

The list of Snapshot objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

dssrsResponseStatus :: Lens' DescribeSnapshotsResponse Int

The response status code.