com.amazonaws.services.imagebuilder

Interface AWSimagebuilder

All Known Subinterfaces:

AWSimagebuilderAsync

All Known Implementing Classes:

AbstractAWSimagebuilder, AbstractAWSimagebuilderAsync, AWSimagebuilderAsyncClient, AWSimagebuilderClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSimagebuilder

Interface for accessing imagebuilder.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSimagebuilder instead.

EC2 Image Builder is a fully managed AWS 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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CancelImageCreationResult	cancelImageCreation(CancelImageCreationRequest cancelImageCreationRequest) CancelImageCreation cancels the creation of Image.
CreateComponentResult	createComponent(CreateComponentRequest createComponentRequest) Creates a new component that can be used to build, validate, test, and assess your image.
CreateDistributionConfigurationResult	createDistributionConfiguration(CreateDistributionConfigurationRequest createDistributionConfigurationRequest) Creates a new distribution configuration.
CreateImageResult	createImage(CreateImageRequest createImageRequest) Creates a new image.
CreateImagePipelineResult	createImagePipeline(CreateImagePipelineRequest createImagePipelineRequest) Creates a new image pipeline.
CreateImageRecipeResult	createImageRecipe(CreateImageRecipeRequest createImageRecipeRequest) Creates a new image recipe.
CreateInfrastructureConfigurationResult	createInfrastructureConfiguration(CreateInfrastructureConfigurationRequest createInfrastructureConfigurationRequest) Creates a new infrastructure configuration.
DeleteComponentResult	deleteComponent(DeleteComponentRequest deleteComponentRequest) Deletes a component build version.
DeleteDistributionConfigurationResult	deleteDistributionConfiguration(DeleteDistributionConfigurationRequest deleteDistributionConfigurationRequest) Deletes a distribution configuration.
DeleteImageResult	deleteImage(DeleteImageRequest deleteImageRequest) Deletes an image.
DeleteImagePipelineResult	deleteImagePipeline(DeleteImagePipelineRequest deleteImagePipelineRequest) Deletes an image pipeline.
DeleteImageRecipeResult	deleteImageRecipe(DeleteImageRecipeRequest deleteImageRecipeRequest) Deletes an image recipe.
DeleteInfrastructureConfigurationResult	deleteInfrastructureConfiguration(DeleteInfrastructureConfigurationRequest deleteInfrastructureConfigurationRequest) 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 getComponentRequest) Gets a component object.
GetComponentPolicyResult	getComponentPolicy(GetComponentPolicyRequest getComponentPolicyRequest) Gets a component policy.
GetDistributionConfigurationResult	getDistributionConfiguration(GetDistributionConfigurationRequest getDistributionConfigurationRequest) Gets a distribution configuration.
GetImageResult	getImage(GetImageRequest getImageRequest) Gets an image.
GetImagePipelineResult	getImagePipeline(GetImagePipelineRequest getImagePipelineRequest) Gets an image pipeline.
GetImagePolicyResult	getImagePolicy(GetImagePolicyRequest getImagePolicyRequest) Gets an image policy.
GetImageRecipeResult	getImageRecipe(GetImageRecipeRequest getImageRecipeRequest) Gets an image recipe.
GetImageRecipePolicyResult	getImageRecipePolicy(GetImageRecipePolicyRequest getImageRecipePolicyRequest) Gets an image recipe policy.
GetInfrastructureConfigurationResult	getInfrastructureConfiguration(GetInfrastructureConfigurationRequest getInfrastructureConfigurationRequest) Gets an infrastructure configuration.
ImportComponentResult	importComponent(ImportComponentRequest importComponentRequest) Imports a component and transforms its data into a component document.
ListComponentBuildVersionsResult	listComponentBuildVersions(ListComponentBuildVersionsRequest listComponentBuildVersionsRequest) Returns the list of component build versions for the specified semantic version.
ListComponentsResult	listComponents(ListComponentsRequest listComponentsRequest) Returns the list of component build versions for the specified semantic version.
ListDistributionConfigurationsResult	listDistributionConfigurations(ListDistributionConfigurationsRequest listDistributionConfigurationsRequest) Returns a list of distribution configurations.
ListImageBuildVersionsResult	listImageBuildVersions(ListImageBuildVersionsRequest listImageBuildVersionsRequest) Returns a list of distribution configurations.
ListImagePipelineImagesResult	listImagePipelineImages(ListImagePipelineImagesRequest listImagePipelineImagesRequest) Returns a list of images created by the specified pipeline.
ListImagePipelinesResult	listImagePipelines(ListImagePipelinesRequest listImagePipelinesRequest) Returns a list of image pipelines.
ListImageRecipesResult	listImageRecipes(ListImageRecipesRequest listImageRecipesRequest) Returns a list of image recipes.
ListImagesResult	listImages(ListImagesRequest listImagesRequest) Returns the list of image build versions for the specified semantic version.
ListInfrastructureConfigurationsResult	listInfrastructureConfigurations(ListInfrastructureConfigurationsRequest listInfrastructureConfigurationsRequest) Returns a list of infrastructure configurations.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns the list of tags for the specified resource.
PutComponentPolicyResult	putComponentPolicy(PutComponentPolicyRequest putComponentPolicyRequest) Applies a policy to a component.
PutImagePolicyResult	putImagePolicy(PutImagePolicyRequest putImagePolicyRequest) Applies a policy to an image.
PutImageRecipePolicyResult	putImageRecipePolicy(PutImageRecipePolicyRequest putImageRecipePolicyRequest) 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 startImagePipelineExecutionRequest) Manually triggers a pipeline to create an image.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds a tag to a resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes a tag from a resource.
UpdateDistributionConfigurationResult	updateDistributionConfiguration(UpdateDistributionConfigurationRequest updateDistributionConfigurationRequest) Updates a new distribution configuration.
UpdateImagePipelineResult	updateImagePipeline(UpdateImagePipelineRequest updateImagePipelineRequest) Updates a new image pipeline.
UpdateInfrastructureConfigurationResult	updateInfrastructureConfiguration(UpdateInfrastructureConfigurationRequest updateInfrastructureConfigurationRequest) Updates a new infrastructure configuration.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

cancelImageCreation

CancelImageCreationResult cancelImageCreation(CancelImageCreationRequest cancelImageCreationRequest)

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

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

CreateComponentResult createComponent(CreateComponentRequest createComponentRequest)

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

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.

See Also:

AWS API Documentation

createDistributionConfiguration

CreateDistributionConfigurationResult createDistributionConfiguration(CreateDistributionConfigurationRequest createDistributionConfigurationRequest)

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

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.

See Also:

AWS API Documentation

createImage

CreateImageResult createImage(CreateImageRequest createImageRequest)

Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration.

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.

See Also:

AWS API Documentation

createImagePipeline

CreateImagePipelineResult createImagePipeline(CreateImagePipelineRequest createImagePipelineRequest)

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

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.

See Also:

AWS API Documentation

createImageRecipe

CreateImageRecipeResult createImageRecipe(CreateImageRecipeRequest createImageRecipeRequest)

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

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.

See Also:

AWS API Documentation

createInfrastructureConfiguration

CreateInfrastructureConfigurationResult createInfrastructureConfiguration(CreateInfrastructureConfigurationRequest createInfrastructureConfigurationRequest)

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

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.

See Also:

AWS API Documentation

deleteComponent

DeleteComponentResult deleteComponent(DeleteComponentRequest deleteComponentRequest)

Deletes a component build version.

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

deleteDistributionConfiguration

DeleteDistributionConfigurationResult deleteDistributionConfiguration(DeleteDistributionConfigurationRequest deleteDistributionConfigurationRequest)

Deletes a distribution configuration.

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

DeleteImageResult deleteImage(DeleteImageRequest deleteImageRequest)

Deletes an image.

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

DeleteImagePipelineResult deleteImagePipeline(DeleteImagePipelineRequest deleteImagePipelineRequest)

Deletes an image pipeline.

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

DeleteImageRecipeResult deleteImageRecipe(DeleteImageRecipeRequest deleteImageRecipeRequest)

Deletes an image recipe.

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

