Imagebuilder

This page documents function available when using the Imagebuilder module, created with @service Imagebuilder.

Index

Documentation

Main.Imagebuilder.cancel_image_creationMethod
cancel_image_creation(client_token, image_build_version_arn)
cancel_image_creation(client_token, image_build_version_arn, params::Dict{String,<:Any})

CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.

Arguments

  • client_token: Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
  • image_build_version_arn: The Amazon Resource Name (ARN) of the image that you want to cancel creation for.
Main.Imagebuilder.create_componentMethod
create_component(client_token, name, platform, semantic_version)
create_component(client_token, name, platform, semantic_version, params::Dict{String,<:Any})

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.

Arguments

  • client_token: The idempotency token of the component.
  • name: The name of the component.
  • platform: The operating system platform of the component.
  • semantic_version: The semantic version of the component. This version follows the semantic version syntax. The semantic version has four nodes: &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "changeDescription": 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 this component.
  • "data": 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.
  • "description": Describes the contents of the component.
  • "kmsKeyId": The ID of the KMS key that is used to encrypt this component.
  • "supportedOsVersions": 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.
  • "tags": The tags that apply to the component.
  • "uri": 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.
Main.Imagebuilder.create_container_recipeMethod
create_container_recipe(client_token, components, container_type, name, parent_image, semantic_version, target_repository)
create_container_recipe(client_token, components, container_type, name, parent_image, semantic_version, target_repository, params::Dict{String,<:Any})

Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.

Arguments

  • client_token: The client token used to make this request idempotent.
  • components: Components for build and test 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.
  • container_type: The type of container to create.
  • name: The name of the container recipe.
  • parent_image: The base image for the container recipe.
  • semantic_version: The semantic version of the container recipe. This version follows the semantic version syntax. The semantic version has four nodes: &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. 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.
  • target_repository: The destination repository for the container image.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the container recipe.
  • "dockerfileTemplateData": The Dockerfile template used to build your image as an inline data blob.
  • "dockerfileTemplateUri": The Amazon S3 URI for the Dockerfile that will be used to build your container image.
  • "imageOsVersionOverride": Specifies the operating system version for the base image.
  • "instanceConfiguration": A group of options that can be used to configure an instance for building and testing container images.
  • "kmsKeyId": Identifies which KMS key is used to encrypt the container image.
  • "platformOverride": Specifies the operating system platform when you use a custom base image.
  • "tags": Tags that are attached to the container recipe.
  • "workingDirectory": The working directory for use during build and test workflows.
Main.Imagebuilder.create_distribution_configurationMethod
create_distribution_configuration(client_token, distributions, name)
create_distribution_configuration(client_token, distributions, name, params::Dict{String,<:Any})

Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.

Arguments

  • client_token: The idempotency token of the distribution configuration.
  • distributions: The distributions of the distribution configuration.
  • name: The name of the distribution configuration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the distribution configuration.
  • "tags": The tags of the distribution configuration.
Main.Imagebuilder.create_imageMethod
create_image(client_token, infrastructure_configuration_arn)
create_image(client_token, infrastructure_configuration_arn, params::Dict{String,<:Any})

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.

Arguments

  • client_token: The idempotency token used to make this request idempotent.
  • infrastructure_configuration_arn: The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "containerRecipeArn": The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
  • "distributionConfigurationArn": The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
  • "enhancedImageMetadataEnabled": Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
  • "imageRecipeArn": The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
  • "imageScanningConfiguration": Contains settings for vulnerability scans.
  • "imageTestsConfiguration": The image tests configuration of the image.
  • "tags": The tags of the image.
Main.Imagebuilder.create_image_pipelineMethod
create_image_pipeline(client_token, infrastructure_configuration_arn, name)
create_image_pipeline(client_token, infrastructure_configuration_arn, name, params::Dict{String,<:Any})

Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.

Arguments

  • client_token: The idempotency token used to make this request idempotent.
  • infrastructure_configuration_arn: The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.
  • name: The name of the image pipeline.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "containerRecipeArn": The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.
  • "description": The description of the image pipeline.
  • "distributionConfigurationArn": The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.
  • "enhancedImageMetadataEnabled": Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
  • "imageRecipeArn": The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.
  • "imageScanningConfiguration": Contains settings for vulnerability scans.
  • "imageTestsConfiguration": The image test configuration of the image pipeline.
  • "schedule": The schedule of the image pipeline.
  • "status": The status of the image pipeline.
  • "tags": The tags of the image pipeline.
