Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Returns information about DB cluster snapshots. This API action supports pagination.
This operation returns paginated results.
Synopsis
- data DescribeDBClusterSnapshots = DescribeDBClusterSnapshots' {}
- newDescribeDBClusterSnapshots :: DescribeDBClusterSnapshots
- describeDBClusterSnapshots_dbClusterIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text)
- describeDBClusterSnapshots_dbClusterSnapshotIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text)
- describeDBClusterSnapshots_filters :: Lens' DescribeDBClusterSnapshots (Maybe [Filter])
- describeDBClusterSnapshots_includePublic :: Lens' DescribeDBClusterSnapshots (Maybe Bool)
- describeDBClusterSnapshots_includeShared :: Lens' DescribeDBClusterSnapshots (Maybe Bool)
- describeDBClusterSnapshots_marker :: Lens' DescribeDBClusterSnapshots (Maybe Text)
- describeDBClusterSnapshots_maxRecords :: Lens' DescribeDBClusterSnapshots (Maybe Int)
- describeDBClusterSnapshots_snapshotType :: Lens' DescribeDBClusterSnapshots (Maybe Text)
- data DescribeDBClusterSnapshotsResponse = DescribeDBClusterSnapshotsResponse' {}
- newDescribeDBClusterSnapshotsResponse :: Int -> DescribeDBClusterSnapshotsResponse
- describeDBClusterSnapshotsResponse_dbClusterSnapshots :: Lens' DescribeDBClusterSnapshotsResponse (Maybe [DBClusterSnapshot])
- describeDBClusterSnapshotsResponse_marker :: Lens' DescribeDBClusterSnapshotsResponse (Maybe Text)
- describeDBClusterSnapshotsResponse_httpStatus :: Lens' DescribeDBClusterSnapshotsResponse Int
Creating a Request
data DescribeDBClusterSnapshots Source #
See: newDescribeDBClusterSnapshots
smart constructor.
DescribeDBClusterSnapshots' | |
|
Instances
newDescribeDBClusterSnapshots :: DescribeDBClusterSnapshots Source #
Create a value of DescribeDBClusterSnapshots
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:
DescribeDBClusterSnapshots
, describeDBClusterSnapshots_dbClusterIdentifier
- The ID of the DB cluster to retrieve the list of DB cluster snapshots
for. This parameter can't be used in conjunction with the
DBClusterSnapshotIdentifier
parameter. This parameter is not
case-sensitive.
Constraints:
- If supplied, must match the identifier of an existing DBCluster.
DescribeDBClusterSnapshots
, describeDBClusterSnapshots_dbClusterSnapshotIdentifier
- A specific DB cluster snapshot identifier to describe. This parameter
can't be used in conjunction with the DBClusterIdentifier
parameter.
This value is stored as a lowercase string.
Constraints:
- If supplied, must match the identifier of an existing DBClusterSnapshot.
- If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
$sel:filters:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_filters
- This parameter is not currently supported.
$sel:includePublic:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_includePublic
- True to include manual DB cluster snapshots that are public and can be
copied or restored by any Amazon account, and otherwise false. The
default is false
. The default is false.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
$sel:includeShared:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_includeShared
- True to include shared manual DB cluster snapshots from other Amazon
accounts that this Amazon account has been given permission to copy or
restore, and otherwise false. The default is false
.
You can give an Amazon account permission to restore a manual DB cluster snapshot from another Amazon account by the ModifyDBClusterSnapshotAttribute API action.
DescribeDBClusterSnapshots
, describeDBClusterSnapshots_marker
- An optional pagination token provided by a previous
DescribeDBClusterSnapshots
request. If this parameter is specified,
the response includes only records beyond the marker, up to the value
specified by MaxRecords
.
$sel:maxRecords:DescribeDBClusterSnapshots'
, describeDBClusterSnapshots_maxRecords
- 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.
DescribeDBClusterSnapshots
, describeDBClusterSnapshots_snapshotType
- The type of DB cluster snapshots to be returned. You can specify one of
the following values:
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for my Amazon account.manual
- Return all DB cluster snapshots that have been taken by my Amazon account.shared
- Return all manual DB cluster snapshots that have been shared to my Amazon account.public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and
manual DB cluster snapshots are returned. You can include shared DB
cluster snapshots with these results by setting the IncludeShared
parameter to true
. You can include public DB cluster snapshots with
these results by setting the IncludePublic
parameter to true
.
The IncludeShared
and IncludePublic
parameters don't apply for
SnapshotType
values of manual
or automated
. The IncludePublic
parameter doesn't apply when SnapshotType
is set to shared
. The
IncludeShared
parameter doesn't apply when SnapshotType
is set to
public
.
Request Lenses
describeDBClusterSnapshots_dbClusterIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #
The ID of the DB cluster to retrieve the list of DB cluster snapshots
for. This parameter can't be used in conjunction with the
DBClusterSnapshotIdentifier
parameter. This parameter is not
case-sensitive.
Constraints:
- If supplied, must match the identifier of an existing DBCluster.
describeDBClusterSnapshots_dbClusterSnapshotIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #
A specific DB cluster snapshot identifier to describe. This parameter
can't be used in conjunction with the DBClusterIdentifier
parameter.
This value is stored as a lowercase string.
Constraints:
- If supplied, must match the identifier of an existing DBClusterSnapshot.
- If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
describeDBClusterSnapshots_filters :: Lens' DescribeDBClusterSnapshots (Maybe [Filter]) Source #
This parameter is not currently supported.
describeDBClusterSnapshots_includePublic :: Lens' DescribeDBClusterSnapshots (Maybe Bool) Source #
True to include manual DB cluster snapshots that are public and can be
copied or restored by any Amazon account, and otherwise false. The
default is false
. The default is false.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
describeDBClusterSnapshots_includeShared :: Lens' DescribeDBClusterSnapshots (Maybe Bool) Source #
True to include shared manual DB cluster snapshots from other Amazon
accounts that this Amazon account has been given permission to copy or
restore, and otherwise false. The default is false
.
You can give an Amazon account permission to restore a manual DB cluster snapshot from another Amazon account by the ModifyDBClusterSnapshotAttribute API action.
describeDBClusterSnapshots_marker :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #
An optional pagination token provided by a previous
DescribeDBClusterSnapshots
request. If this parameter is specified,
the response includes only records beyond the marker, up to the value
specified by MaxRecords
.
describeDBClusterSnapshots_maxRecords :: Lens' DescribeDBClusterSnapshots (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.
describeDBClusterSnapshots_snapshotType :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for my Amazon account.manual
- Return all DB cluster snapshots that have been taken by my Amazon account.shared
- Return all manual DB cluster snapshots that have been shared to my Amazon account.public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and
manual DB cluster snapshots are returned. You can include shared DB
cluster snapshots with these results by setting the IncludeShared
parameter to true
. You can include public DB cluster snapshots with
these results by setting the IncludePublic
parameter to true
.
The IncludeShared
and IncludePublic
parameters don't apply for
SnapshotType
values of manual
or automated
. The IncludePublic
parameter doesn't apply when SnapshotType
is set to shared
. The
IncludeShared
parameter doesn't apply when SnapshotType
is set to
public
.
Destructuring the Response
data DescribeDBClusterSnapshotsResponse Source #
See: newDescribeDBClusterSnapshotsResponse
smart constructor.
DescribeDBClusterSnapshotsResponse' | |
|
Instances
newDescribeDBClusterSnapshotsResponse Source #
Create a value of DescribeDBClusterSnapshotsResponse
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:dbClusterSnapshots:DescribeDBClusterSnapshotsResponse'
, describeDBClusterSnapshotsResponse_dbClusterSnapshots
- Provides a list of DB cluster snapshots for the user.
DescribeDBClusterSnapshots
, describeDBClusterSnapshotsResponse_marker
- An optional pagination token provided by a previous
DescribeDBClusterSnapshots request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords
.
$sel:httpStatus:DescribeDBClusterSnapshotsResponse'
, describeDBClusterSnapshotsResponse_httpStatus
- The response's http status code.
Response Lenses
describeDBClusterSnapshotsResponse_dbClusterSnapshots :: Lens' DescribeDBClusterSnapshotsResponse (Maybe [DBClusterSnapshot]) Source #
Provides a list of DB cluster snapshots for the user.
describeDBClusterSnapshotsResponse_marker :: Lens' DescribeDBClusterSnapshotsResponse (Maybe Text) Source #
An optional pagination token provided by a previous
DescribeDBClusterSnapshots request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords
.
describeDBClusterSnapshotsResponse_httpStatus :: Lens' DescribeDBClusterSnapshotsResponse Int Source #
The response's http status code.