amazonka-datapipeline-1.6.1: Amazon Data Pipeline SDK.

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

Network.AWS.DataPipeline.CreatePipeline

Contents

Description

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

Synopsis

Creating a Request

createPipeline #

Creates a value of CreatePipeline with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cpDescription - The description for the pipeline.
  • cpTags - 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 .
  • cpName - 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.
  • cpUniqueId - 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.

data CreatePipeline #

Contains the parameters for CreatePipeline.

See: createPipeline smart constructor.

Instances
Eq CreatePipeline # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

Data CreatePipeline # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreatePipeline -> c CreatePipeline #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreatePipeline #

toConstr :: CreatePipeline -> Constr #

dataTypeOf :: CreatePipeline -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreatePipeline) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreatePipeline) #

gmapT :: (forall b. Data b => b -> b) -> CreatePipeline -> CreatePipeline #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreatePipeline -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreatePipeline -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreatePipeline -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreatePipeline -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreatePipeline -> m CreatePipeline #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreatePipeline -> m CreatePipeline #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreatePipeline -> m CreatePipeline #

Read CreatePipeline # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

Show CreatePipeline # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

Generic CreatePipeline # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

Associated Types

type Rep CreatePipeline :: Type -> Type #

Hashable CreatePipeline # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

ToJSON CreatePipeline # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

AWSRequest CreatePipeline # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

Associated Types

type Rs CreatePipeline :: Type #

ToHeaders CreatePipeline # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

ToPath CreatePipeline # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

ToQuery CreatePipeline # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

NFData CreatePipeline # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

Methods

rnf :: CreatePipeline -> () #

type Rep CreatePipeline # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

type Rep CreatePipeline = D1 (MetaData "CreatePipeline" "Network.AWS.DataPipeline.CreatePipeline" "amazonka-datapipeline-1.6.1-4OlZZr9txnv4YAc3mX4olh" False) (C1 (MetaCons "CreatePipeline'" PrefixI True) ((S1 (MetaSel (Just "_cpDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cpTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 (MetaSel (Just "_cpName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cpUniqueId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs CreatePipeline # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

Request Lenses

cpDescription :: Lens' CreatePipeline (Maybe Text) #

The description for the pipeline.

cpTags :: Lens' CreatePipeline [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 .

cpName :: Lens' CreatePipeline 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.

cpUniqueId :: Lens' CreatePipeline 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.

Destructuring the Response

createPipelineResponse #

Creates a value of CreatePipelineResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cprsResponseStatus - -- | The response status code.
  • cprsPipelineId - The ID that AWS Data Pipeline assigns the newly created pipeline. For example, df-06372391ZG65EXAMPLE .

data CreatePipelineResponse #

Contains the output of CreatePipeline.

See: createPipelineResponse smart constructor.

Instances
Eq CreatePipelineResponse # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

Data CreatePipelineResponse # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreatePipelineResponse -> c CreatePipelineResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreatePipelineResponse #

toConstr :: CreatePipelineResponse -> Constr #

dataTypeOf :: CreatePipelineResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreatePipelineResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreatePipelineResponse) #

gmapT :: (forall b. Data b => b -> b) -> CreatePipelineResponse -> CreatePipelineResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreatePipelineResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreatePipelineResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreatePipelineResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreatePipelineResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreatePipelineResponse -> m CreatePipelineResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreatePipelineResponse -> m CreatePipelineResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreatePipelineResponse -> m CreatePipelineResponse #

Read CreatePipelineResponse # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

Show CreatePipelineResponse # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

Generic CreatePipelineResponse # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

Associated Types

type Rep CreatePipelineResponse :: Type -> Type #

NFData CreatePipelineResponse # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

Methods

rnf :: CreatePipelineResponse -> () #

type Rep CreatePipelineResponse # 
Instance details

Defined in Network.AWS.DataPipeline.CreatePipeline

type Rep CreatePipelineResponse = D1 (MetaData "CreatePipelineResponse" "Network.AWS.DataPipeline.CreatePipeline" "amazonka-datapipeline-1.6.1-4OlZZr9txnv4YAc3mX4olh" False) (C1 (MetaCons "CreatePipelineResponse'" PrefixI True) (S1 (MetaSel (Just "_cprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_cprsPipelineId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

Response Lenses

cprsResponseStatus :: Lens' CreatePipelineResponse Int #

  • - | The response status code.

cprsPipelineId :: Lens' CreatePipelineResponse Text #

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