| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.DirectoryService.DescribeSnapshots
Description
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.
This operation returns paginated results.
Synopsis
- data DescribeSnapshots = DescribeSnapshots' {}
- newDescribeSnapshots :: DescribeSnapshots
- describeSnapshots_directoryId :: Lens' DescribeSnapshots (Maybe Text)
- describeSnapshots_nextToken :: Lens' DescribeSnapshots (Maybe Text)
- describeSnapshots_snapshotIds :: Lens' DescribeSnapshots (Maybe [Text])
- describeSnapshots_limit :: Lens' DescribeSnapshots (Maybe Natural)
- data DescribeSnapshotsResponse = DescribeSnapshotsResponse' {}
- newDescribeSnapshotsResponse :: Int -> DescribeSnapshotsResponse
- describeSnapshotsResponse_nextToken :: Lens' DescribeSnapshotsResponse (Maybe Text)
- describeSnapshotsResponse_snapshots :: Lens' DescribeSnapshotsResponse (Maybe [Snapshot])
- describeSnapshotsResponse_httpStatus :: Lens' DescribeSnapshotsResponse Int
Creating a Request
data DescribeSnapshots Source #
Contains the inputs for the DescribeSnapshots operation.
See: newDescribeSnapshots smart constructor.
Constructors
| DescribeSnapshots' | |
Fields
| |
Instances
newDescribeSnapshots :: DescribeSnapshots Source #
Create a value of DescribeSnapshots with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:directoryId:DescribeSnapshots', describeSnapshots_directoryId - The identifier of the directory for which to retrieve snapshot
information.
$sel:nextToken:DescribeSnapshots', describeSnapshots_nextToken - The DescribeSnapshotsResult.NextToken value from a previous call to
DescribeSnapshots. Pass null if this is the first call.
$sel:snapshotIds:DescribeSnapshots', describeSnapshots_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.
$sel:limit:DescribeSnapshots', describeSnapshots_limit - The maximum number of objects to return.
Request Lenses
describeSnapshots_directoryId :: Lens' DescribeSnapshots (Maybe Text) Source #
The identifier of the directory for which to retrieve snapshot information.
describeSnapshots_nextToken :: Lens' DescribeSnapshots (Maybe Text) Source #
The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.
describeSnapshots_snapshotIds :: Lens' DescribeSnapshots (Maybe [Text]) Source #
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.
describeSnapshots_limit :: Lens' DescribeSnapshots (Maybe Natural) Source #
The maximum number of objects to return.
Destructuring the Response
data DescribeSnapshotsResponse Source #
Contains the results of the DescribeSnapshots operation.
See: newDescribeSnapshotsResponse smart constructor.
Constructors
| DescribeSnapshotsResponse' | |
Fields
| |
Instances
newDescribeSnapshotsResponse Source #
Create a value of DescribeSnapshotsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeSnapshots', describeSnapshotsResponse_nextToken - If not null, more results are available. Pass this value in the
NextToken member of a subsequent call to DescribeSnapshots.
$sel:snapshots:DescribeSnapshotsResponse', describeSnapshotsResponse_snapshots - 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.
$sel:httpStatus:DescribeSnapshotsResponse', describeSnapshotsResponse_httpStatus - The response's http status code.
Response Lenses
describeSnapshotsResponse_nextToken :: Lens' DescribeSnapshotsResponse (Maybe Text) Source #
If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots.
describeSnapshotsResponse_snapshots :: Lens' DescribeSnapshotsResponse (Maybe [Snapshot]) Source #
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.
describeSnapshotsResponse_httpStatus :: Lens' DescribeSnapshotsResponse Int Source #
The response's http status code.