Package-level declarations

Types

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
class Ami

Details of an Amazon EC2 AMI.

Link copied to clipboard

Define and configure the output AMIs of the pipeline.

Link copied to clipboard
sealed class BuildType
Link copied to clipboard

You have exceeded the permitted request rate for the specific operation.

Link copied to clipboard

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.

Link copied to clipboard
class Component

A detailed view of a component.

Link copied to clipboard

Configuration details of the component.

Link copied to clipboard
sealed class ComponentFormat
Link copied to clipboard

Contains a key/value pair that sets the named component parameter.

Link copied to clipboard

Defines a parameter that is used to provide configuration details for the component.

Link copied to clipboard

A group of fields that describe the current status of components.

Link copied to clipboard
sealed class ComponentStatus
Link copied to clipboard

A high-level summary of a component.

Link copied to clipboard
sealed class ComponentType
Link copied to clipboard

The defining characteristics of a specific version of an Amazon Web Services TOE component.

Link copied to clipboard
class Container

A container encapsulates the runtime environment for an application.

Link copied to clipboard

Container distribution settings for encryption, licensing, and sharing in a specific Region.

Link copied to clipboard

A container recipe.

Link copied to clipboard

A summary of a container recipe

Link copied to clipboard
Link copied to clipboard
sealed class ContainerType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class CvssScore

Amazon Inspector generates a risk score for each finding. This score helps you to prioritize findings, to focus on the most critical findings and the most vulnerable resources. The score uses the Common Vulnerability Scoring System (CVSS) format. This format is a modification of the base CVSS score that the National Vulnerability Database (NVD) provides. For more information about severity levels, see Severity levels for Amazon Inspector findings in the Amazon Inspector User Guide.

Link copied to clipboard

Details about an adjustment that Amazon Inspector made to the CVSS score for a finding.

Link copied to clipboard

Details about the source of the score, and the factors that determined the adjustments to create the final score.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class DiskImageFormat
Link copied to clipboard

Defines the settings for a specific Region.

Link copied to clipboard

A distribution configuration.

Link copied to clipboard

A high-level overview of a distribution configuration.

Link copied to clipboard

Amazon EBS-specific block device mapping specifications.

Link copied to clipboard
sealed class EbsVolumeType
Link copied to clipboard

Settings that Image Builder uses to configure the ECR repository and the output container images that Amazon Inspector scans.

Link copied to clipboard

Define and configure faster launching for output Windows AMIs.

Link copied to clipboard

Identifies the launch template that the associated Windows AMI uses for launching an instance when faster launching is enabled.

Link copied to clipboard

Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.

Link copied to clipboard
class Filter

A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

Link copied to clipboard

You are not authorized to perform the requested operation.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

GetInfrastructureConfiguration request object.

Link copied to clipboard

GetInfrastructureConfiguration response object.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.

Link copied to clipboard
class Image

An Image Builder image. You must specify exactly one recipe for the image – either a container recipe (containerRecipe), which creates a container image, or an image recipe (imageRecipe), which creates an AMI.

Link copied to clipboard

Contains vulnerability counts for a specific image.

Link copied to clipboard

Base class for all service related exceptions thrown by the Imagebuilder client

Link copied to clipboard

A software package that's installed on top of the base image to create a customized image.

Link copied to clipboard

Details of an image pipeline.

Link copied to clipboard

Contains vulnerability counts for a specific image pipeline.

Link copied to clipboard

An image recipe.

Link copied to clipboard

A summary of an image recipe.

Link copied to clipboard

Contains details about a vulnerability scan finding.

Link copied to clipboard

This returns exactly one type of aggregation, based on the filter that Image Builder applies in its API action.

Link copied to clipboard

A name value pair that Image Builder applies to streamline results from the vulnerability scan findings list action.

Link copied to clipboard

Contains settings for Image Builder image resource and container image scans.

Link copied to clipboard

Shows the vulnerability scan status for a specific image, and the reason for that status.

Link copied to clipboard
sealed class ImageScanStatus
Link copied to clipboard
sealed class ImageSource
Link copied to clipboard

Image status and the reason for that status.

Link copied to clipboard
sealed class ImageStatus
Link copied to clipboard

An image summary.

Link copied to clipboard

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.

Link copied to clipboard
sealed class ImageType
Link copied to clipboard

The defining characteristics of a specific version of an Image Builder image.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Details of the infrastructure configuration.

Link copied to clipboard

The infrastructure used when building Amazon EC2 AMIs.

Link copied to clipboard

Information about the factors that influenced the score that Amazon Inspector assigned for a finding.

Link copied to clipboard

Defines block device mappings for the instance used to configure your image.

Link copied to clipboard

Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.

Link copied to clipboard

The instance metadata options that apply to the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances, or Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows instances.

Link copied to clipboard

You have provided an invalid pagination token in your request.

Link copied to clipboard

You have specified two or more mutually exclusive parameters. Review the error message for details.

Link copied to clipboard

The specified parameter is invalid. Review the available parameters for the API request.

