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

Amazonka.RDS.DescribeDBClusterSnapshots

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about DB cluster snapshots. This API action supports pagination.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDBClusterSnapshots Source #

See: newDescribeDBClusterSnapshots smart constructor.

Constructors

DescribeDBClusterSnapshots'

Fields

dbClusterIdentifier :: Maybe Text
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 isn't case-sensitive.
Constraints:
- If supplied, must match the identifier of an existing DBCluster.
dbClusterSnapshotIdentifier :: Maybe Text
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.
filters :: Maybe [Filter]
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
- db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
- db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.
- snapshot-type - Accepts types of DB cluster snapshots.
- engine - Accepts names of database engines.
includePublic :: Maybe Bool
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
includeShared :: Maybe Bool
A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
marker :: Maybe Text
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.
maxRecords :: Maybe Int
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 you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
snapshotType :: Maybe Text
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 RDS for my Amazon Web Services account.
- manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.
- shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services 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 enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.
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.

Instances

Instances details

ToHeaders DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots Methods toHeaders :: DescribeDBClusterSnapshots -> [Header] #
ToPath DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots Methods toPath :: DescribeDBClusterSnapshots -> ByteString #
ToQuery DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots Methods toQuery :: DescribeDBClusterSnapshots -> QueryString #
AWSPager DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots Methods page :: DescribeDBClusterSnapshots -> AWSResponse DescribeDBClusterSnapshots -> Maybe DescribeDBClusterSnapshots #
AWSRequest DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots Associated Types type AWSResponse DescribeDBClusterSnapshots # Methods request :: (Service -> Service) -> DescribeDBClusterSnapshots -> Request DescribeDBClusterSnapshots # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDBClusterSnapshots -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDBClusterSnapshots))) #
Generic DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots Associated Types type Rep DescribeDBClusterSnapshots :: Type -> Type # Methods from :: DescribeDBClusterSnapshots -> Rep DescribeDBClusterSnapshots x # to :: Rep DescribeDBClusterSnapshots x -> DescribeDBClusterSnapshots #
Read DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots Methods readsPrec :: Int -> ReadS DescribeDBClusterSnapshots # readList :: ReadS [DescribeDBClusterSnapshots] # readPrec :: ReadPrec DescribeDBClusterSnapshots # readListPrec :: ReadPrec [DescribeDBClusterSnapshots] #
Show DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots Methods showsPrec :: Int -> DescribeDBClusterSnapshots -> ShowS # show :: DescribeDBClusterSnapshots -> String # showList :: [DescribeDBClusterSnapshots] -> ShowS #
NFData DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots Methods rnf :: DescribeDBClusterSnapshots -> () #
Eq DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots Methods (==) :: DescribeDBClusterSnapshots -> DescribeDBClusterSnapshots -> Bool # (/=) :: DescribeDBClusterSnapshots -> DescribeDBClusterSnapshots -> Bool #
Hashable DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots Methods hashWithSalt :: Int -> DescribeDBClusterSnapshots -> Int # hash :: DescribeDBClusterSnapshots -> Int #
type AWSResponse DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots type AWSResponse DescribeDBClusterSnapshots = DescribeDBClusterSnapshotsResponse
type Rep DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots type Rep DescribeDBClusterSnapshots = D1 ('MetaData "DescribeDBClusterSnapshots" "Amazonka.RDS.DescribeDBClusterSnapshots" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBClusterSnapshots'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "includePublic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "includeShared") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "snapshotType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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 isn't 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 - A filter that specifies one or more DB cluster snapshots to describe.

Supported filters:

db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.
snapshot-type - Accepts types of DB cluster snapshots.
engine - Accepts names of database engines.

$sel:includePublic:DescribeDBClusterSnapshots', describeDBClusterSnapshots_includePublic - A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

$sel:includeShared:DescribeDBClusterSnapshots', describeDBClusterSnapshots_includeShared - A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services 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 you can retrieve the remaining results.

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 RDS for my Amazon Web Services account.
manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.
shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services 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 enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.

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 isn't 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 #

A filter that specifies one or more DB cluster snapshots to describe.

Supported filters:

db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.
snapshot-type - Accepts types of DB cluster snapshots.
engine - Accepts names of database engines.

describeDBClusterSnapshots_includePublic :: Lens' DescribeDBClusterSnapshots (Maybe Bool) Source #

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

describeDBClusterSnapshots_includeShared :: Lens' DescribeDBClusterSnapshots (Maybe Bool) Source #

A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services 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 you can retrieve the remaining results.

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 RDS for my Amazon Web Services account.
manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.
shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services 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 enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.

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 #

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

See: newDescribeDBClusterSnapshotsResponse smart constructor.

Constructors

DescribeDBClusterSnapshotsResponse'
Fields dbClusterSnapshots :: Maybe [DBClusterSnapshot] Provides a list of DB cluster snapshots for the user. marker :: Maybe Text 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`. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeDBClusterSnapshotsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots Associated Types type Rep DescribeDBClusterSnapshotsResponse :: Type -> Type # Methods from :: DescribeDBClusterSnapshotsResponse -> Rep DescribeDBClusterSnapshotsResponse x # to :: Rep DescribeDBClusterSnapshotsResponse x -> DescribeDBClusterSnapshotsResponse #
Read DescribeDBClusterSnapshotsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots Methods readsPrec :: Int -> ReadS DescribeDBClusterSnapshotsResponse # readList :: ReadS [DescribeDBClusterSnapshotsResponse] # readPrec :: ReadPrec DescribeDBClusterSnapshotsResponse # readListPrec :: ReadPrec [DescribeDBClusterSnapshotsResponse] #
Show DescribeDBClusterSnapshotsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots Methods showsPrec :: Int -> DescribeDBClusterSnapshotsResponse -> ShowS # show :: DescribeDBClusterSnapshotsResponse -> String # showList :: [DescribeDBClusterSnapshotsResponse] -> ShowS #
NFData DescribeDBClusterSnapshotsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots Methods rnf :: DescribeDBClusterSnapshotsResponse -> () #
Eq DescribeDBClusterSnapshotsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots Methods (==) :: DescribeDBClusterSnapshotsResponse -> DescribeDBClusterSnapshotsResponse -> Bool # (/=) :: DescribeDBClusterSnapshotsResponse -> DescribeDBClusterSnapshotsResponse -> Bool #
type Rep DescribeDBClusterSnapshotsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterSnapshots type Rep DescribeDBClusterSnapshotsResponse = D1 ('MetaData "DescribeDBClusterSnapshotsResponse" "Amazonka.RDS.DescribeDBClusterSnapshots" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBClusterSnapshotsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterSnapshots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterSnapshot])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBClusterSnapshotsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeDBClusterSnapshotsResponse'`
-> DescribeDBClusterSnapshotsResponse

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.