[ aws . imagebuilder ]

list-workflow-executions

Description

Returns a list of workflow runtime instance metadata objects for a specific image build version.

See also: AWS API Documentation

Synopsis

  list-workflow-executions
[--max-results <value>]
[--next-token <value>]
--image-build-version-arn <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]

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.

--image-build-version-arn (string)

List all workflow runtime instances for the specified image build version resource ARN.

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

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

Output

requestId -> (string)

The request ID that uniquely identifies this request.

workflowExecutions -> (list)

Contains an array of runtime details that represents each time a workflow ran for the requested image build version.

(structure)

Metadata that includes details and status from this runtime instance of the workflow.

workflowBuildVersionArn -> (string)

The Amazon Resource Name (ARN) of the workflow resource build version that ran.

workflowExecutionId -> (string)

Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.

type -> (string)

Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.

status -> (string)

The current runtime status for this workflow.

message -> (string)

The runtime output message from the workflow, if applicable.

totalStepCount -> (integer)

The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.

totalStepsSucceeded -> (integer)

A runtime count for the number of steps in the workflow that ran successfully.

totalStepsFailed -> (integer)

A runtime count for the number of steps in the workflow that failed.

totalStepsSkipped -> (integer)

A runtime count for the number of steps in the workflow that were skipped.

startTime -> (string)

The timestamp when the runtime instance of this workflow started.

endTime -> (string)

The timestamp when this runtime instance of the workflow finished.

parallelGroup -> (string)

The name of the test group that included the test workflow resource at runtime.

imageBuildVersionArn -> (string)

The resource ARN of the image build version for which you requested a list of workflow runtime details.

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.