Network.AWS.RDS.DescribeDBClusterSnapshots

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

This operation returns paginated results.

Creating a Request

describeDBClusterSnapshots :: DescribeDBClusterSnapshots

Creates a value of DescribeDBClusterSnapshots with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ddbcsDBClusterIdentifier - The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with the DBClusterSnapshotIdentifier parameter. 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
• ddbcsIncludeShared - Set this value to true to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false . The default is false . You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.
• ddbcsDBClusterSnapshotIdentifier - A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the DBClusterIdentifier parameter. 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 identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
• ddbcsFilters - This parameter is not currently supported.
• ddbcsSnapshotType - 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 AWS account. * manual - Return all DB cluster snapshots that have been taken by my AWS account. * shared - Return all manual DB cluster snapshots that have been shared to my AWS 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 .
• ddbcsMarker - 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 .
• ddbcsMaxRecords - 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.
• ddbcsIncludePublic - Set this value to true to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to 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.

data DescribeDBClusterSnapshots

See: describeDBClusterSnapshots smart constructor.

Instances

Eq DescribeDBClusterSnapshots

Methods

(==) :: DescribeDBClusterSnapshots -> DescribeDBClusterSnapshots -> Bool

(/=) :: DescribeDBClusterSnapshots -> DescribeDBClusterSnapshots -> Bool

Data DescribeDBClusterSnapshots

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeDBClusterSnapshots -> c DescribeDBClusterSnapshots

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeDBClusterSnapshots

toConstr :: DescribeDBClusterSnapshots -> Constr

dataTypeOf :: DescribeDBClusterSnapshots -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeDBClusterSnapshots)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeDBClusterSnapshots)

gmapT :: (forall b. Data b => b -> b) -> DescribeDBClusterSnapshots -> DescribeDBClusterSnapshots

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDBClusterSnapshots -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDBClusterSnapshots -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeDBClusterSnapshots -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeDBClusterSnapshots -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeDBClusterSnapshots -> m DescribeDBClusterSnapshots

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDBClusterSnapshots -> m DescribeDBClusterSnapshots

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDBClusterSnapshots -> m DescribeDBClusterSnapshots

Read DescribeDBClusterSnapshots

Methods

readsPrec :: Int -> ReadS DescribeDBClusterSnapshots

readList :: ReadS [DescribeDBClusterSnapshots]

readPrec :: ReadPrec DescribeDBClusterSnapshots

readListPrec :: ReadPrec [DescribeDBClusterSnapshots]

Show DescribeDBClusterSnapshots

Methods

showsPrec :: Int -> DescribeDBClusterSnapshots -> ShowS

show :: DescribeDBClusterSnapshots -> String

showList :: [DescribeDBClusterSnapshots] -> ShowS

Generic DescribeDBClusterSnapshots

Associated Types

type Rep DescribeDBClusterSnapshots :: * -> *

Methods

from :: DescribeDBClusterSnapshots -> Rep DescribeDBClusterSnapshots x

to :: Rep DescribeDBClusterSnapshots x -> DescribeDBClusterSnapshots

Hashable DescribeDBClusterSnapshots

Methods

hashWithSalt :: Int -> DescribeDBClusterSnapshots -> Int

hash :: DescribeDBClusterSnapshots -> Int

NFData DescribeDBClusterSnapshots

Methods

rnf :: DescribeDBClusterSnapshots -> ()

AWSPager DescribeDBClusterSnapshots

Methods

page :: DescribeDBClusterSnapshots -> Rs DescribeDBClusterSnapshots -> Maybe DescribeDBClusterSnapshots

AWSRequest DescribeDBClusterSnapshots

Associated Types

type Rs DescribeDBClusterSnapshots :: *

Methods

request :: DescribeDBClusterSnapshots -> Request DescribeDBClusterSnapshots

response :: MonadResource m => Logger -> Service -> Proxy * DescribeDBClusterSnapshots -> ClientResponse -> m (Response DescribeDBClusterSnapshots)

ToPath DescribeDBClusterSnapshots

Methods

toPath :: DescribeDBClusterSnapshots -> ByteString

ToHeaders DescribeDBClusterSnapshots

Methods

toHeaders :: DescribeDBClusterSnapshots -> [Header]

ToQuery DescribeDBClusterSnapshots

Methods

toQuery :: DescribeDBClusterSnapshots -> QueryString

type Rep DescribeDBClusterSnapshots

type Rep DescribeDBClusterSnapshots = D1 (MetaData "DescribeDBClusterSnapshots" "Network.AWS.RDS.DescribeDBClusterSnapshots" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "DescribeDBClusterSnapshots'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ddbcsDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ddbcsIncludeShared") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_ddbcsDBClusterSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ddbcsFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ddbcsSnapshotType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ddbcsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ddbcsMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_ddbcsIncludePublic") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))))))

