Copyright | (c) 2013-2016 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.
This operation returns paginated results.
- describeDBSnapshots :: DescribeDBSnapshots
- data DescribeDBSnapshots
- ddsIncludeShared :: Lens' DescribeDBSnapshots (Maybe Bool)
- ddsFilters :: Lens' DescribeDBSnapshots [Filter]
- ddsDBSnapshotIdentifier :: Lens' DescribeDBSnapshots (Maybe Text)
- ddsSnapshotType :: Lens' DescribeDBSnapshots (Maybe Text)
- ddsDBInstanceIdentifier :: Lens' DescribeDBSnapshots (Maybe Text)
- ddsMarker :: Lens' DescribeDBSnapshots (Maybe Text)
- ddsMaxRecords :: Lens' DescribeDBSnapshots (Maybe Int)
- ddsIncludePublic :: Lens' DescribeDBSnapshots (Maybe Bool)
- describeDBSnapshotsResponse :: Int -> DescribeDBSnapshotsResponse
- data DescribeDBSnapshotsResponse
- ddsrsMarker :: Lens' DescribeDBSnapshotsResponse (Maybe Text)
- ddsrsDBSnapshots :: Lens' DescribeDBSnapshotsResponse [DBSnapshot]
- ddsrsResponseStatus :: 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
ddsIncludeShared :: Lens' DescribeDBSnapshots (Maybe Bool) Source #
True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore; otherwise false. The default is false.
An AWS account is given permission to restore a manual DB snapshot from another AWS account by the ModifyDBSnapshotAttribute API.
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. You can specify one of the following values:
automated
- Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.manual
- Return all DB snapshots that have been taken by my AWS account.shared
- Return all manual DB snapshots that have been shared to my AWS account.public
- Return all DB snapshots that have been marked as public.
If you do not specify a SnapshotType
, then both automated and manual snapshots are returned. You can include shared snapshots with these results by setting the IncludeShared
parameter to true
. You can include public snapshots with these results by setting the IncludePublic
parameter to true
.
The IncludeShared
and IncludePublic
parameters do not apply for SnapshotType
values of manual
or automated
. The IncludePublic
parameter does not apply when SnapshotType
is set to shared
. the IncludeShared
parameter does not apply when SnapshotType
is set to public
.
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
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
.
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.
ddsIncludePublic :: Lens' DescribeDBSnapshots (Maybe Bool) Source #
True to include manual DB snapshots that are public and can be copied or restored by any AWS account; otherwise false. The default is false.
An manual DB snapshot is shared as public by the ModifyDBSnapshotAttribute API.
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.
ddsrsResponseStatus :: Lens' DescribeDBSnapshotsResponse Int Source #
The response status code.