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

Network.AWS.RDS.DescribeDBClusterSnapshots

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

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

Synopsis

Creating a Request

describeDBClusterSnapshots :: DescribeDBClusterSnapshots Source #

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:

data DescribeDBClusterSnapshots Source #

See: describeDBClusterSnapshots smart constructor.

Instances

Eq DescribeDBClusterSnapshots Source #
Methods (==) :: DescribeDBClusterSnapshots -> DescribeDBClusterSnapshots -> Bool # (/=) :: DescribeDBClusterSnapshots -> DescribeDBClusterSnapshots -> Bool #
Data DescribeDBClusterSnapshots Source #
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 Source #
Methods readsPrec :: Int -> ReadS DescribeDBClusterSnapshots # readList :: ReadS [DescribeDBClusterSnapshots] # readPrec :: ReadPrec DescribeDBClusterSnapshots # readListPrec :: ReadPrec [DescribeDBClusterSnapshots] #
Show DescribeDBClusterSnapshots Source #
Methods showsPrec :: Int -> DescribeDBClusterSnapshots -> ShowS # show :: DescribeDBClusterSnapshots -> String # showList :: [DescribeDBClusterSnapshots] -> ShowS #
Generic DescribeDBClusterSnapshots Source #
Associated Types type Rep DescribeDBClusterSnapshots :: * -> * # Methods from :: DescribeDBClusterSnapshots -> Rep DescribeDBClusterSnapshots x # to :: Rep DescribeDBClusterSnapshots x -> DescribeDBClusterSnapshots #
Hashable DescribeDBClusterSnapshots Source #
Methods hashWithSalt :: Int -> DescribeDBClusterSnapshots -> Int # hash :: DescribeDBClusterSnapshots -> Int #
NFData DescribeDBClusterSnapshots Source #
Methods rnf :: DescribeDBClusterSnapshots -> () #
AWSRequest DescribeDBClusterSnapshots Source #
Associated Types type Rs DescribeDBClusterSnapshots :: * # Methods request :: DescribeDBClusterSnapshots -> Request DescribeDBClusterSnapshots # response :: MonadResource m => Logger -> Service -> Proxy * DescribeDBClusterSnapshots -> ClientResponse -> m (Response DescribeDBClusterSnapshots) #
ToQuery DescribeDBClusterSnapshots Source #
Methods toQuery :: DescribeDBClusterSnapshots -> QueryString #
ToPath DescribeDBClusterSnapshots Source #
Methods toPath :: DescribeDBClusterSnapshots -> ByteString #
ToHeaders DescribeDBClusterSnapshots Source #
Methods toHeaders :: DescribeDBClusterSnapshots -> [Header] #
type Rep DescribeDBClusterSnapshots Source #
type Rep DescribeDBClusterSnapshots = D1 (MetaData "DescribeDBClusterSnapshots" "Network.AWS.RDS.DescribeDBClusterSnapshots" "amazonka-rds-1.4.3-4bcWghDPA7l4r93XQMzvZA" False) (C1 (MetaCons "DescribeDBClusterSnapshots'" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_ddbcsDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((::) (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)))))))
type Rs DescribeDBClusterSnapshots Source #
type Rs DescribeDBClusterSnapshots = DescribeDBClusterSnapshotsResponse

Request Lenses

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

A DB cluster identifier 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

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

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 is the identifier of an automated snapshot, the SnapshotType parameter must also be specified.

ddbcsFilters :: Lens' DescribeDBClusterSnapshots [Filter] Source #

This parameter is not currently supported.

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

The type of DB cluster snapshots that will be returned. Values can be automated or manual. If this parameter is not specified, the returned results will include all snapshot types.

ddbcsMarker :: 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.

ddbcsMaxRecords :: 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.

Destructuring the Response

describeDBClusterSnapshotsResponse Source #

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:

data DescribeDBClusterSnapshotsResponse Source #

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 Source #
Methods (==) :: DescribeDBClusterSnapshotsResponse -> DescribeDBClusterSnapshotsResponse -> Bool # (/=) :: DescribeDBClusterSnapshotsResponse -> DescribeDBClusterSnapshotsResponse -> Bool #
Data DescribeDBClusterSnapshotsResponse Source #
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 Source #
Methods readsPrec :: Int -> ReadS DescribeDBClusterSnapshotsResponse # readList :: ReadS [DescribeDBClusterSnapshotsResponse] # readPrec :: ReadPrec DescribeDBClusterSnapshotsResponse # readListPrec :: ReadPrec [DescribeDBClusterSnapshotsResponse] #
Show DescribeDBClusterSnapshotsResponse Source #
Methods showsPrec :: Int -> DescribeDBClusterSnapshotsResponse -> ShowS # show :: DescribeDBClusterSnapshotsResponse -> String # showList :: [DescribeDBClusterSnapshotsResponse] -> ShowS #
Generic DescribeDBClusterSnapshotsResponse Source #
Associated Types type Rep DescribeDBClusterSnapshotsResponse :: * -> * # Methods from :: DescribeDBClusterSnapshotsResponse -> Rep DescribeDBClusterSnapshotsResponse x # to :: Rep DescribeDBClusterSnapshotsResponse x -> DescribeDBClusterSnapshotsResponse #
NFData DescribeDBClusterSnapshotsResponse Source #
Methods rnf :: DescribeDBClusterSnapshotsResponse -> () #
type Rep DescribeDBClusterSnapshotsResponse Source #
type Rep DescribeDBClusterSnapshotsResponse = D1 (MetaData "DescribeDBClusterSnapshotsResponse" "Network.AWS.RDS.DescribeDBClusterSnapshots" "amazonka-rds-1.4.3-4bcWghDPA7l4r93XQMzvZA" 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 DecidedStrict) (Rec0 Int)))))

Response Lenses

ddbcsrsMarker :: 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.

ddbcsrsDBClusterSnapshots :: Lens' DescribeDBClusterSnapshotsResponse [DBClusterSnapshot] Source #

Provides a list of DB cluster snapshots for the user.

ddbcsrsResponseStatus :: Lens' DescribeDBClusterSnapshotsResponse Int Source #

The response status code.