/* * 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.*; import com.amazonaws.regions.*; import com.amazonaws.services.imagebuilder.model.*; /** * Interface for accessing imagebuilder. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.imagebuilder.AbstractAWSimagebuilder} 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 AWSimagebuilder { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "imagebuilder"; /** *

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

* * @param cancelImageCreationRequest * @return Result of the CancelImageCreation operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws IdempotentParameterMismatchException * You have specified a client token for an operation using parameter values that differ from a previous * request that used the same client token. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws ResourceInUseException * The resource that you are trying to operate on is currently in use. Review the message details and retry * later. * @sample AWSimagebuilder.CancelImageCreation * @see AWS API Documentation */ CancelImageCreationResult cancelImageCreation(CancelImageCreationRequest cancelImageCreationRequest); /** *

* 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: *

* * * @param createComponentRequest * @return Result of the CreateComponent operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws IdempotentParameterMismatchException * You have specified a client token for an operation using parameter values that differ from a previous * request that used the same client token. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws InvalidVersionNumberException * Your version number is out of bounds or does not follow the required syntax. * @throws ResourceInUseException * The resource that you are trying to operate on is currently in use. Review the message details and retry * later. * @throws InvalidParameterCombinationException * You have specified two or more mutually exclusive parameters. Review the error message for details. * @throws ServiceQuotaExceededException * You have exceeded the number of permitted resources or operations for this service. For service quotas, * see EC2 * Image Builder endpoints and quotas. * @sample AWSimagebuilder.CreateComponent * @see AWS * API Documentation */ CreateComponentResult createComponent(CreateComponentRequest createComponentRequest); /** *

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

* * @param createContainerRecipeRequest * @return Result of the CreateContainerRecipe operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws IdempotentParameterMismatchException * You have specified a client token for an operation using parameter values that differ from a previous * request that used the same client token. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws InvalidVersionNumberException * Your version number is out of bounds or does not follow the required syntax. * @throws ResourceInUseException * The resource that you are trying to operate on is currently in use. Review the message details and retry * later. * @throws ResourceAlreadyExistsException * The resource that you are trying to create already exists. * @throws ServiceQuotaExceededException * You have exceeded the number of permitted resources or operations for this service. For service quotas, * see EC2 * Image Builder endpoints and quotas. * @sample AWSimagebuilder.CreateContainerRecipe * @see AWS API Documentation */ CreateContainerRecipeResult createContainerRecipe(CreateContainerRecipeRequest createContainerRecipeRequest); /** *

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

* * @param createDistributionConfigurationRequest * @return Result of the CreateDistributionConfiguration operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws IdempotentParameterMismatchException * You have specified a client token for an operation using parameter values that differ from a previous * request that used the same client token. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws ResourceInUseException * The resource that you are trying to operate on is currently in use. Review the message details and retry * later. * @throws ResourceAlreadyExistsException * The resource that you are trying to create already exists. * @throws InvalidParameterCombinationException * You have specified two or more mutually exclusive parameters. Review the error message for details. * @throws ServiceQuotaExceededException * You have exceeded the number of permitted resources or operations for this service. For service quotas, * see EC2 * Image Builder endpoints and quotas. * @sample AWSimagebuilder.CreateDistributionConfiguration * @see AWS API Documentation */ CreateDistributionConfigurationResult createDistributionConfiguration(CreateDistributionConfigurationRequest createDistributionConfigurationRequest); /** *

* 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 Result of the CreateImage operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws IdempotentParameterMismatchException * You have specified a client token for an operation using parameter values that differ from a previous * request that used the same client token. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws ResourceInUseException * The resource that you are trying to operate on is currently in use. Review the message details and retry * later. * @throws ServiceQuotaExceededException * You have exceeded the number of permitted resources or operations for this service. For service quotas, * see EC2 * Image Builder endpoints and quotas. * @sample AWSimagebuilder.CreateImage * @see AWS API * Documentation */ CreateImageResult createImage(CreateImageRequest createImageRequest); /** *

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

* * @param createImagePipelineRequest * @return Result of the CreateImagePipeline operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws IdempotentParameterMismatchException * You have specified a client token for an operation using parameter values that differ from a previous * request that used the same client token. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws ResourceInUseException * The resource that you are trying to operate on is currently in use. Review the message details and retry * later. * @throws ResourceAlreadyExistsException * The resource that you are trying to create already exists. * @throws ServiceQuotaExceededException * You have exceeded the number of permitted resources or operations for this service. For service quotas, * see EC2 * Image Builder endpoints and quotas. * @sample AWSimagebuilder.CreateImagePipeline * @see AWS API Documentation */ CreateImagePipelineResult createImagePipeline(CreateImagePipelineRequest createImagePipelineRequest); /** *

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

* * @param createImageRecipeRequest * @return Result of the CreateImageRecipe operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws IdempotentParameterMismatchException * You have specified a client token for an operation using parameter values that differ from a previous * request that used the same client token. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws InvalidVersionNumberException * Your version number is out of bounds or does not follow the required syntax. * @throws ResourceInUseException * The resource that you are trying to operate on is currently in use. Review the message details and retry * later. * @throws ResourceAlreadyExistsException * The resource that you are trying to create already exists. * @throws ServiceQuotaExceededException * You have exceeded the number of permitted resources or operations for this service. For service quotas, * see EC2 * Image Builder endpoints and quotas. * @sample AWSimagebuilder.CreateImageRecipe * @see AWS * API Documentation */ CreateImageRecipeResult createImageRecipe(CreateImageRecipeRequest createImageRecipeRequest); /** *

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

* * @param createInfrastructureConfigurationRequest * @return Result of the CreateInfrastructureConfiguration operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws IdempotentParameterMismatchException * You have specified a client token for an operation using parameter values that differ from a previous * request that used the same client token. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws ResourceInUseException * The resource that you are trying to operate on is currently in use. Review the message details and retry * later. * @throws ResourceAlreadyExistsException * The resource that you are trying to create already exists. * @throws ServiceQuotaExceededException * You have exceeded the number of permitted resources or operations for this service. For service quotas, * see EC2 * Image Builder endpoints and quotas. * @sample AWSimagebuilder.CreateInfrastructureConfiguration * @see AWS API Documentation */ CreateInfrastructureConfigurationResult createInfrastructureConfiguration(CreateInfrastructureConfigurationRequest createInfrastructureConfigurationRequest); /** *

* Deletes a component build version. *

* * @param deleteComponentRequest * @return Result of the DeleteComponent operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws ResourceDependencyException * You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the * error message for more details. * @sample AWSimagebuilder.DeleteComponent * @see AWS * API Documentation */ DeleteComponentResult deleteComponent(DeleteComponentRequest deleteComponentRequest); /** *

* Deletes a container recipe. *

* * @param deleteContainerRecipeRequest * @return Result of the DeleteContainerRecipe operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws ResourceDependencyException * You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the * error message for more details. * @sample AWSimagebuilder.DeleteContainerRecipe * @see AWS API Documentation */ DeleteContainerRecipeResult deleteContainerRecipe(DeleteContainerRecipeRequest deleteContainerRecipeRequest); /** *

* Deletes a distribution configuration. *

* * @param deleteDistributionConfigurationRequest * @return Result of the DeleteDistributionConfiguration operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws ResourceDependencyException * You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the * error message for more details. * @sample AWSimagebuilder.DeleteDistributionConfiguration * @see AWS API Documentation */ DeleteDistributionConfigurationResult deleteDistributionConfiguration(DeleteDistributionConfigurationRequest deleteDistributionConfigurationRequest); /** *

* 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. *

* * * @param deleteImageRequest * @return Result of the DeleteImage operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws ResourceDependencyException * You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the * error message for more details. * @sample AWSimagebuilder.DeleteImage * @see AWS API * Documentation */ DeleteImageResult deleteImage(DeleteImageRequest deleteImageRequest); /** *

* Deletes an image pipeline. *

* * @param deleteImagePipelineRequest * @return Result of the DeleteImagePipeline operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws ResourceDependencyException * You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the * error message for more details. * @sample AWSimagebuilder.DeleteImagePipeline * @see AWS API Documentation */ DeleteImagePipelineResult deleteImagePipeline(DeleteImagePipelineRequest deleteImagePipelineRequest); /** *

* Deletes an image recipe. *

* * @param deleteImageRecipeRequest * @return Result of the DeleteImageRecipe operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws ResourceDependencyException * You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the * error message for more details. * @sample AWSimagebuilder.DeleteImageRecipe * @see AWS * API Documentation */ DeleteImageRecipeResult deleteImageRecipe(DeleteImageRecipeRequest deleteImageRecipeRequest); /** *

* Deletes an infrastructure configuration. *

* * @param deleteInfrastructureConfigurationRequest * @return Result of the DeleteInfrastructureConfiguration operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws ResourceDependencyException * You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the * error message for more details. * @sample AWSimagebuilder.DeleteInfrastructureConfiguration * @see AWS API Documentation */ DeleteInfrastructureConfigurationResult deleteInfrastructureConfiguration(DeleteInfrastructureConfigurationRequest deleteInfrastructureConfigurationRequest); /** *

* Gets a component object. *

* * @param getComponentRequest * @return Result of the GetComponent operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.GetComponent * @see AWS API * Documentation */ GetComponentResult getComponent(GetComponentRequest getComponentRequest); /** *

* Gets a component policy. *

* * @param getComponentPolicyRequest * @return Result of the GetComponentPolicy operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws ResourceNotFoundException * At least one of the resources referenced by your request does not exist. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.GetComponentPolicy * @see AWS API Documentation */ GetComponentPolicyResult getComponentPolicy(GetComponentPolicyRequest getComponentPolicyRequest); /** *

* Retrieves a container recipe. *

* * @param getContainerRecipeRequest * @return Result of the GetContainerRecipe operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.GetContainerRecipe * @see AWS API Documentation */ GetContainerRecipeResult getContainerRecipe(GetContainerRecipeRequest getContainerRecipeRequest); /** *

* Retrieves the policy for a container recipe. *

* * @param getContainerRecipePolicyRequest * @return Result of the GetContainerRecipePolicy operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ResourceNotFoundException * At least one of the resources referenced by your request does not exist. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.GetContainerRecipePolicy * @see AWS API Documentation */ GetContainerRecipePolicyResult getContainerRecipePolicy(GetContainerRecipePolicyRequest getContainerRecipePolicyRequest); /** *

* Gets a distribution configuration. *

* * @param getDistributionConfigurationRequest * @return Result of the GetDistributionConfiguration operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.GetDistributionConfiguration * @see AWS API Documentation */ GetDistributionConfigurationResult getDistributionConfiguration(GetDistributionConfigurationRequest getDistributionConfigurationRequest); /** *

* Gets an image. *

* * @param getImageRequest * @return Result of the GetImage operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.GetImage * @see AWS API * Documentation */ GetImageResult getImage(GetImageRequest getImageRequest); /** *

* Gets an image pipeline. *

* * @param getImagePipelineRequest * @return Result of the GetImagePipeline operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.GetImagePipeline * @see AWS * API Documentation */ GetImagePipelineResult getImagePipeline(GetImagePipelineRequest getImagePipelineRequest); /** *

* Gets an image policy. *

* * @param getImagePolicyRequest * @return Result of the GetImagePolicy operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws ResourceNotFoundException * At least one of the resources referenced by your request does not exist. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.GetImagePolicy * @see AWS * API Documentation */ GetImagePolicyResult getImagePolicy(GetImagePolicyRequest getImagePolicyRequest); /** *

* Gets an image recipe. *

* * @param getImageRecipeRequest * @return Result of the GetImageRecipe operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.GetImageRecipe * @see AWS * API Documentation */ GetImageRecipeResult getImageRecipe(GetImageRecipeRequest getImageRecipeRequest); /** *

* Gets an image recipe policy. *

* * @param getImageRecipePolicyRequest * @return Result of the GetImageRecipePolicy operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ResourceNotFoundException * At least one of the resources referenced by your request does not exist. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.GetImageRecipePolicy * @see AWS API Documentation */ GetImageRecipePolicyResult getImageRecipePolicy(GetImageRecipePolicyRequest getImageRecipePolicyRequest); /** *

* Gets an infrastructure configuration. *

* * @param getInfrastructureConfigurationRequest * GetInfrastructureConfiguration request object. * @return Result of the GetInfrastructureConfiguration operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.GetInfrastructureConfiguration * @see AWS API Documentation */ GetInfrastructureConfigurationResult getInfrastructureConfiguration(GetInfrastructureConfigurationRequest getInfrastructureConfigurationRequest); /** *

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

* * @param getWorkflowExecutionRequest * @return Result of the GetWorkflowExecution operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.GetWorkflowExecution * @see AWS API Documentation */ GetWorkflowExecutionResult getWorkflowExecution(GetWorkflowExecutionRequest getWorkflowExecutionRequest); /** *

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

* * @param getWorkflowStepExecutionRequest * @return Result of the GetWorkflowStepExecution operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.GetWorkflowStepExecution * @see AWS API Documentation */ GetWorkflowStepExecutionResult getWorkflowStepExecution(GetWorkflowStepExecutionRequest getWorkflowStepExecutionRequest); /** *

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

* * @param importComponentRequest * @return Result of the ImportComponent operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws IdempotentParameterMismatchException * You have specified a client token for an operation using parameter values that differ from a previous * request that used the same client token. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws InvalidVersionNumberException * Your version number is out of bounds or does not follow the required syntax. * @throws ResourceInUseException * The resource that you are trying to operate on is currently in use. Review the message details and retry * later. * @throws InvalidParameterCombinationException * You have specified two or more mutually exclusive parameters. Review the error message for details. * @sample AWSimagebuilder.ImportComponent * @see AWS * API Documentation */ ImportComponentResult importComponent(ImportComponentRequest importComponentRequest); /** *

* 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 Result of the ImportVmImage operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @sample AWSimagebuilder.ImportVmImage * @see AWS API * Documentation */ ImportVmImageResult importVmImage(ImportVmImageRequest importVmImageRequest); /** *

* 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. *

*
* * @param listComponentBuildVersionsRequest * @return Result of the ListComponentBuildVersions operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidPaginationTokenException * You have provided an invalid pagination token in your request. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.ListComponentBuildVersions * @see AWS API Documentation */ ListComponentBuildVersionsResult listComponentBuildVersions(ListComponentBuildVersionsRequest listComponentBuildVersionsRequest); /** *

* 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. *

*
* * @param listComponentsRequest * @return Result of the ListComponents operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidPaginationTokenException * You have provided an invalid pagination token in your request. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.ListComponents * @see AWS * API Documentation */ ListComponentsResult listComponents(ListComponentsRequest listComponentsRequest); /** *

* Returns a list of container recipes. *

* * @param listContainerRecipesRequest * @return Result of the ListContainerRecipes operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidPaginationTokenException * You have provided an invalid pagination token in your request. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.ListContainerRecipes * @see AWS API Documentation */ ListContainerRecipesResult listContainerRecipes(ListContainerRecipesRequest listContainerRecipesRequest); /** *

* Returns a list of distribution configurations. *

* * @param listDistributionConfigurationsRequest * @return Result of the ListDistributionConfigurations operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidPaginationTokenException * You have provided an invalid pagination token in your request. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.ListDistributionConfigurations * @see AWS API Documentation */ ListDistributionConfigurationsResult listDistributionConfigurations(ListDistributionConfigurationsRequest listDistributionConfigurationsRequest); /** *

* Returns a list of image build versions. *

* * @param listImageBuildVersionsRequest * @return Result of the ListImageBuildVersions operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidPaginationTokenException * You have provided an invalid pagination token in your request. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.ListImageBuildVersions * @see AWS API Documentation */ ListImageBuildVersionsResult listImageBuildVersions(ListImageBuildVersionsRequest listImageBuildVersionsRequest); /** *

* 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 Result of the ListImagePackages operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidPaginationTokenException * You have provided an invalid pagination token in your request. * @throws ResourceNotFoundException * At least one of the resources referenced by your request does not exist. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.ListImagePackages * @see AWS * API Documentation */ ListImagePackagesResult listImagePackages(ListImagePackagesRequest listImagePackagesRequest); /** *

* Returns a list of images created by the specified pipeline. *

* * @param listImagePipelineImagesRequest * @return Result of the ListImagePipelineImages operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidPaginationTokenException * You have provided an invalid pagination token in your request. * @throws ResourceNotFoundException * At least one of the resources referenced by your request does not exist. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.ListImagePipelineImages * @see AWS API Documentation */ ListImagePipelineImagesResult listImagePipelineImages(ListImagePipelineImagesRequest listImagePipelineImagesRequest); /** *

* Returns a list of image pipelines. *

* * @param listImagePipelinesRequest * @return Result of the ListImagePipelines operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidPaginationTokenException * You have provided an invalid pagination token in your request. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.ListImagePipelines * @see AWS API Documentation */ ListImagePipelinesResult listImagePipelines(ListImagePipelinesRequest listImagePipelinesRequest); /** *

* Returns a list of image recipes. *

* * @param listImageRecipesRequest * @return Result of the ListImageRecipes operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidPaginationTokenException * You have provided an invalid pagination token in your request. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.ListImageRecipes * @see AWS * API Documentation */ ListImageRecipesResult listImageRecipes(ListImageRecipesRequest listImageRecipesRequest); /** *

* 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: *

* * * @param listImageScanFindingAggregationsRequest * @return Result of the ListImageScanFindingAggregations operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidPaginationTokenException * You have provided an invalid pagination token in your request. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.ListImageScanFindingAggregations * @see AWS API Documentation */ ListImageScanFindingAggregationsResult listImageScanFindingAggregations(ListImageScanFindingAggregationsRequest listImageScanFindingAggregationsRequest); /** *

* Returns a list of image scan findings for your account. *

* * @param listImageScanFindingsRequest * @return Result of the ListImageScanFindings operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidPaginationTokenException * You have provided an invalid pagination token in your request. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.ListImageScanFindings * @see AWS API Documentation */ ListImageScanFindingsResult listImageScanFindings(ListImageScanFindingsRequest listImageScanFindingsRequest); /** *

* 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 Result of the ListImages operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidPaginationTokenException * You have provided an invalid pagination token in your request. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.ListImages * @see AWS API * Documentation */ ListImagesResult listImages(ListImagesRequest listImagesRequest); /** *

* Returns a list of infrastructure configurations. *

* * @param listInfrastructureConfigurationsRequest * @return Result of the ListInfrastructureConfigurations operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidPaginationTokenException * You have provided an invalid pagination token in your request. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.ListInfrastructureConfigurations * @see AWS API Documentation */ ListInfrastructureConfigurationsResult listInfrastructureConfigurations(ListInfrastructureConfigurationsRequest listInfrastructureConfigurationsRequest); /** *

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

* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws ResourceNotFoundException * At least one of the resources referenced by your request does not exist. * @sample AWSimagebuilder.ListTagsForResource * @see AWS API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** *

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

* * @param listWorkflowExecutionsRequest * @return Result of the ListWorkflowExecutions operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidPaginationTokenException * You have provided an invalid pagination token in your request. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.ListWorkflowExecutions * @see AWS API Documentation */ ListWorkflowExecutionsResult listWorkflowExecutions(ListWorkflowExecutionsRequest listWorkflowExecutionsRequest); /** *

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

* * @param listWorkflowStepExecutionsRequest * @return Result of the ListWorkflowStepExecutions operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidPaginationTokenException * You have provided an invalid pagination token in your request. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.ListWorkflowStepExecutions * @see AWS API Documentation */ ListWorkflowStepExecutionsResult listWorkflowStepExecutions(ListWorkflowStepExecutionsRequest listWorkflowStepExecutionsRequest); /** *

* 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. *

* * @param putComponentPolicyRequest * @return Result of the PutComponentPolicy operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidParameterValueException * The value that you provided for the specified parameter is invalid. * @throws ResourceNotFoundException * At least one of the resources referenced by your request does not exist. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.PutComponentPolicy * @see AWS API Documentation */ PutComponentPolicyResult putComponentPolicy(PutComponentPolicyRequest putComponentPolicyRequest); /** *

* 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. *

* * @param putContainerRecipePolicyRequest * @return Result of the PutContainerRecipePolicy operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidParameterValueException * The value that you provided for the specified parameter is invalid. * @throws ResourceNotFoundException * At least one of the resources referenced by your request does not exist. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.PutContainerRecipePolicy * @see AWS API Documentation */ PutContainerRecipePolicyResult putContainerRecipePolicy(PutContainerRecipePolicyRequest putContainerRecipePolicyRequest); /** *

* 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. *

* * @param putImagePolicyRequest * @return Result of the PutImagePolicy operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidParameterValueException * The value that you provided for the specified parameter is invalid. * @throws ResourceNotFoundException * At least one of the resources referenced by your request does not exist. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.PutImagePolicy * @see AWS * API Documentation */ PutImagePolicyResult putImagePolicy(PutImagePolicyRequest putImagePolicyRequest); /** *

* 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. *

* * @param putImageRecipePolicyRequest * @return Result of the PutImageRecipePolicy operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws InvalidParameterValueException * The value that you provided for the specified parameter is invalid. * @throws ResourceNotFoundException * At least one of the resources referenced by your request does not exist. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @sample AWSimagebuilder.PutImageRecipePolicy * @see AWS API Documentation */ PutImageRecipePolicyResult putImageRecipePolicy(PutImageRecipePolicyRequest putImageRecipePolicyRequest); /** *

* Manually triggers a pipeline to create an image. *

* * @param startImagePipelineExecutionRequest * @return Result of the StartImagePipelineExecution operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws ResourceNotFoundException * At least one of the resources referenced by your request does not exist. * @throws IdempotentParameterMismatchException * You have specified a client token for an operation using parameter values that differ from a previous * request that used the same client token. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws ResourceInUseException * The resource that you are trying to operate on is currently in use. Review the message details and retry * later. * @sample AWSimagebuilder.StartImagePipelineExecution * @see AWS API Documentation */ StartImagePipelineExecutionResult startImagePipelineExecution(StartImagePipelineExecutionRequest startImagePipelineExecutionRequest); /** *

* Adds a tag to a resource. *

* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws ResourceNotFoundException * At least one of the resources referenced by your request does not exist. * @sample AWSimagebuilder.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** *

* Removes a tag from a resource. *

* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws ResourceNotFoundException * At least one of the resources referenced by your request does not exist. * @sample AWSimagebuilder.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** *

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

* * @param updateDistributionConfigurationRequest * @return Result of the UpdateDistributionConfiguration operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws IdempotentParameterMismatchException * You have specified a client token for an operation using parameter values that differ from a previous * request that used the same client token. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws ResourceInUseException * The resource that you are trying to operate on is currently in use. Review the message details and retry * later. * @throws InvalidParameterCombinationException * You have specified two or more mutually exclusive parameters. Review the error message for details. * @sample AWSimagebuilder.UpdateDistributionConfiguration * @see AWS API Documentation */ UpdateDistributionConfigurationResult updateDistributionConfiguration(UpdateDistributionConfigurationRequest updateDistributionConfigurationRequest); /** *

* 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. *

*
* * @param updateImagePipelineRequest * @return Result of the UpdateImagePipeline operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws IdempotentParameterMismatchException * You have specified a client token for an operation using parameter values that differ from a previous * request that used the same client token. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws ResourceInUseException * The resource that you are trying to operate on is currently in use. Review the message details and retry * later. * @sample AWSimagebuilder.UpdateImagePipeline * @see AWS API Documentation */ UpdateImagePipelineResult updateImagePipeline(UpdateImagePipelineRequest updateImagePipelineRequest); /** *

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

* * @param updateInfrastructureConfigurationRequest * @return Result of the UpdateInfrastructureConfiguration operation returned by the service. * @throws ServiceException * This exception is thrown when the service encounters an unrecoverable exception. * @throws ClientException * These errors are usually caused by a client action, such as using an action or resource on behalf of a * user that doesn't have permissions to use the action or resource, or specifying an invalid resource * identifier. * @throws ServiceUnavailableException * The service is unable to process your request at this time. * @throws InvalidRequestException * You have requested an action that that the service doesn't support. * @throws IdempotentParameterMismatchException * You have specified a client token for an operation using parameter values that differ from a previous * request that used the same client token. * @throws ForbiddenException * You are not authorized to perform the requested operation. * @throws CallRateLimitExceededException * You have exceeded the permitted request rate for the specific operation. * @throws ResourceInUseException * The resource that you are trying to operate on is currently in use. Review the message details and retry * later. * @sample AWSimagebuilder.UpdateInfrastructureConfiguration * @see AWS API Documentation */ UpdateInfrastructureConfigurationResult updateInfrastructureConfiguration(UpdateInfrastructureConfigurationRequest updateInfrastructureConfigurationRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. *

* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }