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.DataPipeline.DescribePipelines

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines Methods (==) :: DescribePipelines -> DescribePipelines -> Bool # (/=) :: DescribePipelines -> DescribePipelines -> Bool #
Data DescribePipelines #
Instance details Defined in Network.AWS.DataPipeline.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 #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines Methods readsPrec :: Int -> ReadS DescribePipelines # readList :: ReadS [DescribePipelines] # readPrec :: ReadPrec DescribePipelines # readListPrec :: ReadPrec [DescribePipelines] #
Show DescribePipelines #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines Methods showsPrec :: Int -> DescribePipelines -> ShowS # show :: DescribePipelines -> String # showList :: [DescribePipelines] -> ShowS #
Generic DescribePipelines #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines Associated Types type Rep DescribePipelines :: Type -> Type # Methods from :: DescribePipelines -> Rep DescribePipelines x # to :: Rep DescribePipelines x -> DescribePipelines #
Hashable DescribePipelines #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines Methods hashWithSalt :: Int -> DescribePipelines -> Int # hash :: DescribePipelines -> Int #
ToJSON DescribePipelines #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines Methods toJSON :: DescribePipelines -> Value # toEncoding :: DescribePipelines -> Encoding # toJSONList :: [DescribePipelines] -> Value # toEncodingList :: [DescribePipelines] -> Encoding #
AWSRequest DescribePipelines #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines Associated Types type Rs DescribePipelines :: Type # Methods request :: DescribePipelines -> Request DescribePipelines # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribePipelines -> ClientResponse -> m (Response DescribePipelines) #
ToHeaders DescribePipelines #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines Methods toHeaders :: DescribePipelines -> [Header] #
ToPath DescribePipelines #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines Methods toPath :: DescribePipelines -> ByteString #
ToQuery DescribePipelines #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines Methods toQuery :: DescribePipelines -> QueryString #
NFData DescribePipelines #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines Methods rnf :: DescribePipelines -> () #
type Rep DescribePipelines #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines type Rep DescribePipelines = D1 (MetaData "DescribePipelines" "Network.AWS.DataPipeline.DescribePipelines" "amazonka-datapipeline-1.6.1-4OlZZr9txnv4YAc3mX4olh" True) (C1 (MetaCons "DescribePipelines'" PrefixI True) (S1 (MetaSel (Just "_dpPipelineIds") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))
type Rs DescribePipelines #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines type Rs DescribePipelines = DescribePipelinesResponse

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 #

Arguments

:: Int	`dprsResponseStatus`
-> 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:

dprsResponseStatus - -- | The response status code.
dprsPipelineDescriptionList - An array of descriptions for the specified pipelines.

data DescribePipelinesResponse #

Contains the output of DescribePipelines.

See: describePipelinesResponse smart constructor.

Instances

Eq DescribePipelinesResponse #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines Methods (==) :: DescribePipelinesResponse -> DescribePipelinesResponse -> Bool # (/=) :: DescribePipelinesResponse -> DescribePipelinesResponse -> Bool #
Data DescribePipelinesResponse #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines 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 #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines Methods readsPrec :: Int -> ReadS DescribePipelinesResponse # readList :: ReadS [DescribePipelinesResponse] # readPrec :: ReadPrec DescribePipelinesResponse # readListPrec :: ReadPrec [DescribePipelinesResponse] #
Show DescribePipelinesResponse #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines Methods showsPrec :: Int -> DescribePipelinesResponse -> ShowS # show :: DescribePipelinesResponse -> String # showList :: [DescribePipelinesResponse] -> ShowS #
Generic DescribePipelinesResponse #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines Associated Types type Rep DescribePipelinesResponse :: Type -> Type # Methods from :: DescribePipelinesResponse -> Rep DescribePipelinesResponse x # to :: Rep DescribePipelinesResponse x -> DescribePipelinesResponse #
NFData DescribePipelinesResponse #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines Methods rnf :: DescribePipelinesResponse -> () #
type Rep DescribePipelinesResponse #
Instance details Defined in Network.AWS.DataPipeline.DescribePipelines type Rep DescribePipelinesResponse = D1 (MetaData "DescribePipelinesResponse" "Network.AWS.DataPipeline.DescribePipelines" "amazonka-datapipeline-1.6.1-4OlZZr9txnv4YAc3mX4olh" False) (C1 (MetaCons "DescribePipelinesResponse'" PrefixI True) (S1 (MetaSel (Just "_dprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_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.