Main.Imagebuilder.create_image_recipeMethod
create_image_recipe(client_token, components, name, parent_image, semantic_version)
create_image_recipe(client_token, components, name, parent_image, semantic_version, params::Dict{String,<:Any})

Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.

Arguments

  • client_token: The idempotency token used to make this request idempotent.
  • components: The components included in the image recipe.
  • name: The name of the image recipe.
  • parent_image: The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.
  • semantic_version: The semantic version of the image recipe. This version follows the semantic version syntax. The semantic version has four nodes: &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "additionalInstanceConfiguration": Specify additional settings and launch scripts for your build instances.
  • "blockDeviceMappings": The block device mappings of the image recipe.
  • "description": The description of the image recipe.
  • "tags": The tags of the image recipe.
  • "workingDirectory": The working directory used during build and test workflows.
Main.Imagebuilder.create_infrastructure_configurationMethod
create_infrastructure_configuration(client_token, instance_profile_name, name)
create_infrastructure_configuration(client_token, instance_profile_name, name, params::Dict{String,<:Any})

Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.

Arguments

  • client_token: The idempotency token used to make this request idempotent.
  • instance_profile_name: The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
  • name: The name of the infrastructure configuration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the infrastructure configuration.
  • "instanceMetadataOptions": The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.
  • "instanceTypes": The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.
  • "keyPair": The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.
  • "logging": The logging configuration of the infrastructure configuration.
  • "resourceTags": The tags attached to the resource created by Image Builder.
  • "securityGroupIds": The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
  • "snsTopicArn": The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications. 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.
  • "subnetId": The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.
  • "tags": The tags of the infrastructure configuration.
  • "terminateInstanceOnFailure": The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.
Main.Imagebuilder.delete_componentMethod
delete_component(component_build_version_arn)
delete_component(component_build_version_arn, params::Dict{String,<:Any})

Deletes a component build version.

Arguments

  • component_build_version_arn: The Amazon Resource Name (ARN) of the component build version to delete.
Main.Imagebuilder.delete_container_recipeMethod
delete_container_recipe(container_recipe_arn)
delete_container_recipe(container_recipe_arn, params::Dict{String,<:Any})

Deletes a container recipe.

Arguments

  • container_recipe_arn: The Amazon Resource Name (ARN) of the container recipe to delete.
Main.Imagebuilder.delete_distribution_configurationMethod
delete_distribution_configuration(distribution_configuration_arn)
delete_distribution_configuration(distribution_configuration_arn, params::Dict{String,<:Any})

Deletes a distribution configuration.

Arguments

  • distribution_configuration_arn: The Amazon Resource Name (ARN) of the distribution configuration to delete.
Main.Imagebuilder.delete_imageMethod
delete_image(image_build_version_arn)
delete_image(image_build_version_arn, params::Dict{String,<:Any})

Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container images that are created during the image build process. You must clean those up separately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI commands. To deregister an EC2 Linux AMI, see Deregister your Linux AMI in the Amazon EC2 User Guide . To deregister an EC2 Windows AMI, see Deregister your Windows AMI in the Amazon EC2 Windows Guide . To delete a container image from Amazon ECR, see Deleting an image in the Amazon ECR User Guide.

Arguments

  • image_build_version_arn: The Amazon Resource Name (ARN) of the Image Builder image resource to delete.
Main.Imagebuilder.delete_image_pipelineMethod
delete_image_pipeline(image_pipeline_arn)
delete_image_pipeline(image_pipeline_arn, params::Dict{String,<:Any})

Deletes an image pipeline.

Arguments

  • image_pipeline_arn: The Amazon Resource Name (ARN) of the image pipeline to delete.
Main.Imagebuilder.delete_image_recipeMethod
delete_image_recipe(image_recipe_arn)
delete_image_recipe(image_recipe_arn, params::Dict{String,<:Any})

Deletes an image recipe.

Arguments

  • image_recipe_arn: The Amazon Resource Name (ARN) of the image recipe to delete.
