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.DocumentDB.DescribeDBClusterSnapshots

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about cluster snapshots. This API operation supports pagination.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDBClusterSnapshots Source #

Represents the input to DescribeDBClusterSnapshots.

See: newDescribeDBClusterSnapshots smart constructor.

Constructors

DescribeDBClusterSnapshots'

Fields

dbClusterIdentifier :: Maybe Text
The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.
Constraints:
- If provided, must match the identifier of an existing DBCluster.
dbClusterSnapshotIdentifier :: Maybe Text
A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
- If provided, 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]
This parameter is not currently supported.
includePublic :: Maybe Bool
Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.
includeShared :: Maybe Bool
Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.
marker :: Maybe Text
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.
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 (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
snapshotType :: Maybe Text
The type of cluster snapshots to be returned. You can specify one of the following values:
- automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
- manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
- shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.
- public - Return all cluster snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic 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.

Instances

Instances details

ToHeaders DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots Methods toHeaders :: DescribeDBClusterSnapshots -> [Header] #
ToPath DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots Methods toPath :: DescribeDBClusterSnapshots -> ByteString #
ToQuery DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots Methods toQuery :: DescribeDBClusterSnapshots -> QueryString #
AWSPager DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots Methods page :: DescribeDBClusterSnapshots -> AWSResponse DescribeDBClusterSnapshots -> Maybe DescribeDBClusterSnapshots #
AWSRequest DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.DocumentDB.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.DocumentDB.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.DocumentDB.DescribeDBClusterSnapshots Methods readsPrec :: Int -> ReadS DescribeDBClusterSnapshots # readList :: ReadS [DescribeDBClusterSnapshots] # readPrec :: ReadPrec DescribeDBClusterSnapshots # readListPrec :: ReadPrec [DescribeDBClusterSnapshots] #
Show DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots Methods showsPrec :: Int -> DescribeDBClusterSnapshots -> ShowS # show :: DescribeDBClusterSnapshots -> String # showList :: [DescribeDBClusterSnapshots] -> ShowS #
NFData DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots Methods rnf :: DescribeDBClusterSnapshots -> () #
Eq DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots Methods (==) :: DescribeDBClusterSnapshots -> DescribeDBClusterSnapshots -> Bool # (/=) :: DescribeDBClusterSnapshots -> DescribeDBClusterSnapshots -> Bool #
Hashable DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots Methods hashWithSalt :: Int -> DescribeDBClusterSnapshots -> Int # hash :: DescribeDBClusterSnapshots -> Int #
type AWSResponse DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots type AWSResponse DescribeDBClusterSnapshots = DescribeDBClusterSnapshotsResponse
type Rep DescribeDBClusterSnapshots Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots type Rep DescribeDBClusterSnapshots = D1 ('MetaData "DescribeDBClusterSnapshots" "Amazonka.DocumentDB.DescribeDBClusterSnapshots" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

If provided, must match the identifier of an existing DBCluster.

DescribeDBClusterSnapshots, describeDBClusterSnapshots_dbClusterSnapshotIdentifier - A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

If provided, 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 - Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.

$sel:includeShared:DescribeDBClusterSnapshots', describeDBClusterSnapshots_includeShared - Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.

DescribeDBClusterSnapshots, describeDBClusterSnapshots_marker - 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.

$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 (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 cluster snapshots to be returned. You can specify one of the following values:

automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.
public - Return all cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic 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 cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

If provided, must match the identifier of an existing DBCluster.

describeDBClusterSnapshots_dbClusterSnapshotIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text) Source #

A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

If provided, 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 #

Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.

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

Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.

describeDBClusterSnapshots_marker :: Lens' DescribeDBClusterSnapshots (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.

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 (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 cluster snapshots to be returned. You can specify one of the following values:

automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.
public - Return all cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic 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 #

Represents the output of DescribeDBClusterSnapshots.

See: newDescribeDBClusterSnapshotsResponse smart constructor.

Constructors

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

Instances

Instances details

Generic DescribeDBClusterSnapshotsResponse Source #
Instance details Defined in Amazonka.DocumentDB.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.DocumentDB.DescribeDBClusterSnapshots Methods readsPrec :: Int -> ReadS DescribeDBClusterSnapshotsResponse # readList :: ReadS [DescribeDBClusterSnapshotsResponse] # readPrec :: ReadPrec DescribeDBClusterSnapshotsResponse # readListPrec :: ReadPrec [DescribeDBClusterSnapshotsResponse] #
Show DescribeDBClusterSnapshotsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots Methods showsPrec :: Int -> DescribeDBClusterSnapshotsResponse -> ShowS # show :: DescribeDBClusterSnapshotsResponse -> String # showList :: [DescribeDBClusterSnapshotsResponse] -> ShowS #
NFData DescribeDBClusterSnapshotsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots Methods rnf :: DescribeDBClusterSnapshotsResponse -> () #
Eq DescribeDBClusterSnapshotsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots Methods (==) :: DescribeDBClusterSnapshotsResponse -> DescribeDBClusterSnapshotsResponse -> Bool # (/=) :: DescribeDBClusterSnapshotsResponse -> DescribeDBClusterSnapshotsResponse -> Bool #
type Rep DescribeDBClusterSnapshotsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusterSnapshots type Rep DescribeDBClusterSnapshotsResponse = D1 ('MetaData "DescribeDBClusterSnapshotsResponse" "Amazonka.DocumentDB.DescribeDBClusterSnapshots" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 cluster snapshots.

DescribeDBClusterSnapshots, describeDBClusterSnapshotsResponse_marker - 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.

$sel:httpStatus:DescribeDBClusterSnapshotsResponse', describeDBClusterSnapshotsResponse_httpStatus - The response's http status code.

Response Lenses

describeDBClusterSnapshotsResponse_dbClusterSnapshots :: Lens' DescribeDBClusterSnapshotsResponse (Maybe [DBClusterSnapshot]) Source #

Provides a list of cluster snapshots.

describeDBClusterSnapshotsResponse_marker :: Lens' DescribeDBClusterSnapshotsResponse (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.

describeDBClusterSnapshotsResponse_httpStatus :: Lens' DescribeDBClusterSnapshotsResponse Int Source #

The response's http status code.