Network.AWS.DataPipeline.PutPipelineDefinition

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.

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

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

See: AWS API Reference for PutPipelineDefinition.

Creating a Request

putPipelineDefinition

Arguments

:: Text

ppdPipelineId

-> PutPipelineDefinition

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

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

• ppdParameterObjects
• ppdParameterValues
• ppdPipelineId
• ppdPipelineObjects

data PutPipelineDefinition

Contains the parameters for PutPipelineDefinition.

See: putPipelineDefinition smart constructor.

Instances

Eq PutPipelineDefinition

Data PutPipelineDefinition

Read PutPipelineDefinition

Show PutPipelineDefinition

Generic PutPipelineDefinition

ToJSON PutPipelineDefinition

AWSRequest PutPipelineDefinition

ToPath PutPipelineDefinition

ToHeaders PutPipelineDefinition

ToQuery PutPipelineDefinition

type Rep PutPipelineDefinition

type Rs PutPipelineDefinition = PutPipelineDefinitionResponse

Request Lenses

ppdParameterObjects :: Lens' PutPipelineDefinition [ParameterObject]

The parameter objects used with the pipeline.

ppdParameterValues :: Lens' PutPipelineDefinition [ParameterValue]

The parameter values used with the pipeline.

ppdPipelineId :: Lens' PutPipelineDefinition Text

The ID of the pipeline.

ppdPipelineObjects :: Lens' PutPipelineDefinition [PipelineObject]

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

Destructuring the Response

putPipelineDefinitionResponse

Arguments

:: Int

ppdrsResponseStatus

-> Bool

ppdrsErrored

-> PutPipelineDefinitionResponse

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

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

• ppdrsValidationErrors
• ppdrsValidationWarnings
• ppdrsResponseStatus
• ppdrsErrored

data PutPipelineDefinitionResponse

Contains the output of PutPipelineDefinition.

See: putPipelineDefinitionResponse smart constructor.

Instances

Eq PutPipelineDefinitionResponse

Data PutPipelineDefinitionResponse

Read PutPipelineDefinitionResponse

Show PutPipelineDefinitionResponse

Generic PutPipelineDefinitionResponse

type Rep PutPipelineDefinitionResponse

Response Lenses

ppdrsValidationErrors :: Lens' PutPipelineDefinitionResponse [ValidationError]

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

ppdrsValidationWarnings :: Lens' PutPipelineDefinitionResponse [ValidationWarning]

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

ppdrsResponseStatus :: Lens' PutPipelineDefinitionResponse Int

The response status code.

ppdrsErrored :: Lens' PutPipelineDefinitionResponse 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.