amazonaws.com – imagebuilder

OpenAPI apis-guru cloud

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.

Homepage: https://api.apis.guru/v2/specs/amazonaws.com:imagebuilder/2019-12-02.json
Provider: amazonaws.com:imagebuilder / imagebuilder
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/amazonaws.com/imagebuilder/2019-12-02/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/amazonaws.com/imagebuilder/2019-12-02/openapi.yaml

Tools (58)

Extracted live via the executor SDK.

cancelImageCreation.putOperation

CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
createComponent.putOperation
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.
createContainerRecipe.putOperation

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

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

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.
createImagePipeline.putOperation

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

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

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

Deletes a component build version.
deleteContainerRecipeContainerRecipeArn.deleteContainerRecipe

Deletes a container recipe.
deleteDistributionConfigurationDistributionConfigurationArn.deleteDistributionConfiguration

Deletes a distribution configuration.
deleteImageImageBuildVersionArn.deleteImage
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 in the Amazon EC2 User Guide .
- To deregister an EC2 Windows AMI, see in the Amazon EC2 Windows Guide .
- To delete a container image from Amazon ECR, see in the Amazon ECR User Guide.
deleteImagePipelineImagePipelineArn.deleteImagePipeline

Deletes an image pipeline.
deleteImageRecipeImageRecipeArn.deleteImageRecipe

Deletes an image recipe.
deleteInfrastructureConfigurationInfrastructureConfigurationArn.deleteInfrastructureConfiguration

Deletes an infrastructure configuration.
getComponentComponentBuildVersionArn.getComponent

Gets a component object.
getComponentPolicyComponentArn.getComponentPolicy

Gets a component policy.
getContainerRecipeContainerRecipeArn.getContainerRecipe

Retrieves a container recipe.
getContainerRecipePolicyContainerRecipeArn.getContainerRecipePolicy

Retrieves the policy for a container recipe.
getDistributionConfigurationDistributionConfigurationArn.getDistributionConfiguration

Gets a distribution configuration.
getImageImageBuildVersionArn.getImage

Gets an image.
getImagePipelineImagePipelineArn.getImagePipeline

Gets an image pipeline.
getImagePolicyImageArn.getImagePolicy

Gets an image policy.
getImageRecipeImageRecipeArn.getImageRecipe

Gets an image recipe.
getImageRecipePolicyImageRecipeArn.getImageRecipePolicy

Gets an image recipe policy.
getInfrastructureConfigurationInfrastructureConfigurationArn.getInfrastructureConfiguration

Gets an infrastructure configuration.
getWorkflowExecutionWorkflowExecutionId.getWorkflowExecution

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

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

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

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 action uses those files to import your VM and create an AMI. To import using the CLI command, see

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.
listComponentBuildVersions.postOperation

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.
listComponents.postOperation

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.
listContainerRecipes.postOperation

Returns a list of container recipes.
listDistributionConfigurations.postOperation

Returns a list of distribution configurations.
listImageBuildVersions.postOperation

Returns a list of image build versions.
listImagePackages.postOperation

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

Returns a list of images created by the specified pipeline.
listImagePipelines.postOperation

Returns a list of image pipelines.
listImageRecipes.postOperation

Returns a list of image recipes.
listImages.postOperation

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.
listImageScanFindingAggregations.postOperation
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
listImageScanFindings.postOperation

Returns a list of image scan findings for your account.
listInfrastructureConfigurations.postOperation

Returns a list of infrastructure configurations.
listWorkflowExecutions.postOperation

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

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

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

Applies a policy to a container image. We recommend that you call the RAM API CreateResourceShare () to share resources. If you call the Image Builder API PutContainerImagePolicy, 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.
putImagePolicy.putOperation

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

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

Manually triggers a pipeline to create an image.
tags.listTagsForResource

Returns the list of tags for the specified resource.
tags.tagResource

Adds a tag to a resource.
tags.untagResource

Removes a tag from a resource.
updateDistributionConfiguration.putOperation

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

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.
updateInfrastructureConfiguration.putOperation

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

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools