Skip to content

EC2 Image Builder API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

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.

EC2 Image Builder is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 56 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2019-12-02
Endpoints
56
Spec updated
2020-04-16

Endpoints

MethodPathWhat it does
PUT/CancelImageCreationCancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
PUT/CreateComponent<p>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 ex
PUT/CreateContainerRecipeCreates a new container recipe. Container recipes define how images are configured, tested, and assessed.
PUT/CreateDistributionConfigurationCreates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
PUT/CreateImageCreates 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
PUT/CreateImagePipelineCreates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
PUT/CreateImageRecipeCreates a new image recipe. Image recipes define how images are configured, tested, and assessed.
PUT/CreateInfrastructureConfigurationCreates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
DELETE/DeleteComponent#componentBuildVersionArnDeletes a component build version.
DELETE/DeleteContainerRecipe#containerRecipeArnDeletes a container recipe.
DELETE/DeleteDistributionConfiguration#distributionConfigurationArnDeletes a distribution configuration.
DELETE/DeleteImage#imageBuildVersionArn<p>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
DELETE/DeleteImagePipeline#imagePipelineArnDeletes an image pipeline.
DELETE/DeleteImageRecipe#imageRecipeArnDeletes an image recipe.
DELETE/DeleteInfrastructureConfiguration#infrastructureConfigurationArnDeletes an infrastructure configuration.
GET/GetComponent#componentBuildVersionArnGets a component object.
GET/GetComponentPolicy#componentArnGets a component policy.
GET/GetContainerRecipe#containerRecipeArnRetrieves a container recipe.
GET/GetContainerRecipePolicy#containerRecipeArnRetrieves the policy for a container recipe.
GET/GetDistributionConfiguration#distributionConfigurationArnGets a distribution configuration.
GET/GetImage#imageBuildVersionArnGets an image.
GET/GetImagePipeline#imagePipelineArnGets an image pipeline.
GET/GetImagePolicy#imageArnGets an image policy.
GET/GetImageRecipe#imageRecipeArnGets an image recipe.
GET/GetImageRecipePolicy#imageRecipeArnGets an image recipe policy.
GET/GetInfrastructureConfiguration#infrastructureConfigurationArnGets an infrastructure configuration.
GET/GetWorkflowExecution#workflowExecutionIdGet the runtime information that was logged for a specific runtime instance of the workflow.
GET/GetWorkflowStepExecution#stepExecutionIdGet the runtime information that was logged for a specific runtime instance of the workflow step.
PUT/ImportComponentImports a component and transforms its data into a component document.
PUT/ImportVmImage<p>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 sna
POST/ListComponentBuildVersions<p>Returns the list of component build versions for the specified semantic version.</p> <note> <p>The semantic version has four nodes: &lt;major&gt;.&lt;minor&g
POST/ListComponents<p>Returns the list of components that can be filtered by name, or by using the listed <code>filters</code> to streamline results. Newly created components can
POST/ListContainerRecipesReturns a list of container recipes.
POST/ListDistributionConfigurationsReturns a list of distribution configurations.
POST/ListImageBuildVersionsReturns a list of image build versions.
POST/ListImagePackagesList the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.
POST/ListImagePipelineImagesReturns a list of images created by the specified pipeline.
POST/ListImagePipelinesReturns a list of image pipelines.
POST/ListImageRecipesReturns a list of image recipes.
POST/ListImageScanFindingAggregations<p>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 w
POST/ListImageScanFindingsReturns a list of image scan findings for your account.
POST/ListImagesReturns 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.
POST/ListInfrastructureConfigurationsReturns a list of infrastructure configurations.
GET/tags/{resourceArn}Returns the list of tags for the specified resource.
POST/tags/{resourceArn}Adds a tag to a resource.
POST/ListWorkflowExecutionsReturns a list of workflow runtime instance metadata objects for a specific image build version.
POST/ListWorkflowStepExecutionsShows runtime data for each step in a runtime instance of the workflow that you specify in the request.
PUT/PutComponentPolicyApplies a policy to a component. We recommend that you call the RAM API <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.htm
PUT/PutContainerRecipePolicyApplies a policy to a container image. We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com//ram/latest/APIReference/API_Crea
PUT/PutImagePolicyApplies a policy to an image. We recommend that you call the RAM API <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html">
PUT/PutImageRecipePolicyApplies a policy to an image recipe. We recommend that you call the RAM API <a href="https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare
PUT/StartImagePipelineExecutionManually triggers a pipeline to create an image.
DELETE/tags/{resourceArn}#tagKeysRemoves a tag from a resource.
PUT/UpdateDistributionConfigurationUpdates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
PUT/UpdateImagePipeline<p>Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images.</p> <note> <p>UpdateImagePipeline does not support
PUT/UpdateInfrastructureConfigurationUpdates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.

Questions

Does the EC2 Image Builder API need an API key?

Yes. The EC2 Image Builder API uses API key authentication; the documentation explains how to get credentials.

Does the EC2 Image Builder API support HTTPS?

Yes, the EC2 Image Builder API is served over HTTPS.

How many endpoints does the EC2 Image Builder API have?

Its OpenAPI description lists 56 endpoints in version 2019-12-02. All of them are shown on this page.

What are alternatives to the EC2 Image Builder API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).