AWS SDK for C++AWS SDK for C++ Version 1.11.901 |
#include <ImagebuilderClient.h>
EC2 Image Builder automates the creation, management, and deployment of customized, secure, and up-to-date server images. You can build Amazon Machine Images (AMIs) and container images that are pre-installed and pre-configured with software and settings to meet specific IT standards.
For an introduction to the service concepts that these API operations work with, see How Image Builder works in the EC2 Image Builder User Guide.
Definition at line 27 of file ImagebuilderClient.h.
Definition at line 32 of file ImagebuilderClient.h.
Definition at line 36 of file ImagebuilderClient.h.
Definition at line 37 of file ImagebuilderClient.h.
Aws::imagebuilder::ImagebuilderClientConfiguration(),
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr,
Aws::imagebuilder::ImagebuilderClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr,
Aws::imagebuilder::ImagebuilderClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Cancels the creation of an image. This operation can only be used on images in a non-terminal state. Cancellation is asynchronous: the request returns immediately, then Image Builder stops the running build and moves the image to the CANCELLED state. Output resources that the build already created, such as AMIs and snapshots, aren't removed.
nullptr
An Async wrapper for CancelImageCreation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 113 of file ImagebuilderClient.h.
A Callable wrapper for CancelImageCreation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 104 of file ImagebuilderClient.h.
Cancels a lifecycle execution – a single run of lifecycle actions that a lifecycle policy or a StartResourceStateUpdate request started. You can only cancel an execution that hasn't reached a terminal state. Cancellation is asynchronous and doesn't undo completed lifecycle actions.
nullptr
An Async wrapper for CancelLifecycleExecution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 143 of file ImagebuilderClient.h.
A Callable wrapper for CancelLifecycleExecution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 134 of file ImagebuilderClient.h.
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.
Image Builder determines the component type from the document. If the document contains a single phase named test, the component type is TEST. Otherwise, the component type is BUILD.
nullptr
An Async wrapper for CreateComponent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 177 of file ImagebuilderClient.h.
A Callable wrapper for CreateComponent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 168 of file ImagebuilderClient.h.
Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.
nullptr
An Async wrapper for CreateContainerRecipe that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 204 of file ImagebuilderClient.h.
A Callable wrapper for CreateContainerRecipe that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 195 of file ImagebuilderClient.h.
Creates a new distribution configuration. Distribution configurations define and configure the outputs for your images, including the target Regions, accounts, and settings for each Region.
nullptr
An Async wrapper for CreateDistributionConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 234 of file ImagebuilderClient.h.
A Callable wrapper for CreateDistributionConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 224 of file ImagebuilderClient.h.
Creates a new image along with all configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a containerRecipeArn or an imageRecipeArn.
The response returns as soon as Image Builder creates the new image resource. The image build process runs asynchronously. To check its progress, call GetImage and check the image status.
nullptr
An Async wrapper for CreateImage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 267 of file ImagebuilderClient.h.
A Callable wrapper for CreateImage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 258 of file ImagebuilderClient.h.
Creates a new image pipeline. Use image pipelines to automate the creation and distribution of images. You must specify exactly one recipe for the pipeline, using either a containerRecipeArn or an imageRecipeArn.
nullptr
An Async wrapper for CreateImagePipeline that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 296 of file ImagebuilderClient.h.
A Callable wrapper for CreateImagePipeline that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 287 of file ImagebuilderClient.h.
Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.
nullptr
An Async wrapper for CreateImageRecipe that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 323 of file ImagebuilderClient.h.
A Callable wrapper for CreateImageRecipe that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 314 of file ImagebuilderClient.h.
Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
nullptr
An Async wrapper for CreateInfrastructureConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 353 of file ImagebuilderClient.h.
A Callable wrapper for CreateInfrastructureConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 343 of file ImagebuilderClient.h.
nullptr
An Async wrapper for CreateLifecyclePolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 380 of file ImagebuilderClient.h.
A Callable wrapper for CreateLifecyclePolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 371 of file ImagebuilderClient.h.
Creates a new workflow or a new version of an existing workflow. If a workflow with the same name and semantic version already exists, and your request changes its configuration, Image Builder creates a new build version. If the configuration is identical to the latest build version, the request fails because that workflow configuration already exists.
nullptr
An Async wrapper for CreateWorkflow that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 410 of file ImagebuilderClient.h.
A Callable wrapper for CreateWorkflow that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 401 of file ImagebuilderClient.h.
Deletes a component build version. The request fails with ResourceDependencyException if an image recipe or container recipe references this component version. It also fails if the component build version is shared with other accounts.
nullptr
An Async wrapper for DeleteComponent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 438 of file ImagebuilderClient.h.
A Callable wrapper for DeleteComponent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 429 of file ImagebuilderClient.h.
Deletes a container recipe. The request fails with ResourceDependencyException if the recipe is shared with other accounts, or if an image pipeline references it.
nullptr
An Async wrapper for DeleteContainerRecipe that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 466 of file ImagebuilderClient.h.
A Callable wrapper for DeleteContainerRecipe that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 457 of file ImagebuilderClient.h.
Deletes a distribution configuration. You can't delete a configuration that an image pipeline still references. The request fails with ResourceDependencyException. Update or delete the referencing pipelines first.
nullptr
An Async wrapper for DeleteDistributionConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 497 of file ImagebuilderClient.h.
A Callable wrapper for DeleteDistributionConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 487 of file ImagebuilderClient.h.
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.
The request fails with ResourceDependencyException if the image is shared with other accounts, or if other resources depend on it. It also fails while the image build is still running. Cancel an in-progress build with CancelImageCreation before you delete the image.
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.
nullptr
An Async wrapper for DeleteImage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 540 of file ImagebuilderClient.h.
A Callable wrapper for DeleteImage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 531 of file ImagebuilderClient.h.
Deletes an image pipeline. Images that the pipeline created aren't deleted - remove those separately with DeleteImage. You can delete a pipeline while a build that it started is still running. The build continues independently.
nullptr
An Async wrapper for DeleteImagePipeline that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 569 of file ImagebuilderClient.h.
A Callable wrapper for DeleteImagePipeline that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 560 of file ImagebuilderClient.h.
nullptr
An Async wrapper for DeleteImageRecipe that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 595 of file ImagebuilderClient.h.
A Callable wrapper for DeleteImageRecipe that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 586 of file ImagebuilderClient.h.
Deletes an infrastructure configuration. You can't delete a configuration that an image pipeline still references. The request fails with ResourceDependencyException. Update or delete the referencing pipelines first.
nullptr
An Async wrapper for DeleteInfrastructureConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 626 of file ImagebuilderClient.h.
A Callable wrapper for DeleteInfrastructureConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 616 of file ImagebuilderClient.h.
Deletes the specified lifecycle policy resource. Deleting the policy removes its schedule, so no further lifecycle runs occur for that policy. If a lifecycle execution is in progress for the policy, Image Builder cancels it. Deletion doesn't revert actions that the policy already applied to your resources.
nullptr
An Async wrapper for DeleteLifecyclePolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 657 of file ImagebuilderClient.h.
A Callable wrapper for DeleteLifecyclePolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 648 of file ImagebuilderClient.h.
Deletes a specific workflow resource. You can't delete a workflow build version while an image pipeline references it. The request fails with ResourceDependencyException.
nullptr
An Async wrapper for DeleteWorkflow that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 684 of file ImagebuilderClient.h.
A Callable wrapper for DeleteWorkflow that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 675 of file ImagebuilderClient.h.
Distributes an existing AMI to target Regions and accounts without running the full image build process. This operation only runs the distribution phase on an image that has already been built.
nullptr
An Async wrapper for DistributeImage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 711 of file ImagebuilderClient.h.
A Callable wrapper for DistributeImage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 702 of file ImagebuilderClient.h.
nullptr
An Async wrapper for GetComponent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 736 of file ImagebuilderClient.h.
A Callable wrapper for GetComponent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 727 of file ImagebuilderClient.h.
nullptr
An Async wrapper for GetComponentPolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 762 of file ImagebuilderClient.h.
A Callable wrapper for GetComponentPolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 753 of file ImagebuilderClient.h.
nullptr
An Async wrapper for GetContainerRecipe that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 788 of file ImagebuilderClient.h.
A Callable wrapper for GetContainerRecipe that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 779 of file ImagebuilderClient.h.
nullptr
An Async wrapper for GetContainerRecipePolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 814 of file ImagebuilderClient.h.
A Callable wrapper for GetContainerRecipePolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 805 of file ImagebuilderClient.h.
nullptr
An Async wrapper for GetDistributionConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 843 of file ImagebuilderClient.h.
A Callable wrapper for GetDistributionConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 833 of file ImagebuilderClient.h.
nullptr
An Async wrapper for GetImage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 869 of file ImagebuilderClient.h.
A Callable wrapper for GetImage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 860 of file ImagebuilderClient.h.
nullptr
An Async wrapper for GetImagePipeline that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 895 of file ImagebuilderClient.h.
A Callable wrapper for GetImagePipeline that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 886 of file ImagebuilderClient.h.
nullptr
An Async wrapper for GetImagePolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 920 of file ImagebuilderClient.h.
A Callable wrapper for GetImagePolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 911 of file ImagebuilderClient.h.
nullptr
An Async wrapper for GetImageRecipe that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 945 of file ImagebuilderClient.h.
A Callable wrapper for GetImageRecipe that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 936 of file ImagebuilderClient.h.
nullptr
An Async wrapper for GetImageRecipePolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 971 of file ImagebuilderClient.h.
A Callable wrapper for GetImageRecipePolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 962 of file ImagebuilderClient.h.
nullptr
An Async wrapper for GetInfrastructureConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 999 of file ImagebuilderClient.h.
A Callable wrapper for GetInfrastructureConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 989 of file ImagebuilderClient.h.
Retrieves runtime information for a lifecycle execution – a single run of lifecycle actions that a lifecycle policy or a StartResourceStateUpdate request started.
nullptr
An Async wrapper for GetLifecycleExecution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1028 of file ImagebuilderClient.h.
A Callable wrapper for GetLifecycleExecution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1019 of file ImagebuilderClient.h.
nullptr
An Async wrapper for GetLifecyclePolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1055 of file ImagebuilderClient.h.
A Callable wrapper for GetLifecyclePolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1046 of file ImagebuilderClient.h.
Verifies the subscription and performs resource dependency checks on the requested Amazon Web Services Marketplace resource. The caller must be entitled to the resource. For Amazon Web Services Marketplace components, the response contains fields to download the components and their artifacts.
nullptr
An Async wrapper for GetMarketplaceResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1085 of file ImagebuilderClient.h.
A Callable wrapper for GetMarketplaceResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1076 of file ImagebuilderClient.h.
nullptr
An Async wrapper for GetWorkflow that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1111 of file ImagebuilderClient.h.
A Callable wrapper for GetWorkflow that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1102 of file ImagebuilderClient.h.
Retrieves runtime information for a specific runtime instance of the workflow.
nullptr
An Async wrapper for GetWorkflowExecution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1138 of file ImagebuilderClient.h.
A Callable wrapper for GetWorkflowExecution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1129 of file ImagebuilderClient.h.
Retrieves runtime information for a specific runtime instance of the workflow step.
nullptr
An Async wrapper for GetWorkflowStepExecution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1165 of file ImagebuilderClient.h.
A Callable wrapper for GetWorkflowStepExecution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1156 of file ImagebuilderClient.h.
Imports a component and transforms its data into a component document. For the SHELL format, Image Builder wraps your script in a component document with a single step that runs the script.
nullptr
An Async wrapper for ImportComponent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1193 of file ImagebuilderClient.h.
A Callable wrapper for ImportComponent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1184 of file ImagebuilderClient.h.
Imports a Windows operating system image from a verified Microsoft ISO disk file. The following disk images are supported:
Windows 11 Enterprise
The response returns as soon as Image Builder creates the new image resource in the PENDING state. The conversion from ISO file to AMI then runs asynchronously on an EC2 instance that Image Builder launches with the specified infrastructure configuration.
nullptr
An Async wrapper for ImportDiskImage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1224 of file ImagebuilderClient.h.
A Callable wrapper for ImportDiskImage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1215 of file ImagebuilderClient.h.
Creates an Image Builder image resource from an Amazon EC2 VM import task. The response returns as soon as Image Builder creates the image resource in the PENDING state. Image Builder then monitors the import task asynchronously. When the task completes, Image Builder records the AMI that it produced as the new image's output resource and marks the image AVAILABLE. You can then use the imported image as the base image for your recipes.
To create the VM import task, use the Amazon EC2 API ImportImage operation, or the import-image CLI command.
nullptr
An Async wrapper for ImportVmImage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1259 of file ImagebuilderClient.h.
A Callable wrapper for ImportVmImage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1250 of file ImagebuilderClient.h.
{})
const
Returns a list of component build versions for the specified component version ARN. You can only list build versions for components that your account owns. Deprecated build versions aren't included in the results.
nullptr,
{}
An Async wrapper for ListComponentBuildVersions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1290 of file ImagebuilderClient.h.
{})
const
A Callable wrapper for ListComponentBuildVersions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1280 of file ImagebuilderClient.h.
{})
const
Returns the list of components that you have access to. By default, the response doesn't include components in the DEPRECATED state. To list deprecated components, use the status filter with the value DEPRECATED.
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: You can 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.
nullptr,
{}
An Async wrapper for ListComponents that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1325 of file ImagebuilderClient.h.
{})
const
A Callable wrapper for ListComponents that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1316 of file ImagebuilderClient.h.
{})
const
nullptr,
{}
An Async wrapper for ListContainerRecipes that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1352 of file ImagebuilderClient.h.
{})
const
A Callable wrapper for ListContainerRecipes that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1343 of file ImagebuilderClient.h.
{})
const
nullptr,
{}
An Async wrapper for ListDistributionConfigurations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1381 of file ImagebuilderClient.h.
{})
const
A Callable wrapper for ListDistributionConfigurations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1371 of file ImagebuilderClient.h.
{})
const
nullptr,
{}
An Async wrapper for ListImageBuildVersions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1408 of file ImagebuilderClient.h.
{})
const
A Callable wrapper for ListImageBuildVersions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1399 of file ImagebuilderClient.h.
Lists the packages that are associated with an image build version, as determined by Amazon Web Services Systems Manager Inventory at build time.
nullptr
An Async wrapper for ListImagePackages that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1437 of file ImagebuilderClient.h.
A Callable wrapper for ListImagePackages that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1428 of file ImagebuilderClient.h.
nullptr
An Async wrapper for ListImagePipelineImages that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1464 of file ImagebuilderClient.h.
A Callable wrapper for ListImagePipelineImages that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1455 of file ImagebuilderClient.h.
{})
const
nullptr,
{}
An Async wrapper for ListImagePipelines that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1491 of file ImagebuilderClient.h.
{})
const
A Callable wrapper for ListImagePipelines that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1482 of file ImagebuilderClient.h.
{})
const
nullptr,
{}
An Async wrapper for ListImageRecipes that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1518 of file ImagebuilderClient.h.
{})
const
A Callable wrapper for ListImageRecipes that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1509 of file ImagebuilderClient.h.
{})
const
nullptr,
{}
An Async wrapper for ListImages that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1611 of file ImagebuilderClient.h.
{})
const
A Callable wrapper for ListImages that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1602 of file ImagebuilderClient.h.
{})
const
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:
imageBuildVersionArn
imagePipelineArn
vulnerabilityId
nullptr,
{}
An Async wrapper for ListImageScanFindingAggregations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1555 of file ImagebuilderClient.h.
{})
const
A Callable wrapper for ListImageScanFindingAggregations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1545 of file ImagebuilderClient.h.
{})
const
Returns a list of image scan findings for your account. Amazon Inspector generates the findings when it scans images that have scanning enabled.
nullptr,
{}
An Async wrapper for ListImageScanFindings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1584 of file ImagebuilderClient.h.
{})
const
A Callable wrapper for ListImageScanFindings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1575 of file ImagebuilderClient.h.
{})
const
nullptr,
{}
An Async wrapper for ListInfrastructureConfigurations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1641 of file ImagebuilderClient.h.
{})
const
A Callable wrapper for ListInfrastructureConfigurations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1631 of file ImagebuilderClient.h.
Lists resources that the runtime instance of the image lifecycle identified for lifecycle actions.
nullptr
An Async wrapper for ListLifecycleExecutionResources that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1671 of file ImagebuilderClient.h.
A Callable wrapper for ListLifecycleExecutionResources that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1661 of file ImagebuilderClient.h.
nullptr
An Async wrapper for ListLifecycleExecutions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1699 of file ImagebuilderClient.h.
A Callable wrapper for ListLifecycleExecutions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1690 of file ImagebuilderClient.h.
{})
const
Retrieves a list of lifecycle policies in your Amazon Web Services account.
nullptr,
{}
An Async wrapper for ListLifecyclePolicies that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1727 of file ImagebuilderClient.h.
{})
const
A Callable wrapper for ListLifecyclePolicies that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1718 of file ImagebuilderClient.h.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1755 of file ImagebuilderClient.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1746 of file ImagebuilderClient.h.
{})
const
Lists the workflow steps in your Amazon Web Services account that have paused at a WaitForAction step, and are waiting for you to respond. To send a response, call SendWorkflowStepAction.
nullptr,
{}
An Async wrapper for ListWaitingWorkflowSteps that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1785 of file ImagebuilderClient.h.
{})
const
A Callable wrapper for ListWaitingWorkflowSteps that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1775 of file ImagebuilderClient.h.
{})
const
nullptr,
{}
An Async wrapper for ListWorkflowBuildVersions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1815 of file ImagebuilderClient.h.
{})
const
A Callable wrapper for ListWorkflowBuildVersions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1805 of file ImagebuilderClient.h.
Returns a list of workflow runtime instance metadata objects for a specific image build version.
nullptr
An Async wrapper for ListWorkflowExecutions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1843 of file ImagebuilderClient.h.
A Callable wrapper for ListWorkflowExecutions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1834 of file ImagebuilderClient.h.
{})
const
Lists workflow versions based on filtering parameters. To list the build versions of a specific workflow version, call ListWorkflowBuildVersions.
nullptr,
{}
An Async wrapper for ListWorkflows that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1901 of file ImagebuilderClient.h.
{})
const
A Callable wrapper for ListWorkflows that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1892 of file ImagebuilderClient.h.
Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.
nullptr
An Async wrapper for ListWorkflowStepExecutions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1873 of file ImagebuilderClient.h.
A Callable wrapper for ListWorkflowStepExecutions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1863 of file ImagebuilderClient.h.
Applies a policy to a component. The preferred way to share resources is with the RAM API CreateResourceShare. If you use the PutComponentPolicy operation instead, you must also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource isn't visible to the principals that it's shared with.
nullptr
An Async wrapper for PutComponentPolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1935 of file ImagebuilderClient.h.
A Callable wrapper for PutComponentPolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1926 of file ImagebuilderClient.h.
Applies a policy to a container recipe. The preferred way to share resources is with the RAM API CreateResourceShare. If you use the PutContainerRecipePolicy operation instead, you must also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource isn't visible to the principals that it's shared with.
nullptr
An Async wrapper for PutContainerRecipePolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1968 of file ImagebuilderClient.h.
A Callable wrapper for PutContainerRecipePolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1959 of file ImagebuilderClient.h.
Applies a policy to an image. The preferred way to share resources is with the RAM API CreateResourceShare. If you use the PutImagePolicy operation instead, you must also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource isn't visible to the principals that it's shared with.
nullptr
An Async wrapper for PutImagePolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2001 of file ImagebuilderClient.h.
A Callable wrapper for PutImagePolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1992 of file ImagebuilderClient.h.
Applies a policy to an image recipe. The preferred way to share resources is with the RAM API CreateResourceShare. If you use the PutImageRecipePolicy operation instead, you must also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource isn't visible to the principals that it's shared with.
nullptr
An Async wrapper for PutImageRecipePolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2034 of file ImagebuilderClient.h.
A Callable wrapper for PutImageRecipePolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2025 of file ImagebuilderClient.h.
Retries a failed or canceled image build without rebuilding the phases that already completed. The image re-runs asynchronously in place: the same build version returns to the test or distribution phase where it failed and continues from there. No new image build version is created. Retry is only supported for AMI-based images.
nullptr
An Async wrapper for RetryImage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2063 of file ImagebuilderClient.h.
A Callable wrapper for RetryImage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2054 of file ImagebuilderClient.h.
Sends an action to a workflow step that has paused at a WaitForAction step, so that image creation can continue. To find the steps that are waiting for an action, call ListWaitingWorkflowSteps.
nullptr
An Async wrapper for SendWorkflowStepAction that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2092 of file ImagebuilderClient.h.
A Callable wrapper for SendWorkflowStepAction that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2083 of file ImagebuilderClient.h.
Manually triggers a pipeline to create an image. You can start a build this way whether the pipeline is enabled or disabled. The response returns as soon as Image Builder creates the new image resource and queues the build. Use the returned imageBuildVersionArn with GetImage to track build progress.
nullptr
An Async wrapper for StartImagePipelineExecution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2125 of file ImagebuilderClient.h.
A Callable wrapper for StartImagePipelineExecution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2115 of file ImagebuilderClient.h.
Begins an ad-hoc state change for the specified image build version. This is a one-time operation - if you schedule the update, it runs only once. If the request includes underlying resources, or schedules the update far enough in the future, Image Builder runs the update as an asynchronous lifecycle execution and returns its identifier. Otherwise, for target states other than DELETED, the state change applies immediately. If a request that starts a lifecycle execution arrives while the image already has one in progress, Image Builder rejects it.
nullptr
An Async wrapper for StartResourceStateUpdate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2159 of file ImagebuilderClient.h.
A Callable wrapper for StartResourceStateUpdate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2150 of file ImagebuilderClient.h.
nullptr
An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2185 of file ImagebuilderClient.h.
A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2176 of file ImagebuilderClient.h.
nullptr
An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2210 of file ImagebuilderClient.h.
A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2201 of file ImagebuilderClient.h.
Updates a distribution configuration. Distribution configurations define and configure the outputs for your images, including the target Regions, accounts, and settings for each Region.
This operation doesn't support selective updates. The request replaces the stored configuration, so include every setting that you want to keep.
nullptr
An Async wrapper for UpdateDistributionConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2242 of file ImagebuilderClient.h.
A Callable wrapper for UpdateDistributionConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2232 of file ImagebuilderClient.h.
Updates an image pipeline. Use image pipelines to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a containerRecipeArn or an imageRecipeArn. The recipe must be the same type, image or container, as the pipeline's current recipe.
UpdateImagePipeline does not support selective updates. The request replaces the pipeline's entire configuration, so include every setting that you want to keep. Any optional property that you omit is removed or reset to its default.
nullptr
An Async wrapper for UpdateImagePipeline that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2277 of file ImagebuilderClient.h.
A Callable wrapper for UpdateImagePipeline that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2268 of file ImagebuilderClient.h.
Updates an infrastructure configuration. An infrastructure configuration defines the environment in which Image Builder builds and tests your image.
This operation doesn't support selective updates. The request replaces the configuration, so include every setting that you want to keep. Omitted optional properties are cleared.
nullptr
An Async wrapper for UpdateInfrastructureConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2309 of file ImagebuilderClient.h.
A Callable wrapper for UpdateInfrastructureConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2299 of file ImagebuilderClient.h.
Updates the specified lifecycle policy. The request replaces the existing policy configuration rather than merging changes, so re-specify every setting that you want to keep. The resourceType must match the existing policy's value.
nullptr
An Async wrapper for UpdateLifecyclePolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2339 of file ImagebuilderClient.h.
A Callable wrapper for UpdateLifecyclePolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2330 of file ImagebuilderClient.h.