create-pipeline¶

Description¶

Creates a new pipeline in the specified workspace. A pipeline defines a directed acyclic graph (DAG) of compute nodes, where each node references a task and can declare dependencies on other nodes. Cyclic dependencies are not allowed. Nodes without dependencies run in parallel, while nodes with dependencies wait for all upstream nodes to complete successfully before starting.

You can set environment variables at the pipeline level that are shared across all compute nodes, and override them at the individual compute node level.

Synopsis¶

  create-pipeline
--workspace-name <value>
--pipeline-name <value>
[--description <value>]
[--environment-variables <value>]
--computations <value>
[--tags <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--workspace-name (string) [required]

The name of the workspace.

Constraints:

min: 1

max: 64

pattern: ^[a-zA-Z0-9_-]+$

--pipeline-name (string) [required]

The name of the pipeline to create. Must be unique within the workspace.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9_-]+

--description (string)

A description of the pipeline.

Constraints:

min: 1

max: 2048

pattern: [^\u0000-\u001F\u007F]+

--environment-variables (map)

Environment variables shared across all compute nodes in the pipeline. Individual compute nodes can override these values with their own environment variables.

Constraints:

min: 0

max: 20

key -> (string)

Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)

Constraints:

min: 1

max: 255

pattern: (?!(?i)AWS_)[a-zA-Z_][a-zA-Z0-9_]*

value -> (string)

Environment variable value

Constraints:

min: 0

max: 1024

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--computations (list) [required]

The list of compute nodes that form the pipeline DAG. Each compute node references a task and can declare dependencies on other nodes.

Constraints:

min: 0

max: 50

(structure)

A single compute node in a pipeline DAG. Each compute node references a task and can declare dependencies on other nodes.

computeNodeName -> (string) [required]

The unique name for this compute node within the pipeline.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9_-]+

taskName -> (string) [required]

The name of the task to execute for this compute node.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9_-]+

environmentVariables -> (map)

Environment variables specific to this compute node. These override pipeline-level environment variables with the same key.

Constraints:

min: 0

max: 20

key -> (string)

Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)

Constraints:

min: 1

max: 255

pattern: (?!(?i)AWS_)[a-zA-Z_][a-zA-Z0-9_]*

value -> (string)

Environment variable value

Constraints:

min: 0

max: 1024

dependsOn -> (list)

A list of compute node names that must complete successfully before this node can start.

Constraints:

min: 0

max: 10

(string)

Reusable resource name with alphanumeric, hyphen, and underscore characters.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9_-]+

Shorthand Syntax:

computeNodeName=string,taskName=string,environmentVariables={KeyName1=string,KeyName2=string},dependsOn=string,string ...

JSON Syntax:

[
  {
    "computeNodeName": "string",
    "taskName": "string",
    "environmentVariables": {"string": "string"
      ...},
    "dependsOn": ["string", ...]
  }
  ...
]

--tags (map)

A list of key-value pairs that contain metadata for the pipeline. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Constraints:

min: 1

max: 50

key -> (string)

Constraints:

min: 1

max: 128

value -> (string)

Constraints:

min: 0

max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.

Constraints:

min: 36

max: 64

pattern: \S{36,64}

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

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

pipelineName -> (string)

The name of the created pipeline.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9_-]+

pipelineArn -> (string)

The ARN of the created pipeline.

Constraints:

min: 1

max: 1600

pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$

version -> (string)

The version of the newly created pipeline.

Constraints:

min: 1

max: 10

pattern: ^(0|([1-9]{1}\d*))$

status -> (structure)

The current lifecycle status of the pipeline.

error -> (structure)

Contains associated error information, if any.

code -> (string)

The error code.

Possible values:

VALIDATION_ERROR

INTERNAL_FAILURE

message -> (string)

The error message.

state -> (string)

The current status of the resource.

Possible values:

CREATING

ACTIVE

UPDATING

DELETING

FAILED

Table of Contents

Feedback

User Guide

create-pipeline¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