Safe Haskell | None |
---|---|
Language | Haskell2010 |
Returns information about DB snapshots. This API supports pagination.
http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBSnapshots.html
- data DescribeDBSnapshots
- describeDBSnapshots :: DescribeDBSnapshots
- ddbsDBInstanceIdentifier :: Lens' DescribeDBSnapshots (Maybe Text)
- ddbsDBSnapshotIdentifier :: Lens' DescribeDBSnapshots (Maybe Text)
- ddbsFilters :: Lens' DescribeDBSnapshots [Filter]
- ddbsMarker :: Lens' DescribeDBSnapshots (Maybe Text)
- ddbsMaxRecords :: Lens' DescribeDBSnapshots (Maybe Int)
- ddbsSnapshotType :: Lens' DescribeDBSnapshots (Maybe Text)
- data DescribeDBSnapshotsResponse
- describeDBSnapshotsResponse :: DescribeDBSnapshotsResponse
- ddbsrDBSnapshots :: Lens' DescribeDBSnapshotsResponse [DBSnapshot]
- ddbsrMarker :: Lens' DescribeDBSnapshotsResponse (Maybe Text)
Request
Request constructor
describeDBSnapshots :: DescribeDBSnapshots Source
DescribeDBSnapshots
constructor.
The fields accessible through corresponding lenses are:
Request lenses
ddbsDBInstanceIdentifier :: Lens' DescribeDBSnapshots (Maybe Text) Source
A DB instance identifier to retrieve the list of DB snapshots for. 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
ddbsDBSnapshotIdentifier :: Lens' DescribeDBSnapshots (Maybe Text) Source
A specific DB snapshot identifier to describe. 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.
ddbsFilters :: Lens' DescribeDBSnapshots [Filter] Source
This parameter is not currently supported.
ddbsMarker :: 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
.
ddbsMaxRecords :: 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 may be retrieved.
Default: 100
Constraints: minimum 20, maximum 100
ddbsSnapshotType :: 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.
Response
Response constructor
describeDBSnapshotsResponse :: DescribeDBSnapshotsResponse Source
DescribeDBSnapshotsResponse
constructor.
The fields accessible through corresponding lenses are:
Response lenses
ddbsrDBSnapshots :: Lens' DescribeDBSnapshotsResponse [DBSnapshot] Source
A list of DBSnapshot
instances.
ddbsrMarker :: 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
.