2026/04/10 - EC2 Image Builder - 4 updated api methods
Changes Image pipelines can now automatically apply tags to images they create. Set the imageTags property when creating or updating your pipelines to get started.
{'imageTags': {'string': 'string'}}
Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
See also: AWS API Documentation
Request Syntax
client.create_image_pipeline(
name='string',
description='string',
imageRecipeArn='string',
containerRecipeArn='string',
infrastructureConfigurationArn='string',
distributionConfigurationArn='string',
imageTestsConfiguration={
'imageTestsEnabled': True|False,
'timeoutMinutes': 123
},
enhancedImageMetadataEnabled=True|False,
schedule={
'scheduleExpression': 'string',
'timezone': 'string',
'pipelineExecutionStartCondition': 'EXPRESSION_MATCH_ONLY'|'EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE',
'autoDisablePolicy': {
'failureCount': 123
}
},
status='DISABLED'|'ENABLED',
tags={
'string': 'string'
},
imageTags={
'string': 'string'
},
clientToken='string',
imageScanningConfiguration={
'imageScanningEnabled': True|False,
'ecrConfiguration': {
'repositoryName': 'string',
'containerTags': [
'string',
]
}
},
workflows=[
{
'workflowArn': 'string',
'parameters': [
{
'name': 'string',
'value': [
'string',
]
},
],
'parallelGroup': 'string',
'onFailure': 'CONTINUE'|'ABORT'
},
],
executionRole='string',
loggingConfiguration={
'imageLogGroupName': 'string',
'pipelineLogGroupName': 'string'
}
)
string
[REQUIRED]
The name of the image pipeline.
string
The description of the image pipeline.
string
The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.
string
The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.
string
The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.
dict
The image test configuration of the image pipeline.
imageTestsEnabled (boolean) --
Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.
timeoutMinutes (integer) --
The maximum time in minutes that tests are permitted to run.
boolean
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.
dict
The schedule of the image pipeline.
scheduleExpression (string) --
The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.
timezone (string) --
The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.
pipelineExecutionStartCondition (string) --
The start condition configures when the pipeline should trigger a new image build, as follows. If no value is set Image Builder defaults to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE.
EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE (default) – When you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder builds a new image only when there are new versions of the base image or components in your recipe that match the filter.
EXPRESSION_MATCH_ONLY – This condition builds a new image every time the CRON expression matches the current time.
autoDisablePolicy (dict) --
The policy that configures when Image Builder should automatically disable a pipeline that is failing.
failureCount (integer) -- [REQUIRED]
The number of consecutive scheduled image pipeline executions that must fail before Image Builder automatically disables the pipeline.
string
The status of the image pipeline.
dict
The tags of the image pipeline.
(string) --
(string) --
dict
The tags to be applied to the images produced by this pipeline.
(string) --
(string) --
string
[REQUIRED]
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
This field is autopopulated if not provided.
dict
Contains settings for vulnerability scans.
imageScanningEnabled (boolean) --
A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
ecrConfiguration (dict) --
Contains Amazon ECR settings for vulnerability scans.
repositoryName (string) --
The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository for vulnerability scans of your output container images.
containerTags (list) --
Tags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can help you identify and manage your scanned images.
(string) --
list
Contains an array of workflow configuration objects.
(dict) --
Contains control settings and configurable inputs for a workflow resource.
workflowArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the workflow resource.
parameters (list) --
Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.
(dict) --
Contains a key/value pair that sets the named workflow parameter.
name (string) -- [REQUIRED]
The name of the workflow parameter to set.
value (list) -- [REQUIRED]
Sets the value for the named workflow parameter.
(string) --
parallelGroup (string) --
Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.
onFailure (string) --
The action to take if the workflow fails.
string
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
dict
Define logging configuration for the image build process.
imageLogGroupName (string) --
The log group name that Image Builder uses for image creation. If not specified, the log group name defaults to /aws/imagebuilder/image-name.
pipelineLogGroupName (string) --
The log group name that Image Builder uses for the log output during creation of a new pipeline. If not specified, the pipeline log group name defaults to /aws/imagebuilder/pipeline/pipeline-name.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'imagePipelineArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
clientToken (string) --
The client token that uniquely identifies the request.
imagePipelineArn (string) --
The Amazon Resource Name (ARN) of the image pipeline that was created by this request.
{'imagePipeline': {'imageTags': {'string': 'string'}}}
Gets an image pipeline.
See also: AWS API Documentation
Request Syntax
client.get_image_pipeline(
imagePipelineArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.
dict
Response Syntax
{
'requestId': 'string',
'imagePipeline': {
'arn': 'string',
'name': 'string',
'description': 'string',
'platform': 'Windows'|'Linux'|'macOS',
'enhancedImageMetadataEnabled': True|False,
'imageRecipeArn': 'string',
'containerRecipeArn': 'string',
'infrastructureConfigurationArn': 'string',
'distributionConfigurationArn': 'string',
'imageTestsConfiguration': {
'imageTestsEnabled': True|False,
'timeoutMinutes': 123
},
'schedule': {
'scheduleExpression': 'string',
'timezone': 'string',
'pipelineExecutionStartCondition': 'EXPRESSION_MATCH_ONLY'|'EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE',
'autoDisablePolicy': {
'failureCount': 123
}
},
'status': 'DISABLED'|'ENABLED',
'dateCreated': 'string',
'dateUpdated': 'string',
'dateLastRun': 'string',
'lastRunStatus': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED',
'dateNextRun': 'string',
'tags': {
'string': 'string'
},
'imageScanningConfiguration': {
'imageScanningEnabled': True|False,
'ecrConfiguration': {
'repositoryName': 'string',
'containerTags': [
'string',
]
}
},
'imageTags': {
'string': 'string'
},
'executionRole': 'string',
'workflows': [
{
'workflowArn': 'string',
'parameters': [
{
'name': 'string',
'value': [
'string',
]
},
],
'parallelGroup': 'string',
'onFailure': 'CONTINUE'|'ABORT'
},
],
'loggingConfiguration': {
'imageLogGroupName': 'string',
'pipelineLogGroupName': 'string'
},
'consecutiveFailures': 123
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
imagePipeline (dict) --
The image pipeline object.
arn (string) --
The Amazon Resource Name (ARN) of the image pipeline.
name (string) --
The name of the image pipeline.
description (string) --
The description of the image pipeline.
platform (string) --
The platform of the image pipeline.
enhancedImageMetadataEnabled (boolean) --
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.
imageRecipeArn (string) --
The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
containerRecipeArn (string) --
The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
infrastructureConfigurationArn (string) --
The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
distributionConfigurationArn (string) --
The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
imageTestsConfiguration (dict) --
The image tests configuration of the image pipeline.
imageTestsEnabled (boolean) --
Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.
timeoutMinutes (integer) --
The maximum time in minutes that tests are permitted to run.
schedule (dict) --
The schedule of the image pipeline.
scheduleExpression (string) --
The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.
timezone (string) --
The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.
pipelineExecutionStartCondition (string) --
The start condition configures when the pipeline should trigger a new image build, as follows. If no value is set Image Builder defaults to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE.
EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE (default) – When you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder builds a new image only when there are new versions of the base image or components in your recipe that match the filter.
EXPRESSION_MATCH_ONLY – This condition builds a new image every time the CRON expression matches the current time.
autoDisablePolicy (dict) --
The policy that configures when Image Builder should automatically disable a pipeline that is failing.
failureCount (integer) --
The number of consecutive scheduled image pipeline executions that must fail before Image Builder automatically disables the pipeline.
status (string) --
The status of the image pipeline.
dateCreated (string) --
The date on which this image pipeline was created.
dateUpdated (string) --
The date on which this image pipeline was last updated.
dateLastRun (string) --
This is no longer supported, and does not return a value.
lastRunStatus (string) --
The status of the last image that this pipeline built, such as BUILDING, TESTING, FAILED, or AVAILABLE.
dateNextRun (string) --
The next date when the pipeline is scheduled to run.
tags (dict) --
The tags of this image pipeline.
(string) --
(string) --
imageScanningConfiguration (dict) --
Contains settings for vulnerability scans.
imageScanningEnabled (boolean) --
A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
ecrConfiguration (dict) --
Contains Amazon ECR settings for vulnerability scans.
repositoryName (string) --
The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository for vulnerability scans of your output container images.
containerTags (list) --
Tags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can help you identify and manage your scanned images.
(string) --
imageTags (dict) --
The tags to be applied to the images produced by this pipeline.
(string) --
(string) --
executionRole (string) --
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
workflows (list) --
Contains the workflows that run for the image pipeline.
(dict) --
Contains control settings and configurable inputs for a workflow resource.
workflowArn (string) --
The Amazon Resource Name (ARN) of the workflow resource.
parameters (list) --
Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.
(dict) --
Contains a key/value pair that sets the named workflow parameter.
name (string) --
The name of the workflow parameter to set.
value (list) --
Sets the value for the named workflow parameter.
(string) --
parallelGroup (string) --
Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.
onFailure (string) --
The action to take if the workflow fails.
loggingConfiguration (dict) --
Defines logging configuration for the output image.
imageLogGroupName (string) --
The log group name that Image Builder uses for image creation. If not specified, the log group name defaults to /aws/imagebuilder/image-name.
pipelineLogGroupName (string) --
The log group name that Image Builder uses for the log output during creation of a new pipeline. If not specified, the pipeline log group name defaults to /aws/imagebuilder/pipeline/pipeline-name.
consecutiveFailures (integer) --
Image Builder tracks the number of consecutive failures for scheduled pipeline executions and takes one of the following actions each time it runs on a schedule:
If the pipeline execution is successful, the number of consecutive failures resets to zero.
If the pipeline execution fails, Image Builder increments the number of consecutive failures. If the failure count exceeds the limit defined in the AutoDisablePolicy, Image Builder disables the pipeline.
The consecutive failure count is also reset to zero under the following conditions:
The pipeline runs manually and succeeds.
The pipeline configuration is updated.
If the pipeline runs manually and fails, the count remains the same. The next scheduled run continues to increment where it left off before.
{'imagePipelineList': {'imageTags': {'string': 'string'}}}
Returns a list of image pipelines.
See also: AWS API Documentation
Request Syntax
client.list_image_pipelines(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
list
Use the following filters to streamline results:
description
distributionConfigurationArn
imageRecipeArn
infrastructureConfigurationArn
name
status
(dict) --
A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
name (string) --
The name of the filter. Filter names are case-sensitive.
values (list) --
The filter values. Filter values are case-sensitive.
(string) --
integer
Specify the maximum number of items to return in a request.
string
A token to specify where to start paginating. This is the nextToken from a previously truncated response.
dict
Response Syntax
{
'requestId': 'string',
'imagePipelineList': [
{
'arn': 'string',
'name': 'string',
'description': 'string',
'platform': 'Windows'|'Linux'|'macOS',
'enhancedImageMetadataEnabled': True|False,
'imageRecipeArn': 'string',
'containerRecipeArn': 'string',
'infrastructureConfigurationArn': 'string',
'distributionConfigurationArn': 'string',
'imageTestsConfiguration': {
'imageTestsEnabled': True|False,
'timeoutMinutes': 123
},
'schedule': {
'scheduleExpression': 'string',
'timezone': 'string',
'pipelineExecutionStartCondition': 'EXPRESSION_MATCH_ONLY'|'EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE',
'autoDisablePolicy': {
'failureCount': 123
}
},
'status': 'DISABLED'|'ENABLED',
'dateCreated': 'string',
'dateUpdated': 'string',
'dateLastRun': 'string',
'lastRunStatus': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED',
'dateNextRun': 'string',
'tags': {
'string': 'string'
},
'imageScanningConfiguration': {
'imageScanningEnabled': True|False,
'ecrConfiguration': {
'repositoryName': 'string',
'containerTags': [
'string',
]
}
},
'imageTags': {
'string': 'string'
},
'executionRole': 'string',
'workflows': [
{
'workflowArn': 'string',
'parameters': [
{
'name': 'string',
'value': [
'string',
]
},
],
'parallelGroup': 'string',
'onFailure': 'CONTINUE'|'ABORT'
},
],
'loggingConfiguration': {
'imageLogGroupName': 'string',
'pipelineLogGroupName': 'string'
},
'consecutiveFailures': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
imagePipelineList (list) --
The list of image pipelines.
(dict) --
Details of an image pipeline.
arn (string) --
The Amazon Resource Name (ARN) of the image pipeline.
name (string) --
The name of the image pipeline.
description (string) --
The description of the image pipeline.
platform (string) --
The platform of the image pipeline.
enhancedImageMetadataEnabled (boolean) --
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.
imageRecipeArn (string) --
The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
containerRecipeArn (string) --
The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
infrastructureConfigurationArn (string) --
The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
distributionConfigurationArn (string) --
The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
imageTestsConfiguration (dict) --
The image tests configuration of the image pipeline.
imageTestsEnabled (boolean) --
Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.
timeoutMinutes (integer) --
The maximum time in minutes that tests are permitted to run.
schedule (dict) --
The schedule of the image pipeline.
scheduleExpression (string) --
The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.
timezone (string) --
The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.
pipelineExecutionStartCondition (string) --
The start condition configures when the pipeline should trigger a new image build, as follows. If no value is set Image Builder defaults to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE.
EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE (default) – When you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder builds a new image only when there are new versions of the base image or components in your recipe that match the filter.
EXPRESSION_MATCH_ONLY – This condition builds a new image every time the CRON expression matches the current time.
autoDisablePolicy (dict) --
The policy that configures when Image Builder should automatically disable a pipeline that is failing.
failureCount (integer) --
The number of consecutive scheduled image pipeline executions that must fail before Image Builder automatically disables the pipeline.
status (string) --
The status of the image pipeline.
dateCreated (string) --
The date on which this image pipeline was created.
dateUpdated (string) --
The date on which this image pipeline was last updated.
dateLastRun (string) --
This is no longer supported, and does not return a value.
lastRunStatus (string) --
The status of the last image that this pipeline built, such as BUILDING, TESTING, FAILED, or AVAILABLE.
dateNextRun (string) --
The next date when the pipeline is scheduled to run.
tags (dict) --
The tags of this image pipeline.
(string) --
(string) --
imageScanningConfiguration (dict) --
Contains settings for vulnerability scans.
imageScanningEnabled (boolean) --
A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
ecrConfiguration (dict) --
Contains Amazon ECR settings for vulnerability scans.
repositoryName (string) --
The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository for vulnerability scans of your output container images.
containerTags (list) --
Tags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can help you identify and manage your scanned images.
(string) --
imageTags (dict) --
The tags to be applied to the images produced by this pipeline.
(string) --
(string) --
executionRole (string) --
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
workflows (list) --
Contains the workflows that run for the image pipeline.
(dict) --
Contains control settings and configurable inputs for a workflow resource.
workflowArn (string) --
The Amazon Resource Name (ARN) of the workflow resource.
parameters (list) --
Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.
(dict) --
Contains a key/value pair that sets the named workflow parameter.
name (string) --
The name of the workflow parameter to set.
value (list) --
Sets the value for the named workflow parameter.
(string) --
parallelGroup (string) --
Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.
onFailure (string) --
The action to take if the workflow fails.
loggingConfiguration (dict) --
Defines logging configuration for the output image.
imageLogGroupName (string) --
The log group name that Image Builder uses for image creation. If not specified, the log group name defaults to /aws/imagebuilder/image-name.
pipelineLogGroupName (string) --
The log group name that Image Builder uses for the log output during creation of a new pipeline. If not specified, the pipeline log group name defaults to /aws/imagebuilder/pipeline/pipeline-name.
consecutiveFailures (integer) --
Image Builder tracks the number of consecutive failures for scheduled pipeline executions and takes one of the following actions each time it runs on a schedule:
If the pipeline execution is successful, the number of consecutive failures resets to zero.
If the pipeline execution fails, Image Builder increments the number of consecutive failures. If the failure count exceeds the limit defined in the AutoDisablePolicy, Image Builder disables the pipeline.
The consecutive failure count is also reset to zero under the following conditions:
The pipeline runs manually and succeeds.
The pipeline configuration is updated.
If the pipeline runs manually and fails, the count remains the same. The next scheduled run continues to increment where it left off before.
nextToken (string) --
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.
{'imageTags': {'string': 'string'}}
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.
See also: AWS API Documentation
Request Syntax
client.update_image_pipeline(
imagePipelineArn='string',
description='string',
imageRecipeArn='string',
containerRecipeArn='string',
infrastructureConfigurationArn='string',
distributionConfigurationArn='string',
imageTestsConfiguration={
'imageTestsEnabled': True|False,
'timeoutMinutes': 123
},
enhancedImageMetadataEnabled=True|False,
schedule={
'scheduleExpression': 'string',
'timezone': 'string',
'pipelineExecutionStartCondition': 'EXPRESSION_MATCH_ONLY'|'EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE',
'autoDisablePolicy': {
'failureCount': 123
}
},
status='DISABLED'|'ENABLED',
clientToken='string',
imageScanningConfiguration={
'imageScanningEnabled': True|False,
'ecrConfiguration': {
'repositoryName': 'string',
'containerTags': [
'string',
]
}
},
workflows=[
{
'workflowArn': 'string',
'parameters': [
{
'name': 'string',
'value': [
'string',
]
},
],
'parallelGroup': 'string',
'onFailure': 'CONTINUE'|'ABORT'
},
],
loggingConfiguration={
'imageLogGroupName': 'string',
'pipelineLogGroupName': 'string'
},
executionRole='string',
imageTags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image pipeline that you want to update.
string
The description of the image pipeline.
string
The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
string
The Amazon Resource Name (ARN) of the container pipeline to update.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.
string
The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.
dict
The image test configuration of the image pipeline.
imageTestsEnabled (boolean) --
Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.
timeoutMinutes (integer) --
The maximum time in minutes that tests are permitted to run.
boolean
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.
dict
The schedule of the image pipeline.
scheduleExpression (string) --
The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.
timezone (string) --
The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.
pipelineExecutionStartCondition (string) --
The start condition configures when the pipeline should trigger a new image build, as follows. If no value is set Image Builder defaults to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE.
EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE (default) – When you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder builds a new image only when there are new versions of the base image or components in your recipe that match the filter.
EXPRESSION_MATCH_ONLY – This condition builds a new image every time the CRON expression matches the current time.
autoDisablePolicy (dict) --
The policy that configures when Image Builder should automatically disable a pipeline that is failing.
failureCount (integer) -- [REQUIRED]
The number of consecutive scheduled image pipeline executions that must fail before Image Builder automatically disables the pipeline.
string
The status of the image pipeline.
string
[REQUIRED]
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
This field is autopopulated if not provided.
dict
Contains settings for vulnerability scans.
imageScanningEnabled (boolean) --
A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
ecrConfiguration (dict) --
Contains Amazon ECR settings for vulnerability scans.
repositoryName (string) --
The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository for vulnerability scans of your output container images.
containerTags (list) --
Tags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can help you identify and manage your scanned images.
(string) --
list
Contains the workflows to run for the pipeline.
(dict) --
Contains control settings and configurable inputs for a workflow resource.
workflowArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the workflow resource.
parameters (list) --
Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.
(dict) --
Contains a key/value pair that sets the named workflow parameter.
name (string) -- [REQUIRED]
The name of the workflow parameter to set.
value (list) -- [REQUIRED]
Sets the value for the named workflow parameter.
(string) --
parallelGroup (string) --
Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.
onFailure (string) --
The action to take if the workflow fails.
dict
Update logging configuration for the output image that's created when the pipeline runs.
imageLogGroupName (string) --
The log group name that Image Builder uses for image creation. If not specified, the log group name defaults to /aws/imagebuilder/image-name.
pipelineLogGroupName (string) --
The log group name that Image Builder uses for the log output during creation of a new pipeline. If not specified, the pipeline log group name defaults to /aws/imagebuilder/pipeline/pipeline-name.
string
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
dict
The tags to be applied to the images produced by this pipeline.
(string) --
(string) --
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'imagePipelineArn': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
clientToken (string) --
The client token that uniquely identifies the request.
imagePipelineArn (string) --
The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.