@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSimagebuilder extends Object implements AWSimagebuilder
AWSimagebuilder. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIXpublic CancelImageCreationResult cancelImageCreation(CancelImageCreationRequest request)
AWSimagebuilderCancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
cancelImageCreation in interface AWSimagebuilderpublic CreateComponentResult createComponent(CreateComponentRequest request)
AWSimagebuilderCreates a new component that can be used to build, validate, test, and assess your image.
createComponent in interface AWSimagebuilderpublic CreateContainerRecipeResult createContainerRecipe(CreateContainerRecipeRequest request)
AWSimagebuilderCreates a new container recipe. Container recipes define how images are configured, tested, and assessed.
createContainerRecipe in interface AWSimagebuilderpublic CreateDistributionConfigurationResult createDistributionConfiguration(CreateDistributionConfigurationRequest request)
AWSimagebuilderCreates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
createDistributionConfiguration in interface AWSimagebuilderpublic CreateImageResult createImage(CreateImageRequest request)
AWSimagebuilderCreates 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.
createImage in interface AWSimagebuilderpublic CreateImagePipelineResult createImagePipeline(CreateImagePipelineRequest request)
AWSimagebuilderCreates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
createImagePipeline in interface AWSimagebuilderpublic CreateImageRecipeResult createImageRecipe(CreateImageRecipeRequest request)
AWSimagebuilderCreates a new image recipe. Image recipes define how images are configured, tested, and assessed.
createImageRecipe in interface AWSimagebuilderpublic CreateInfrastructureConfigurationResult createInfrastructureConfiguration(CreateInfrastructureConfigurationRequest request)
AWSimagebuilderCreates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
createInfrastructureConfiguration in interface AWSimagebuilderpublic DeleteComponentResult deleteComponent(DeleteComponentRequest request)
AWSimagebuilderDeletes a component build version.
deleteComponent in interface AWSimagebuilderpublic DeleteContainerRecipeResult deleteContainerRecipe(DeleteContainerRecipeRequest request)
AWSimagebuilderDeletes a container recipe.
deleteContainerRecipe in interface AWSimagebuilderpublic DeleteDistributionConfigurationResult deleteDistributionConfiguration(DeleteDistributionConfigurationRequest request)
AWSimagebuilderDeletes a distribution configuration.
deleteDistributionConfiguration in interface AWSimagebuilderpublic DeleteImageResult deleteImage(DeleteImageRequest request)
AWSimagebuilderDeletes 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.
deleteImage in interface AWSimagebuilderpublic DeleteImagePipelineResult deleteImagePipeline(DeleteImagePipelineRequest request)
AWSimagebuilderDeletes an image pipeline.
deleteImagePipeline in interface AWSimagebuilderpublic DeleteImageRecipeResult deleteImageRecipe(DeleteImageRecipeRequest request)
AWSimagebuilderDeletes an image recipe.
deleteImageRecipe in interface AWSimagebuilderpublic DeleteInfrastructureConfigurationResult deleteInfrastructureConfiguration(DeleteInfrastructureConfigurationRequest request)
AWSimagebuilderDeletes an infrastructure configuration.
deleteInfrastructureConfiguration in interface AWSimagebuilderpublic GetComponentResult getComponent(GetComponentRequest request)
AWSimagebuilderGets a component object.
getComponent in interface AWSimagebuilderpublic GetComponentPolicyResult getComponentPolicy(GetComponentPolicyRequest request)
AWSimagebuilderGets a component policy.
getComponentPolicy in interface AWSimagebuilderpublic GetContainerRecipeResult getContainerRecipe(GetContainerRecipeRequest request)
AWSimagebuilderRetrieves a container recipe.
getContainerRecipe in interface AWSimagebuilderpublic GetContainerRecipePolicyResult getContainerRecipePolicy(GetContainerRecipePolicyRequest request)
AWSimagebuilderRetrieves the policy for a container recipe.
getContainerRecipePolicy in interface AWSimagebuilderpublic GetDistributionConfigurationResult getDistributionConfiguration(GetDistributionConfigurationRequest request)
AWSimagebuilderGets a distribution configuration.
getDistributionConfiguration in interface AWSimagebuilderpublic GetImageResult getImage(GetImageRequest request)
AWSimagebuilderGets an image.
getImage in interface AWSimagebuilderpublic GetImagePipelineResult getImagePipeline(GetImagePipelineRequest request)
AWSimagebuilderGets an image pipeline.
getImagePipeline in interface AWSimagebuilderpublic GetImagePolicyResult getImagePolicy(GetImagePolicyRequest request)
AWSimagebuilderGets an image policy.
getImagePolicy in interface AWSimagebuilderpublic GetImageRecipeResult getImageRecipe(GetImageRecipeRequest request)
AWSimagebuilderGets an image recipe.
getImageRecipe in interface AWSimagebuilderpublic GetImageRecipePolicyResult getImageRecipePolicy(GetImageRecipePolicyRequest request)
AWSimagebuilderGets an image recipe policy.
getImageRecipePolicy in interface AWSimagebuilderpublic GetInfrastructureConfigurationResult getInfrastructureConfiguration(GetInfrastructureConfigurationRequest request)
AWSimagebuilderGets an infrastructure configuration.
getInfrastructureConfiguration in interface AWSimagebuilderrequest - GetInfrastructureConfiguration request object.public ImportComponentResult importComponent(ImportComponentRequest request)
AWSimagebuilderImports a component and transforms its data into a component document.
importComponent in interface AWSimagebuilderpublic ListComponentBuildVersionsResult listComponentBuildVersions(ListComponentBuildVersionsRequest request)
AWSimagebuilderReturns 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.
listComponentBuildVersions in interface AWSimagebuilderpublic ListComponentsResult listComponents(ListComponentsRequest request)
AWSimagebuilderReturns 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.
listComponents in interface AWSimagebuilderpublic ListContainerRecipesResult listContainerRecipes(ListContainerRecipesRequest request)
AWSimagebuilderReturns a list of container recipes.
listContainerRecipes in interface AWSimagebuilderpublic ListDistributionConfigurationsResult listDistributionConfigurations(ListDistributionConfigurationsRequest request)
AWSimagebuilderReturns a list of distribution configurations.
listDistributionConfigurations in interface AWSimagebuilderpublic ListImageBuildVersionsResult listImageBuildVersions(ListImageBuildVersionsRequest request)
AWSimagebuilderReturns a list of image build versions.
listImageBuildVersions in interface AWSimagebuilderpublic ListImagePackagesResult listImagePackages(ListImagePackagesRequest request)
AWSimagebuilderList the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.
listImagePackages in interface AWSimagebuilderpublic ListImagePipelineImagesResult listImagePipelineImages(ListImagePipelineImagesRequest request)
AWSimagebuilderReturns a list of images created by the specified pipeline.
listImagePipelineImages in interface AWSimagebuilderpublic ListImagePipelinesResult listImagePipelines(ListImagePipelinesRequest request)
AWSimagebuilderReturns a list of image pipelines.
listImagePipelines in interface AWSimagebuilderpublic ListImageRecipesResult listImageRecipes(ListImageRecipesRequest request)
AWSimagebuilderReturns a list of image recipes.
listImageRecipes in interface AWSimagebuilderpublic ListImagesResult listImages(ListImagesRequest request)
AWSimagebuilderReturns the list of images that you have access to.
listImages in interface AWSimagebuilderpublic ListInfrastructureConfigurationsResult listInfrastructureConfigurations(ListInfrastructureConfigurationsRequest request)
AWSimagebuilderReturns a list of infrastructure configurations.
listInfrastructureConfigurations in interface AWSimagebuilderpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSimagebuilderReturns the list of tags for the specified resource.
listTagsForResource in interface AWSimagebuilderpublic PutComponentPolicyResult putComponentPolicy(PutComponentPolicyRequest request)
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.
putComponentPolicy in interface AWSimagebuilderpublic PutContainerRecipePolicyResult putContainerRecipePolicy(PutContainerRecipePolicyRequest request)
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.
putContainerRecipePolicy in interface AWSimagebuilderpublic PutImagePolicyResult putImagePolicy(PutImagePolicyRequest request)
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.
putImagePolicy in interface AWSimagebuilderpublic PutImageRecipePolicyResult putImageRecipePolicy(PutImageRecipePolicyRequest request)
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.
putImageRecipePolicy in interface AWSimagebuilderpublic StartImagePipelineExecutionResult startImagePipelineExecution(StartImagePipelineExecutionRequest request)
AWSimagebuilderManually triggers a pipeline to create an image.
startImagePipelineExecution in interface AWSimagebuilderpublic TagResourceResult tagResource(TagResourceRequest request)
AWSimagebuilderAdds a tag to a resource.
tagResource in interface AWSimagebuilderpublic UntagResourceResult untagResource(UntagResourceRequest request)
AWSimagebuilderRemoves a tag from a resource.
untagResource in interface AWSimagebuilderpublic UpdateDistributionConfigurationResult updateDistributionConfiguration(UpdateDistributionConfigurationRequest request)
AWSimagebuilderUpdates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
updateDistributionConfiguration in interface AWSimagebuilderpublic UpdateImagePipelineResult updateImagePipeline(UpdateImagePipelineRequest request)
AWSimagebuilderUpdates 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.
updateImagePipeline in interface AWSimagebuilderpublic UpdateInfrastructureConfigurationResult updateInfrastructureConfiguration(UpdateInfrastructureConfigurationRequest request)
AWSimagebuilderUpdates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
updateInfrastructureConfiguration in interface AWSimagebuilderpublic void shutdown()
AWSimagebuildershutdown in interface AWSimagebuilderpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSimagebuilderResponse 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.
getCachedResponseMetadata in interface AWSimagebuilderrequest - The originally executed request.