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

Amazonka.DataPipeline.DescribePipelines

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

data DescribePipelines Source #

Contains the parameters for DescribePipelines.

See: newDescribePipelines smart constructor.

Constructors

DescribePipelines' 

Fields

  • pipelineIds :: [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.

Instances

Instances details
Eq DescribePipelines Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

Read DescribePipelines Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

Show DescribePipelines Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

Generic DescribePipelines Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

Associated Types

type Rep DescribePipelines :: Type -> Type #

NFData DescribePipelines Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

Methods

rnf :: DescribePipelines -> () #

Hashable DescribePipelines Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

ToJSON DescribePipelines Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

AWSRequest DescribePipelines Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

Associated Types

type AWSResponse DescribePipelines #

ToHeaders DescribePipelines Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

ToPath DescribePipelines Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

ToQuery DescribePipelines Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

type Rep DescribePipelines Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

type Rep DescribePipelines = D1 ('MetaData "DescribePipelines" "Amazonka.DataPipeline.DescribePipelines" "libZSservicesZSamazonka-datapipelineZSamazonka-datapipeline" 'False) (C1 ('MetaCons "DescribePipelines'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipelineIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))
type AWSResponse DescribePipelines Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

newDescribePipelines :: DescribePipelines Source #

Create a value of DescribePipelines with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:pipelineIds:DescribePipelines', describePipelines_pipelineIds - 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.

Request Lenses

describePipelines_pipelineIds :: Lens' DescribePipelines [Text] Source #

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

data DescribePipelinesResponse Source #

Contains the output of DescribePipelines.

See: newDescribePipelinesResponse smart constructor.

Constructors

DescribePipelinesResponse' 

Fields

Instances

Instances details
Eq DescribePipelinesResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

Read DescribePipelinesResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

Show DescribePipelinesResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

Generic DescribePipelinesResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

Associated Types

type Rep DescribePipelinesResponse :: Type -> Type #

NFData DescribePipelinesResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

type Rep DescribePipelinesResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.DescribePipelines

type Rep DescribePipelinesResponse = D1 ('MetaData "DescribePipelinesResponse" "Amazonka.DataPipeline.DescribePipelines" "libZSservicesZSamazonka-datapipelineZSamazonka-datapipeline" 'False) (C1 ('MetaCons "DescribePipelinesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "pipelineDescriptionList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [PipelineDescription])))

newDescribePipelinesResponse Source #

Create a value of DescribePipelinesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribePipelinesResponse', describePipelinesResponse_httpStatus - The response's http status code.

$sel:pipelineDescriptionList:DescribePipelinesResponse', describePipelinesResponse_pipelineDescriptionList - An array of descriptions for the specified pipelines.

Response Lenses