update-pipeline-execution¶
Description¶
Updates a pipeline execution.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
update-pipeline-execution
--pipeline-execution-arn <value>
[--pipeline-execution-description <value>]
[--pipeline-execution-display-name <value>]
[--parallelism-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--pipeline-execution-arn (string)
The Amazon Resource Name (ARN) of the pipeline execution.
--pipeline-execution-description (string)
The description of the pipeline execution.
--pipeline-execution-display-name (string)
The display name of the pipeline execution.
--parallelism-configuration (structure)
This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.
MaxParallelExecutionSteps -> (integer)
The max number of steps that can be executed in parallel.
Shorthand Syntax:
MaxParallelExecutionSteps=integer
JSON Syntax:
{
"MaxParallelExecutionSteps": integer
}
--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 updated pipeline execution.