Imagebuilder

import { Imagebuilder } from "https://aws-api.deno.dev/v0.3/services/imagebuilder.ts?docs=full";

class Imagebuilder {

constructor(apiFactory: client.ApiFactory);

async cancelImageCreation(params: CancelImageCreationRequest, opts?: client.RequestOptions): Promise<CancelImageCreationResponse>;

async createComponent(params: CreateComponentRequest, opts?: client.RequestOptions): Promise<CreateComponentResponse>;

async createContainerRecipe(params: CreateContainerRecipeRequest, opts?: client.RequestOptions): Promise<CreateContainerRecipeResponse>;

async createDistributionConfiguration(params: CreateDistributionConfigurationRequest, opts?: client.RequestOptions): Promise<CreateDistributionConfigurationResponse>;

async createImage(params: CreateImageRequest, opts?: client.RequestOptions): Promise<CreateImageResponse>;

async createImagePipeline(params: CreateImagePipelineRequest, opts?: client.RequestOptions): Promise<CreateImagePipelineResponse>;

async createImageRecipe(params: CreateImageRecipeRequest, opts?: client.RequestOptions): Promise<CreateImageRecipeResponse>;

async createInfrastructureConfiguration(params: CreateInfrastructureConfigurationRequest, opts?: client.RequestOptions): Promise<CreateInfrastructureConfigurationResponse>;

async deleteComponent(params: DeleteComponentRequest, opts?: client.RequestOptions): Promise<DeleteComponentResponse>;

async deleteContainerRecipe(params: DeleteContainerRecipeRequest, opts?: client.RequestOptions): Promise<DeleteContainerRecipeResponse>;

async deleteDistributionConfiguration(params: DeleteDistributionConfigurationRequest, opts?: client.RequestOptions): Promise<DeleteDistributionConfigurationResponse>;

async deleteImage(params: DeleteImageRequest, opts?: client.RequestOptions): Promise<DeleteImageResponse>;

async deleteImagePipeline(params: DeleteImagePipelineRequest, opts?: client.RequestOptions): Promise<DeleteImagePipelineResponse>;

async deleteImageRecipe(params: DeleteImageRecipeRequest, opts?: client.RequestOptions): Promise<DeleteImageRecipeResponse>;

async deleteInfrastructureConfiguration(params: DeleteInfrastructureConfigurationRequest, opts?: client.RequestOptions): Promise<DeleteInfrastructureConfigurationResponse>;

async getComponent(params: GetComponentRequest, opts?: client.RequestOptions): Promise<GetComponentResponse>;

async getComponentPolicy(params: GetComponentPolicyRequest, opts?: client.RequestOptions): Promise<GetComponentPolicyResponse>;

async getContainerRecipe(params: GetContainerRecipeRequest, opts?: client.RequestOptions): Promise<GetContainerRecipeResponse>;

async getContainerRecipePolicy(params: GetContainerRecipePolicyRequest, opts?: client.RequestOptions): Promise<GetContainerRecipePolicyResponse>;

async getDistributionConfiguration(params: GetDistributionConfigurationRequest, opts?: client.RequestOptions): Promise<GetDistributionConfigurationResponse>;

async getImage(params: GetImageRequest, opts?: client.RequestOptions): Promise<GetImageResponse>;

async getImagePipeline(params: GetImagePipelineRequest, opts?: client.RequestOptions): Promise<GetImagePipelineResponse>;

async getImagePolicy(params: GetImagePolicyRequest, opts?: client.RequestOptions): Promise<GetImagePolicyResponse>;

async getImageRecipe(params: GetImageRecipeRequest, opts?: client.RequestOptions): Promise<GetImageRecipeResponse>;

async getImageRecipePolicy(params: GetImageRecipePolicyRequest, opts?: client.RequestOptions): Promise<GetImageRecipePolicyResponse>;

async getInfrastructureConfiguration(params: GetInfrastructureConfigurationRequest, opts?: client.RequestOptions): Promise<GetInfrastructureConfigurationResponse>;

async importComponent(params: ImportComponentRequest, opts?: client.RequestOptions): Promise<ImportComponentResponse>;

async importVmImage(params: ImportVmImageRequest, opts?: client.RequestOptions): Promise<ImportVmImageResponse>;

async listComponentBuildVersions(params: ListComponentBuildVersionsRequest, opts?: client.RequestOptions): Promise<ListComponentBuildVersionsResponse>;

async listComponents(params?: ListComponentsRequest, opts?: client.RequestOptions): Promise<ListComponentsResponse>;

async listContainerRecipes(params?: ListContainerRecipesRequest, opts?: client.RequestOptions): Promise<ListContainerRecipesResponse>;

async listDistributionConfigurations(params?: ListDistributionConfigurationsRequest, opts?: client.RequestOptions): Promise<ListDistributionConfigurationsResponse>;

async listImageBuildVersions(params: ListImageBuildVersionsRequest, opts?: client.RequestOptions): Promise<ListImageBuildVersionsResponse>;

async listImagePackages(params: ListImagePackagesRequest, opts?: client.RequestOptions): Promise<ListImagePackagesResponse>;

async listImagePipelineImages(params: ListImagePipelineImagesRequest, opts?: client.RequestOptions): Promise<ListImagePipelineImagesResponse>;

async listImagePipelines(params?: ListImagePipelinesRequest, opts?: client.RequestOptions): Promise<ListImagePipelinesResponse>;

async listImageRecipes(params?: ListImageRecipesRequest, opts?: client.RequestOptions): Promise<ListImageRecipesResponse>;

async listImages(params?: ListImagesRequest, opts?: client.RequestOptions): Promise<ListImagesResponse>;

async listInfrastructureConfigurations(params?: ListInfrastructureConfigurationsRequest, opts?: client.RequestOptions): Promise<ListInfrastructureConfigurationsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async putComponentPolicy(params: PutComponentPolicyRequest, opts?: client.RequestOptions): Promise<PutComponentPolicyResponse>;

async putContainerRecipePolicy(params: PutContainerRecipePolicyRequest, opts?: client.RequestOptions): Promise<PutContainerRecipePolicyResponse>;

async putImagePolicy(params: PutImagePolicyRequest, opts?: client.RequestOptions): Promise<PutImagePolicyResponse>;

async putImageRecipePolicy(params: PutImageRecipePolicyRequest, opts?: client.RequestOptions): Promise<PutImageRecipePolicyResponse>;

async startImagePipelineExecution(params: StartImagePipelineExecutionRequest, opts?: client.RequestOptions): Promise<StartImagePipelineExecutionResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateDistributionConfiguration(params: UpdateDistributionConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateDistributionConfigurationResponse>;

async updateImagePipeline(params: UpdateImagePipelineRequest, opts?: client.RequestOptions): Promise<UpdateImagePipelineResponse>;

async updateInfrastructureConfiguration(params: UpdateInfrastructureConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateInfrastructureConfigurationResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Imagebuilder(apiFactory: client.ApiFactory)

[src]

§Methods

cancelImageCreation(params: CancelImageCreationRequest, opts?: client.RequestOptions): Promise<CancelImageCreationResponse>

[src]

CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.

createComponent(params: CreateComponentRequest, opts?: client.RequestOptions): Promise<CreateComponentResponse>

[src]

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

createContainerRecipe(params: CreateContainerRecipeRequest, opts?: client.RequestOptions): Promise<CreateContainerRecipeResponse>

[src]

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

createDistributionConfiguration(params: CreateDistributionConfigurationRequest, opts?: client.RequestOptions): Promise<CreateDistributionConfigurationResponse>

[src]

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

createImage(params: CreateImageRequest, opts?: client.RequestOptions): Promise<CreateImageResponse>

[src]

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(params: CreateImagePipelineRequest, opts?: client.RequestOptions): Promise<CreateImagePipelineResponse>

[src]

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

createImageRecipe(params: CreateImageRecipeRequest, opts?: client.RequestOptions): Promise<CreateImageRecipeResponse>

[src]

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

createInfrastructureConfiguration(params: CreateInfrastructureConfigurationRequest, opts?: client.RequestOptions): Promise<CreateInfrastructureConfigurationResponse>

[src]

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

deleteComponent(params: DeleteComponentRequest, opts?: client.RequestOptions): Promise<DeleteComponentResponse>

[src]

Deletes a component build version.

deleteContainerRecipe(params: DeleteContainerRecipeRequest, opts?: client.RequestOptions): Promise<DeleteContainerRecipeResponse>

[src]

Deletes a container recipe.

deleteDistributionConfiguration(params: DeleteDistributionConfigurationRequest, opts?: client.RequestOptions): Promise<DeleteDistributionConfigurationResponse>

[src]

Deletes a distribution configuration.

deleteImage(params: DeleteImageRequest, opts?: client.RequestOptions): Promise<DeleteImageResponse>

[src]

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.

deleteImagePipeline(params: DeleteImagePipelineRequest, opts?: client.RequestOptions): Promise<DeleteImagePipelineResponse>

[src]

Deletes an image pipeline.

deleteImageRecipe(params: DeleteImageRecipeRequest, opts?: client.RequestOptions): Promise<DeleteImageRecipeResponse>

[src]

Deletes an image recipe.

deleteInfrastructureConfiguration(params: DeleteInfrastructureConfigurationRequest, opts?: client.RequestOptions): Promise<DeleteInfrastructureConfigurationResponse>

[src]

Deletes an infrastructure configuration.

getComponent(params: GetComponentRequest, opts?: client.RequestOptions): Promise<GetComponentResponse>

[src]

Gets a component object.

getComponentPolicy(params: GetComponentPolicyRequest, opts?: client.RequestOptions): Promise<GetComponentPolicyResponse>

[src]

Gets a component policy.

getContainerRecipe(params: GetContainerRecipeRequest, opts?: client.RequestOptions): Promise<GetContainerRecipeResponse>

[src]

Retrieves a container recipe.

getContainerRecipePolicy(params: GetContainerRecipePolicyRequest, opts?: client.RequestOptions): Promise<GetContainerRecipePolicyResponse>

[src]

Retrieves the policy for a container recipe.

getDistributionConfiguration(params: GetDistributionConfigurationRequest, opts?: client.RequestOptions): Promise<GetDistributionConfigurationResponse>

[src]

Gets a distribution configuration.

getImage(params: GetImageRequest, opts?: client.RequestOptions): Promise<GetImageResponse>

[src]

Gets an image.

getImagePipeline(params: GetImagePipelineRequest, opts?: client.RequestOptions): Promise<GetImagePipelineResponse>

[src]

Gets an image pipeline.

getImagePolicy(params: GetImagePolicyRequest, opts?: client.RequestOptions): Promise<GetImagePolicyResponse>

[src]

Gets an image policy.

getImageRecipe(params: GetImageRecipeRequest, opts?: client.RequestOptions): Promise<GetImageRecipeResponse>

[src]

Gets an image recipe.

getImageRecipePolicy(params: GetImageRecipePolicyRequest, opts?: client.RequestOptions): Promise<GetImageRecipePolicyResponse>

[src]

Gets an image recipe policy.

getInfrastructureConfiguration(params: GetInfrastructureConfigurationRequest, opts?: client.RequestOptions): Promise<GetInfrastructureConfigurationResponse>

[src]

Gets an infrastructure configuration.

importComponent(params: ImportComponentRequest, opts?: client.RequestOptions): Promise<ImportComponentResponse>

[src]

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

importVmImage(params: ImportVmImageRequest, opts?: client.RequestOptions): Promise<ImportVmImageResponse>

[src]

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.

listComponentBuildVersions(params: ListComponentBuildVersionsRequest, opts?: client.RequestOptions): Promise<ListComponentBuildVersionsResponse>

[src]

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

Note: 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.

listComponents(params?: ListComponentsRequest, opts?: client.RequestOptions): Promise<ListComponentsResponse>

[src]

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

listContainerRecipes(params?: ListContainerRecipesRequest, opts?: client.RequestOptions): Promise<ListContainerRecipesResponse>

[src]

Returns a list of container recipes.

listDistributionConfigurations(params?: ListDistributionConfigurationsRequest, opts?: client.RequestOptions): Promise<ListDistributionConfigurationsResponse>

[src]

Returns a list of distribution configurations.

listImageBuildVersions(params: ListImageBuildVersionsRequest, opts?: client.RequestOptions): Promise<ListImageBuildVersionsResponse>

[src]

Returns a list of image build versions.

listImagePackages(params: ListImagePackagesRequest, opts?: client.RequestOptions): Promise<ListImagePackagesResponse>

[src]

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

listImagePipelineImages(params: ListImagePipelineImagesRequest, opts?: client.RequestOptions): Promise<ListImagePipelineImagesResponse>

[src]

Returns a list of images created by the specified pipeline.

listImagePipelines(params?: ListImagePipelinesRequest, opts?: client.RequestOptions): Promise<ListImagePipelinesResponse>

[src]

Returns a list of image pipelines.

listImageRecipes(params?: ListImageRecipesRequest, opts?: client.RequestOptions): Promise<ListImageRecipesResponse>

[src]

Returns a list of image recipes.

listImages(params?: ListImagesRequest, opts?: client.RequestOptions): Promise<ListImagesResponse>

[src]

Returns the list of images that you have access to.

listInfrastructureConfigurations(params?: ListInfrastructureConfigurationsRequest, opts?: client.RequestOptions): Promise<ListInfrastructureConfigurationsResponse>

[src]

Returns a list of infrastructure configurations.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Returns the list of tags for the specified resource.

putComponentPolicy(params: PutComponentPolicyRequest, opts?: client.RequestOptions): Promise<PutComponentPolicyResponse>

[src]

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.

putContainerRecipePolicy(params: PutContainerRecipePolicyRequest, opts?: client.RequestOptions): Promise<PutContainerRecipePolicyResponse>

[src]

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.

putImagePolicy(params: PutImagePolicyRequest, opts?: client.RequestOptions): Promise<PutImagePolicyResponse>

[src]

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.

putImageRecipePolicy(params: PutImageRecipePolicyRequest, opts?: client.RequestOptions): Promise<PutImageRecipePolicyResponse>

[src]

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.

startImagePipelineExecution(params: StartImagePipelineExecutionRequest, opts?: client.RequestOptions): Promise<StartImagePipelineExecutionResponse>

[src]

Manually triggers a pipeline to create an image.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds a tag to a resource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes a tag from a resource.

updateDistributionConfiguration(params: UpdateDistributionConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateDistributionConfigurationResponse>

[src]

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

updateImagePipeline(params: UpdateImagePipelineRequest, opts?: client.RequestOptions): Promise<UpdateImagePipelineResponse>

[src]

Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images.

Note: 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(params: UpdateInfrastructureConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateInfrastructureConfigurationResponse>

[src]

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

§Static Properties

ApiMetadata: client.ApiMetadata

[src]