Main.Imagebuilder.delete_infrastructure_configurationMethod
delete_infrastructure_configuration(infrastructure_configuration_arn)
delete_infrastructure_configuration(infrastructure_configuration_arn, params::Dict{String,<:Any})

Deletes an infrastructure configuration.

Arguments

  • infrastructure_configuration_arn: The Amazon Resource Name (ARN) of the infrastructure configuration to delete.
Main.Imagebuilder.get_componentMethod
get_component(component_build_version_arn)
get_component(component_build_version_arn, params::Dict{String,<:Any})

Gets a component object.

Arguments

  • component_build_version_arn: The Amazon Resource Name (ARN) of the component that you want to get. Regex requires the suffix /d+.
Main.Imagebuilder.get_component_policyMethod
get_component_policy(component_arn)
get_component_policy(component_arn, params::Dict{String,<:Any})

Gets a component policy.

Arguments

  • component_arn: The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.
Main.Imagebuilder.get_container_recipeMethod
get_container_recipe(container_recipe_arn)
get_container_recipe(container_recipe_arn, params::Dict{String,<:Any})

Retrieves a container recipe.

Arguments

  • container_recipe_arn: The Amazon Resource Name (ARN) of the container recipe to retrieve.
Main.Imagebuilder.get_container_recipe_policyMethod
get_container_recipe_policy(container_recipe_arn)
get_container_recipe_policy(container_recipe_arn, params::Dict{String,<:Any})

Retrieves the policy for a container recipe.

Arguments

  • container_recipe_arn: The Amazon Resource Name (ARN) of the container recipe for the policy being requested.
Main.Imagebuilder.get_distribution_configurationMethod
get_distribution_configuration(distribution_configuration_arn)
get_distribution_configuration(distribution_configuration_arn, params::Dict{String,<:Any})

Gets a distribution configuration.

Arguments

  • distribution_configuration_arn: The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.
Main.Imagebuilder.get_imageMethod
get_image(image_build_version_arn)
get_image(image_build_version_arn, params::Dict{String,<:Any})

Gets an image.

Arguments

  • image_build_version_arn: The Amazon Resource Name (ARN) of the image that you want to get.
Main.Imagebuilder.get_image_pipelineMethod
get_image_pipeline(image_pipeline_arn)
get_image_pipeline(image_pipeline_arn, params::Dict{String,<:Any})

Gets an image pipeline.

Arguments

  • image_pipeline_arn: The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.
Main.Imagebuilder.get_image_policyMethod
get_image_policy(image_arn)
get_image_policy(image_arn, params::Dict{String,<:Any})

Gets an image policy.

Arguments

  • image_arn: The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.
Main.Imagebuilder.get_image_recipeMethod
get_image_recipe(image_recipe_arn)
get_image_recipe(image_recipe_arn, params::Dict{String,<:Any})

Gets an image recipe.

Arguments

  • image_recipe_arn: The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.
Main.Imagebuilder.get_image_recipe_policyMethod
get_image_recipe_policy(image_recipe_arn)
get_image_recipe_policy(image_recipe_arn, params::Dict{String,<:Any})

Gets an image recipe policy.

Arguments

  • image_recipe_arn: The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve.
Main.Imagebuilder.get_infrastructure_configurationMethod
get_infrastructure_configuration(infrastructure_configuration_arn)
get_infrastructure_configuration(infrastructure_configuration_arn, params::Dict{String,<:Any})

Gets an infrastructure configuration.

Arguments

  • infrastructure_configuration_arn: The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve.
Main.Imagebuilder.get_workflow_executionMethod
get_workflow_execution(workflow_execution_id)
get_workflow_execution(workflow_execution_id, params::Dict{String,<:Any})

Get the runtime information that was logged for a specific runtime instance of the workflow.

Arguments

  • workflow_execution_id: Use the unique identifier for a runtime instance of the workflow to get runtime details.
Main.Imagebuilder.get_workflow_step_executionMethod
get_workflow_step_execution(step_execution_id)
get_workflow_step_execution(step_execution_id, params::Dict{String,<:Any})

Get the runtime information that was logged for a specific runtime instance of the workflow step.

