| Copyright | (c) 2013-2021 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 |
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
- data DescribePipelines = DescribePipelines' {
- pipelineIds :: [Text]
- newDescribePipelines :: DescribePipelines
- describePipelines_pipelineIds :: Lens' DescribePipelines [Text]
- data DescribePipelinesResponse = DescribePipelinesResponse' {}
- newDescribePipelinesResponse :: Int -> DescribePipelinesResponse
- describePipelinesResponse_httpStatus :: Lens' DescribePipelinesResponse Int
- describePipelinesResponse_pipelineDescriptionList :: Lens' DescribePipelinesResponse [PipelineDescription]
Creating a Request
data DescribePipelines Source #
Contains the parameters for DescribePipelines.
See: newDescribePipelines smart constructor.
Constructors
| DescribePipelines' | |
Fields
| |
Instances
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
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
describePipelinesResponse_httpStatus :: Lens' DescribePipelinesResponse Int Source #
The response's http status code.
describePipelinesResponse_pipelineDescriptionList :: Lens' DescribePipelinesResponse [PipelineDescription] Source #
An array of descriptions for the specified pipelines.