Skip to content

Manually triggers a pipeline to create an image

Description

Manually triggers a pipeline to create an image. You can start a build this way whether the pipeline is enabled or disabled. The response returns as soon as Image Builder creates the new image resource and queues the build. Use the returned imageBuildVersionArn with get_image to track build progress.

Usage

imagebuilder_start_image_pipeline_execution(imagePipelineArn,
  clientToken, tags)

Arguments

  • imagePipelineArn

    [required] The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.

  • clientToken

    [required] A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

  • tags

    The tags for Image Builder to apply to the image resource that's created when pipeline execution starts.

Value

A list with the following syntax:

list(
  requestId = "string",
  clientToken = "string",
  imageBuildVersionArn = "string"
)

Request syntax

svc$start_image_pipeline_execution(
  imagePipelineArn = "string",
  clientToken = "string",
  tags = list(
    "string"
  )
)