Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns information about DB snapshots. This API supports pagination.
See: AWS API Reference for DescribeDBSnapshots.
This operation returns paginated results.
- describeDBSnapshots :: DescribeDBSnapshots
- data DescribeDBSnapshots
- ddsFilters :: Lens' DescribeDBSnapshots [Filter]
- ddsDBSnapshotIdentifier :: Lens' DescribeDBSnapshots (Maybe Text)
- ddsSnapshotType :: Lens' DescribeDBSnapshots (Maybe Text)
- ddsDBInstanceIdentifier :: Lens' DescribeDBSnapshots (Maybe Text)
- ddsMaxRecords :: Lens' DescribeDBSnapshots (Maybe Int)
- ddsMarker :: Lens' DescribeDBSnapshots (Maybe Text)
- describeDBSnapshotsResponse :: Int -> DescribeDBSnapshotsResponse
- data DescribeDBSnapshotsResponse
- ddsrsMarker :: Lens' DescribeDBSnapshotsResponse (Maybe Text)
- ddsrsDBSnapshots :: Lens' DescribeDBSnapshotsResponse [DBSnapshot]
- ddsrsStatus :: Lens' DescribeDBSnapshotsResponse Int
Creating a Request
describeDBSnapshots :: DescribeDBSnapshots Source
Creates a value of DescribeDBSnapshots
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeDBSnapshots Source
See: describeDBSnapshots
smart constructor.
Request Lenses
ddsFilters :: Lens' DescribeDBSnapshots [Filter] Source
This parameter is not currently supported.
ddsDBSnapshotIdentifier :: Lens' DescribeDBSnapshots (Maybe Text) Source
A specific DB snapshot identifier to describe. This parameter cannot be
used in conjunction with DBInstanceIdentifier
. This value is stored as
a lowercase string.
Constraints:
- Must be 1 to 255 alphanumeric characters.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- If this is the identifier of an automated snapshot, the
SnapshotType
parameter must also be specified.
ddsSnapshotType :: Lens' DescribeDBSnapshots (Maybe Text) Source
The type of snapshots that will be returned. Values can be "automated" or "manual." If not specified, the returned results will include all snapshots types.
ddsDBInstanceIdentifier :: Lens' DescribeDBSnapshots (Maybe Text) Source
A DB instance identifier to retrieve the list of DB snapshots for. This
parameter cannot be used in conjunction with DBSnapshotIdentifier
.
This parameter is not case-sensitive.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
ddsMaxRecords :: Lens' DescribeDBSnapshots (Maybe Int) Source
The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
ddsMarker :: Lens' DescribeDBSnapshots (Maybe Text) Source
An optional pagination token provided by a previous
DescribeDBSnapshots
request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords
.
Destructuring the Response
describeDBSnapshotsResponse Source
Creates a value of DescribeDBSnapshotsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeDBSnapshotsResponse Source
Contains the result of a successful invocation of the DescribeDBSnapshots action.
See: describeDBSnapshotsResponse
smart constructor.
Response Lenses
ddsrsMarker :: Lens' DescribeDBSnapshotsResponse (Maybe Text) Source
An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
ddsrsDBSnapshots :: Lens' DescribeDBSnapshotsResponse [DBSnapshot] Source
A list of DBSnapshot instances.
ddsrsStatus :: Lens' DescribeDBSnapshotsResponse Int Source
The response status code.