[ aws . sagemaker ]

start-pipeline-execution

Description

Starts a pipeline execution.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  start-pipeline-execution
--pipeline-name <value>
[--pipeline-execution-display-name <value>]
[--pipeline-parameters <value>]
[--pipeline-execution-description <value>]
[--client-request-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--pipeline-name (string)

The name of the pipeline.

--pipeline-execution-display-name (string)

The display name of the pipeline execution.

--pipeline-parameters (list)

Contains a list of pipeline parameters. This list can be empty.

(structure)

Assigns a value to a named Pipeline parameter.

Name -> (string)

The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.

Value -> (string)

The literal value for the parameter.

Shorthand Syntax:

Name=string,Value=string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Value": "string"
  }
  ...
]

--pipeline-execution-description (string)

The description of the pipeline execution.

--client-request-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

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

See ‘aws help’ for descriptions of global parameters.

Output

PipelineExecutionArn -> (string)

The Amazon Resource Name (ARN) of the pipeline execution.