AWS.Imagebuilder — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelImageCreation(params = {}, callback) ⇒ AWS.Request

CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.

cancelLifecycleExecution(params = {}, callback) ⇒ AWS.Request

Cancel a specific image lifecycle policy runtime instance.

createComponent(params = {}, callback) ⇒ AWS.Request

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.

createContainerRecipe(params = {}, callback) ⇒ AWS.Request

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

createDistributionConfiguration(params = {}, callback) ⇒ AWS.Request

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

createImage(params = {}, callback) ⇒ AWS.Request

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.

createImagePipeline(params = {}, callback) ⇒ AWS.Request

Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.

createImageRecipe(params = {}, callback) ⇒ AWS.Request

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

createInfrastructureConfiguration(params = {}, callback) ⇒ AWS.Request

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

createLifecyclePolicy(params = {}, callback) ⇒ AWS.Request

Create a lifecycle policy resource.

createWorkflow(params = {}, callback) ⇒ AWS.Request

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

deleteComponent(params = {}, callback) ⇒ AWS.Request

Deletes a component build version.

deleteContainerRecipe(params = {}, callback) ⇒ AWS.Request

Deletes a container recipe.

deleteDistributionConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes a distribution configuration.

deleteImage(params = {}, callback) ⇒ AWS.Request

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.

deleteImagePipeline(params = {}, callback) ⇒ AWS.Request

Deletes an image pipeline.

deleteImageRecipe(params = {}, callback) ⇒ AWS.Request

deleteInfrastructureConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes an infrastructure configuration.

deleteLifecyclePolicy(params = {}, callback) ⇒ AWS.Request

Delete the specified lifecycle policy resource.

deleteWorkflow(params = {}, callback) ⇒ AWS.Request

Deletes a specific workflow resource.

getComponentPolicy(params = {}, callback) ⇒ AWS.Request

getContainerRecipe(params = {}, callback) ⇒ AWS.Request

Retrieves a container recipe.

getContainerRecipePolicy(params = {}, callback) ⇒ AWS.Request

Retrieves the policy for a container recipe.

getDistributionConfiguration(params = {}, callback) ⇒ AWS.Request

Gets a distribution configuration.

getImagePipeline(params = {}, callback) ⇒ AWS.Request

getImagePolicy(params = {}, callback) ⇒ AWS.Request

getImageRecipe(params = {}, callback) ⇒ AWS.Request

getImageRecipePolicy(params = {}, callback) ⇒ AWS.Request

Gets an image recipe policy.

getInfrastructureConfiguration(params = {}, callback) ⇒ AWS.Request

Gets an infrastructure configuration.

getLifecycleExecution(params = {}, callback) ⇒ AWS.Request

Get the runtime information that was logged for a specific runtime instance of the lifecycle policy.

getLifecyclePolicy(params = {}, callback) ⇒ AWS.Request

Get details for the specified image lifecycle policy.

getWorkflow(params = {}, callback) ⇒ AWS.Request

Get a workflow resource object.

getWorkflowExecution(params = {}, callback) ⇒ AWS.Request

Get the runtime information that was logged for a specific runtime instance of the workflow.

getWorkflowStepExecution(params = {}, callback) ⇒ AWS.Request

Get the runtime information that was logged for a specific runtime instance of the workflow step.

importComponent(params = {}, callback) ⇒ AWS.Request

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

importVmImage(params = {}, callback) ⇒ AWS.Request

When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data. 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.

listComponentBuildVersions(params = {}, callback) ⇒ AWS.Request

Returns the list of component build versions for the specified semantic version.

Note: The semantic version has four nodes: ../. 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(params = {}, callback) ⇒ AWS.Request

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.

Note: The semantic version has four nodes: ../. 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.

listContainerRecipes(params = {}, callback) ⇒ AWS.Request

Returns a list of container recipes.

listDistributionConfigurations(params = {}, callback) ⇒ AWS.Request

Returns a list of distribution configurations.

listImageBuildVersions(params = {}, callback) ⇒ AWS.Request

Returns a list of image build versions.

listImagePackages(params = {}, callback) ⇒ AWS.Request

List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.

listImagePipelineImages(params = {}, callback) ⇒ AWS.Request

Returns a list of images created by the specified pipeline.

listImagePipelines(params = {}, callback) ⇒ AWS.Request

Returns a list of image pipelines.

listImageRecipes(params = {}, callback) ⇒ AWS.Request

Returns a list of image recipes.

listImages(params = {}, callback) ⇒ AWS.Request

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.

listImageScanFindingAggregations(params = {}, callback) ⇒ AWS.Request

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

listImageScanFindings(params = {}, callback) ⇒ AWS.Request

Returns a list of image scan findings for your account.

listInfrastructureConfigurations(params = {}, callback) ⇒ AWS.Request

Returns a list of infrastructure configurations.

listLifecycleExecutionResources(params = {}, callback) ⇒ AWS.Request

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

listLifecycleExecutions(params = {}, callback) ⇒ AWS.Request

Get the lifecycle runtime history for the specified resource.

listLifecyclePolicies(params = {}, callback) ⇒ AWS.Request

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Returns the list of tags for the specified resource.

listWaitingWorkflowSteps(params = {}, callback) ⇒ AWS.Request

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

listWorkflowBuildVersions(params = {}, callback) ⇒ AWS.Request

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

listWorkflowExecutions(params = {}, callback) ⇒ AWS.Request

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

listWorkflows(params = {}, callback) ⇒ AWS.Request

Lists workflow build versions based on filtering parameters.

listWorkflowStepExecutions(params = {}, callback) ⇒ AWS.Request

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

putComponentPolicy(params = {}, callback) ⇒ AWS.Request

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.

putContainerRecipePolicy(params = {}, callback) ⇒ AWS.Request

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.

putImagePolicy(params = {}, callback) ⇒ AWS.Request

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.

putImageRecipePolicy(params = {}, callback) ⇒ AWS.Request

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.

sendWorkflowStepAction(params = {}, callback) ⇒ AWS.Request

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

startImagePipelineExecution(params = {}, callback) ⇒ AWS.Request

Manually triggers a pipeline to create an image.

startResourceStateUpdate(params = {}, callback) ⇒ AWS.Request

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

tagResource(params = {}, callback) ⇒ AWS.Request

Adds a tag to a resource.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes a tag from a resource.

updateDistributionConfiguration(params = {}, callback) ⇒ AWS.Request

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

updateImagePipeline(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

updateInfrastructureConfiguration(params = {}, callback) ⇒ AWS.Request

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

updateLifecyclePolicy(params = {}, callback) ⇒ AWS.Request

Update the specified lifecycle policy.