DeleteInfrastructureConfigurationResult deleteInfrastructureConfiguration(DeleteInfrastructureConfigurationRequest deleteInfrastructureConfigurationRequest)

Deletes an infrastructure configuration.

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

GetComponentResult getComponent(GetComponentRequest getComponentRequest)

Gets a component object.

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

GetComponentPolicyResult getComponentPolicy(GetComponentPolicyRequest getComponentPolicyRequest)

Gets a component policy.

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

getDistributionConfiguration

GetDistributionConfigurationResult getDistributionConfiguration(GetDistributionConfigurationRequest getDistributionConfigurationRequest)

Gets a distribution configuration.

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

GetImageResult getImage(GetImageRequest getImageRequest)

Gets an image.

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

GetImagePipelineResult getImagePipeline(GetImagePipelineRequest getImagePipelineRequest)

Gets an image pipeline.

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

GetImagePolicyResult getImagePolicy(GetImagePolicyRequest getImagePolicyRequest)

Gets an image policy.

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

GetImageRecipeResult getImageRecipe(GetImageRecipeRequest getImageRecipeRequest)

Gets an image recipe.

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

GetImageRecipePolicyResult getImageRecipePolicy(GetImageRecipePolicyRequest getImageRecipePolicyRequest)

Gets an image recipe policy.

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

GetInfrastructureConfigurationResult getInfrastructureConfiguration(GetInfrastructureConfigurationRequest getInfrastructureConfigurationRequest)

Gets an infrastructure configuration.

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

ImportComponentResult importComponent(ImportComponentRequest importComponentRequest)

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

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

ListComponentBuildVersionsResult listComponentBuildVersions(ListComponentBuildVersionsRequest listComponentBuildVersionsRequest)

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

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

ListComponentsResult listComponents(ListComponentsRequest listComponentsRequest)

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

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

listDistributionConfigurations

ListDistributionConfigurationsResult listDistributionConfigurations(ListDistributionConfigurationsRequest listDistributionConfigurationsRequest)

Returns a list of distribution configurations.

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

ListImageBuildVersionsResult listImageBuildVersions(ListImageBuildVersionsRequest listImageBuildVersionsRequest)

Returns a list of distribution configurations.

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

listImagePipelineImages

ListImagePipelineImagesResult listImagePipelineImages(ListImagePipelineImagesRequest listImagePipelineImagesRequest)

Returns a list of images created by the specified pipeline.

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

ListImagePipelinesResult listImagePipelines(ListImagePipelinesRequest listImagePipelinesRequest)

Returns a list of image pipelines.

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

ListImageRecipesResult listImageRecipes(ListImageRecipesRequest listImageRecipesRequest)

Returns a list of image recipes.

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

ListImagesResult listImages(ListImagesRequest listImagesRequest)

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

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

ListInfrastructureConfigurationsResult listInfrastructureConfigurations(ListInfrastructureConfigurationsRequest listInfrastructureConfigurationsRequest)

Returns a list of infrastructure configurations.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Returns the list of tags for the specified resource.

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

PutComponentPolicyResult putComponentPolicy(PutComponentPolicyRequest putComponentPolicyRequest)

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.

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

putImagePolicy

PutImagePolicyResult putImagePolicy(PutImagePolicyRequest putImagePolicyRequest)

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.

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

PutImageRecipePolicyResult putImageRecipePolicy(PutImageRecipePolicyRequest putImageRecipePolicyRequest)

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.

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

StartImagePipelineExecutionResult startImagePipelineExecution(StartImagePipelineExecutionRequest startImagePipelineExecutionRequest)

Manually triggers a pipeline to create an image.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds a tag to a resource.

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes a tag from a resource.

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

UpdateDistributionConfigurationResult updateDistributionConfiguration(UpdateDistributionConfigurationRequest updateDistributionConfigurationRequest)

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

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

UpdateImagePipelineResult updateImagePipeline(UpdateImagePipelineRequest updateImagePipelineRequest)

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

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

UpdateInfrastructureConfigurationResult updateInfrastructureConfiguration(UpdateInfrastructureConfigurationRequest updateInfrastructureConfigurationRequest)

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

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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.