AbstractAWSimagebuilder (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.imagebuilder.AbstractAWSimagebuilder

All Implemented Interfaces:

AWSimagebuilder

Direct Known Subclasses:

AbstractAWSimagebuilderAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSimagebuilder
extends Object
implements AWSimagebuilder
```
Abstract implementation of AWSimagebuilder. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 Builder image resource.
`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.
`ImportVmImageResult`	`importVmImage(ImportVmImageRequest request)` When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data.
`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 Web Services 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
  - cancelImageCreation
```
public CancelImageCreationResult cancelImageCreation(CancelImageCreationRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    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
    
    Returns:
    
    Result of the CancelImageCreation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createComponent
```
public CreateComponentResult createComponent(CreateComponentRequest request)
```
    Description copied from interface: AWSimagebuilder
    Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods:
    - Inline, using the data property in the request body.
    - A URL that points to a YAML document file stored in Amazon S3, using the uri property in the request body.
    Specified by:
    
    createComponent in interface AWSimagebuilder
    
    Returns:
    
    Result of the CreateComponent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createContainerRecipe
```
public CreateContainerRecipeResult createContainerRecipe(CreateContainerRecipeRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.
    
    Specified by:
    
    createContainerRecipe in interface AWSimagebuilder
    
    Returns:
    
    Result of the CreateContainerRecipe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDistributionConfiguration
```
public CreateDistributionConfigurationResult createDistributionConfiguration(CreateDistributionConfigurationRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
    
    Specified by:
    
    createDistributionConfiguration in interface AWSimagebuilder
    
    Returns:
    
    Result of the CreateDistributionConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createImage
```
public CreateImageResult createImage(CreateImageRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    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
    
    Returns:
    
    Result of the CreateImage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createImagePipeline
```
public CreateImagePipelineResult createImagePipeline(CreateImagePipelineRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
    
    Specified by:
    
    createImagePipeline in interface AWSimagebuilder
    
    Returns:
    
    Result of the CreateImagePipeline operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createImageRecipe
```
public CreateImageRecipeResult createImageRecipe(CreateImageRecipeRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.
    
    Specified by:
    
    createImageRecipe in interface AWSimagebuilder
    
    Returns:
    
    Result of the CreateImageRecipe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createInfrastructureConfiguration
```
public CreateInfrastructureConfigurationResult createInfrastructureConfiguration(CreateInfrastructureConfigurationRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    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
    
    Returns:
    
    Result of the CreateInfrastructureConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteComponent
```
public DeleteComponentResult deleteComponent(DeleteComponentRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Deletes a component build version.
    
    Specified by:
    
    deleteComponent in interface AWSimagebuilder
    
    Returns:
    
    Result of the DeleteComponent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteContainerRecipe
```
public DeleteContainerRecipeResult deleteContainerRecipe(DeleteContainerRecipeRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Deletes a container recipe.
    
    Specified by:
    
    deleteContainerRecipe in interface AWSimagebuilder
    
    Returns:
    
    Result of the DeleteContainerRecipe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDistributionConfiguration
```
public DeleteDistributionConfigurationResult deleteDistributionConfiguration(DeleteDistributionConfigurationRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Deletes a distribution configuration.
    
    Specified by:
    
    deleteDistributionConfiguration in interface AWSimagebuilder
    
    Returns:
    
    Result of the DeleteDistributionConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteImage
```
public DeleteImageResult deleteImage(DeleteImageRequest request)
```
    Description copied from interface: AWSimagebuilder
    Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container images that are created during the image build process. You must clean those up separately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI commands.
    - To deregister an EC2 Linux AMI, see Deregister your Linux AMI in the Amazon EC2 User Guide .
    - To deregister an EC2 Windows AMI, see Deregister your Windows AMI in the Amazon EC2 Windows Guide .
    - To delete a container image from Amazon ECR, see Deleting an image in the Amazon ECR User Guide.
    Specified by:
    
    deleteImage in interface AWSimagebuilder
    
    Returns:
    
    Result of the DeleteImage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteImagePipeline
```
public DeleteImagePipelineResult deleteImagePipeline(DeleteImagePipelineRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Deletes an image pipeline.
    
    Specified by:
    
    deleteImagePipeline in interface AWSimagebuilder
    
    Returns:
    
    Result of the DeleteImagePipeline operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteImageRecipe
```
public DeleteImageRecipeResult deleteImageRecipe(DeleteImageRecipeRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Deletes an image recipe.
    
    Specified by:
    
    deleteImageRecipe in interface AWSimagebuilder
    
    Returns:
    
    Result of the DeleteImageRecipe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteInfrastructureConfiguration
```
public DeleteInfrastructureConfigurationResult deleteInfrastructureConfiguration(DeleteInfrastructureConfigurationRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Deletes an infrastructure configuration.
    
    Specified by:
    
    deleteInfrastructureConfiguration in interface AWSimagebuilder
    
    Returns:
    
    Result of the DeleteInfrastructureConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getComponent
```
public GetComponentResult getComponent(GetComponentRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Gets a component object.
    
    Specified by:
    
    getComponent in interface AWSimagebuilder
    
    Returns:
    
    Result of the GetComponent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getComponentPolicy
```
public GetComponentPolicyResult getComponentPolicy(GetComponentPolicyRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Gets a component policy.
    
    Specified by:
    
    getComponentPolicy in interface AWSimagebuilder
    
    Returns:
    
    Result of the GetComponentPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getContainerRecipe
```
public GetContainerRecipeResult getContainerRecipe(GetContainerRecipeRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Retrieves a container recipe.
    
    Specified by:
    
    getContainerRecipe in interface AWSimagebuilder
    
    Returns:
    
    Result of the GetContainerRecipe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getContainerRecipePolicy
```
public GetContainerRecipePolicyResult getContainerRecipePolicy(GetContainerRecipePolicyRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Retrieves the policy for a container recipe.
    
    Specified by:
    
    getContainerRecipePolicy in interface AWSimagebuilder
    
    Returns:
    
    Result of the GetContainerRecipePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDistributionConfiguration
```
public GetDistributionConfigurationResult getDistributionConfiguration(GetDistributionConfigurationRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Gets a distribution configuration.
    
    Specified by:
    
    getDistributionConfiguration in interface AWSimagebuilder
    
    Returns:
    
    Result of the GetDistributionConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getImage
```
public GetImageResult getImage(GetImageRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Gets an image.
    
    Specified by:
    
    getImage in interface AWSimagebuilder
    
    Returns:
    
    Result of the GetImage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getImagePipeline
```
public GetImagePipelineResult getImagePipeline(GetImagePipelineRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Gets an image pipeline.
    
    Specified by:
    
    getImagePipeline in interface AWSimagebuilder
    
    Returns:
    
    Result of the GetImagePipeline operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getImagePolicy
```
public GetImagePolicyResult getImagePolicy(GetImagePolicyRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Gets an image policy.
    
    Specified by:
    
    getImagePolicy in interface AWSimagebuilder
    
    Returns:
    
    Result of the GetImagePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getImageRecipe
```
public GetImageRecipeResult getImageRecipe(GetImageRecipeRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Gets an image recipe.
    
    Specified by:
    
    getImageRecipe in interface AWSimagebuilder
    
    Returns:
    
    Result of the GetImageRecipe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getImageRecipePolicy
```
public GetImageRecipePolicyResult getImageRecipePolicy(GetImageRecipePolicyRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Gets an image recipe policy.
    
    Specified by:
    
    getImageRecipePolicy in interface AWSimagebuilder
    
    Returns:
    
    Result of the GetImageRecipePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getInfrastructureConfiguration
```
public GetInfrastructureConfigurationResult getInfrastructureConfiguration(GetInfrastructureConfigurationRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Gets an infrastructure configuration.
    
    Specified by:
    
    getInfrastructureConfiguration in interface AWSimagebuilder
    
    Parameters:
    
    request - GetInfrastructureConfiguration request object.
    
    Returns:
    
    Result of the GetInfrastructureConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importComponent
```
public ImportComponentResult importComponent(ImportComponentRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Imports a component and transforms its data into a component document.
    
    Specified by:
    
    importComponent in interface AWSimagebuilder
    
    Returns:
    
    Result of the ImportComponent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importVmImage
```
public ImportVmImageResult importVmImage(ImportVmImageRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data. The Amazon EC2 API ImportImage action uses those files to import your VM and create an AMI. To import using the CLI command, see import-image
    
    You can reference the task ID from the VM import to pull in the AMI that the import created as the base image for your Image Builder recipe.
    
    Specified by:
    
    importVmImage in interface AWSimagebuilder
    
    Returns:
    
    Result of the ImportVmImage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listComponentBuildVersions
```
public ListComponentBuildVersionsResult listComponentBuildVersions(ListComponentBuildVersionsRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Returns the list of component build versions for the specified semantic version.
    
    The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
    
    Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
    
    Specified by:
    
    listComponentBuildVersions in interface AWSimagebuilder
    
    Returns:
    
    Result of the ListComponentBuildVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listComponents
```
public ListComponentsResult listComponents(ListComponentsRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Returns the list of component build versions for the specified semantic version.
    
    The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
    
    Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
    
    Specified by:
    
    listComponents in interface AWSimagebuilder
    
    Returns:
    
    Result of the ListComponents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listContainerRecipes
```
public ListContainerRecipesResult listContainerRecipes(ListContainerRecipesRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Returns a list of container recipes.
    
    Specified by:
    
    listContainerRecipes in interface AWSimagebuilder
    
    Returns:
    
    Result of the ListContainerRecipes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDistributionConfigurations
```
public ListDistributionConfigurationsResult listDistributionConfigurations(ListDistributionConfigurationsRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Returns a list of distribution configurations.
    
    Specified by:
    
    listDistributionConfigurations in interface AWSimagebuilder
    
    Returns:
    
    Result of the ListDistributionConfigurations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listImageBuildVersions
```
public ListImageBuildVersionsResult listImageBuildVersions(ListImageBuildVersionsRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Returns a list of image build versions.
    
    Specified by:
    
    listImageBuildVersions in interface AWSimagebuilder
    
    Returns:
    
    Result of the ListImageBuildVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listImagePackages
```
public ListImagePackagesResult listImagePackages(ListImagePackagesRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.
    
    Specified by:
    
    listImagePackages in interface AWSimagebuilder
    
    Returns:
    
    Result of the ListImagePackages operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listImagePipelineImages
```
public ListImagePipelineImagesResult listImagePipelineImages(ListImagePipelineImagesRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Returns a list of images created by the specified pipeline.
    
    Specified by:
    
    listImagePipelineImages in interface AWSimagebuilder
    
    Returns:
    
    Result of the ListImagePipelineImages operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listImagePipelines
```
public ListImagePipelinesResult listImagePipelines(ListImagePipelinesRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Returns a list of image pipelines.
    
    Specified by:
    
    listImagePipelines in interface AWSimagebuilder
    
    Returns:
    
    Result of the ListImagePipelines operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listImageRecipes
```
public ListImageRecipesResult listImageRecipes(ListImageRecipesRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Returns a list of image recipes.
    
    Specified by:
    
    listImageRecipes in interface AWSimagebuilder
    
    Returns:
    
    Result of the ListImageRecipes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listImages
```
public ListImagesResult listImages(ListImagesRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Returns the list of images that you have access to.
    
    Specified by:
    
    listImages in interface AWSimagebuilder
    
    Returns:
    
    Result of the ListImages operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listInfrastructureConfigurations
```
public ListInfrastructureConfigurationsResult listInfrastructureConfigurations(ListInfrastructureConfigurationsRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Returns a list of infrastructure configurations.
    
    Specified by:
    
    listInfrastructureConfigurations in interface AWSimagebuilder
    
    Returns:
    
    Result of the ListInfrastructureConfigurations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Returns the list of tags for the specified resource.
    
    Specified by:
    
    listTagsForResource in interface AWSimagebuilder
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putComponentPolicy
```
public PutComponentPolicyResult putComponentPolicy(PutComponentPolicyRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    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
    
    Returns:
    
    Result of the PutComponentPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putContainerRecipePolicy
```
public PutContainerRecipePolicyResult putContainerRecipePolicy(PutContainerRecipePolicyRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    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
    
    Returns:
    
    Result of the PutContainerRecipePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putImagePolicy
```
public PutImagePolicyResult putImagePolicy(PutImagePolicyRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    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
    
    Returns:
    
    Result of the PutImagePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putImageRecipePolicy
```
public PutImageRecipePolicyResult putImageRecipePolicy(PutImageRecipePolicyRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    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
    
    Returns:
    
    Result of the PutImageRecipePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startImagePipelineExecution
```
public StartImagePipelineExecutionResult startImagePipelineExecution(StartImagePipelineExecutionRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Manually triggers a pipeline to create an image.
    
    Specified by:
    
    startImagePipelineExecution in interface AWSimagebuilder
    
    Returns:
    
    Result of the StartImagePipelineExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Adds a tag to a resource.
    
    Specified by:
    
    tagResource in interface AWSimagebuilder
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Removes a tag from a resource.
    
    Specified by:
    
    untagResource in interface AWSimagebuilder
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDistributionConfiguration
```
public UpdateDistributionConfigurationResult updateDistributionConfiguration(UpdateDistributionConfigurationRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
    
    Specified by:
    
    updateDistributionConfiguration in interface AWSimagebuilder
    
    Returns:
    
    Result of the UpdateDistributionConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateImagePipeline
```
public UpdateImagePipelineResult updateImagePipeline(UpdateImagePipelineRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    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
    
    Returns:
    
    Result of the UpdateImagePipeline operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateInfrastructureConfiguration
```
public UpdateInfrastructureConfigurationResult updateInfrastructureConfiguration(UpdateInfrastructureConfigurationRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    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
    
    Returns:
    
    Result of the UpdateInfrastructureConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSimagebuilder
    
    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.
    
    Specified by:
    
    shutdown in interface AWSimagebuilder
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSimagebuilder
    
    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.
    
    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.

Did this page help you?

Class AbstractAWSimagebuilder

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

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

importVmImage

listComponentBuildVersions

listComponents

listContainerRecipes

listDistributionConfigurations

listImageBuildVersions

listImagePackages

listImagePipelineImages

listImagePipelines

listImageRecipes

listImages

listInfrastructureConfigurations

listTagsForResource

putComponentPolicy

putContainerRecipePolicy

putImagePolicy

putImageRecipePolicy

startImagePipelineExecution

tagResource

untagResource

updateDistributionConfiguration

updateImagePipeline

updateInfrastructureConfiguration

shutdown

getCachedResponseMetadata