2025/11/20 - EC2 Image Builder - 2 new 11 updated api methods
Changes EC2 Image Builder now enables the distribution of existing AMIs, retry distribution, and define distribution workflows. It also supports automatic versioning for recipes and components, allowing automatic version increments and dynamic referencing in pipelines.
DistributeImage distributes existing AMIs to additional regions and accounts without rebuilding the image.
See also: AWS API Documentation
Request Syntax
client.distribute_image(
sourceImage='string',
distributionConfigurationArn='string',
executionRole='string',
tags={
'string': 'string'
},
clientToken='string',
loggingConfiguration={
'logGroupName': 'string'
}
)
string
[REQUIRED]
The source image Amazon Resource Name (ARN) to distribute.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the distribution configuration to use.
string
[REQUIRED]
The IAM role to use for the distribution.
dict
The tags to apply to the distributed image.
(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
The logging configuration for the distribution.
logGroupName (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.
dict
Response Syntax
{
'clientToken': 'string',
'imageBuildVersionArn': 'string'
}
Response Structure
(dict) --
clientToken (string) --
The client token that uniquely identifies the request.
imageBuildVersionArn (string) --
The Amazon Resource Name (ARN) of the image to be distributed.
RetryImage retries an image distribution without rebuilding the image.
See also: AWS API Documentation
Request Syntax
client.retry_image(
imageBuildVersionArn='string',
clientToken='string'
)
string
[REQUIRED]
The source image Amazon Resource Name (ARN) to retry.
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
Response Syntax
{
'clientToken': 'string',
'imageBuildVersionArn': 'string'
}
Response Structure
(dict) --
clientToken (string) --
The client token that uniquely identifies the request.
imageBuildVersionArn (string) --
The ARN of the image to be retried.
{'dryRun': 'boolean'}
Response {'latestVersionReferences': {'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string',
'latestVersionArn': 'string'}}
Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods:
Inline, using the data property in the request body.
A URL that points to a YAML document file stored in Amazon S3, using the uri property in the request body.
See also: AWS API Documentation
Request Syntax
client.create_component(
name='string',
semanticVersion='string',
description='string',
changeDescription='string',
platform='Windows'|'Linux'|'macOS',
supportedOsVersions=[
'string',
],
data='string',
uri='string',
kmsKeyId='string',
tags={
'string': 'string'
},
clientToken='string',
dryRun=True|False
)
string
[REQUIRED]
The name of the component.
string
[REQUIRED]
The semantic version of the component. This version follows the semantic version syntax.
string
Describes the contents of the component.
string
The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.
string
[REQUIRED]
The operating system platform of the component.
list
The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
(string) --
string
Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
string
The uri of a YAML component document file. This must be an S3 URL ( s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.
string
The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
dict
The tags that apply to the component.
(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.
boolean
Validates the required permissions for the operation and the request parameters, without actually making the request, and provides an error response. Upon a successful request, the error response is DryRunOperationException.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'componentBuildVersionArn': 'string',
'latestVersionReferences': {
'latestVersionArn': 'string',
'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string'
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
clientToken (string) --
The client token that uniquely identifies the request.
componentBuildVersionArn (string) --
The Amazon Resource Name (ARN) of the component that the request created.
latestVersionReferences (dict) --
The resource ARNs with different wildcard variations of semantic versioning.
latestVersionArn (string) --
The latest version Amazon Resource Name (ARN) of the Image Builder resource.
latestMajorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.
latestMinorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.
latestPatchVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.
{'latestVersionReferences': {'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string',
'latestVersionArn': 'string'}}
Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.
See also: AWS API Documentation
Request Syntax
client.create_container_recipe(
containerType='DOCKER',
name='string',
description='string',
semanticVersion='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',
dockerfileTemplateUri='string',
platformOverride='Windows'|'Linux'|'macOS',
imageOsVersionOverride='string',
parentImage='string',
tags={
'string': 'string'
},
workingDirectory='string',
targetRepository={
'service': 'ECR',
'repositoryName': 'string'
},
kmsKeyId='string',
clientToken='string'
)
string
[REQUIRED]
The type of container to create.
string
[REQUIRED]
The name of the container recipe.
string
The description of the container recipe.
string
[REQUIRED]
The semantic version of the container recipe. This version follows the semantic version syntax.
list
The components included in the container recipe.
(dict) --
Configuration details of the component.
componentArn (string) -- [REQUIRED]
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) -- [REQUIRED]
The name of the component parameter to set.
value (list) -- [REQUIRED]
Sets the value for the named component parameter.
(string) --
dict
A group of options that can be used to configure an instance for building and testing container images.
image (string) --
The base image for a container build and test instance. This can contain an AMI ID or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.
If not specified, Image Builder uses 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) --
The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
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.
string
The Dockerfile template used to build your image as an inline data blob.
string
The Amazon S3 URI for the Dockerfile that will be used to build your container image.
string
Specifies the operating system platform when you use a custom base image.
string
Specifies the operating system version for the base image.
string
[REQUIRED]
The base image for the container recipe.
dict
Tags that are attached to the container recipe.
(string) --
(string) --
string
The working directory for use during build and test workflows.
dict
[REQUIRED]
The destination repository for the container image.
service (string) -- [REQUIRED]
Specifies the service in which this image was registered.
repositoryName (string) -- [REQUIRED]
The name of the container repository where the output container image is stored. This name is prefixed by the repository location. For example, <repository location url>/repository_name.
string
The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the Dockerfile template. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
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
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'containerRecipeArn': 'string',
'latestVersionReferences': {
'latestVersionArn': 'string',
'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string'
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
clientToken (string) --
The client token that uniquely identifies the request.
containerRecipeArn (string) --
Returns the Amazon Resource Name (ARN) of the container recipe that the request created.
latestVersionReferences (dict) --
The resource ARNs with different wildcard variations of semantic versioning.
latestVersionArn (string) --
The latest version Amazon Resource Name (ARN) of the Image Builder resource.
latestMajorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.
latestMinorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.
latestPatchVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.
{'latestVersionReferences': {'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string',
'latestVersionArn': 'string'}}
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',
]
}
},
workflows=[
{
'workflowArn': 'string',
'parameters': [
{
'name': 'string',
'value': [
'string',
]
},
],
'parallelGroup': 'string',
'onFailure': 'CONTINUE'|'ABORT'
},
],
executionRole='string',
loggingConfiguration={
'logGroupName': '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.
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]
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.
logGroupName (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.
dict
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'imageBuildVersionArn': 'string',
'latestVersionReferences': {
'latestVersionArn': 'string',
'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string'
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
clientToken (string) --
The client token that uniquely identifies the request.
imageBuildVersionArn (string) --
The Amazon Resource Name (ARN) of the image that the request created.
latestVersionReferences (dict) --
The resource ARNs with different wildcard variations of semantic versioning.
latestVersionArn (string) --
The latest version Amazon Resource Name (ARN) of the Image Builder resource.
latestMajorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.
latestMinorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.
latestPatchVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.
{'latestVersionReferences': {'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string',
'latestVersionArn': 'string'}}
Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.
See also: AWS API Documentation
Request Syntax
client.create_image_recipe(
name='string',
description='string',
semanticVersion='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'
},
],
tags={
'string': 'string'
},
workingDirectory='string',
additionalInstanceConfiguration={
'systemsManagerAgent': {
'uninstallAfterBuild': True|False
},
'userDataOverride': 'string'
},
amiTags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The name of the image recipe.
string
The description of the image recipe.
string
[REQUIRED]
The semantic version of the image recipe. This version follows the semantic version syntax.
list
The components included in the image recipe.
(dict) --
Configuration details of the component.
componentArn (string) -- [REQUIRED]
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) -- [REQUIRED]
The name of the component parameter to set.
value (list) -- [REQUIRED]
Sets the value for the named component parameter.
(string) --
string
[REQUIRED]
The base image for customizations specified in the image recipe. You can specify the parent image using one of the following options:
AMI ID
Image Builder image Amazon Resource Name (ARN)
Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.
Amazon Web Services Marketplace product ID
If you enter an AMI ID or an SSM parameter that contains the AMI ID, you must have access to the AMI, and the AMI must be in the source Region.
list
The block device mappings of the image 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) --
The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
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.
dict
The tags of the image recipe.
(string) --
(string) --
string
The working directory used during build and test workflows.
dict
Specify additional settings and launch scripts for your build instances.
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. default value is false.
The default behavior of uninstallAfterBuild is to remove the SSM Agent if it was installed by EC2 Image Builder
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.
dict
Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.
(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
Response Syntax
{
'requestId': 'string',
'clientToken': 'string',
'imageRecipeArn': 'string',
'latestVersionReferences': {
'latestVersionArn': 'string',
'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string'
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
clientToken (string) --
The client token that uniquely identifies the request.
imageRecipeArn (string) --
The Amazon Resource Name (ARN) of the image recipe that was created by this request.
latestVersionReferences (dict) --
The resource ARNs with different wildcard variations of semantic versioning.
latestVersionArn (string) --
The latest version Amazon Resource Name (ARN) of the Image Builder resource.
latestMajorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.
latestMinorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.
latestPatchVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.
{'dryRun': 'boolean'}
Response {'latestVersionReferences': {'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string',
'latestVersionArn': 'string'}}
Create a new workflow or a new version of an existing workflow.
See also: AWS API Documentation
Request Syntax
client.create_workflow(
name='string',
semanticVersion='string',
description='string',
changeDescription='string',
data='string',
uri='string',
kmsKeyId='string',
tags={
'string': 'string'
},
clientToken='string',
type='BUILD'|'TEST'|'DISTRIBUTION',
dryRun=True|False
)
string
[REQUIRED]
The name of the workflow to create.
string
[REQUIRED]
The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.
string
Describes the workflow.
string
Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.
string
Contains the UTF-8 encoded YAML document content for the workflow. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
string
The uri of a YAML component document file. This must be an S3 URL ( s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.
string
The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this workflow resource. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
dict
Tags that apply to the workflow resource.
(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.
string
[REQUIRED]
The phase in the image build process for which the workflow resource is responsible.
boolean
Validates the required permissions for the operation and the request parameters, without actually making the request, and provides an error response. Upon a successful request, the error response is DryRunOperationException.
dict
Response Syntax
{
'clientToken': 'string',
'workflowBuildVersionArn': 'string',
'latestVersionReferences': {
'latestVersionArn': 'string',
'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string'
}
}
Response Structure
(dict) --
clientToken (string) --
The client token that uniquely identifies the request.
workflowBuildVersionArn (string) --
The Amazon Resource Name (ARN) of the workflow resource that the request created.
latestVersionReferences (dict) --
The resource ARNs with different wildcard variations of semantic versioning.
latestVersionArn (string) --
The latest version Amazon Resource Name (ARN) of the Image Builder resource.
latestMajorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.
latestMinorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.
latestPatchVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.
{'latestVersionReferences': {'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string',
'latestVersionArn': 'string'}}
Gets a component object.
See also: AWS API Documentation
Request Syntax
client.get_component(
componentBuildVersionArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the component that you want to get. Regex requires the suffix /\d+$.
dict
Response Syntax
{
'requestId': 'string',
'component': {
'arn': 'string',
'name': 'string',
'version': 'string',
'description': 'string',
'changeDescription': 'string',
'type': 'BUILD'|'TEST',
'platform': 'Windows'|'Linux'|'macOS',
'supportedOsVersions': [
'string',
],
'state': {
'status': 'DEPRECATED'|'DISABLED'|'ACTIVE',
'reason': 'string'
},
'parameters': [
{
'name': 'string',
'type': 'string',
'defaultValue': [
'string',
],
'description': 'string'
},
],
'owner': 'string',
'data': 'string',
'kmsKeyId': 'string',
'encrypted': True|False,
'dateCreated': 'string',
'tags': {
'string': 'string'
},
'publisher': 'string',
'obfuscate': True|False,
'productCodes': [
{
'productCodeId': 'string',
'productCodeType': 'marketplace'
},
]
},
'latestVersionReferences': {
'latestVersionArn': 'string',
'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string'
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
component (dict) --
The component object specified in the request.
arn (string) --
The Amazon Resource Name (ARN) of the component.
name (string) --
The name of the component.
version (string) --
The version of the component.
description (string) --
The description of the component.
changeDescription (string) --
Describes what change has been made in this version of the component, or what makes this version different from other versions of the component.
type (string) --
The component type specifies whether Image Builder uses the component to build the image or only to test it.
platform (string) --
The operating system platform of the component.
supportedOsVersions (list) --
The operating system (OS) version supported by the component. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.
(string) --
state (dict) --
Describes the current status of the component.
status (string) --
The current state of the component.
reason (string) --
Describes how or why the component changed state.
parameters (list) --
Contains parameter details for each of the parameters that the component document defined for the component.
(dict) --
Defines a parameter that is used to provide configuration details for the component.
name (string) --
The name of this input parameter.
type (string) --
The type of input this parameter provides. The currently supported value is "string".
defaultValue (list) --
The default value of this parameter if no input is provided.
(string) --
description (string) --
Describes this parameter.
owner (string) --
The owner of the component.
data (string) --
Component data contains the YAML document content for the component.
kmsKeyId (string) --
The KMS key identifier used to encrypt the component. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
encrypted (boolean) --
The encryption status of the component.
dateCreated (string) --
The date that Image Builder created the component.
tags (dict) --
The tags that apply to the component.
(string) --
(string) --
publisher (string) --
Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
obfuscate (boolean) --
Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
productCodes (list) --
Contains product codes that are used for billing purposes for Amazon Web Services Marketplace components.
(dict) --
Information about a single product code.
productCodeId (string) --
For Amazon Web Services Marketplace components, this contains the product code ID that can be stamped onto an EC2 AMI to ensure that components are billed correctly. If this property is empty, it might mean that the component is not published.
productCodeType (string) --
The owner of the product code that's billed. If this property is empty, it might mean that the component is not published.
latestVersionReferences (dict) --
The resource ARNs with different wildcard variations of semantic versioning.
latestVersionArn (string) --
The latest version Amazon Resource Name (ARN) of the Image Builder resource.
latestMajorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.
latestMinorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.
latestPatchVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.
{'latestVersionReferences': {'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string',
'latestVersionArn': 'string'}}
Retrieves a container recipe.
See also: AWS API Documentation
Request Syntax
client.get_container_recipe(
containerRecipeArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the container recipe to retrieve.
dict
Response Syntax
{
'requestId': 'string',
'containerRecipe': {
'arn': 'string',
'containerType': 'DOCKER',
'name': 'string',
'description': 'string',
'platform': 'Windows'|'Linux'|'macOS',
'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'
}
},
'latestVersionReferences': {
'latestVersionArn': 'string',
'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string'
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
containerRecipe (dict) --
The container recipe object that is returned.
arn (string) --
The Amazon Resource Name (ARN) of the container recipe.
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.
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 base image for a container build and test instance. This can contain an AMI ID or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.
If not specified, Image Builder uses 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) --
The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
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) --
The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the container image for distribution to the target Region. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
encrypted (boolean) --
A flag that indicates if the target container is encrypted.
parentImage (string) --
The base image for customizations specified in the container recipe. This can contain an Image Builder image resource ARN or a container image URI, for example amazonlinux:latest.
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. For example, <repository location url>/repository_name.
latestVersionReferences (dict) --
The resource ARNs with different wildcard variations of semantic versioning.
latestVersionArn (string) --
The latest version Amazon Resource Name (ARN) of the Image Builder resource.
latestMajorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.
latestMinorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.
latestPatchVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.
{'latestVersionReferences': {'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string',
'latestVersionArn': 'string'}}
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'|'macOS',
'enhancedImageMetadataEnabled': True|False,
'osVersion': 'string',
'state': {
'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED',
'reason': 'string'
},
'imageRecipe': {
'arn': 'string',
'type': 'AMI'|'DOCKER',
'name': 'string',
'description': 'string',
'platform': 'Windows'|'Linux'|'macOS',
'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'
},
'amiTags': {
'string': 'string'
}
},
'containerRecipe': {
'arn': 'string',
'containerType': 'DOCKER',
'name': 'string',
'description': 'string',
'platform': 'Windows'|'Linux'|'macOS',
'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'
},
'placement': {
'availabilityZone': 'string',
'tenancy': 'default'|'dedicated'|'host',
'hostId': 'string',
'hostResourceGroupArn': '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'
},
],
'ssmParameterConfigurations': [
{
'amiAccountId': 'string',
'parameterName': 'string',
'dataType': 'text'|'aws:ec2:image'
},
]
},
],
'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'|'DISABLED',
'reason': 'string'
},
'accountId': 'string'
},
],
'containers': [
{
'region': 'string',
'imageUris': [
'string',
]
},
]
},
'tags': {
'string': 'string'
},
'buildType': 'USER_INITIATED'|'SCHEDULED'|'IMPORT'|'IMPORT_ISO',
'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',
]
}
},
'deprecationTime': datetime(2015, 1, 1),
'lifecycleExecutionId': 'string',
'executionRole': 'string',
'workflows': [
{
'workflowArn': 'string',
'parameters': [
{
'name': 'string',
'value': [
'string',
]
},
],
'parallelGroup': 'string',
'onFailure': 'CONTINUE'|'ABORT'
},
],
'loggingConfiguration': {
'logGroupName': 'string'
}
},
'latestVersionReferences': {
'latestVersionArn': 'string',
'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': '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.
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.
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 for customizations specified in the image recipe. You can specify the parent image using one of the following options:
AMI ID
Image Builder image Amazon Resource Name (ARN)
Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.
Amazon Web Services Marketplace product ID
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) --
The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
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. default value is false.
The default behavior of uninstallAfterBuild is to remove the SSM Agent if it was installed by EC2 Image Builder
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.
amiTags (dict) --
Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.
(string) --
(string) --
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.
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.
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 base image for a container build and test instance. This can contain an AMI ID or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.
If not specified, Image Builder uses 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) --
The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
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) --
The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the container image for distribution to the target Region. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
encrypted (boolean) --
A flag that indicates if the target container is encrypted.
parentImage (string) --
The base image for customizations specified in the container recipe. This can contain an Image Builder image resource ARN or a container image URI, for example amazonlinux:latest.
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. For example, <repository location url>/repository_name.
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.
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) --
placement (dict) --
The instance placement settings that define where the instances that are launched from your image will run.
availabilityZone (string) --
The Availability Zone where your build and test instances will launch.
tenancy (string) --
The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware. An instance with a tenancy of host runs on a Dedicated Host.
If tenancy is set to host, then you can optionally specify one target for placement – either host ID or host resource group ARN. If automatic placement is enabled for your host, and you don't specify any placement target, Amazon EC2 will try to find an available host for your build and test instances.
hostId (string) --
The ID of the Dedicated Host on which build and test instances run. This only applies if tenancy is host. If you specify the host ID, you must not specify the resource group ARN. If you specify both, Image Builder returns an error.
hostResourceGroupArn (string) --
The Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances. This only applies if tenancy is host. If you specify the resource group ARN, you must not specify the host ID. If you specify both, Image Builder returns an error.
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 Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt the distributed image. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
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. For example, <repository location url>/repository_name.
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.
ssmParameterConfigurations (list) --
Contains settings to update Amazon Web Services Systems Manager (SSM) Parameter Store Parameters with output AMI IDs from the build by target Region.
(dict) --
Configuration for a single Parameter in the Amazon Web Services Systems Manager (SSM) Parameter Store in a given Region.
amiAccountId (string) --
Specify the account that will own the Parameter in a given Region. During distribution, this account must be specified in distribution settings as a target account for the Region.
parameterName (string) --
This is the name of the Parameter in the target Region or account. The image distribution creates the Parameter if it doesn't already exist. Otherwise, it updates the parameter.
dataType (string) --
The data type specifies what type of value the Parameter contains. We recommend that you use data type aws:ec2:image.
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.
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.
IMPORT_ISO – An ISO disk import created the image.
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 Amazon Inspector scans. Tags can help you identify and manage your scanned images.
(string) --
deprecationTime (datetime) --
The time when deprecation occurs for an image resource. This can be a past or future date.
lifecycleExecutionId (string) --
Identifies the last runtime instance of the lifecycle policy to take action on the image.
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 build and test workflows that are associated with the image.
(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) --
The logging configuration that's defined for the image. Image Builder uses the defined settings to direct execution log output during image creation.
logGroupName (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.
latestVersionReferences (dict) --
The resource ARNs with different wildcard variations of semantic versioning.
latestVersionArn (string) --
The latest version Amazon Resource Name (ARN) of the Image Builder resource.
latestMajorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.
latestMinorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.
latestPatchVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.
{'latestVersionReferences': {'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string',
'latestVersionArn': 'string'}}
Gets an image recipe.
See also: AWS API Documentation
Request Syntax
client.get_image_recipe(
imageRecipeArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.
dict
Response Syntax
{
'requestId': 'string',
'imageRecipe': {
'arn': 'string',
'type': 'AMI'|'DOCKER',
'name': 'string',
'description': 'string',
'platform': 'Windows'|'Linux'|'macOS',
'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'
},
'amiTags': {
'string': 'string'
}
},
'latestVersionReferences': {
'latestVersionArn': 'string',
'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string'
}
}
Response Structure
(dict) --
requestId (string) --
The request ID that uniquely identifies this request.
imageRecipe (dict) --
The image recipe object.
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 for customizations specified in the image recipe. You can specify the parent image using one of the following options:
AMI ID
Image Builder image Amazon Resource Name (ARN)
Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.
Amazon Web Services Marketplace product ID
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) --
The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
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. default value is false.
The default behavior of uninstallAfterBuild is to remove the SSM Agent if it was installed by EC2 Image Builder
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.
amiTags (dict) --
Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.
(string) --
(string) --
latestVersionReferences (dict) --
The resource ARNs with different wildcard variations of semantic versioning.
latestVersionArn (string) --
The latest version Amazon Resource Name (ARN) of the Image Builder resource.
latestMajorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.
latestMinorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.
latestPatchVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.
{'latestVersionReferences': {'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string',
'latestVersionArn': 'string'}}
Get a workflow resource object.
See also: AWS API Documentation
Request Syntax
client.get_workflow(
workflowBuildVersionArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the workflow resource that you want to get.
dict
Response Syntax
{
'workflow': {
'arn': 'string',
'name': 'string',
'version': 'string',
'description': 'string',
'changeDescription': 'string',
'type': 'BUILD'|'TEST'|'DISTRIBUTION',
'state': {
'status': 'DEPRECATED',
'reason': 'string'
},
'owner': 'string',
'data': 'string',
'kmsKeyId': 'string',
'dateCreated': 'string',
'tags': {
'string': 'string'
},
'parameters': [
{
'name': 'string',
'type': 'string',
'defaultValue': [
'string',
],
'description': 'string'
},
]
},
'latestVersionReferences': {
'latestVersionArn': 'string',
'latestMajorVersionArn': 'string',
'latestMinorVersionArn': 'string',
'latestPatchVersionArn': 'string'
}
}
Response Structure
(dict) --
workflow (dict) --
The workflow resource specified in the request.
arn (string) --
The Amazon Resource Name (ARN) of the workflow resource.
name (string) --
The name of the workflow resource.
version (string) --
The workflow resource version. Workflow resources are immutable. To make a change, you can clone a workflow or create a new version.
description (string) --
The description of the workflow.
changeDescription (string) --
Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.
type (string) --
Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows.
state (dict) --
Describes the current status of the workflow and the reason for that status.
status (string) --
The current state of the workflow.
reason (string) --
Describes how or why the workflow changed state.
owner (string) --
The owner of the workflow resource.
data (string) --
Contains the YAML document content for the workflow.
kmsKeyId (string) --
The KMS key identifier used to encrypt the workflow resource. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
dateCreated (string) --
The timestamp when Image Builder created the workflow resource.
tags (dict) --
The tags that apply to the workflow resource
(string) --
(string) --
parameters (list) --
An array of input parameters that that the image workflow uses to control actions or configure settings.
(dict) --
Defines a parameter that's used to provide configuration details for the workflow.
name (string) --
The name of this input parameter.
type (string) --
The type of input this parameter provides. The currently supported value is "string".
defaultValue (list) --
The default value of this parameter if no input is provided.
(string) --
description (string) --
Describes this parameter.
latestVersionReferences (dict) --
The resource ARNs with different wildcard variations of semantic versioning.
latestVersionArn (string) --
The latest version Amazon Resource Name (ARN) of the Image Builder resource.
latestMajorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.
latestMinorVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.
latestPatchVersionArn (string) --
The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.
{'workflowExecutions': {'retried': 'boolean'}}
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
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.
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'|'CANCELLED',
'message': 'string',
'totalStepCount': 123,
'totalStepsSucceeded': 123,
'totalStepsFailed': 123,
'totalStepsSkipped': 123,
'startTime': 'string',
'endTime': 'string',
'parallelGroup': 'string',
'retried': True|False
},
],
'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.
parallelGroup (string) --
The name of the test group that included the test workflow resource at runtime.
retried (boolean) --
Indicates retry status for this runtime instance of the workflow.
imageBuildVersionArn (string) --
The resource Amazon Resource Name (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 hasn't included in this request. Use this token with the next request to retrieve additional objects.