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¶
Synopsis¶
get-workflow
--workflow-build-version-arn <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¶
--workflow-build-version-arn (string)
The Amazon Resource Name (ARN) of the workflow resource that you want to get.
--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.
--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¶
workflow -> (structure)
The workflow resource specified in the request.
arn -> (string)
The Amazon Resource Name (ARN) of the workflow resource.name -> (string)
The name of the workflow resource.version -> (string)
The workflow resource version. Workflow resources are immutable. To make a change, you can clone a workflow or create a new version.description -> (string)
The description of the workflow.changeDescription -> (string)
Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.type -> (string)
Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows.state -> (structure)
Describes the current status of the workflow and the reason for that status.
status -> (string)
The current state of the workflow.reason -> (string)
Describes how or why the workflow changed state.owner -> (string)
The owner of the workflow resource.data -> (string)
Contains the YAML document content for the workflow.kmsKeyId -> (string)
The KMS key identifier used to encrypt the workflow resource.dateCreated -> (string)
The timestamp when Image Builder created the workflow resource.tags -> (map)
The tags that apply to the workflow resource
key -> (string)
value -> (string)
parameters -> (list)
An array of input parameters that that the image workflow uses to control actions or configure settings.
(structure)
Defines a parameter that's used to provide configuration details for the workflow.
name -> (string)
The name of this input parameter.type -> (string)
The type of input this parameter provides. The currently supported value is "string".defaultValue -> (list)
The default value of this parameter if no input is provided.
(string)
description -> (string)
Describes this parameter.