Arguments

  • step_execution_id: Use the unique identifier for a specific runtime instance of the workflow step to get runtime details for that step.
Main.Imagebuilder.import_componentMethod
import_component(client_token, format, name, platform, semantic_version, type)
import_component(client_token, format, name, platform, semantic_version, type, params::Dict{String,<:Any})

Imports a component and transforms its data into a component document.

Arguments

  • client_token: The idempotency token of the component.
  • format: The format of the resource that you want to import as a component.
  • name: The name of the component.
  • platform: The platform of the component.
  • semantic_version: The semantic version of the component. This version follows the semantic version syntax. The semantic version has four nodes: &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can assign values for the first three, and can filter on all of them. 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.
  • type: The type of the component denotes whether the component is used to build the image, or only to test it.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "changeDescription": The change description of the component. This description indicates the change that has been made in this version, or what makes this version different from other versions of this component.
  • "data": The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.
  • "description": The description of the component. Describes the contents of the component.
  • "kmsKeyId": The ID of the KMS key that should be used to encrypt this component.
  • "tags": The tags of the component.
  • "uri": The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.
Main.Imagebuilder.import_vm_imageMethod
import_vm_image(client_token, name, platform, semantic_version, vm_import_task_id)
import_vm_image(client_token, name, platform, semantic_version, vm_import_task_id, params::Dict{String,<:Any})

When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data. The Amazon EC2 API ImportImage action uses those files to import your VM and create an AMI. To import using the CLI command, see import-image You can reference the task ID from the VM import to pull in the AMI that the import created as the base image for your Image Builder recipe.

Arguments

  • client_token: Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
  • name: The name of the base image that is created by the import process.
  • platform: The operating system platform for the imported VM.
  • semantic_version: The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax. The semantic version has four nodes: &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. 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.
  • vm_import_task_id: The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description for the base image that is created by the import process.
  • "osVersion": The operating system version for the imported VM.
  • "tags": Tags that are attached to the import resources.
Main.Imagebuilder.list_component_build_versionsMethod
list_component_build_versions(component_version_arn)
list_component_build_versions(component_version_arn, params::Dict{String,<:Any})

Returns the list of component build versions for the specified semantic version. The semantic version has four nodes: &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can assign values for the first three, and can filter on all of them. 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.

Arguments

  • component_version_arn: The component version Amazon Resource Name (ARN) whose versions you want to list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum items to return in a request.
  • "nextToken": A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_componentsMethod
list_components()
list_components(params::Dict{String,<:Any})

Returns the list of components that can be filtered by name, or by using the listed filters to streamline results. Newly created components can take up to two minutes to appear in the ListComponents API Results. The semantic version has four nodes: &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can assign values for the first three, and can filter on all of them. 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "byName": Returns the list of components for the specified name.
  • "filters": Use the following filters to streamline results: description name platform supportedOsVersion type version
  • "maxResults": The maximum items to return in a request.
  • "nextToken": A token to specify where to start paginating. This is the NextToken from a previously truncated response.
  • "owner": Filters results based on the type of owner for the component. By default, this request returns a list of components that your account owns. To see results for other types of owners, you can specify components that Amazon manages, third party components, or components that other accounts have shared with you.
Main.Imagebuilder.list_container_recipesMethod
list_container_recipes()
list_container_recipes(params::Dict{String,<:Any})

Returns a list of container recipes.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filters": Use the following filters to streamline results: containerType name parentImage platform
  • "maxResults": The maximum items to return in a request.
  • "nextToken": A token to specify where to start paginating. This is the NextToken from a previously truncated response.
  • "owner": Returns container recipes belonging to the specified owner, that have been shared with you. You can omit this field to return container recipes belonging to your account.
Main.Imagebuilder.list_distribution_configurationsMethod
list_distribution_configurations()
list_distribution_configurations(params::Dict{String,<:Any})

Returns a list of distribution configurations.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filters": You can filter on name to streamline results.
  • "maxResults": The maximum items to return in a request.
  • "nextToken": A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_image_build_versionsMethod
list_image_build_versions(image_version_arn)
list_image_build_versions(image_version_arn, params::Dict{String,<:Any})

Returns a list of image build versions.

