Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
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.
Synopsis
- describeSnapshots :: DescribeSnapshots
- data DescribeSnapshots
- dsDirectoryId :: Lens' DescribeSnapshots (Maybe Text)
- dsNextToken :: Lens' DescribeSnapshots (Maybe Text)
- dsSnapshotIds :: Lens' DescribeSnapshots [Text]
- dsLimit :: Lens' DescribeSnapshots (Maybe Natural)
- describeSnapshotsResponse :: Int -> DescribeSnapshotsResponse
- data DescribeSnapshotsResponse
- dssrsNextToken :: Lens' DescribeSnapshotsResponse (Maybe Text)
- dssrsSnapshots :: Lens' DescribeSnapshotsResponse [Snapshot]
- dssrsResponseStatus :: Lens' DescribeSnapshotsResponse Int
Creating a Request
describeSnapshots :: DescribeSnapshots Source #
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
- The identifier of the directory for which to retrieve snapshot information.dsNextToken
- The DescribeSnapshotsResult.NextToken value from a previous call toDescribeSnapshots
. Pass null if this is the first call.dsSnapshotIds
- 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
- The maximum number of objects to return.
data DescribeSnapshots Source #
Contains the inputs for the DescribeSnapshots
operation.
See: describeSnapshots
smart constructor.
Instances
Request Lenses
dsDirectoryId :: Lens' DescribeSnapshots (Maybe Text) Source #
The identifier of the directory for which to retrieve snapshot information.
dsNextToken :: Lens' DescribeSnapshots (Maybe Text) Source #
The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots
. Pass null if this is the first call.
dsSnapshotIds :: Lens' DescribeSnapshots [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.
Destructuring the Response
describeSnapshotsResponse Source #
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
- If not null, more results are available. Pass this value in the NextToken member of a subsequent call toDescribeSnapshots
.dssrsSnapshots
- The list ofSnapshot
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
- -- | The response status code.
data DescribeSnapshotsResponse Source #
Contains the results of the DescribeSnapshots
operation.
See: describeSnapshotsResponse
smart constructor.
Instances
Response Lenses
dssrsNextToken :: 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
.
dssrsSnapshots :: Lens' DescribeSnapshotsResponse [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.
dssrsResponseStatus :: Lens' DescribeSnapshotsResponse Int Source #
- - | The response status code.