describe-pipeline-execution¶

Description¶

Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node. Use this operation to monitor execution progress and inspect per-node results, environment variables, and error details.

Synopsis¶

  describe-pipeline-execution
--workspace-name <value>
--pipeline-name <value>
--pipeline-execution-id <value>
[--starting-token <value>]
[--page-size <value>]
[--max-items <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.

Constraints:

min: 1

max: 64

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

--pipeline-execution-id (string) [required]

The unique identifier of the pipeline execution.

Constraints:

min: 36

max: 36

pattern: ^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 1

max: 250

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

pipelineExecutionId -> (string)

The unique identifier of the pipeline execution.

Constraints:

min: 36

max: 36

pattern: ^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

pipelineName -> (string)

The name of the pipeline.

Constraints:

min: 1

max: 64

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

workspaceName -> (string)

The name of the workspace.

Constraints:

min: 1

max: 64

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

pipelineVersion -> (string)

The pipeline version this execution ran against.

Constraints:

min: 1

max: 10

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

status -> (structure)

The current execution status of the pipeline.

state -> (string) [required]

Current state of the pipeline execution.

Possible values:

NOT_STARTED

RUNNING

SUCCEEDED

FAILED

CANCELLING

CANCELLED

stateDetails -> (structure)

Additional information about the execution outcome. Populated when the execution has terminated (failed or cancelled).

code -> (string)

Classification of the failure. Present when the execution failed.

Possible values:

VALIDATION_ERROR

INTERNAL_FAILURE

EXECUTION_ERROR

TIMED_OUT

message -> (string) [required]

Human-readable description of the outcome. For a failed execution, this describes why it failed; for a cancelled execution, this is the reason you supplied when calling CancelPipelineExecution.

details -> (list)

Per-step error entries to help diagnose a failed execution. Present when the execution failed.

(structure)

Contains a detailed error entry for granular troubleshooting of pipeline failures.

code -> (string) [required]

The error code.

Possible values:

VALIDATION_ERROR

INTERNAL_FAILURE

EXECUTION_ERROR

TIMED_OUT

message -> (string) [required]

The associated error message.

startTime -> (timestamp)

The time the pipeline execution started, in Unix epoch time.

endTime -> (timestamp)

The time the pipeline execution completed, in Unix epoch time.

requestEnvironmentVariables -> (structure)

The environment variables provided as input for the pipeline execution.

global -> (map)

Global environment variables that apply to all compute nodes in the pipeline execution.

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

computeNodes -> (map)

Per-compute-node environment variable overrides. Each entry maps a compute node name to its environment variable overrides.

Constraints:

min: 0

max: 50

key -> (string)

The compute node name from the pipeline definition.

Constraints:

min: 1

max: 64

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

value -> (map)

Environment variable overrides specific to this compute node.

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

executionPriority -> (integer)

Scheduling priority for the execution. When not specified, defaults to lowest priority.

Constraints:

min: 0

max: 2

computeNodeExecutionDetails -> (list)

A list of compute node execution details within this pipeline execution.

(structure)

Contains detailed execution information for a compute node within a pipeline execution.

computeNodeName -> (string) [required]

The name of the compute node.

Constraints:

min: 1

max: 64

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

taskName -> (string) [required]

The name of the task executed for this compute node.

Constraints:

min: 1

max: 64

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

taskArn -> (string) [required]

The ARN of the task.

Constraints:

min: 1

max: 1600

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

taskVersion -> (string) [required]

The task version that executed for this compute node.

Constraints:

min: 1

max: 10

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

dependsOn -> (list) [required]

A list of compute node names that this node depends on.

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_-]+

status -> (structure) [required]

The current execution status of the compute node.

state -> (string) [required]

Current state of the compute node execution.

Possible values:

NOT_STARTED

QUEUED

RUNNING

SUCCEEDED

FAILED

stateDetails -> (structure)

Additional information about the compute node’s failure. Populated when the compute node has failed.

code -> (string) [required]

Classification of the failure.

Possible values:

VALIDATION_ERROR

INTERNAL_FAILURE

EXECUTION_ERROR

TIMED_OUT

message -> (string) [required]

Human-readable description of why the compute node failed.

details -> (list)

Detailed error entries to help diagnose the failure.

(structure)

Contains a detailed error entry for granular troubleshooting of pipeline failures.

code -> (string) [required]

The error code.

Possible values:

VALIDATION_ERROR

INTERNAL_FAILURE

EXECUTION_ERROR

TIMED_OUT

message -> (string) [required]

The associated error message.

startTime -> (timestamp)

The time the compute node execution started, in Unix epoch time.

endTime -> (timestamp)

The time the compute node execution completed, in Unix epoch time.

executionEnvironmentVariables -> (map)

The fully resolved environment variables used for this compute node execution.

Constraints:

min: 0

max: 200

key -> (string)

The environment variable name.

Constraints:

min: 1

max: 255

value -> (string)

The environment variable value.

Constraints:

min: 0

max: 1024

nextToken -> (string)

The token to be used for the next set of paginated results.

Constraints:

min: 1

max: 4096

Table of Contents

Feedback

User Guide