Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.RDS.DescribeDBClusters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about provisioned Aurora DB clusters. This API supports pagination.

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

Creating a Request

describeDBClusters :: DescribeDBClusters #

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

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

ddcDBClusterIdentifier - The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: * If supplied, must match an existing DBClusterIdentifier.
ddcFilters - A filter that specifies one or more DB clusters to describe. Supported filters: * db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.
ddcMarker - An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
ddcMaxRecords - 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.

data DescribeDBClusters #

See: describeDBClusters smart constructor.

Instances

Eq DescribeDBClusters #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Methods (==) :: DescribeDBClusters -> DescribeDBClusters -> Bool # (/=) :: DescribeDBClusters -> DescribeDBClusters -> Bool #
Data DescribeDBClusters #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeDBClusters -> c DescribeDBClusters # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeDBClusters # toConstr :: DescribeDBClusters -> Constr # dataTypeOf :: DescribeDBClusters -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeDBClusters) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeDBClusters) # gmapT :: (forall b. Data b => b -> b) -> DescribeDBClusters -> DescribeDBClusters # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDBClusters -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDBClusters -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeDBClusters -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeDBClusters -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeDBClusters -> m DescribeDBClusters # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDBClusters -> m DescribeDBClusters # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDBClusters -> m DescribeDBClusters #
Read DescribeDBClusters #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Methods readsPrec :: Int -> ReadS DescribeDBClusters # readList :: ReadS [DescribeDBClusters] # readPrec :: ReadPrec DescribeDBClusters # readListPrec :: ReadPrec [DescribeDBClusters] #
Show DescribeDBClusters #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Methods showsPrec :: Int -> DescribeDBClusters -> ShowS # show :: DescribeDBClusters -> String # showList :: [DescribeDBClusters] -> ShowS #
Generic DescribeDBClusters #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Associated Types type Rep DescribeDBClusters :: * -> * # Methods from :: DescribeDBClusters -> Rep DescribeDBClusters x # to :: Rep DescribeDBClusters x -> DescribeDBClusters #
Hashable DescribeDBClusters #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Methods hashWithSalt :: Int -> DescribeDBClusters -> Int # hash :: DescribeDBClusters -> Int #
AWSRequest DescribeDBClusters #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Associated Types type Rs DescribeDBClusters :: * # Methods request :: DescribeDBClusters -> Request DescribeDBClusters # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeDBClusters -> ClientResponse -> m (Response DescribeDBClusters) #
ToHeaders DescribeDBClusters #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Methods toHeaders :: DescribeDBClusters -> [Header] #
ToPath DescribeDBClusters #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Methods toPath :: DescribeDBClusters -> ByteString #
ToQuery DescribeDBClusters #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Methods toQuery :: DescribeDBClusters -> QueryString #
NFData DescribeDBClusters #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Methods rnf :: DescribeDBClusters -> () #
type Rep DescribeDBClusters #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters type Rep DescribeDBClusters = D1 (MetaData "DescribeDBClusters" "Network.AWS.RDS.DescribeDBClusters" "amazonka-rds-1.6.0-62mw5vrBA3M4x0SZvkmRx5" False) (C1 (MetaCons "DescribeDBClusters'" PrefixI True) ((S1 (MetaSel (Just "_ddcDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ddcFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 (MetaSel (Just "_ddcMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ddcMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))))
type Rs DescribeDBClusters #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters type Rs DescribeDBClusters = DescribeDBClustersResponse

Request Lenses

ddcDBClusterIdentifier :: Lens' DescribeDBClusters (Maybe Text) #

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: * If supplied, must match an existing DBClusterIdentifier.

ddcFilters :: Lens' DescribeDBClusters [Filter] #

A filter that specifies one or more DB clusters to describe. Supported filters: * db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

ddcMarker :: Lens' DescribeDBClusters (Maybe Text) #

An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

ddcMaxRecords :: Lens' DescribeDBClusters (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.

Destructuring the Response

describeDBClustersResponse #

Arguments

:: Int	`ddcrsResponseStatus`
-> DescribeDBClustersResponse

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

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

ddcrsDBClusters - Contains a list of DB clusters for the user.
ddcrsMarker - A pagination token that can be used in a subsequent DescribeDBClusters request.
ddcrsResponseStatus - -- | The response status code.

data DescribeDBClustersResponse #

Contains the result of a successful invocation of the DescribeDBClusters action.

See: describeDBClustersResponse smart constructor.

Instances

Eq DescribeDBClustersResponse #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Methods (==) :: DescribeDBClustersResponse -> DescribeDBClustersResponse -> Bool # (/=) :: DescribeDBClustersResponse -> DescribeDBClustersResponse -> Bool #
Data DescribeDBClustersResponse #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeDBClustersResponse -> c DescribeDBClustersResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeDBClustersResponse # toConstr :: DescribeDBClustersResponse -> Constr # dataTypeOf :: DescribeDBClustersResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeDBClustersResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeDBClustersResponse) # gmapT :: (forall b. Data b => b -> b) -> DescribeDBClustersResponse -> DescribeDBClustersResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDBClustersResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDBClustersResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeDBClustersResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeDBClustersResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeDBClustersResponse -> m DescribeDBClustersResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDBClustersResponse -> m DescribeDBClustersResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDBClustersResponse -> m DescribeDBClustersResponse #
Read DescribeDBClustersResponse #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Methods readsPrec :: Int -> ReadS DescribeDBClustersResponse # readList :: ReadS [DescribeDBClustersResponse] # readPrec :: ReadPrec DescribeDBClustersResponse # readListPrec :: ReadPrec [DescribeDBClustersResponse] #
Show DescribeDBClustersResponse #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Methods showsPrec :: Int -> DescribeDBClustersResponse -> ShowS # show :: DescribeDBClustersResponse -> String # showList :: [DescribeDBClustersResponse] -> ShowS #
Generic DescribeDBClustersResponse #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Associated Types type Rep DescribeDBClustersResponse :: * -> * # Methods from :: DescribeDBClustersResponse -> Rep DescribeDBClustersResponse x # to :: Rep DescribeDBClustersResponse x -> DescribeDBClustersResponse #
NFData DescribeDBClustersResponse #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters Methods rnf :: DescribeDBClustersResponse -> () #
type Rep DescribeDBClustersResponse #
Instance details Defined in Network.AWS.RDS.DescribeDBClusters type Rep DescribeDBClustersResponse = D1 (MetaData "DescribeDBClustersResponse" "Network.AWS.RDS.DescribeDBClusters" "amazonka-rds-1.6.0-62mw5vrBA3M4x0SZvkmRx5" False) (C1 (MetaCons "DescribeDBClustersResponse'" PrefixI True) (S1 (MetaSel (Just "_ddcrsDBClusters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DBCluster])) :: (S1 (MetaSel (Just "_ddcrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ddcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

ddcrsDBClusters :: Lens' DescribeDBClustersResponse [DBCluster] #

Contains a list of DB clusters for the user.

ddcrsMarker :: Lens' DescribeDBClustersResponse (Maybe Text) #

A pagination token that can be used in a subsequent DescribeDBClusters request.

ddcrsResponseStatus :: Lens' DescribeDBClustersResponse Int #

- | The response status code.