PUT

/UpdateImagePipeline

http://imagebuilder.{region}.amazonaws.com/UpdateImagePipeline

<p>Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images.</p> <note> <p>UpdateImagePipeline does not support selective updates for the pipeline. You must specify all of the required properties in the update request, not just the properties that have changed.</p> </note>

Access Token Required: API Key

Body Params

statusstring

The status of the image pipeline.

scheduleobject

A schedule configures how often and when a pipeline will automatically create a new image.

clientTokenstringrequired

The idempotency token used to make this request idempotent.

descriptionstring

The description of the image pipeline.

imageRecipeArnstring

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.

imagePipelineArnstringrequired

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

containerRecipeArnstring

The Amazon Resource Name (ARN) of the container pipeline to update.

imageTestsConfigurationobject

Configure image tests for your pipeline build. Tests run after building the image, to verify that the AMI or container image is valid before distributing it.

imageScanningConfigurationobject

Contains settings for Image Builder image resource and container image scans.

distributionConfigurationArnstring

The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.

enhancedImageMetadataEnabledboolean

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

infrastructureConfigurationArnstringrequired

The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://imagebuilder.{region}.amazonaws.com/UpdateImagePipeline' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT