2023/03/30 - EC2 Image Builder - 6 new 6 updated api methods
Changes Adds support for new image workflow details and image vulnerability detection.
Get the runtime information that was logged for a specific runtime instance of the workflow step.
See also: AWS API Documentation
Request Syntax
client.get_workflow_step_execution(
stepExecutionId='string'
)
string
[REQUIRED]
Use the unique identifier for a specific runtime instance of the workflow step to get runtime details for that step.
dict
Response Syntax
{
'requestId': 'string',
'stepExecutionId': 'string',
'workflowBuildVersionArn': 'string',
'workflowExecutionId': 'string',
'imageBuildVersionArn': 'string',
'name': 'string',
'description': 'string',
'action': 'string',
'status': 'PENDING'|'SKIPPED'|'RUNNING'|'COMPLETED'|'FAILED',
'rollbackStatus': 'RUNNING'|'COMPLETED'|'SKIPPED'|'FAILED',
'message': 'string',
'inputs': 'string',
'outputs': 'string',
'startTime': 'string',
'endTime': 'string',
'onFailure': 'string',
'timeoutSeconds': 123
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
stepExecutionId (string) --
The unique identifier for the runtime version of the workflow step that you specified in the request.
workflowBuildVersionArn (string) --
The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step.
workflowExecutionId (string) --
The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
imageBuildVersionArn (string) --
The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow step creates.
name (string) --
The name of the specified runtime instance of the workflow step.
description (string) --
Describes the specified workflow step.
action (string) --
The name of the action that the specified step performs.
status (string) --
The current status for the specified runtime version of the workflow step.
rollbackStatus (string) --
Reports on the rollback status of the specified runtime version of the workflow step, if applicable.
message (string) --
The output message from the specified runtime instance of the workflow step, if applicable.
inputs (string) --
Input parameters that Image Builder provided for the specified runtime instance of the workflow step.
outputs (string) --
The file names that the specified runtime version of the workflow step created as output.
startTime (string) --
The timestamp when the specified runtime version of the workflow step started.
endTime (string) --
The timestamp when the specified runtime instance of the workflow step finished.
onFailure (string) --
The action to perform if the workflow step fails.
timeoutSeconds (integer) --
The maximum duration in seconds for this step to complete its action.
Get the runtime information that was logged for a specific runtime instance of the workflow.
See also: AWS API Documentation
Request Syntax
client.get_workflow_execution(
workflowExecutionId='string'
)
string
[REQUIRED]
Use the unique identifier for a runtime instance of the workflow to get runtime details.
dict
Response Syntax
{
'requestId': 'string',
'workflowBuildVersionArn': 'string',
'workflowExecutionId': 'string',
'imageBuildVersionArn': 'string',
'type': 'BUILD'|'TEST'|'DISTRIBUTION',
'status': 'PENDING'|'SKIPPED'|'RUNNING'|'COMPLETED'|'FAILED'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_COMPLETED',
'message': 'string',
'totalStepCount': 123,
'totalStepsSucceeded': 123,
'totalStepsFailed': 123,
'totalStepsSkipped': 123,
'startTime': 'string',
'endTime': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
workflowBuildVersionArn (string) --
The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow.
workflowExecutionId (string) --
The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
imageBuildVersionArn (string) --
The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow created.
type (string) --
The type of workflow that Image Builder ran for the specified runtime instance of the workflow.
status (string) --
The current runtime status for the specified runtime instance of the workflow.
message (string) --
The output message from the specified runtime instance of the workflow, if applicable.
totalStepCount (integer) --
The total number of steps in the specified runtime instance of the workflow that ran. This number should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
totalStepsSucceeded (integer) --
A runtime count for the number of steps that ran successfully in the specified runtime instance of the workflow.
totalStepsFailed (integer) --
A runtime count for the number of steps that failed in the specified runtime instance of the workflow.
totalStepsSkipped (integer) --
A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow.
startTime (string) --
The timestamp when the specified runtime instance of the workflow started.
endTime (string) --
The timestamp when the specified runtime instance of the workflow finished.
Returns a list of workflow runtime instance metadata objects for a specific image build version.
See also: AWS API Documentation
Request Syntax
client.list_workflow_executions(
maxResults=123,
nextToken='string',
imageBuildVersionArn='string'
)
integer
The maximum items to return in a request.
string
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
string
[REQUIRED]
List all workflow runtime instances for the specified image build version resource ARN.
dict
Response Syntax
{
'requestId': 'string',
'workflowExecutions': [
{
'workflowBuildVersionArn': 'string',
'workflowExecutionId': 'string',
'type': 'BUILD'|'TEST'|'DISTRIBUTION',
'status': 'PENDING'|'SKIPPED'|'RUNNING'|'COMPLETED'|'FAILED'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_COMPLETED',
'message': 'string',
'totalStepCount': 123,
'totalStepsSucceeded': 123,
'totalStepsFailed': 123,
'totalStepsSkipped': 123,
'startTime': 'string',
'endTime': 'string'
},
],
'imageBuildVersionArn': 'string',
'message': 'string',
'nextToken': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
workflowExecutions (list) --
Contains an array of runtime details that represents each time a workflow ran for the requested image build version.
(dict) --
Metadata that includes details and status from this runtime instance of the workflow.
workflowBuildVersionArn (string) --
The Amazon Resource Name (ARN) of the workflow resource build version that ran.
workflowExecutionId (string) --
Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
type (string) --
Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
status (string) --
The current runtime status for this workflow.
message (string) --
The runtime output message from the workflow, if applicable.
totalStepCount (integer) --
The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
totalStepsSucceeded (integer) --
A runtime count for the number of steps in the workflow that ran successfully.
totalStepsFailed (integer) --
A runtime count for the number of steps in the workflow that failed.
totalStepsSkipped (integer) --
A runtime count for the number of steps in the workflow that were skipped.
startTime (string) --
The timestamp when the runtime instance of this workflow started.
endTime (string) --
The timestamp when this runtime instance of the workflow finished.
imageBuildVersionArn (string) --
The resource ARN of the image build version for which you requested a list of workflow runtime details.
message (string) --
The output message from the list action, if applicable.
nextToken (string) --
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
Returns a list of image scan aggregations for your account. You can filter by the type of key that Image Builder uses to group results. For example, if you want to get a list of findings by severity level for one of your pipelines, you might specify your pipeline with the imagePipelineArn filter. If you don't specify a filter, Image Builder returns an aggregation for your account.
To streamline results, you can use the following filters in your request:
accountId
imageBuildVersionArn
imagePipelineArn
vulnerabilityId
See also: AWS API Documentation
Request Syntax
client.list_image_scan_finding_aggregations(
filter={
'name': 'string',
'values': [
'string',
]
},
nextToken='string'
)
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) --
string
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
dict
Response Syntax
{
'requestId': 'string',
'aggregationType': 'string',
'responses': [
{
'accountAggregation': {
'accountId': 'string',
'severityCounts': {
'all': 123,
'critical': 123,
'high': 123,
'medium': 123
}
},
'imageAggregation': {
'imageBuildVersionArn': 'string',
'severityCounts': {
'all': 123,
'critical': 123,
'high': 123,
'medium': 123
}
},
'imagePipelineAggregation': {
'imagePipelineArn': 'string',
'severityCounts': {
'all': 123,
'critical': 123,
'high': 123,
'medium': 123
}
},
'vulnerabilityIdAggregation': {
'vulnerabilityId': 'string',
'severityCounts': {
'all': 123,
'critical': 123,
'high': 123,
'medium': 123
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
aggregationType (string) --
The aggregation type specifies what type of key is used to group the image scan findings. Image Builder returns results based on the request filter. If you didn't specify a filter in the request, the type defaults to accountId .
Aggregation types
accountId
imageBuildVersionArn
imagePipelineArn
vulnerabilityId
Each aggregation includes counts by severity level for medium severity and higher level findings, plus a total for all of the findings for each key value.
responses (list) --
An array of image scan finding aggregations that match the filter criteria.
(dict) --
This returns exactly one type of aggregation, based on the filter that Image Builder applies in its API action.
accountAggregation (dict) --
Returns an object that contains severity counts based on an account ID.
accountId (string) --
Identifies the account that owns the aggregated resource findings.
severityCounts (dict) --
Counts by severity level for medium severity and higher level findings, plus a total for all of the findings.
all (integer) --
The total number of findings across all severity levels for the specified filter.
critical (integer) --
The number of critical severity findings for the specified filter.
high (integer) --
The number of high severity findings for the specified filter.
medium (integer) --
The number of medium severity findings for the specified filter.
imageAggregation (dict) --
Returns an object that contains severity counts based on the Amazon Resource Name (ARN) for a specific image.
imageBuildVersionArn (string) --
The Amazon Resource Name (ARN) that identifies the image for this aggregation.
severityCounts (dict) --
Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image.
all (integer) --
The total number of findings across all severity levels for the specified filter.
critical (integer) --
The number of critical severity findings for the specified filter.
high (integer) --
The number of high severity findings for the specified filter.
medium (integer) --
The number of medium severity findings for the specified filter.
imagePipelineAggregation (dict) --
Returns an object that contains severity counts based on an image pipeline ARN.
imagePipelineArn (string) --
The Amazon Resource Name (ARN) that identifies the image pipeline for this aggregation.
severityCounts (dict) --
Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image pipeline.
all (integer) --
The total number of findings across all severity levels for the specified filter.
critical (integer) --
The number of critical severity findings for the specified filter.
high (integer) --
The number of high severity findings for the specified filter.
medium (integer) --
The number of medium severity findings for the specified filter.
vulnerabilityIdAggregation (dict) --
Returns an object that contains severity counts based on vulnerability ID.
vulnerabilityId (string) --
The vulnerability Id for this set of counts.
severityCounts (dict) --
Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified vulnerability.
all (integer) --
The total number of findings across all severity levels for the specified filter.
critical (integer) --
The number of critical severity findings for the specified filter.
high (integer) --
The number of high severity findings for the specified filter.
medium (integer) --
The number of medium severity findings for the specified filter.
nextToken (string) --
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
Shows runtime data for each step in a runtime instance of the workflow that you specify in the request.
See also: AWS API Documentation
Request Syntax
client.list_workflow_step_executions(
maxResults=123,
nextToken='string',
workflowExecutionId='string'
)
integer
The maximum items to return in a request.
string
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
string
[REQUIRED]
The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
dict
Response Syntax
{
'requestId': 'string',
'steps': [
{
'stepExecutionId': 'string',
'name': 'string',
'description': 'string',
'action': 'string',
'status': 'PENDING'|'SKIPPED'|'RUNNING'|'COMPLETED'|'FAILED',
'rollbackStatus': 'RUNNING'|'COMPLETED'|'SKIPPED'|'FAILED',
'message': 'string',
'inputs': 'string',
'outputs': 'string',
'startTime': 'string',
'endTime': 'string'
},
],
'workflowBuildVersionArn': 'string',
'workflowExecutionId': 'string',
'imageBuildVersionArn': 'string',
'message': 'string',
'nextToken': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
steps (list) --
Contains an array of runtime details that represents each step in this runtime instance of the workflow.
(dict) --
Runtime details and status for the workflow step.
stepExecutionId (string) --
A unique identifier for the workflow step, assigned at runtime.
name (string) --
The name of the workflow step.
description (string) --
Description of the workflow step.
action (string) --
The step action name.
status (string) --
Runtime status for the workflow step.
rollbackStatus (string) --
Reports on the rollback status of the step, if applicable.
message (string) --
Detailed output message that the workflow step provides at runtime.
inputs (string) --
Input parameters that Image Builder provides for the workflow step.
outputs (string) --
The file names that the workflow step created as output for this runtime instance of the workflow.
startTime (string) --
The timestamp when the workflow step started.
endTime (string) --
The timestamp when the workflow step finished.
workflowBuildVersionArn (string) --
The build version ARN for the Image Builder workflow resource that defines the steps for this runtime instance of the workflow.
workflowExecutionId (string) --
The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
imageBuildVersionArn (string) --
The image build version resource ARN that's associated with the specified runtime instance of the workflow.
message (string) --
The output message from the list action, if applicable.
nextToken (string) --
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
Returns a list of image scan findings for your account.
See also: AWS API Documentation
Request Syntax
client.list_image_scan_findings(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
list
An array of name value pairs that you can use to filter your results. You can use the following filters to streamline results:
imageBuildVersionArn
imagePipelineArn
vulnerabilityId
severity
If you don't request a filter, then all findings in your account are listed.
(dict) --
A name value pair that Image Builder applies to streamline results from the vulnerability scan findings list action.
name (string) --
The name of the image scan finding filter. Filter names are case-sensitive.
values (list) --
The filter values. Filter values are case-sensitive.
(string) --
integer
The maximum 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',
'findings': [
{
'awsAccountId': 'string',
'imageBuildVersionArn': 'string',
'imagePipelineArn': 'string',
'type': 'string',
'description': 'string',
'title': 'string',
'remediation': {
'recommendation': {
'text': 'string',
'url': 'string'
}
},
'severity': 'string',
'firstObservedAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'inspectorScore': 123.0,
'inspectorScoreDetails': {
'adjustedCvss': {
'scoreSource': 'string',
'cvssSource': 'string',
'version': 'string',
'score': 123.0,
'scoringVector': 'string',
'adjustments': [
{
'metric': 'string',
'reason': 'string'
},
]
}
},
'packageVulnerabilityDetails': {
'vulnerabilityId': 'string',
'vulnerablePackages': [
{
'name': 'string',
'version': 'string',
'sourceLayerHash': 'string',
'epoch': 123,
'release': 'string',
'arch': 'string',
'packageManager': 'string',
'filePath': 'string',
'fixedInVersion': 'string',
'remediation': 'string'
},
],
'source': 'string',
'cvss': [
{
'baseScore': 123.0,
'scoringVector': 'string',
'version': 'string',
'source': 'string'
},
],
'relatedVulnerabilities': [
'string',
],
'sourceUrl': 'string',
'vendorSeverity': 'string',
'vendorCreatedAt': datetime(2015, 1, 1),
'vendorUpdatedAt': datetime(2015, 1, 1),
'referenceUrls': [
'string',
]
},
'fixAvailable': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
findings (list) --
The image scan findings for your account that meet your request filter criteria.
(dict) --
Contains details about a vulnerability scan finding.
awsAccountId (string) --
The Amazon Web Services account ID that's associated with the finding.
imageBuildVersionArn (string) --
The Amazon Resource Name (ARN) of the image build version that's associated with the finding.
imagePipelineArn (string) --
The Amazon Resource Name (ARN) of the image pipeline that's associated with the finding.
type (string) --
The type of the finding. Image Builder looks for findings of the type PACKAGE_VULNERABILITY that apply to output images, and excludes other types.
description (string) --
The description of the finding.
title (string) --
The title of the finding.
remediation (dict) --
An object that contains the details about how to remediate the finding.
recommendation (dict) --
An object that contains information about the recommended course of action to remediate the finding.
text (string) --
The recommended course of action to remediate the finding.
url (string) --
A link to more information about the recommended remediation for this vulnerability.
severity (string) --
The severity of the finding.
firstObservedAt (datetime) --
The date and time when the finding was first observed.
updatedAt (datetime) --
The timestamp when the finding was last updated.
inspectorScore (float) --
The score that Amazon Inspector assigned for the finding.
inspectorScoreDetails (dict) --
An object that contains details of the Amazon Inspector score.
adjustedCvss (dict) --
An object that contains details about an adjustment that Amazon Inspector made to the CVSS score for the finding.
scoreSource (string) --
The source for the CVSS score.
cvssSource (string) --
The source of the finding.
version (string) --
The CVSS version that generated the score.
score (float) --
The CVSS score.
scoringVector (string) --
A vector that measures the severity of the vulnerability.
adjustments (list) --
An object that contains details about an adjustment that Amazon Inspector made to the CVSS score for the finding.
(dict) --
Details about an adjustment that Amazon Inspector made to the CVSS score for a finding.
metric (string) --
The metric that Amazon Inspector used to adjust the CVSS score.
reason (string) --
The reason for the CVSS score adjustment.
packageVulnerabilityDetails (dict) --
An object that contains the details of a package vulnerability finding.
vulnerabilityId (string) --
A unique identifier for this vulnerability.
vulnerablePackages (list) --
The packages that this vulnerability impacts.
(dict) --
Information about a vulnerable package that Amazon Inspector identifies in a finding.
name (string) --
The name of the vulnerable package.
version (string) --
The version of the vulnerable package.
sourceLayerHash (string) --
The source layer hash of the vulnerable package.
epoch (integer) --
The epoch of the vulnerable package.
release (string) --
The release of the vulnerable package.
arch (string) --
The architecture of the vulnerable package.
packageManager (string) --
The package manager of the vulnerable package.
filePath (string) --
The file path of the vulnerable package.
fixedInVersion (string) --
The version of the package that contains the vulnerability fix.
remediation (string) --
The code to run in your environment to update packages with a fix available.
source (string) --
The source of the vulnerability information.
cvss (list) --
CVSS scores for one or more vulnerabilities that Amazon Inspector identified for a package.
(dict) --
Amazon Inspector generates a risk score for each finding. This score helps you to prioritize findings, to focus on the most critical findings and the most vulnerable resources. The score uses the Common Vulnerability Scoring System (CVSS) format. This format is a modification of the base CVSS score that the National Vulnerability Database (NVD) provides. For more information about severity levels, see Severity levels for Amazon Inspector findings in the Amazon Inspector User Guide .
baseScore (float) --
The CVSS base score.
scoringVector (string) --
The vector string of the CVSS score.
version (string) --
The CVSS version that generated the score.
source (string) --
The source of the CVSS score.
relatedVulnerabilities (list) --
Vulnerabilities that are often related to the findings for the package.
(string) --
sourceUrl (string) --
A link to the source of the vulnerability information.
vendorSeverity (string) --
The severity that the vendor assigned to this vulnerability type.
vendorCreatedAt (datetime) --
The date and time when this vulnerability was first added to the vendor's database.
vendorUpdatedAt (datetime) --
The date and time when the vendor last updated this vulnerability in their database.
referenceUrls (list) --
Links to web pages that contain details about the vulnerabilities that Amazon Inspector identified for the package.
(string) --
fixAvailable (string) --
Details about whether a fix is available for any of the packages that are identified in the finding through a version update.
nextToken (string) --
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
{'imageScanningConfiguration': {'ecrConfiguration': {'containerTags': ['string'],
'repositoryName': 'string'},
'imageScanningEnabled': 'boolean'}}
Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.
See also: AWS API Documentation
Request Syntax
client.create_image(
imageRecipeArn='string',
containerRecipeArn='string',
distributionConfigurationArn='string',
infrastructureConfigurationArn='string',
imageTestsConfiguration={
'imageTestsEnabled': True|False,
'timeoutMinutes': 123
},
enhancedImageMetadataEnabled=True|False,
tags={
'string': 'string'
},
clientToken='string',
imageScanningConfiguration={
'imageScanningEnabled': True|False,
'ecrConfiguration': {
'repositoryName': 'string',
'containerTags': [
'string',
]
}
}
)
string
The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
string
The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
string
The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
dict
The image tests configuration of the image.
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.
Note
The timeoutMinutes attribute is not currently active. This value is ignored.
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 tags of the image.
(string) --
(string) --
string
[REQUIRED]
The idempotency token used to make this request idempotent.
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 &INS; scans. Tags can help you identify and manage your scanned images.
(string) --
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'imageBuildVersionArn': 'string'
}
Response Structure
(dict) --
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 this request created.
{'imageScanningConfiguration': {'ecrConfiguration': {'containerTags': ['string'],
'repositoryName': 'string'},
'imageScanningEnabled': 'boolean'}}
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'
},
status='DISABLED'|'ENABLED',
tags={
'string': 'string'
},
clientToken='string',
imageScanningConfiguration={
'imageScanningEnabled': True|False,
'ecrConfiguration': {
'repositoryName': 'string',
'containerTags': [
'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.
Note
The timeoutMinutes attribute is not currently active. This value is ignored.
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 condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE , and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY , it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference .
string
The status of the image pipeline.
dict
The tags of the image pipeline.
(string) --
(string) --
string
[REQUIRED]
The idempotency token used to make this request idempotent.
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 &INS; scans. Tags can help you identify and manage your scanned images.
(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 idempotency token used to make this request idempotent.
imagePipelineArn (string) --
The Amazon Resource Name (ARN) of the image pipeline that was created by this request.
{'image': {'imageScanningConfiguration': {'ecrConfiguration': {'containerTags': ['string'],
'repositoryName': 'string'},
'imageScanningEnabled': 'boolean'},
'scanState': {'reason': 'string',
'status': 'PENDING | SCANNING | COLLECTING | '
'COMPLETED | ABANDONED | FAILED | '
'TIMED_OUT'}}}
Gets an image.
See also: AWS API Documentation
Request Syntax
client.get_image(
imageBuildVersionArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image that you want to get.
dict
Response Syntax
{
'requestId': 'string',
'image': {
'arn': 'string',
'type': 'AMI'|'DOCKER',
'name': 'string',
'version': 'string',
'platform': 'Windows'|'Linux',
'enhancedImageMetadataEnabled': True|False,
'osVersion': 'string',
'state': {
'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED',
'reason': 'string'
},
'imageRecipe': {
'arn': 'string',
'type': 'AMI'|'DOCKER',
'name': 'string',
'description': 'string',
'platform': 'Windows'|'Linux',
'owner': 'string',
'version': 'string',
'components': [
{
'componentArn': 'string',
'parameters': [
{
'name': 'string',
'value': [
'string',
]
},
]
},
],
'parentImage': 'string',
'blockDeviceMappings': [
{
'deviceName': 'string',
'ebs': {
'encrypted': True|False,
'deleteOnTermination': True|False,
'iops': 123,
'kmsKeyId': 'string',
'snapshotId': 'string',
'volumeSize': 123,
'volumeType': 'standard'|'io1'|'io2'|'gp2'|'gp3'|'sc1'|'st1',
'throughput': 123
},
'virtualName': 'string',
'noDevice': 'string'
},
],
'dateCreated': 'string',
'tags': {
'string': 'string'
},
'workingDirectory': 'string',
'additionalInstanceConfiguration': {
'systemsManagerAgent': {
'uninstallAfterBuild': True|False
},
'userDataOverride': 'string'
}
},
'containerRecipe': {
'arn': 'string',
'containerType': 'DOCKER',
'name': 'string',
'description': 'string',
'platform': 'Windows'|'Linux',
'owner': 'string',
'version': 'string',
'components': [
{
'componentArn': 'string',
'parameters': [
{
'name': 'string',
'value': [
'string',
]
},
]
},
],
'instanceConfiguration': {
'image': 'string',
'blockDeviceMappings': [
{
'deviceName': 'string',
'ebs': {
'encrypted': True|False,
'deleteOnTermination': True|False,
'iops': 123,
'kmsKeyId': 'string',
'snapshotId': 'string',
'volumeSize': 123,
'volumeType': 'standard'|'io1'|'io2'|'gp2'|'gp3'|'sc1'|'st1',
'throughput': 123
},
'virtualName': 'string',
'noDevice': 'string'
},
]
},
'dockerfileTemplateData': 'string',
'kmsKeyId': 'string',
'encrypted': True|False,
'parentImage': 'string',
'dateCreated': 'string',
'tags': {
'string': 'string'
},
'workingDirectory': 'string',
'targetRepository': {
'service': 'ECR',
'repositoryName': 'string'
}
},
'sourcePipelineName': 'string',
'sourcePipelineArn': 'string',
'infrastructureConfiguration': {
'arn': 'string',
'name': 'string',
'description': 'string',
'instanceTypes': [
'string',
],
'instanceProfileName': 'string',
'securityGroupIds': [
'string',
],
'subnetId': 'string',
'logging': {
's3Logs': {
's3BucketName': 'string',
's3KeyPrefix': 'string'
}
},
'keyPair': 'string',
'terminateInstanceOnFailure': True|False,
'snsTopicArn': 'string',
'dateCreated': 'string',
'dateUpdated': 'string',
'resourceTags': {
'string': 'string'
},
'instanceMetadataOptions': {
'httpTokens': 'string',
'httpPutResponseHopLimit': 123
},
'tags': {
'string': 'string'
}
},
'distributionConfiguration': {
'arn': 'string',
'name': 'string',
'description': 'string',
'distributions': [
{
'region': 'string',
'amiDistributionConfiguration': {
'name': 'string',
'description': 'string',
'targetAccountIds': [
'string',
],
'amiTags': {
'string': 'string'
},
'kmsKeyId': 'string',
'launchPermission': {
'userIds': [
'string',
],
'userGroups': [
'string',
],
'organizationArns': [
'string',
],
'organizationalUnitArns': [
'string',
]
}
},
'containerDistributionConfiguration': {
'description': 'string',
'containerTags': [
'string',
],
'targetRepository': {
'service': 'ECR',
'repositoryName': 'string'
}
},
'licenseConfigurationArns': [
'string',
],
'launchTemplateConfigurations': [
{
'launchTemplateId': 'string',
'accountId': 'string',
'setDefaultVersion': True|False
},
],
's3ExportConfiguration': {
'roleName': 'string',
'diskImageFormat': 'VMDK'|'RAW'|'VHD',
's3Bucket': 'string',
's3Prefix': 'string'
},
'fastLaunchConfigurations': [
{
'enabled': True|False,
'snapshotConfiguration': {
'targetResourceCount': 123
},
'maxParallelLaunches': 123,
'launchTemplate': {
'launchTemplateId': 'string',
'launchTemplateName': 'string',
'launchTemplateVersion': 'string'
},
'accountId': 'string'
},
]
},
],
'timeoutMinutes': 123,
'dateCreated': 'string',
'dateUpdated': 'string',
'tags': {
'string': 'string'
}
},
'imageTestsConfiguration': {
'imageTestsEnabled': True|False,
'timeoutMinutes': 123
},
'dateCreated': 'string',
'outputResources': {
'amis': [
{
'region': 'string',
'image': 'string',
'name': 'string',
'description': 'string',
'state': {
'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED',
'reason': 'string'
},
'accountId': 'string'
},
],
'containers': [
{
'region': 'string',
'imageUris': [
'string',
]
},
]
},
'tags': {
'string': 'string'
},
'buildType': 'USER_INITIATED'|'SCHEDULED'|'IMPORT',
'imageSource': 'AMAZON_MANAGED'|'AWS_MARKETPLACE'|'IMPORTED'|'CUSTOM',
'scanState': {
'status': 'PENDING'|'SCANNING'|'COLLECTING'|'COMPLETED'|'ABANDONED'|'FAILED'|'TIMED_OUT',
'reason': 'string'
},
'imageScanningConfiguration': {
'imageScanningEnabled': True|False,
'ecrConfiguration': {
'repositoryName': 'string',
'containerTags': [
'string',
]
}
}
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
image (dict) --
The image object.
arn (string) --
The Amazon Resource Name (ARN) of the image.
Note
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
type (string) --
Specifies whether this image produces an AMI or a container image.
name (string) --
The name of the image.
version (string) --
The semantic version of the image.
Note
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
platform (string) --
The image operating system platform, such as Linux or Windows.
enhancedImageMetadataEnabled (boolean) --
Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
osVersion (string) --
The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
state (dict) --
The state of the image.
status (string) --
The status of the image.
reason (string) --
The reason for the status of the image.
imageRecipe (dict) --
For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.
arn (string) --
The Amazon Resource Name (ARN) of the image recipe.
type (string) --
Specifies which type of image is created by the recipe - an AMI or a container image.
name (string) --
The name of the image recipe.
description (string) --
The description of the image recipe.
platform (string) --
The platform of the image recipe.
owner (string) --
The owner of the image recipe.
version (string) --
The version of the image recipe.
components (list) --
The components that are included in the image recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
(dict) --
Configuration details of the component.
componentArn (string) --
The Amazon Resource Name (ARN) of the component.
parameters (list) --
A group of parameter settings that Image Builder uses to configure the component for a specific recipe.
(dict) --
Contains a key/value pair that sets the named component parameter.
name (string) --
The name of the component parameter to set.
value (list) --
Sets the value for the named component parameter.
(string) --
parentImage (string) --
The base image of the image recipe.
blockDeviceMappings (list) --
The block device mappings to apply when creating images from this recipe.
(dict) --
Defines block device mappings for the instance used to configure your image.
deviceName (string) --
The device to which these mappings apply.
ebs (dict) --
Use to manage Amazon EBS-specific configuration for this mapping.
encrypted (boolean) --
Use to configure device encryption.
deleteOnTermination (boolean) --
Use to configure delete on termination of the associated device.
iops (integer) --
Use to configure device IOPS.
kmsKeyId (string) --
Use to configure the KMS key to use when encrypting the device.
snapshotId (string) --
The snapshot that defines the device contents.
volumeSize (integer) --
Use to override the device's volume size.
volumeType (string) --
Use to override the device's volume type.
throughput (integer) --
For GP3 volumes only – The throughput in MiB/s that the volume supports.
virtualName (string) --
Use to manage instance ephemeral devices.
noDevice (string) --
Use to remove a mapping from the base image.
dateCreated (string) --
The date on which this image recipe was created.
tags (dict) --
The tags of the image recipe.
(string) --
(string) --
workingDirectory (string) --
The working directory to be used during build and test workflows.
additionalInstanceConfiguration (dict) --
Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.
systemsManagerAgent (dict) --
Contains settings for the Systems Manager agent on your build instance.
uninstallAfterBuild (boolean) --
Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
userDataOverride (string) --
Use this property to provide commands or a command script to run when you launch your build instance.
The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.
Note
The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$ :
#!/bin/bash
mkdir -p /var/bb/
touch /var
containerRecipe (dict) --
For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.
arn (string) --
The Amazon Resource Name (ARN) of the container recipe.
Note
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
containerType (string) --
Specifies the type of container, such as Docker.
name (string) --
The name of the container recipe.
description (string) --
The description of the container recipe.
platform (string) --
The system platform for the container, such as Windows or Linux.
owner (string) --
The owner of the container recipe.
version (string) --
The semantic version of the container recipe.
Note
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
components (list) --
Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
(dict) --
Configuration details of the component.
componentArn (string) --
The Amazon Resource Name (ARN) of the component.
parameters (list) --
A group of parameter settings that Image Builder uses to configure the component for a specific recipe.
(dict) --
Contains a key/value pair that sets the named component parameter.
name (string) --
The name of the component parameter to set.
value (list) --
Sets the value for the named component parameter.
(string) --
instanceConfiguration (dict) --
A group of options that can be used to configure an instance for building and testing container images.
image (string) --
The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.
blockDeviceMappings (list) --
Defines the block devices to attach for building an instance from this Image Builder AMI.
(dict) --
Defines block device mappings for the instance used to configure your image.
deviceName (string) --
The device to which these mappings apply.
ebs (dict) --
Use to manage Amazon EBS-specific configuration for this mapping.
encrypted (boolean) --
Use to configure device encryption.
deleteOnTermination (boolean) --
Use to configure delete on termination of the associated device.
iops (integer) --
Use to configure device IOPS.
kmsKeyId (string) --
Use to configure the KMS key to use when encrypting the device.
snapshotId (string) --
The snapshot that defines the device contents.
volumeSize (integer) --
Use to override the device's volume size.
volumeType (string) --
Use to override the device's volume type.
throughput (integer) --
For GP3 volumes only – The throughput in MiB/s that the volume supports.
virtualName (string) --
Use to manage instance ephemeral devices.
noDevice (string) --
Use to remove a mapping from the base image.
dockerfileTemplateData (string) --
Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
kmsKeyId (string) --
Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
encrypted (boolean) --
A flag that indicates if the target container is encrypted.
parentImage (string) --
The base image for the container recipe.
dateCreated (string) --
The date when this container recipe was created.
tags (dict) --
Tags that are attached to the container recipe.
(string) --
(string) --
workingDirectory (string) --
The working directory for use during build and test workflows.
targetRepository (dict) --
The destination repository for the container image.
service (string) --
Specifies the service in which this image was registered.
repositoryName (string) --
The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
sourcePipelineName (string) --
The name of the image pipeline that created this image.
sourcePipelineArn (string) --
The Amazon Resource Name (ARN) of the image pipeline that created this image.
infrastructureConfiguration (dict) --
The infrastructure that Image Builder used to create this image.
arn (string) --
The Amazon Resource Name (ARN) of the infrastructure configuration.
name (string) --
The name of the infrastructure configuration.
description (string) --
The description of the infrastructure configuration.
instanceTypes (list) --
The instance types of the infrastructure configuration.
(string) --
instanceProfileName (string) --
The instance profile of the infrastructure configuration.
securityGroupIds (list) --
The security group IDs of the infrastructure configuration.
(string) --
subnetId (string) --
The subnet ID of the infrastructure configuration.
logging (dict) --
The logging configuration of the infrastructure configuration.
s3Logs (dict) --
The Amazon S3 logging configuration.
s3BucketName (string) --
The S3 bucket in which to store the logs.
s3KeyPrefix (string) --
The Amazon S3 path to the bucket where the logs are stored.
keyPair (string) --
The Amazon EC2 key pair of the infrastructure configuration.
terminateInstanceOnFailure (boolean) --
The terminate instance on failure configuration of the infrastructure configuration.
snsTopicArn (string) --
The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
Note
EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.
dateCreated (string) --
The date on which the infrastructure configuration was created.
dateUpdated (string) --
The date on which the infrastructure configuration was last updated.
resourceTags (dict) --
The tags attached to the resource created by Image Builder.
(string) --
(string) --
instanceMetadataOptions (dict) --
The instance metadata option settings for the infrastructure configuration.
httpTokens (string) --
Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:
required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.
optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.
The default setting is optional .
httpPutResponseHopLimit (integer) --
Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.
tags (dict) --
The tags of the infrastructure configuration.
(string) --
(string) --
distributionConfiguration (dict) --
The distribution configuration that Image Builder used to create this image.
arn (string) --
The Amazon Resource Name (ARN) of the distribution configuration.
name (string) --
The name of the distribution configuration.
description (string) --
The description of the distribution configuration.
distributions (list) --
The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions.
(dict) --
Defines the settings for a specific Region.
region (string) --
The target Region.
amiDistributionConfiguration (dict) --
The specific AMI settings; for example, launch permissions or AMI tags.
name (string) --
The name of the output AMI.
description (string) --
The description of the AMI distribution configuration. Minimum and maximum length are in characters.
targetAccountIds (list) --
The ID of an account to which you want to distribute an image.
(string) --
amiTags (dict) --
The tags to apply to AMIs distributed to this Region.
(string) --
(string) --
kmsKeyId (string) --
The KMS key identifier used to encrypt the distributed image.
launchPermission (dict) --
Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
userIds (list) --
The Amazon Web Services account ID.
(string) --
userGroups (list) --
The name of the group.
(string) --
organizationArns (list) --
The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?.
(string) --
organizationalUnitArns (list) --
The ARN for an Organizations organizational unit (OU) that you want to share your AMI with. For more information about key concepts for Organizations, see Organizations terminology and concepts.
(string) --
containerDistributionConfiguration (dict) --
Container distribution settings for encryption, licensing, and sharing in a specific Region.
description (string) --
The description of the container distribution configuration.
containerTags (list) --
Tags that are attached to the container distribution configuration.
(string) --
targetRepository (dict) --
The destination repository for the container distribution configuration.
service (string) --
Specifies the service in which this image was registered.
repositoryName (string) --
The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
licenseConfigurationArns (list) --
The License Manager Configuration to associate with the AMI in the specified Region.
(string) --
launchTemplateConfigurations (list) --
A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.
(dict) --
Identifies an Amazon EC2 launch template to use for a specific account.
launchTemplateId (string) --
Identifies the Amazon EC2 launch template to use.
accountId (string) --
The account ID that this configuration applies to.
setDefaultVersion (boolean) --
Set the specified Amazon EC2 launch template as the default launch template for the specified account.
s3ExportConfiguration (dict) --
Configure export settings to deliver disk images created from your image build, using a file format that is compatible with your VMs in that Region.
roleName (string) --
The name of the role that grants VM Import/Export permission to export images to your S3 bucket.
diskImageFormat (string) --
Export the updated image to one of the following supported disk image formats:
Virtual Hard Disk (VHD) – Compatible with Citrix Xen and Microsoft Hyper-V virtualization products.
Stream-optimized ESX Virtual Machine Disk (VMDK) – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6.
Raw – Raw format.
s3Bucket (string) --
The S3 bucket in which to store the output disk images for your VM.
s3Prefix (string) --
The Amazon S3 path for the bucket where the output disk images for your VM are stored.
fastLaunchConfigurations (list) --
The Windows faster-launching configurations to use for AMI distribution.
(dict) --
Define and configure faster launching for output Windows AMIs.
enabled (boolean) --
A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.
snapshotConfiguration (dict) --
Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.
targetResourceCount (integer) --
The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
maxParallelLaunches (integer) --
The maximum number of parallel instances that are launched for creating resources.
launchTemplate (dict) --
The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
launchTemplateId (string) --
The ID of the launch template to use for faster launching for a Windows AMI.
launchTemplateName (string) --
The name of the launch template to use for faster launching for a Windows AMI.
launchTemplateVersion (string) --
The version of the launch template to use for faster launching for a Windows AMI.
accountId (string) --
The owner account ID for the fast-launch enabled Windows AMI.
timeoutMinutes (integer) --
The maximum duration in minutes for this distribution configuration.
dateCreated (string) --
The date on which this distribution configuration was created.
dateUpdated (string) --
The date on which this distribution configuration was last updated.
tags (dict) --
The tags of the distribution configuration.
(string) --
(string) --
imageTestsConfiguration (dict) --
The image tests that ran when that Image Builder created this image.
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.
Note
The timeoutMinutes attribute is not currently active. This value is ignored.
dateCreated (string) --
The date on which Image Builder created this image.
outputResources (dict) --
The output resources that Image Builder produces for this image.
amis (list) --
The Amazon EC2 AMIs created by this image.
(dict) --
Details of an Amazon EC2 AMI.
region (string) --
The Amazon Web Services Region of the Amazon EC2 AMI.
image (string) --
The AMI ID of the Amazon EC2 AMI.
name (string) --
The name of the Amazon EC2 AMI.
description (string) --
The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.
state (dict) --
Image status and the reason for that status.
status (string) --
The status of the image.
reason (string) --
The reason for the status of the image.
accountId (string) --
The account ID of the owner of the AMI.
containers (list) --
Container images that the pipeline has generated and stored in the output repository.
(dict) --
A container encapsulates the runtime environment for an application.
region (string) --
Containers and container images are Region-specific. This is the Region context for the container.
imageUris (list) --
A list of URIs for containers created in the context Region.
(string) --
tags (dict) --
The tags that apply to this image.
(string) --
(string) --
buildType (string) --
Indicates the type of build that created this image. The build can be initiated in the following ways:
USER_INITIATED – A manual pipeline build request.
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
IMPORT – A VM import created the image to use as the base image for the recipe.
imageSource (string) --
The origin of the base image that Image Builder used to build this image.
scanState (dict) --
Contains information about the current state of scans for this image.
status (string) --
The current state of vulnerability scans for the image.
reason (string) --
The reason for the scan status for the image.
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 &INS; scans. Tags can help you identify and manage your scanned images.
(string) --
{'imagePipeline': {'imageScanningConfiguration': {'ecrConfiguration': {'containerTags': ['string'],
'repositoryName': 'string'},
'imageScanningEnabled': 'boolean'}}}
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',
'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'
},
'status': 'DISABLED'|'ENABLED',
'dateCreated': 'string',
'dateUpdated': 'string',
'dateLastRun': 'string',
'dateNextRun': 'string',
'tags': {
'string': 'string'
},
'imageScanningConfiguration': {
'imageScanningEnabled': True|False,
'ecrConfiguration': {
'repositoryName': 'string',
'containerTags': [
'string',
]
}
}
}
}
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.
Note
The timeoutMinutes attribute is not currently active. This value is ignored.
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 condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE , and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY , it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference .
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.
dateNextRun (string) --
This is no longer supported, and does not return a value.
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 &INS; scans. Tags can help you identify and manage your scanned images.
(string) --
{'imagePipelineList': {'imageScanningConfiguration': {'ecrConfiguration': {'containerTags': ['string'],
'repositoryName': 'string'},
'imageScanningEnabled': 'boolean'}}}
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
The maximum 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',
'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'
},
'status': 'DISABLED'|'ENABLED',
'dateCreated': 'string',
'dateUpdated': 'string',
'dateLastRun': 'string',
'dateNextRun': 'string',
'tags': {
'string': 'string'
},
'imageScanningConfiguration': {
'imageScanningEnabled': True|False,
'ecrConfiguration': {
'repositoryName': 'string',
'containerTags': [
'string',
]
}
}
},
],
'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.
Note
The timeoutMinutes attribute is not currently active. This value is ignored.
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 condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE , and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY , it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference .
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.
dateNextRun (string) --
This is no longer supported, and does not return a value.
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 &INS; scans. Tags can help you identify and manage your scanned images.
(string) --
nextToken (string) --
The next token used for paginated responses. When this field isn't empty, there are additional elements that the service has'ot included in this request. Use this token with the next request to retrieve additional objects.
{'imageScanningConfiguration': {'ecrConfiguration': {'containerTags': ['string'],
'repositoryName': 'string'},
'imageScanningEnabled': 'boolean'}}
Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images.
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.
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'
},
status='DISABLED'|'ENABLED',
clientToken='string',
imageScanningConfiguration={
'imageScanningEnabled': True|False,
'ecrConfiguration': {
'repositoryName': 'string',
'containerTags': [
'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.
Note
The timeoutMinutes attribute is not currently active. This value is ignored.
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 condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE , and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY , it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference .
string
The status of the image pipeline.
string
[REQUIRED]
The idempotency token used to make this request idempotent.
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 &INS; scans. Tags can help you identify and manage your scanned images.
(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 idempotency token used to make this request idempotent.
imagePipelineArn (string) --
The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.