Package-level declarations
Types
You do not have permissions to perform the requested operation.
Contains counts of vulnerability findings from image scans that run when you create new Image Builder images, or build new versions of existing images. The vulnerability counts are grouped by severity level. The counts are aggregated across resources to create the final tally for the account that owns them.
In addition to your infrastructure configuration, these settings provide an extra layer of control over your build instances. You can also specify commands to run on launch for all of your build instances.
Define and configure the output AMIs of the pipeline.
Defines the rules by which an image pipeline is automatically disabled when it fails. By default, if the schedule doesn't include an auto-disable policy, Image Builder disables the pipeline after 5 consecutive failed scheduled builds.
You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.
A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.
Configuration details of the component. You can specify each component only once in a recipe, regardless of version. Components with a status of DEPRECATED or DISABLED can't be added to new recipes.
Contains details about the component that caused the image creation process to fail. The details identify the first step that failed when the component ran.
Contains a key/value pair that sets the named component parameter.
Defines a parameter that is used to provide configuration details for the component.
A group of fields that describe the current status of components.
A high-level summary of a component.
The defining characteristics of a specific version of a component.
Defines how the output container image is distributed in a specific Amazon Web Services Region: the target repository, the image tags to apply to the distributed image, and an optional description.
Defines how Image Builder builds and tests a container image: the base image, components to apply, the Dockerfile template, the build and test instance configuration, and the target repository for the output image.
A summary of a container recipe.
A CVSS score for the vulnerability, as published by the vulnerability source. Sources include the National Vulnerability Database (NVD) and the operating system vendor's security feed. A finding can include CVSS scores from multiple sources and CVSS versions.
Details about an adjustment that Amazon Inspector made to the CVSS score for a finding.
Details about the source of the score, and the factors that determined the adjustments to create the final score.
Defines the settings for a specific Region.
Defines how Image Builder distributes the output of an image build. You can configure:
A high-level overview of a distribution configuration.
Contains details about a failure that occurred while Image Builder distributed the image or applied configuration to the distributed image.
The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
Amazon EBS-specific block device mapping specifications.
Settings that Image Builder uses to configure the ECR repository and the output container images that Amazon Inspector scans.
Defines and configures EC2 Fast Launch for output Windows AMIs.
Identifies the launch template that the associated Windows AMI uses for launching an instance when Windows fast launch is enabled.
Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
You are not authorized to perform the requested operation.
GetInfrastructureConfiguration request object.
GetInfrastructureConfiguration response object.
You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
An Image Builder image resource that keeps track of all of the settings used to create, configure, and distribute output for that image. An image that Image Builder built from a recipe contains exactly one recipe – either a container recipe (containerRecipe), which creates a container image, or an image recipe (imageRecipe), which creates an AMI. Imported images don't contain a recipe.
Contains vulnerability counts for a specific image.
Base class for all service related exceptions thrown by the Imagebuilder client
Contains details about the failure when the image creation process fails. Properties appear in the failure context when the related information is available for the failure.
The logging configuration that's defined for the image. Image Builder uses the defined settings to direct execution log output during image creation.
A software package that's installed on an image, as detected by Amazon Web Services Systems Manager Inventory at build time. The list includes packages that shipped with the base image.
Defines the automation configuration for building, testing, and distributing images. A pipeline references the resources that its builds use, such as the recipe and infrastructure configuration. It also holds the settings that control its builds, such as the schedule and custom workflows.
Contains vulnerability counts for a specific image pipeline.
An image recipe.
A summary of an image recipe.
Contains details about a vulnerability scan finding that Amazon Inspector generated for an image.
This returns exactly one type of aggregation, based on the filter that Image Builder applies in its API action.
A name value pair that Image Builder applies to streamline results from the vulnerability scan findings list action.
Contains settings for Image Builder image resource and container image scans.
Shows the vulnerability scan status for a specific image, and the reason for that status.
Image status and the reason for that status.
An image summary.
Configure image tests for your pipeline build. Tests run after building the image, to verify that the AMI or container image is valid before distributing it.
The defining characteristics of a specific version of an Image Builder image.
Details of the infrastructure configuration.
Contains a high-level summary of an infrastructure configuration, including the environment settings that Image Builder uses to build and test images.
Information about the factors that influenced the score that Amazon Inspector assigned for a finding.
Defines block device mappings for the instance used to configure your image.
Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.
The instance metadata service (IMDS) settings that Image Builder applies to the EC2 build and test instances it launches. These settings control how software on those instances retrieves instance metadata and IAM role credentials.
You have provided an invalid pagination token in your request.
You have specified a combination of parameters that isn't valid. For example, two mutually exclusive parameters, or a parameter without its required companion parameter. Review the error message for details.
The specified parameter is invalid. Review the available parameters for the API request.
The value that you provided for the specified parameter is invalid.
The request is malformed or otherwise invalid. Verify the request and try again.
Your version number is out of bounds or does not follow the required syntax.
A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.
Describes the configuration for a launch permission. The launch permission modification request is sent to the Amazon EC2 ModifyImageAttribute API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set userGroups to the value all. See the examples for making an AMI public at Amazon EC2 ModifyImageAttribute.
Identifies an Amazon EC2 launch template to use for a specific account.
Contains metadata from a runtime instance of a lifecycle policy.
Contains details for a resource that the runtime instance of the lifecycle policy identified for action.
The lifecycle policy action that was identified for the impacted resource.
Contains an indicator that shows whether the lifecycle execution identified any resources to take lifecycle actions on.
Contains the state of an impacted resource that the runtime instance of the lifecycle policy identified for action.
Contains the state of an impacted snapshot resource that the runtime instance of the lifecycle policy identified for action.
The current state of the runtime instance of the lifecycle policy.
Defines a lifecycle policy resource: its identity, status, execution role, resource type, rules, resource selection, timestamps, and tags.
Defines one lifecycle policy rule: the action to take, the filter that determines which resources the rule applies to, and optional exclusion rules.
Contains the action configuration for a lifecycle policy rule: the action to take, and which underlying resources the action extends to.
Specifies how the lifecycle policy should apply actions to selected resources.
Specifies resources that lifecycle policy actions should not apply to.
Defines criteria for AMIs that are excluded from lifecycle actions.
Defines criteria to exclude AMIs from lifecycle actions based on the last time they were used to launch an instance.
Defines filters that the lifecycle policy uses to determine impacted resource.
Resource selection criteria for the lifecycle policy. You must provide exactly one selection criteria: either recipes or a tag map, not both.
Specifies an Image Builder recipe that the lifecycle policy uses for resource selection.
Contains a summary of lifecycle policy resources.
The resources produced by this image.
Information about package vulnerability findings.
The logging configuration that's defined for pipeline execution.
By default, EC2 instances run on shared tenancy hardware. This means that multiple Amazon Web Services accounts might share the same physical hardware. When you use dedicated hardware, the physical server that hosts your instances is dedicated to your Amazon Web Services account. Instance placement settings contain the details for the physical hardware where instances that Image Builder launches during image creation will run.
Information about a single product code.
Contains details about a distribution or image configuration failure for a single Region.
Controls Secure Boot and UEFI data settings for the resulting image during ISO imports. For more information, see UEFI Secure Boot for Amazon EC2 instances in the Amazon EC2 User Guide.
Information about how to remediate a finding.
Details about the recommended course of action to remediate the finding.
The resource that you are trying to create already exists.
You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
The resource that you are trying to operate on is currently in use. Review the message details and retry later.
At least one of the resources referenced by your request does not exist.
The state to apply to the image resource in a resource state update request.
Additional rules to specify resources that should be exempt from ad-hoc lifecycle actions.
Specifies which underlying resources the resource state update applies to, in addition to the Image Builder image resource itself: distributed AMIs and their snapshots for AMI images, or distributed container images for container images.
Properties that configure exporting the output image to a disk image file in an Amazon S3 bucket, in a format that's compatible with your VMs.
An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
The service is unable to process your request at this time.
Includes counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified filter.
Configuration for a single Parameter in the Amazon Web Services Systems Manager (SSM) Parameter Store in a given Region.
Contains settings for the Systems Manager agent on your build instance. This setting applies to Linux and macOS build instances only. Requests that set it for a recipe with a Windows base image are rejected.
The container repository where the output container image is stored.
You have attempted too many requests for the specific operation.
Includes counts of image and pipeline resource findings by vulnerability.
Information about a vulnerable package that Amazon Inspector identifies in a finding.
Windows-specific configuration settings for an ISO import, including the edition to install from a multi-edition Windows ISO file.
Contains control settings and configurable inputs for a workflow resource.
Metadata that includes details and status from this runtime instance of the workflow.
Contains a key/value pair that sets the named workflow parameter.
Defines a parameter that's used to provide configuration details for the workflow.
A group of fields that describe the current status of the workflow.
Contains runtime details for a workflow step that has paused at a WaitForAction step, and is waiting for you to send an action.
Runtime details and status for the workflow step.
Contains metadata about the workflow resource.
Contains details about this version of the workflow.