AWSimagebuilderClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.imagebuilder.AWSimagebuilderClient

All Implemented Interfaces:

AWSimagebuilder

Direct Known Subclasses:

AWSimagebuilderAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSimagebuilderClient
extends AmazonWebServiceClient
implements AWSimagebuilder
```
Client for accessing imagebuilder. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.imagebuilder.AWSimagebuilder
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AWSimagebuilderClientBuilder`	`builder()`
`CancelImageCreationResult`	`cancelImageCreation(CancelImageCreationRequest request)` CancelImageCreation cancels the creation of Image.
`CreateComponentResult`	`createComponent(CreateComponentRequest request)` Creates a new component that can be used to build, validate, test, and assess your image.
`CreateContainerRecipeResult`	`createContainerRecipe(CreateContainerRecipeRequest request)` Creates a new container recipe.
`CreateDistributionConfigurationResult`	`createDistributionConfiguration(CreateDistributionConfigurationRequest request)` Creates a new distribution configuration.
`CreateImageResult`	`createImage(CreateImageRequest request)` Creates a new image.
`CreateImagePipelineResult`	`createImagePipeline(CreateImagePipelineRequest request)` Creates a new image pipeline.
`CreateImageRecipeResult`	`createImageRecipe(CreateImageRecipeRequest request)` Creates a new image recipe.
`CreateInfrastructureConfigurationResult`	`createInfrastructureConfiguration(CreateInfrastructureConfigurationRequest request)` Creates a new infrastructure configuration.
`DeleteComponentResult`	`deleteComponent(DeleteComponentRequest request)` Deletes a component build version.
`DeleteContainerRecipeResult`	`deleteContainerRecipe(DeleteContainerRecipeRequest request)` Deletes a container recipe.
`DeleteDistributionConfigurationResult`	`deleteDistributionConfiguration(DeleteDistributionConfigurationRequest request)` Deletes a distribution configuration.
`DeleteImageResult`	`deleteImage(DeleteImageRequest request)` Deletes an image.
`DeleteImagePipelineResult`	`deleteImagePipeline(DeleteImagePipelineRequest request)` Deletes an image pipeline.
`DeleteImageRecipeResult`	`deleteImageRecipe(DeleteImageRecipeRequest request)` Deletes an image recipe.
`DeleteInfrastructureConfigurationResult`	`deleteInfrastructureConfiguration(DeleteInfrastructureConfigurationRequest request)` Deletes an infrastructure configuration.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetComponentResult`	`getComponent(GetComponentRequest request)` Gets a component object.
`GetComponentPolicyResult`	`getComponentPolicy(GetComponentPolicyRequest request)` Gets a component policy.
`GetContainerRecipeResult`	`getContainerRecipe(GetContainerRecipeRequest request)` Retrieves a container recipe.
`GetContainerRecipePolicyResult`	`getContainerRecipePolicy(GetContainerRecipePolicyRequest request)` Retrieves the policy for a container recipe.
`GetDistributionConfigurationResult`	`getDistributionConfiguration(GetDistributionConfigurationRequest request)` Gets a distribution configuration.
`GetImageResult`	`getImage(GetImageRequest request)` Gets an image.
`GetImagePipelineResult`	`getImagePipeline(GetImagePipelineRequest request)` Gets an image pipeline.
`GetImagePolicyResult`	`getImagePolicy(GetImagePolicyRequest request)` Gets an image policy.
`GetImageRecipeResult`	`getImageRecipe(GetImageRecipeRequest request)` Gets an image recipe.
`GetImageRecipePolicyResult`	`getImageRecipePolicy(GetImageRecipePolicyRequest request)` Gets an image recipe policy.
`GetInfrastructureConfigurationResult`	`getInfrastructureConfiguration(GetInfrastructureConfigurationRequest request)` Gets an infrastructure configuration.
`ImportComponentResult`	`importComponent(ImportComponentRequest request)` Imports a component and transforms its data into a component document.
`ListComponentBuildVersionsResult`	`listComponentBuildVersions(ListComponentBuildVersionsRequest request)` Returns the list of component build versions for the specified semantic version.
`ListComponentsResult`	`listComponents(ListComponentsRequest request)` Returns the list of component build versions for the specified semantic version.
`ListContainerRecipesResult`	`listContainerRecipes(ListContainerRecipesRequest request)` Returns a list of container recipes.
`ListDistributionConfigurationsResult`	`listDistributionConfigurations(ListDistributionConfigurationsRequest request)` Returns a list of distribution configurations.
`ListImageBuildVersionsResult`	`listImageBuildVersions(ListImageBuildVersionsRequest request)` Returns a list of image build versions.
`ListImagePackagesResult`	`listImagePackages(ListImagePackagesRequest request)` List the Packages that are associated with an Image Build Version, as determined by Amazon EC2 Systems Manager Inventory at build time.
`ListImagePipelineImagesResult`	`listImagePipelineImages(ListImagePipelineImagesRequest request)` Returns a list of images created by the specified pipeline.
`ListImagePipelinesResult`	`listImagePipelines(ListImagePipelinesRequest request)` Returns a list of image pipelines.
`ListImageRecipesResult`	`listImageRecipes(ListImageRecipesRequest request)` Returns a list of image recipes.
`ListImagesResult`	`listImages(ListImagesRequest request)` Returns the list of images that you have access to.
`ListInfrastructureConfigurationsResult`	`listInfrastructureConfigurations(ListInfrastructureConfigurationsRequest request)` Returns a list of infrastructure configurations.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Returns the list of tags for the specified resource.
`PutComponentPolicyResult`	`putComponentPolicy(PutComponentPolicyRequest request)` Applies a policy to a component.
`PutContainerRecipePolicyResult`	`putContainerRecipePolicy(PutContainerRecipePolicyRequest request)` Applies a policy to a container image.
`PutImagePolicyResult`	`putImagePolicy(PutImagePolicyRequest request)` Applies a policy to an image.
`PutImageRecipePolicyResult`	`putImageRecipePolicy(PutImageRecipePolicyRequest request)` Applies a policy to an image recipe.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartImagePipelineExecutionResult`	`startImagePipelineExecution(StartImagePipelineExecutionRequest request)` Manually triggers a pipeline to create an image.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds a tag to a resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes a tag from a resource.
`UpdateDistributionConfigurationResult`	`updateDistributionConfiguration(UpdateDistributionConfigurationRequest request)` Updates a new distribution configuration.
`UpdateImagePipelineResult`	`updateImagePipeline(UpdateImagePipelineRequest request)` Updates an image pipeline.
`UpdateInfrastructureConfigurationResult`	`updateInfrastructureConfiguration(UpdateInfrastructureConfigurationRequest request)` Updates a new infrastructure configuration.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AWSimagebuilderClientBuilder builder()
```
  - cancelImageCreation
```
public CancelImageCreationResult cancelImageCreation(CancelImageCreationRequest request)
```
    CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
    
    Specified by:
    
    cancelImageCreation in interface AWSimagebuilder
    
    Parameters:
    
    cancelImageCreationRequest -
    
    Returns:
    
    Result of the CancelImageCreation operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    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.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    ResourceInUseException - The resource that you are trying to operate on is currently in use. Review the message details and retry later.
    
    See Also:
    
    AWS API Documentation
  - createComponent
```
public CreateComponentResult createComponent(CreateComponentRequest request)
```
    Creates a new component that can be used to build, validate, test, and assess your image.
    
    Specified by:
    
    createComponent in interface AWSimagebuilder
    
    Parameters:
    
    createComponentRequest -
    
    Returns:
    
    Result of the CreateComponent operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    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.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    InvalidVersionNumberException - Your version number is out of bounds or does not follow the required syntax.
    
    ResourceInUseException - The resource that you are trying to operate on is currently in use. Review the message details and retry later.
    
    InvalidParameterCombinationException - You have specified two or more mutually exclusive parameters. Review the error message for details.
    
    ServiceQuotaExceededException - You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
    
    See Also:
    
    AWS API Documentation
  - createContainerRecipe
```
public CreateContainerRecipeResult createContainerRecipe(CreateContainerRecipeRequest request)
```
    Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.
    
    Specified by:
    
    createContainerRecipe in interface AWSimagebuilder
    
    Parameters:
    
    createContainerRecipeRequest -
    
    Returns:
    
    Result of the CreateContainerRecipe operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    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.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    InvalidVersionNumberException - Your version number is out of bounds or does not follow the required syntax.
    
    ResourceInUseException - The resource that you are trying to operate on is currently in use. Review the message details and retry later.
    
    ResourceAlreadyExistsException - The resource that you are trying to create already exists.
    
    ServiceQuotaExceededException - You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
    
    See Also:
    
    AWS API Documentation
  - createDistributionConfiguration
```
public CreateDistributionConfigurationResult createDistributionConfiguration(CreateDistributionConfigurationRequest request)
```
    Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
    
    Specified by:
    
    createDistributionConfiguration in interface AWSimagebuilder
    
    Parameters:
    
    createDistributionConfigurationRequest -
    
    Returns:
    
    Result of the CreateDistributionConfiguration operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    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.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    ResourceInUseException - The resource that you are trying to operate on is currently in use. Review the message details and retry later.
    
    ResourceAlreadyExistsException - The resource that you are trying to create already exists.
    
    InvalidParameterCombinationException - You have specified two or more mutually exclusive parameters. Review the error message for details.
    
    ServiceQuotaExceededException - You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
    
    See Also:
    
    AWS API Documentation
  - createImage
```
public CreateImageResult createImage(CreateImageRequest request)
```
    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.
    
    Specified by:
    
    createImage in interface AWSimagebuilder
    
    Parameters:
    
    createImageRequest -
    
    Returns:
    
    Result of the CreateImage operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    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.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    ResourceInUseException - The resource that you are trying to operate on is currently in use. Review the message details and retry later.
    
    ServiceQuotaExceededException - You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
    
    See Also:
    
    AWS API Documentation
  - createImagePipeline
```
public CreateImagePipelineResult createImagePipeline(CreateImagePipelineRequest request)
```
    Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
    
    Specified by:
    
    createImagePipeline in interface AWSimagebuilder
    
    Parameters:
    
    createImagePipelineRequest -
    
    Returns:
    
    Result of the CreateImagePipeline operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    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.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    ResourceInUseException - The resource that you are trying to operate on is currently in use. Review the message details and retry later.
    
    ResourceAlreadyExistsException - The resource that you are trying to create already exists.
    
    ServiceQuotaExceededException - You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
    
    See Also:
    
    AWS API Documentation
  - createImageRecipe
```
public CreateImageRecipeResult createImageRecipe(CreateImageRecipeRequest request)
```
    Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.
    
    Specified by:
    
    createImageRecipe in interface AWSimagebuilder
    
    Parameters:
    
    createImageRecipeRequest -
    
    Returns:
    
    Result of the CreateImageRecipe operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    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.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    InvalidVersionNumberException - Your version number is out of bounds or does not follow the required syntax.
    
    ResourceInUseException - The resource that you are trying to operate on is currently in use. Review the message details and retry later.
    
    ResourceAlreadyExistsException - The resource that you are trying to create already exists.
    
    ServiceQuotaExceededException - You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
    
    See Also:
    
    AWS API Documentation
  - createInfrastructureConfiguration
```
public CreateInfrastructureConfigurationResult createInfrastructureConfiguration(CreateInfrastructureConfigurationRequest request)
```
    Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
    
    Specified by:
    
    createInfrastructureConfiguration in interface AWSimagebuilder
    
    Parameters:
    
    createInfrastructureConfigurationRequest -
    
    Returns:
    
    Result of the CreateInfrastructureConfiguration operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    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.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    ResourceInUseException - The resource that you are trying to operate on is currently in use. Review the message details and retry later.
    
    ResourceAlreadyExistsException - The resource that you are trying to create already exists.
    
    ServiceQuotaExceededException - You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
    
    See Also:
    
    AWS API Documentation
  - deleteComponent
```
public DeleteComponentResult deleteComponent(DeleteComponentRequest request)
```
    Deletes a component build version.
    
    Specified by:
    
    deleteComponent in interface AWSimagebuilder
    
    Parameters:
    
    deleteComponentRequest -
    
    Returns:
    
    Result of the DeleteComponent operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    ResourceDependencyException - You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
    
    See Also:
    
    AWS API Documentation
  - deleteContainerRecipe
```
public DeleteContainerRecipeResult deleteContainerRecipe(DeleteContainerRecipeRequest request)
```
    Deletes a container recipe.
    
    Specified by:
    
    deleteContainerRecipe in interface AWSimagebuilder
    
    Parameters:
    
    deleteContainerRecipeRequest -
    
    Returns:
    
    Result of the DeleteContainerRecipe operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    ResourceDependencyException - You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
    
    See Also:
    
    AWS API Documentation
  - deleteDistributionConfiguration
```
public DeleteDistributionConfigurationResult deleteDistributionConfiguration(DeleteDistributionConfigurationRequest request)
```
    Deletes a distribution configuration.
    
    Specified by:
    
    deleteDistributionConfiguration in interface AWSimagebuilder
    
    Parameters:
    
    deleteDistributionConfigurationRequest -
    
    Returns:
    
    Result of the DeleteDistributionConfiguration operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    ResourceDependencyException - You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
    
    See Also:
    
    AWS API Documentation
  - deleteImage
```
public DeleteImageResult deleteImage(DeleteImageRequest request)
```
    Deletes an image.
    
    Specified by:
    
    deleteImage in interface AWSimagebuilder
    
    Parameters:
    
    deleteImageRequest -
    
    Returns:
    
    Result of the DeleteImage operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    ResourceDependencyException - You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
    
    See Also:
    
    AWS API Documentation
  - deleteImagePipeline
```
public DeleteImagePipelineResult deleteImagePipeline(DeleteImagePipelineRequest request)
```
    Deletes an image pipeline.
    
    Specified by:
    
    deleteImagePipeline in interface AWSimagebuilder
    
    Parameters:
    
    deleteImagePipelineRequest -
    
    Returns:
    
    Result of the DeleteImagePipeline operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    ResourceDependencyException - You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
    
    See Also:
    
    AWS API Documentation
  - deleteImageRecipe
```
public DeleteImageRecipeResult deleteImageRecipe(DeleteImageRecipeRequest request)
```
    Deletes an image recipe.
    
    Specified by:
    
    deleteImageRecipe in interface AWSimagebuilder
    
    Parameters:
    
    deleteImageRecipeRequest -
    
    Returns:
    
    Result of the DeleteImageRecipe operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    ResourceDependencyException - You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
    
    See Also:
    
    AWS API Documentation
  - deleteInfrastructureConfiguration
```
public DeleteInfrastructureConfigurationResult deleteInfrastructureConfiguration(DeleteInfrastructureConfigurationRequest request)
```
    Deletes an infrastructure configuration.
    
    Specified by:
    
    deleteInfrastructureConfiguration in interface AWSimagebuilder
    
    Parameters:
    
    deleteInfrastructureConfigurationRequest -
    
    Returns:
    
    Result of the DeleteInfrastructureConfiguration operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    ResourceDependencyException - You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
    
    See Also:
    
    AWS API Documentation
  - getComponent
```
public GetComponentResult getComponent(GetComponentRequest request)
```
    Gets a component object.
    
    Specified by:
    
    getComponent in interface AWSimagebuilder
    
    Parameters:
    
    getComponentRequest -
    
    Returns:
    
    Result of the GetComponent operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - getComponentPolicy
```
public GetComponentPolicyResult getComponentPolicy(GetComponentPolicyRequest request)
```
    Gets a component policy.
    
    Specified by:
    
    getComponentPolicy in interface AWSimagebuilder
    
    Parameters:
    
    getComponentPolicyRequest -
    
    Returns:
    
    Result of the GetComponentPolicy operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    ResourceNotFoundException - At least one of the resources referenced by your request does not exist.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - getContainerRecipe
```
public GetContainerRecipeResult getContainerRecipe(GetContainerRecipeRequest request)
```
    Retrieves a container recipe.
    
    Specified by:
    
    getContainerRecipe in interface AWSimagebuilder
    
    Parameters:
    
    getContainerRecipeRequest -
    
    Returns:
    
    Result of the GetContainerRecipe operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - getContainerRecipePolicy
```
public GetContainerRecipePolicyResult getContainerRecipePolicy(GetContainerRecipePolicyRequest request)
```
    Retrieves the policy for a container recipe.
    
    Specified by:
    
    getContainerRecipePolicy in interface AWSimagebuilder
    
    Parameters:
    
    getContainerRecipePolicyRequest -
    
    Returns:
    
    Result of the GetContainerRecipePolicy operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ResourceNotFoundException - At least one of the resources referenced by your request does not exist.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - getDistributionConfiguration
```
public GetDistributionConfigurationResult getDistributionConfiguration(GetDistributionConfigurationRequest request)
```
    Gets a distribution configuration.
    
    Specified by:
    
    getDistributionConfiguration in interface AWSimagebuilder
    
    Parameters:
    
    getDistributionConfigurationRequest -
    
    Returns:
    
    Result of the GetDistributionConfiguration operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - getImage
```
public GetImageResult getImage(GetImageRequest request)
```
    Gets an image.
    
    Specified by:
    
    getImage in interface AWSimagebuilder
    
    Parameters:
    
    getImageRequest -
    
    Returns:
    
    Result of the GetImage operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - getImagePipeline
```
public GetImagePipelineResult getImagePipeline(GetImagePipelineRequest request)
```
    Gets an image pipeline.
    
    Specified by:
    
    getImagePipeline in interface AWSimagebuilder
    
    Parameters:
    
    getImagePipelineRequest -
    
    Returns:
    
    Result of the GetImagePipeline operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - getImagePolicy
```
public GetImagePolicyResult getImagePolicy(GetImagePolicyRequest request)
```
    Gets an image policy.
    
    Specified by:
    
    getImagePolicy in interface AWSimagebuilder
    
    Parameters:
    
    getImagePolicyRequest -
    
    Returns:
    
    Result of the GetImagePolicy operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    ResourceNotFoundException - At least one of the resources referenced by your request does not exist.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - getImageRecipe
```
public GetImageRecipeResult getImageRecipe(GetImageRecipeRequest request)
```
    Gets an image recipe.
    
    Specified by:
    
    getImageRecipe in interface AWSimagebuilder
    
    Parameters:
    
    getImageRecipeRequest -
    
    Returns:
    
    Result of the GetImageRecipe operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - getImageRecipePolicy
```
public GetImageRecipePolicyResult getImageRecipePolicy(GetImageRecipePolicyRequest request)
```
    Gets an image recipe policy.
    
    Specified by:
    
    getImageRecipePolicy in interface AWSimagebuilder
    
    Parameters:
    
    getImageRecipePolicyRequest -
    
    Returns:
    
    Result of the GetImageRecipePolicy operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ResourceNotFoundException - At least one of the resources referenced by your request does not exist.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - getInfrastructureConfiguration
```
public GetInfrastructureConfigurationResult getInfrastructureConfiguration(GetInfrastructureConfigurationRequest request)
```
    Gets an infrastructure configuration.
    
    Specified by:
    
    getInfrastructureConfiguration in interface AWSimagebuilder
    
    Parameters:
    
    getInfrastructureConfigurationRequest - GetInfrastructureConfiguration request object.
    
    Returns:
    
    Result of the GetInfrastructureConfiguration operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - importComponent
```
public ImportComponentResult importComponent(ImportComponentRequest request)
```
    Imports a component and transforms its data into a component document.
    
    Specified by:
    
    importComponent in interface AWSimagebuilder
    
    Parameters:
    
    importComponentRequest -
    
    Returns:
    
    Result of the ImportComponent operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    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.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    InvalidVersionNumberException - Your version number is out of bounds or does not follow the required syntax.
    
    ResourceInUseException - The resource that you are trying to operate on is currently in use. Review the message details and retry later.
    
    InvalidParameterCombinationException - You have specified two or more mutually exclusive parameters. Review the error message for details.
    
    See Also:
    
    AWS API Documentation
  - listComponentBuildVersions
```
public ListComponentBuildVersionsResult listComponentBuildVersions(ListComponentBuildVersionsRequest request)
```
    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: When you retrieve or reference a resource with a semantic version, you can use wildcards (x) to filter your results. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards. For example, specifying "1.2.x", or "1.x.x" works to filter list results, but neither "1.x.2", nor "x.2.x" will work. You do not have to specify the build - Image Builder automatically uses a wildcard for that, if applicable.
    
    Specified by:
    
    listComponentBuildVersions in interface AWSimagebuilder
    
    Parameters:
    
    listComponentBuildVersionsRequest -
    
    Returns:
    
    Result of the ListComponentBuildVersions operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    InvalidPaginationTokenException - You have provided an invalid pagination token in your request.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - listComponents
```
public ListComponentsResult listComponents(ListComponentsRequest request)
```
    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: When you retrieve or reference a resource with a semantic version, you can use wildcards (x) to filter your results. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards. For example, specifying "1.2.x", or "1.x.x" works to filter list results, but neither "1.x.2", nor "x.2.x" will work. You do not have to specify the build - Image Builder automatically uses a wildcard for that, if applicable.
    
    Specified by:
    
    listComponents in interface AWSimagebuilder
    
    Parameters:
    
    listComponentsRequest -
    
    Returns:
    
    Result of the ListComponents operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    InvalidPaginationTokenException - You have provided an invalid pagination token in your request.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - listContainerRecipes
```
public ListContainerRecipesResult listContainerRecipes(ListContainerRecipesRequest request)
```
    Returns a list of container recipes.
    
    Specified by:
    
    listContainerRecipes in interface AWSimagebuilder
    
    Parameters:
    
    listContainerRecipesRequest -
    
    Returns:
    
    Result of the ListContainerRecipes operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    InvalidPaginationTokenException - You have provided an invalid pagination token in your request.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - listDistributionConfigurations
```
public ListDistributionConfigurationsResult listDistributionConfigurations(ListDistributionConfigurationsRequest request)
```
    Returns a list of distribution configurations.
    
    Specified by:
    
    listDistributionConfigurations in interface AWSimagebuilder
    
    Parameters:
    
    listDistributionConfigurationsRequest -
    
    Returns:
    
    Result of the ListDistributionConfigurations operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    InvalidPaginationTokenException - You have provided an invalid pagination token in your request.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - listImageBuildVersions
```
public ListImageBuildVersionsResult listImageBuildVersions(ListImageBuildVersionsRequest request)
```
    Returns a list of image build versions.
    
    Specified by:
    
    listImageBuildVersions in interface AWSimagebuilder
    
    Parameters:
    
    listImageBuildVersionsRequest -
    
    Returns:
    
    Result of the ListImageBuildVersions operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    InvalidPaginationTokenException - You have provided an invalid pagination token in your request.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - listImagePackages
```
public ListImagePackagesResult listImagePackages(ListImagePackagesRequest request)
```
    List the Packages that are associated with an Image Build Version, as determined by Amazon EC2 Systems Manager Inventory at build time.
    
    Specified by:
    
    listImagePackages in interface AWSimagebuilder
    
    Parameters:
    
    listImagePackagesRequest -
    
    Returns:
    
    Result of the ListImagePackages operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    InvalidPaginationTokenException - You have provided an invalid pagination token in your request.
    
    ResourceNotFoundException - At least one of the resources referenced by your request does not exist.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - listImagePipelineImages
```
public ListImagePipelineImagesResult listImagePipelineImages(ListImagePipelineImagesRequest request)
```
    Returns a list of images created by the specified pipeline.
    
    Specified by:
    
    listImagePipelineImages in interface AWSimagebuilder
    
    Parameters:
    
    listImagePipelineImagesRequest -
    
    Returns:
    
    Result of the ListImagePipelineImages operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    InvalidPaginationTokenException - You have provided an invalid pagination token in your request.
    
    ResourceNotFoundException - At least one of the resources referenced by your request does not exist.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - listImagePipelines
```
public ListImagePipelinesResult listImagePipelines(ListImagePipelinesRequest request)
```
    Returns a list of image pipelines.
    
    Specified by:
    
    listImagePipelines in interface AWSimagebuilder
    
    Parameters:
    
    listImagePipelinesRequest -
    
    Returns:
    
    Result of the ListImagePipelines operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    InvalidPaginationTokenException - You have provided an invalid pagination token in your request.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - listImageRecipes
```
public ListImageRecipesResult listImageRecipes(ListImageRecipesRequest request)
```
    Returns a list of image recipes.
    
    Specified by:
    
    listImageRecipes in interface AWSimagebuilder
    
    Parameters:
    
    listImageRecipesRequest -
    
    Returns:
    
    Result of the ListImageRecipes operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    InvalidPaginationTokenException - You have provided an invalid pagination token in your request.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - listImages
```
public ListImagesResult listImages(ListImagesRequest request)
```
    Returns the list of images that you have access to.
    
    Specified by:
    
    listImages in interface AWSimagebuilder
    
    Parameters:
    
    listImagesRequest -
    
    Returns:
    
    Result of the ListImages operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    InvalidPaginationTokenException - You have provided an invalid pagination token in your request.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - listInfrastructureConfigurations
```
public ListInfrastructureConfigurationsResult listInfrastructureConfigurations(ListInfrastructureConfigurationsRequest request)
```
    Returns a list of infrastructure configurations.
    
    Specified by:
    
    listInfrastructureConfigurations in interface AWSimagebuilder
    
    Parameters:
    
    listInfrastructureConfigurationsRequest -
    
    Returns:
    
    Result of the ListInfrastructureConfigurations operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    InvalidPaginationTokenException - You have provided an invalid pagination token in your request.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Returns the list of tags for the specified resource.
    
    Specified by:
    
    listTagsForResource in interface AWSimagebuilder
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
    
    ResourceNotFoundException - At least one of the resources referenced by your request does not exist.
    
    See Also:
    
    AWS API Documentation
  - putComponentPolicy
```
public PutComponentPolicyResult putComponentPolicy(PutComponentPolicyRequest request)
```
    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.
    
    Specified by:
    
    putComponentPolicy in interface AWSimagebuilder
    
    Parameters:
    
    putComponentPolicyRequest -
    
    Returns:
    
    Result of the PutComponentPolicy operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    InvalidParameterValueException - The value that you provided for the specified parameter is invalid.
    
    ResourceNotFoundException - At least one of the resources referenced by your request does not exist.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - putContainerRecipePolicy
```
public PutContainerRecipePolicyResult putContainerRecipePolicy(PutContainerRecipePolicyRequest request)
```
    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.
    
    Specified by:
    
    putContainerRecipePolicy in interface AWSimagebuilder
    
    Parameters:
    
    putContainerRecipePolicyRequest -
    
    Returns:
    
    Result of the PutContainerRecipePolicy operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    InvalidParameterValueException - The value that you provided for the specified parameter is invalid.
    
    ResourceNotFoundException - At least one of the resources referenced by your request does not exist.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - putImagePolicy
```
public PutImagePolicyResult putImagePolicy(PutImagePolicyRequest request)
```
    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.
    
    Specified by:
    
    putImagePolicy in interface AWSimagebuilder
    
    Parameters:
    
    putImagePolicyRequest -
    
    Returns:
    
    Result of the PutImagePolicy operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    InvalidParameterValueException - The value that you provided for the specified parameter is invalid.
    
    ResourceNotFoundException - At least one of the resources referenced by your request does not exist.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - putImageRecipePolicy
```
public PutImageRecipePolicyResult putImageRecipePolicy(PutImageRecipePolicyRequest request)
```
    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.
    
    Specified by:
    
    putImageRecipePolicy in interface AWSimagebuilder
    
    Parameters:
    
    putImageRecipePolicyRequest -
    
    Returns:
    
    Result of the PutImageRecipePolicy operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    InvalidParameterValueException - The value that you provided for the specified parameter is invalid.
    
    ResourceNotFoundException - At least one of the resources referenced by your request does not exist.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    See Also:
    
    AWS API Documentation
  - startImagePipelineExecution
```
public StartImagePipelineExecutionResult startImagePipelineExecution(StartImagePipelineExecutionRequest request)
```
    Manually triggers a pipeline to create an image.
    
    Specified by:
    
    startImagePipelineExecution in interface AWSimagebuilder
    
    Parameters:
    
    startImagePipelineExecutionRequest -
    
    Returns:
    
    Result of the StartImagePipelineExecution operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    ResourceNotFoundException - At least one of the resources referenced by your request does not exist.
    
    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.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    ResourceInUseException - The resource that you are trying to operate on is currently in use. Review the message details and retry later.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Adds a tag to a resource.
    
    Specified by:
    
    tagResource in interface AWSimagebuilder
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
    
    ResourceNotFoundException - At least one of the resources referenced by your request does not exist.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes a tag from a resource.
    
    Specified by:
    
    untagResource in interface AWSimagebuilder
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
    
    ResourceNotFoundException - At least one of the resources referenced by your request does not exist.
    
    See Also:
    
    AWS API Documentation
  - updateDistributionConfiguration
```
public UpdateDistributionConfigurationResult updateDistributionConfiguration(UpdateDistributionConfigurationRequest request)
```
    Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
    
    Specified by:
    
    updateDistributionConfiguration in interface AWSimagebuilder
    
    Parameters:
    
    updateDistributionConfigurationRequest -
    
    Returns:
    
    Result of the UpdateDistributionConfiguration operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    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.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    ResourceInUseException - The resource that you are trying to operate on is currently in use. Review the message details and retry later.
    
    InvalidParameterCombinationException - You have specified two or more mutually exclusive parameters. Review the error message for details.
    
    See Also:
    
    AWS API Documentation
  - updateImagePipeline
```
public UpdateImagePipelineResult updateImagePipeline(UpdateImagePipelineRequest request)
```
    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.
    
    Specified by:
    
    updateImagePipeline in interface AWSimagebuilder
    
    Parameters:
    
    updateImagePipelineRequest -
    
    Returns:
    
    Result of the UpdateImagePipeline operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    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.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    ResourceInUseException - The resource that you are trying to operate on is currently in use. Review the message details and retry later.
    
    See Also:
    
    AWS API Documentation
  - updateInfrastructureConfiguration
```
public UpdateInfrastructureConfigurationResult updateInfrastructureConfiguration(UpdateInfrastructureConfigurationRequest request)
```
    Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
    
    Specified by:
    
    updateInfrastructureConfiguration in interface AWSimagebuilder
    
    Parameters:
    
    updateInfrastructureConfigurationRequest -
    
    Returns:
    
    Result of the UpdateInfrastructureConfiguration operation returned by the service.
    
    Throws:
    
    ServiceException - This exception is thrown when the service encounters an unrecoverable exception.
    
    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.
    
    ServiceUnavailableException - The service is unable to process your request at this time.
    
    InvalidRequestException - You have made a request for an action that is not supported by the service.
    
    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.
    
    ForbiddenException - You are not authorized to perform the requested operation.
    
    CallRateLimitExceededException - You have exceeded the permitted request rate for the specific operation.
    
    ResourceInUseException - The resource that you are trying to operate on is currently in use. Review the message details and retry later.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSimagebuilder
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSimagebuilder
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AWSimagebuilderClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.imagebuilder.AWSimagebuilder

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

cancelImageCreation

createComponent

createContainerRecipe

createDistributionConfiguration

createImage

createImagePipeline

createImageRecipe

createInfrastructureConfiguration

deleteComponent

deleteContainerRecipe

deleteDistributionConfiguration

deleteImage

deleteImagePipeline

deleteImageRecipe

deleteInfrastructureConfiguration

getComponent

getComponentPolicy

getContainerRecipe

getContainerRecipePolicy

getDistributionConfiguration

getImage

getImagePipeline

getImagePolicy

getImageRecipe

getImageRecipePolicy

getInfrastructureConfiguration

importComponent

listComponentBuildVersions

listComponents

listContainerRecipes

listDistributionConfigurations

listImageBuildVersions

listImagePackages

listImagePipelineImages

listImagePipelines

listImageRecipes

listImages

listInfrastructureConfigurations

listTagsForResource

putComponentPolicy

putContainerRecipePolicy

putImagePolicy

putImageRecipePolicy

startImagePipelineExecution

tagResource

untagResource

updateDistributionConfiguration

updateImagePipeline

updateInfrastructureConfiguration

getCachedResponseMetadata

shutdown