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 |
Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
Synopsis
- data CreatePipeline = CreatePipeline' {}
- newCreatePipeline :: Text -> Text -> CreatePipeline
- createPipeline_description :: Lens' CreatePipeline (Maybe Text)
- createPipeline_tags :: Lens' CreatePipeline (Maybe [Tag])
- createPipeline_name :: Lens' CreatePipeline Text
- createPipeline_uniqueId :: Lens' CreatePipeline Text
- data CreatePipelineResponse = CreatePipelineResponse' {
- httpStatus :: Int
- pipelineId :: Text
- newCreatePipelineResponse :: Int -> Text -> CreatePipelineResponse
- createPipelineResponse_httpStatus :: Lens' CreatePipelineResponse Int
- createPipelineResponse_pipelineId :: Lens' CreatePipelineResponse Text
Creating a Request
data CreatePipeline Source #
Contains the parameters for CreatePipeline.
See: newCreatePipeline
smart constructor.
CreatePipeline' | |
|
Instances
Create a value of CreatePipeline
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:description:CreatePipeline'
, createPipeline_description
- The description for the pipeline.
$sel:tags:CreatePipeline'
, createPipeline_tags
- A list of tags to associate with the pipeline at creation. Tags let you
control access to pipelines. For more information, see
Controlling User Access to Pipelines
in the AWS Data Pipeline Developer Guide.
$sel:name:CreatePipeline'
, createPipeline_name
- The name for the pipeline. You can use the same name for multiple
pipelines associated with your AWS account, because AWS Data Pipeline
assigns each pipeline a unique pipeline identifier.
$sel:uniqueId:CreatePipeline'
, createPipeline_uniqueId
- A unique identifier. This identifier is not the same as the pipeline
identifier assigned by AWS Data Pipeline. You are responsible for
defining the format and ensuring the uniqueness of this identifier. You
use this parameter to ensure idempotency during repeated calls to
CreatePipeline
. For example, if the first call to CreatePipeline
does not succeed, you can pass in the same unique identifier and
pipeline name combination on a subsequent call to CreatePipeline
.
CreatePipeline
ensures that if a pipeline already exists with the same
name and unique identifier, a new pipeline is not created. Instead,
you'll receive the pipeline identifier from the previous attempt. The
uniqueness of the name and unique identifier combination is scoped to
the AWS account or IAM user credentials.
Request Lenses
createPipeline_description :: Lens' CreatePipeline (Maybe Text) Source #
The description for the pipeline.
createPipeline_tags :: Lens' CreatePipeline (Maybe [Tag]) Source #
A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
createPipeline_name :: Lens' CreatePipeline Text Source #
The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.
createPipeline_uniqueId :: Lens' CreatePipeline Text Source #
A unique identifier. This identifier is not the same as the pipeline
identifier assigned by AWS Data Pipeline. You are responsible for
defining the format and ensuring the uniqueness of this identifier. You
use this parameter to ensure idempotency during repeated calls to
CreatePipeline
. For example, if the first call to CreatePipeline
does not succeed, you can pass in the same unique identifier and
pipeline name combination on a subsequent call to CreatePipeline
.
CreatePipeline
ensures that if a pipeline already exists with the same
name and unique identifier, a new pipeline is not created. Instead,
you'll receive the pipeline identifier from the previous attempt. The
uniqueness of the name and unique identifier combination is scoped to
the AWS account or IAM user credentials.
Destructuring the Response
data CreatePipelineResponse Source #
Contains the output of CreatePipeline.
See: newCreatePipelineResponse
smart constructor.
CreatePipelineResponse' | |
|
Instances
newCreatePipelineResponse Source #
:: Int | |
-> Text | |
-> CreatePipelineResponse |
Create a value of CreatePipelineResponse
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:CreatePipelineResponse'
, createPipelineResponse_httpStatus
- The response's http status code.
$sel:pipelineId:CreatePipelineResponse'
, createPipelineResponse_pipelineId
- The ID that AWS Data Pipeline assigns the newly created pipeline. For
example, df-06372391ZG65EXAMPLE
.
Response Lenses
createPipelineResponse_httpStatus :: Lens' CreatePipelineResponse Int Source #
The response's http status code.
createPipelineResponse_pipelineId :: Lens' CreatePipelineResponse Text Source #
The ID that AWS Data Pipeline assigns the newly created pipeline. For
example, df-06372391ZG65EXAMPLE
.