Package-level declarations

Types

Link copied to clipboard

EC2 Image Builder automates the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard

Cancels the creation of an image. This operation can only be used on images in a non-terminal state.

Link copied to clipboard

Cancels a specific image lifecycle policy runtime instance.

Link copied to clipboard

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:

Link copied to clipboard

Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Creates a new image pipeline. Use image pipelines to automate the creation and distribution of images.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Creates a lifecycle policy resource.

Link copied to clipboard

Creates a new workflow or a new version of an existing workflow.

Link copied to clipboard

Deletes a component build version.

Link copied to clipboard

Deletes a container recipe.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

Deletes an image pipeline.

Link copied to clipboard

Deletes an image recipe.

Link copied to clipboard
Link copied to clipboard

Deletes the specified lifecycle policy resource.

Link copied to clipboard

Deletes a specific workflow resource.

Link copied to clipboard

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.

Link copied to clipboard

Retrieves a component object.

Link copied to clipboard

Retrieves a component policy.

Link copied to clipboard

Retrieves a container recipe.

Link copied to clipboard

Retrieves the policy for a container recipe.

Link copied to clipboard

Retrieves a distribution configuration.

Link copied to clipboard
inline suspend fun ImagebuilderClient.getImage(crossinline block: GetImageRequest.Builder.() -> Unit): GetImageResponse

Retrieves an image.

Link copied to clipboard

Retrieves an image pipeline.

Link copied to clipboard

Retrieves an image policy.

Link copied to clipboard

Retrieves an image recipe.

Link copied to clipboard

Retrieves an image recipe policy.

Link copied to clipboard

Retrieves an infrastructure configuration.

Link copied to clipboard

Retrieves the runtime information for a specific runtime instance of the lifecycle policy.

Link copied to clipboard

Retrieves details for the specified image lifecycle policy.

Link copied to clipboard

Verifies the subscription and performs resource dependency checks on the requested Amazon Web Services Marketplace resource. For Amazon Web Services Marketplace components, the response contains fields to download the components and their artifacts.

Link copied to clipboard

Retrieves a workflow resource object.

Link copied to clipboard

Retrieves runtime information for a specific runtime instance of the workflow.

Link copied to clipboard

Retrieves runtime information for a specific runtime instance of the workflow step.

Link copied to clipboard

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

Link copied to clipboard

Imports a Windows operating system image from a verified Microsoft ISO disk file. The following disk images are supported:

Link copied to clipboard

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

Link copied to clipboard

Returns the list of component build versions for the specified component version Amazon Resource Name (ARN).

Link copied to clipboard

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.

Link copied to clipboard

Returns a list of container recipes.

Link copied to clipboard

Returns a list of distribution configurations.

Link copied to clipboard

Returns a list of image build versions.

Link copied to clipboard

Lists the packages that are associated with an image build version, as determined by Amazon Web Services Systems Manager Inventory at build time.

Link copied to clipboard

Returns a list of images created by the specified pipeline.

Link copied to clipboard

Returns a list of image pipelines.

Link copied to clipboard

Returns a list of image recipes.

Link copied to clipboard
inline suspend fun ImagebuilderClient.listImages(crossinline block: ListImagesRequest.Builder.() -> Unit): ListImagesResponse

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.

Link copied to clipboard

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.

Link copied to clipboard

Returns a list of image scan findings for your account.

Link copied to clipboard

Returns a list of infrastructure configurations.

Link copied to clipboard

Lists resources that the runtime instance of the image lifecycle identified for lifecycle actions.

Link copied to clipboard

Retrieves the lifecycle runtime history for the specified resource.

Link copied to clipboard

Retrieves a list of lifecycle policies in your Amazon Web Services account.

Link copied to clipboard

Returns the list of tags for the specified resource.

Link copied to clipboard

Retrieves a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account.

Link copied to clipboard

Returns a list of build versions for a specific workflow resource.

Link copied to clipboard

Returns a list of workflow runtime instance metadata objects for a specific image build version.

Link copied to clipboard

Lists workflow build versions based on filtering parameters.

Link copied to clipboard

Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.

Link copied to clipboard

Applies a policy to a component. To share resources, call the RAM API CreateResourceShare. If you call this API, you must also call the RAM API PromoteResourceShareCreatedFromPolicy so that the resource is visible to all principals with whom the resource is shared.

Link copied to clipboard

Applies a policy to a container image. To share resources, call the RAM API CreateResourceShare. If you call this API, you must also call the RAM API PromoteResourceShareCreatedFromPolicy so that the resource is visible to all principals with whom the resource is shared.

Link copied to clipboard

Applies a policy to an image. To share resources, call the RAM API CreateResourceShare. If you call this API, you must also call the RAM API PromoteResourceShareCreatedFromPolicy so that the resource is visible to all principals with whom the resource is shared.

Link copied to clipboard

Applies a policy to an image recipe. To share resources, call the RAM API CreateResourceShare. If you call this API, you must also call the RAM API PromoteResourceShareCreatedFromPolicy so that the resource is visible to all principals with whom the resource is shared.

Link copied to clipboard
inline suspend fun ImagebuilderClient.retryImage(crossinline block: RetryImageRequest.Builder.() -> Unit): RetryImageResponse

Retries an image distribution or test without rebuilding the image.

Link copied to clipboard

Pauses or resumes image creation when the associated workflow runs a WaitForAction step.

Link copied to clipboard

Manually triggers a pipeline to create an image.

Link copied to clipboard

Begins an asynchronous resource state update for lifecycle changes to the specified image resources.

Link copied to clipboard

Adds a tag to a resource.

Link copied to clipboard

Removes a tag from a resource.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Updates an infrastructure configuration. An infrastructure configuration defines the environment in which Image Builder builds and tests your image.

Link copied to clipboard

Updates the specified lifecycle policy.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.