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 ]

get-workflow-step-execution

Description

Get the runtime information that was logged for a specific runtime instance of the workflow step.

See also: AWS API Documentation

Synopsis

  get-workflow-step-execution
--step-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

--step-execution-id (string)

Use the unique identifier for a specific runtime instance of the workflow step to get runtime details for that step.

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

stepExecutionId -> (string)

The unique identifier for the runtime version of the workflow step that you specified in the request.

workflowBuildVersionArn -> (string)

The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step.

workflowExecutionId -> (string)

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

imageBuildVersionArn -> (string)

The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow step creates.

name -> (string)

The name of the specified runtime instance of the workflow step.

description -> (string)

Describes the specified workflow step.

action -> (string)

The name of the action that the specified step performs.

status -> (string)

The current status for the specified runtime version of the workflow step.

rollbackStatus -> (string)

Reports on the rollback status of the specified runtime version of the workflow step, if applicable.

message -> (string)

The output message from the specified runtime instance of the workflow step, if applicable.

inputs -> (string)

Input parameters that Image Builder provided for the specified runtime instance of the workflow step.

outputs -> (string)

The file names that the specified runtime version of the workflow step created as output.

startTime -> (string)

The timestamp when the specified runtime version of the workflow step started.

endTime -> (string)

The timestamp when the specified runtime instance of the workflow step finished.

onFailure -> (string)

The action to perform if the workflow step fails.

timeoutSeconds -> (integer)

The maximum duration in seconds for this step to complete its action.