View Source AWS.Imagebuilder (aws-elixir v1.0.4)
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.
Link to this section 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 container recipe.
Creates a new distribution configuration.
Creates a new image.
Creates a new image pipeline.
Creates a new image recipe.
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 a container recipe.
Deletes a distribution configuration.
Deletes an Image Builder image resource.
Deletes an image pipeline.
Deletes an image recipe.
Deletes an infrastructure configuration.
Delete the specified lifecycle policy resource.
Deletes a specific workflow resource.
Gets a component object.
Gets a component policy.
Retrieves a container recipe.
Retrieves the policy for a container recipe.
Gets a distribution configuration.
Gets an image.
Gets an image pipeline.
Gets an image policy.
Gets an image recipe.
Gets an image recipe policy.
Gets an infrastructure configuration.
Get the runtime information that was logged for a specific runtime instance of the lifecycle policy.
Get details for the specified image lifecycle policy.
Verify the subscription and perform resource dependency checks on the requested Amazon Web Services Marketplace resource.
Get a workflow resource object.
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 component version Amazon Resource Name (ARN).
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.
Adds a tag to a resource.
Removes a tag from a resource.
Updates a new distribution configuration.
Updates an image pipeline.
Updates a new infrastructure configuration.
Update the specified lifecycle policy.
Link to this section Functions
CancelImageCreation cancels the creation of Image.
This operation can only be used on images in a non-terminal state.
Cancel a specific image lifecycle policy runtime instance.
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.
Creates a new container recipe.
Container recipes define how images are configured, tested, and assessed.
Creates a new distribution configuration.
Distribution configurations define and configure the outputs of your pipeline.
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.
Creates a new image pipeline.
Image pipelines enable you to automate the creation and distribution of images.
Creates a new image recipe.
Image recipes define how images are configured, tested, and assessed.
Creates a new infrastructure configuration.
An infrastructure configuration defines the environment in which your image will be built and tested.
Create a lifecycle policy resource.
Create a new workflow or a new version of an existing workflow.
Deletes a component build version.
Deletes a container recipe.
Deletes a distribution configuration.
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*.
Deletes an image pipeline.
Deletes an image recipe.
Deletes an infrastructure configuration.
Delete the specified lifecycle policy resource.
Deletes a specific workflow resource.
Gets a component object.
Gets a component policy.
Retrieves a container recipe.
get_container_recipe_policy(client, container_recipe_arn, options \\ [])
View SourceRetrieves the policy for a container recipe.
get_distribution_configuration(client, distribution_configuration_arn, options \\ [])
View SourceGets a distribution configuration.
Gets an image.
Gets an image pipeline.
Gets an image policy.
Gets an image recipe.
Gets an image recipe policy.
get_infrastructure_configuration(client, infrastructure_configuration_arn, options \\ [])
View SourceGets an infrastructure configuration.
get_lifecycle_execution(client, lifecycle_execution_id, options \\ [])
View SourceGet the runtime information that was logged for a specific runtime instance of the lifecycle policy.
Get details for the specified image lifecycle policy.
Verify the subscription and perform resource dependency checks on the requested Amazon Web Services Marketplace resource.
For Amazon Web Services Marketplace components, the response contains fields to download the components and their artifacts.
Get a workflow resource object.
get_workflow_execution(client, workflow_execution_id, options \\ [])
View SourceGet the runtime information that was logged for a specific runtime instance of the workflow.
get_workflow_step_execution(client, step_execution_id, options \\ [])
View SourceGet 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.
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.
Returns the list of component build versions for the specified component version Amazon Resource Name (ARN).
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: ../. 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.
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.
list_image_scan_finding_aggregations(client, input, options \\ [])
View SourceReturns 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
Returns a list of image scan findings for your account.
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.
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.
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.
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.
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.
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.
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.
Adds a tag to a resource.
Removes a tag from a resource.
Updates a new distribution configuration.
Distribution configurations define and configure the outputs of your pipeline.
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.
Updates a new infrastructure configuration.
An infrastructure configuration defines the environment in which your image will be built and tested.
Update the specified lifecycle policy.