amazonka-datapipeline-1.4.5: Amazon Data Pipeline SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.DataPipeline.DescribePipelines

Contents

Description

Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions.

To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition .

Synopsis

Creating a Request

describePipelines :: DescribePipelines #

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

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

  • dpPipelineIds - The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines .

data DescribePipelines #

Contains the parameters for DescribePipelines.

See: describePipelines smart constructor.

Instances

Eq DescribePipelines # 
Data DescribePipelines # 

Methods

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

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

toConstr :: DescribePipelines -> Constr #

dataTypeOf :: DescribePipelines -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribePipelines -> DescribePipelines #

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

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

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

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

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

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

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

Read DescribePipelines # 
Show DescribePipelines # 
Generic DescribePipelines # 
Hashable DescribePipelines # 
ToJSON DescribePipelines # 
NFData DescribePipelines # 

Methods

rnf :: DescribePipelines -> () #

AWSRequest DescribePipelines # 
ToQuery DescribePipelines # 
ToPath DescribePipelines # 
ToHeaders DescribePipelines # 
type Rep DescribePipelines # 
type Rep DescribePipelines = D1 (MetaData "DescribePipelines" "Network.AWS.DataPipeline.DescribePipelines" "amazonka-datapipeline-1.4.5-BJaoECYz4XDHL06I8wcb9o" True) (C1 (MetaCons "DescribePipelines'" PrefixI True) (S1 (MetaSel (Just Symbol "_dpPipelineIds") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))
type Rs DescribePipelines # 

Request Lenses

dpPipelineIds :: Lens' DescribePipelines [Text] #

The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines .

Destructuring the Response

describePipelinesResponse #

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

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

data DescribePipelinesResponse #

Contains the output of DescribePipelines.

See: describePipelinesResponse smart constructor.

Instances

Eq DescribePipelinesResponse # 
Data DescribePipelinesResponse # 

Methods

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

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

toConstr :: DescribePipelinesResponse -> Constr #

dataTypeOf :: DescribePipelinesResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribePipelinesResponse -> DescribePipelinesResponse #

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

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

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

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

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

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

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

Read DescribePipelinesResponse # 
Show DescribePipelinesResponse # 
Generic DescribePipelinesResponse # 
NFData DescribePipelinesResponse # 
type Rep DescribePipelinesResponse # 
type Rep DescribePipelinesResponse = D1 (MetaData "DescribePipelinesResponse" "Network.AWS.DataPipeline.DescribePipelines" "amazonka-datapipeline-1.4.5-BJaoECYz4XDHL06I8wcb9o" False) (C1 (MetaCons "DescribePipelinesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_dprsPipelineDescriptionList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [PipelineDescription]))))

Response Lenses

dprsResponseStatus :: Lens' DescribePipelinesResponse Int #

  • - | The response status code.

dprsPipelineDescriptionList :: Lens' DescribePipelinesResponse [PipelineDescription] #

An array of descriptions for the specified pipelines.