Amazon Web Services, Inc.

EC2 Image Builder

EC2 Image Builder automates the creation, management, and deployment of customized, secure, and up-to-date server images. You can build Amazon Machine Images…

Media & content#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

EC2 Image Builder automates the
creation, management, and deployment of customized, secure, and up-to-date
server images. You can build Amazon Machine Images (AMIs) and container images
that are pre-installed and pre-configured with software and settings to meet
specific IT standards.
For an introduction to the service concepts that these API operations work with,
see How Image Builder
works in the EC2 Image Builder User Guide .

Endpoints 77

  • PUTCancel image creation/CancelImageCreationCancels the creation of an image. This operation can only be used on images in a non-terminal state. Cancellation is asynchronous: the request returns…
  • PUTCancel lifecycle execution/CancelLifecycleExecutionCancels a lifecycle execution – a single run of lifecycle actions that a lifecycle policy or a StartResourceStateUpdate request started. You can only cancel…
  • PUTCreate component/CreateComponentCreates 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…
  • PUTCreate container recipe/CreateContainerRecipeCreates a new container recipe. Container recipes define how images are configured, tested, and assessed.
  • PUTCreate distribution configuration/CreateDistributionConfigurationCreates a new distribution configuration. Distribution configurations define and configure the outputs for your images, including the target Regions,…
  • PUTCreate image/CreateImageCreates a new image along with all configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image,…
  • PUTCreate image pipeline/CreateImagePipelineCreates a new image pipeline. Use image pipelines to automate the creation and distribution of images. You must specify exactly one recipe for the pipeline,…
  • PUTCreate image recipe/CreateImageRecipeCreates a new image recipe. Image recipes define how images are configured, tested, and assessed.
  • PUTCreate infrastructure configuration/CreateInfrastructureConfigurationCreates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
  • PUTCreate lifecycle policy/CreateLifecyclePolicyCreates a lifecycle policy resource.
  • PUTCreate workflow/CreateWorkflowCreates a new workflow or a new version of an existing workflow. If a workflow with the same name and semantic version already exists, and your request…
  • DELETEDelete component/DeleteComponent?componentBuildVersionArn=stringDeletes a component build version. The request fails with ResourceDependencyException if an image recipe or container recipe references this component…
  • DELETEDelete container recipe/DeleteContainerRecipe?containerRecipeArn=stringDeletes a container recipe. The request fails with ResourceDependencyException if the recipe is shared with other accounts, or if an image pipeline references…
  • DELETEDelete distribution configuration/DeleteDistributionConfiguration?distributionConfigurationArn=stringDeletes a distribution configuration. You can't delete a configuration that an image pipeline still references. The request fails with…
  • DELETEDelete image/DeleteImage?imageBuildVersionArn=stringDeletes 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…
  • DELETEDelete image pipeline/DeleteImagePipeline?imagePipelineArn=stringDeletes an image pipeline. Images that the pipeline created aren't deleted - remove those separately with DeleteImage . You can delete a pipeline while a…
  • DELETEDelete image recipe/DeleteImageRecipe?imageRecipeArn=stringDeletes an image recipe.
  • DELETEDelete infrastructure configuration/DeleteInfrastructureConfiguration?infrastructureConfigurationArn=stringDeletes an infrastructure configuration. You can't delete a configuration that an image pipeline still references. The request fails with…
  • DELETEDelete lifecycle policy/DeleteLifecyclePolicy?lifecyclePolicyArn=stringDeletes the specified lifecycle policy resource. Deleting the policy removes its schedule, so no further lifecycle runs occur for that policy. If a lifecycle…
  • DELETEDelete workflow/DeleteWorkflow?workflowBuildVersionArn=stringDeletes a specific workflow resource. You can't delete a workflow build version while an image pipeline references it. The request fails with…
  • PUTDistribute image/DistributeImageDistributes an existing AMI to target Regions and accounts without running the full image build process. This operation only runs the distribution phase on an…
  • GETGet component/GetComponent?componentBuildVersionArn=stringRetrieves a component object.
  • GETGet component policy/GetComponentPolicy?componentArn=stringRetrieves a component policy.
  • GETGet container recipe/GetContainerRecipe?containerRecipeArn=stringRetrieves a container recipe.
  • GETGet container recipe policy/GetContainerRecipePolicy?containerRecipeArn=stringRetrieves the policy for a container recipe.
  • GETGet distribution configuration/GetDistributionConfiguration?distributionConfigurationArn=stringRetrieves a distribution configuration.
  • GETGet image/GetImage?imageBuildVersionArn=stringRetrieves an image.
  • GETGet image pipeline/GetImagePipeline?imagePipelineArn=stringRetrieves an image pipeline.
  • GETGet image policy/GetImagePolicy?imageArn=stringRetrieves an image policy.
  • GETGet image recipe/GetImageRecipe?imageRecipeArn=stringRetrieves an image recipe.
  • GETGet image recipe policy/GetImageRecipePolicy?imageRecipeArn=stringRetrieves an image recipe policy.
  • GETGet infrastructure configuration/GetInfrastructureConfiguration?infrastructureConfigurationArn=stringRetrieves an infrastructure configuration.
  • GETGet lifecycle execution/GetLifecycleExecution?lifecycleExecutionId=stringRetrieves runtime information for a lifecycle execution – a single run of lifecycle actions that a lifecycle policy or a StartResourceStateUpdate request…
  • GETGet lifecycle policy/GetLifecyclePolicy?lifecyclePolicyArn=stringRetrieves details for the specified image lifecycle policy.
  • POSTGet marketplace resource/GetMarketplaceResourceVerifies the subscription and performs resource dependency checks on the requested Amazon Web Services Marketplace resource. The caller must be entitled to…
  • GETGet workflow/GetWorkflow?workflowBuildVersionArn=stringRetrieves a workflow resource object.
  • GETGet workflow execution/GetWorkflowExecution?workflowExecutionId=stringRetrieves runtime information for a specific runtime instance of the workflow.
  • GETGet workflow step execution/GetWorkflowStepExecution?stepExecutionId=stringRetrieves runtime information for a specific runtime instance of the workflow step.
  • PUTImport component/ImportComponentImports a component and transforms its data into a component document. For the SHELL format, Image Builder wraps your script in a component document with a…
  • PUTImport disk image/ImportDiskImageImports a Windows operating system image from a verified Microsoft ISO disk file. The following disk images are supported: Windows 11 Enterprise The response…
  • PUTImport vm image/ImportVmImageCreates an Image Builder image resource from an Amazon EC2 VM import task. The response returns as soon as Image Builder creates the image resource in the…
  • POSTList component build versions/ListComponentBuildVersionsReturns a list of component build versions for the specified component version ARN. You can only list build versions for components that your account owns.…
  • POSTList components/ListComponentsReturns the list of components that you have access to. By default, the response doesn't include components in the DEPRECATED state. To list deprecated…
  • POSTList container recipes/ListContainerRecipesReturns a list of container recipes.
  • POSTList distribution configurations/ListDistributionConfigurationsReturns a list of distribution configurations.
  • POSTList image build versions/ListImageBuildVersionsReturns a list of image build versions.
  • POSTList image packages/ListImagePackagesLists the packages that are associated with an image build version, as determined by Amazon Web Services Systems Manager Inventory at build time.
  • POSTList image pipeline images/ListImagePipelineImagesReturns a list of images created by the specified pipeline.
  • POSTList image pipelines/ListImagePipelinesReturns a list of image pipelines.
  • POSTList image recipes/ListImageRecipesReturns a list of image recipes.
  • POSTList image scan finding aggregations/ListImageScanFindingAggregationsReturns 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…
  • POSTList image scan findings/ListImageScanFindingsReturns a list of image scan findings for your account. Amazon Inspector generates the findings when it scans images that have scanning enabled.
  • POSTList images/ListImagesReturns the list of images that you have access to.
  • POSTList infrastructure configurations/ListInfrastructureConfigurationsReturns a list of infrastructure configurations.
  • POSTList lifecycle execution resources/ListLifecycleExecutionResourcesLists resources that the runtime instance of the image lifecycle identified for lifecycle actions.
  • POSTList lifecycle executions/ListLifecycleExecutionsRetrieves the lifecycle runtime history for the specified resource.
  • POSTList lifecycle policies/ListLifecyclePoliciesRetrieves a list of lifecycle policies in your Amazon Web Services account.
  • GETList tags for resource/tags/:resourceArnReturns the list of tags for the specified resource.
  • POSTTag resource/tags/:resourceArnAdds a tag to a resource.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes a tag from a resource.
  • POSTList waiting workflow steps/ListWaitingWorkflowStepsLists the workflow steps in your Amazon Web Services account that have paused at a WaitForAction step, and are waiting for you to respond. To send a response,…
  • POSTList workflow build versions/ListWorkflowBuildVersionsReturns a list of build versions for a specific workflow resource.
  • POSTList workflow executions/ListWorkflowExecutionsReturns a list of workflow runtime instance metadata objects for a specific image build version.
  • POSTList workflow step executions/ListWorkflowStepExecutionsReturns runtime data for each step in a runtime instance of the workflow that you specify in the request.
  • POSTList workflows/ListWorkflowsLists workflow versions based on filtering parameters. To list the build versions of a specific workflow version, call ListWorkflowBuildVersions .
  • PUTPut component policy/PutComponentPolicyApplies a policy to a component. The preferred way to share resources is with the RAM API CreateResourceShare . If you use the PutComponentPolicy operation…
  • PUTPut container recipe policy/PutContainerRecipePolicyApplies a policy to a container recipe. The preferred way to share resources is with the RAM API CreateResourceShare . If you use the PutContainerRecipePolicy…
  • PUTPut image policy/PutImagePolicyApplies a policy to an image. The preferred way to share resources is with the RAM API CreateResourceShare . If you use the PutImagePolicy operation instead,…
  • PUTPut image recipe policy/PutImageRecipePolicyApplies a policy to an image recipe. The preferred way to share resources is with the RAM API CreateResourceShare . If you use the PutImageRecipePolicy…
  • PUTRetry image/RetryImageRetries a failed or canceled image build without rebuilding the phases that already completed. The image re-runs asynchronously in place: the same build…
  • PUTSend workflow step action/SendWorkflowStepActionSends an action to a workflow step that has paused at a WaitForAction step, so that image creation can continue. To find the steps that are waiting for an…
  • PUTStart image pipeline execution/StartImagePipelineExecutionManually triggers a pipeline to create an image. You can start a build this way whether the pipeline is enabled or disabled. The response returns as soon as…
  • PUTStart resource state update/StartResourceStateUpdateBegins an ad-hoc state change for the specified image build version. This is a one-time operation - if you schedule the update, it runs only once. If the…
  • PUTUpdate distribution configuration/UpdateDistributionConfigurationUpdates a distribution configuration. Distribution configurations define and configure the outputs for your images, including the target Regions, accounts,…
  • PUTUpdate image pipeline/UpdateImagePipelineUpdates an image pipeline. Use image pipelines to automate the creation and distribution of images. You must specify exactly one recipe for your image, using…
  • PUTUpdate infrastructure configuration/UpdateInfrastructureConfigurationUpdates an infrastructure configuration. An infrastructure configuration defines the environment in which Image Builder builds and tests your image. This…
  • PUTUpdate lifecycle policy/UpdateLifecyclePolicyUpdates the specified lifecycle policy. The resourceType must match the existing policy's value. This operation doesn't support selective updates. The request…

API details

Base URL
https://imagebuilder.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
77 operations on 75 pathsPUT 27POST 23GET 17DELETE 10
Description format
AWS Smithy model, API version 2019-12-02

How to test the EC2 Image Builder in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the EC2 Image Builder collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Cancel image creation” (PUT /CancelImageCreation), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the EC2 Image Builder?

EC2 Image Builder automates the creation, management, and deployment of customized, secure, and up-to-date server images. You can build Amazon Machine Images… It is listed under Media & content and has 77 endpoints.

Who publishes the EC2 Image Builder?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the EC2 Image Builder?

Requests go to https://imagebuilder.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the EC2 Image Builder?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the EC2 Image Builder have?

77 operations on 75 paths (27 PUT, 23 POST, 17 GET, 10 DELETE).

Is forking the EC2 Image Builder free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.