Link copied to clipboard

The value that you provided for the specified parameter is invalid.

Link copied to clipboard

You have requested an action that that the service doesn't support.

Link copied to clipboard

Your version number is out of bounds or does not follow the required syntax.

Link copied to clipboard

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 the launch permission authorized accounts to all. See the examples for making an AMI public at Amazon EC2 ModifyImageAttribute.

Link copied to clipboard

Identifies an Amazon EC2 launch template to use for a specific account.

Link copied to clipboard

Contains metadata from a runtime instance of a lifecycle policy.

Link copied to clipboard

Contains details for a resource that the runtime instance of the lifecycle policy identified for action.

Link copied to clipboard

The lifecycle policy action that was identified for the impacted resource.

Contains details for an image resource that was identified for a lifecycle action.

Link copied to clipboard

Contains the state of an impacted resource that the runtime instance of the lifecycle policy identified for action.

Link copied to clipboard

Contains the state of an impacted snapshot resource that the runtime instance of the lifecycle policy identified for action.

Link copied to clipboard

The current state of the runtime instance of the lifecycle policy.

Link copied to clipboard
Link copied to clipboard

The configuration details for a lifecycle policy resource.

Link copied to clipboard

The configuration details for a lifecycle policy resource.

Link copied to clipboard

Contains selection criteria for the lifecycle policy.

Specifies how the lifecycle policy should apply actions to selected resources.

Link copied to clipboard

Specifies resources that lifecycle policy actions should not apply to.

Link copied to clipboard

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.

Link copied to clipboard

Defines filters that the lifecycle policy uses to determine impacted resource.

Link copied to clipboard

Resource selection criteria for the lifecycle policy.

Link copied to clipboard

Specifies an Image Builder recipe that the lifecycle policy uses for resource selection.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Contains a summary of lifecycle policy resources.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Logging

Logging configuration defines where Image Builder uploads your logs.

Link copied to clipboard
Link copied to clipboard
sealed class OnWorkflowFailure
Link copied to clipboard

The resources produced by this image.

Link copied to clipboard
sealed class Ownership
Link copied to clipboard

Information about package vulnerability findings.

Link copied to clipboard
sealed class PipelineStatus
Link copied to clipboard
class Placement

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.

Link copied to clipboard
sealed class Platform
Link copied to clipboard

Information about a single product code.

Link copied to clipboard
sealed class ProductCodeType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Information about how to remediate a finding.

Link copied to clipboard

Details about the recommended course of action to remediate the finding.

Link copied to clipboard

The resource that you are trying to create already exists.

Link copied to clipboard

You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.

Link copied to clipboard

The resource that you are trying to operate on is currently in use. Review the message details and retry later.

Link copied to clipboard

At least one of the resources referenced by your request does not exist.

Link copied to clipboard

The current state of an impacted resource.

Link copied to clipboard

Additional rules to specify resources that should be exempt from ad-hoc lifecycle actions.

Link copied to clipboard

Specifies if the lifecycle policy should apply actions to selected resources.

Link copied to clipboard
sealed class ResourceStatus
Link copied to clipboard

Properties that configure export from your build instance to a compatible file format for your VM.

Link copied to clipboard
class S3Logs

Amazon S3 logging configuration.

Link copied to clipboard
class Schedule

A schedule configures when and how often a pipeline will automatically create a new image.

Link copied to clipboard

This exception is thrown when the service encounters an unrecoverable exception.

Link copied to clipboard

You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.

Link copied to clipboard

The service is unable to process your request at this time.

Link copied to clipboard

Includes counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified filter.

Link copied to clipboard

Configuration for a single Parameter in the Amazon Web Services Systems Manager (SSM) Parameter Store in a given Region.

Link copied to clipboard
Link copied to clipboard

Contains settings for the Systems Manager agent on your build instance.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The container repository where the output container image is stored.

Link copied to clipboard
sealed class TenancyType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Includes counts of image and pipeline resource findings by vulnerability.

Link copied to clipboard

Information about a vulnerable package that Amazon Inspector identifies in a finding.

Link copied to clipboard
class Workflow

Defines a process that Image Builder uses to build and test images during the image creation process.

Link copied to clipboard

Contains control settings and configurable inputs for a workflow resource.

Link copied to clipboard

Metadata that includes details and status from this runtime instance of the workflow.

Link copied to clipboard
Link copied to clipboard

Contains a key/value pair that sets the named workflow parameter.

Link copied to clipboard

Defines a parameter that's used to provide configuration details for the workflow.

Link copied to clipboard

A group of fields that describe the current status of workflow.

Link copied to clipboard
sealed class WorkflowStatus
Link copied to clipboard
Link copied to clipboard

Contains runtime details for an instance of a workflow that ran for the associated image build version.

Link copied to clipboard
Link copied to clipboard

Runtime details and status for the workflow step.

Link copied to clipboard

Contains metadata about the workflow resource.

Link copied to clipboard
sealed class WorkflowType
Link copied to clipboard

Contains details about this version of the workflow.