type Rs DescribeDBClusterSnapshots

type Rs DescribeDBClusterSnapshots = DescribeDBClusterSnapshotsResponse

Request Lenses

ddbcsDBClusterIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text)

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with the DBClusterSnapshotIdentifier parameter. 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

ddbcsIncludeShared :: Lens' DescribeDBClusterSnapshots (Maybe Bool)

Set this value to true to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false . The default is false . You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.

ddbcsDBClusterSnapshotIdentifier :: Lens' DescribeDBClusterSnapshots (Maybe Text)

A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the DBClusterIdentifier parameter. 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 identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

ddbcsFilters :: Lens' DescribeDBClusterSnapshots [Filter]

This parameter is not currently supported.

ddbcsSnapshotType :: Lens' DescribeDBClusterSnapshots (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 AWS account. * manual - Return all DB cluster snapshots that have been taken by my AWS account. * shared - Return all manual DB cluster snapshots that have been shared to my AWS 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 .

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

ddbcsMaxRecords :: Lens' DescribeDBClusterSnapshots (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 that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.

ddbcsIncludePublic :: Lens' DescribeDBClusterSnapshots (Maybe Bool)

Set this value to true to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to 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.

Destructuring the Response

describeDBClusterSnapshotsResponse

Arguments

:: Int

ddbcsrsResponseStatus

-> DescribeDBClusterSnapshotsResponse

Creates a value of DescribeDBClusterSnapshotsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ddbcsrsMarker - 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 .
• ddbcsrsDBClusterSnapshots - Provides a list of DB cluster snapshots for the user.
• ddbcsrsResponseStatus - -- | The response status code.

data DescribeDBClusterSnapshotsResponse

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

See: describeDBClusterSnapshotsResponse smart constructor.

Instances

Eq DescribeDBClusterSnapshotsResponse

Methods

(==) :: DescribeDBClusterSnapshotsResponse -> DescribeDBClusterSnapshotsResponse -> Bool

(/=) :: DescribeDBClusterSnapshotsResponse -> DescribeDBClusterSnapshotsResponse -> Bool

Data DescribeDBClusterSnapshotsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeDBClusterSnapshotsResponse -> c DescribeDBClusterSnapshotsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeDBClusterSnapshotsResponse

toConstr :: DescribeDBClusterSnapshotsResponse -> Constr

dataTypeOf :: DescribeDBClusterSnapshotsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeDBClusterSnapshotsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeDBClusterSnapshotsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeDBClusterSnapshotsResponse -> DescribeDBClusterSnapshotsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDBClusterSnapshotsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDBClusterSnapshotsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeDBClusterSnapshotsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeDBClusterSnapshotsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeDBClusterSnapshotsResponse -> m DescribeDBClusterSnapshotsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDBClusterSnapshotsResponse -> m DescribeDBClusterSnapshotsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDBClusterSnapshotsResponse -> m DescribeDBClusterSnapshotsResponse

Read DescribeDBClusterSnapshotsResponse

Methods

readsPrec :: Int -> ReadS DescribeDBClusterSnapshotsResponse

readList :: ReadS [DescribeDBClusterSnapshotsResponse]

readPrec :: ReadPrec DescribeDBClusterSnapshotsResponse

readListPrec :: ReadPrec [DescribeDBClusterSnapshotsResponse]

Show DescribeDBClusterSnapshotsResponse

Methods

showsPrec :: Int -> DescribeDBClusterSnapshotsResponse -> ShowS

show :: DescribeDBClusterSnapshotsResponse -> String

showList :: [DescribeDBClusterSnapshotsResponse] -> ShowS

Generic DescribeDBClusterSnapshotsResponse

Associated Types

type Rep DescribeDBClusterSnapshotsResponse :: * -> *

Methods

from :: DescribeDBClusterSnapshotsResponse -> Rep DescribeDBClusterSnapshotsResponse x

to :: Rep DescribeDBClusterSnapshotsResponse x -> DescribeDBClusterSnapshotsResponse

NFData DescribeDBClusterSnapshotsResponse

Methods

rnf :: DescribeDBClusterSnapshotsResponse -> ()

type Rep DescribeDBClusterSnapshotsResponse

type Rep DescribeDBClusterSnapshotsResponse = D1 (MetaData "DescribeDBClusterSnapshotsResponse" "Network.AWS.RDS.DescribeDBClusterSnapshots" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "DescribeDBClusterSnapshotsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddbcsrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ddbcsrsDBClusterSnapshots") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DBClusterSnapshot]))) (S1 (MetaSel (Just Symbol "_ddbcsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

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

ddbcsrsDBClusterSnapshots :: Lens' DescribeDBClusterSnapshotsResponse [DBClusterSnapshot]

Provides a list of DB cluster snapshots for the user.

ddbcsrsResponseStatus :: Lens' DescribeDBClusterSnapshotsResponse Int

• - | The response status code.