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.CreatePipeline

Description

Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.

Synopsis

Creating a Request

data CreatePipeline Source #

Contains the parameters for CreatePipeline.

See: newCreatePipeline smart constructor.

Constructors

CreatePipeline' 

Fields

  • description :: Maybe Text

    The description for the pipeline.

  • tags :: Maybe [Tag]

    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.

  • name :: Text

    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.

  • uniqueId :: Text

    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.

Instances

Instances details
Eq CreatePipeline Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

Read CreatePipeline Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

Show CreatePipeline Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

Generic CreatePipeline Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

Associated Types

type Rep CreatePipeline :: Type -> Type #

NFData CreatePipeline Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

Methods

rnf :: CreatePipeline -> () #

Hashable CreatePipeline Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

ToJSON CreatePipeline Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

AWSRequest CreatePipeline Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

Associated Types

type AWSResponse CreatePipeline #

ToHeaders CreatePipeline Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

ToPath CreatePipeline Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

ToQuery CreatePipeline Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

type Rep CreatePipeline Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

type Rep CreatePipeline = D1 ('MetaData "CreatePipeline" "Amazonka.DataPipeline.CreatePipeline" "libZSservicesZSamazonka-datapipelineZSamazonka-datapipeline" 'False) (C1 ('MetaCons "CreatePipeline'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "uniqueId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreatePipeline Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

newCreatePipeline Source #

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.

Constructors

CreatePipelineResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • pipelineId :: Text

    The ID that AWS Data Pipeline assigns the newly created pipeline. For example, df-06372391ZG65EXAMPLE.

Instances

Instances details
Eq CreatePipelineResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

Read CreatePipelineResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

Show CreatePipelineResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

Generic CreatePipelineResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

Associated Types

type Rep CreatePipelineResponse :: Type -> Type #

NFData CreatePipelineResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

Methods

rnf :: CreatePipelineResponse -> () #

type Rep CreatePipelineResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.CreatePipeline

type Rep CreatePipelineResponse = D1 ('MetaData "CreatePipelineResponse" "Amazonka.DataPipeline.CreatePipeline" "libZSservicesZSamazonka-datapipelineZSamazonka-datapipeline" 'False) (C1 ('MetaCons "CreatePipelineResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "pipelineId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreatePipelineResponse Source #

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_pipelineId :: Lens' CreatePipelineResponse Text Source #

The ID that AWS Data Pipeline assigns the newly created pipeline. For example, df-06372391ZG65EXAMPLE.