AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iotsitewise ]

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.

See also: AWS API Documentation

describe-pipeline-execution is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: computeNodeExecutionDetails

Synopsis

  describe-pipeline-execution
--workspace-name <value>
--pipeline-name <value>
--pipeline-execution-id <value>
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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>]
[--v2-debug]

Options

--workspace-name (string)

The name of the workspace.

--pipeline-name (string)

The name of the pipeline.

--pipeline-execution-id (string)

The unique identifier of the pipeline execution.

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

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

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

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

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

pipelineExecutionId -> (string)

The unique identifier of the pipeline execution.

pipelineName -> (string)

The name of the pipeline.

workspaceName -> (string)

The name of the workspace.

pipelineVersion -> (string)

The pipeline version this execution ran against.

status -> (structure)

The current execution status of the pipeline.

state -> (string)

Current state of the pipeline execution.

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.

message -> (string)

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)

The error code.

message -> (string)

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.

key -> (string)

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

value -> (string)

Environment variable value

computeNodes -> (map)

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

key -> (string)

The compute node name from the pipeline definition.

value -> (map)

Environment variable overrides specific to this compute node.

key -> (string)

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

value -> (string)

Environment variable value

executionPriority -> (integer)

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

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)

The name of the compute node.

taskName -> (string)

The name of the task executed for this compute node.

taskArn -> (string)

The ARN of the task.

taskVersion -> (string)

The task version that executed for this compute node.

dependsOn -> (list)

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

(string)

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

status -> (structure)

The current execution status of the compute node.

state -> (string)

Current state of the compute node execution.

stateDetails -> (structure)

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

code -> (string)

Classification of the failure.

message -> (string)

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)

The error code.

message -> (string)

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.

key -> (string)

The environment variable name.

value -> (string)

The environment variable value.

nextToken -> (string)

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