AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . imagebuilder ]

list-workflow-step-executions

Description

Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.

See also: AWS API Documentation

Synopsis

  list-workflow-step-executions
[--max-results <value>]
[--next-token <value>]
--workflow-execution-id <value>
[--cli-input-json <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>]

Options

--max-results (integer)

The maximum items to return in a request.

--next-token (string)

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

--workflow-execution-id (string)

The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

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

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

Output

requestId -> (string)

The request ID that uniquely identifies this request.

steps -> (list)

Contains an array of runtime details that represents each step in this runtime instance of the workflow.

(structure)

Runtime details and status for the workflow step.

stepExecutionId -> (string)

A unique identifier for the workflow step, assigned at runtime.

name -> (string)

The name of the workflow step.

description -> (string)

Description of the workflow step.

action -> (string)

The step action name.

status -> (string)

Runtime status for the workflow step.

rollbackStatus -> (string)

Reports on the rollback status of the step, if applicable.

message -> (string)

Detailed output message that the workflow step provides at runtime.

inputs -> (string)

Input parameters that Image Builder provides for the workflow step.

outputs -> (string)

The file names that the workflow step created as output for this runtime instance of the workflow.

startTime -> (string)

The timestamp when the workflow step started.

endTime -> (string)

The timestamp when the workflow step finished.

workflowBuildVersionArn -> (string)

The build version ARN for the Image Builder workflow resource that defines the steps for this runtime instance of the workflow.

workflowExecutionId -> (string)

The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

imageBuildVersionArn -> (string)

The image build version resource ARN that's associated with the specified runtime instance of the workflow.

message -> (string)

The output message from the list action, if applicable.

nextToken -> (string)

The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.