@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_PREFIX
public CancelImageCreationResult cancelImageCreation(CancelImageCreationRequest request)
AWSimagebuilder
CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
cancelImageCreation
in interface AWSimagebuilder
public CancelLifecycleExecutionResult cancelLifecycleExecution(CancelLifecycleExecutionRequest request)
AWSimagebuilder
Cancel a specific image lifecycle policy runtime instance.
cancelLifecycleExecution
in interface AWSimagebuilder
public CreateComponentResult createComponent(CreateComponentRequest request)
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.
createComponent
in interface AWSimagebuilder
public CreateContainerRecipeResult createContainerRecipe(CreateContainerRecipeRequest request)
AWSimagebuilder
Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.
createContainerRecipe
in interface AWSimagebuilder
public CreateDistributionConfigurationResult createDistributionConfiguration(CreateDistributionConfigurationRequest request)
AWSimagebuilder
Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
createDistributionConfiguration
in interface AWSimagebuilder
public CreateImageResult createImage(CreateImageRequest request)
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.
createImage
in interface AWSimagebuilder
public CreateImagePipelineResult createImagePipeline(CreateImagePipelineRequest request)
AWSimagebuilder
Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
createImagePipeline
in interface AWSimagebuilder
public CreateImageRecipeResult createImageRecipe(CreateImageRecipeRequest request)
AWSimagebuilder
Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.
createImageRecipe
in interface AWSimagebuilder
public CreateInfrastructureConfigurationResult createInfrastructureConfiguration(CreateInfrastructureConfigurationRequest request)
AWSimagebuilder
Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
createInfrastructureConfiguration
in interface AWSimagebuilder
public CreateLifecyclePolicyResult createLifecyclePolicy(CreateLifecyclePolicyRequest request)
AWSimagebuilder
Create a lifecycle policy resource.
createLifecyclePolicy
in interface AWSimagebuilder
public CreateWorkflowResult createWorkflow(CreateWorkflowRequest request)
AWSimagebuilder
Create a new workflow or a new version of an existing workflow.
createWorkflow
in interface AWSimagebuilder
public DeleteComponentResult deleteComponent(DeleteComponentRequest request)
AWSimagebuilder
Deletes a component build version.
deleteComponent
in interface AWSimagebuilder
public DeleteContainerRecipeResult deleteContainerRecipe(DeleteContainerRecipeRequest request)
AWSimagebuilder
Deletes a container recipe.
deleteContainerRecipe
in interface AWSimagebuilder
public DeleteDistributionConfigurationResult deleteDistributionConfiguration(DeleteDistributionConfigurationRequest request)
AWSimagebuilder
Deletes a distribution configuration.
deleteDistributionConfiguration
in interface AWSimagebuilder
public DeleteImageResult deleteImage(DeleteImageRequest request)
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.
deleteImage
in interface AWSimagebuilder
public DeleteImagePipelineResult deleteImagePipeline(DeleteImagePipelineRequest request)
AWSimagebuilder
Deletes an image pipeline.
deleteImagePipeline
in interface AWSimagebuilder
public DeleteImageRecipeResult deleteImageRecipe(DeleteImageRecipeRequest request)
AWSimagebuilder
Deletes an image recipe.
deleteImageRecipe
in interface AWSimagebuilder
public DeleteInfrastructureConfigurationResult deleteInfrastructureConfiguration(DeleteInfrastructureConfigurationRequest request)
AWSimagebuilder
Deletes an infrastructure configuration.
deleteInfrastructureConfiguration
in interface AWSimagebuilder
public DeleteLifecyclePolicyResult deleteLifecyclePolicy(DeleteLifecyclePolicyRequest request)
AWSimagebuilder
Delete the specified lifecycle policy resource.
deleteLifecyclePolicy
in interface AWSimagebuilder
public DeleteWorkflowResult deleteWorkflow(DeleteWorkflowRequest request)
AWSimagebuilder
Deletes a specific workflow resource.
deleteWorkflow
in interface AWSimagebuilder
public GetComponentResult getComponent(GetComponentRequest request)
AWSimagebuilder
Gets a component object.
getComponent
in interface AWSimagebuilder
public GetComponentPolicyResult getComponentPolicy(GetComponentPolicyRequest request)
AWSimagebuilder
Gets a component policy.
getComponentPolicy
in interface AWSimagebuilder
public GetContainerRecipeResult getContainerRecipe(GetContainerRecipeRequest request)
AWSimagebuilder
Retrieves a container recipe.
getContainerRecipe
in interface AWSimagebuilder
public GetContainerRecipePolicyResult getContainerRecipePolicy(GetContainerRecipePolicyRequest request)
AWSimagebuilder
Retrieves the policy for a container recipe.
getContainerRecipePolicy
in interface AWSimagebuilder
public GetDistributionConfigurationResult getDistributionConfiguration(GetDistributionConfigurationRequest request)
AWSimagebuilder
Gets a distribution configuration.
getDistributionConfiguration
in interface AWSimagebuilder
public GetImageResult getImage(GetImageRequest request)
AWSimagebuilder
Gets an image.
getImage
in interface AWSimagebuilder
public GetImagePipelineResult getImagePipeline(GetImagePipelineRequest request)
AWSimagebuilder
Gets an image pipeline.
getImagePipeline
in interface AWSimagebuilder
public GetImagePolicyResult getImagePolicy(GetImagePolicyRequest request)
AWSimagebuilder
Gets an image policy.
getImagePolicy
in interface AWSimagebuilder
public GetImageRecipeResult getImageRecipe(GetImageRecipeRequest request)
AWSimagebuilder
Gets an image recipe.
getImageRecipe
in interface AWSimagebuilder
public GetImageRecipePolicyResult getImageRecipePolicy(GetImageRecipePolicyRequest request)
AWSimagebuilder
Gets an image recipe policy.
getImageRecipePolicy
in interface AWSimagebuilder
public GetInfrastructureConfigurationResult getInfrastructureConfiguration(GetInfrastructureConfigurationRequest request)
AWSimagebuilder
Gets an infrastructure configuration.
getInfrastructureConfiguration
in interface AWSimagebuilder
request
- GetInfrastructureConfiguration request object.public GetLifecycleExecutionResult getLifecycleExecution(GetLifecycleExecutionRequest request)
AWSimagebuilder
Get the runtime information that was logged for a specific runtime instance of the lifecycle policy.
getLifecycleExecution
in interface AWSimagebuilder
public GetLifecyclePolicyResult getLifecyclePolicy(GetLifecyclePolicyRequest request)
AWSimagebuilder
Get details for the specified image lifecycle policy.
getLifecyclePolicy
in interface AWSimagebuilder
public GetWorkflowResult getWorkflow(GetWorkflowRequest request)
AWSimagebuilder
Get a workflow resource object.
getWorkflow
in interface AWSimagebuilder
public GetWorkflowExecutionResult getWorkflowExecution(GetWorkflowExecutionRequest request)
AWSimagebuilder
Get the runtime information that was logged for a specific runtime instance of the workflow.
getWorkflowExecution
in interface AWSimagebuilder
public GetWorkflowStepExecutionResult getWorkflowStepExecution(GetWorkflowStepExecutionRequest request)
AWSimagebuilder
Get the runtime information that was logged for a specific runtime instance of the workflow step.
getWorkflowStepExecution
in interface AWSimagebuilder
public ImportComponentResult importComponent(ImportComponentRequest request)
AWSimagebuilder
Imports a component and transforms its data into a component document.
importComponent
in interface AWSimagebuilder
public ImportVmImageResult importVmImage(ImportVmImageRequest request)
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.
importVmImage
in interface AWSimagebuilder
public ListComponentBuildVersionsResult listComponentBuildVersions(ListComponentBuildVersionsRequest request)
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.
listComponentBuildVersions
in interface AWSimagebuilder
public ListComponentsResult listComponents(ListComponentsRequest request)
AWSimagebuilder
Returns the list of components that can be filtered by name, or by using the listed filters
to
streamline results. Newly created components can take up to two minutes to appear in the ListComponents API
Results.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
listComponents
in interface AWSimagebuilder
public ListContainerRecipesResult listContainerRecipes(ListContainerRecipesRequest request)
AWSimagebuilder
Returns a list of container recipes.
listContainerRecipes
in interface AWSimagebuilder
public ListDistributionConfigurationsResult listDistributionConfigurations(ListDistributionConfigurationsRequest request)
AWSimagebuilder
Returns a list of distribution configurations.
listDistributionConfigurations
in interface AWSimagebuilder
public ListImageBuildVersionsResult listImageBuildVersions(ListImageBuildVersionsRequest request)
AWSimagebuilder
Returns a list of image build versions.
listImageBuildVersions
in interface AWSimagebuilder
public ListImagePackagesResult listImagePackages(ListImagePackagesRequest request)
AWSimagebuilder
List 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 AWSimagebuilder
public ListImagePipelineImagesResult listImagePipelineImages(ListImagePipelineImagesRequest request)
AWSimagebuilder
Returns a list of images created by the specified pipeline.
listImagePipelineImages
in interface AWSimagebuilder
public ListImagePipelinesResult listImagePipelines(ListImagePipelinesRequest request)
AWSimagebuilder
Returns a list of image pipelines.
listImagePipelines
in interface AWSimagebuilder
public ListImageRecipesResult listImageRecipes(ListImageRecipesRequest request)
AWSimagebuilder
Returns a list of image recipes.
listImageRecipes
in interface AWSimagebuilder
public ListImageScanFindingAggregationsResult listImageScanFindingAggregations(ListImageScanFindingAggregationsRequest request)
AWSimagebuilder
Returns a list of image scan aggregations for your account. You can filter by the type of key that Image Builder
uses to group results. For example, if you want to get a list of findings by severity level for one of your
pipelines, you might specify your pipeline with the imagePipelineArn
filter. If you don't specify a
filter, Image Builder returns an aggregation for your account.
To streamline results, you can use the following filters in your request:
accountId
imageBuildVersionArn
imagePipelineArn
vulnerabilityId
listImageScanFindingAggregations
in interface AWSimagebuilder
public ListImageScanFindingsResult listImageScanFindings(ListImageScanFindingsRequest request)
AWSimagebuilder
Returns a list of image scan findings for your account.
listImageScanFindings
in interface AWSimagebuilder
public ListImagesResult listImages(ListImagesRequest request)
AWSimagebuilder
Returns the list of images that you have access to. Newly created images can take up to two minutes to appear in the ListImages API Results.
listImages
in interface AWSimagebuilder
public ListInfrastructureConfigurationsResult listInfrastructureConfigurations(ListInfrastructureConfigurationsRequest request)
AWSimagebuilder
Returns a list of infrastructure configurations.
listInfrastructureConfigurations
in interface AWSimagebuilder
public ListLifecycleExecutionResourcesResult listLifecycleExecutionResources(ListLifecycleExecutionResourcesRequest request)
AWSimagebuilder
List resources that the runtime instance of the image lifecycle identified for lifecycle actions.
listLifecycleExecutionResources
in interface AWSimagebuilder
public ListLifecycleExecutionsResult listLifecycleExecutions(ListLifecycleExecutionsRequest request)
AWSimagebuilder
Get the lifecycle runtime history for the specified resource.
listLifecycleExecutions
in interface AWSimagebuilder
public ListLifecyclePoliciesResult listLifecyclePolicies(ListLifecyclePoliciesRequest request)
AWSimagebuilder
Get a list of lifecycle policies in your Amazon Web Services account.
listLifecyclePolicies
in interface AWSimagebuilder
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSimagebuilder
Returns the list of tags for the specified resource.
listTagsForResource
in interface AWSimagebuilder
public ListWaitingWorkflowStepsResult listWaitingWorkflowSteps(ListWaitingWorkflowStepsRequest request)
AWSimagebuilder
Get a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account.
listWaitingWorkflowSteps
in interface AWSimagebuilder
public ListWorkflowBuildVersionsResult listWorkflowBuildVersions(ListWorkflowBuildVersionsRequest request)
AWSimagebuilder
Returns a list of build versions for a specific workflow resource.
listWorkflowBuildVersions
in interface AWSimagebuilder
public ListWorkflowExecutionsResult listWorkflowExecutions(ListWorkflowExecutionsRequest request)
AWSimagebuilder
Returns a list of workflow runtime instance metadata objects for a specific image build version.
listWorkflowExecutions
in interface AWSimagebuilder
public ListWorkflowStepExecutionsResult listWorkflowStepExecutions(ListWorkflowStepExecutionsRequest request)
AWSimagebuilder
Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.
listWorkflowStepExecutions
in interface AWSimagebuilder
public ListWorkflowsResult listWorkflows(ListWorkflowsRequest request)
AWSimagebuilder
Lists workflow build versions based on filtering parameters.
listWorkflows
in interface AWSimagebuilder
public 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 AWSimagebuilder
public 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 AWSimagebuilder
public 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 AWSimagebuilder
public 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 AWSimagebuilder
public SendWorkflowStepActionResult sendWorkflowStepAction(SendWorkflowStepActionRequest request)
AWSimagebuilder
Pauses or resumes image creation when the associated workflow runs a WaitForAction
step.
sendWorkflowStepAction
in interface AWSimagebuilder
public StartImagePipelineExecutionResult startImagePipelineExecution(StartImagePipelineExecutionRequest request)
AWSimagebuilder
Manually triggers a pipeline to create an image.
startImagePipelineExecution
in interface AWSimagebuilder
public StartResourceStateUpdateResult startResourceStateUpdate(StartResourceStateUpdateRequest request)
AWSimagebuilder
Begin asynchronous resource state update for lifecycle changes to the specified image resources.
startResourceStateUpdate
in interface AWSimagebuilder
public TagResourceResult tagResource(TagResourceRequest request)
AWSimagebuilder
Adds a tag to a resource.
tagResource
in interface AWSimagebuilder
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSimagebuilder
Removes a tag from a resource.
untagResource
in interface AWSimagebuilder
public UpdateDistributionConfigurationResult updateDistributionConfiguration(UpdateDistributionConfigurationRequest request)
AWSimagebuilder
Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
updateDistributionConfiguration
in interface AWSimagebuilder
public UpdateImagePipelineResult updateImagePipeline(UpdateImagePipelineRequest request)
AWSimagebuilder
Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images. You
must specify exactly one recipe for your image, using either a containerRecipeArn
or an
imageRecipeArn
.
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 AWSimagebuilder
public UpdateInfrastructureConfigurationResult updateInfrastructureConfiguration(UpdateInfrastructureConfigurationRequest request)
AWSimagebuilder
Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
updateInfrastructureConfiguration
in interface AWSimagebuilder
public UpdateLifecyclePolicyResult updateLifecyclePolicy(UpdateLifecyclePolicyRequest request)
AWSimagebuilder
Update the specified lifecycle policy.
updateLifecyclePolicy
in interface AWSimagebuilder
public void shutdown()
AWSimagebuilder
shutdown
in interface AWSimagebuilder
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSimagebuilder
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.
getCachedResponseMetadata
in interface AWSimagebuilder
request
- The originally executed request.