Arguments

  • image_version_arn: The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filters": Use the following filters to streamline results: name osVersion platform type version
  • "maxResults": The maximum items to return in a request.
  • "nextToken": A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_image_packagesMethod
list_image_packages(image_build_version_arn)
list_image_packages(image_build_version_arn, params::Dict{String,<:Any})

List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.

Arguments

  • image_build_version_arn: Filter results for the ListImagePackages request by the Image Build Version ARN

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum items to return in a request.
  • "nextToken": A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_image_pipeline_imagesMethod
list_image_pipeline_images(image_pipeline_arn)
list_image_pipeline_images(image_pipeline_arn, params::Dict{String,<:Any})

Returns a list of images created by the specified pipeline.

Arguments

  • image_pipeline_arn: The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filters": Use the following filters to streamline results: name version
  • "maxResults": The maximum items to return in a request.
  • "nextToken": A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_image_pipelinesMethod
list_image_pipelines()
list_image_pipelines(params::Dict{String,<:Any})

Returns a list of image pipelines.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filters": Use the following filters to streamline results: description distributionConfigurationArn imageRecipeArn infrastructureConfigurationArn name status
  • "maxResults": The maximum items to return in a request.
  • "nextToken": A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_image_recipesMethod
list_image_recipes()
list_image_recipes(params::Dict{String,<:Any})

Returns a list of image recipes.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filters": Use the following filters to streamline results: name parentImage platform
  • "maxResults": The maximum items to return in a request.
  • "nextToken": A token to specify where to start paginating. This is the NextToken from a previously truncated response.
  • "owner": The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers.
