UpdateImagePipeline
Updates an image pipeline. Image pipelines enable you to automate the creation and
distribution of images. You must specify exactly one recipe for your image, using either
a containerRecipeArn
or an imageRecipeArn
.
Note
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.
Request Syntax
PUT /UpdateImagePipeline HTTP/1.1
Content-type: application/json
{
"clientToken": "string
",
"containerRecipeArn": "string
",
"description": "string
",
"distributionConfigurationArn": "string
",
"enhancedImageMetadataEnabled": boolean
,
"executionRole": "string
",
"imagePipelineArn": "string
",
"imageRecipeArn": "string
",
"imageScanningConfiguration": {
"ecrConfiguration": {
"containerTags": [ "string
" ],
"repositoryName": "string
"
},
"imageScanningEnabled": boolean
},
"imageTestsConfiguration": {
"imageTestsEnabled": boolean
,
"timeoutMinutes": number
},
"infrastructureConfigurationArn": "string
",
"schedule": {
"pipelineExecutionStartCondition": "string
",
"scheduleExpression": "string
",
"timezone": "string
"
},
"status": "string
",
"workflows": [
{
"onFailure": "string
",
"parallelGroup": "string
",
"parameters": [
{
"name": "string
",
"value": [ "string
" ]
}
],
"workflowArn": "string
"
}
]
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- clientToken
-
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Required: Yes
- containerRecipeArn
-
The Amazon Resource Name (ARN) of the container pipeline to update.
Type: String
Pattern:
^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):container-recipe/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+$
Required: No
- description
-
The description of the image pipeline.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- distributionConfigurationArn
-
The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.
Type: String
Pattern:
^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):distribution-configuration/[a-z0-9-_]+$
Required: No
- enhancedImageMetadataEnabled
-
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.
Type: Boolean
Required: No
- executionRole
-
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^(?:arn:aws(?:-[a-z]+)*:iam::[0-9]{12}:role/)?[a-zA-Z_0-9+=,.@\-_/]+$
Required: No
- imagePipelineArn
-
The Amazon Resource Name (ARN) of the image pipeline that you want to update.
Type: String
Pattern:
^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image-pipeline/[a-z0-9-_]+$
Required: Yes
- imageRecipeArn
-
The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
Type: String
Pattern:
^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image-recipe/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+$
Required: No
- imageScanningConfiguration
-
Contains settings for vulnerability scans.
Type: ImageScanningConfiguration object
Required: No
- imageTestsConfiguration
-
The image test configuration of the image pipeline.
Type: ImageTestsConfiguration object
Required: No
- infrastructureConfigurationArn
-
The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.
Type: String
Pattern:
^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):infrastructure-configuration/[a-z0-9-_]+$
Required: Yes
- schedule
-
The schedule of the image pipeline.
Type: Schedule object
Required: No
- status
-
The status of the image pipeline.
Type: String
Valid Values:
DISABLED | ENABLED
Required: No
- workflows
-
Contains the workflows to run for the pipeline.
Type: Array of WorkflowConfiguration objects
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"clientToken": "string",
"imagePipelineArn": "string",
"requestId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- clientToken
-
The client token that uniquely identifies the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
- imagePipelineArn
-
The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.
Type: String
Pattern:
^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image-pipeline/[a-z0-9-_]+$
- requestId
-
The request ID that uniquely identifies this request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors.
- CallRateLimitExceededException
-
You have exceeded the permitted request rate for the specific operation.
HTTP Status Code: 429
- ClientException
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
HTTP Status Code: 400
- ForbiddenException
-
You are not authorized to perform the requested operation.
HTTP Status Code: 403
- IdempotentParameterMismatchException
-
You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
HTTP Status Code: 400
- InvalidRequestException
-
You have requested an action that that the service doesn't support.
HTTP Status Code: 400
- ResourceInUseException
-
The resource that you are trying to operate on is currently in use. Review the message details and retry later.
HTTP Status Code: 400
- ServiceException
-
This exception is thrown when the service encounters an unrecoverable exception.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is unable to process your request at this time.
HTTP Status Code: 503
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: