View Source AWS.Imagebuilder (aws-elixir v0.14.1)

EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.

Summary

Functions

CancelImageCreation cancels the creation of Image.

Cancel a specific image lifecycle policy runtime instance.

Creates a new component that can be used to build, validate, test, and assess your image.

Creates a new distribution configuration.

Creates a new infrastructure configuration.

Create a lifecycle policy resource.

Create a new workflow or a new version of an existing workflow.

Deletes a component build version.

Deletes an Image Builder image resource.

Delete the specified lifecycle policy resource.

Deletes a specific workflow resource.

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

Get details for the specified image lifecycle policy.

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

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

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

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.

Returns the list of component build versions for the specified semantic version.

Returns the list of components that can be filtered by name, or by using the listed filters to streamline results.

Returns a list of container recipes.

Returns a list of distribution configurations.

Returns a list of image build versions.

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

Returns a list of images created by the specified pipeline.

Returns a list of image pipelines.

Returns a list of image recipes.

Returns a list of image scan aggregations for your account.

Returns a list of image scan findings for your account.

Returns the list of images that you have access to.

Returns a list of infrastructure configurations.

List resources that the runtime instance of the image lifecycle identified for lifecycle actions.

Get the lifecycle runtime history for the specified resource.

Get a list of lifecycle policies in your Amazon Web Services account.

Returns the list of tags for the specified resource.

Get a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account.

Returns a list of build versions for a specific workflow resource.

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

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

Lists workflow build versions based on filtering parameters.

Applies a policy to a component.

Applies a policy to a container image.

Applies a policy to an image.

Applies a policy to an image recipe.

Pauses or resumes image creation when the associated workflow runs a WaitForAction step.

Manually triggers a pipeline to create an image.

Begin asynchronous resource state update for lifecycle changes to the specified image resources.

Updates a new distribution configuration.

Updates a new infrastructure configuration.

Update the specified lifecycle policy.

Functions

Link to this function

cancel_image_creation(client, input, options \\ [])

View Source

CancelImageCreation cancels the creation of Image.

This operation can only be used on images in a non-terminal state.

Link to this function

cancel_lifecycle_execution(client, input, options \\ [])

View Source

Cancel a specific image lifecycle policy runtime instance.

Link to this function

create_component(client, input, options \\ [])

View Source

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.

Link to this function

create_container_recipe(client, input, options \\ [])

View Source

Creates a new container recipe.

Container recipes define how images are configured, tested, and assessed.

Link to this function

create_distribution_configuration(client, input, options \\ [])

View Source

Creates a new distribution configuration.

Distribution configurations define and configure the outputs of your pipeline.

Link to this function

create_image(client, input, options \\ [])

View Source

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.

Link to this function

create_image_pipeline(client, input, options \\ [])

View Source

Creates a new image pipeline.

Image pipelines enable you to automate the creation and distribution of images.

Link to this function

create_image_recipe(client, input, options \\ [])

View Source

Creates a new image recipe.

Image recipes define how images are configured, tested, and assessed.

Link to this function

create_infrastructure_configuration(client, input, options \\ [])

View Source

Creates a new infrastructure configuration.

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

Link to this function

create_lifecycle_policy(client, input, options \\ [])

View Source

Create a lifecycle policy resource.

Link to this function

create_workflow(client, input, options \\ [])

View Source

Create a new workflow or a new version of an existing workflow.

Link to this function

delete_component(client, input, options \\ [])

View Source

Deletes a component build version.

Link to this function

delete_container_recipe(client, input, options \\ [])

View Source

Deletes a container recipe.

Link to this function

delete_distribution_configuration(client, input, options \\ [])

View Source

Deletes a distribution configuration.

Link to this function

delete_image(client, input, options \\ [])

View Source

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.

Link to this function

delete_image_pipeline(client, input, options \\ [])

View Source

Deletes an image pipeline.

Link to this function

delete_image_recipe(client, input, options \\ [])

View Source

Deletes an image recipe.

Link to this function

delete_infrastructure_configuration(client, input, options \\ [])

View Source

Deletes an infrastructure configuration.

Link to this function

delete_lifecycle_policy(client, input, options \\ [])

View Source

Delete the specified lifecycle policy resource.

Link to this function

delete_workflow(client, input, options \\ [])

View Source

Deletes a specific workflow resource.

Link to this function

get_component(client, component_build_version_arn, options \\ [])

View Source

Gets a component object.

Link to this function

get_component_policy(client, component_arn, options \\ [])

View Source

Gets a component policy.

Link to this function

get_container_recipe(client, container_recipe_arn, options \\ [])

View Source

Retrieves a container recipe.

Link to this function

get_container_recipe_policy(client, container_recipe_arn, options \\ [])

View Source

Retrieves the policy for a container recipe.

Link to this function

get_distribution_configuration(client, distribution_configuration_arn, options \\ [])

View Source

Gets a distribution configuration.

Link to this function

get_image(client, image_build_version_arn, options \\ [])

View Source

Gets an image.

Link to this function

get_image_pipeline(client, image_pipeline_arn, options \\ [])

View Source

Gets an image pipeline.

Link to this function

get_image_policy(client, image_arn, options \\ [])

View Source

Gets an image policy.

Link to this function

get_image_recipe(client, image_recipe_arn, options \\ [])

View Source

Gets an image recipe.

Link to this function

get_image_recipe_policy(client, image_recipe_arn, options \\ [])

View Source

Gets an image recipe policy.

Link to this function

get_infrastructure_configuration(client, infrastructure_configuration_arn, options \\ [])

View Source

Gets an infrastructure configuration.

Link to this function

get_lifecycle_execution(client, lifecycle_execution_id, options \\ [])

View Source

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

Link to this function

get_lifecycle_policy(client, lifecycle_policy_arn, options \\ [])

View Source

Get details for the specified image lifecycle policy.

Link to this function

get_workflow(client, workflow_build_version_arn, options \\ [])

View Source

Get a workflow resource object.

Link to this function

get_workflow_execution(client, workflow_execution_id, options \\ [])

View Source

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

Link to this function

get_workflow_step_execution(client, step_execution_id, options \\ [])

View Source

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

Link to this function

import_component(client, input, options \\ [])

View Source

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

Link to this function

import_vm_image(client, input, options \\ [])

View Source

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.

Link to this function

list_component_build_versions(client, input, options \\ [])

View Source

Returns the list of component build versions for the specified semantic version.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

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.

Link to this function

list_components(client, input, options \\ [])

View Source

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: <major>.<minor>.<patch>/<build>. 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.

Link to this function

list_container_recipes(client, input, options \\ [])

View Source

Returns a list of container recipes.

Link to this function

list_distribution_configurations(client, input, options \\ [])

View Source

Returns a list of distribution configurations.

Link to this function

list_image_build_versions(client, input, options \\ [])

View Source

Returns a list of image build versions.

Link to this function

list_image_packages(client, input, options \\ [])

View Source

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

Link to this function

list_image_pipeline_images(client, input, options \\ [])

View Source

Returns a list of images created by the specified pipeline.

Link to this function

list_image_pipelines(client, input, options \\ [])

View Source

Returns a list of image pipelines.

Link to this function

list_image_recipes(client, input, options \\ [])

View Source

Returns a list of image recipes.

Link to this function

list_image_scan_finding_aggregations(client, input, options \\ [])

View Source

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

Link to this function

list_image_scan_findings(client, input, options \\ [])

View Source

Returns a list of image scan findings for your account.

Link to this function

list_images(client, input, options \\ [])

View Source

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.

Link to this function

list_infrastructure_configurations(client, input, options \\ [])

View Source

Returns a list of infrastructure configurations.

Link to this function

list_lifecycle_execution_resources(client, input, options \\ [])

View Source

List resources that the runtime instance of the image lifecycle identified for lifecycle actions.

Link to this function

list_lifecycle_executions(client, input, options \\ [])

View Source

Get the lifecycle runtime history for the specified resource.

Link to this function

list_lifecycle_policies(client, input, options \\ [])

View Source

Get a list of lifecycle policies in your Amazon Web Services account.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Returns the list of tags for the specified resource.

Link to this function

list_waiting_workflow_steps(client, input, options \\ [])

View Source

Get a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account.

Link to this function

list_workflow_build_versions(client, input, options \\ [])

View Source

Returns a list of build versions for a specific workflow resource.

Link to this function

list_workflow_executions(client, input, options \\ [])

View Source

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

Link to this function

list_workflow_step_executions(client, input, options \\ [])

View Source

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

Link to this function

list_workflows(client, input, options \\ [])

View Source

Lists workflow build versions based on filtering parameters.

Link to this function

put_component_policy(client, input, options \\ [])

View Source

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.

Link to this function

put_container_recipe_policy(client, input, options \\ [])

View Source

Applies a policy to a container image.

We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.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/API_PromoteResourceShareCreatedFromPolicy.html) in order for the resource to be visible to all principals with whom the resource is shared.

Link to this function

put_image_policy(client, input, options \\ [])

View Source

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.

Link to this function

put_image_recipe_policy(client, input, options \\ [])

View Source

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.

Link to this function

send_workflow_step_action(client, input, options \\ [])

View Source

Pauses or resumes image creation when the associated workflow runs a WaitForAction step.

Link to this function

start_image_pipeline_execution(client, input, options \\ [])

View Source

Manually triggers a pipeline to create an image.

Link to this function

start_resource_state_update(client, input, options \\ [])

View Source

Begin asynchronous resource state update for lifecycle changes to the specified image resources.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds a tag to a resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes a tag from a resource.

Link to this function

update_distribution_configuration(client, input, options \\ [])

View Source

Updates a new distribution configuration.

Distribution configurations define and configure the outputs of your pipeline.

Link to this function

update_image_pipeline(client, input, options \\ [])

View Source

Updates an image pipeline.

Image pipelines enable you to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a containerRecipeArn or an imageRecipeArn.

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.

Link to this function

update_infrastructure_configuration(client, input, options \\ [])

View Source

Updates a new infrastructure configuration.

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

Link to this function

update_lifecycle_policy(client, input, options \\ [])

View Source

Update the specified lifecycle policy.