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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline.

PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.

An object is missing a name or identifier field.
A string or reference field is empty.
The number of objects in the pipeline exceeds the maximum allowed objects.
The pipeline is in a FINISHED state.

Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.

Synopsis

Creating a Request

data PutPipelineDefinition Source #

Contains the parameters for PutPipelineDefinition.

See: newPutPipelineDefinition smart constructor.

Constructors

PutPipelineDefinition'
Fields parameterObjects :: Maybe [ParameterObject] The parameter objects used with the pipeline. parameterValues :: Maybe [ParameterValue] The parameter values used with the pipeline. pipelineId :: Text The ID of the pipeline. pipelineObjects :: [PipelineObject] The objects that define the pipeline. These objects overwrite the existing pipeline definition.

Instances

Instances details

Eq PutPipelineDefinition Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition Methods (==) :: PutPipelineDefinition -> PutPipelineDefinition -> Bool # (/=) :: PutPipelineDefinition -> PutPipelineDefinition -> Bool #
Read PutPipelineDefinition Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition Methods readsPrec :: Int -> ReadS PutPipelineDefinition # readList :: ReadS [PutPipelineDefinition] # readPrec :: ReadPrec PutPipelineDefinition # readListPrec :: ReadPrec [PutPipelineDefinition] #
Show PutPipelineDefinition Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition Methods showsPrec :: Int -> PutPipelineDefinition -> ShowS # show :: PutPipelineDefinition -> String # showList :: [PutPipelineDefinition] -> ShowS #
Generic PutPipelineDefinition Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition Associated Types type Rep PutPipelineDefinition :: Type -> Type # Methods from :: PutPipelineDefinition -> Rep PutPipelineDefinition x # to :: Rep PutPipelineDefinition x -> PutPipelineDefinition #
NFData PutPipelineDefinition Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition Methods rnf :: PutPipelineDefinition -> () #
Hashable PutPipelineDefinition Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition Methods hashWithSalt :: Int -> PutPipelineDefinition -> Int # hash :: PutPipelineDefinition -> Int #
ToJSON PutPipelineDefinition Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition Methods toJSON :: PutPipelineDefinition -> Value # toEncoding :: PutPipelineDefinition -> Encoding # toJSONList :: [PutPipelineDefinition] -> Value # toEncodingList :: [PutPipelineDefinition] -> Encoding #
AWSRequest PutPipelineDefinition Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition Associated Types type AWSResponse PutPipelineDefinition # Methods request :: PutPipelineDefinition -> Request PutPipelineDefinition # response :: MonadResource m => Logger -> Service -> Proxy PutPipelineDefinition -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutPipelineDefinition))) #
ToHeaders PutPipelineDefinition Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition Methods toHeaders :: PutPipelineDefinition -> [Header] #
ToPath PutPipelineDefinition Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition Methods toPath :: PutPipelineDefinition -> ByteString #
ToQuery PutPipelineDefinition Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition Methods toQuery :: PutPipelineDefinition -> QueryString #
type Rep PutPipelineDefinition Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition type Rep PutPipelineDefinition = D1 ('MetaData "PutPipelineDefinition" "Amazonka.DataPipeline.PutPipelineDefinition" "libZSservicesZSamazonka-datapipelineZSamazonka-datapipeline" 'False) (C1 ('MetaCons "PutPipelineDefinition'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "parameterObjects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ParameterObject])) :: S1 ('MetaSel ('Just "parameterValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ParameterValue]))) :: (S1 ('MetaSel ('Just "pipelineId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "pipelineObjects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [PipelineObject]))))
type AWSResponse PutPipelineDefinition Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition type AWSResponse PutPipelineDefinition = PutPipelineDefinitionResponse

newPutPipelineDefinition Source #

Arguments

:: Text	`$sel:pipelineId:PutPipelineDefinition'`
-> PutPipelineDefinition

Create a value of PutPipelineDefinition 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:parameterObjects:PutPipelineDefinition', putPipelineDefinition_parameterObjects - The parameter objects used with the pipeline.

$sel:parameterValues:PutPipelineDefinition', putPipelineDefinition_parameterValues - The parameter values used with the pipeline.

$sel:pipelineId:PutPipelineDefinition', putPipelineDefinition_pipelineId - The ID of the pipeline.

$sel:pipelineObjects:PutPipelineDefinition', putPipelineDefinition_pipelineObjects - The objects that define the pipeline. These objects overwrite the existing pipeline definition.

Request Lenses

putPipelineDefinition_parameterObjects :: Lens' PutPipelineDefinition (Maybe [ParameterObject]) Source #

The parameter objects used with the pipeline.

putPipelineDefinition_parameterValues :: Lens' PutPipelineDefinition (Maybe [ParameterValue]) Source #

The parameter values used with the pipeline.

