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 ]
Manually triggers a pipeline to create an image.
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
start-image-pipeline-execution
--image-pipeline-arn <value>
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
--image-pipeline-arn (string)
The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.
--client-token (string)
The idempotency token used to make this request idempotent.
--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.
See 'aws help' for descriptions of global parameters.
To start an image pipeline manually
The following start-image-pipeline-execution example manually starts an image pipeline.
aws imagebuilder start-image-pipeline-execution \
--image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline
Output:
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1"
}
For more information, see Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI in the EC2 Image Builder Users Guide.
requestId -> (string)
The request ID that uniquely identifies this request.
clientToken -> (string)
The idempotency token used to make this request idempotent.
imageBuildVersionArn -> (string)
The Amazon Resource Name (ARN) of the image that was created by this request.