import type { BuildType, ComponentFormat, ComponentStatus, ComponentType, ContainerRepositoryService, ContainerType, DiskImageFormat, EbsVolumeType, ImageScanStatus, ImageSource, ImageStatus, ImageType, LifecycleExecutionResourceActionName, LifecycleExecutionResourceStatus, LifecycleExecutionStatus, LifecyclePolicyDetailActionType, LifecyclePolicyDetailFilterType, LifecyclePolicyResourceType, LifecyclePolicyStatus, LifecyclePolicyTimeUnit, MarketplaceResourceType, OnWorkflowFailure, Ownership, PipelineExecutionStartCondition, PipelineStatus, Platform, ProductCodeType, ResourceStatus, SsmParameterDataType, TenancyType, WorkflowExecutionStatus, WorkflowStatus, WorkflowStepActionType, WorkflowStepExecutionRollbackStatus, WorkflowStepExecutionStatus, WorkflowType } from "./enums"; /** *

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

* @public */ export interface SeverityCounts { /** *

The total number of findings across all severity levels for the specified filter.

* @public */ all?: number | undefined; /** *

The number of critical severity findings for the specified filter.

* @public */ critical?: number | undefined; /** *

The number of high severity findings for the specified filter.

* @public */ high?: number | undefined; /** *

The number of medium severity findings for the specified filter.

* @public */ medium?: number | undefined; } /** *

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.

* @public */ export interface AccountAggregation { /** *

Identifies the account that owns the aggregated resource findings.

* @public */ accountId?: string | undefined; /** *

Counts by severity level for medium severity and higher level findings, plus a total * for all of the findings.

* @public */ severityCounts?: SeverityCounts | undefined; } /** *

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

* @public */ export interface SystemsManagerAgent { /** *

Controls whether the Systems Manager agent is removed from your final build image, prior to * creating the new AMI. If this is set to true, then the agent is removed from the final * image. If it's set to false, then the agent is left in, so that it is included in the * new AMI. default value is false.

*

The default behavior of uninstallAfterBuild is to remove the SSM Agent if it was installed by EC2 Image Builder

* @public */ uninstallAfterBuild?: boolean | undefined; } /** *

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.

*

Image Builder does not automatically install the Systems Manager agent on Windows instances. If your base * image includes the Systems Manager agent, then the AMI that you create will also include the * agent. For Linux instances, if the base image does not already include the Systems Manager agent, * Image Builder installs it. For Linux instances where Image Builder installs the Systems Manager agent, you can * choose whether to keep it for the AMI that you create.

* @public */ export interface AdditionalInstanceConfiguration { /** *

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

* @public */ systemsManagerAgent?: SystemsManagerAgent | undefined; /** *

Use this property to provide commands or a command script to run when you launch your * build instance.

*

The userDataOverride property replaces any commands that Image Builder might have added to * ensure that Systems Manager is installed on your Linux build instance. If you override the user * data, make sure that you add commands to install Systems Manager, if it is not pre-installed on * your base image.

* *

The user data is always base 64 encoded. For example, the following commands are * encoded as * IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:

*

* #!/bin/bash *

*

mkdir -p /var/bb/

*

touch /var

* * @public */ userDataOverride?: string | undefined; } /** *

Image status and the reason for that status.

* @public */ export interface ImageState { /** *

The status of the image.

* @public */ status?: ImageStatus | undefined; /** *

The reason for the status of the image.

* @public */ reason?: string | undefined; } /** *

Details of an Amazon EC2 AMI.

* @public */ export interface Ami { /** *

The Amazon Web Services Region of the Amazon EC2 AMI.

* @public */ region?: string | undefined; /** *

The AMI ID of the Amazon EC2 AMI.

* @public */ image?: string | undefined; /** *

The name of the Amazon EC2 AMI.

* @public */ name?: string | undefined; /** *

The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.

* @public */ description?: string | undefined; /** *

Image status and the reason for that status.

* @public */ state?: ImageState | undefined; /** *

The account ID of the owner of the AMI.

* @public */ accountId?: string | undefined; } /** *

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.

* @public */ export interface LaunchPermissionConfiguration { /** *

The Amazon Web Services account ID.

* @public */ userIds?: string[] | undefined; /** *

The name of the group.

* @public */ userGroups?: string[] | undefined; /** *

The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more * information, see What is * Organizations?.

* @public */ organizationArns?: string[] | undefined; /** *

The ARN for an Organizations organizational unit (OU) that you want to share your AMI with. * For more information about key concepts for Organizations, see Organizations * terminology and concepts.

* @public */ organizationalUnitArns?: string[] | undefined; } /** *

Define and configure the output AMIs of the pipeline.

* @public */ export interface AmiDistributionConfiguration { /** *

The name of the output AMI.

* @public */ name?: string | undefined; /** *

The description of the AMI distribution configuration. Minimum and maximum length are * in characters.

* @public */ description?: string | undefined; /** *

The ID of an account to which you want to distribute an image.

* @public */ targetAccountIds?: string[] | undefined; /** *

The tags to apply to AMIs distributed to this Region.

* @public */ amiTags?: Record | undefined; /** *

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt the distributed image. * This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) * in the Key Management Service Developer Guide.

* @public */ kmsKeyId?: string | undefined; /** *

Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to * launch instances.

* @public */ launchPermission?: LaunchPermissionConfiguration | undefined; } /** *

Defines the rules by which an image pipeline is automatically disabled when it fails.

* @public */ export interface AutoDisablePolicy { /** *

The number of consecutive scheduled image pipeline executions that must fail before Image Builder * automatically disables the pipeline.

* @public */ failureCount: number | undefined; } /** * @public */ export interface CancelImageCreationRequest { /** *

The Amazon Resource Name (ARN) of the image that you want to cancel creation * for.

* @public */ imageBuildVersionArn: string | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface CancelImageCreationResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image whose creation this request canceled.

* @public */ imageBuildVersionArn?: string | undefined; } /** * @public */ export interface CancelLifecycleExecutionRequest { /** *

Identifies the specific runtime instance of the image lifecycle to cancel.

* @public */ lifecycleExecutionId: string | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface CancelLifecycleExecutionResponse { /** *

The unique identifier for the image lifecycle runtime instance that was canceled.

* @public */ lifecycleExecutionId?: string | undefined; } /** *

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

* @public */ export interface ComponentParameterDetail { /** *

The name of this input parameter.

* @public */ name: string | undefined; /** *

The type of input this parameter provides. The currently supported value is * "string".

* @public */ type: string | undefined; /** *

The default value of this parameter if no input is provided.

* @public */ defaultValue?: string[] | undefined; /** *

Describes this parameter.

* @public */ description?: string | undefined; } /** *

Information about a single product code.

* @public */ export interface ProductCodeListItem { /** *

For Amazon Web Services Marketplace components, this contains the product code ID that can be stamped onto * an EC2 AMI to ensure that components are billed correctly. If this property is empty, * it might mean that the component is not published.

* @public */ productCodeId: string | undefined; /** *

The owner of the product code that's billed. If this property is * empty, it might mean that the component is not published.

* @public */ productCodeType: ProductCodeType | undefined; } /** *

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

* @public */ export interface ComponentState { /** *

The current state of the component.

* @public */ status?: ComponentStatus | undefined; /** *

Describes how or why the component changed state.

* @public */ reason?: string | undefined; } /** *

A detailed view of a component.

* @public */ export interface Component { /** *

The Amazon Resource Name (ARN) of the component.

* @public */ arn?: string | undefined; /** *

The name of the component.

* @public */ name?: string | undefined; /** *

The version of the component.

* @public */ version?: string | undefined; /** *

The description of the component.

* @public */ description?: string | undefined; /** *

Describes what change has been made in this version of the component, * or what makes this version different from other versions of the component.

* @public */ changeDescription?: string | undefined; /** *

The component type specifies whether Image Builder uses the component to build the image or * only to test it.

* @public */ type?: ComponentType | undefined; /** *

The operating system platform of the component.

* @public */ platform?: Platform | undefined; /** *

The operating system (OS) version supported by the component. If the OS information is * available, Image Builder performs a prefix match against the base image OS version during image * recipe creation.

* @public */ supportedOsVersions?: string[] | undefined; /** *

Describes the current status of the component.

* @public */ state?: ComponentState | undefined; /** *

Contains parameter details for each of the parameters that the component document * defined for the component.

* @public */ parameters?: ComponentParameterDetail[] | undefined; /** *

The owner of the component.

* @public */ owner?: string | undefined; /** *

Component data contains the YAML document content for the component.

* @public */ data?: string | undefined; /** *

The KMS key identifier used to encrypt the component. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) * in the Key Management Service Developer Guide.

* @public */ kmsKeyId?: string | undefined; /** *

The encryption status of the component.

* @public */ encrypted?: boolean | undefined; /** *

The date that Image Builder created the component.

* @public */ dateCreated?: string | undefined; /** *

The tags that apply to the component.

* @public */ tags?: Record | undefined; /** *

Contains the name of the publisher if this is a third-party component. Otherwise, * this property is empty.

* @public */ publisher?: string | undefined; /** *

Indicates whether component source is hidden from view in the console, and from * component detail results for API, CLI, or SDK operations.

* @public */ obfuscate?: boolean | undefined; /** *

Contains product codes that are used for billing purposes for Amazon Web Services Marketplace components.

* @public */ productCodes?: ProductCodeListItem[] | undefined; } /** *

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

* @public */ export interface ComponentParameter { /** *

The name of the component parameter to set.

* @public */ name: string | undefined; /** *

Sets the value for the named component parameter.

* @public */ value: string[] | undefined; } /** *

Configuration details of the component.

* @public */ export interface ComponentConfiguration { /** *

The Amazon Resource Name (ARN) of the component.

* @public */ componentArn: string | undefined; /** *

A group of parameter settings that Image Builder uses to configure the component for a specific * recipe.

* @public */ parameters?: ComponentParameter[] | undefined; } /** *

A high-level summary of a component.

* @public */ export interface ComponentSummary { /** *

The Amazon Resource Name (ARN) of the component.

* @public */ arn?: string | undefined; /** *

The name of the component.

* @public */ name?: string | undefined; /** *

The version of the component.

* @public */ version?: string | undefined; /** *

The operating system platform of the component.

* @public */ platform?: Platform | undefined; /** *

The operating system (OS) version that the component supports. If the OS information * is available, Image Builder performs a prefix match against the base image OS version during * image recipe creation.

* @public */ supportedOsVersions?: string[] | undefined; /** *

Describes the current status of the component.

* @public */ state?: ComponentState | undefined; /** *

The component type specifies whether Image Builder uses the component to build the image or * only to test it.

* @public */ type?: ComponentType | undefined; /** *

The owner of the component.

* @public */ owner?: string | undefined; /** *

The description of the component.

* @public */ description?: string | undefined; /** *

The change description for the current version of the component.

* @public */ changeDescription?: string | undefined; /** *

The original creation date of the component.

* @public */ dateCreated?: string | undefined; /** *

The tags that apply to the component.

* @public */ tags?: Record | undefined; /** *

Contains the name of the publisher if this is a third-party component. Otherwise, * this property is empty.

* @public */ publisher?: string | undefined; /** *

Indicates whether component source is hidden from view in the console, and from * component detail results for API, CLI, or SDK operations.

* @public */ obfuscate?: boolean | undefined; } /** *

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

* @public */ export interface ComponentVersion { /** *

The Amazon Resource Name (ARN) of the component.

* *

Semantic versioning is included in each object's Amazon Resource Name (ARN), * at the level that applies to that object as follows:

*
    *
  1. *

    Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are * either left off entirely, or they are specified as wildcards, for example: x.x.x.

    *
    2. *
  2. *

    Version ARNs have only the first three nodes: ..

    *
    3. *
  3. *

    Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

    *
    4. *
* * @public */ arn?: string | undefined; /** *

The name of the component.

* @public */ name?: string | undefined; /** *

The semantic version of the component.

* *

The semantic version has four nodes: ../. * You can assign values for the first three, and can filter on all of them.

*

* Assignment: For the first three nodes you can assign any positive integer value, including * zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the * build number to the fourth node.

*

* Patterns: You can use any numeric pattern that adheres to the assignment requirements for * the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or * a date, such as 2021.01.01.

*

* 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.

* * @public */ version?: string | undefined; /** *

The description of the component.

* @public */ description?: string | undefined; /** *

The platform of the component.

* @public */ platform?: Platform | undefined; /** *

he operating system (OS) version supported by the component. If the OS information is * available, a prefix match is performed against the base image OS version during image * recipe creation.

* @public */ supportedOsVersions?: string[] | undefined; /** *

The type of the component denotes whether the component is used to build the image or * only to test it.

* @public */ type?: ComponentType | undefined; /** *

The owner of the component.

* @public */ owner?: string | undefined; /** *

The date that the component was created.

* @public */ dateCreated?: string | undefined; /** *

Describes the current status of the component version.

* @public */ status?: ComponentStatus | undefined; /** *

Contains product codes that are used for billing purposes for Amazon Web Services Marketplace components.

* @public */ productCodes?: ProductCodeListItem[] | undefined; } /** *

A container encapsulates the runtime environment for an application.

* @public */ export interface Container { /** *

Containers and container images are Region-specific. This is the Region context for * the container.

* @public */ region?: string | undefined; /** *

A list of URIs for containers created in the context Region.

* @public */ imageUris?: string[] | undefined; } /** *

The container repository where the output container image is stored.

* @public */ export interface TargetContainerRepository { /** *

Specifies the service in which this image was registered.

* @public */ service: ContainerRepositoryService | undefined; /** *

The name of the container repository where the output container image is stored. * This name is prefixed by the repository location. For example, * /repository_name.

* @public */ repositoryName: string | undefined; } /** *

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

* @public */ export interface ContainerDistributionConfiguration { /** *

The description of the container distribution configuration.

* @public */ description?: string | undefined; /** *

Tags that are attached to the container distribution configuration.

* @public */ containerTags?: string[] | undefined; /** *

The destination repository for the container distribution configuration.

* @public */ targetRepository: TargetContainerRepository | undefined; } /** *

Amazon EBS-specific block device mapping specifications.

* @public */ export interface EbsInstanceBlockDeviceSpecification { /** *

Use to configure device encryption.

* @public */ encrypted?: boolean | undefined; /** *

Use to configure delete on termination of the associated device.

* @public */ deleteOnTermination?: boolean | undefined; /** *

Use to configure device IOPS.

* @public */ iops?: number | undefined; /** *

The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. * This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) * in the Key Management Service Developer Guide.

* @public */ kmsKeyId?: string | undefined; /** *

The snapshot that defines the device contents.

* @public */ snapshotId?: string | undefined; /** *

Use to override the device's volume size.

* @public */ volumeSize?: number | undefined; /** *

Use to override the device's volume type.

* @public */ volumeType?: EbsVolumeType | undefined; /** *

* For GP3 volumes only – The throughput in MiB/s * that the volume supports.

* @public */ throughput?: number | undefined; } /** *

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

* @public */ export interface InstanceBlockDeviceMapping { /** *

The device to which these mappings apply.

* @public */ deviceName?: string | undefined; /** *

Use to manage Amazon EBS-specific configuration for this mapping.

* @public */ ebs?: EbsInstanceBlockDeviceSpecification | undefined; /** *

Use to manage instance ephemeral devices.

* @public */ virtualName?: string | undefined; /** *

Use to remove a mapping from the base image.

* @public */ noDevice?: string | undefined; } /** *

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

* @public */ export interface InstanceConfiguration { /** *

The base image for a container build and test instance. This can contain an AMI ID * or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, * followed by the parameter name or ARN.

*

If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.

* @public */ image?: string | undefined; /** *

Defines the block devices to attach for building an instance from this Image Builder * AMI.

* @public */ blockDeviceMappings?: InstanceBlockDeviceMapping[] | undefined; } /** *

A container recipe.

* @public */ export interface ContainerRecipe { /** *

The Amazon Resource Name (ARN) of the container recipe.

* *

Semantic versioning is included in each object's Amazon Resource Name (ARN), * at the level that applies to that object as follows:

*
    *
  1. *

    Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are * either left off entirely, or they are specified as wildcards, for example: x.x.x.

    *
    2. *
  2. *

    Version ARNs have only the first three nodes: ..

    *
    3. *
  3. *

    Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

    *
    4. *
* * @public */ arn?: string | undefined; /** *

Specifies the type of container, such as Docker.

* @public */ containerType?: ContainerType | undefined; /** *

The name of the container recipe.

* @public */ name?: string | undefined; /** *

The description of the container recipe.

* @public */ description?: string | undefined; /** *

The system platform for the container, such as Windows or Linux.

* @public */ platform?: Platform | undefined; /** *

The owner of the container recipe.

* @public */ owner?: string | undefined; /** *

The semantic version of the container recipe.

* *

The semantic version has four nodes: ../. * You can assign values for the first three, and can filter on all of them.

*

* Assignment: For the first three nodes you can assign any positive integer value, including * zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the * build number to the fourth node.

*

* Patterns: You can use any numeric pattern that adheres to the assignment requirements for * the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or * a date, such as 2021.01.01.

*

* 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.

* * @public */ version?: string | undefined; /** *

Build and test components that are included in the container recipe. * Recipes require a minimum of one build component, and can * have a maximum of 20 build and test components in any combination.

* @public */ components?: ComponentConfiguration[] | undefined; /** *

A group of options that can be used to configure an instance for building and testing * container images.

* @public */ instanceConfiguration?: InstanceConfiguration | undefined; /** *

Dockerfiles are text documents that are used to build Docker containers, and ensure * that they contain all of the elements required by the application running inside. The * template data consists of contextual variables where Image Builder places build information or * scripts, based on your container image recipe.

* @public */ dockerfileTemplateData?: string | undefined; /** *

The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the container image * for distribution to the target Region. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) * in the Key Management Service Developer Guide.

* @public */ kmsKeyId?: string | undefined; /** *

A flag that indicates if the target container is encrypted.

* @public */ encrypted?: boolean | undefined; /** *

The base image for customizations specified in the container recipe. This can * contain an Image Builder image resource ARN or a container image URI, for example * amazonlinux:latest.

* @public */ parentImage?: string | undefined; /** *

The date when this container recipe was created.

* @public */ dateCreated?: string | undefined; /** *

Tags that are attached to the container recipe.

* @public */ tags?: Record | undefined; /** *

The working directory for use during build and test workflows.

* @public */ workingDirectory?: string | undefined; /** *

The destination repository for the container image.

* @public */ targetRepository?: TargetContainerRepository | undefined; } /** *

A summary of a container recipe

* @public */ export interface ContainerRecipeSummary { /** *

The Amazon Resource Name (ARN) of the container recipe.

* @public */ arn?: string | undefined; /** *

Specifies the type of container, such as "Docker".

* @public */ containerType?: ContainerType | undefined; /** *

The name of the container recipe.

* @public */ name?: string | undefined; /** *

The system platform for the container, such as Windows or Linux.

* @public */ platform?: Platform | undefined; /** *

The owner of the container recipe.

* @public */ owner?: string | undefined; /** *

The base image for the container recipe.

* @public */ parentImage?: string | undefined; /** *

The date when this container recipe was created.

* @public */ dateCreated?: string | undefined; /** *

The base image for a container build and test instance. This can contain an AMI ID * or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, * followed by the parameter name or ARN.

*

If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.

* @public */ instanceImage?: string | undefined; /** *

Tags that are attached to the container recipe.

* @public */ tags?: Record | undefined; } /** * @public */ export interface CreateComponentRequest { /** *

The name of the component.

* @public */ name: string | undefined; /** *

The semantic version of the component. This version follows the semantic version * syntax.

* *

The semantic version has four nodes: ../. * You can assign values for the first three, and can filter on all of them.

*

* Assignment: For the first three nodes you can assign any positive integer value, including * zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the * build number to the fourth node.

*

* Patterns: You can use any numeric pattern that adheres to the assignment requirements for * the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or * a date, such as 2021.01.01.

* * @public */ semanticVersion: string | undefined; /** *

Describes the contents of the component.

* @public */ description?: string | undefined; /** *

The change description of the component. Describes what change has been made in this * version, or what makes this version different from other versions of the * component.

* @public */ changeDescription?: string | undefined; /** *

The operating system platform of the component.

* @public */ platform: Platform | undefined; /** *

The operating system (OS) version supported by the component. If the OS information is * available, a prefix match is performed against the base image OS version during image * recipe creation.

* @public */ supportedOsVersions?: string[] | undefined; /** *

Component data contains inline YAML document content for the component. * Alternatively, you can specify the uri of a YAML document file stored in * Amazon S3. However, you cannot specify both properties.

* @public */ data?: string | undefined; /** *

The uri of a YAML component document file. This must be an S3 URL * (s3://bucket/key), and the requester must have permission to access the * S3 bucket it points to. If you use Amazon S3, you can specify component content up to your * service quota.

*

Alternatively, you can specify the YAML document inline, using the component * data property. You cannot specify both properties.

* @public */ uri?: string | undefined; /** *

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) * in the Key Management Service Developer Guide.

* @public */ kmsKeyId?: string | undefined; /** *

The tags that apply to the component.

* @public */ tags?: Record | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; /** *

Validates the required permissions for the operation and the request parameters, without actually making the request, and provides an error response. Upon a successful request, the error response is DryRunOperationException.

* @public */ dryRun?: boolean | undefined; } /** *

The resource ARNs with different wildcard variations of semantic versioning.

* @public */ export interface LatestVersionReferences { /** *

The latest version Amazon Resource Name (ARN) of the Image Builder resource.

* @public */ latestVersionArn?: string | undefined; /** *

The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.

* @public */ latestMajorVersionArn?: string | undefined; /** *

The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.

* @public */ latestMinorVersionArn?: string | undefined; /** *

The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.

* @public */ latestPatchVersionArn?: string | undefined; } /** * @public */ export interface CreateComponentResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the component that the request created.

* @public */ componentBuildVersionArn?: string | undefined; /** *

The resource ARNs with different wildcard variations of semantic versioning.

* @public */ latestVersionReferences?: LatestVersionReferences | undefined; } /** * @public */ export interface CreateContainerRecipeRequest { /** *

The type of container to create.

* @public */ containerType: ContainerType | undefined; /** *

The name of the container recipe.

* @public */ name: string | undefined; /** *

The description of the container recipe.

* @public */ description?: string | undefined; /** *

The semantic version of the container recipe. This version follows the semantic * version syntax.

* *

The semantic version has four nodes: ../. * You can assign values for the first three, and can filter on all of them.

*

* Assignment: For the first three nodes you can assign any positive integer value, including * zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the * build number to the fourth node.

*

* Patterns: You can use any numeric pattern that adheres to the assignment requirements for * the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or * a date, such as 2021.01.01.

* * @public */ semanticVersion: string | undefined; /** *

The components included in the container recipe.

* @public */ components?: ComponentConfiguration[] | undefined; /** *

A group of options that can be used to configure an instance for building and testing * container images.

* @public */ instanceConfiguration?: InstanceConfiguration | undefined; /** *

The Dockerfile template used to build your image as an inline data blob.

* @public */ dockerfileTemplateData?: string | undefined; /** *

The Amazon S3 URI for the Dockerfile that will be used to build your container * image.

* @public */ dockerfileTemplateUri?: string | undefined; /** *

Specifies the operating system platform when you use a custom base image.

* @public */ platformOverride?: Platform | undefined; /** *

Specifies the operating system version for the base image.

* @public */ imageOsVersionOverride?: string | undefined; /** *

The base image for the container recipe.

* @public */ parentImage: string | undefined; /** *

Tags that are attached to the container recipe.

* @public */ tags?: Record | undefined; /** *

The working directory for use during build and test workflows.

* @public */ workingDirectory?: string | undefined; /** *

The destination repository for the container image.

* @public */ targetRepository: TargetContainerRepository | undefined; /** *

The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the Dockerfile * template. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) * in the Key Management Service Developer Guide.

* @public */ kmsKeyId?: string | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface CreateContainerRecipeResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

Returns the Amazon Resource Name (ARN) of the container recipe that the request * created.

* @public */ containerRecipeArn?: string | undefined; /** *

The resource ARNs with different wildcard variations of semantic versioning.

* @public */ latestVersionReferences?: LatestVersionReferences | undefined; } /** *

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

* *

You can specify either the launchTemplateName or the * launchTemplateId, but not both.

* * @public */ export interface FastLaunchLaunchTemplateSpecification { /** *

The ID of the launch template to use for faster launching for a Windows AMI.

* @public */ launchTemplateId?: string | undefined; /** *

The name of the launch template to use for faster launching for a Windows AMI.

* @public */ launchTemplateName?: string | undefined; /** *

The version of the launch template to use for faster launching for a Windows * AMI.

* @public */ launchTemplateVersion?: string | undefined; } /** *

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

* @public */ export interface FastLaunchSnapshotConfiguration { /** *

The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled * Windows AMI.

* @public */ targetResourceCount?: number | undefined; } /** *

Define and configure faster launching for output Windows AMIs.

* @public */ export interface FastLaunchConfiguration { /** *

A Boolean that represents the current state of faster launching for the Windows AMI. * Set to true to start using Windows faster launching, or false * to stop using it.

* @public */ enabled: boolean | undefined; /** *

Configuration settings for managing the number of snapshots that are created from * pre-provisioned instances for the Windows AMI when faster launching is enabled.

* @public */ snapshotConfiguration?: FastLaunchSnapshotConfiguration | undefined; /** *

The maximum number of parallel instances that are launched for creating * resources.

* @public */ maxParallelLaunches?: number | undefined; /** *

The launch template that the fast-launch enabled Windows AMI uses when it launches * Windows instances to create pre-provisioned snapshots.

* @public */ launchTemplate?: FastLaunchLaunchTemplateSpecification | undefined; /** *

The owner account ID for the fast-launch enabled Windows AMI.

* @public */ accountId?: string | undefined; } /** *

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

* @public */ export interface LaunchTemplateConfiguration { /** *

Identifies the Amazon EC2 launch template to use.

* @public */ launchTemplateId: string | undefined; /** *

The account ID that this configuration applies to.

* @public */ accountId?: string | undefined; /** *

Set the specified Amazon EC2 launch template as the default launch template for the * specified account.

* @public */ setDefaultVersion?: boolean | undefined; } /** *

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

* @public */ export interface S3ExportConfiguration { /** *

The name of the role that grants VM Import/Export permission to export images to your * S3 bucket.

* @public */ roleName: string | undefined; /** *

Export the updated image to one of the following supported disk image formats:

*
    *
  • *

    * Virtual Hard Disk (VHD) – Compatible * with Citrix Xen and Microsoft Hyper-V virtualization products.

    *
    • *
  • *

    * Stream-optimized ESX Virtual Machine Disk * (VMDK) – Compatible with VMware ESX and VMware vSphere * versions 4, 5, and 6.

    *
    • *
  • *

    * Raw – Raw format.

    *
    • *
* @public */ diskImageFormat: DiskImageFormat | undefined; /** *

The S3 bucket in which to store the output disk images for your VM.

* @public */ s3Bucket: string | undefined; /** *

The Amazon S3 path for the bucket where the output disk images for your VM are * stored.

* @public */ s3Prefix?: string | undefined; } /** *

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

* @public */ export interface SsmParameterConfiguration { /** *

Specify the account that will own the Parameter in a given Region. During distribution, * this account must be specified in distribution settings as a target account for the * Region.

* @public */ amiAccountId?: string | undefined; /** *

This is the name of the Parameter in the target Region or account. The image * distribution creates the Parameter if it doesn't already exist. Otherwise, it updates * the parameter.

* @public */ parameterName: string | undefined; /** *

The data type specifies what type of value the Parameter contains. We recommend that * you use data type aws:ec2:image.

* @public */ dataType?: SsmParameterDataType | undefined; } /** *

Defines the settings for a specific Region.

* @public */ export interface Distribution { /** *

The target Region.

* @public */ region: string | undefined; /** *

The specific AMI settings; for example, launch permissions or AMI tags.

* @public */ amiDistributionConfiguration?: AmiDistributionConfiguration | undefined; /** *

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

* @public */ containerDistributionConfiguration?: ContainerDistributionConfiguration | undefined; /** *

The License Manager Configuration to associate with the AMI in the specified * Region.

* @public */ licenseConfigurationArns?: string[] | undefined; /** *

A group of launchTemplateConfiguration settings that apply to image distribution for * specified accounts.

* @public */ launchTemplateConfigurations?: LaunchTemplateConfiguration[] | undefined; /** *

Configure export settings to deliver disk images created from your image build, * using a file format that is compatible with your VMs in that Region.

* @public */ s3ExportConfiguration?: S3ExportConfiguration | undefined; /** *

The Windows faster-launching configurations to use for AMI distribution.

* @public */ fastLaunchConfigurations?: FastLaunchConfiguration[] | undefined; /** *

Contains settings to update Amazon Web Services Systems Manager (SSM) Parameter Store Parameters with * output AMI IDs from the build by target Region.

* @public */ ssmParameterConfigurations?: SsmParameterConfiguration[] | undefined; } /** * @public */ export interface CreateDistributionConfigurationRequest { /** *

The name of the distribution configuration.

* @public */ name: string | undefined; /** *

The description of the distribution configuration.

* @public */ description?: string | undefined; /** *

The distributions of the distribution configuration.

* @public */ distributions: Distribution[] | undefined; /** *

The tags of the distribution configuration.

* @public */ tags?: Record | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface CreateDistributionConfigurationResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the distribution configuration that was created by * this request.

* @public */ distributionConfigurationArn?: string | undefined; } /** *

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

* @public */ export interface EcrConfiguration { /** *

The name of the container repository that Amazon Inspector scans to identify findings for your * container images. The name includes the path for the repository location. If you don’t * provide this information, Image Builder creates a repository in your account named * image-builder-image-scanning-repository for vulnerability scans of your * output container images.

* @public */ repositoryName?: string | undefined; /** *

Tags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can * help you identify and manage your scanned images.

* @public */ containerTags?: string[] | undefined; } /** *

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

* @public */ export interface ImageScanningConfiguration { /** *

A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that * Amazon Inspector runs against the build instance when you create a new image.

* @public */ imageScanningEnabled?: boolean | undefined; /** *

Contains Amazon ECR settings for vulnerability scans.

* @public */ ecrConfiguration?: EcrConfiguration | undefined; } /** *

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.

* @public */ export interface ImageTestsConfiguration { /** *

Determines if tests should run after building the image. Image Builder defaults to enable tests * to run following the image build, before image distribution.

* @public */ imageTestsEnabled?: boolean | undefined; /** *

The maximum time in minutes that tests are permitted to run.

* *

The timeout property is not currently active. This value is * ignored.

* * @public */ timeoutMinutes?: number | undefined; } /** *

The logging configuration that's defined for the image. Image Builder uses the defined settings * to direct execution log output during image creation.

* @public */ export interface ImageLoggingConfiguration { /** *

The log group name that Image Builder uses for image creation. If not specified, the log group * name defaults to /aws/imagebuilder/image-name.

* @public */ logGroupName?: string | undefined; } /** *

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

* @public */ export interface WorkflowParameter { /** *

The name of the workflow parameter to set.

* @public */ name: string | undefined; /** *

Sets the value for the named workflow parameter.

* @public */ value: string[] | undefined; } /** *

Contains control settings and configurable inputs for a workflow * resource.

* @public */ export interface WorkflowConfiguration { /** *

The Amazon Resource Name (ARN) of the workflow resource.

* @public */ workflowArn: string | undefined; /** *

Contains parameter values for each of the parameters that the workflow * document defined for the workflow resource.

* @public */ parameters?: WorkflowParameter[] | undefined; /** *

Test workflows are defined within named runtime groups called parallel groups. * The parallel group is the named group that contains this test workflow. Test * workflows within a parallel group can run at the same time. Image Builder starts up to five * test workflows in the group at the same time, and starts additional workflows as * others complete, until all workflows in the group have completed. This field only * applies for test workflows.

* @public */ parallelGroup?: string | undefined; /** *

The action to take if the workflow fails.

* @public */ onFailure?: OnWorkflowFailure | undefined; } /** * @public */ export interface CreateImageRequest { /** *

The Amazon Resource Name (ARN) of the image recipe that defines how images are * configured, tested, and assessed.

* @public */ imageRecipeArn?: string | undefined; /** *

The Amazon Resource Name (ARN) of the container recipe that defines how images are * configured and tested.

* @public */ containerRecipeArn?: string | undefined; /** *

The Amazon Resource Name (ARN) of the distribution configuration that defines and * configures the outputs of your pipeline.

* @public */ distributionConfigurationArn?: string | undefined; /** *

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the * environment in which your image will be built and tested.

* @public */ infrastructureConfigurationArn: string | undefined; /** *

The image tests configuration of the image.

* @public */ imageTestsConfiguration?: ImageTestsConfiguration | undefined; /** *

Collects additional information about the image being created, including the operating * system (OS) version and package list. This information is used to enhance the overall * experience of using EC2 Image Builder. Enabled by default.

* @public */ enhancedImageMetadataEnabled?: boolean | undefined; /** *

The tags of the image.

* @public */ tags?: Record | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; /** *

Contains settings for vulnerability scans.

* @public */ imageScanningConfiguration?: ImageScanningConfiguration | undefined; /** *

Contains an array of workflow configuration objects.

* @public */ workflows?: WorkflowConfiguration[] | undefined; /** *

The name or Amazon Resource Name (ARN) for the IAM role you create that grants * Image Builder access to perform workflow actions.

* @public */ executionRole?: string | undefined; /** *

Define logging configuration for the image build process.

* @public */ loggingConfiguration?: ImageLoggingConfiguration | undefined; } /** * @public */ export interface CreateImageResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image that the request created.

* @public */ imageBuildVersionArn?: string | undefined; /** *

The resource ARNs with different wildcard variations of semantic versioning.

* @public */ latestVersionReferences?: LatestVersionReferences | undefined; } /** *

The logging configuration that's defined for pipeline execution.

* @public */ export interface PipelineLoggingConfiguration { /** *

The log group name that Image Builder uses for image creation. If not specified, the log group * name defaults to /aws/imagebuilder/image-name.

* @public */ imageLogGroupName?: string | undefined; /** *

The log group name that Image Builder uses for the log output during creation of a new pipeline. * If not specified, the pipeline log group name defaults to * /aws/imagebuilder/pipeline/pipeline-name.

* @public */ pipelineLogGroupName?: string | undefined; } /** *

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

* @public */ export interface Schedule { /** *

The cron expression determines how often EC2 Image Builder evaluates your * pipelineExecutionStartCondition.

*

For information on how to format a cron expression in Image Builder, see Use * cron expressions in EC2 Image Builder.

* @public */ scheduleExpression?: string | undefined; /** *

The timezone that applies to the scheduling expression. For example, "Etc/UTC", * "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.

* @public */ timezone?: string | undefined; /** *

The start condition configures when the pipeline should trigger a new image build, * as follows. If no value is set Image Builder defaults to * EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE.

*
    *
  • *

    * EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE (default) – * When you use semantic version filters on the base image or components in your * image recipe, EC2 Image Builder builds a new image only when there are new versions of * the base image or components in your recipe that match the filter.

    * *

    For semantic version syntax, see CreateComponent.

    *     *
    • *
  • *

    * EXPRESSION_MATCH_ONLY – This condition builds a new * image every time the CRON expression matches the current time.

    *
    • *
* @public */ pipelineExecutionStartCondition?: PipelineExecutionStartCondition | undefined; /** *

The policy that configures when Image Builder should automatically disable a pipeline that * is failing.

* @public */ autoDisablePolicy?: AutoDisablePolicy | undefined; } /** * @public */ export interface CreateImagePipelineRequest { /** *

The name of the image pipeline.

* @public */ name: string | undefined; /** *

The description of the image pipeline.

* @public */ description?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image recipe that will be used to configure * images created by this image pipeline.

* @public */ imageRecipeArn?: string | undefined; /** *

The Amazon Resource Name (ARN) of the container recipe that is used to configure * images created by this container pipeline.

* @public */ containerRecipeArn?: string | undefined; /** *

The Amazon Resource Name (ARN) of the infrastructure configuration that will be used * to build images created by this image pipeline.

* @public */ infrastructureConfigurationArn: string | undefined; /** *

The Amazon Resource Name (ARN) of the distribution configuration that will be used to * configure and distribute images created by this image pipeline.

* @public */ distributionConfigurationArn?: string | undefined; /** *

The image test configuration of the image pipeline.

* @public */ imageTestsConfiguration?: ImageTestsConfiguration | undefined; /** *

Collects additional information about the image being created, including the operating * system (OS) version and package list. This information is used to enhance the overall * experience of using EC2 Image Builder. Enabled by default.

* @public */ enhancedImageMetadataEnabled?: boolean | undefined; /** *

The schedule of the image pipeline.

* @public */ schedule?: Schedule | undefined; /** *

The status of the image pipeline.

* @public */ status?: PipelineStatus | undefined; /** *

The tags of the image pipeline.

* @public */ tags?: Record | undefined; /** *

The tags to be applied to the images produced by this pipeline.

* @public */ imageTags?: Record | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; /** *

Contains settings for vulnerability scans.

* @public */ imageScanningConfiguration?: ImageScanningConfiguration | undefined; /** *

Contains an array of workflow configuration objects.

* @public */ workflows?: WorkflowConfiguration[] | undefined; /** *

The name or Amazon Resource Name (ARN) for the IAM role you create that grants * Image Builder access to perform workflow actions.

* @public */ executionRole?: string | undefined; /** *

Define logging configuration for the image build process.

* @public */ loggingConfiguration?: PipelineLoggingConfiguration | undefined; } /** * @public */ export interface CreateImagePipelineResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image pipeline that was created by this * request.

* @public */ imagePipelineArn?: string | undefined; } /** * @public */ export interface CreateImageRecipeRequest { /** *

The name of the image recipe.

* @public */ name: string | undefined; /** *

The description of the image recipe.

* @public */ description?: string | undefined; /** *

The semantic version of the image recipe. This version follows the semantic version * syntax.

* *

The semantic version has four nodes: ../. * You can assign values for the first three, and can filter on all of them.

*

* Assignment: For the first three nodes you can assign any positive integer value, including * zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the * build number to the fourth node.

*

* Patterns: You can use any numeric pattern that adheres to the assignment requirements for * the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or * a date, such as 2021.01.01.

* * @public */ semanticVersion: string | undefined; /** *

The components included in the image recipe.

* @public */ components?: ComponentConfiguration[] | undefined; /** *

The base image for customizations specified in the image recipe. You can specify the * parent image using one of the following options:

*
    *
  • *

    AMI ID

    *
    • *
  • *

    Image Builder image Amazon Resource Name (ARN)

    *
    • *
  • *

    Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, * followed by the parameter name or ARN.

    *
    • *
  • *

    Amazon Web Services Marketplace product ID

    *
    • *
*

If you enter an AMI ID or an SSM parameter that contains the AMI ID, you must have access * to the AMI, and the AMI must be in the source Region.

* @public */ parentImage: string | undefined; /** *

The block device mappings of the image recipe.

* @public */ blockDeviceMappings?: InstanceBlockDeviceMapping[] | undefined; /** *

The tags of the image recipe.

* @public */ tags?: Record | undefined; /** *

The working directory used during build and test workflows.

* @public */ workingDirectory?: string | undefined; /** *

Specify additional settings and launch scripts for your build instances.

* @public */ additionalInstanceConfiguration?: AdditionalInstanceConfiguration | undefined; /** *

Tags that are applied to the AMI that Image Builder creates during the Build phase * prior to image distribution.

* @public */ amiTags?: Record | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface CreateImageRecipeResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image recipe that was created by this * request.

* @public */ imageRecipeArn?: string | undefined; /** *

The resource ARNs with different wildcard variations of semantic versioning.

* @public */ latestVersionReferences?: LatestVersionReferences | undefined; } /** *

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.

* @public */ export interface InstanceMetadataOptions { /** *

Indicates whether a signed token header is required for instance metadata retrieval * requests. The values affect the response as follows:

*
    *
  • *

    * required – When you retrieve the IAM * role credentials, version 2.0 credentials are returned in all cases.

    *
    • *
  • *

    * optional – You can include a signed * token header in your request to retrieve instance metadata, or you can leave it * out. If you include it, version 2.0 credentials are returned for the IAM role. * Otherwise, version 1.0 credentials are returned.

    *
    • *
*

The default setting is optional.

* @public */ httpTokens?: string | undefined; /** *

Limit the number of hops that an instance metadata request can traverse to reach its * destination. The default is one hop. However, if HTTP tokens are required, container * image builds need a minimum of two hops.

* @public */ httpPutResponseHopLimit?: number | undefined; } /** *

Amazon S3 logging configuration.

* @public */ export interface S3Logs { /** *

The S3 bucket in which to store the logs.

* @public */ s3BucketName?: string | undefined; /** *

The Amazon S3 path to the bucket where the logs are stored.

* @public */ s3KeyPrefix?: string | undefined; } /** *

Logging configuration defines where Image Builder uploads your logs.

* @public */ export interface Logging { /** *

The Amazon S3 logging configuration.

* @public */ s3Logs?: S3Logs | undefined; } /** *

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.

* @public */ export interface Placement { /** *

The Availability Zone where your build and test instances will launch.

* @public */ availabilityZone?: string | undefined; /** *

The tenancy of the instance. An instance with a tenancy of dedicated * runs on single-tenant hardware. An instance with a tenancy of host runs * on a Dedicated Host.

*

If tenancy is set to host, then you can optionally specify one target * for placement – either host ID or host resource group ARN. If automatic placement * is enabled for your host, and you don't specify any placement target, Amazon EC2 will try to * find an available host for your build and test instances.

* @public */ tenancy?: TenancyType | undefined; /** *

The ID of the Dedicated Host on which build and test instances run. This only * applies if tenancy is host. If you specify the host ID, you * must not specify the resource group ARN. If you specify both, Image Builder returns an error.

* @public */ hostId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances. * This only applies if tenancy is host. If you specify the resource * group ARN, you must not specify the host ID. If you specify both, Image Builder returns an error.

* @public */ hostResourceGroupArn?: string | undefined; } /** * @public */ export interface CreateInfrastructureConfigurationRequest { /** *

The name of the infrastructure configuration.

* @public */ name: string | undefined; /** *

The description of the infrastructure configuration.

* @public */ description?: string | undefined; /** *

The instance types of the infrastructure configuration. You can specify one or more * instance types to use for this build. The service will pick one of these instance types * based on availability.

* @public */ instanceTypes?: string[] | undefined; /** *

The instance profile to associate with the instance used to customize your Amazon EC2 * AMI.

* @public */ instanceProfileName: string | undefined; /** *

The security group IDs to associate with the instance used to customize your Amazon EC2 * AMI.

* @public */ securityGroupIds?: string[] | undefined; /** *

The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.

* @public */ subnetId?: string | undefined; /** *

The logging configuration of the infrastructure configuration.

* @public */ logging?: Logging | undefined; /** *

The key pair of the infrastructure configuration. You can use this to log on to and * debug the instance used to create your image.

* @public */ keyPair?: string | undefined; /** *

The terminate instance on failure setting of the infrastructure configuration. Set to * false if you want Image Builder to retain the instance used to configure your AMI if the build or * test phase of your workflow fails.

* @public */ terminateInstanceOnFailure?: boolean | undefined; /** *

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event * notifications.

* *

EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys * from other accounts. The key that is used to encrypt the SNS topic must reside in the * account that the Image Builder service runs under.

* * @public */ snsTopicArn?: string | undefined; /** *

The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process. * Tags are formatted as key value pairs.

* @public */ resourceTags?: Record | undefined; /** *

The instance metadata options that you can set for the HTTP requests that pipeline * builds use to launch EC2 build and test instances.

* @public */ instanceMetadataOptions?: InstanceMetadataOptions | undefined; /** *

The metadata tags to assign to the infrastructure configuration resource that Image Builder * creates as output. Tags are formatted as key value pairs.

* @public */ tags?: Record | undefined; /** *

The instance placement settings that define where the instances that are launched * from your image will run.

* @public */ placement?: Placement | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface CreateInfrastructureConfigurationResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the infrastructure configuration that was created by * this request.

* @public */ infrastructureConfigurationArn?: string | undefined; } /** *

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

* @public */ export interface LifecyclePolicyDetailActionIncludeResources { /** *

Specifies whether the lifecycle action should apply to distributed AMIs.

* @public */ amis?: boolean | undefined; /** *

Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.

* @public */ snapshots?: boolean | undefined; /** *

Specifies whether the lifecycle action should apply to distributed containers.

* @public */ containers?: boolean | undefined; } /** *

Contains selection criteria for the lifecycle policy.

* @public */ export interface LifecyclePolicyDetailAction { /** *

Specifies the lifecycle action to take.

* @public */ type: LifecyclePolicyDetailActionType | undefined; /** *

Specifies the resources that the lifecycle policy applies to.

* @public */ includeResources?: LifecyclePolicyDetailActionIncludeResources | undefined; } /** *

Defines criteria to exclude AMIs from lifecycle actions based on the last * time they were used to launch an instance.

* @public */ export interface LifecyclePolicyDetailExclusionRulesAmisLastLaunched { /** *

The integer number of units for the time period. For example 6 (months).

* @public */ value: number | undefined; /** *

Defines the unit of time that the lifecycle policy uses to calculate elapsed time * since the last instance launched from the AMI. For example: days, weeks, months, or years.

* @public */ unit: LifecyclePolicyTimeUnit | undefined; } /** *

Defines criteria for AMIs that are excluded from lifecycle actions.

* @public */ export interface LifecyclePolicyDetailExclusionRulesAmis { /** *

Configures whether public AMIs are excluded from the lifecycle action.

* @public */ isPublic?: boolean | undefined; /** *

Configures Amazon Web Services Regions that are excluded from the lifecycle action.

* @public */ regions?: string[] | undefined; /** *

Specifies Amazon Web Services accounts whose resources are excluded from the lifecycle action.

* @public */ sharedAccounts?: string[] | undefined; /** *

Specifies configuration details for Image Builder to exclude the most recent resources * from lifecycle actions.

* @public */ lastLaunched?: LifecyclePolicyDetailExclusionRulesAmisLastLaunched | undefined; /** *

Lists tags that should be excluded from lifecycle actions for the AMIs that have them.

* @public */ tagMap?: Record | undefined; } /** *

Specifies resources that lifecycle policy actions should not apply to.

* @public */ export interface LifecyclePolicyDetailExclusionRules { /** *

Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image * resources that have them.

* @public */ tagMap?: Record | undefined; /** *

Lists configuration values that apply to AMIs that Image Builder should exclude * from the lifecycle action.

* @public */ amis?: LifecyclePolicyDetailExclusionRulesAmis | undefined; } /** *

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

* @public */ export interface LifecyclePolicyDetailFilter { /** *

Filter resources based on either age or count.

* @public */ type: LifecyclePolicyDetailFilterType | undefined; /** *

The number of units for the time period or for the count. For example, a value of * 6 might refer to six months or six AMIs.

* *

For count-based filters, this value represents the minimum number of resources * to keep on hand. If you have fewer resources than this number, the resource is * excluded from lifecycle actions.

* * @public */ value: number | undefined; /** *

Defines the unit of time that the lifecycle policy uses to determine impacted * resources. This is required for age-based rules.

* @public */ unit?: LifecyclePolicyTimeUnit | undefined; /** *

For age-based filters, this is the number of resources to keep on hand after the lifecycle * DELETE action is applied. Impacted resources are only deleted if you have more than * this number of resources. If you have fewer resources than this number, the impacted resource * is not deleted.

* @public */ retainAtLeast?: number | undefined; } /** *

The configuration details for a lifecycle policy resource.

* @public */ export interface LifecyclePolicyDetail { /** *

Configuration details for the policy action.

* @public */ action: LifecyclePolicyDetailAction | undefined; /** *

Specifies the resources that the lifecycle policy applies to.

* @public */ filter: LifecyclePolicyDetailFilter | undefined; /** *

Additional rules to specify resources that should be exempt from policy actions.

* @public */ exclusionRules?: LifecyclePolicyDetailExclusionRules | undefined; } /** *

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

* @public */ export interface LifecyclePolicyResourceSelectionRecipe { /** *

The name of an Image Builder recipe that the lifecycle policy uses for resource selection.

* @public */ name: string | undefined; /** *

The version of the Image Builder recipe specified by the name field.

* @public */ semanticVersion: string | undefined; } /** *

Resource selection criteria for the lifecycle policy.

* @public */ export interface LifecyclePolicyResourceSelection { /** *

A list of recipes that are used as selection criteria for the output * images that the lifecycle policy applies to.

* @public */ recipes?: LifecyclePolicyResourceSelectionRecipe[] | undefined; /** *

A list of tags that are used as selection criteria for the Image Builder image * resources that the lifecycle policy applies to.

* @public */ tagMap?: Record | undefined; } /** * @public */ export interface CreateLifecyclePolicyRequest { /** *

The name of the lifecycle policy to create.

* @public */ name: string | undefined; /** *

Optional description for the lifecycle policy.

* @public */ description?: string | undefined; /** *

Indicates whether the lifecycle policy resource is enabled.

* @public */ status?: LifecyclePolicyStatus | undefined; /** *

The name or Amazon Resource Name (ARN) for the IAM role you create that grants * Image Builder access to run lifecycle actions.

* @public */ executionRole: string | undefined; /** *

The type of Image Builder resource that the lifecycle policy applies to.

* @public */ resourceType: LifecyclePolicyResourceType | undefined; /** *

Configuration details for the lifecycle policy rules.

* @public */ policyDetails: LifecyclePolicyDetail[] | undefined; /** *

Selection criteria for the resources that the lifecycle policy applies to.

* @public */ resourceSelection: LifecyclePolicyResourceSelection | undefined; /** *

Tags to apply to the lifecycle policy resource.

* @public */ tags?: Record | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface CreateLifecyclePolicyResponse { /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the lifecycle policy that the request created.

* @public */ lifecyclePolicyArn?: string | undefined; } /** * @public */ export interface CreateWorkflowRequest { /** *

The name of the workflow to create.

* @public */ name: string | undefined; /** *

The semantic version of this workflow resource. The semantic version syntax * adheres to the following rules.

* *

The semantic version has four nodes: ../. * You can assign values for the first three, and can filter on all of them.

*

* Assignment: For the first three nodes you can assign any positive integer value, including * zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the * build number to the fourth node.

*

* Patterns: You can use any numeric pattern that adheres to the assignment requirements for * the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or * a date, such as 2021.01.01.

* * @public */ semanticVersion: string | undefined; /** *

Describes the workflow.

* @public */ description?: string | undefined; /** *

Describes what change has been made in this version of the workflow, or * what makes this version different from other versions of the workflow.

* @public */ changeDescription?: string | undefined; /** *

Contains the UTF-8 encoded YAML document content for the workflow. * Alternatively, you can specify the uri of a YAML document file stored in * Amazon S3. However, you cannot specify both properties.

* @public */ data?: string | undefined; /** *

The uri of a YAML component document file. This must be an S3 URL * (s3://bucket/key), and the requester must have permission to access the * S3 bucket it points to. If you use Amazon S3, you can specify component content up to your * service quota.

*

Alternatively, you can specify the YAML document inline, using the component * data property. You cannot specify both properties.

* @public */ uri?: string | undefined; /** *

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this workflow resource. * This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) * in the Key Management Service Developer Guide.

* @public */ kmsKeyId?: string | undefined; /** *

Tags that apply to the workflow resource.

* @public */ tags?: Record | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; /** *

The phase in the image build process for which the workflow resource * is responsible.

* @public */ type: WorkflowType | undefined; /** *

Validates the required permissions for the operation and the request parameters, without actually making the request, and provides an error response. Upon a successful request, the error response is DryRunOperationException.

* @public */ dryRun?: boolean | undefined; } /** * @public */ export interface CreateWorkflowResponse { /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the workflow resource that the request created.

* @public */ workflowBuildVersionArn?: string | undefined; /** *

The resource ARNs with different wildcard variations of semantic versioning.

* @public */ latestVersionReferences?: LatestVersionReferences | undefined; } /** *

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.

* @public */ export interface CvssScore { /** *

The CVSS base score.

* @public */ baseScore?: number | undefined; /** *

The vector string of the CVSS score.

* @public */ scoringVector?: string | undefined; /** *

The CVSS version that generated the score.

* @public */ version?: string | undefined; /** *

The source of the CVSS score.

* @public */ source?: string | undefined; } /** *

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

* @public */ export interface CvssScoreAdjustment { /** *

The metric that Amazon Inspector used to adjust the CVSS score.

* @public */ metric?: string | undefined; /** *

The reason for the CVSS score adjustment.

* @public */ reason?: string | undefined; } /** *

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

* @public */ export interface CvssScoreDetails { /** *

The source for the CVSS score.

* @public */ scoreSource?: string | undefined; /** *

The source of the finding.

* @public */ cvssSource?: string | undefined; /** *

The CVSS version that generated the score.

* @public */ version?: string | undefined; /** *

The CVSS score.

* @public */ score?: number | undefined; /** *

A vector that measures the severity of the vulnerability.

* @public */ scoringVector?: string | undefined; /** *

An object that contains details about an adjustment that Amazon Inspector made to the CVSS score * for the finding.

* @public */ adjustments?: CvssScoreAdjustment[] | undefined; } /** * @public */ export interface DeleteComponentRequest { /** *

The Amazon Resource Name (ARN) of the component build version to delete.

* @public */ componentBuildVersionArn: string | undefined; } /** * @public */ export interface DeleteComponentResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the component build version that this request deleted.

* @public */ componentBuildVersionArn?: string | undefined; } /** * @public */ export interface DeleteContainerRecipeRequest { /** *

The Amazon Resource Name (ARN) of the container recipe to delete.

* @public */ containerRecipeArn: string | undefined; } /** * @public */ export interface DeleteContainerRecipeResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the container recipe that was deleted.

* @public */ containerRecipeArn?: string | undefined; } /** * @public */ export interface DeleteDistributionConfigurationRequest { /** *

The Amazon Resource Name (ARN) of the distribution configuration to delete.

* @public */ distributionConfigurationArn: string | undefined; } /** * @public */ export interface DeleteDistributionConfigurationResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the distribution configuration that was * deleted.

* @public */ distributionConfigurationArn?: string | undefined; } /** * @public */ export interface DeleteImageRequest { /** *

The Amazon Resource Name (ARN) of the Image Builder image resource to delete.

* @public */ imageBuildVersionArn: string | undefined; } /** * @public */ export interface DeleteImageResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the Image Builder image resource that this request deleted.

* @public */ imageBuildVersionArn?: string | undefined; } /** * @public */ export interface DeleteImagePipelineRequest { /** *

The Amazon Resource Name (ARN) of the image pipeline to delete.

* @public */ imagePipelineArn: string | undefined; } /** * @public */ export interface DeleteImagePipelineResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image pipeline that was deleted.

* @public */ imagePipelineArn?: string | undefined; } /** * @public */ export interface DeleteImageRecipeRequest { /** *

The Amazon Resource Name (ARN) of the image recipe to delete.

* @public */ imageRecipeArn: string | undefined; } /** * @public */ export interface DeleteImageRecipeResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image recipe that was deleted.

* @public */ imageRecipeArn?: string | undefined; } /** * @public */ export interface DeleteInfrastructureConfigurationRequest { /** *

The Amazon Resource Name (ARN) of the infrastructure configuration to delete.

* @public */ infrastructureConfigurationArn: string | undefined; } /** * @public */ export interface DeleteInfrastructureConfigurationResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the infrastructure configuration that was * deleted.

* @public */ infrastructureConfigurationArn?: string | undefined; } /** * @public */ export interface DeleteLifecyclePolicyRequest { /** *

The Amazon Resource Name (ARN) of the lifecycle policy resource to delete.

* @public */ lifecyclePolicyArn: string | undefined; } /** * @public */ export interface DeleteLifecyclePolicyResponse { /** *

The Amazon Resource Name (ARN) of the lifecycle policy that was deleted.

* @public */ lifecyclePolicyArn?: string | undefined; } /** * @public */ export interface DeleteWorkflowRequest { /** *

The Amazon Resource Name (ARN) of the workflow resource to delete.

* @public */ workflowBuildVersionArn: string | undefined; } /** * @public */ export interface DeleteWorkflowResponse { /** *

The Amazon Resource Name (ARN) of the workflow resource that this request deleted.

* @public */ workflowBuildVersionArn?: string | undefined; } /** * @public */ export interface DistributeImageRequest { /** *

The source image Amazon Resource Name (ARN) to distribute.

* @public */ sourceImage: string | undefined; /** *

The Amazon Resource Name (ARN) of the distribution configuration to use.

* @public */ distributionConfigurationArn: string | undefined; /** *

The IAM role to use for the distribution.

* @public */ executionRole: string | undefined; /** *

The tags to apply to the distributed image.

* @public */ tags?: Record | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; /** *

The logging configuration for the distribution.

* @public */ loggingConfiguration?: ImageLoggingConfiguration | undefined; } /** * @public */ export interface DistributeImageResponse { /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image to be distributed.

* @public */ imageBuildVersionArn?: string | undefined; } /** *

A distribution configuration.

* @public */ export interface DistributionConfiguration { /** *

The Amazon Resource Name (ARN) of the distribution configuration.

* @public */ arn?: string | undefined; /** *

The name of the distribution configuration.

* @public */ name?: string | undefined; /** *

The description of the distribution configuration.

* @public */ description?: string | undefined; /** *

The distribution objects that apply Region-specific settings for the deployment of * the image to targeted Regions.

* @public */ distributions?: Distribution[] | undefined; /** *

The maximum duration in minutes for this distribution configuration.

* @public */ timeoutMinutes: number | undefined; /** *

The date on which this distribution configuration was created.

* @public */ dateCreated?: string | undefined; /** *

The date on which this distribution configuration was last updated.

* @public */ dateUpdated?: string | undefined; /** *

The tags of the distribution configuration.

* @public */ tags?: Record | undefined; } /** *

A high-level overview of a distribution configuration.

* @public */ export interface DistributionConfigurationSummary { /** *

The Amazon Resource Name (ARN) of the distribution configuration.

* @public */ arn?: string | undefined; /** *

The name of the distribution configuration.

* @public */ name?: string | undefined; /** *

The description of the distribution configuration.

* @public */ description?: string | undefined; /** *

The date on which the distribution configuration was created.

* @public */ dateCreated?: string | undefined; /** *

The date on which the distribution configuration was updated.

* @public */ dateUpdated?: string | undefined; /** *

The tags associated with the distribution configuration.

* @public */ tags?: Record | undefined; /** *

A list of Regions where the container image is distributed to.

* @public */ regions?: string[] | undefined; } /** *

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.

* @public */ export interface Filter { /** *

The name of the filter. Filter names are case-sensitive.

* @public */ name?: string | undefined; /** *

The filter values. Filter values are case-sensitive.

* @public */ values?: string[] | undefined; } /** * @public */ export interface GetComponentRequest { /** *

The Amazon Resource Name (ARN) of the component that you want to get. Regex requires * the suffix /\d+$.

* @public */ componentBuildVersionArn: string | undefined; } /** * @public */ export interface GetComponentResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The component object specified in the request.

* @public */ component?: Component | undefined; /** *

The resource ARNs with different wildcard variations of semantic versioning.

* @public */ latestVersionReferences?: LatestVersionReferences | undefined; } /** * @public */ export interface GetComponentPolicyRequest { /** *

The Amazon Resource Name (ARN) of the component whose policy you want to * retrieve.

* @public */ componentArn: string | undefined; } /** * @public */ export interface GetComponentPolicyResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The component policy.

* @public */ policy?: string | undefined; } /** * @public */ export interface GetContainerRecipeRequest { /** *

The Amazon Resource Name (ARN) of the container recipe to retrieve.

* @public */ containerRecipeArn: string | undefined; } /** * @public */ export interface GetContainerRecipeResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The container recipe object that is returned.

* @public */ containerRecipe?: ContainerRecipe | undefined; /** *

The resource ARNs with different wildcard variations of semantic versioning.

* @public */ latestVersionReferences?: LatestVersionReferences | undefined; } /** * @public */ export interface GetContainerRecipePolicyRequest { /** *

The Amazon Resource Name (ARN) of the container recipe for the policy being * requested.

* @public */ containerRecipeArn: string | undefined; } /** * @public */ export interface GetContainerRecipePolicyResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The container recipe policy object that is returned.

* @public */ policy?: string | undefined; } /** * @public */ export interface GetDistributionConfigurationRequest { /** *

The Amazon Resource Name (ARN) of the distribution configuration that you want to * retrieve.

* @public */ distributionConfigurationArn: string | undefined; } /** * @public */ export interface GetDistributionConfigurationResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The distribution configuration object.

* @public */ distributionConfiguration?: DistributionConfiguration | undefined; } /** * @public */ export interface GetImageRequest { /** *

The Amazon Resource Name (ARN) of the image that you want to get.

* @public */ imageBuildVersionArn: string | undefined; } /** *

An image recipe.

* @public */ export interface ImageRecipe { /** *

The Amazon Resource Name (ARN) of the image recipe.

* @public */ arn?: string | undefined; /** *

Specifies which type of image is created by the recipe - an AMI or a container * image.

* @public */ type?: ImageType | undefined; /** *

The name of the image recipe.

* @public */ name?: string | undefined; /** *

The description of the image recipe.

* @public */ description?: string | undefined; /** *

The platform of the image recipe.

* @public */ platform?: Platform | undefined; /** *

The owner of the image recipe.

* @public */ owner?: string | undefined; /** *

The version of the image recipe.

* @public */ version?: string | undefined; /** *

The components that are included in the image recipe. Recipes require a minimum of one build component, and can * have a maximum of 20 build and test components in any combination.

* @public */ components?: ComponentConfiguration[] | undefined; /** *

The base image for customizations specified in the image recipe. You can specify the * parent image using one of the following options:

*
    *
  • *

    AMI ID

    *
    • *
  • *

    Image Builder image Amazon Resource Name (ARN)

    *
    • *
  • *

    Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, * followed by the parameter name or ARN.

    *
    • *
  • *

    Amazon Web Services Marketplace product ID

    *
    • *
* @public */ parentImage?: string | undefined; /** *

The block device mappings to apply when creating images from this recipe.

* @public */ blockDeviceMappings?: InstanceBlockDeviceMapping[] | undefined; /** *

The date on which this image recipe was created.

* @public */ dateCreated?: string | undefined; /** *

The tags of the image recipe.

* @public */ tags?: Record | undefined; /** *

The working directory to be used during build and test workflows.

* @public */ workingDirectory?: string | undefined; /** *

Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test * your image configuration. Instance configuration adds a layer of control over those * instances. You can define settings and add scripts to run when an instance is launched * from your AMI.

* @public */ additionalInstanceConfiguration?: AdditionalInstanceConfiguration | undefined; /** *

Tags that are applied to the AMI that Image Builder creates during the Build phase * prior to image distribution.

* @public */ amiTags?: Record | undefined; } /** *

Details of the infrastructure configuration.

* @public */ export interface InfrastructureConfiguration { /** *

The Amazon Resource Name (ARN) of the infrastructure configuration.

* @public */ arn?: string | undefined; /** *

The name of the infrastructure configuration.

* @public */ name?: string | undefined; /** *

The description of the infrastructure configuration.

* @public */ description?: string | undefined; /** *

The instance types of the infrastructure configuration.

* @public */ instanceTypes?: string[] | undefined; /** *

The instance profile of the infrastructure configuration.

* @public */ instanceProfileName?: string | undefined; /** *

The security group IDs of the infrastructure configuration.

* @public */ securityGroupIds?: string[] | undefined; /** *

The subnet ID of the infrastructure configuration.

* @public */ subnetId?: string | undefined; /** *

The logging configuration of the infrastructure configuration.

* @public */ logging?: Logging | undefined; /** *

The Amazon EC2 key pair of the infrastructure configuration.

* @public */ keyPair?: string | undefined; /** *

The terminate instance on failure configuration of the infrastructure * configuration.

* @public */ terminateInstanceOnFailure?: boolean | undefined; /** *

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event * notifications.

* *

EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys * from other accounts. The key that is used to encrypt the SNS topic must reside in the * account that the Image Builder service runs under.

* * @public */ snsTopicArn?: string | undefined; /** *

The date on which the infrastructure configuration was created.

* @public */ dateCreated?: string | undefined; /** *

The date on which the infrastructure configuration was last updated.

* @public */ dateUpdated?: string | undefined; /** *

The tags attached to the resource created by Image Builder.

* @public */ resourceTags?: Record | undefined; /** *

The instance metadata option settings for the infrastructure configuration.

* @public */ instanceMetadataOptions?: InstanceMetadataOptions | undefined; /** *

The tags of the infrastructure configuration.

* @public */ tags?: Record | undefined; /** *

The instance placement settings that define where the instances that are launched * from your image will run.

* @public */ placement?: Placement | undefined; } /** *

The resources produced by this image.

* @public */ export interface OutputResources { /** *

The Amazon EC2 AMIs created by this image.

* @public */ amis?: Ami[] | undefined; /** *

Container images that the pipeline has generated and stored in the output * repository.

* @public */ containers?: Container[] | undefined; } /** *

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

* @public */ export interface ImageScanState { /** *

The current state of vulnerability scans for the image.

* @public */ status?: ImageScanStatus | undefined; /** *

The reason for the scan status for the image.

* @public */ reason?: string | undefined; } /** *

An Image Builder image resource that keeps track of all of the settings used to create, configure, * and distribute output for that 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.

* @public */ export interface Image { /** *

The Amazon Resource Name (ARN) of the image.

* *

Semantic versioning is included in each object's Amazon Resource Name (ARN), * at the level that applies to that object as follows:

*
    *
  1. *

    Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are * either left off entirely, or they are specified as wildcards, for example: x.x.x.

    *
    2. *
  2. *

    Version ARNs have only the first three nodes: ..

    *
    3. *
  3. *

    Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

    *
    4. *
* * @public */ arn?: string | undefined; /** *

Specifies whether this image produces an AMI or a container image.

* @public */ type?: ImageType | undefined; /** *

The name of the image.

* @public */ name?: string | undefined; /** *

The semantic version of the image.

* *

The semantic version has four nodes: ../. * You can assign values for the first three, and can filter on all of them.

*

* Assignment: For the first three nodes you can assign any positive integer value, including * zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the * build number to the fourth node.

*

* Patterns: You can use any numeric pattern that adheres to the assignment requirements for * the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or * a date, such as 2021.01.01.

*

* 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.

* * @public */ version?: string | undefined; /** *

The image operating system platform, such as Linux or Windows.

* @public */ platform?: Platform | undefined; /** *

Indicates whether Image Builder collects additional information about the image, such as * the operating system (OS) version and package list.

* @public */ enhancedImageMetadataEnabled?: boolean | undefined; /** *

The operating system version for instances that launch from this image. For example, * Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

* @public */ osVersion?: string | undefined; /** *

The state of the image.

* @public */ state?: ImageState | undefined; /** *

For images that distribute an AMI, this is the image recipe that Image Builder used to * create the image. For container images, this is empty.

* @public */ imageRecipe?: ImageRecipe | undefined; /** *

For container images, this is the container recipe that Image Builder used to create the * image. For images that distribute an AMI, this is empty.

* @public */ containerRecipe?: ContainerRecipe | undefined; /** *

The name of the image pipeline that created this image.

* @public */ sourcePipelineName?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image pipeline that created this image.

* @public */ sourcePipelineArn?: string | undefined; /** *

The infrastructure that Image Builder used to create this image.

* @public */ infrastructureConfiguration?: InfrastructureConfiguration | undefined; /** *

The distribution configuration that Image Builder used to create this image.

* @public */ distributionConfiguration?: DistributionConfiguration | undefined; /** *

The image tests that ran when that Image Builder created this image.

* @public */ imageTestsConfiguration?: ImageTestsConfiguration | undefined; /** *

The date on which Image Builder created this image.

* @public */ dateCreated?: string | undefined; /** *

The output resources that Image Builder produces for this image.

* @public */ outputResources?: OutputResources | undefined; /** *

The tags that apply to this image.

* @public */ tags?: Record | undefined; /** *

Indicates the type of build that created this image. The build can be initiated in the * following ways:

*
    *
  • *

    * USER_INITIATED – A manual * pipeline build request.

    *
    • *
  • *

    * SCHEDULED – A pipeline build * initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

    *
    • *
  • *

    * IMPORT – A VM import created * the image to use as the base image for the recipe.

    *
    • *
  • *

    * IMPORT_ISO – An ISO disk import created * the image.

    *
    • *
* @public */ buildType?: BuildType | undefined; /** *

The origin of the base image that Image Builder used to build this image.

* @public */ imageSource?: ImageSource | undefined; /** *

Contains information about the current state of scans for this image.

* @public */ scanState?: ImageScanState | undefined; /** *

Contains settings for vulnerability scans.

* @public */ imageScanningConfiguration?: ImageScanningConfiguration | undefined; /** *

The time when deprecation occurs for an image resource. This can be a past or future date.

* @public */ deprecationTime?: Date | undefined; /** *

Identifies the last runtime instance of the lifecycle policy to take action on the image.

* @public */ lifecycleExecutionId?: string | undefined; /** *

The name or Amazon Resource Name (ARN) for the IAM role you create that grants * Image Builder access to perform workflow actions.

* @public */ executionRole?: string | undefined; /** *

Contains the build and test workflows that are associated with the image.

* @public */ workflows?: WorkflowConfiguration[] | undefined; /** *

The logging configuration that's defined for the image. Image Builder uses the defined settings * to direct execution log output during image creation.

* @public */ loggingConfiguration?: ImageLoggingConfiguration | undefined; } /** * @public */ export interface GetImageResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The image object.

* @public */ image?: Image | undefined; /** *

The resource ARNs with different wildcard variations of semantic versioning.

* @public */ latestVersionReferences?: LatestVersionReferences | undefined; } /** * @public */ export interface GetImagePipelineRequest { /** *

The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.

* @public */ imagePipelineArn: string | undefined; } /** *

Details of an image pipeline.

* @public */ export interface ImagePipeline { /** *

The Amazon Resource Name (ARN) of the image pipeline.

* @public */ arn?: string | undefined; /** *

The name of the image pipeline.

* @public */ name?: string | undefined; /** *

The description of the image pipeline.

* @public */ description?: string | undefined; /** *

The platform of the image pipeline.

* @public */ platform?: Platform | undefined; /** *

Collects additional information about the image being created, including the operating * system (OS) version and package list. This information is used to enhance the overall * experience of using EC2 Image Builder. Enabled by default.

* @public */ enhancedImageMetadataEnabled?: boolean | undefined; /** *

The Amazon Resource Name (ARN) of the image recipe associated with this image * pipeline.

* @public */ imageRecipeArn?: string | undefined; /** *

The Amazon Resource Name (ARN) of the container recipe that is used for this * pipeline.

* @public */ containerRecipeArn?: string | undefined; /** *

The Amazon Resource Name (ARN) of the infrastructure configuration associated with * this image pipeline.

* @public */ infrastructureConfigurationArn?: string | undefined; /** *

The Amazon Resource Name (ARN) of the distribution configuration associated with this * image pipeline.

* @public */ distributionConfigurationArn?: string | undefined; /** *

The image tests configuration of the image pipeline.

* @public */ imageTestsConfiguration?: ImageTestsConfiguration | undefined; /** *

The schedule of the image pipeline.

* @public */ schedule?: Schedule | undefined; /** *

The status of the image pipeline.

* @public */ status?: PipelineStatus | undefined; /** *

The date on which this image pipeline was created.

* @public */ dateCreated?: string | undefined; /** *

The date on which this image pipeline was last updated.

* @public */ dateUpdated?: string | undefined; /** *

This is no longer supported, and does not return a value.

* @public */ dateLastRun?: string | undefined; /** *

The status of the last image that this pipeline built, such as * BUILDING, TESTING, FAILED, * or AVAILABLE.

* @public */ lastRunStatus?: ImageStatus | undefined; /** *

The next date when the pipeline is scheduled to run.

* @public */ dateNextRun?: string | undefined; /** *

The tags of this image pipeline.

* @public */ tags?: Record | undefined; /** *

Contains settings for vulnerability scans.

* @public */ imageScanningConfiguration?: ImageScanningConfiguration | undefined; /** *

The tags to be applied to the images produced by this pipeline.

* @public */ imageTags?: Record | undefined; /** *

The name or Amazon Resource Name (ARN) for the IAM role you create that grants * Image Builder access to perform workflow actions.

* @public */ executionRole?: string | undefined; /** *

Contains the workflows that run for the image pipeline.

* @public */ workflows?: WorkflowConfiguration[] | undefined; /** *

Defines logging configuration for the output image.

* @public */ loggingConfiguration?: PipelineLoggingConfiguration | undefined; /** *

Image Builder tracks the number of consecutive failures for scheduled pipeline * executions and takes one of the following actions each time it runs on a schedule:

*
    *
  • *

    If the pipeline execution is successful, the number of consecutive * failures resets to zero.

    *
    • *
  • *

    If the pipeline execution fails, Image Builder increments the number of * consecutive failures. If the failure count exceeds the limit defined in the * AutoDisablePolicy, Image Builder disables the pipeline.

    *
    • *
*

The consecutive failure count is also reset to zero under the following * conditions:

*
    *
  • *

    The pipeline runs manually and succeeds.

    *
    • *
  • *

    The pipeline configuration is updated.

    *
    • *
*

If the pipeline runs manually and fails, the count remains the same. The next * scheduled run continues to increment where it left off before.

* @public */ consecutiveFailures?: number | undefined; } /** * @public */ export interface GetImagePipelineResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The image pipeline object.

* @public */ imagePipeline?: ImagePipeline | undefined; } /** * @public */ export interface GetImagePolicyRequest { /** *

The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.

* @public */ imageArn: string | undefined; } /** * @public */ export interface GetImagePolicyResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The image policy object.

* @public */ policy?: string | undefined; } /** * @public */ export interface GetImageRecipeRequest { /** *

The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.

* @public */ imageRecipeArn: string | undefined; } /** * @public */ export interface GetImageRecipeResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The image recipe object.

* @public */ imageRecipe?: ImageRecipe | undefined; /** *

The resource ARNs with different wildcard variations of semantic versioning.

* @public */ latestVersionReferences?: LatestVersionReferences | undefined; } /** * @public */ export interface GetImageRecipePolicyRequest { /** *

The Amazon Resource Name (ARN) of the image recipe whose policy you want to * retrieve.

* @public */ imageRecipeArn: string | undefined; } /** * @public */ export interface GetImageRecipePolicyResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The image recipe policy object.

* @public */ policy?: string | undefined; } /** *

GetInfrastructureConfiguration request object.

* @public */ export interface GetInfrastructureConfigurationRequest { /** *

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to * retrieve.

* @public */ infrastructureConfigurationArn: string | undefined; } /** *

GetInfrastructureConfiguration response object.

* @public */ export interface GetInfrastructureConfigurationResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The infrastructure configuration object.

* @public */ infrastructureConfiguration?: InfrastructureConfiguration | undefined; } /** * @public */ export interface GetLifecycleExecutionRequest { /** *

Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details.

* @public */ lifecycleExecutionId: string | undefined; } /** *

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

* @public */ export interface LifecycleExecutionResourcesImpactedSummary { /** *

Indicates whether an image resource that was identified for a lifecycle action has * associated resources that are also impacted.

* @public */ hasImpactedResources?: boolean | undefined; } /** *

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

* @public */ export interface LifecycleExecutionState { /** *

The runtime status of the lifecycle execution.

* @public */ status?: LifecycleExecutionStatus | undefined; /** *

The reason for the current status.

* @public */ reason?: string | undefined; } /** *

Contains metadata from a runtime instance of a lifecycle policy.

* @public */ export interface LifecycleExecution { /** *

Identifies the lifecycle policy runtime instance.

* @public */ lifecycleExecutionId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the lifecycle policy that ran.

* @public */ lifecyclePolicyArn?: string | undefined; /** *

Contains information about associated resources that are identified for action by * the runtime instance of the lifecycle policy.

* @public */ resourcesImpactedSummary?: LifecycleExecutionResourcesImpactedSummary | undefined; /** *

Runtime state that reports if the policy action ran successfully, * failed, or was skipped.

* @public */ state?: LifecycleExecutionState | undefined; /** *

The timestamp when the lifecycle runtime instance started.

* @public */ startTime?: Date | undefined; /** *

The timestamp when the lifecycle runtime instance completed.

* @public */ endTime?: Date | undefined; } /** * @public */ export interface GetLifecycleExecutionResponse { /** *

Runtime details for the specified runtime instance of the lifecycle policy.

* @public */ lifecycleExecution?: LifecycleExecution | undefined; } /** * @public */ export interface GetLifecyclePolicyRequest { /** *

Specifies the Amazon Resource Name (ARN) of the image lifecycle policy resource to get.

* @public */ lifecyclePolicyArn: string | undefined; } /** *

The configuration details for a lifecycle policy resource.

* @public */ export interface LifecyclePolicy { /** *

The Amazon Resource Name (ARN) of the lifecycle policy resource.

* @public */ arn?: string | undefined; /** *

The name of the lifecycle policy.

* @public */ name?: string | undefined; /** *

Optional description for the lifecycle policy.

* @public */ description?: string | undefined; /** *

Indicates whether the lifecycle policy resource is enabled.

* @public */ status?: LifecyclePolicyStatus | undefined; /** *

The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy. * This is a custom role that you create.

* @public */ executionRole?: string | undefined; /** *

The type of resources the lifecycle policy targets.

* @public */ resourceType?: LifecyclePolicyResourceType | undefined; /** *

The configuration details for a lifecycle policy resource.

* @public */ policyDetails?: LifecyclePolicyDetail[] | undefined; /** *

Resource selection criteria used to run the lifecycle policy.

* @public */ resourceSelection?: LifecyclePolicyResourceSelection | undefined; /** *

The timestamp when Image Builder created the lifecycle policy resource.

* @public */ dateCreated?: Date | undefined; /** *

The timestamp when Image Builder updated the lifecycle policy resource.

* @public */ dateUpdated?: Date | undefined; /** *

The timestamp for the last time Image Builder ran the lifecycle policy.

* @public */ dateLastRun?: Date | undefined; /** *

To help manage your lifecycle policy resources, you can assign your own * metadata to each resource in the form of tags. Each tag consists of a key and * an optional value, both of which you define.

* @public */ tags?: Record | undefined; } /** * @public */ export interface GetLifecyclePolicyResponse { /** *

The Amazon Resource Name (ARN) of the image lifecycle policy resource that was returned.

* @public */ lifecyclePolicy?: LifecyclePolicy | undefined; } /** * @public */ export interface GetMarketplaceResourceRequest { /** *

Specifies which type of Amazon Web Services Marketplace resource Image Builder retrieves.

* @public */ resourceType: MarketplaceResourceType | undefined; /** *

The Amazon Resource Name (ARN) that uniquely identifies an Amazon Web Services Marketplace resource.

* @public */ resourceArn: string | undefined; /** *

The bucket path that you can specify to download the resource from Amazon S3.

* @public */ resourceLocation?: string | undefined; } /** * @public */ export interface GetMarketplaceResourceResponse { /** *

The Amazon Resource Name (ARN) for the Amazon Web Services Marketplace resource that was requested.

* @public */ resourceArn?: string | undefined; /** *

The obfuscated S3 URL to download the component artifact from.

* @public */ url?: string | undefined; /** *

Returns obfuscated data that contains the YAML content of the component.

* @public */ data?: string | undefined; } /** * @public */ export interface GetWorkflowRequest { /** *

The Amazon Resource Name (ARN) of the workflow resource that you want to get.

* @public */ workflowBuildVersionArn: string | undefined; } /** *

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

* @public */ export interface WorkflowParameterDetail { /** *

The name of this input parameter.

* @public */ name: string | undefined; /** *

The type of input this parameter provides. The currently supported value is * "string".

* @public */ type: string | undefined; /** *

The default value of this parameter if no input is provided.

* @public */ defaultValue?: string[] | undefined; /** *

Describes this parameter.

* @public */ description?: string | undefined; } /** *

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

* @public */ export interface WorkflowState { /** *

The current state of the workflow.

* @public */ status?: WorkflowStatus | undefined; /** *

Describes how or why the workflow changed state.

* @public */ reason?: string | undefined; } /** *

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

* @public */ export interface Workflow { /** *

The Amazon Resource Name (ARN) of the workflow resource.

* @public */ arn?: string | undefined; /** *

The name of the workflow resource.

* @public */ name?: string | undefined; /** *

The workflow resource version. Workflow resources are immutable. * To make a change, you can clone a workflow or create a new version.

* @public */ version?: string | undefined; /** *

The description of the workflow.

* @public */ description?: string | undefined; /** *

Describes what change has been made in this version of the workflow, or * what makes this version different from other versions of the workflow.

* @public */ changeDescription?: string | undefined; /** *

Specifies the image creation stage that the workflow applies to. Image Builder * currently supports build and test workflows.

* @public */ type?: WorkflowType | undefined; /** *

Describes the current status of the workflow and the reason for * that status.

* @public */ state?: WorkflowState | undefined; /** *

The owner of the workflow resource.

* @public */ owner?: string | undefined; /** *

Contains the YAML document content for the workflow.

* @public */ data?: string | undefined; /** *

The KMS key identifier used to encrypt the workflow resource. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) * in the Key Management Service Developer Guide.

* @public */ kmsKeyId?: string | undefined; /** *

The timestamp when Image Builder created the workflow resource.

* @public */ dateCreated?: string | undefined; /** *

The tags that apply to the workflow resource

* @public */ tags?: Record | undefined; /** *

An array of input parameters that that the image workflow uses * to control actions or configure settings.

* @public */ parameters?: WorkflowParameterDetail[] | undefined; } /** * @public */ export interface GetWorkflowResponse { /** *

The workflow resource specified in the request.

* @public */ workflow?: Workflow | undefined; /** *

The resource ARNs with different wildcard variations of semantic versioning.

* @public */ latestVersionReferences?: LatestVersionReferences | undefined; } /** * @public */ export interface GetWorkflowExecutionRequest { /** *

Use the unique identifier for a runtime instance of the workflow to get * runtime details.

* @public */ workflowExecutionId: string | undefined; } /** * @public */ export interface GetWorkflowExecutionResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource * that defines the specified runtime instance of the workflow.

* @public */ workflowBuildVersionArn?: string | undefined; /** *

The unique identifier that Image Builder assigned to keep track of runtime details * when it ran the workflow.

* @public */ workflowExecutionId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image resource build version that the specified * runtime instance of the workflow created.

* @public */ imageBuildVersionArn?: string | undefined; /** *

The type of workflow that Image Builder ran for the specified runtime instance of the workflow.

* @public */ type?: WorkflowType | undefined; /** *

The current runtime status for the specified runtime instance of the workflow.

* @public */ status?: WorkflowExecutionStatus | undefined; /** *

The output message from the specified runtime instance of the workflow, if applicable.

* @public */ message?: string | undefined; /** *

The total number of steps in the specified runtime instance of the workflow that ran. * This number should equal the sum of the step counts for steps that succeeded, were skipped, * and failed.

* @public */ totalStepCount?: number | undefined; /** *

A runtime count for the number of steps that ran successfully in the specified runtime * instance of the workflow.

* @public */ totalStepsSucceeded?: number | undefined; /** *

A runtime count for the number of steps that failed in the specified runtime instance * of the workflow.

* @public */ totalStepsFailed?: number | undefined; /** *

A runtime count for the number of steps that were skipped in the specified runtime * instance of the workflow.

* @public */ totalStepsSkipped?: number | undefined; /** *

The timestamp when the specified runtime instance of the workflow started.

* @public */ startTime?: string | undefined; /** *

The timestamp when the specified runtime instance of the workflow finished.

* @public */ endTime?: string | undefined; /** *

Test workflows are defined within named runtime groups. The parallel group * is a named group that contains one or more test workflows.

* @public */ parallelGroup?: string | undefined; } /** * @public */ export interface GetWorkflowStepExecutionRequest { /** *

Use the unique identifier for a specific runtime instance of the workflow step to * get runtime details for that step.

* @public */ stepExecutionId: string | undefined; } /** * @public */ export interface GetWorkflowStepExecutionResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The unique identifier for the runtime version of the workflow step that you specified * in the request.

* @public */ stepExecutionId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource * that defines this workflow step.

* @public */ workflowBuildVersionArn?: string | undefined; /** *

The unique identifier that Image Builder assigned to keep track of runtime details * when it ran the workflow.

* @public */ workflowExecutionId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image resource build version that the specified * runtime instance of the workflow step creates.

* @public */ imageBuildVersionArn?: string | undefined; /** *

The name of the specified runtime instance of the workflow step.

* @public */ name?: string | undefined; /** *

Describes the specified workflow step.

* @public */ description?: string | undefined; /** *

The name of the action that the specified step performs.

* @public */ action?: string | undefined; /** *

The current status for the specified runtime version of the workflow step.

* @public */ status?: WorkflowStepExecutionStatus | undefined; /** *

Reports on the rollback status of the specified runtime version of the workflow step, * if applicable.

* @public */ rollbackStatus?: WorkflowStepExecutionRollbackStatus | undefined; /** *

The output message from the specified runtime instance of the workflow step, if applicable.

* @public */ message?: string | undefined; /** *

Input parameters that Image Builder provided for the specified runtime instance of * the workflow step.

* @public */ inputs?: string | undefined; /** *

The file names that the specified runtime version of the workflow step created as output.

* @public */ outputs?: string | undefined; /** *

The timestamp when the specified runtime version of the workflow step started.

* @public */ startTime?: string | undefined; /** *

The timestamp when the specified runtime instance of the workflow step finished.

* @public */ endTime?: string | undefined; /** *

The action to perform if the workflow step fails.

* @public */ onFailure?: string | undefined; /** *

The maximum duration in seconds for this step to complete its action.

* @public */ timeoutSeconds?: number | undefined; } /** *

Contains vulnerability counts for a specific image.

* @public */ export interface ImageAggregation { /** *

The Amazon Resource Name (ARN) that identifies the image for this aggregation.

* @public */ imageBuildVersionArn?: string | undefined; /** *

Counts by severity level for medium severity and higher level findings, plus a total * for all of the findings for the specified image.

* @public */ severityCounts?: SeverityCounts | undefined; } /** * @public */ export interface ImportComponentRequest { /** *

The name of the component.

* @public */ name: string | undefined; /** *

The semantic version of the component. This version follows the semantic version * syntax.

* *

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.

* * @public */ semanticVersion: string | undefined; /** *

The description of the component. Describes the contents of the component.

* @public */ description?: string | undefined; /** *

The change description of the component. This description indicates the change that * has been made in this version, or what makes this version different from other versions * of the component.

* @public */ changeDescription?: string | undefined; /** *

The type of the component denotes whether the component is used to build the image, or * only to test it.

* @public */ type: ComponentType | undefined; /** *

The format of the resource that you want to import as a component.

* @public */ format: ComponentFormat | undefined; /** *

The platform of the component.

* @public */ platform: Platform | undefined; /** *

The data of the component. Used to specify the data inline. Either data * or uri can be used to specify the data within the component.

* @public */ data?: string | undefined; /** *

The uri of the component. Must be an Amazon S3 URL and the requester must have permission * to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your * service quota. Either data or uri can be used to specify the * data within the component.

* @public */ uri?: string | undefined; /** *

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) * in the Key Management Service Developer Guide.

* @public */ kmsKeyId?: string | undefined; /** *

The tags of the component.

* @public */ tags?: Record | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface ImportComponentResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the imported component.

* @public */ componentBuildVersionArn?: string | undefined; } /** *

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 * .

* @public */ export interface RegisterImageOptions { /** *

Specifies whether Secure Boot is enabled for the output AMI. * The default value is true. To disable Secure Boot * for custom unsigned drivers, set this value to false.

* @public */ secureBootEnabled?: boolean | undefined; /** *

A Base64-encoded representation of the non-volatile UEFI variable store. * You can specify this parameter only when * secureBootEnabled is true or * unspecified. You can inspect and modify the UEFI data by using * the python-uefivars tool on GitHub.

*

For more information, see UEFI * variables for Amazon EC2 instances.

* @public */ uefiData?: string | undefined; } /** *

Windows-specific configuration settings for an ISO import, including * the edition to install from a multi-edition Windows ISO file.

* @public */ export interface WindowsConfiguration { /** *

The 1-based index that specifies which Windows edition to install * from a multi-edition Windows ISO file. A Windows ISO can contain a * .wim file with multiple image indexes, each representing * a different edition.

* @public */ imageIndex: number | undefined; } /** * @public */ export interface ImportDiskImageRequest { /** *

The name of the image resource that's created from the import.

* @public */ name: string | undefined; /** *

The semantic version to attach to the image that's created during the import * process. This version follows the semantic version syntax.

* @public */ semanticVersion: string | undefined; /** *

The description for your disk image import.

* @public */ description?: string | undefined; /** *

The operating system platform for the imported image. Allowed values include * the following: Windows.

* @public */ platform: string | undefined; /** *

The operating system version for the imported image. Allowed values include * the following: Microsoft Windows 11.

* @public */ osVersion: string | undefined; /** *

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access * to perform workflow actions to import an image from a Microsoft ISO file.

* @public */ executionRole?: string | undefined; /** *

The Amazon Resource Name (ARN) of the infrastructure configuration resource that's used for * launching the EC2 instance on which the ISO image is built.

* @public */ infrastructureConfigurationArn: string | undefined; /** *

The uri of the ISO disk file that's stored in Amazon S3.

* @public */ uri: string | undefined; /** *

Define logging configuration for the image build process.

* @public */ loggingConfiguration?: ImageLoggingConfiguration | undefined; /** *

Tags that are attached to image resources created from the import.

* @public */ tags?: Record | undefined; /** *

Configures Secure Boot and UEFI settings for the * imported image.

* @public */ registerImageOptions?: RegisterImageOptions | undefined; /** *

Specifies Windows settings for ISO imports.

* @public */ windowsConfiguration?: WindowsConfiguration | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface ImportDiskImageResponse { /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the output AMI that was created from the ISO disk file.

* @public */ imageBuildVersionArn?: string | undefined; } /** * @public */ export interface ImportVmImageRequest { /** *

The name of the base image that is created by the import process.

* @public */ name: string | undefined; /** *

The semantic version to attach to the base image that was created during the import * process. This version follows the semantic version syntax.

* *

The semantic version has four nodes: ../. * You can assign values for the first three, and can filter on all of them.

*

* Assignment: For the first three nodes you can assign any positive integer value, including * zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the * build number to the fourth node.

*

* Patterns: You can use any numeric pattern that adheres to the assignment requirements for * the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or * a date, such as 2021.01.01.

* * @public */ semanticVersion: string | undefined; /** *

The description for the base image that is created by the import process.

* @public */ description?: string | undefined; /** *

The operating system platform for the imported VM.

* @public */ platform: Platform | undefined; /** *

The operating system version for the imported VM.

* @public */ osVersion?: string | undefined; /** *

The importTaskId (API) or ImportTaskId (CLI) from the * Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in * the AMI that is created from the VM source as the base image for your recipe.

* @public */ vmImportTaskId: string | undefined; /** *

Define logging configuration for the image build process.

* @public */ loggingConfiguration?: ImageLoggingConfiguration | undefined; /** *

Tags that are attached to the import resources.

* @public */ tags?: Record | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface ImportVmImageResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the AMI that was created during the VM import * process. This AMI is used as the base image for the recipe that imported the VM.

* @public */ imageArn?: string | undefined; /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface ListComponentBuildVersionsRequest { /** *

The component version Amazon Resource Name (ARN) whose versions you want to * list.

* @public */ componentVersionArn?: string | undefined; /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListComponentBuildVersionsResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The list of component summaries for the specified semantic version.

* @public */ componentSummaryList?: ComponentSummary[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListComponentsRequest { /** *

Filters results based on the type of owner for the component. By default, this request * returns a list of components that your account owns. To see results for other types of * owners, you can specify components that Amazon manages, third party components, or * components that other accounts have shared with you.

* @public */ owner?: Ownership | undefined; /** *

Use the following filters to streamline results:

*
    *
  • *

    * description *

    *
    • *
  • *

    * name *

    *
    • *
  • *

    * platform *

    *
    • *
  • *

    * supportedOsVersion *

    *
    • *
  • *

    * type *

    *
    • *
  • *

    * version *

    *
    • *
* @public */ filters?: Filter[] | undefined; /** *

Returns the list of components for the specified name.

* @public */ byName?: boolean | undefined; /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListComponentsResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The list of component semantic versions.

* *

The semantic version has four nodes: ../. * You can assign values for the first three, and can filter on all of them.

* * @public */ componentVersionList?: ComponentVersion[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListContainerRecipesRequest { /** *

Returns container recipes belonging to the specified owner, that have been shared with * you. You can omit this field to return container recipes belonging to your * account.

* @public */ owner?: Ownership | undefined; /** *

Use the following filters to streamline results:

*
    *
  • *

    * containerType *

    *
    • *
  • *

    * name *

    *
    • *
  • *

    * parentImage *

    *
    • *
  • *

    * platform *

    *
    • *
* @public */ filters?: Filter[] | undefined; /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListContainerRecipesResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The list of container recipes returned for the request.

* @public */ containerRecipeSummaryList?: ContainerRecipeSummary[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListDistributionConfigurationsRequest { /** *

You can filter on name to streamline results.

* @public */ filters?: Filter[] | undefined; /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListDistributionConfigurationsResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The list of distributions.

* @public */ distributionConfigurationSummaryList?: DistributionConfigurationSummary[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListImageBuildVersionsRequest { /** *

The Amazon Resource Name (ARN) of the image whose build versions you want to * retrieve.

* @public */ imageVersionArn?: string | undefined; /** *

Use the following filters to streamline results:

*
    *
  • *

    * name *

    *
    • *
  • *

    * osVersion *

    *
    • *
  • *

    * platform *

    *
    • *
  • *

    * type *

    *
    • *
  • *

    * version *

    *
    • *
* @public */ filters?: Filter[] | undefined; /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** *

An image summary.

* @public */ export interface ImageSummary { /** *

The Amazon Resource Name (ARN) of the image.

* @public */ arn?: string | undefined; /** *

The name of the image.

* @public */ name?: string | undefined; /** *

Specifies whether this image produces an AMI or a container image.

* @public */ type?: ImageType | undefined; /** *

The version of the image.

* @public */ version?: string | undefined; /** *

The image operating system platform, such as Linux or Windows.

* @public */ platform?: Platform | undefined; /** *

The operating system version of the instances that launch from this image. For * example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

* @public */ osVersion?: string | undefined; /** *

The state of the image.

* @public */ state?: ImageState | undefined; /** *

The owner of the image.

* @public */ owner?: string | undefined; /** *

The date on which Image Builder created this image.

* @public */ dateCreated?: string | undefined; /** *

The output resources that Image Builder produced when it created this image.

* @public */ outputResources?: OutputResources | undefined; /** *

The tags that apply to this image.

* @public */ tags?: Record | undefined; /** *

Indicates the type of build that created this image. The build can be initiated in the * following ways:

*
    *
  • *

    * USER_INITIATED – A manual * pipeline build request.

    *
    • *
  • *

    * SCHEDULED – A pipeline build * initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

    *
    • *
  • *

    * IMPORT – A VM import created * the image to use as the base image for the recipe.

    *
    • *
  • *

    * IMPORT_ISO – An ISO disk import created * the image.

    *
    • *
* @public */ buildType?: BuildType | undefined; /** *

The origin of the base image that Image Builder used to build this image.

* @public */ imageSource?: ImageSource | undefined; /** *

The time when deprecation occurs for an image resource. This can be a past or future date.

* @public */ deprecationTime?: Date | undefined; /** *

Identifies the last runtime instance of the lifecycle policy to take action on the image.

* @public */ lifecycleExecutionId?: string | undefined; /** *

The logging configuration that's defined for the image.

* @public */ loggingConfiguration?: ImageLoggingConfiguration | undefined; } /** * @public */ export interface ListImageBuildVersionsResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The list of image build versions.

* @public */ imageSummaryList?: ImageSummary[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListImagePackagesRequest { /** *

Filter results for the ListImagePackages request by the Image Build Version ARN

* @public */ imageBuildVersionArn: string | undefined; /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** *

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

* @public */ export interface ImagePackage { /** *

The name of the package that's reported to the operating system package * manager.

* @public */ packageName?: string | undefined; /** *

The version of the package that's reported to the operating system package * manager.

* @public */ packageVersion?: string | undefined; } /** * @public */ export interface ListImagePackagesResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The list of Image Packages returned in the response.

* @public */ imagePackageList?: ImagePackage[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListImagePipelineImagesRequest { /** *

The Amazon Resource Name (ARN) of the image pipeline whose images you want to * view.

* @public */ imagePipelineArn: string | undefined; /** *

Use the following filters to streamline results:

*
    *
  • *

    * name *

    *
    • *
  • *

    * version *

    *
    • *
* @public */ filters?: Filter[] | undefined; /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListImagePipelineImagesResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The list of images built by this pipeline.

* @public */ imageSummaryList?: ImageSummary[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListImagePipelinesRequest { /** *

Use the following filters to streamline results:

*
    *
  • *

    * description *

    *
    • *
  • *

    * distributionConfigurationArn *

    *
    • *
  • *

    * imageRecipeArn *

    *
    • *
  • *

    * infrastructureConfigurationArn *

    *
    • *
  • *

    * name *

    *
    • *
  • *

    * status *

    *
    • *
* @public */ filters?: Filter[] | undefined; /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListImagePipelinesResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The list of image pipelines.

* @public */ imagePipelineList?: ImagePipeline[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListImageRecipesRequest { /** *

You can specify the recipe owner to filter results by that owner. By default, this request will * only show image recipes owned by your account. To filter by a different owner, specify one of the * Valid Values that are listed for this parameter.

* @public */ owner?: Ownership | undefined; /** *

Use the following filters to streamline results:

*
    *
  • *

    * name *

    *
    • *
  • *

    * parentImage *

    *
    • *
  • *

    * platform *

    *
    • *
* @public */ filters?: Filter[] | undefined; /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** *

A summary of an image recipe.

* @public */ export interface ImageRecipeSummary { /** *

The Amazon Resource Name (ARN) of the image recipe.

* @public */ arn?: string | undefined; /** *

The name of the image recipe.

* @public */ name?: string | undefined; /** *

The platform of the image recipe.

* @public */ platform?: Platform | undefined; /** *

The owner of the image recipe.

* @public */ owner?: string | undefined; /** *

The base image of the image recipe.

* @public */ parentImage?: string | undefined; /** *

The date on which this image recipe was created.

* @public */ dateCreated?: string | undefined; /** *

The tags of the image recipe.

* @public */ tags?: Record | undefined; } /** * @public */ export interface ListImageRecipesResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

A list of ImageRecipeSummary objects that contain identifying characteristics for the * image recipe, such as the name, the Amazon Resource Name (ARN), and the date created, along with other key details.

* @public */ imageRecipeSummaryList?: ImageRecipeSummary[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListImagesRequest { /** *

The owner defines which images you want to list. By default, this request will only * show images owned by your account. You can use this field to specify if you want to view * images owned by yourself, by Amazon, or those images that have been shared with you by * other customers.

* @public */ owner?: Ownership | undefined; /** *

Use the following filters to streamline results:

*
    *
  • *

    * name *

    *
    • *
  • *

    * osVersion *

    *
    • *
  • *

    * platform *

    *
    • *
  • *

    * type *

    *
    • *
  • *

    * version *

    *
    • *
* @public */ filters?: Filter[] | undefined; /** *

Requests a list of images with a specific recipe name.

* @public */ byName?: boolean | undefined; /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; /** *

Includes deprecated images in the response list.

* @public */ includeDeprecated?: boolean | undefined; } /** *

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

* @public */ export interface ImageVersion { /** *

The Amazon Resource Name (ARN) of a specific version of an Image Builder image.

* *

Semantic versioning is included in each object's Amazon Resource Name (ARN), * at the level that applies to that object as follows:

*
    *
  1. *

    Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are * either left off entirely, or they are specified as wildcards, for example: x.x.x.

    *
    2. *
  2. *

    Version ARNs have only the first three nodes: ..

    *
    3. *
  3. *

    Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

    *
    4. *
* * @public */ arn?: string | undefined; /** *

The name of this specific version of an Image Builder image.

* @public */ name?: string | undefined; /** *

Specifies whether this image produces an AMI or a container image.

* @public */ type?: ImageType | undefined; /** *

Details for a specific version of an Image Builder image. This version follows the semantic * version syntax.

* *

The semantic version has four nodes: ../. * You can assign values for the first three, and can filter on all of them.

*

* Assignment: For the first three nodes you can assign any positive integer value, including * zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the * build number to the fourth node.

*

* Patterns: You can use any numeric pattern that adheres to the assignment requirements for * the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or * a date, such as 2021.01.01.

*

* 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.

* * @public */ version?: string | undefined; /** *

The operating system platform of the image version, for example "Windows" or * "Linux".

* @public */ platform?: Platform | undefined; /** *

The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2, * Ubuntu 18, or Microsoft Windows Server 2019.

* @public */ osVersion?: string | undefined; /** *

The owner of the image version.

* @public */ owner?: string | undefined; /** *

The date on which this specific version of the Image Builder image was created.

* @public */ dateCreated?: string | undefined; /** *

Indicates the type of build that created this image. The build can be initiated in the * following ways:

*
    *
  • *

    * USER_INITIATED – A manual * pipeline build request.

    *
    • *
  • *

    * SCHEDULED – A pipeline build * initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

    *
    • *
  • *

    * IMPORT – A VM import created * the image to use as the base image for the recipe.

    *
    • *
  • *

    * IMPORT_ISO – An ISO disk import created * the image.

    *
    • *
* @public */ buildType?: BuildType | undefined; /** *

The origin of the base image that Image Builder used to build this image.

* @public */ imageSource?: ImageSource | undefined; } /** * @public */ export interface ListImagesResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The list of image semantic versions.

* *

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.

* * @public */ imageVersionList?: ImageVersion[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListImageScanFindingAggregationsRequest { /** *

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.

* @public */ filter?: Filter | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** *

Contains vulnerability counts for a specific image pipeline.

* @public */ export interface ImagePipelineAggregation { /** *

The Amazon Resource Name (ARN) that identifies the image pipeline for this * aggregation.

* @public */ imagePipelineArn?: string | undefined; /** *

Counts by severity level for medium severity and higher level findings, plus a total * for all of the findings for the specified image pipeline.

* @public */ severityCounts?: SeverityCounts | undefined; } /** *

Includes counts of image and pipeline resource findings by vulnerability.

* @public */ export interface VulnerabilityIdAggregation { /** *

The vulnerability Id for this set of counts.

* @public */ vulnerabilityId?: string | undefined; /** *

Counts by severity level for medium severity and higher level findings, plus a total * for all of the findings for the specified vulnerability.

* @public */ severityCounts?: SeverityCounts | undefined; } /** *

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

* @public */ export interface ImageScanFindingAggregation { /** *

Returns an object that contains severity counts based on an account ID.

* @public */ accountAggregation?: AccountAggregation | undefined; /** *

Returns an object that contains severity counts based on the Amazon Resource Name (ARN) for a specific image.

* @public */ imageAggregation?: ImageAggregation | undefined; /** *

Returns an object that contains severity counts based on an image pipeline ARN.

* @public */ imagePipelineAggregation?: ImagePipelineAggregation | undefined; /** *

Returns an object that contains severity counts based on vulnerability ID.

* @public */ vulnerabilityIdAggregation?: VulnerabilityIdAggregation | undefined; } /** * @public */ export interface ListImageScanFindingAggregationsResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The aggregation type specifies what type of key is used to group the image scan * findings. Image Builder returns results based on the request filter. If you didn't specify a * filter in the request, the type defaults to accountId.

*

* Aggregation types *

*
    *
  • *

    accountId

    *
    • *
  • *

    imageBuildVersionArn

    *
    • *
  • *

    imagePipelineArn

    *
    • *
  • *

    vulnerabilityId

    *
    • *
*

Each aggregation includes counts by severity level for medium severity and higher * level findings, plus a total for all of the findings for each key value.

* @public */ aggregationType?: string | undefined; /** *

An array of image scan finding aggregations that match the filter criteria.

* @public */ responses?: ImageScanFindingAggregation[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** *

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

* @public */ export interface ImageScanFindingsFilter { /** *

The name of the image scan finding filter. Filter names are case-sensitive.

* @public */ name?: string | undefined; /** *

The filter values. Filter values are case-sensitive.

* @public */ values?: string[] | undefined; } /** * @public */ export interface ListImageScanFindingsRequest { /** *

An array of name value pairs that you can use to filter your results. You can use the * following filters to streamline results:

*
    *
  • *

    * imageBuildVersionArn *

    *
    • *
  • *

    * imagePipelineArn *

    *
    • *
  • *

    * vulnerabilityId *

    *
    • *
  • *

    * severity *

    *
    • *
*

If you don't request a filter, then all findings in your account are listed.

* @public */ filters?: ImageScanFindingsFilter[] | undefined; /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** *

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

* @public */ export interface InspectorScoreDetails { /** *

An object that contains details about an adjustment that Amazon Inspector made to the CVSS score * for the finding.

* @public */ adjustedCvss?: CvssScoreDetails | undefined; } /** *

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

* @public */ export interface VulnerablePackage { /** *

The name of the vulnerable package.

* @public */ name?: string | undefined; /** *

The version of the vulnerable package.

* @public */ version?: string | undefined; /** *

The source layer hash of the vulnerable package.

* @public */ sourceLayerHash?: string | undefined; /** *

The epoch of the vulnerable package.

* @public */ epoch?: number | undefined; /** *

The release of the vulnerable package.

* @public */ release?: string | undefined; /** *

The architecture of the vulnerable package.

* @public */ arch?: string | undefined; /** *

The package manager of the vulnerable package.

* @public */ packageManager?: string | undefined; /** *

The file path of the vulnerable package.

* @public */ filePath?: string | undefined; /** *

The version of the package that contains the vulnerability fix.

* @public */ fixedInVersion?: string | undefined; /** *

The code to run in your environment to update packages with a fix available.

* @public */ remediation?: string | undefined; } /** *

Information about package vulnerability findings.

* @public */ export interface PackageVulnerabilityDetails { /** *

A unique identifier for this vulnerability.

* @public */ vulnerabilityId: string | undefined; /** *

The packages that this vulnerability impacts.

* @public */ vulnerablePackages?: VulnerablePackage[] | undefined; /** *

The source of the vulnerability information.

* @public */ source?: string | undefined; /** *

CVSS scores for one or more vulnerabilities that Amazon Inspector identified for a * package.

* @public */ cvss?: CvssScore[] | undefined; /** *

Vulnerabilities that are often related to the findings for the package.

* @public */ relatedVulnerabilities?: string[] | undefined; /** *

A link to the source of the vulnerability information.

* @public */ sourceUrl?: string | undefined; /** *

The severity that the vendor assigned to this vulnerability type.

* @public */ vendorSeverity?: string | undefined; /** *

The date and time when this vulnerability was first added to the vendor's * database.

* @public */ vendorCreatedAt?: Date | undefined; /** *

The date and time when the vendor last updated this vulnerability in their * database.

* @public */ vendorUpdatedAt?: Date | undefined; /** *

Links to web pages that contain details about the vulnerabilities that Amazon Inspector * identified for the package.

* @public */ referenceUrls?: string[] | undefined; } /** *

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

* @public */ export interface RemediationRecommendation { /** *

The recommended course of action to remediate the finding.

* @public */ text?: string | undefined; /** *

A link to more information about the recommended remediation for this * vulnerability.

* @public */ url?: string | undefined; } /** *

Information about how to remediate a finding.

* @public */ export interface Remediation { /** *

An object that contains information about the recommended course of action to * remediate the finding.

* @public */ recommendation?: RemediationRecommendation | undefined; } /** *

Contains details about a vulnerability scan finding.

* @public */ export interface ImageScanFinding { /** *

The Amazon Web Services account ID that's associated with the finding.

* @public */ awsAccountId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image build version that's associated with the * finding.

* @public */ imageBuildVersionArn?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image pipeline that's associated with the * finding.

* @public */ imagePipelineArn?: string | undefined; /** *

The type of the finding. Image Builder looks for findings of the type * PACKAGE_VULNERABILITY that apply to output images, and excludes other * types.

* @public */ type?: string | undefined; /** *

The description of the finding.

* @public */ description?: string | undefined; /** *

The title of the finding.

* @public */ title?: string | undefined; /** *

An object that contains the details about how to remediate the finding.

* @public */ remediation?: Remediation | undefined; /** *

The severity of the finding.

* @public */ severity?: string | undefined; /** *

The date and time when the finding was first observed.

* @public */ firstObservedAt?: Date | undefined; /** *

The timestamp when the finding was last updated.

* @public */ updatedAt?: Date | undefined; /** *

The score that Amazon Inspector assigned for the finding.

* @public */ inspectorScore?: number | undefined; /** *

An object that contains details of the Amazon Inspector score.

* @public */ inspectorScoreDetails?: InspectorScoreDetails | undefined; /** *

An object that contains the details of a package vulnerability finding.

* @public */ packageVulnerabilityDetails?: PackageVulnerabilityDetails | undefined; /** *

Details about whether a fix is available for any of the packages that are identified * in the finding through a version update.

* @public */ fixAvailable?: string | undefined; } /** * @public */ export interface ListImageScanFindingsResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The image scan findings for your account that meet your request filter * criteria.

* @public */ findings?: ImageScanFinding[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListInfrastructureConfigurationsRequest { /** *

You can filter on name to streamline results.

* @public */ filters?: Filter[] | undefined; /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** *

The infrastructure used when building Amazon EC2 AMIs.

* @public */ export interface InfrastructureConfigurationSummary { /** *

The Amazon Resource Name (ARN) of the infrastructure configuration.

* @public */ arn?: string | undefined; /** *

The name of the infrastructure configuration.

* @public */ name?: string | undefined; /** *

The description of the infrastructure configuration.

* @public */ description?: string | undefined; /** *

The date on which the infrastructure configuration was created.

* @public */ dateCreated?: string | undefined; /** *

The date on which the infrastructure configuration was last updated.

* @public */ dateUpdated?: string | undefined; /** *

The tags attached to the image created by Image Builder.

* @public */ resourceTags?: Record | undefined; /** *

The tags of the infrastructure configuration.

* @public */ tags?: Record | undefined; /** *

The instance types of the infrastructure configuration.

* @public */ instanceTypes?: string[] | undefined; /** *

The instance profile of the infrastructure configuration.

* @public */ instanceProfileName?: string | undefined; /** *

The instance placement settings that define where the instances that are launched * from your image will run.

* @public */ placement?: Placement | undefined; } /** * @public */ export interface ListInfrastructureConfigurationsResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The list of infrastructure configurations.

* @public */ infrastructureConfigurationSummaryList?: InfrastructureConfigurationSummary[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListLifecycleExecutionResourcesRequest { /** *

Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details.

* @public */ lifecycleExecutionId: string | undefined; /** *

You can leave this empty to get a list of Image Builder resources that were identified for lifecycle actions.

*

To get a list of associated resources that are impacted for an individual resource (the parent), specify * its Amazon Resource Name (ARN). Associated resources are produced from your image and distributed when you run a build, such as * AMIs or container images stored in ECR repositories.

* @public */ parentResourceId?: string | undefined; /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** *

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

* @public */ export interface LifecycleExecutionResourceAction { /** *

The name of the resource that was identified for a lifecycle policy action.

* @public */ name?: LifecycleExecutionResourceActionName | undefined; /** *

The reason why the lifecycle policy action is taken.

* @public */ reason?: string | undefined; } /** *

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

* @public */ export interface LifecycleExecutionResourceState { /** *

The runtime status of the lifecycle action taken for the * impacted resource.

* @public */ status?: LifecycleExecutionResourceStatus | undefined; /** *

Messaging that clarifies the reason for the assigned status.

* @public */ reason?: string | undefined; } /** *

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

* @public */ export interface LifecycleExecutionSnapshotResource { /** *

Identifies the impacted snapshot resource.

* @public */ snapshotId?: string | undefined; /** *

The runtime status of the lifecycle action taken for the snapshot.

* @public */ state?: LifecycleExecutionResourceState | undefined; } /** *

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

* @public */ export interface LifecycleExecutionResource { /** *

The account that owns the impacted resource.

* @public */ accountId?: string | undefined; /** *

Identifies the impacted resource. The resource ID depends on the type of * resource, as follows.

*
    *
  • *

    Image Builder image resources: Amazon Resource Name (ARN)

    *
    • *
  • *

    Distributed AMIs: AMI ID

    *
    • *
  • *

    Container images distributed to an ECR repository: image URI or SHA Digest

    *
    • *
* @public */ resourceId?: string | undefined; /** *

The runtime state for the lifecycle execution.

* @public */ state?: LifecycleExecutionResourceState | undefined; /** *

The action to take for the identified resource.

* @public */ action?: LifecycleExecutionResourceAction | undefined; /** *

The Amazon Web Services Region where the lifecycle execution resource is stored.

* @public */ region?: string | undefined; /** *

A list of associated resource snapshots for the impacted resource if * it’s an AMI.

* @public */ snapshots?: LifecycleExecutionSnapshotResource[] | undefined; /** *

For an impacted container image, this identifies a list of URIs for associated * container images distributed to ECR repositories.

* @public */ imageUris?: string[] | undefined; /** *

The starting timestamp from the lifecycle action that was applied to the resource.

* @public */ startTime?: Date | undefined; /** *

The ending timestamp from the lifecycle action that was applied to the resource.

* @public */ endTime?: Date | undefined; } /** * @public */ export interface ListLifecycleExecutionResourcesResponse { /** *

Runtime details for the specified runtime instance of the lifecycle policy.

* @public */ lifecycleExecutionId?: string | undefined; /** *

The current state of the lifecycle runtime instance.

* @public */ lifecycleExecutionState?: LifecycleExecutionState | undefined; /** *

A list of resources that were identified for lifecycle actions.

* @public */ resources?: LifecycleExecutionResource[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListLifecycleExecutionsRequest { /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the resource for which to get a list of lifecycle runtime instances.

* @public */ resourceArn: string | undefined; } /** * @public */ export interface ListLifecycleExecutionsResponse { /** *

A list of lifecycle runtime instances for the specified resource.

* @public */ lifecycleExecutions?: LifecycleExecution[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListLifecyclePoliciesRequest { /** *

Streamline results based on one of the following values: Name, * Status.

* @public */ filters?: Filter[] | undefined; /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** *

Contains a summary of lifecycle policy resources.

* @public */ export interface LifecyclePolicySummary { /** *

The Amazon Resource Name (ARN) of the lifecycle policy summary resource.

* @public */ arn?: string | undefined; /** *

The name of the lifecycle policy.

* @public */ name?: string | undefined; /** *

Optional description for the lifecycle policy.

* @public */ description?: string | undefined; /** *

The lifecycle policy resource status.

* @public */ status?: LifecyclePolicyStatus | undefined; /** *

The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy.

* @public */ executionRole?: string | undefined; /** *

The type of resources the lifecycle policy targets.

* @public */ resourceType?: LifecyclePolicyResourceType | undefined; /** *

The timestamp when Image Builder created the lifecycle policy resource.

* @public */ dateCreated?: Date | undefined; /** *

The timestamp when Image Builder updated the lifecycle policy resource.

* @public */ dateUpdated?: Date | undefined; /** *

The timestamp for the last time Image Builder ran the lifecycle policy.

* @public */ dateLastRun?: Date | undefined; /** *

To help manage your lifecycle policy resources, you can assign your own * metadata to each resource in the form of tags. Each tag consists of a key and * an optional value, both of which you define.

* @public */ tags?: Record | undefined; } /** * @public */ export interface ListLifecyclePoliciesResponse { /** *

A list of lifecycle policies in your Amazon Web Services account that meet the criteria * specified in the request.

* @public */ lifecyclePolicySummaryList?: LifecyclePolicySummary[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListTagsForResourceRequest { /** *

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

* @public */ resourceArn: string | undefined; } /** * @public */ export interface ListTagsForResourceResponse { /** *

The tags for the specified resource.

* @public */ tags?: Record | undefined; } /** * @public */ export interface ListWaitingWorkflowStepsRequest { /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** *

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

* @public */ export interface WorkflowStepExecution { /** *

Uniquely identifies the workflow step that ran for the associated * image build version.

* @public */ stepExecutionId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image build version that ran the workflow.

* @public */ imageBuildVersionArn?: string | undefined; /** *

Uniquely identifies the runtime instance of the workflow that contains * the workflow step that ran for the associated image build version.

* @public */ workflowExecutionId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the workflow resource that ran.

* @public */ workflowBuildVersionArn?: string | undefined; /** *

The name of the workflow step.

* @public */ name?: string | undefined; /** *

The name of the step action.

* @public */ action?: string | undefined; /** *

The timestamp when the workflow step started.

* @public */ startTime?: string | undefined; } /** * @public */ export interface ListWaitingWorkflowStepsResponse { /** *

An array of the workflow steps that are waiting for action in your * Amazon Web Services account.

* @public */ steps?: WorkflowStepExecution[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListWorkflowBuildVersionsRequest { /** *

The Amazon Resource Name (ARN) of the workflow resource for which to get a list of build versions.

* @public */ workflowVersionArn?: string | undefined; /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** *

Contains metadata about the workflow resource.

* @public */ export interface WorkflowSummary { /** *

The Amazon Resource Name (ARN) of the workflow resource.

* @public */ arn?: string | undefined; /** *

The name of the workflow.

* @public */ name?: string | undefined; /** *

The version of the workflow.

* @public */ version?: string | undefined; /** *

Describes the workflow.

* @public */ description?: string | undefined; /** *

The change description for the current version of the workflow resource.

* @public */ changeDescription?: string | undefined; /** *

The image creation stage that this workflow applies to. Image Builder currently * supports build and test stage workflows.

* @public */ type?: WorkflowType | undefined; /** *

The owner of the workflow resource.

* @public */ owner?: string | undefined; /** *

Describes the current state of the workflow resource.

* @public */ state?: WorkflowState | undefined; /** *

The original creation date of the workflow resource.

* @public */ dateCreated?: string | undefined; /** *

Contains a list of tags that are defined for the workflow.

* @public */ tags?: Record | undefined; } /** * @public */ export interface ListWorkflowBuildVersionsResponse { /** *

A list that contains metadata for the workflow builds that have run for * the workflow resource specified in the request.

* @public */ workflowSummaryList?: WorkflowSummary[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListWorkflowExecutionsRequest { /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; /** *

List all workflow runtime instances for the specified image build version * resource ARN.

* @public */ imageBuildVersionArn: string | undefined; } /** *

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

* @public */ export interface WorkflowExecutionMetadata { /** *

The Amazon Resource Name (ARN) of the workflow resource build version that ran.

* @public */ workflowBuildVersionArn?: string | undefined; /** *

Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a * workflow.

* @public */ workflowExecutionId?: string | undefined; /** *

Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.

* @public */ type?: WorkflowType | undefined; /** *

The current runtime status for this workflow.

* @public */ status?: WorkflowExecutionStatus | undefined; /** *

The runtime output message from the workflow, if applicable.

* @public */ message?: string | undefined; /** *

The total number of steps in the workflow. This should equal the sum of the step * counts for steps that succeeded, were skipped, and failed.

* @public */ totalStepCount?: number | undefined; /** *

A runtime count for the number of steps in the workflow that ran successfully.

* @public */ totalStepsSucceeded?: number | undefined; /** *

A runtime count for the number of steps in the workflow that failed.

* @public */ totalStepsFailed?: number | undefined; /** *

A runtime count for the number of steps in the workflow that were skipped.

* @public */ totalStepsSkipped?: number | undefined; /** *

The timestamp when the runtime instance of this workflow started.

* @public */ startTime?: string | undefined; /** *

The timestamp when this runtime instance of the workflow finished.

* @public */ endTime?: string | undefined; /** *

The name of the test group that included the test workflow resource at runtime.

* @public */ parallelGroup?: string | undefined; /** *

Indicates retry status for this runtime instance of the workflow.

* @public */ retried?: boolean | undefined; } /** * @public */ export interface ListWorkflowExecutionsResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

Contains an array of runtime details that represents each time a workflow ran for * the requested image build version.

* @public */ workflowExecutions?: WorkflowExecutionMetadata[] | undefined; /** *

The resource Amazon Resource Name (ARN) of the image build version for which you requested a list of * workflow runtime details.

* @public */ imageBuildVersionArn?: string | undefined; /** *

The output message from the list action, if applicable.

* @public */ message?: string | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListWorkflowsRequest { /** *

Used to get a list of workflow build version filtered by the identity of the creator.

* @public */ owner?: Ownership | undefined; /** *

Used to streamline search results.

* @public */ filters?: Filter[] | undefined; /** *

Specify all or part of the workflow name to streamline results.

* @public */ byName?: boolean | undefined; /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; } /** *

Contains details about this version of the workflow.

* @public */ export interface WorkflowVersion { /** *

The Amazon Resource Name (ARN) of the workflow resource.

* @public */ arn?: string | undefined; /** *

The name of the workflow.

* @public */ name?: string | undefined; /** *

The semantic version of the workflow resource. The format includes three nodes: ...

* @public */ version?: string | undefined; /** *

Describes the workflow.

* @public */ description?: string | undefined; /** *

The image creation stage that this workflow applies to. Image Builder currently * supports build and test stage workflows.

* @public */ type?: WorkflowType | undefined; /** *

The owner of the workflow resource.

* @public */ owner?: string | undefined; /** *

The timestamp when Image Builder created the workflow version.

* @public */ dateCreated?: string | undefined; } /** * @public */ export interface ListWorkflowsResponse { /** *

A list of workflow build versions that match the request criteria.

* @public */ workflowVersionList?: WorkflowVersion[] | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListWorkflowStepExecutionsRequest { /** *

Specify the maximum number of items to return in a request.

* @public */ maxResults?: number | undefined; /** *

A token to specify where to start paginating. This is the nextToken * from a previously truncated response.

* @public */ nextToken?: string | undefined; /** *

The unique identifier that Image Builder assigned to keep track of runtime details * when it ran the workflow.

* @public */ workflowExecutionId: string | undefined; } /** *

Runtime details and status for the workflow step.

* @public */ export interface WorkflowStepMetadata { /** *

A unique identifier for the workflow step, assigned at runtime.

* @public */ stepExecutionId?: string | undefined; /** *

The name of the workflow step.

* @public */ name?: string | undefined; /** *

Description of the workflow step.

* @public */ description?: string | undefined; /** *

The step action name.

* @public */ action?: string | undefined; /** *

Runtime status for the workflow step.

* @public */ status?: WorkflowStepExecutionStatus | undefined; /** *

Reports on the rollback status of the step, if applicable.

* @public */ rollbackStatus?: WorkflowStepExecutionRollbackStatus | undefined; /** *

Detailed output message that the workflow step provides at runtime.

* @public */ message?: string | undefined; /** *

Input parameters that Image Builder provides for the workflow step.

* @public */ inputs?: string | undefined; /** *

The file names that the workflow step created as output for this runtime instance of the workflow.

* @public */ outputs?: string | undefined; /** *

The timestamp when the workflow step started.

* @public */ startTime?: string | undefined; /** *

The timestamp when the workflow step finished.

* @public */ endTime?: string | undefined; } /** * @public */ export interface ListWorkflowStepExecutionsResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

Contains an array of runtime details that represents each step in this runtime * instance of the workflow.

* @public */ steps?: WorkflowStepMetadata[] | undefined; /** *

The build version Amazon Resource Name (ARN) for the Image Builder workflow resource that defines the steps for * this runtime instance of the workflow.

* @public */ workflowBuildVersionArn?: string | undefined; /** *

The unique identifier that Image Builder assigned to keep track of runtime details * when it ran the workflow.

* @public */ workflowExecutionId?: string | undefined; /** *

The image build version resource Amazon Resource Name (ARN) that's associated with the specified runtime * instance of the workflow.

* @public */ imageBuildVersionArn?: string | undefined; /** *

The output message from the list action, if applicable.

* @public */ message?: string | undefined; /** *

The next token used for paginated responses. When this field isn't empty, * there are additional elements that the service hasn't included in this request. Use this token * with the next request to retrieve additional objects.

* @public */ nextToken?: string | undefined; } /** * @public */ export interface PutComponentPolicyRequest { /** *

The Amazon Resource Name (ARN) of the component that this policy should be applied * to.

* @public */ componentArn: string | undefined; /** *

The policy to apply.

* @public */ policy: string | undefined; } /** * @public */ export interface PutComponentPolicyResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the component that this policy was applied * to.

* @public */ componentArn?: string | undefined; } /** * @public */ export interface PutContainerRecipePolicyRequest { /** *

The Amazon Resource Name (ARN) of the container recipe that this policy should be * applied to.

* @public */ containerRecipeArn: string | undefined; /** *

The policy to apply to the container recipe.

* @public */ policy: string | undefined; } /** * @public */ export interface PutContainerRecipePolicyResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the container recipe that this policy was applied * to.

* @public */ containerRecipeArn?: string | undefined; } /** * @public */ export interface PutImagePolicyRequest { /** *

The Amazon Resource Name (ARN) of the image that this policy should be applied * to.

* @public */ imageArn: string | undefined; /** *

The policy to apply.

* @public */ policy: string | undefined; } /** * @public */ export interface PutImagePolicyResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image that this policy was applied to.

* @public */ imageArn?: string | undefined; } /** * @public */ export interface PutImageRecipePolicyRequest { /** *

The Amazon Resource Name (ARN) of the image recipe that this policy should be applied * to.

* @public */ imageRecipeArn: string | undefined; /** *

The policy to apply.

* @public */ policy: string | undefined; } /** * @public */ export interface PutImageRecipePolicyResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image recipe that this policy was applied * to.

* @public */ imageRecipeArn?: string | undefined; } /** * @public */ export interface RetryImageRequest { /** *

The source image Amazon Resource Name (ARN) to retry.

* @public */ imageBuildVersionArn: string | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface RetryImageResponse { /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The ARN of the image to be retried.

* @public */ imageBuildVersionArn?: string | undefined; } /** * @public */ export interface SendWorkflowStepActionRequest { /** *

Uniquely identifies the workflow step that sent the step action.

* @public */ stepExecutionId: string | undefined; /** *

The Amazon Resource Name (ARN) of the image build version to send action for.

* @public */ imageBuildVersionArn: string | undefined; /** *

The action for the image creation process to take while a workflow * WaitForAction step waits for an asynchronous action to complete.

* @public */ action: WorkflowStepActionType | undefined; /** *

The reason why this action is sent.

* @public */ reason?: string | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface SendWorkflowStepActionResponse { /** *

The workflow step that sent the step action.

* @public */ stepExecutionId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image build version that received the action * request.

* @public */ imageBuildVersionArn?: string | undefined; /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface StartImagePipelineExecutionRequest { /** *

The Amazon Resource Name (ARN) of the image pipeline that you want to manually * invoke.

* @public */ imagePipelineArn: string | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; /** *

Specify tags for Image Builder to apply to the image resource that's created * When it starts pipeline execution.

* @public */ tags?: Record | undefined; } /** * @public */ export interface StartImagePipelineExecutionResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image that the request created.

* @public */ imageBuildVersionArn?: string | undefined; } /** *

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

* @public */ export interface ResourceStateUpdateExclusionRules { /** *

Defines criteria for AMIs that are excluded from lifecycle actions.

* @public */ amis?: LifecyclePolicyDetailExclusionRulesAmis | undefined; } /** *

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

* @public */ export interface ResourceStateUpdateIncludeResources { /** *

Specifies whether the lifecycle action should apply to distributed AMIs

* @public */ amis?: boolean | undefined; /** *

Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.

* @public */ snapshots?: boolean | undefined; /** *

Specifies whether the lifecycle action should apply to distributed containers.

* @public */ containers?: boolean | undefined; } /** *

The current state of an impacted resource.

* @public */ export interface ResourceState { /** *

Shows the current lifecycle policy action that was applied to an impacted resource.

* @public */ status?: ResourceStatus | undefined; } /** * @public */ export interface StartResourceStateUpdateRequest { /** *

The Amazon Resource Name (ARN) of the Image Builder resource that is updated. The state update might also * impact associated resources.

* @public */ resourceArn: string | undefined; /** *

Indicates the lifecycle action to take for this request.

* @public */ state: ResourceState | undefined; /** *

The name or Amazon Resource Name (ARN) of the IAM role that’s used to update image state.

* @public */ executionRole?: string | undefined; /** *

A list of image resources to update state for.

* @public */ includeResources?: ResourceStateUpdateIncludeResources | undefined; /** *

Skip action on the image resource and associated resources if specified * exclusion rules are met.

* @public */ exclusionRules?: ResourceStateUpdateExclusionRules | undefined; /** *

The timestamp that indicates when resources are updated by a lifecycle action.

* @public */ updateAt?: Date | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface StartResourceStateUpdateResponse { /** *

Identifies the lifecycle runtime instance that started the resource * state update.

* @public */ lifecycleExecutionId?: string | undefined; /** *

The requested Amazon Resource Name (ARN) of the Image Builder resource for the asynchronous update.

* @public */ resourceArn?: string | undefined; } /** * @public */ export interface TagResourceRequest { /** *

The Amazon Resource Name (ARN) of the resource that you want to tag.

* @public */ resourceArn: string | undefined; /** *

The tags to apply to the resource.

* @public */ tags: Record | undefined; } /** * @public */ export interface TagResourceResponse { } /** * @public */ export interface UntagResourceRequest { /** *

The Amazon Resource Name (ARN) of the resource that you want to untag.

* @public */ resourceArn: string | undefined; /** *

The tag keys to remove from the resource.

* @public */ tagKeys: string[] | undefined; } /** * @public */ export interface UntagResourceResponse { } /** * @public */ export interface UpdateDistributionConfigurationRequest { /** *

The Amazon Resource Name (ARN) of the distribution configuration that you want to * update.

* @public */ distributionConfigurationArn: string | undefined; /** *

The description of the distribution configuration.

* @public */ description?: string | undefined; /** *

The distributions of the distribution configuration.

* @public */ distributions: Distribution[] | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface UpdateDistributionConfigurationResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the distribution configuration that was updated by * this request.

* @public */ distributionConfigurationArn?: string | undefined; } /** * @public */ export interface UpdateImagePipelineRequest { /** *

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

* @public */ imagePipelineArn: string | undefined; /** *

The description of the image pipeline.

* @public */ description?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image recipe that will be used to configure * images updated by this image pipeline.

* @public */ imageRecipeArn?: string | undefined; /** *

The Amazon Resource Name (ARN) of the container pipeline to update.

* @public */ containerRecipeArn?: string | undefined; /** *

The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to * build images that this image pipeline has updated.

* @public */ infrastructureConfigurationArn: string | undefined; /** *

The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to * configure and distribute images that this image pipeline has updated.

* @public */ distributionConfigurationArn?: string | undefined; /** *

The image test configuration of the image pipeline.

* @public */ imageTestsConfiguration?: ImageTestsConfiguration | undefined; /** *

Collects additional information about the image being created, including the operating * system (OS) version and package list. This information is used to enhance the overall * experience of using EC2 Image Builder. Enabled by default.

* @public */ enhancedImageMetadataEnabled?: boolean | undefined; /** *

The schedule of the image pipeline.

* @public */ schedule?: Schedule | undefined; /** *

The status of the image pipeline.

* @public */ status?: PipelineStatus | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; /** *

Contains settings for vulnerability scans.

* @public */ imageScanningConfiguration?: ImageScanningConfiguration | undefined; /** *

Contains the workflows to run for the pipeline.

* @public */ workflows?: WorkflowConfiguration[] | undefined; /** *

Update logging configuration for the output image that's created when * the pipeline runs.

* @public */ loggingConfiguration?: PipelineLoggingConfiguration | undefined; /** *

The name or Amazon Resource Name (ARN) for the IAM role you create that grants * Image Builder access to perform workflow actions.

* @public */ executionRole?: string | undefined; /** *

The tags to be applied to the images produced by this pipeline.

* @public */ imageTags?: Record | undefined; } /** * @public */ export interface UpdateImagePipelineResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the image pipeline that was updated by this * request.

* @public */ imagePipelineArn?: string | undefined; } /** * @public */ export interface UpdateInfrastructureConfigurationRequest { /** *

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to * update.

* @public */ infrastructureConfigurationArn: string | undefined; /** *

The description of the infrastructure configuration.

* @public */ description?: string | undefined; /** *

The instance types of the infrastructure configuration. You can specify one or more * instance types to use for this build. The service will pick one of these instance types * based on availability.

* @public */ instanceTypes?: string[] | undefined; /** *

The instance profile to associate with the instance used to customize your Amazon EC2 * AMI.

* @public */ instanceProfileName: string | undefined; /** *

The security group IDs to associate with the instance used to customize your Amazon EC2 * AMI.

* @public */ securityGroupIds?: string[] | undefined; /** *

The subnet ID to place the instance used to customize your Amazon EC2 AMI in.

* @public */ subnetId?: string | undefined; /** *

The logging configuration of the infrastructure configuration.

* @public */ logging?: Logging | undefined; /** *

The key pair of the infrastructure configuration. You can use this to log on to and * debug the instance used to create your image.

* @public */ keyPair?: string | undefined; /** *

The terminate instance on failure setting of the infrastructure configuration. Set to * false if you want Image Builder to retain the instance used to configure your AMI if the build or * test phase of your workflow fails.

* @public */ terminateInstanceOnFailure?: boolean | undefined; /** *

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event * notifications.

* *

EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys * from other accounts. The key that is used to encrypt the SNS topic must reside in the * account that the Image Builder service runs under.

* * @public */ snsTopicArn?: string | undefined; /** *

The tags attached to the resource created by Image Builder.

* @public */ resourceTags?: Record | undefined; /** *

The instance metadata options that you can set for the HTTP requests that pipeline * builds use to launch EC2 build and test instances. For more information about instance * metadata options, see one of the following links:

* * @public */ instanceMetadataOptions?: InstanceMetadataOptions | undefined; /** *

The instance placement settings that define where the instances that are launched * from your image will run.

* @public */ placement?: Placement | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface UpdateInfrastructureConfigurationResponse { /** *

The request ID that uniquely identifies this request.

* @public */ requestId?: string | undefined; /** *

The client token that uniquely identifies the request.

* @public */ clientToken?: string | undefined; /** *

The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by * this request.

* @public */ infrastructureConfigurationArn?: string | undefined; } /** * @public */ export interface UpdateLifecyclePolicyRequest { /** *

The Amazon Resource Name (ARN) of the lifecycle policy resource.

* @public */ lifecyclePolicyArn: string | undefined; /** *

Optional description for the lifecycle policy.

* @public */ description?: string | undefined; /** *

Indicates whether the lifecycle policy resource is enabled.

* @public */ status?: LifecyclePolicyStatus | undefined; /** *

The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to update the * lifecycle policy.

* @public */ executionRole: string | undefined; /** *

The type of image resource that the lifecycle policy applies to.

* @public */ resourceType: LifecyclePolicyResourceType | undefined; /** *

The configuration details for a lifecycle policy resource.

* @public */ policyDetails: LifecyclePolicyDetail[] | undefined; /** *

Selection criteria for resources that the lifecycle policy applies to.

* @public */ resourceSelection: LifecyclePolicyResourceSelection | undefined; /** *

Unique, case-sensitive identifier you provide to ensure * idempotency of the request. For more information, see Ensuring idempotency * in the Amazon EC2 API Reference.

* @public */ clientToken?: string | undefined; } /** * @public */ export interface UpdateLifecyclePolicyResponse { /** *

The Amazon Resource Name (ARN) of the image lifecycle policy resource that was updated.

* @public */ lifecyclePolicyArn?: string | undefined; }