[ aws . datapipeline ]

put-pipeline-definition

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-pipeline-definition
--pipeline-id <value>
[--parameter-objects <value>]
[--parameter-values <value>]
--pipeline-definition <value>
[--parameter-values-uri <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--pipeline-id (string)

The ID of the pipeline.

--parameter-objects (string) The JSON parameter objects. If the parameter objects are in a file you can use the file://syntax to specify a filename. You can optionally provide these in pipeline definition as well. Parameter objects provided on command line would replace the one in definition.

--parameter-values (string) The JSON parameter values. You can specify these as key-value pairs in the key=value format. Multiple parameters are separated by a space. For list type parameter values you can use the same key name and specify each value as a key value pair. e.g. arrayValue=value1 arrayValue=value2

--pipeline-definition (string) The JSON pipeline definition. If the pipeline definition is in a file you can use the file://syntax to specify a filename.

--parameter-values-uri (string) The JSON parameter values. If the parameter values are in a file you can use the file://syntax to specify a filename. You can optionally provide these in pipeline definition as well. Parameter values provided on command line would replace the one in definition.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To upload a pipeline definition

This example uploads the specified pipeline definition to the specified pipeline:

aws datapipeline put-pipeline-definition --pipeline-id df-00627471SOVYZEXAMPLE --pipeline-definition file://my-pipeline-definition.json

The following is example output:

{
  "validationErrors": [],
  "errored": false,
  "validationWarnings": []
}

Output

validationErrors -> (list)

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

(structure)

Defines a validation error. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.

id -> (string)

The identifier of the object that contains the validation error.

errors -> (list)

A description of the validation error.

(string)

validationWarnings -> (list)

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

(structure)

Defines a validation warning. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.

id -> (string)

The identifier of the object that contains the validation warning.

warnings -> (list)

A description of the validation warning.

(string)

errored -> (boolean)

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.