putPipelineDefinition_pipelineId :: Lens' PutPipelineDefinition Text Source #

The ID of the pipeline.

putPipelineDefinition_pipelineObjects :: Lens' PutPipelineDefinition [PipelineObject] Source #

The objects that define the pipeline. These objects overwrite the existing pipeline definition.

Destructuring the Response

data PutPipelineDefinitionResponse Source #

Contains the output of PutPipelineDefinition.

See: newPutPipelineDefinitionResponse smart constructor.

Constructors

PutPipelineDefinitionResponse'

Fields

validationErrors :: Maybe [ValidationError]
The validation errors that are associated with the objects defined in pipelineObjects.
validationWarnings :: Maybe [ValidationWarning]
The validation warnings that are associated with the objects defined in pipelineObjects.
httpStatus :: Int
The response's http status code.
errored :: Bool
Indicates whether there were validation errors, and the pipeline definition is stored but cannot be activated until you correct the pipeline and call PutPipelineDefinition to commit the corrected pipeline.

Instances

Instances details

Eq PutPipelineDefinitionResponse Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition Methods (==) :: PutPipelineDefinitionResponse -> PutPipelineDefinitionResponse -> Bool # (/=) :: PutPipelineDefinitionResponse -> PutPipelineDefinitionResponse -> Bool #
Read PutPipelineDefinitionResponse Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition Methods readsPrec :: Int -> ReadS PutPipelineDefinitionResponse # readList :: ReadS [PutPipelineDefinitionResponse] # readPrec :: ReadPrec PutPipelineDefinitionResponse # readListPrec :: ReadPrec [PutPipelineDefinitionResponse] #
Show PutPipelineDefinitionResponse Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition Methods showsPrec :: Int -> PutPipelineDefinitionResponse -> ShowS # show :: PutPipelineDefinitionResponse -> String # showList :: [PutPipelineDefinitionResponse] -> ShowS #
Generic PutPipelineDefinitionResponse Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition Associated Types type Rep PutPipelineDefinitionResponse :: Type -> Type # Methods from :: PutPipelineDefinitionResponse -> Rep PutPipelineDefinitionResponse x # to :: Rep PutPipelineDefinitionResponse x -> PutPipelineDefinitionResponse #
NFData PutPipelineDefinitionResponse Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition Methods rnf :: PutPipelineDefinitionResponse -> () #
type Rep PutPipelineDefinitionResponse Source #
Instance details Defined in Amazonka.DataPipeline.PutPipelineDefinition type Rep PutPipelineDefinitionResponse = D1 ('MetaData "PutPipelineDefinitionResponse" "Amazonka.DataPipeline.PutPipelineDefinition" "libZSservicesZSamazonka-datapipelineZSamazonka-datapipeline" 'False) (C1 ('MetaCons "PutPipelineDefinitionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "validationErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ValidationError])) :: S1 ('MetaSel ('Just "validationWarnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ValidationWarning]))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "errored") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

newPutPipelineDefinitionResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutPipelineDefinitionResponse'`
-> Bool	`$sel:errored:PutPipelineDefinitionResponse'`
-> PutPipelineDefinitionResponse

Create a value of PutPipelineDefinitionResponse 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:validationErrors:PutPipelineDefinitionResponse', putPipelineDefinitionResponse_validationErrors - The validation errors that are associated with the objects defined in pipelineObjects.

$sel:validationWarnings:PutPipelineDefinitionResponse', putPipelineDefinitionResponse_validationWarnings - The validation warnings that are associated with the objects defined in pipelineObjects.

$sel:httpStatus:PutPipelineDefinitionResponse', putPipelineDefinitionResponse_httpStatus - The response's http status code.

$sel:errored:PutPipelineDefinitionResponse', putPipelineDefinitionResponse_errored - Indicates whether there were validation errors, and the pipeline definition is stored but cannot be activated until you correct the pipeline and call PutPipelineDefinition to commit the corrected pipeline.

Response Lenses

putPipelineDefinitionResponse_validationErrors :: Lens' PutPipelineDefinitionResponse (Maybe [ValidationError]) Source #

The validation errors that are associated with the objects defined in pipelineObjects.

putPipelineDefinitionResponse_validationWarnings :: Lens' PutPipelineDefinitionResponse (Maybe [ValidationWarning]) Source #

The validation warnings that are associated with the objects defined in pipelineObjects.

putPipelineDefinitionResponse_httpStatus :: Lens' PutPipelineDefinitionResponse Int Source #

The response's http status code.

putPipelineDefinitionResponse_errored :: Lens' PutPipelineDefinitionResponse Bool Source #

Indicates whether there were validation errors, and the pipeline definition is stored but cannot be activated until you correct the pipeline and call PutPipelineDefinition to commit the corrected pipeline.