Main.Imagebuilder.list_image_scan_finding_aggregationsMethod
list_image_scan_finding_aggregations()
list_image_scan_finding_aggregations(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filter":
  • "nextToken": A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_image_scan_findingsMethod
list_image_scan_findings()
list_image_scan_findings(params::Dict{String,<:Any})

Returns a list of image scan findings for your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filters": 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.
  • "maxResults": The maximum items to return in a request.
  • "nextToken": A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_imagesMethod
list_images()
list_images(params::Dict{String,<:Any})

Returns the list of images that you have access to. Newly created images can take up to two minutes to appear in the ListImages API Results.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "byName": Requests a list of images with a specific recipe name.
  • "filters": Use the following filters to streamline results: name osVersion platform type version
  • "includeDeprecated": Includes deprecated images in the response list.
  • "maxResults": The maximum items to return in a request.
  • "nextToken": A token to specify where to start paginating. This is the NextToken from a previously truncated response.
  • "owner": The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.
Main.Imagebuilder.list_infrastructure_configurationsMethod
list_infrastructure_configurations()
list_infrastructure_configurations(params::Dict{String,<:Any})

Returns a list of infrastructure configurations.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filters": You can filter on name to streamline results.
  • "maxResults": The maximum items to return in a request.
  • "nextToken": A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Returns the list of tags for the specified resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
Main.Imagebuilder.list_workflow_executionsMethod
list_workflow_executions(image_build_version_arn)
list_workflow_executions(image_build_version_arn, params::Dict{String,<:Any})

Returns a list of workflow runtime instance metadata objects for a specific image build version.

Arguments

  • image_build_version_arn: List all workflow runtime instances for the specified image build version resource ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum items to return in a request.
  • "nextToken": A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.list_workflow_step_executionsMethod
list_workflow_step_executions(workflow_execution_id)
list_workflow_step_executions(workflow_execution_id, params::Dict{String,<:Any})

Shows runtime data for each step in a runtime instance of the workflow that you specify in the request.

Arguments

  • workflow_execution_id: The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum items to return in a request.
  • "nextToken": A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Main.Imagebuilder.put_component_policyMethod
put_component_policy(component_arn, policy)
put_component_policy(component_arn, policy, params::Dict{String,<:Any})

Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.

Arguments

  • component_arn: The Amazon Resource Name (ARN) of the component that this policy should be applied to.
  • policy: The policy to apply.
Main.Imagebuilder.put_container_recipe_policyMethod
put_container_recipe_policy(container_recipe_arn, policy)
put_container_recipe_policy(container_recipe_arn, policy, params::Dict{String,<:Any})

Applies a policy to a container image. We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com//ram/latest/APIReference/APICreateResourceShare.html) to share resources. If you call the Image Builder API PutContainerImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com//ram/latest/APIReference/APIPromoteResourceShareCreatedFromPol icy.html) in order for the resource to be visible to all principals with whom the resource is shared.

Arguments

  • container_recipe_arn: The Amazon Resource Name (ARN) of the container recipe that this policy should be applied to.
  • policy: The policy to apply to the container recipe.
Main.Imagebuilder.put_image_policyMethod
put_image_policy(image_arn, policy)
put_image_policy(image_arn, policy, params::Dict{String,<:Any})

Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.

Arguments

  • image_arn: The Amazon Resource Name (ARN) of the image that this policy should be applied to.
  • policy: The policy to apply.
Main.Imagebuilder.put_image_recipe_policyMethod
put_image_recipe_policy(image_recipe_arn, policy)
put_image_recipe_policy(image_recipe_arn, policy, params::Dict{String,<:Any})

Applies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.

Arguments

  • image_recipe_arn: The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to.
  • policy: The policy to apply.
Main.Imagebuilder.start_image_pipeline_executionMethod
start_image_pipeline_execution(client_token, image_pipeline_arn)
start_image_pipeline_execution(client_token, image_pipeline_arn, params::Dict{String,<:Any})

Manually triggers a pipeline to create an image.

Arguments

  • client_token: The idempotency token used to make this request idempotent.
  • image_pipeline_arn: The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.
Main.Imagebuilder.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds a tag to a resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource that you want to tag.
  • tags: The tags to apply to the resource.
Main.Imagebuilder.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes a tag from a resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource that you want to untag.
  • tag_keys: The tag keys to remove from the resource.
Main.Imagebuilder.update_distribution_configurationMethod
update_distribution_configuration(client_token, distribution_configuration_arn, distributions)
update_distribution_configuration(client_token, distribution_configuration_arn, distributions, params::Dict{String,<:Any})

Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.

Arguments

  • client_token: The idempotency token of the distribution configuration.
  • distribution_configuration_arn: The Amazon Resource Name (ARN) of the distribution configuration that you want to update.
  • distributions: The distributions of the distribution configuration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the distribution configuration.
Main.Imagebuilder.update_image_pipelineMethod
update_image_pipeline(client_token, image_pipeline_arn, infrastructure_configuration_arn)
update_image_pipeline(client_token, image_pipeline_arn, infrastructure_configuration_arn, params::Dict{String,<:Any})

Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images. 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.

Arguments

  • client_token: The idempotency token used to make this request idempotent.
  • image_pipeline_arn: The Amazon Resource Name (ARN) of the image pipeline that you want to update.
  • infrastructure_configuration_arn: The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "containerRecipeArn": The Amazon Resource Name (ARN) of the container pipeline to update.
  • "description": The description of the image pipeline.
  • "distributionConfigurationArn": The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.
  • "enhancedImageMetadataEnabled": Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
  • "imageRecipeArn": The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
  • "imageScanningConfiguration": Contains settings for vulnerability scans.
  • "imageTestsConfiguration": The image test configuration of the image pipeline.
  • "schedule": The schedule of the image pipeline.
  • "status": The status of the image pipeline.
Main.Imagebuilder.update_infrastructure_configurationMethod
update_infrastructure_configuration(client_token, infrastructure_configuration_arn, instance_profile_name)
update_infrastructure_configuration(client_token, infrastructure_configuration_arn, instance_profile_name, params::Dict{String,<:Any})

Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.

Arguments

  • client_token: The idempotency token used to make this request idempotent.
  • infrastructure_configuration_arn: The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.
  • instance_profile_name: The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the infrastructure configuration.
  • "instanceMetadataOptions": The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see one of the following links: Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances. Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows instances.
  • "instanceTypes": The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.
  • "keyPair": The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.
  • "logging": The logging configuration of the infrastructure configuration.
  • "resourceTags": The tags attached to the resource created by Image Builder.
  • "securityGroupIds": The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
  • "snsTopicArn": The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications. 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.
  • "subnetId": The subnet ID to place the instance used to customize your Amazon EC2 AMI in.
  • "terminateInstanceOnFailure": The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.