Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . datapipeline ]

validate-pipeline-definition

Description

Validates the specified pipeline definition to ensure that it is well formed and can be run without error.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  validate-pipeline-definition
--pipeline-id <value>
--pipeline-objects <value>
[--parameter-objects <value>]
[--parameter-values <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--pipeline-id (string)

The ID of the pipeline.

--pipeline-objects (list)

The objects that define the pipeline changes to validate against the pipeline.

Shorthand Syntax:

id=string,name=string,fields=[{key=string,stringValue=string,refValue=string},{key=string,stringValue=string,refValue=string}] ...

JSON Syntax:

[
  {
    "id": "string",
    "name": "string",
    "fields": [
      {
        "key": "string",
        "stringValue": "string",
        "refValue": "string"
      }
      ...
    ]
  }
  ...
]

--parameter-objects (list)

The parameter objects used with the pipeline.

Shorthand Syntax:

id=string,attributes=[{key=string,stringValue=string},{key=string,stringValue=string}] ...

JSON Syntax:

[
  {
    "id": "string",
    "attributes": [
      {
        "key": "string",
        "stringValue": "string"
      }
      ...
    ]
  }
  ...
]

--parameter-values (list)

The parameter values used with the pipeline.

Shorthand Syntax:

id=string,stringValue=string ...

JSON Syntax:

[
  {
    "id": "string",
    "stringValue": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

validationErrors -> (list)

Any validation errors that were found.

(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)

Any validation warnings that were found.

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