/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.imagebuilder; import javax.annotation.Generated; import com.amazonaws.services.imagebuilder.model.*; /** * Interface for accessing imagebuilder asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.imagebuilder.AbstractAWSimagebuilderAsync} instead. *
**
* 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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSimagebuilderAsync extends AWSimagebuilder { /** ** CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal * state. *
* * @param cancelImageCreationRequest * @return A Java Future containing the result of the CancelImageCreation operation returned by the service. * @sample AWSimagebuilderAsync.CancelImageCreation * @see AWS API Documentation */ java.util.concurrent.Future* CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal * state. *
* * @param cancelImageCreationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CancelImageCreation operation returned by the service. * @sample AWSimagebuilderAsyncHandler.CancelImageCreation * @see AWS API Documentation */ java.util.concurrent.Future* 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 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. *
* * @param createContainerRecipeRequest * @return A Java Future containing the result of the CreateContainerRecipe operation returned by the service. * @sample AWSimagebuilderAsync.CreateContainerRecipe * @see AWS API Documentation */ java.util.concurrent.Future* Creates a new container recipe. Container recipes define how images are configured, tested, and assessed. *
* * @param createContainerRecipeRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateContainerRecipe operation returned by the service. * @sample AWSimagebuilderAsyncHandler.CreateContainerRecipe * @see AWS API Documentation */ java.util.concurrent.Future* Creates a new distribution configuration. Distribution configurations define and configure the outputs of your * pipeline. *
* * @param createDistributionConfigurationRequest * @return A Java Future containing the result of the CreateDistributionConfiguration operation returned by the * service. * @sample AWSimagebuilderAsync.CreateDistributionConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* Creates a new distribution configuration. Distribution configurations define and configure the outputs of your * pipeline. *
* * @param createDistributionConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateDistributionConfiguration operation returned by the * service. * @sample AWSimagebuilderAsyncHandler.CreateDistributionConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param createImageRequest * @return A Java Future containing the result of the CreateImage operation returned by the service. * @sample AWSimagebuilderAsync.CreateImage * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param createImageRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateImage operation returned by the service. * @sample AWSimagebuilderAsyncHandler.CreateImage * @see AWS API * Documentation */ java.util.concurrent.Future* Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images. *
* * @param createImagePipelineRequest * @return A Java Future containing the result of the CreateImagePipeline operation returned by the service. * @sample AWSimagebuilderAsync.CreateImagePipeline * @see AWS API Documentation */ java.util.concurrent.Future* Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images. *
* * @param createImagePipelineRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateImagePipeline operation returned by the service. * @sample AWSimagebuilderAsyncHandler.CreateImagePipeline * @see AWS API Documentation */ java.util.concurrent.Future* Creates a new image recipe. Image recipes define how images are configured, tested, and assessed. *
* * @param createImageRecipeRequest * @return A Java Future containing the result of the CreateImageRecipe operation returned by the service. * @sample AWSimagebuilderAsync.CreateImageRecipe * @see AWS * API Documentation */ java.util.concurrent.Future* Creates a new image recipe. Image recipes define how images are configured, tested, and assessed. *
* * @param createImageRecipeRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateImageRecipe operation returned by the service. * @sample AWSimagebuilderAsyncHandler.CreateImageRecipe * @see AWS * API Documentation */ java.util.concurrent.Future* Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your * image will be built and tested. *
* * @param createInfrastructureConfigurationRequest * @return A Java Future containing the result of the CreateInfrastructureConfiguration operation returned by the * service. * @sample AWSimagebuilderAsync.CreateInfrastructureConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your * image will be built and tested. *
* * @param createInfrastructureConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateInfrastructureConfiguration operation returned by the * service. * @sample AWSimagebuilderAsyncHandler.CreateInfrastructureConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* Deletes a component build version. *
* * @param deleteComponentRequest * @return A Java Future containing the result of the DeleteComponent operation returned by the service. * @sample AWSimagebuilderAsync.DeleteComponent * @see AWS * API Documentation */ java.util.concurrent.Future* Deletes a component build version. *
* * @param deleteComponentRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteComponent operation returned by the service. * @sample AWSimagebuilderAsyncHandler.DeleteComponent * @see AWS * API Documentation */ java.util.concurrent.Future* Deletes a container recipe. *
* * @param deleteContainerRecipeRequest * @return A Java Future containing the result of the DeleteContainerRecipe operation returned by the service. * @sample AWSimagebuilderAsync.DeleteContainerRecipe * @see AWS API Documentation */ java.util.concurrent.Future* Deletes a container recipe. *
* * @param deleteContainerRecipeRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteContainerRecipe operation returned by the service. * @sample AWSimagebuilderAsyncHandler.DeleteContainerRecipe * @see AWS API Documentation */ java.util.concurrent.Future* Deletes a distribution configuration. *
* * @param deleteDistributionConfigurationRequest * @return A Java Future containing the result of the DeleteDistributionConfiguration operation returned by the * service. * @sample AWSimagebuilderAsync.DeleteDistributionConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* Deletes a distribution configuration. *
* * @param deleteDistributionConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteDistributionConfiguration operation returned by the * service. * @sample AWSimagebuilderAsyncHandler.DeleteDistributionConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* 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 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. *
* * @param deleteImagePipelineRequest * @return A Java Future containing the result of the DeleteImagePipeline operation returned by the service. * @sample AWSimagebuilderAsync.DeleteImagePipeline * @see AWS API Documentation */ java.util.concurrent.Future* Deletes an image pipeline. *
* * @param deleteImagePipelineRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteImagePipeline operation returned by the service. * @sample AWSimagebuilderAsyncHandler.DeleteImagePipeline * @see AWS API Documentation */ java.util.concurrent.Future* Deletes an image recipe. *
* * @param deleteImageRecipeRequest * @return A Java Future containing the result of the DeleteImageRecipe operation returned by the service. * @sample AWSimagebuilderAsync.DeleteImageRecipe * @see AWS * API Documentation */ java.util.concurrent.Future* Deletes an image recipe. *
* * @param deleteImageRecipeRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteImageRecipe operation returned by the service. * @sample AWSimagebuilderAsyncHandler.DeleteImageRecipe * @see AWS * API Documentation */ java.util.concurrent.Future* Deletes an infrastructure configuration. *
* * @param deleteInfrastructureConfigurationRequest * @return A Java Future containing the result of the DeleteInfrastructureConfiguration operation returned by the * service. * @sample AWSimagebuilderAsync.DeleteInfrastructureConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* Deletes an infrastructure configuration. *
* * @param deleteInfrastructureConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteInfrastructureConfiguration operation returned by the * service. * @sample AWSimagebuilderAsyncHandler.DeleteInfrastructureConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* Gets a component object. *
* * @param getComponentRequest * @return A Java Future containing the result of the GetComponent operation returned by the service. * @sample AWSimagebuilderAsync.GetComponent * @see AWS API * Documentation */ java.util.concurrent.Future* Gets a component object. *
* * @param getComponentRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetComponent operation returned by the service. * @sample AWSimagebuilderAsyncHandler.GetComponent * @see AWS API * Documentation */ java.util.concurrent.Future* Gets a component policy. *
* * @param getComponentPolicyRequest * @return A Java Future containing the result of the GetComponentPolicy operation returned by the service. * @sample AWSimagebuilderAsync.GetComponentPolicy * @see AWS API Documentation */ java.util.concurrent.Future* Gets a component policy. *
* * @param getComponentPolicyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetComponentPolicy operation returned by the service. * @sample AWSimagebuilderAsyncHandler.GetComponentPolicy * @see AWS API Documentation */ java.util.concurrent.Future* Retrieves a container recipe. *
* * @param getContainerRecipeRequest * @return A Java Future containing the result of the GetContainerRecipe operation returned by the service. * @sample AWSimagebuilderAsync.GetContainerRecipe * @see AWS API Documentation */ java.util.concurrent.Future* Retrieves a container recipe. *
* * @param getContainerRecipeRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetContainerRecipe operation returned by the service. * @sample AWSimagebuilderAsyncHandler.GetContainerRecipe * @see AWS API Documentation */ java.util.concurrent.Future* Retrieves the policy for a container recipe. *
* * @param getContainerRecipePolicyRequest * @return A Java Future containing the result of the GetContainerRecipePolicy operation returned by the service. * @sample AWSimagebuilderAsync.GetContainerRecipePolicy * @see AWS API Documentation */ java.util.concurrent.Future* Retrieves the policy for a container recipe. *
* * @param getContainerRecipePolicyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetContainerRecipePolicy operation returned by the service. * @sample AWSimagebuilderAsyncHandler.GetContainerRecipePolicy * @see AWS API Documentation */ java.util.concurrent.Future* Gets a distribution configuration. *
* * @param getDistributionConfigurationRequest * @return A Java Future containing the result of the GetDistributionConfiguration operation returned by the * service. * @sample AWSimagebuilderAsync.GetDistributionConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* Gets a distribution configuration. *
* * @param getDistributionConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetDistributionConfiguration operation returned by the * service. * @sample AWSimagebuilderAsyncHandler.GetDistributionConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* Gets an image. *
* * @param getImageRequest * @return A Java Future containing the result of the GetImage operation returned by the service. * @sample AWSimagebuilderAsync.GetImage * @see AWS API * Documentation */ java.util.concurrent.Future* Gets an image. *
* * @param getImageRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetImage operation returned by the service. * @sample AWSimagebuilderAsyncHandler.GetImage * @see AWS API * Documentation */ java.util.concurrent.Future* Gets an image pipeline. *
* * @param getImagePipelineRequest * @return A Java Future containing the result of the GetImagePipeline operation returned by the service. * @sample AWSimagebuilderAsync.GetImagePipeline * @see AWS * API Documentation */ java.util.concurrent.Future* Gets an image pipeline. *
* * @param getImagePipelineRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetImagePipeline operation returned by the service. * @sample AWSimagebuilderAsyncHandler.GetImagePipeline * @see AWS * API Documentation */ java.util.concurrent.Future* Gets an image policy. *
* * @param getImagePolicyRequest * @return A Java Future containing the result of the GetImagePolicy operation returned by the service. * @sample AWSimagebuilderAsync.GetImagePolicy * @see AWS * API Documentation */ java.util.concurrent.Future* Gets an image policy. *
* * @param getImagePolicyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetImagePolicy operation returned by the service. * @sample AWSimagebuilderAsyncHandler.GetImagePolicy * @see AWS * API Documentation */ java.util.concurrent.Future* Gets an image recipe. *
* * @param getImageRecipeRequest * @return A Java Future containing the result of the GetImageRecipe operation returned by the service. * @sample AWSimagebuilderAsync.GetImageRecipe * @see AWS * API Documentation */ java.util.concurrent.Future* Gets an image recipe. *
* * @param getImageRecipeRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetImageRecipe operation returned by the service. * @sample AWSimagebuilderAsyncHandler.GetImageRecipe * @see AWS * API Documentation */ java.util.concurrent.Future* Gets an image recipe policy. *
* * @param getImageRecipePolicyRequest * @return A Java Future containing the result of the GetImageRecipePolicy operation returned by the service. * @sample AWSimagebuilderAsync.GetImageRecipePolicy * @see AWS API Documentation */ java.util.concurrent.Future* Gets an image recipe policy. *
* * @param getImageRecipePolicyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetImageRecipePolicy operation returned by the service. * @sample AWSimagebuilderAsyncHandler.GetImageRecipePolicy * @see AWS API Documentation */ java.util.concurrent.Future* Gets an infrastructure configuration. *
* * @param getInfrastructureConfigurationRequest * GetInfrastructureConfiguration request object. * @return A Java Future containing the result of the GetInfrastructureConfiguration operation returned by the * service. * @sample AWSimagebuilderAsync.GetInfrastructureConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* Gets an infrastructure configuration. *
* * @param getInfrastructureConfigurationRequest * GetInfrastructureConfiguration request object. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetInfrastructureConfiguration operation returned by the * service. * @sample AWSimagebuilderAsyncHandler.GetInfrastructureConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* Get the runtime information that was logged for a specific runtime instance of the workflow. *
* * @param getWorkflowExecutionRequest * @return A Java Future containing the result of the GetWorkflowExecution operation returned by the service. * @sample AWSimagebuilderAsync.GetWorkflowExecution * @see AWS API Documentation */ java.util.concurrent.Future* Get the runtime information that was logged for a specific runtime instance of the workflow. *
* * @param getWorkflowExecutionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetWorkflowExecution operation returned by the service. * @sample AWSimagebuilderAsyncHandler.GetWorkflowExecution * @see AWS API Documentation */ java.util.concurrent.Future* Get the runtime information that was logged for a specific runtime instance of the workflow step. *
* * @param getWorkflowStepExecutionRequest * @return A Java Future containing the result of the GetWorkflowStepExecution operation returned by the service. * @sample AWSimagebuilderAsync.GetWorkflowStepExecution * @see AWS API Documentation */ java.util.concurrent.Future* Get the runtime information that was logged for a specific runtime instance of the workflow step. *
* * @param getWorkflowStepExecutionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetWorkflowStepExecution operation returned by the service. * @sample AWSimagebuilderAsyncHandler.GetWorkflowStepExecution * @see AWS API Documentation */ java.util.concurrent.Future* Imports a component and transforms its data into a component document. *
* * @param importComponentRequest * @return A Java Future containing the result of the ImportComponent operation returned by the service. * @sample AWSimagebuilderAsync.ImportComponent * @see AWS * API Documentation */ java.util.concurrent.Future* Imports a component and transforms its data into a component document. *
* * @param importComponentRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ImportComponent operation returned by the service. * @sample AWSimagebuilderAsyncHandler.ImportComponent * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param importVmImageRequest * @return A Java Future containing the result of the ImportVmImage operation returned by the service. * @sample AWSimagebuilderAsync.ImportVmImage * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param importVmImageRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ImportVmImage operation returned by the service. * @sample AWSimagebuilderAsyncHandler.ImportVmImage * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
** 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. *
*
* 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. *
*
* 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. *
** Returns a list of container recipes. *
* * @param listContainerRecipesRequest * @return A Java Future containing the result of the ListContainerRecipes operation returned by the service. * @sample AWSimagebuilderAsync.ListContainerRecipes * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of container recipes. *
* * @param listContainerRecipesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListContainerRecipes operation returned by the service. * @sample AWSimagebuilderAsyncHandler.ListContainerRecipes * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of distribution configurations. *
* * @param listDistributionConfigurationsRequest * @return A Java Future containing the result of the ListDistributionConfigurations operation returned by the * service. * @sample AWSimagebuilderAsync.ListDistributionConfigurations * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of distribution configurations. *
* * @param listDistributionConfigurationsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListDistributionConfigurations operation returned by the * service. * @sample AWSimagebuilderAsyncHandler.ListDistributionConfigurations * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of image build versions. *
* * @param listImageBuildVersionsRequest * @return A Java Future containing the result of the ListImageBuildVersions operation returned by the service. * @sample AWSimagebuilderAsync.ListImageBuildVersions * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of image build versions. *
* * @param listImageBuildVersionsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListImageBuildVersions operation returned by the service. * @sample AWSimagebuilderAsyncHandler.ListImageBuildVersions * @see AWS API Documentation */ java.util.concurrent.Future* List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems * Manager Inventory at build time. *
* * @param listImagePackagesRequest * @return A Java Future containing the result of the ListImagePackages operation returned by the service. * @sample AWSimagebuilderAsync.ListImagePackages * @see AWS * API Documentation */ java.util.concurrent.Future* List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems * Manager Inventory at build time. *
* * @param listImagePackagesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListImagePackages operation returned by the service. * @sample AWSimagebuilderAsyncHandler.ListImagePackages * @see AWS * API Documentation */ java.util.concurrent.Future* Returns a list of images created by the specified pipeline. *
* * @param listImagePipelineImagesRequest * @return A Java Future containing the result of the ListImagePipelineImages operation returned by the service. * @sample AWSimagebuilderAsync.ListImagePipelineImages * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of images created by the specified pipeline. *
* * @param listImagePipelineImagesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListImagePipelineImages operation returned by the service. * @sample AWSimagebuilderAsyncHandler.ListImagePipelineImages * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of image pipelines. *
* * @param listImagePipelinesRequest * @return A Java Future containing the result of the ListImagePipelines operation returned by the service. * @sample AWSimagebuilderAsync.ListImagePipelines * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of image pipelines. *
* * @param listImagePipelinesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListImagePipelines operation returned by the service. * @sample AWSimagebuilderAsyncHandler.ListImagePipelines * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of image recipes. *
* * @param listImageRecipesRequest * @return A Java Future containing the result of the ListImageRecipes operation returned by the service. * @sample AWSimagebuilderAsync.ListImageRecipes * @see AWS * API Documentation */ java.util.concurrent.Future* Returns a list of image recipes. *
* * @param listImageRecipesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListImageRecipes operation returned by the service. * @sample AWSimagebuilderAsyncHandler.ListImageRecipes * @see AWS * API Documentation */ java.util.concurrent.Future
* 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
*
* 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
*
* Returns a list of image scan findings for your account. *
* * @param listImageScanFindingsRequest * @return A Java Future containing the result of the ListImageScanFindings operation returned by the service. * @sample AWSimagebuilderAsync.ListImageScanFindings * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of image scan findings for your account. *
* * @param listImageScanFindingsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListImageScanFindings operation returned by the service. * @sample AWSimagebuilderAsyncHandler.ListImageScanFindings * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listImagesRequest * @return A Java Future containing the result of the ListImages operation returned by the service. * @sample AWSimagebuilderAsync.ListImages * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param listImagesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListImages operation returned by the service. * @sample AWSimagebuilderAsyncHandler.ListImages * @see AWS API * Documentation */ java.util.concurrent.Future* Returns a list of infrastructure configurations. *
* * @param listInfrastructureConfigurationsRequest * @return A Java Future containing the result of the ListInfrastructureConfigurations operation returned by the * service. * @sample AWSimagebuilderAsync.ListInfrastructureConfigurations * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of infrastructure configurations. *
* * @param listInfrastructureConfigurationsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListInfrastructureConfigurations operation returned by the * service. * @sample AWSimagebuilderAsyncHandler.ListInfrastructureConfigurations * @see AWS API Documentation */ java.util.concurrent.Future* Returns the list of tags for the specified resource. *
* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSimagebuilderAsync.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future* Returns the list of tags for the specified resource. *
* * @param listTagsForResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSimagebuilderAsyncHandler.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of workflow runtime instance metadata objects for a specific image build version. *
* * @param listWorkflowExecutionsRequest * @return A Java Future containing the result of the ListWorkflowExecutions operation returned by the service. * @sample AWSimagebuilderAsync.ListWorkflowExecutions * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of workflow runtime instance metadata objects for a specific image build version. *
* * @param listWorkflowExecutionsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListWorkflowExecutions operation returned by the service. * @sample AWSimagebuilderAsyncHandler.ListWorkflowExecutions * @see AWS API Documentation */ java.util.concurrent.Future* Shows runtime data for each step in a runtime instance of the workflow that you specify in the request. *
* * @param listWorkflowStepExecutionsRequest * @return A Java Future containing the result of the ListWorkflowStepExecutions operation returned by the service. * @sample AWSimagebuilderAsync.ListWorkflowStepExecutions * @see AWS API Documentation */ java.util.concurrent.Future* Shows runtime data for each step in a runtime instance of the workflow that you specify in the request. *
* * @param listWorkflowStepExecutionsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListWorkflowStepExecutions operation returned by the service. * @sample AWSimagebuilderAsyncHandler.ListWorkflowStepExecutions * @see AWS API Documentation */ java.util.concurrent.Future
* 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 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 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. 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.
*
* 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.
*
* Manually triggers a pipeline to create an image. *
* * @param startImagePipelineExecutionRequest * @return A Java Future containing the result of the StartImagePipelineExecution operation returned by the service. * @sample AWSimagebuilderAsync.StartImagePipelineExecution * @see AWS API Documentation */ java.util.concurrent.Future* Manually triggers a pipeline to create an image. *
* * @param startImagePipelineExecutionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StartImagePipelineExecution operation returned by the service. * @sample AWSimagebuilderAsyncHandler.StartImagePipelineExecution * @see AWS API Documentation */ java.util.concurrent.Future* Adds a tag to a resource. *
* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSimagebuilderAsync.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Adds a tag to a resource. *
* * @param tagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSimagebuilderAsyncHandler.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Removes a tag from a resource. *
* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSimagebuilderAsync.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Removes a tag from a resource. *
* * @param untagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSimagebuilderAsyncHandler.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Updates a new distribution configuration. Distribution configurations define and configure the outputs of your * pipeline. *
* * @param updateDistributionConfigurationRequest * @return A Java Future containing the result of the UpdateDistributionConfiguration operation returned by the * service. * @sample AWSimagebuilderAsync.UpdateDistributionConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* Updates a new distribution configuration. Distribution configurations define and configure the outputs of your * pipeline. *
* * @param updateDistributionConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateDistributionConfiguration operation returned by the * service. * @sample AWSimagebuilderAsyncHandler.UpdateDistributionConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
** 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. *
** Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your * image will be built and tested. *
* * @param updateInfrastructureConfigurationRequest * @return A Java Future containing the result of the UpdateInfrastructureConfiguration operation returned by the * service. * @sample AWSimagebuilderAsync.UpdateInfrastructureConfiguration * @see AWS API Documentation */ java.util.concurrent.Future* Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your * image will be built and tested. *
* * @param updateInfrastructureConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateInfrastructureConfiguration operation returned by the * service. * @sample AWSimagebuilderAsyncHandler.UpdateInfrastructureConfiguration * @see AWS API Documentation */ java.util.concurrent.Future