EC2 Image Builder automates the creation, management, and deployment of customized, secure, and up-to-date server images. You can build Amazon Machine Images (AMIs) and container images that are pre-installed and pre-configured with software and settings to meet specific IT standards.
For an introduction to the service concepts that these API operations work with, see How Image Builder works in the EC2 Image Builder User Guide.
", "operations": { "CancelImageCreation": "Cancels the creation of an image. This operation can only be used on images in a non-terminal state. Cancellation is asynchronous: the request returns immediately, then Image Builder stops the running build and moves the image to the CANCELLED state. Output resources that the build already created, such as AMIs and snapshots, aren't removed.
Cancels a lifecycle execution – a single run of lifecycle actions that a lifecycle policy or a StartResourceStateUpdate request started. You can only cancel an execution that hasn't reached a terminal state. Cancellation is asynchronous and doesn't undo completed lifecycle actions.
", "CreateComponent": "Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods:
Inline, using the data property in the request body.
A URL that points to a YAML document file stored in Amazon S3, using the uri property in the request body.
Image Builder determines the component type from the document. If the document contains a single phase named test, the component type is TEST. Otherwise, the component type is BUILD.
Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.
", "CreateDistributionConfiguration": "Creates a new distribution configuration. Distribution configurations define and configure the outputs for your images, including the target Regions, accounts, and settings for each Region.
", "CreateImage": "Creates a new image along with all configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a containerRecipeArn or an imageRecipeArn.
The response returns as soon as Image Builder creates the new image resource. The image build process runs asynchronously. To check its progress, call GetImage and check the image status.
", "CreateImagePipeline": "Creates a new image pipeline. Use image pipelines to automate the creation and distribution of images. You must specify exactly one recipe for the pipeline, using either a containerRecipeArn or an imageRecipeArn.
Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.
", "CreateInfrastructureConfiguration": "Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
", "CreateLifecyclePolicy": "Creates a lifecycle policy resource.
", "CreateWorkflow": "Creates a new workflow or a new version of an existing workflow. If a workflow with the same name and semantic version already exists, and your request changes its configuration, Image Builder creates a new build version. If the configuration is identical to the latest build version, the request fails because that workflow configuration already exists.
", "DeleteComponent": "Deletes a component build version. The request fails with ResourceDependencyException if an image recipe or container recipe references this component version. It also fails if the component build version is shared with other accounts.
Deletes a container recipe. The request fails with ResourceDependencyException if the recipe is shared with other accounts, or if an image pipeline references it.
Deletes a distribution configuration. You can't delete a configuration that an image pipeline still references. The request fails with ResourceDependencyException. Update or delete the referencing pipelines first.
Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container images that are created during the image build process. You must clean those up separately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI commands.
The request fails with ResourceDependencyException if the image is shared with other accounts, or if other resources depend on it. It also fails while the image build is still running. Cancel an in-progress build with CancelImageCreation before you delete the image.
To deregister an EC2 Linux AMI, see Deregister your Linux AMI in the Amazon EC2 User Guide .
To deregister an EC2 Windows AMI, see Deregister your Windows AMI in the Amazon EC2 Windows Guide .
To delete a container image from Amazon ECR, see Deleting an image in the Amazon ECR User Guide.
Deletes an image pipeline. Images that the pipeline created aren't deleted - remove those separately with DeleteImage. You can delete a pipeline while a build that it started is still running. The build continues independently.
", "DeleteImageRecipe": "Deletes an image recipe.
", "DeleteInfrastructureConfiguration": "Deletes an infrastructure configuration. You can't delete a configuration that an image pipeline still references. The request fails with ResourceDependencyException. Update or delete the referencing pipelines first.
Deletes the specified lifecycle policy resource. Deleting the policy removes its schedule, so no further lifecycle runs occur for that policy. If a lifecycle execution is in progress for the policy, Image Builder cancels it. Deletion doesn't revert actions that the policy already applied to your resources.
", "DeleteWorkflow": "Deletes a specific workflow resource. You can't delete a workflow build version while an image pipeline references it. The request fails with ResourceDependencyException.
Distributes an existing AMI to target Regions and accounts without running the full image build process. This operation only runs the distribution phase on an image that has already been built.
", "GetComponent": "Retrieves a component object.
", "GetComponentPolicy": "Retrieves a component policy.
", "GetContainerRecipe": "Retrieves a container recipe.
", "GetContainerRecipePolicy": "Retrieves the policy for a container recipe.
", "GetDistributionConfiguration": "Retrieves a distribution configuration.
", "GetImage": "Retrieves an image.
", "GetImagePipeline": "Retrieves an image pipeline.
", "GetImagePolicy": "Retrieves an image policy.
", "GetImageRecipe": "Retrieves an image recipe.
", "GetImageRecipePolicy": "Retrieves an image recipe policy.
", "GetInfrastructureConfiguration": "Retrieves an infrastructure configuration.
", "GetLifecycleExecution": "Retrieves runtime information for a lifecycle execution – a single run of lifecycle actions that a lifecycle policy or a StartResourceStateUpdate request started.
", "GetLifecyclePolicy": "Retrieves details for the specified image lifecycle policy.
", "GetMarketplaceResource": "Verifies the subscription and performs resource dependency checks on the requested Amazon Web Services Marketplace resource. The caller must be entitled to the resource. For Amazon Web Services Marketplace components, the response contains fields to download the components and their artifacts.
", "GetWorkflow": "Retrieves a workflow resource object.
", "GetWorkflowExecution": "Retrieves runtime information for a specific runtime instance of the workflow.
", "GetWorkflowStepExecution": "Retrieves runtime information for a specific runtime instance of the workflow step.
", "ImportComponent": "Imports a component and transforms its data into a component document. For the SHELL format, Image Builder wraps your script in a component document with a single step that runs the script.
Imports a Windows operating system image from a verified Microsoft ISO disk file. The following disk images are supported:
Windows 11 Enterprise
The response returns as soon as Image Builder creates the new image resource in the PENDING state. The conversion from ISO file to AMI then runs asynchronously on an EC2 instance that Image Builder launches with the specified infrastructure configuration.
Creates an Image Builder image resource from an Amazon EC2 VM import task. The response returns as soon as Image Builder creates the image resource in the PENDING state. Image Builder then monitors the import task asynchronously. When the task completes, Image Builder records the AMI that it produced as the new image's output resource and marks the image AVAILABLE. You can then use the imported image as the base image for your recipes.
To create the VM import task, use the Amazon EC2 API ImportImage operation, or the import-image CLI command.
", "ListComponentBuildVersions": "Returns a list of component build versions for the specified component version ARN. You can only list build versions for components that your account owns. Deprecated build versions aren't included in the results.
", "ListComponents": "Returns the list of components that you have access to. By default, the response doesn't include components in the DEPRECATED state. To list deprecated components, use the status filter with the value DEPRECATED.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Filtering: You can 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.
Returns a list of container recipes.
", "ListDistributionConfigurations": "Returns a list of distribution configurations.
", "ListImageBuildVersions": "Returns a list of image build versions.
", "ListImagePackages": "Lists the packages that are associated with an image build version, as determined by Amazon Web Services Systems Manager Inventory at build time.
", "ListImagePipelineImages": "Returns a list of images created by the specified pipeline.
", "ListImagePipelines": "Returns a list of image pipelines.
", "ListImageRecipes": "Returns a list of image recipes.
", "ListImageScanFindingAggregations": "Returns a list of image scan aggregations for your account. You can filter by the type of key that Image Builder uses to group results. For example, if you want to get a list of findings by severity level for one of your pipelines, you might specify your pipeline with the imagePipelineArn filter. If you don't specify a filter, Image Builder returns an aggregation for your account.
To streamline results, you can use the following filters in your request:
imageBuildVersionArn
imagePipelineArn
vulnerabilityId
Returns a list of image scan findings for your account. Amazon Inspector generates the findings when it scans images that have scanning enabled.
", "ListImages": "Returns the list of images that you have access to.
", "ListInfrastructureConfigurations": "Returns a list of infrastructure configurations.
", "ListLifecycleExecutionResources": "Lists resources that the runtime instance of the image lifecycle identified for lifecycle actions.
", "ListLifecycleExecutions": "Retrieves the lifecycle runtime history for the specified resource.
", "ListLifecyclePolicies": "Retrieves a list of lifecycle policies in your Amazon Web Services account.
", "ListTagsForResource": "Returns the list of tags for the specified resource.
", "ListWaitingWorkflowSteps": "Lists the workflow steps in your Amazon Web Services account that have paused at a WaitForAction step, and are waiting for you to respond. To send a response, call SendWorkflowStepAction.
Returns a list of build versions for a specific workflow resource.
", "ListWorkflowExecutions": "Returns a list of workflow runtime instance metadata objects for a specific image build version.
", "ListWorkflowStepExecutions": "Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.
", "ListWorkflows": "Lists workflow versions based on filtering parameters. To list the build versions of a specific workflow version, call ListWorkflowBuildVersions.
", "PutComponentPolicy": "Applies a policy to a component. The preferred way to share resources is with the RAM API CreateResourceShare. If you use the PutComponentPolicy operation instead, you must also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource isn't visible to the principals that it's shared with.
", "PutContainerRecipePolicy": "Applies a policy to a container recipe. The preferred way to share resources is with the RAM API CreateResourceShare. If you use the PutContainerRecipePolicy operation instead, you must also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource isn't visible to the principals that it's shared with.
", "PutImagePolicy": "Applies a policy to an image. The preferred way to share resources is with the RAM API CreateResourceShare. If you use the PutImagePolicy operation instead, you must also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource isn't visible to the principals that it's shared with.
", "PutImageRecipePolicy": "Applies a policy to an image recipe. The preferred way to share resources is with the RAM API CreateResourceShare. If you use the PutImageRecipePolicy operation instead, you must also call the RAM API PromoteResourceShareCreatedFromPolicy. Otherwise, the resource isn't visible to the principals that it's shared with.
", "RetryImage": "Retries a failed or canceled image build without rebuilding the phases that already completed. The image re-runs asynchronously in place: the same build version returns to the test or distribution phase where it failed and continues from there. No new image build version is created. Retry is only supported for AMI-based images.
", "SendWorkflowStepAction": "Sends an action to a workflow step that has paused at a WaitForAction step, so that image creation can continue. To find the steps that are waiting for an action, call ListWaitingWorkflowSteps.
Manually triggers a pipeline to create an image. You can start a build this way whether the pipeline is enabled or disabled. The response returns as soon as Image Builder creates the new image resource and queues the build. Use the returned imageBuildVersionArn with GetImage to track build progress.
Begins an ad-hoc state change for the specified image build version. This is a one-time operation - if you schedule the update, it runs only once. If the request includes underlying resources, or schedules the update far enough in the future, Image Builder runs the update as an asynchronous lifecycle execution and returns its identifier. Otherwise, for target states other than DELETED, the state change applies immediately. If a request that starts a lifecycle execution arrives while the image already has one in progress, Image Builder rejects it.
Adds a tag to a resource.
", "UntagResource": "Removes a tag from a resource.
", "UpdateDistributionConfiguration": "Updates a distribution configuration. Distribution configurations define and configure the outputs for your images, including the target Regions, accounts, and settings for each Region.
This operation doesn't support selective updates. The request replaces the entire distribution configuration, so include every setting that you want to keep. Any optional property that you omit is removed or reset to its default.
Updates an image pipeline. Use image pipelines to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a containerRecipeArn or an imageRecipeArn. The recipe must be the same type, image or container, as the pipeline's current recipe.
This operation doesn't support selective updates. The request replaces the entire pipeline configuration, so include every setting that you want to keep. Any optional property that you omit is removed or reset to its default.
Updates an infrastructure configuration. An infrastructure configuration defines the environment in which Image Builder builds and tests your image.
This operation doesn't support selective updates. The request replaces the entire infrastructure configuration, so include every setting that you want to keep. Any optional property that you omit is removed or reset to its default.
Updates the specified lifecycle policy. The resourceType must match the existing policy's value.
This operation doesn't support selective updates. The request replaces the entire lifecycle policy configuration, so include every setting that you want to keep. Any optional property that you omit is removed or reset to its default.
You do not have permissions to perform the requested operation.
", "refs": {} }, "AccountAggregation": { "base": "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.
", "refs": { "ImageScanFindingAggregation$accountAggregation": "Returns an object that contains severity counts based on an account ID.
" } }, "AccountId": { "base": null, "refs": { "AccountList$member": null, "FastLaunchConfiguration$accountId": "The owner account ID for the fast-launch enabled Windows AMI.
", "LaunchTemplateConfiguration$accountId": "The account ID that this configuration applies to.
", "RegionFailure$targetAccountId": "The account ID of the account that the image was distributed to in the Region.
", "SsmParameterConfiguration$amiAccountId": "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.
" } }, "AccountList": { "base": null, "refs": { "AmiDistributionConfiguration$targetAccountIds": "The Amazon Web Services account IDs to distribute the AMI to in this Region. Each listed account receives its own copy of the output AMI. If you don't specify accounts, Image Builder distributes the AMI only to your own account.
", "LaunchPermissionConfiguration$userIds": "The Amazon Web Services account IDs to grant launch permission to. Each listed account can use the distributed AMI to launch instances.
", "LifecyclePolicyDetailExclusionRulesAmis$sharedAccounts": "The lifecycle action doesn't apply to AMIs that are shared with any of the specified Amazon Web Services accounts.
" } }, "AdditionalInstanceConfiguration": { "base": "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.
", "refs": { "CreateImageRecipeRequest$additionalInstanceConfiguration": "The additional settings and launch scripts for your build instances.
", "ImageRecipe$additionalInstanceConfiguration": "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 Image Builder launches your build instance.
" } }, "Ami": { "base": "Details of an Amazon EC2 AMI.
", "refs": { "AmiList$member": null } }, "AmiDistributionConfiguration": { "base": "Define and configure the output AMIs of the pipeline.
", "refs": { "Distribution$amiDistributionConfiguration": "The specific AMI settings; for example, launch permissions or AMI tags.
" } }, "AmiList": { "base": null, "refs": { "OutputResources$amis": "The Amazon EC2 AMIs created by this image. The list contains one entry per AMI, including copies that distribution created in each target Amazon Web Services Region and account.
" } }, "AmiNameString": { "base": null, "refs": { "AmiDistributionConfiguration$name": "The name of the output AMI. The name must include the {{ imagebuilder:buildDate }} dynamic tag so that each build produces a uniquely named AMI. If you don't specify a name, Image Builder names the output AMI with the image name followed by the build timestamp, for example my-image 2022-10-26T22-30-05.912619Z.
The name of an AMI watermark. AMI watermarks are lineage markers that Image Builder attaches to output AMIs during the build process. AMI watermarks automatically propagate to derivative AMIs when the source AMI is copied or distributed.
", "refs": { "AmiWatermarksList$member": null } }, "AmiWatermarksList": { "base": "A list of AMI watermark names to attach to the output AMI. Names are case-sensitive. The recipe does not allow duplicate names.
", "refs": { "CreateImageRecipeRequest$amiWatermarks": "The AMI watermark names to attach to the output AMI from this recipe. AMI watermarks are lineage markers. They automatically propagate to derivative AMIs when the source AMI is copied or distributed across Regions or accounts.
AMI watermarks are supported only for image recipes. AMIs with watermarks cannot be made public.
The AMI watermark names attached to the output AMI from this recipe. AMI watermarks are lineage markers that automatically propagate to derivative AMIs when the source AMI is copied or distributed.
" } }, "Arn": { "base": null, "refs": { "Image$sourcePipelineArn": "The Amazon Resource Name (ARN) of the image pipeline that created this image. This field is only present for images that a pipeline execution created.
", "ImagePipeline$imageRecipeArn": "The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
", "ImagePipeline$containerRecipeArn": "The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
", "ImagePipeline$infrastructureConfigurationArn": "The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
", "ImagePipeline$distributionConfigurationArn": "The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
", "ImportVmImageResponse$imageArn": "The Amazon Resource Name (ARN) of the Image Builder image resource that this request created. Image Builder records the AMI from the VM import task in the image's output resources after the task completes.
" } }, "AutoDisableFailureCount": { "base": null, "refs": { "AutoDisablePolicy$failureCount": "The number of consecutive scheduled image pipeline executions that must fail before Image Builder automatically disables the pipeline.
" } }, "AutoDisablePolicy": { "base": "Defines the rules by which an image pipeline is automatically disabled when it fails. By default, if the schedule doesn't include an auto-disable policy, Image Builder disables the pipeline after 5 consecutive failed scheduled builds.
", "refs": { "Schedule$autoDisablePolicy": "The policy that configures when Image Builder should automatically disable a pipeline that is failing.
" } }, "AutoScalingGroupConfiguration": { "base": "Identifies the Amazon EC2 Auto Scaling group that Image Builder takes the build instance from, and how long Image Builder waits when the group has no instance available.
", "refs": { "ParentInstanceConfiguration$autoScalingGroup": "The Amazon EC2 Auto Scaling group that Image Builder takes the build instance from. This is required when you specify parentInstance.
Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
", "ComponentSummary$obfuscate": "Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
", "CreateComponentRequest$dryRun": "Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.
Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.
Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.
Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.
Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.
Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.
Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.
Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.
Specifies whether to enable Windows fast launch on the output AMI during distribution. A value of false means Image Builder takes no fast-launch action for this configuration.
Specifies whether to make the new launch template version that Image Builder creates the default version of the launch template. If you don't set a value, Image Builder treats it as true.
Indicates whether the lifecycle execution identified any resources to take lifecycle actions on.
", "LifecyclePolicyDetailActionIncludeResources$amis": "Specifies whether the lifecycle action should apply to distributed AMIs.
", "LifecyclePolicyDetailActionIncludeResources$snapshots": "Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.
", "LifecyclePolicyDetailActionIncludeResources$containers": "Specifies whether the lifecycle action should apply to distributed containers.
", "LifecyclePolicyDetailExclusionRulesAmis$isPublic": "Configures whether public AMIs are excluded from the lifecycle action.
", "ListComponentsRequest$byName": "Specifies whether to return one entry per component name, with all versions of each component aggregated. Defaults to false, which returns one entry per component version. You can't combine this option with the version filter.
Specifies whether to return one entry per image name, with all versions of each image aggregated. Defaults to false, which returns one entry per image version. You can't combine this option with the version filter.
Specifies whether to return one entry per workflow name, with all versions of each workflow aggregated. Defaults to false, which returns one entry per workflow version. You can't combine this option with the version filter.
Specifies whether the lifecycle action should apply to distributed AMIs.
", "ResourceStateUpdateIncludeResources$snapshots": "Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.
", "ResourceStateUpdateIncludeResources$containers": "Specifies whether the lifecycle action should apply to distributed containers.
" } }, "BuildType": { "base": null, "refs": { "Image$buildType": "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.
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.
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.
You have exceeded the permitted request rate for the Amazon EC2 APIs that Image Builder calls on your behalf. Retry with an increasing or variable delay between requests.
", "refs": {} }, "CancelImageCreationRequest": { "base": null, "refs": {} }, "CancelImageCreationResponse": { "base": null, "refs": {} }, "CancelLifecycleExecutionRequest": { "base": null, "refs": {} }, "CancelLifecycleExecutionResponse": { "base": null, "refs": {} }, "CapacityWaitTimeoutSeconds": { "base": null, "refs": { "AutoScalingGroupConfiguration$capacityWaitTimeoutSeconds": "The number of seconds that Image Builder waits for an instance to become available in the group before the build fails. If you set this value to 0 or omit it, the build fails as soon as the group has no instance available.
" } }, "ClientException": { "base": "A generic client error. This error usually indicates that the request failed a validation check, such as when a downstream service rejects a configured value.
", "refs": {} }, "ClientToken": { "base": null, "refs": { "CancelImageCreationRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "CancelImageCreationResponse$clientToken": "The client token that uniquely identifies the request.
", "CancelLifecycleExecutionRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "CreateComponentRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "CreateComponentResponse$clientToken": "The client token that uniquely identifies the request.
", "CreateContainerRecipeRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "CreateContainerRecipeResponse$clientToken": "The client token that uniquely identifies the request.
", "CreateDistributionConfigurationRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "CreateDistributionConfigurationResponse$clientToken": "The client token that uniquely identifies the request.
", "CreateImagePipelineRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "CreateImagePipelineResponse$clientToken": "The client token that uniquely identifies the request.
", "CreateImageRecipeRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "CreateImageRecipeResponse$clientToken": "The client token that uniquely identifies the request.
", "CreateImageRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "CreateImageResponse$clientToken": "The client token that uniquely identifies the request.
", "CreateInfrastructureConfigurationRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "CreateInfrastructureConfigurationResponse$clientToken": "The client token that uniquely identifies the request.
", "CreateLifecyclePolicyRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "CreateLifecyclePolicyResponse$clientToken": "The client token that uniquely identifies the request.
", "CreateWorkflowRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "CreateWorkflowResponse$clientToken": "The client token that uniquely identifies the request.
", "DistributeImageRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "DistributeImageResponse$clientToken": "The client token that uniquely identifies the request.
", "ImportComponentRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "ImportComponentResponse$clientToken": "The client token that uniquely identifies the request.
", "ImportDiskImageRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "ImportDiskImageResponse$clientToken": "The client token that uniquely identifies the request.
", "ImportVmImageRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "ImportVmImageResponse$clientToken": "The client token that uniquely identifies the request.
", "RetryImageRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "RetryImageResponse$clientToken": "The client token that uniquely identifies the request.
", "SendWorkflowStepActionRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "SendWorkflowStepActionResponse$clientToken": "The client token that uniquely identifies the request.
", "StartImagePipelineExecutionRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "StartImagePipelineExecutionResponse$clientToken": "The client token that uniquely identifies the request.
", "StartResourceStateUpdateRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "UpdateDistributionConfigurationRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "UpdateDistributionConfigurationResponse$clientToken": "The client token that uniquely identifies the request.
", "UpdateImagePipelineRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "UpdateImagePipelineResponse$clientToken": "The client token that uniquely identifies the request.
", "UpdateInfrastructureConfigurationRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
", "UpdateInfrastructureConfigurationResponse$clientToken": "The client token that uniquely identifies the request.
", "UpdateLifecyclePolicyRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
" } }, "Component": { "base": "A detailed view of a component.
", "refs": { "GetComponentResponse$component": "The component object specified in the request.
" } }, "ComponentBuildVersionArn": { "base": null, "refs": { "ComponentFailureContext$componentArn": "The Amazon Resource Name (ARN) of the component build version that failed.
", "CreateComponentResponse$componentBuildVersionArn": "The Amazon Resource Name (ARN) of the component that the request created.
", "DeleteComponentRequest$componentBuildVersionArn": "The Amazon Resource Name (ARN) of the component build version to delete.
", "DeleteComponentResponse$componentBuildVersionArn": "The Amazon Resource Name (ARN) of the component build version that this request deleted.
", "GetComponentPolicyRequest$componentArn": "The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.
", "ImportComponentResponse$componentBuildVersionArn": "The Amazon Resource Name (ARN) of the imported component.
", "PutComponentPolicyRequest$componentArn": "The Amazon Resource Name (ARN) of the component that this policy should be applied to.
", "PutComponentPolicyResponse$componentArn": "The Amazon Resource Name (ARN) of the component that this policy was applied to.
" } }, "ComponentConfiguration": { "base": "Configuration details of the component. You can specify each component only once in a recipe, regardless of version. Components with a status of DEPRECATED or DISABLED can't be added to new recipes.
Build and test components that are included in the container recipe. A recipe can contain a maximum of 20 build and test components in any combination, by default. This maximum is an adjustable quota. For more information, see EC2 Image Builder endpoints and quotas in the Amazon Web Services General Reference.
", "CreateContainerRecipeRequest$components": "The components included in the container recipe. You can specify each component only one time in a recipe.
", "CreateImageRecipeRequest$components": "The components included in the image recipe. Components are optional. A recipe with no components bakes the base image without additional customization. You can specify each component only one time in a recipe. Components with a status of DEPRECATED or DISABLED can't be added to new recipes.
The components that are included in the image recipe. A recipe can contain a maximum of 20 build and test components in any combination, by default. This maximum is an adjustable quota. For more information, see EC2 Image Builder endpoints and quotas in the Amazon Web Services General Reference.
" } }, "ComponentData": { "base": null, "refs": { "Component$data": "Component data contains the YAML document content for the component.
" } }, "ComponentFailureContext": { "base": "Contains details about the component that caused the image creation process to fail. The details identify the first step that failed when the component ran.
", "refs": { "ImageFailureContext$componentFailure": "The details about the component that failed, if the failure occurred while a component was running.
" } }, "ComponentFormat": { "base": null, "refs": { "ImportComponentRequest$format": "The format of the resource that you want to import as a component.
" } }, "ComponentParameter": { "base": "Contains a key/value pair that sets the named component parameter.
", "refs": { "ComponentParameterList$member": null } }, "ComponentParameterDescription": { "base": null, "refs": { "ComponentParameterDetail$description": "Describes this parameter.
" } }, "ComponentParameterDetail": { "base": "Defines a parameter that is used to provide configuration details for the component.
", "refs": { "ComponentParameterDetailList$member": null } }, "ComponentParameterDetailList": { "base": null, "refs": { "Component$parameters": "Contains parameter details for each of the parameters that the component document defined for the component.
" } }, "ComponentParameterList": { "base": null, "refs": { "ComponentConfiguration$parameters": "A group of parameter settings that Image Builder uses to configure the component for a specific recipe. You must supply a value for every component parameter that has no default value, and you can only supply parameters that the component defines.
" } }, "ComponentParameterName": { "base": null, "refs": { "ComponentParameter$name": "The name of the component parameter to set.
", "ComponentParameterDetail$name": "The name of this input parameter.
" } }, "ComponentParameterType": { "base": null, "refs": { "ComponentParameterDetail$type": "The type of input this parameter provides. The currently supported value is \"string\".
" } }, "ComponentParameterValue": { "base": null, "refs": { "ComponentParameterValueList$member": null } }, "ComponentParameterValueList": { "base": null, "refs": { "ComponentParameter$value": "Sets the value for the named component parameter.
", "ComponentParameterDetail$defaultValue": "The default value of this parameter if no input is provided.
" } }, "ComponentState": { "base": "A group of fields that describe the current status of components.
", "refs": { "Component$state": "Describes the current status of the component.
", "ComponentSummary$state": "Describes the current status of the component.
" } }, "ComponentStatus": { "base": null, "refs": { "ComponentState$status": "The current state of the component. Components with a status of DEPRECATED or DISABLED can't be added to new recipes.
Describes the current status of the component version.
" } }, "ComponentSummary": { "base": "A high-level summary of a component.
", "refs": { "ComponentSummaryList$member": null } }, "ComponentSummaryList": { "base": null, "refs": { "ListComponentBuildVersionsResponse$componentSummaryList": "The list of component summaries. Each summary represents one build version of the specified component version, or of the components that your account owns if you didn't specify an ARN. Deprecated build versions aren't included.
" } }, "ComponentType": { "base": null, "refs": { "Component$type": "The component type specifies whether Image Builder uses the component to build the image or only to test it.
", "ComponentSummary$type": "The component type specifies whether Image Builder uses the component to build the image or only to test it.
", "ComponentVersion$type": "The type of the component denotes whether the component is used to build the image or only to test it.
", "ImportComponentRequest$type": "The type of the component denotes whether the component is used to build the image, or only to test it.
" } }, "ComponentVersion": { "base": "The defining characteristics of a specific version of a component.
", "refs": { "ComponentVersionList$member": null } }, "ComponentVersionArn": { "base": null, "refs": { "ListComponentBuildVersionsRequest$componentVersionArn": "The component version ARN whose build versions you want to list. The ARN must specify an exact version, without a build number suffix. If you don't specify an ARN, Image Builder returns build versions for the components that your account owns.
If the ARN that you specify doesn't exist, Image Builder returns an empty list rather than a ResourceNotFoundException error.
The Amazon Resource Name (ARN) of the component. You can specify a build version ARN, or a component version ARN whose version segments can use x wildcards, for example 1.x.x.
The Amazon Resource Name (ARN) of the component that you want to get. You can specify a build version ARN, or a component version ARN. The version can use the x wildcard in trailing positions, for example 1.0.x or 1.x.x. Version ARNs resolve to the latest available matching component build version.
The list of component semantic versions.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
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 reaches 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.
" } }, "Container": { "base": "Details of the container images that are output resources of an image build in a given Amazon Web Services Region: the Region, and the URIs of the container images.
", "refs": { "ContainerList$member": null } }, "ContainerDistributionConfiguration": { "base": "Defines how the output container image is distributed in a specific Amazon Web Services Region: the target repository, the image tags to apply to the distributed image, and an optional description.
", "refs": { "Distribution$containerDistributionConfiguration": "Container distribution settings for encryption, licensing, and sharing in a specific Region.
" } }, "ContainerList": { "base": null, "refs": { "OutputResources$containers": "The container images that Image Builder created when it built this image, stored in the output Amazon ECR repository.
" } }, "ContainerRecipe": { "base": "Defines how Image Builder builds and tests a container image: the base image, components to apply, the Dockerfile template, the build and test instance configuration, and the target repository for the output image.
", "refs": { "GetContainerRecipeResponse$containerRecipe": "The container recipe object that is returned.
", "Image$containerRecipe": "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.
" } }, "ContainerRecipeArn": { "base": null, "refs": { "CreateContainerRecipeResponse$containerRecipeArn": "Returns the Amazon Resource Name (ARN) of the container recipe that the request created.
", "CreateImagePipelineRequest$containerRecipeArn": "The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline. You must specify either this property or imageRecipeArn, but not both.
The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested. You must specify either this property or imageRecipeArn, but not both.
The Amazon Resource Name (ARN) of the container recipe to delete.
", "DeleteContainerRecipeResponse$containerRecipeArn": "The Amazon Resource Name (ARN) of the container recipe that was deleted.
", "GetContainerRecipePolicyRequest$containerRecipeArn": "The Amazon Resource Name (ARN) of the container recipe for the policy being requested.
", "GetContainerRecipeRequest$containerRecipeArn": "The Amazon Resource Name (ARN) of the container recipe to retrieve.
", "PutContainerRecipePolicyRequest$containerRecipeArn": "The Amazon Resource Name (ARN) of the container recipe that this policy should be applied to.
", "PutContainerRecipePolicyResponse$containerRecipeArn": "The Amazon Resource Name (ARN) of the container recipe that this policy was applied to.
", "UpdateImagePipelineRequest$containerRecipeArn": "The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline. You must specify either this property or imageRecipeArn, but not both.
A summary of a container recipe.
", "refs": { "ContainerRecipeSummaryList$member": null } }, "ContainerRecipeSummaryList": { "base": null, "refs": { "ListContainerRecipesResponse$containerRecipeSummaryList": "The list of container recipes returned for the request.
" } }, "ContainerRepositoryService": { "base": null, "refs": { "TargetContainerRepository$service": "Specifies the service in which this image was registered.
" } }, "ContainerType": { "base": null, "refs": { "ContainerRecipe$containerType": "Specifies the type of container, such as Docker.
", "ContainerRecipeSummary$containerType": "Specifies the type of container, such as \"Docker\".
", "CreateContainerRecipeRequest$containerType": "The type of container to create.
" } }, "CreateComponentRequest": { "base": null, "refs": {} }, "CreateComponentResponse": { "base": null, "refs": {} }, "CreateContainerRecipeRequest": { "base": null, "refs": {} }, "CreateContainerRecipeResponse": { "base": null, "refs": {} }, "CreateDistributionConfigurationRequest": { "base": null, "refs": {} }, "CreateDistributionConfigurationResponse": { "base": null, "refs": {} }, "CreateImagePipelineRequest": { "base": null, "refs": {} }, "CreateImagePipelineResponse": { "base": null, "refs": {} }, "CreateImageRecipeRequest": { "base": null, "refs": {} }, "CreateImageRecipeResponse": { "base": null, "refs": {} }, "CreateImageRequest": { "base": null, "refs": {} }, "CreateImageResponse": { "base": null, "refs": {} }, "CreateInfrastructureConfigurationRequest": { "base": null, "refs": {} }, "CreateInfrastructureConfigurationResponse": { "base": null, "refs": {} }, "CreateLifecyclePolicyRequest": { "base": null, "refs": {} }, "CreateLifecyclePolicyResponse": { "base": null, "refs": {} }, "CreateWorkflowRequest": { "base": null, "refs": {} }, "CreateWorkflowResponse": { "base": null, "refs": {} }, "CvssScore": { "base": "A CVSS score for the vulnerability, as published by the vulnerability source. Sources include the National Vulnerability Database (NVD) and the operating system vendor's security feed. A finding can include CVSS scores from multiple sources and CVSS versions.
", "refs": { "CvssScoreList$member": null } }, "CvssScoreAdjustment": { "base": "Details about an adjustment that Amazon Inspector made to the CVSS score for a finding.
", "refs": { "CvssScoreAdjustmentList$member": null } }, "CvssScoreAdjustmentList": { "base": null, "refs": { "CvssScoreDetails$adjustments": "The adjustments that Amazon Inspector applied to the base CVSS score to produce its own score for the finding. The list is empty when Amazon Inspector made no adjustments.
" } }, "CvssScoreDetails": { "base": "Details about the source of the score, and the factors that determined the adjustments to create the final score.
", "refs": { "InspectorScoreDetails$adjustedCvss": "The CVSS score that Amazon Inspector assigned to the finding after applying its adjustments. It includes the score source, CVSS version, scoring vector, and the adjustments applied.
" } }, "CvssScoreList": { "base": null, "refs": { "PackageVulnerabilityDetails$cvss": "The CVSS scores for the vulnerability in this finding, as published by the vulnerability sources. Sources include NVD and the operating system vendor, and scores can span CVSS versions.
" } }, "DateTime": { "base": null, "refs": { "Component$dateCreated": "The date that Image Builder created the component.
", "ComponentSummary$dateCreated": "The date that Image Builder created this version of the component.
", "ComponentVersion$dateCreated": "The date that the component was created.
", "ContainerRecipe$dateCreated": "The date when this container recipe was created.
", "ContainerRecipeSummary$dateCreated": "The date when this container recipe was created.
", "DistributionConfiguration$dateCreated": "The date on which this distribution configuration was created.
", "DistributionConfiguration$dateUpdated": "The date on which this distribution configuration was last updated.
", "DistributionConfigurationSummary$dateCreated": "The date on which the distribution configuration was created.
", "DistributionConfigurationSummary$dateUpdated": "The date on which the distribution configuration was updated.
", "GetWorkflowExecutionResponse$startTime": "The timestamp when the specified runtime instance of the workflow started.
", "GetWorkflowExecutionResponse$endTime": "The timestamp when the specified runtime instance of the workflow finished.
", "GetWorkflowStepExecutionResponse$startTime": "The timestamp when the specified runtime instance of the workflow step started.
", "GetWorkflowStepExecutionResponse$endTime": "The timestamp when the specified runtime instance of the workflow step finished.
", "Image$dateCreated": "The date on which Image Builder created this image.
", "ImagePipeline$dateCreated": "The date on which this image pipeline was created.
", "ImagePipeline$dateUpdated": "The date on which this image pipeline was last updated.
", "ImagePipeline$dateLastRun": "The date on which this image pipeline was last run.
", "ImagePipeline$dateNextRun": "The next date when the pipeline is scheduled to run.
", "ImageRecipe$dateCreated": "The date on which this image recipe was created.
", "ImageRecipeSummary$dateCreated": "The date on which this image recipe was created.
", "ImageSummary$dateCreated": "The date on which Image Builder created this image.
", "ImageVersion$dateCreated": "The date on which this specific version of the Image Builder image was created.
", "InfrastructureConfiguration$dateCreated": "The date on which the infrastructure configuration was created.
", "InfrastructureConfiguration$dateUpdated": "The date on which the infrastructure configuration was last updated.
", "InfrastructureConfigurationSummary$dateCreated": "The date on which the infrastructure configuration was created.
", "InfrastructureConfigurationSummary$dateUpdated": "The date on which the infrastructure configuration was last updated.
", "Workflow$dateCreated": "The timestamp when Image Builder created the workflow resource.
", "WorkflowExecutionMetadata$startTime": "The timestamp when the runtime instance of this workflow started.
", "WorkflowExecutionMetadata$endTime": "The timestamp when this runtime instance of the workflow finished.
", "WorkflowStepExecution$startTime": "The timestamp when the workflow step started.
", "WorkflowStepMetadata$startTime": "The timestamp when the workflow step started.
", "WorkflowStepMetadata$endTime": "The timestamp when the workflow step finished.
", "WorkflowSummary$dateCreated": "The original creation date of the workflow resource.
", "WorkflowVersion$dateCreated": "The timestamp when Image Builder created the workflow version.
" } }, "DateTimeTimestamp": { "base": null, "refs": { "Image$deprecationTime": "The time when deprecation occurs for an image resource. This can be a past or future date.
", "ImageScanFinding$firstObservedAt": "The date and time when the finding was first observed.
", "ImageScanFinding$updatedAt": "The timestamp when the finding was last updated.
", "ImageSummary$deprecationTime": "The time when deprecation occurs for an image resource. This can be a past or future date.
", "LifecycleExecution$startTime": "The timestamp when the lifecycle runtime instance started.
", "LifecycleExecution$endTime": "The timestamp when the lifecycle runtime instance completed.
", "LifecycleExecutionResource$startTime": "The starting timestamp from the lifecycle action that was applied to the resource.
", "LifecycleExecutionResource$endTime": "The ending timestamp from the lifecycle action that was applied to the resource.
", "LifecyclePolicy$dateCreated": "The timestamp when Image Builder created the lifecycle policy resource.
", "LifecyclePolicy$dateUpdated": "The timestamp when Image Builder updated the lifecycle policy resource.
", "LifecyclePolicy$dateLastRun": "The timestamp for the last time Image Builder ran the lifecycle policy.
", "LifecyclePolicySummary$dateCreated": "The timestamp when Image Builder created the lifecycle policy resource.
", "LifecyclePolicySummary$dateUpdated": "The timestamp when Image Builder updated the lifecycle policy resource.
", "LifecyclePolicySummary$dateLastRun": "The timestamp for the last time Image Builder ran the lifecycle policy.
", "PackageVulnerabilityDetails$vendorCreatedAt": "The date and time when this vulnerability was first added to the vendor's database.
", "PackageVulnerabilityDetails$vendorUpdatedAt": "The date and time when the vendor last updated this vulnerability in their database.
", "StartResourceStateUpdateRequest$updateAt": "The timestamp that indicates when resources are updated by a lifecycle action. This property is valid only when the target status is DEPRECATED, and the value must be a future time. If you don't specify a value, Image Builder begins the state update right away. For a scheduled deprecation, included AMIs get their EC2 deprecation time set immediately, and Image Builder schedules the image resource to transition to DEPRECATED at that time.
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.
Defines the settings for a specific Region.
", "refs": { "DistributionList$member": null } }, "DistributionConfiguration": { "base": "Defines how Image Builder distributes the output of an image build. You can configure:
The Regions to distribute the image to.
The Region-specific settings to apply, such as output AMI names, launch permissions for other Amazon Web Services accounts, and target container repositories.
The distribution configuration object.
", "Image$distributionConfiguration": "The distribution configuration that Image Builder used to create this image.
" } }, "DistributionConfigurationArn": { "base": null, "refs": { "CreateDistributionConfigurationResponse$distributionConfigurationArn": "The Amazon Resource Name (ARN) of the distribution configuration that was created by this request.
", "CreateImagePipelineRequest$distributionConfigurationArn": "The Amazon Resource Name (ARN) of the distribution configuration that configures and distributes images created by this image pipeline.
", "CreateImageRequest$distributionConfigurationArn": "The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of the image build. If you don't specify a distribution configuration, Image Builder creates the output image only in the account and Amazon Web Services Region where the build runs.
", "DeleteDistributionConfigurationRequest$distributionConfigurationArn": "The Amazon Resource Name (ARN) of the distribution configuration to delete.
", "DeleteDistributionConfigurationResponse$distributionConfigurationArn": "The Amazon Resource Name (ARN) of the distribution configuration that was deleted.
", "DistributeImageRequest$distributionConfigurationArn": "The Amazon Resource Name (ARN) of the distribution configuration. The configuration defines target Regions, accounts, and AMI settings. The distribution configuration must be in the same Region as this operation.
", "GetDistributionConfigurationRequest$distributionConfigurationArn": "The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.
", "UpdateDistributionConfigurationRequest$distributionConfigurationArn": "The Amazon Resource Name (ARN) of the distribution configuration that you want to update.
", "UpdateDistributionConfigurationResponse$distributionConfigurationArn": "The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request.
", "UpdateImagePipelineRequest$distributionConfigurationArn": "The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images created by this image pipeline.
" } }, "DistributionConfigurationSummary": { "base": "A high-level overview of a distribution configuration.
", "refs": { "DistributionConfigurationSummaryList$member": null } }, "DistributionConfigurationSummaryList": { "base": null, "refs": { "ListDistributionConfigurationsResponse$distributionConfigurationSummaryList": "The list of distributions.
" } }, "DistributionFailureContext": { "base": "Contains details about a failure that occurred while Image Builder distributed the image or applied configuration to the distributed image.
", "refs": { "ImageFailureContext$distributionFailure": "The details about the distribution failure, if the failure occurred while Image Builder distributed or configured the image.
" } }, "DistributionList": { "base": null, "refs": { "CreateDistributionConfigurationRequest$distributions": "The distribution settings for the configuration. Each entry defines how output images are distributed in one target Amazon Web Services Region. A Region can appear at most once in the list.
", "DistributionConfiguration$distributions": "The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions.
", "UpdateDistributionConfigurationRequest$distributions": "The distribution settings for the configuration. Each entry defines how output images are distributed in one target Amazon Web Services Region. A Region can appear at most once in the list. This list replaces the configuration's existing distributions entirely.
" } }, "DistributionTimeoutMinutes": { "base": null, "refs": { "DistributionConfiguration$timeoutMinutes": "A property that Image Builder doesn't use. You can't set this property when you create or update a distribution configuration, and it has no effect on distribution behavior.
" } }, "DockerFileTemplate": { "base": null, "refs": { "ContainerRecipe$dockerfileTemplateData": "The Dockerfile template that Image Builder uses to build the container image. The template can include contextual variables that Image Builder replaces with build information at build time. For the contextual variables that the template can include, see Create a new version of a container recipe in the EC2 Image Builder User Guide.
" } }, "DryRunOperationException": { "base": "The dry run operation of the resource was successful, and no resources or mutations were actually performed due to the dry run flag in the request.
", "refs": {} }, "EbsInstanceBlockDeviceSpecification": { "base": "Amazon EBS-specific block device mapping specifications.
", "refs": { "InstanceBlockDeviceMapping$ebs": "The Amazon EBS-specific configuration for this mapping.
" } }, "EbsIopsInteger": { "base": null, "refs": { "EbsInstanceBlockDeviceSpecification$iops": "The IOPS value for the device. Required only when volumeType is io1 or io2.
" } }, "EbsVolumeSizeInteger": { "base": null, "refs": { "EbsInstanceBlockDeviceSpecification$volumeSize": "Overrides the volume size for the device.
" } }, "EbsVolumeThroughput": { "base": null, "refs": { "EbsInstanceBlockDeviceSpecification$throughput": "For GP3 volumes only – The throughput in MiB/s that the volume supports.
" } }, "EbsVolumeType": { "base": null, "refs": { "EbsInstanceBlockDeviceSpecification$volumeType": "Overrides the volume type for the device.
" } }, "EcrConfiguration": { "base": "Settings that Image Builder uses to configure the ECR repository and the output container images that Amazon Inspector scans.
", "refs": { "ImageScanningConfiguration$ecrConfiguration": "Contains Amazon ECR settings for vulnerability scans.
" } }, "EmptyString": { "base": null, "refs": { "InstanceBlockDeviceMapping$noDevice": "Specifies a mapping to remove from the base image.
" } }, "ErrorMessage": { "base": null, "refs": { "AccessDeniedException$message": null, "CallRateLimitExceededException$message": null, "ClientException$message": null, "DryRunOperationException$message": null, "ForbiddenException$message": null, "IdempotentParameterMismatchException$message": null, "InvalidPaginationTokenException$message": null, "InvalidParameterCombinationException$message": null, "InvalidParameterException$message": null, "InvalidParameterValueException$message": null, "InvalidRequestException$message": null, "InvalidVersionNumberException$message": null, "ResourceAlreadyExistsException$message": null, "ResourceDependencyException$message": null, "ResourceInUseException$message": null, "ResourceNotFoundException$message": null, "ServiceException$message": null, "ServiceQuotaExceededException$message": null, "ServiceUnavailableException$message": null, "TooManyRequestsException$message": null } }, "FastLaunchConfiguration": { "base": "Defines and configures EC2 Fast Launch for output Windows AMIs.
", "refs": { "FastLaunchConfigurationList$member": null } }, "FastLaunchConfigurationList": { "base": null, "refs": { "Distribution$fastLaunchConfigurations": "The Windows faster-launching configurations to use for AMI distribution.
" } }, "FastLaunchLaunchTemplateSpecification": { "base": "Identifies the launch template that the associated Windows AMI uses for launching an instance when Windows fast launch is enabled.
You can specify either the launchTemplateName or the launchTemplateId, but not both.
The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
" } }, "FastLaunchSnapshotConfiguration": { "base": "Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
", "refs": { "FastLaunchConfiguration$snapshotConfiguration": "Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when Windows fast launch is enabled.
" } }, "Filter": { "base": "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.
", "refs": { "FilterList$member": null, "ListImageScanFindingAggregationsRequest$filter": "A filter name and value pair that determines the type of aggregation that Image Builder returns. Use one of the following filter names:
imageBuildVersionArn
imagePipelineArn
vulnerabilityId
If you don't specify a filter, Image Builder returns an aggregation for your account.
" } }, "FilterList": { "base": null, "refs": { "ListComponentsRequest$filters": "Use the following filters to streamline results:
description
name
platform
productCodes
status
supportedOsVersion
type
version
Use the following filters to streamline results:
containerType
name
parentImage
platform
You can filter on name to streamline results.
Use the following filters to streamline results:
name
osVersion
platform
type
version
Use the following filters to streamline results:
name
version
Use the following filters to streamline results:
description
distributionConfigurationArn
imageRecipeArn
infrastructureConfigurationArn
name
status
Use the following filters to streamline results:
name
parentImage
platform
Use the following filters to streamline results:
name
osVersion
platform
type
version
You can filter on name to streamline results.
Use the following filters to streamline results: name, resourceType, and status. Filter names are matched exactly as shown.
Filters to narrow the list of workflows. You can filter on name, version, description, and type.
The name of the filter. Filter names are case-sensitive.
The name filter matches the name that you gave the resource when you created it, exactly as you entered it. It doesn't match the name segment of the resource ARN, which Image Builder converts to lowercase with hyphens in place of spaces and underscores. For example, a resource named My Image has an ARN that contains my-image – filter on My Image to find it.
The name of the image scan finding filter. Filter names are case-sensitive. Valid filter names are:
imageBuildVersionArn – Filters findings by the image build version that was scanned.
imagePipelineArn – Filters findings by the pipeline that created the scanned image.
vulnerabilityId – Filters findings by vulnerability ID, for example a CVE ID.
severity – Filters findings by severity level.
The filter values. Filter values are case-sensitive.
The name filter can use a wildcard: web* matches names that begin with web, and *web* matches names that contain web. The wildcard isn't supported in other positions or in other filters.
You are not authorized to perform the requested operation.
", "refs": {} }, "GetComponentPolicyRequest": { "base": null, "refs": {} }, "GetComponentPolicyResponse": { "base": null, "refs": {} }, "GetComponentRequest": { "base": null, "refs": {} }, "GetComponentResponse": { "base": null, "refs": {} }, "GetContainerRecipePolicyRequest": { "base": null, "refs": {} }, "GetContainerRecipePolicyResponse": { "base": null, "refs": {} }, "GetContainerRecipeRequest": { "base": null, "refs": {} }, "GetContainerRecipeResponse": { "base": null, "refs": {} }, "GetDistributionConfigurationRequest": { "base": null, "refs": {} }, "GetDistributionConfigurationResponse": { "base": null, "refs": {} }, "GetImagePipelineRequest": { "base": null, "refs": {} }, "GetImagePipelineResponse": { "base": null, "refs": {} }, "GetImagePolicyRequest": { "base": null, "refs": {} }, "GetImagePolicyResponse": { "base": null, "refs": {} }, "GetImageRecipePolicyRequest": { "base": null, "refs": {} }, "GetImageRecipePolicyResponse": { "base": null, "refs": {} }, "GetImageRecipeRequest": { "base": null, "refs": {} }, "GetImageRecipeResponse": { "base": null, "refs": {} }, "GetImageRequest": { "base": null, "refs": {} }, "GetImageResponse": { "base": null, "refs": {} }, "GetInfrastructureConfigurationRequest": { "base": "GetInfrastructureConfiguration request object.
", "refs": {} }, "GetInfrastructureConfigurationResponse": { "base": "GetInfrastructureConfiguration response object.
", "refs": {} }, "GetLifecycleExecutionRequest": { "base": null, "refs": {} }, "GetLifecycleExecutionResponse": { "base": null, "refs": {} }, "GetLifecyclePolicyRequest": { "base": null, "refs": {} }, "GetLifecyclePolicyResponse": { "base": null, "refs": {} }, "GetMarketplaceResourceRequest": { "base": null, "refs": {} }, "GetMarketplaceResourceResponse": { "base": null, "refs": {} }, "GetWorkflowExecutionRequest": { "base": null, "refs": {} }, "GetWorkflowExecutionResponse": { "base": null, "refs": {} }, "GetWorkflowRequest": { "base": null, "refs": {} }, "GetWorkflowResponse": { "base": null, "refs": {} }, "GetWorkflowStepExecutionRequest": { "base": null, "refs": {} }, "GetWorkflowStepExecutionResponse": { "base": null, "refs": {} }, "HttpPutResponseHopLimit": { "base": null, "refs": { "InstanceMetadataOptions$httpPutResponseHopLimit": "Limit the number of hops that an instance metadata request can traverse to reach its destination. If you don't set a value, the EC2 launch default for the instance applies. If HTTP tokens are required, container image builds need a minimum of two hops.
" } }, "HttpTokens": { "base": null, "refs": { "InstanceMetadataOptions$httpTokens": "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.
If you don't set a value, the EC2 launch default applies to the build and test instances. That default depends on the base AMI and any account-level instance metadata defaults. For more information, see Configure the instance metadata options in the Amazon EC2 User Guide .
" } }, "IdempotentParameterMismatchException": { "base": "You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
", "refs": {} }, "Image": { "base": "An Image Builder image resource that keeps track of all of the settings used to create, configure, and distribute output for that image. An image that Image Builder built from a recipe contains exactly one recipe – either a container recipe (containerRecipe), which creates a container image, or an image recipe (imageRecipe), which creates an AMI. Imported images don't contain a recipe.
The image object.
" } }, "ImageAggregation": { "base": "Contains vulnerability counts for a specific image.
", "refs": { "ImageScanFindingAggregation$imageAggregation": "Returns an object that contains severity counts based on the Amazon Resource Name (ARN) for a specific image.
" } }, "ImageBuildMessage": { "base": null, "refs": { "ListWorkflowExecutionsResponse$message": "The failure reason for the image build version, if it's in a failed state. This comes from the image itself, not from an individual workflow, so it's available even when no workflow executions remain for the image.
", "ListWorkflowStepExecutionsResponse$message": "The output message from the list action, if applicable.
" } }, "ImageBuildVersionArn": { "base": null, "refs": { "CancelImageCreationRequest$imageBuildVersionArn": "The Amazon Resource Name (ARN) of the image that you want to cancel creation for.
", "CancelImageCreationResponse$imageBuildVersionArn": "The Amazon Resource Name (ARN) of the image whose creation this request canceled.
", "CreateImageResponse$imageBuildVersionArn": "The Amazon Resource Name (ARN) of the image that the request created.
", "DeleteImageRequest$imageBuildVersionArn": "The Amazon Resource Name (ARN) of the Image Builder image resource to delete.
", "DeleteImageResponse$imageBuildVersionArn": "The Amazon Resource Name (ARN) of the Image Builder image resource that this request deleted.
", "DistributeImageResponse$imageBuildVersionArn": "The Amazon Resource Name (ARN) of the new Image Builder image resource that this operation creates to track the distribution. Use this ARN with GetImage to monitor distribution progress.
", "GetImagePolicyRequest$imageArn": "The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.
", "GetWorkflowExecutionResponse$imageBuildVersionArn": "The Amazon Resource Name (ARN) of the image build version that owns the specified runtime instance of the workflow.
", "GetWorkflowStepExecutionResponse$imageBuildVersionArn": "The Amazon Resource Name (ARN) of the image build version that owns the specified runtime instance of the workflow step.
", "ImageAggregation$imageBuildVersionArn": "The Amazon Resource Name (ARN) that identifies the image for this aggregation.
", "ImageScanFinding$imageBuildVersionArn": "The Amazon Resource Name (ARN) of the image build version that's associated with the finding.
", "ImportDiskImageResponse$imageBuildVersionArn": "The Amazon Resource Name (ARN) of the Image Builder image resource that this request created. The AMI doesn't exist yet when the response returns. The import runs asynchronously, and the output AMI appears in the image's output resources when the import completes.
", "ListImagePackagesRequest$imageBuildVersionArn": "The Amazon Resource Name (ARN) of the image build version whose packages you want to list. The value must be a full build version ARN.
", "ListWorkflowExecutionsRequest$imageBuildVersionArn": "List all workflow runtime instances for the specified image build version resource ARN.
", "ListWorkflowExecutionsResponse$imageBuildVersionArn": "The resource Amazon Resource Name (ARN) of the image build version for which you requested a list of workflow runtime details.
", "ListWorkflowStepExecutionsResponse$imageBuildVersionArn": "The image build version resource Amazon Resource Name (ARN) that's associated with the specified runtime instance of the workflow.
", "PutImagePolicyRequest$imageArn": "The Amazon Resource Name (ARN) of the image that this policy should be applied to.
", "PutImagePolicyResponse$imageArn": "The Amazon Resource Name (ARN) of the image that this policy was applied to.
", "RetryImageRequest$imageBuildVersionArn": "The Amazon Resource Name (ARN) of the image build version that you want to retry. The image must be in the FAILED or CANCELLED state.
The ARN of the image to be retried.
", "SendWorkflowStepActionRequest$imageBuildVersionArn": "The Amazon Resource Name (ARN) of the image build version associated with the workflow step execution. This value must match the image that owns the waiting step. If the ARN does not correspond to the image running the workflow, then the request fails with a validation error.
", "SendWorkflowStepActionResponse$imageBuildVersionArn": "The Amazon Resource Name (ARN) of the image build version that received the action request.
", "StartImagePipelineExecutionResponse$imageBuildVersionArn": "The Amazon Resource Name (ARN) of the image that the request created.
", "StartResourceStateUpdateRequest$resourceArn": "The Amazon Resource Name (ARN) of the image build version to update. The image must be in one of these terminal states: AVAILABLE, DEPRECATED, DISABLED, FAILED, or CANCELLED. Images with FAILED or CANCELLED status can transition only to DELETED.
The requested Amazon Resource Name (ARN) of the Image Builder resource for the asynchronous update.
", "WorkflowStepExecution$imageBuildVersionArn": "The Amazon Resource Name (ARN) of the image build version that ran the workflow.
" } }, "ImageBuilderArn": { "base": null, "refs": { "Component$arn": "The Amazon Resource Name (ARN) of the component.
", "ComponentSummary$arn": "The Amazon Resource Name (ARN) of the component.
", "ComponentVersion$arn": "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:
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.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
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:
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.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
The Amazon Resource Name (ARN) of the container recipe.
", "DistributionConfiguration$arn": "The Amazon Resource Name (ARN) of the distribution configuration.
", "DistributionConfigurationSummary$arn": "The Amazon Resource Name (ARN) of the distribution configuration.
", "GetMarketplaceResourceRequest$resourceArn": "The Amazon Resource Name (ARN) that uniquely identifies an Amazon Web Services Marketplace resource.
", "GetMarketplaceResourceResponse$resourceArn": "The Amazon Resource Name (ARN) for the Amazon Web Services Marketplace resource that was requested.
", "Image$arn": "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:
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.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
The Amazon Resource Name (ARN) of the image pipeline.
", "ImageRecipe$arn": "The Amazon Resource Name (ARN) of the image recipe.
", "ImageRecipeSummary$arn": "The Amazon Resource Name (ARN) of the image recipe.
", "ImageSummary$arn": "The Amazon Resource Name (ARN) of the image.
", "ImageVersion$arn": "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:
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.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
The Amazon Resource Name (ARN) of the infrastructure configuration.
", "InfrastructureConfigurationSummary$arn": "The Amazon Resource Name (ARN) of the infrastructure configuration.
", "LatestVersionReferences$latestVersionArn": "The latest version Amazon Resource Name (ARN) of the Image Builder resource.
", "LatestVersionReferences$latestMajorVersionArn": "The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.
The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.
The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.
The Amazon Resource Name (ARN) of the resource for which to list lifecycle executions. Specify a lifecycle policy ARN to list its executions, or an image build version ARN to list the executions that StartResourceStateUpdate started for that image. Other ARN types aren't valid for this request.
", "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource that you want to tag.
", "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource that you want to untag.
" } }, "ImageConfigurationStep": { "base": null, "refs": { "RegionFailure$imageConfigurationStep": "The image configuration step where the failure occurred. Image Builder sets this property when the failure happened during post-distribution configuration, such as launch template updates or virtual machine (VM) export. This property doesn't appear for failures that occurred while Image Builder copied the image to the Region.
" } }, "ImageFailureContext": { "base": "Contains details about the failure when the image creation process fails. Properties appear in the failure context when the related information is available for the failure.
", "refs": { "ImageState$failureContext": "The details about the failure, for images that failed to complete. Image Builder only sets this property when the image status is FAILED.
The logging configuration that's defined for the image. Image Builder uses the defined settings to direct execution log output during image creation.
", "refs": { "CreateImageRequest$loggingConfiguration": "The CloudWatch Logs log group where Image Builder sends the image build logs. If you specify a log group name outside of the /aws/imagebuilder/ namespace, you must also provide an executionRole that has permission to write to that log group.
The logging configuration for the distribution.
", "Image$loggingConfiguration": "The logging configuration that's defined for the image. Image Builder uses the defined settings to direct execution log output during image creation.
", "ImageSummary$loggingConfiguration": "The logging configuration that's defined for the image.
", "ImportDiskImageRequest$loggingConfiguration": "The CloudWatch Logs log group where Image Builder sends the import logs. If you specify a log group name outside of the /aws/imagebuilder/ namespace, you must also provide an executionRole that has permission to write to that log group.
The CloudWatch Logs log group where Image Builder sends the import logs. For ImportVmImage, the log group name must be within the /aws/imagebuilder/ namespace.
A software package that's installed on an image, as detected by Amazon Web Services Systems Manager Inventory at build time. The list includes packages that shipped with the base image.
", "refs": { "ImagePackageList$member": null } }, "ImagePackageList": { "base": null, "refs": { "ListImagePackagesResponse$imagePackageList": "The list of Image Packages returned in the response.
" } }, "ImagePipeline": { "base": "Defines the automation configuration for building, testing, and distributing images. A pipeline references the resources that its builds use, such as the recipe and infrastructure configuration. It also holds the settings that control its builds, such as the schedule and custom workflows.
", "refs": { "GetImagePipelineResponse$imagePipeline": "The image pipeline object.
", "ImagePipelineList$member": null } }, "ImagePipelineAggregation": { "base": "Contains vulnerability counts for a specific image pipeline.
", "refs": { "ImageScanFindingAggregation$imagePipelineAggregation": "Returns an object that contains severity counts based on an image pipeline ARN.
" } }, "ImagePipelineArn": { "base": null, "refs": { "CreateImagePipelineResponse$imagePipelineArn": "The Amazon Resource Name (ARN) of the image pipeline that was created by this request.
", "DeleteImagePipelineRequest$imagePipelineArn": "The Amazon Resource Name (ARN) of the image pipeline to delete.
", "DeleteImagePipelineResponse$imagePipelineArn": "The Amazon Resource Name (ARN) of the image pipeline that was deleted.
", "GetImagePipelineRequest$imagePipelineArn": "The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.
", "ImagePipelineAggregation$imagePipelineArn": "The Amazon Resource Name (ARN) that identifies the image pipeline for this aggregation.
", "ImageScanFinding$imagePipelineArn": "The Amazon Resource Name (ARN) of the image pipeline that's associated with the finding.
", "ListImagePipelineImagesRequest$imagePipelineArn": "The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.
If the ARN that you specify doesn't exist, Image Builder returns an empty list rather than a ResourceNotFoundException error.
The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.
", "UpdateImagePipelineRequest$imagePipelineArn": "The Amazon Resource Name (ARN) of the image pipeline that you want to update.
", "UpdateImagePipelineResponse$imagePipelineArn": "The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.
" } }, "ImagePipelineList": { "base": null, "refs": { "ListImagePipelinesResponse$imagePipelineList": "The list of image pipelines.
" } }, "ImageRecipe": { "base": "An image recipe.
", "refs": { "GetImageRecipeResponse$imageRecipe": "The image recipe object.
", "Image$imageRecipe": "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.
" } }, "ImageRecipeArn": { "base": null, "refs": { "CreateImagePipelineRequest$imageRecipeArn": "The Amazon Resource Name (ARN) of the image recipe that configures images created by this image pipeline. You must specify either this property or containerRecipeArn, but not both.
The Amazon Resource Name (ARN) of the image recipe that was created by this request.
", "CreateImageRequest$imageRecipeArn": "The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed. You must specify either this property or containerRecipeArn, but not both.
The Amazon Resource Name (ARN) of the image recipe to delete.
", "DeleteImageRecipeResponse$imageRecipeArn": "The Amazon Resource Name (ARN) of the image recipe that was deleted.
", "GetImageRecipePolicyRequest$imageRecipeArn": "The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve.
", "GetImageRecipeRequest$imageRecipeArn": "The Amazon Resource Name (ARN) of the image recipe that you want to retrieve. You can use the x wildcard in trailing version positions to retrieve the latest matching version, for example x.x.x or 1.x.x.
The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to.
", "PutImageRecipePolicyResponse$imageRecipeArn": "The Amazon Resource Name (ARN) of the image recipe that this policy was applied to.
", "UpdateImagePipelineRequest$imageRecipeArn": "The Amazon Resource Name (ARN) of the image recipe that configures images created by this image pipeline. You must specify either this property or containerRecipeArn, but not both.
A summary of an image recipe.
", "refs": { "ImageRecipeSummaryList$member": null } }, "ImageRecipeSummaryList": { "base": null, "refs": { "ListImageRecipesResponse$imageRecipeSummaryList": "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.
Contains details about a vulnerability scan finding that Amazon Inspector generated for an image.
", "refs": { "ImageScanFindingsList$member": null } }, "ImageScanFindingAggregation": { "base": "This returns exactly one type of aggregation, based on the filter that Image Builder applies in its API action.
", "refs": { "ImageScanFindingAggregationsList$member": null } }, "ImageScanFindingAggregationsList": { "base": null, "refs": { "ListImageScanFindingAggregationsResponse$responses": "An array of image scan finding aggregations that match the filter criteria.
" } }, "ImageScanFindingsFilter": { "base": "A name value pair that Image Builder applies to streamline results from the vulnerability scan findings list action.
", "refs": { "ImageScanFindingsFilterList$member": null } }, "ImageScanFindingsFilterList": { "base": null, "refs": { "ListImageScanFindingsRequest$filters": "An array of name value pairs that you can use to filter your results. You can use the following filters to streamline results:
imageBuildVersionArn – Filters findings by the image build version that was scanned.
imagePipelineArn – Filters findings by the pipeline that created the scanned image.
vulnerabilityId – Filters findings by vulnerability ID, for example a CVE ID.
severity – Filters findings by severity level.
If you don't request a filter, then all findings in your account are listed.
" } }, "ImageScanFindingsFilterValues": { "base": null, "refs": { "ImageScanFindingsFilter$values": "The filter values. Filter values are case-sensitive.
" } }, "ImageScanFindingsList": { "base": null, "refs": { "ListImageScanFindingsResponse$findings": "The image scan findings for your account that meet your request filter criteria.
" } }, "ImageScanState": { "base": "Shows the vulnerability scan status for a specific image, and the reason for that status.
", "refs": { "Image$scanState": "Contains information about the current state of scans for this image.
" } }, "ImageScanStatus": { "base": null, "refs": { "ImageScanState$status": "The current state of vulnerability scans for the image. The scan starts as PENDING and moves through SCANNING and COLLECTING to COMPLETED. Image Builder sets the status to ABANDONED if the image reaches a terminal state before the scan finding collection completes. A scan can also end as FAILED or TIMED_OUT.
Contains settings for Image Builder image resource and container image scans.
", "refs": { "CreateImagePipelineRequest$imageScanningConfiguration": "The settings that determine whether and how Amazon Inspector scans the images that this pipeline creates.
", "CreateImageRequest$imageScanningConfiguration": "The settings that determine whether and how Amazon Inspector scans the image for vulnerabilities.
", "Image$imageScanningConfiguration": "The settings that determine whether and how Amazon Inspector scans this image.
", "ImagePipeline$imageScanningConfiguration": "The settings that determine whether and how Amazon Inspector scans the images that the pipeline creates.
", "UpdateImagePipelineRequest$imageScanningConfiguration": "The updated settings that determine whether and how Amazon Inspector scans the images that this pipeline creates.
" } }, "ImageScanningType": { "base": null, "refs": { "ImageScanningTypeList$member": null } }, "ImageScanningTypeList": { "base": null, "refs": { "ImageScanningConfiguration$imageScanningTypes": "The type of vulnerability scan that Image Builder runs for AMI output when imageScanningEnabled is true. Specify a single value. If you omit imageScanningTypes, Image Builder uses TEST_INSTANCE_CVE. The scan types work as follows:
With TEST_INSTANCE_CVE, Amazon Inspector scans the test instance during image tests. To use this scan, you must activate Amazon Inspector for Amazon EC2 scanning in the account and Amazon Web Services Region where the build runs. The Image Builder ListImageScanFindings operation returns the findings.
With ON_DEMAND_AMI_CVE, Amazon Inspector starts an on-demand scan of the output AMI during image tests. To use this scan, you must build from an image recipe, but you do not need to activate Amazon Inspector in your account. The Amazon EC2 GetImageFindings operation returns the findings.
The origin of the base image that Image Builder used to build this image.
", "ImageSummary$imageSource": "The origin of the base image that Image Builder used to build this image.
", "ImageVersion$imageSource": "The origin of the base image that Image Builder used to build this image.
" } }, "ImageState": { "base": "Image status and the reason for that status.
", "refs": { "Ami$state": "The state of the AMI, which includes the status and, if applicable, the reason for that status.
", "Image$state": "The state of the image.
", "ImageSummary$state": "The state of the image.
" } }, "ImageStatus": { "base": null, "refs": { "ImageFailureContext$imageStatus": "The status that the image had when the failure occurred. This indicates the stage of the image creation process where the image failed, for example BUILDING or DISTRIBUTING.
The status of the last image that this pipeline built, such as BUILDING, TESTING, FAILED, or AVAILABLE.
The status of the image. A new image moves through build, test, and distribution statuses during creation, and ends in the AVAILABLE, FAILED, or CANCELLED state. The DEPRECATED, DISABLED, and DELETED statuses come from later resource management actions.
An image summary.
", "refs": { "ImageSummaryList$member": null } }, "ImageSummaryList": { "base": null, "refs": { "ListImageBuildVersionsResponse$imageSummaryList": "The list of image build versions.
", "ListImagePipelineImagesResponse$imageSummaryList": "The list of images built by this pipeline.
" } }, "ImageTestsConfiguration": { "base": "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.
", "refs": { "CreateImagePipelineRequest$imageTestsConfiguration": "Specifies the test settings that Image Builder applies to images that this pipeline creates. If you don't provide test settings, Image Builder stores a default configuration with image tests enabled.
", "CreateImageRequest$imageTestsConfiguration": "Settings that determine whether Image Builder runs tests on the image after building it. Image tests are enabled by default.
", "Image$imageTestsConfiguration": "The image test settings that Image Builder used when it created this image.
", "ImagePipeline$imageTestsConfiguration": "The image tests configuration of the image pipeline.
", "UpdateImagePipelineRequest$imageTestsConfiguration": "Specifies the test settings that Image Builder applies to images that this pipeline creates. If you don't provide test settings, Image Builder stores a default configuration with image tests enabled.
" } }, "ImageTestsTimeoutMinutes": { "base": null, "refs": { "ImageTestsConfiguration$timeoutMinutes": "The maximum time in minutes that tests are permitted to run. If you don't specify a value, Image Builder stores and returns 720.
The timeout property is not currently active. This value is ignored.
Specifies whether this image produces an AMI or a container image.
", "ImageRecipe$type": "The output image type. For an image recipe, this is always AMI. Container images are built from container recipes, a separate resource. This field isn't currently returned in responses.
", "ImageSummary$type": "Specifies whether this image produces an AMI or a container image.
", "ImageVersion$type": "Specifies whether this image produces an AMI or a container image.
" } }, "ImageVersion": { "base": "The defining characteristics of a specific version of an Image Builder image.
", "refs": { "ImageVersionList$member": null } }, "ImageVersionArn": { "base": null, "refs": { "ListImageBuildVersionsRequest$imageVersionArn": "The Amazon Resource Name (ARN) of the image version whose build versions you want to retrieve. The ARN must specify an exact version (<major>.<minor>.<patch>) - wildcards aren't allowed. This parameter is optional. If you don't specify it, Image Builder returns build versions for all of the images in your account.
If the ARN that you specify doesn't exist, Image Builder returns an empty list rather than a ResourceNotFoundException error.
The Amazon Resource Name (ARN) of the image that you want to get. You can specify a full build version ARN, or a version ARN with or without wildcards (x.x.x, 1.x.x, or 1.0.x). A version or wildcard ARN resolves to the latest matching build version that has reached AVAILABLE status. Builds that were later deprecated, disabled, or deleted don't resolve. To get an image in any other state, such as a failed or in-progress build, specify the full build version ARN.
The list of image semantic versions.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Filtering: You can 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.
Details of the infrastructure configuration.
", "refs": { "GetInfrastructureConfigurationResponse$infrastructureConfiguration": "The infrastructure configuration object.
", "Image$infrastructureConfiguration": "The infrastructure that Image Builder used to create this image.
" } }, "InfrastructureConfigurationArn": { "base": null, "refs": { "CreateImagePipelineRequest$infrastructureConfigurationArn": "The Amazon Resource Name (ARN) of the infrastructure configuration that builds images created by this image pipeline.
", "CreateImageRequest$infrastructureConfigurationArn": "The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
", "CreateInfrastructureConfigurationResponse$infrastructureConfigurationArn": "The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.
", "DeleteInfrastructureConfigurationRequest$infrastructureConfigurationArn": "The Amazon Resource Name (ARN) of the infrastructure configuration to delete.
", "DeleteInfrastructureConfigurationResponse$infrastructureConfigurationArn": "The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted.
", "GetInfrastructureConfigurationRequest$infrastructureConfigurationArn": "The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve.
", "ImportDiskImageRequest$infrastructureConfigurationArn": "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.
", "UpdateImagePipelineRequest$infrastructureConfigurationArn": "The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images created by this image pipeline.
", "UpdateInfrastructureConfigurationRequest$infrastructureConfigurationArn": "The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.
", "UpdateInfrastructureConfigurationResponse$infrastructureConfigurationArn": "The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request.
" } }, "InfrastructureConfigurationSummary": { "base": "Contains a high-level summary of an infrastructure configuration, including the environment settings that Image Builder uses to build and test images.
", "refs": { "InfrastructureConfigurationSummaryList$member": null } }, "InfrastructureConfigurationSummaryList": { "base": null, "refs": { "ListInfrastructureConfigurationsResponse$infrastructureConfigurationSummaryList": "The list of infrastructure configurations.
" } }, "InlineComponentData": { "base": null, "refs": { "CreateComponentRequest$data": "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.
The Dockerfile template used to build your image, as an inline data blob. You must specify exactly one of the dockerfileTemplateData or dockerfileTemplateUri properties. For the contextual variables that the template can include, see Create a new version of a container recipe in the EC2 Image Builder User Guide.
The UTF-8 encoded YAML document content for the workflow, up to 16,000 characters. For larger documents, store the document in Amazon S3 and specify the uri property instead. You must specify exactly one of the data or uri properties.
Information about the factors that influenced the score that Amazon Inspector assigned for a finding.
", "refs": { "ImageScanFinding$inspectorScoreDetails": "An object that contains details of the Amazon Inspector score.
" } }, "InstanceBlockDeviceMapping": { "base": "Defines block device mappings for the instance used to configure your image.
", "refs": { "InstanceBlockDeviceMappings$member": null } }, "InstanceBlockDeviceMappings": { "base": null, "refs": { "CreateImageRecipeRequest$blockDeviceMappings": "The block device mappings that Image Builder applies to the build instance and the output AMI. For example, you can override the size of the base image's root volume or attach additional EBS volumes.
", "ImageRecipe$blockDeviceMappings": "The block device mappings to apply when creating images from this recipe.
", "InstanceConfiguration$blockDeviceMappings": "Defines the block device mappings for the EC2 instance that Image Builder launches to build and test your container image.
" } }, "InstanceConfiguration": { "base": "Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.
", "refs": { "ContainerRecipe$instanceConfiguration": "A group of options that can be used to configure an instance for building and testing container images.
", "CreateContainerRecipeRequest$instanceConfiguration": "A group of options that can be used to configure an instance for building and testing container images.
" } }, "InstanceMetadataOptions": { "base": "The instance metadata service (IMDS) settings that Image Builder applies to the EC2 build and test instances it launches. These settings control how software on those instances retrieves instance metadata and IAM role credentials.
", "refs": { "CreateInfrastructureConfigurationRequest$instanceMetadataOptions": "The instance metadata service (IMDS) settings that Image Builder applies to the EC2 build and test instances it launches during image creation. If you don't set these options, the EC2 launch defaults for the instance apply. For more information about instance metadata options, see one of the following links:
Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances.
Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows instances.
The instance metadata option settings for the infrastructure configuration.
", "UpdateInfrastructureConfigurationRequest$instanceMetadataOptions": "The instance metadata service (IMDS) settings that Image Builder applies to the EC2 build and test instances it launches during image creation. If you don't set these options, the EC2 launch defaults for the instance apply. For more information about instance metadata options, see one of the following links:
Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances.
Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows instances.
The instance profile to associate with the instance used to customize your Amazon EC2 AMI. The instance profile must exist in your account.
", "InfrastructureConfiguration$instanceProfileName": "The instance profile of the infrastructure configuration.
", "InfrastructureConfigurationSummary$instanceProfileName": "The instance profile of the infrastructure configuration.
", "UpdateInfrastructureConfigurationRequest$instanceProfileName": "The instance profile to associate with the instance used to customize your Amazon EC2 AMI. The instance profile must exist in your account.
" } }, "InstanceType": { "base": null, "refs": { "InstanceTypeList$member": null } }, "InstanceTypeList": { "base": null, "refs": { "CreateInfrastructureConfigurationRequest$instanceTypes": "The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. Image Builder picks one of these instance types based on availability. If you don't specify instance types, Image Builder selects compatible instance types automatically. If you specify a Dedicated Host, Image Builder uses only instance types that the host supports.
", "InfrastructureConfiguration$instanceTypes": "The instance types of the infrastructure configuration.
", "InfrastructureConfigurationSummary$instanceTypes": "The instance types of the infrastructure configuration.
", "UpdateInfrastructureConfigurationRequest$instanceTypes": "The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. Image Builder picks one of these instance types based on availability. If you don't specify instance types, Image Builder selects compatible instance types automatically. If you specify a Dedicated Host, Image Builder uses only instance types that the host supports.
" } }, "InvalidPaginationTokenException": { "base": "You have provided an invalid pagination token in your request.
", "refs": {} }, "InvalidParameterCombinationException": { "base": "You have specified a combination of parameters that isn't valid. For example, two mutually exclusive parameters, or a parameter without its required companion parameter. Review the error message for details.
", "refs": {} }, "InvalidParameterException": { "base": "The specified parameter is invalid. Review the available parameters for the API request.
", "refs": {} }, "InvalidParameterValueException": { "base": "The value that you provided for the specified parameter is invalid.
", "refs": {} }, "InvalidRequestException": { "base": "The request is malformed or otherwise invalid. Verify the request and try again.
", "refs": {} }, "InvalidVersionNumberException": { "base": "Your version number is out of bounds or does not follow the required syntax.
", "refs": {} }, "LatestVersionReferences": { "base": "A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.
", "refs": { "CreateComponentResponse$latestVersionReferences": "A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.
", "CreateContainerRecipeResponse$latestVersionReferences": "A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.
", "CreateImageRecipeResponse$latestVersionReferences": "A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.
", "CreateImageResponse$latestVersionReferences": "A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.
", "CreateWorkflowResponse$latestVersionReferences": "A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.
", "GetComponentResponse$latestVersionReferences": "A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.
", "GetContainerRecipeResponse$latestVersionReferences": "A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.
", "GetImageRecipeResponse$latestVersionReferences": "A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.
", "GetImageResponse$latestVersionReferences": "A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.
", "GetWorkflowResponse$latestVersionReferences": "A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.
" } }, "LaunchPermissionConfiguration": { "base": "Describes the configuration for a launch permission. The launch permission modification request is sent to the Amazon EC2 ModifyImageAttribute API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set userGroups to the value all. See the examples for making an AMI public at Amazon EC2 ModifyImageAttribute.
Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
" } }, "LaunchTemplateConfiguration": { "base": "Identifies an Amazon EC2 launch template to use for a specific account.
", "refs": { "LaunchTemplateConfigurationList$member": null } }, "LaunchTemplateConfigurationList": { "base": null, "refs": { "Distribution$launchTemplateConfigurations": "A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.
" } }, "LaunchTemplateId": { "base": null, "refs": { "FastLaunchLaunchTemplateSpecification$launchTemplateId": "The ID of the launch template to use for Windows fast launch for a Windows AMI.
", "LaunchTemplateConfiguration$launchTemplateId": "Identifies the Amazon EC2 launch template to use.
" } }, "LicenseConfigurationArn": { "base": null, "refs": { "LicenseConfigurationArnList$member": null } }, "LicenseConfigurationArnList": { "base": null, "refs": { "Distribution$licenseConfigurationArns": "The License Manager Configuration to associate with the AMI in the specified Region.
" } }, "LifecycleExecution": { "base": "Contains metadata from a runtime instance of a lifecycle policy.
", "refs": { "GetLifecycleExecutionResponse$lifecycleExecution": "Runtime details for the specified runtime instance of the lifecycle policy.
", "LifecycleExecutionsList$member": null } }, "LifecycleExecutionId": { "base": null, "refs": { "CancelLifecycleExecutionRequest$lifecycleExecutionId": "Identifies the specific runtime instance of the image lifecycle to cancel.
", "CancelLifecycleExecutionResponse$lifecycleExecutionId": "The unique identifier of the lifecycle execution that the cancellation request applies to. The cancellation completes asynchronously.
", "GetLifecycleExecutionRequest$lifecycleExecutionId": "The unique identifier for a runtime instance of the lifecycle policy.
", "Image$lifecycleExecutionId": "Identifies the last runtime instance of the lifecycle policy to take action on the image.
", "ImageSummary$lifecycleExecutionId": "Identifies the last runtime instance of the lifecycle policy to take action on the image.
", "LifecycleExecution$lifecycleExecutionId": "Identifies the lifecycle policy runtime instance.
", "ListLifecycleExecutionResourcesRequest$lifecycleExecutionId": "The unique identifier for a runtime instance of the lifecycle policy.
", "ListLifecycleExecutionResourcesResponse$lifecycleExecutionId": "The unique identifier for the runtime instance of the lifecycle policy.
", "StartResourceStateUpdateResponse$lifecycleExecutionId": "Identifies the lifecycle execution that performs the resource state update. Image Builder only returns this field when it started a lifecycle execution for the update. Use it with GetLifecycleExecution to track progress.
" } }, "LifecycleExecutionResource": { "base": "Contains details for a resource that the runtime instance of the lifecycle policy identified for action.
", "refs": { "LifecycleExecutionResourceList$member": null } }, "LifecycleExecutionResourceAction": { "base": "The lifecycle policy action that was identified for the impacted resource.
", "refs": { "LifecycleExecutionResource$action": "The action to take for the identified resource.
" } }, "LifecycleExecutionResourceActionName": { "base": null, "refs": { "LifecycleExecutionResourceAction$name": "The name of the lifecycle action that was identified for the resource.
" } }, "LifecycleExecutionResourceList": { "base": null, "refs": { "ListLifecycleExecutionResourcesResponse$resources": "A list of resources that were identified for lifecycle actions.
" } }, "LifecycleExecutionResourceState": { "base": "Contains the state of an impacted resource that the runtime instance of the lifecycle policy identified for action.
", "refs": { "LifecycleExecutionResource$state": "The runtime state of the lifecycle action for this resource.
", "LifecycleExecutionSnapshotResource$state": "The runtime status of the lifecycle action taken for the snapshot.
" } }, "LifecycleExecutionResourceStatus": { "base": null, "refs": { "LifecycleExecutionResourceState$status": "The runtime status of the lifecycle action taken for the impacted resource.
" } }, "LifecycleExecutionResourcesImpactedSummary": { "base": "Contains an indicator that shows whether the lifecycle execution identified any resources to take lifecycle actions on.
", "refs": { "LifecycleExecution$resourcesImpactedSummary": "A summary flag that indicates whether the lifecycle execution identified any resources to take lifecycle actions on.
" } }, "LifecycleExecutionSnapshotResource": { "base": "Contains the state of an impacted snapshot resource that the runtime instance of the lifecycle policy identified for action.
", "refs": { "LifecycleExecutionSnapshotResourceList$member": null } }, "LifecycleExecutionSnapshotResourceList": { "base": null, "refs": { "LifecycleExecutionResource$snapshots": "A list of associated resource snapshots for the impacted resource if it’s an AMI.
" } }, "LifecycleExecutionState": { "base": "The current state of the runtime instance of the lifecycle policy.
", "refs": { "LifecycleExecution$state": "Runtime state that reports whether the lifecycle execution is in progress, succeeded, or failed.
", "ListLifecycleExecutionResourcesResponse$lifecycleExecutionState": "The current state of the lifecycle runtime instance.
" } }, "LifecycleExecutionStatus": { "base": null, "refs": { "LifecycleExecutionState$status": "The runtime status of the lifecycle execution.
" } }, "LifecycleExecutionsList": { "base": null, "refs": { "ListLifecycleExecutionsResponse$lifecycleExecutions": "A list of lifecycle runtime instances for the specified resource.
" } }, "LifecyclePolicy": { "base": "Defines a lifecycle policy resource: its identity, status, execution role, resource type, rules, resource selection, timestamps, and tags.
", "refs": { "GetLifecyclePolicyResponse$lifecyclePolicy": "The details of the lifecycle policy that the request retrieved.
" } }, "LifecyclePolicyArn": { "base": null, "refs": { "CreateLifecyclePolicyResponse$lifecyclePolicyArn": "The Amazon Resource Name (ARN) of the lifecycle policy that the request created.
", "DeleteLifecyclePolicyRequest$lifecyclePolicyArn": "The Amazon Resource Name (ARN) of the lifecycle policy resource to delete.
", "DeleteLifecyclePolicyResponse$lifecyclePolicyArn": "The Amazon Resource Name (ARN) of the lifecycle policy that was deleted.
", "GetLifecyclePolicyRequest$lifecyclePolicyArn": "Specifies the Amazon Resource Name (ARN) of the image lifecycle policy resource to get.
", "LifecycleExecution$lifecyclePolicyArn": "The Amazon Resource Name (ARN) of the lifecycle policy that ran.
", "LifecyclePolicy$arn": "The Amazon Resource Name (ARN) of the lifecycle policy resource.
", "LifecyclePolicySummary$arn": "The Amazon Resource Name (ARN) of the lifecycle policy.
", "UpdateLifecyclePolicyRequest$lifecyclePolicyArn": "The Amazon Resource Name (ARN) of the lifecycle policy resource.
", "UpdateLifecyclePolicyResponse$lifecyclePolicyArn": "The Amazon Resource Name (ARN) of the image lifecycle policy resource that was updated.
" } }, "LifecyclePolicyDetail": { "base": "Defines one lifecycle policy rule: the action to take, the filter that determines which resources the rule applies to, and optional exclusion rules.
", "refs": { "LifecyclePolicyDetails$member": null } }, "LifecyclePolicyDetailAction": { "base": "Contains the action configuration for a lifecycle policy rule: the action to take, and which underlying resources the action extends to.
", "refs": { "LifecyclePolicyDetail$action": "Configuration details for the policy action.
" } }, "LifecyclePolicyDetailActionIncludeResources": { "base": "Specifies how the lifecycle policy should apply actions to selected resources.
", "refs": { "LifecyclePolicyDetailAction$includeResources": "Specifies which underlying resources the action extends to beyond the Image Builder image resource itself: distributed AMIs, their snapshots, or distributed container images. DELETE rules can include all three, DEPRECATE and DISABLE rules can include AMIs only, and you can only include snapshots together with AMIs.
Specifies the lifecycle action to take. DELETE deletes the image resource and, with includeResources, also removes distributed AMIs, snapshots, or container images. DEPRECATE and DISABLE set the corresponding status on the image resource and, if includeResources.amis is set, on its distributed AMIs.
Specifies resources that lifecycle policy actions should not apply to.
", "refs": { "LifecyclePolicyDetail$exclusionRules": "Additional rules to specify resources that should be exempt from policy actions.
" } }, "LifecyclePolicyDetailExclusionRulesAmis": { "base": "Defines criteria for AMIs that are excluded from lifecycle actions.
", "refs": { "LifecyclePolicyDetailExclusionRules$amis": "Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action.
", "ResourceStateUpdateExclusionRules$amis": "Defines criteria for AMIs that Image Builder should exclude from the resource state update.
" } }, "LifecyclePolicyDetailExclusionRulesAmisLastLaunched": { "base": "Defines criteria to exclude AMIs from lifecycle actions based on the last time they were used to launch an instance.
", "refs": { "LifecyclePolicyDetailExclusionRulesAmis$lastLaunched": "Configures Image Builder to exclude AMIs that were launched within the specified time period from lifecycle actions. AMIs with no recorded last-launched time aren't excluded by this rule.
" } }, "LifecyclePolicyDetailExclusionRulesAmisLastLaunchedValue": { "base": null, "refs": { "LifecyclePolicyDetailExclusionRulesAmisLastLaunched$value": "The integer number of units for the time period. For example 6 (months).
Defines filters that the lifecycle policy uses to determine impacted resource.
", "refs": { "LifecyclePolicyDetail$filter": "Specifies the resources that the lifecycle policy applies to.
" } }, "LifecyclePolicyDetailFilterRetainAtLeast": { "base": null, "refs": { "LifecyclePolicyDetailFilter$retainAtLeast": "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.
Filter resources based on either AGE or COUNT. You can only use the count filter with the DELETE action type.
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.
Configuration details for the lifecycle policy rules. A policy can contain at most one rule per action type: one DELETE, one DEPRECATE, and one DISABLE.
The list of rules for the lifecycle policy. Each rule pairs an action with a filter and optional exclusion rules. A policy can contain at most one rule per action type.
", "UpdateLifecyclePolicyRequest$policyDetails": "The configuration details for a lifecycle policy resource.
" } }, "LifecyclePolicyResourceSelection": { "base": "Resource selection criteria for the lifecycle policy. You must provide exactly one selection criteria: either recipes or a tag map, not both.
", "refs": { "CreateLifecyclePolicyRequest$resourceSelection": "Selection criteria for the resources that the lifecycle policy applies to. You must specify exactly one selection criteria: either recipes or a tag map, not both.
", "LifecyclePolicy$resourceSelection": "Resource selection criteria used to run the lifecycle policy.
", "UpdateLifecyclePolicyRequest$resourceSelection": "Selection criteria for resources that the lifecycle policy applies to. You must specify exactly one selection criteria: either recipes or a tag map, not both.
" } }, "LifecyclePolicyResourceSelectionRecipe": { "base": "Specifies an Image Builder recipe that the lifecycle policy uses for resource selection.
", "refs": { "LifecyclePolicyResourceSelectionRecipes$member": null } }, "LifecyclePolicyResourceSelectionRecipes": { "base": null, "refs": { "LifecyclePolicyResourceSelection$recipes": "A list of recipes that are used as selection criteria for the output images that the lifecycle policy applies to.
" } }, "LifecyclePolicyResourceType": { "base": null, "refs": { "CreateLifecyclePolicyRequest$resourceType": "The type of Image Builder resource that the lifecycle policy applies to. The resource type determines the allowed rule actions: policies for AMI-based Image Builder images support DELETE, DEPRECATE, and DISABLE, and policies for container-based Image Builder images support only DELETE. You can't change the resource type after creation.
The type of resources the lifecycle policy targets.
", "LifecyclePolicySummary$resourceType": "The type of resources the lifecycle policy targets.
", "UpdateLifecyclePolicyRequest$resourceType": "The type of image resource that the lifecycle policy applies to. The value must match the policy's existing resource type. You can't change the resource type of an existing lifecycle policy.
" } }, "LifecyclePolicyStatus": { "base": null, "refs": { "CreateLifecyclePolicyRequest$status": "Indicates whether the lifecycle policy resource is enabled. If you don't specify a status, it defaults to ENABLED. Only enabled policies run on their schedule.
Indicates whether the lifecycle policy resource is enabled. Only enabled policies run on their schedule. Disabling or deleting a policy removes its schedule and cancels any in-flight lifecycle execution.
", "LifecyclePolicySummary$status": "The lifecycle policy resource status.
", "UpdateLifecyclePolicyRequest$status": "Indicates whether the lifecycle policy resource is enabled. Defaults to ENABLED when omitted, so updating a disabled policy without setting this property re-enables it.
Contains a summary of lifecycle policy resources.
", "refs": { "LifecyclePolicySummaryList$member": null } }, "LifecyclePolicySummaryList": { "base": null, "refs": { "ListLifecyclePoliciesResponse$lifecyclePolicySummaryList": "A list of lifecycle policies in your Amazon Web Services account that meet the criteria specified in the request.
" } }, "LifecyclePolicyTimeUnit": { "base": null, "refs": { "LifecyclePolicyDetailExclusionRulesAmisLastLaunched$unit": "Defines the unit of time that the lifecycle policy uses to calculate elapsed time since the last launch.
", "LifecyclePolicyDetailFilter$unit": "Defines the unit of time that the lifecycle policy uses to determine impacted resources. This is required for age-based rules.
" } }, "ListComponentBuildVersionsRequest": { "base": null, "refs": {} }, "ListComponentBuildVersionsResponse": { "base": null, "refs": {} }, "ListComponentsRequest": { "base": null, "refs": {} }, "ListComponentsResponse": { "base": null, "refs": {} }, "ListContainerRecipesRequest": { "base": null, "refs": {} }, "ListContainerRecipesResponse": { "base": null, "refs": {} }, "ListDistributionConfigurationsRequest": { "base": null, "refs": {} }, "ListDistributionConfigurationsResponse": { "base": null, "refs": {} }, "ListImageBuildVersionsRequest": { "base": null, "refs": {} }, "ListImageBuildVersionsResponse": { "base": null, "refs": {} }, "ListImagePackagesRequest": { "base": null, "refs": {} }, "ListImagePackagesResponse": { "base": null, "refs": {} }, "ListImagePipelineImagesRequest": { "base": null, "refs": {} }, "ListImagePipelineImagesResponse": { "base": null, "refs": {} }, "ListImagePipelinesRequest": { "base": null, "refs": {} }, "ListImagePipelinesResponse": { "base": null, "refs": {} }, "ListImageRecipesRequest": { "base": null, "refs": {} }, "ListImageRecipesResponse": { "base": null, "refs": {} }, "ListImageScanFindingAggregationsRequest": { "base": null, "refs": {} }, "ListImageScanFindingAggregationsResponse": { "base": null, "refs": {} }, "ListImageScanFindingsRequest": { "base": null, "refs": {} }, "ListImageScanFindingsResponse": { "base": null, "refs": {} }, "ListImagesRequest": { "base": null, "refs": {} }, "ListImagesResponse": { "base": null, "refs": {} }, "ListInfrastructureConfigurationsRequest": { "base": null, "refs": {} }, "ListInfrastructureConfigurationsResponse": { "base": null, "refs": {} }, "ListLifecycleExecutionResourcesRequest": { "base": null, "refs": {} }, "ListLifecycleExecutionResourcesResponse": { "base": null, "refs": {} }, "ListLifecycleExecutionsRequest": { "base": null, "refs": {} }, "ListLifecycleExecutionsResponse": { "base": null, "refs": {} }, "ListLifecyclePoliciesRequest": { "base": null, "refs": {} }, "ListLifecyclePoliciesResponse": { "base": null, "refs": {} }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "ListWaitingWorkflowStepsRequest": { "base": null, "refs": {} }, "ListWaitingWorkflowStepsResponse": { "base": null, "refs": {} }, "ListWorkflowBuildVersionsRequest": { "base": null, "refs": {} }, "ListWorkflowBuildVersionsResponse": { "base": null, "refs": {} }, "ListWorkflowExecutionsRequest": { "base": null, "refs": {} }, "ListWorkflowExecutionsResponse": { "base": null, "refs": {} }, "ListWorkflowStepExecutionsRequest": { "base": null, "refs": {} }, "ListWorkflowStepExecutionsResponse": { "base": null, "refs": {} }, "ListWorkflowsRequest": { "base": null, "refs": {} }, "ListWorkflowsResponse": { "base": null, "refs": {} }, "LogGroupName": { "base": null, "refs": { "ImageLoggingConfiguration$logGroupName": "The log group name that Image Builder uses for image creation. If not specified, the log group name defaults to /aws/imagebuilder/image-name.
Specifies the CloudWatch Logs log group name for image build logs. The log group name can contain alphanumeric characters, hyphens, underscores, forward slashes, and periods, up to 512 characters. Log group names not starting with /aws/imagebuilder/ require an executionRole with CloudWatch Logs write permissions. If not specified, defaults to /aws/imagebuilder/image-name.
Specifies the CloudWatch Logs log group name for pipeline execution logs. The log group name can contain alphanumeric characters, hyphens, underscores, forward slashes, and periods, up to 512 characters. Log group names not starting with /aws/imagebuilder/ require an executionRole with CloudWatch Logs write permissions. If not specified, defaults to /aws/imagebuilder/pipeline/pipeline-name.
Logging configuration defines where Image Builder uploads your logs.
", "refs": { "CreateInfrastructureConfigurationRequest$logging": "The logging configuration of the infrastructure configuration. When you configure S3 logs, Image Builder writes logs from the build and test process to the specified bucket under the key prefix.
", "InfrastructureConfiguration$logging": "The logging configuration of the infrastructure configuration. When you configure S3 logs, Image Builder writes logs from the build and test process to the specified bucket under the key prefix.
", "UpdateInfrastructureConfigurationRequest$logging": "The logging configuration of the infrastructure configuration. When you configure S3 logs, Image Builder writes logs from the build and test process to the specified bucket under the key prefix.
" } }, "MarketplaceResourceLocation": { "base": null, "refs": { "GetMarketplaceResourceRequest$resourceLocation": "The Amazon S3 location of the component artifact to retrieve, in s3://bucket/key form.
Specifies which type of Amazon Web Services Marketplace resource Image Builder retrieves.
" } }, "MaxParallelLaunches": { "base": null, "refs": { "FastLaunchConfiguration$maxParallelLaunches": "The maximum number of parallel instances that are launched for creating resources.
" } }, "MaximumSeverityLabel": { "base": null, "refs": { "ScanResultCondition$maximumSeverityLabel": "The maximum severity allowed for findings on the output AMI. A finding above this severity fails the image, unless fixAvailable excludes it. Valid values are INFORMATIONAL, LOW, MEDIUM, and HIGH. A CRITICAL finding that counts always fails the image.
The error message from the step that failed. Image Builder truncates messages that are longer than 1024 characters. The component log in Amazon CloudWatch Logs contains the full output.
", "DistributionFailureContext$errorMessage": "The error message for the distribution failure.
", "RegionFailure$errorMessage": "The error message for the failure in the Region.
" } }, "NonEmptyString": { "base": null, "refs": { "AccountAggregation$accountId": "Identifies the account that owns the aggregated resource findings.
", "Ami$region": "The Amazon Web Services Region of the Amazon EC2 AMI.
", "Ami$image": "The AMI ID of the Amazon EC2 AMI.
", "Ami$name": "The name of the Amazon EC2 AMI.
", "Ami$description": "The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.
", "Ami$accountId": "The account ID of the owner of the AMI.
", "AmiDistributionConfiguration$description": "The description to apply to the distributed AMI. Image Builder sets this as the output AMI's description in each target Region and account. If you don't specify a description, the AMI in the build Region uses the image recipe's description, if the recipe has one. Copies distributed to other Regions and accounts don't receive a default description.
", "AmiDistributionConfiguration$kmsKeyId": "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.
", "AutoScalingGroupConfiguration$name": "The name of the Auto Scaling group, in the same account and Amazon Web Services Region as the infrastructure configuration. To specify a group, you must have permissions to describe it.
", "CancelImageCreationResponse$requestId": "The request ID that uniquely identifies this request.
", "Component$description": "The description of the component.
", "Component$changeDescription": "Describes what change has been made in this version of the component, or what makes this version different from other versions of the component.
", "Component$owner": "The owner of the component. The value is your account ID for components that you own, the sharing account's ID for shared components, or Amazon, ThirdParty, or AWSMarketplace.
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.
", "Component$publisher": "Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
", "ComponentFailureContext$phaseName": "The name of the phase in the component document where the failure occurred, such as build, validate, or test.
The name of the step in the component document that failed.
", "ComponentFailureContext$action": "The action that the failed step runs, for example ExecuteBash.
Describes how or why the component changed state.
", "ComponentSummary$owner": "The owner of the component. The value is your account ID for components that you own, the sharing account's ID for shared components, or Amazon, ThirdParty, or AWSMarketplace.
The description of the component.
", "ComponentSummary$changeDescription": "The change description for this version of the component.
", "ComponentSummary$publisher": "Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
", "ComponentVersion$description": "The description of the component.
", "ComponentVersion$owner": "The owner of the component. The value is your account ID for components that you own, the sharing account's ID for shared components, or Amazon, ThirdParty, or AWSMarketplace.
Containers and container images are Region-specific. This is the Region context for the container.
", "ContainerDistributionConfiguration$description": "The description of the container distribution configuration.
", "ContainerRecipe$description": "The description of the container recipe.
", "ContainerRecipe$owner": "The owner of the container recipe.
", "ContainerRecipe$kmsKeyId": "The KMS key that Image Builder uses to encrypt the recipe's Dockerfile template data at rest. 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. If you don't specify a key, Image Builder encrypts the template data with a KMS key that Image Builder owns. This key isn't used to encrypt the output container image.
", "ContainerRecipe$parentImage": "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.
The working directory for use during build and test workflows.
", "ContainerRecipeSummary$owner": "The owner of the container recipe.
", "ContainerRecipeSummary$parentImage": "The base image for the container recipe.
", "ContainerRecipeSummary$instanceImage": "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.
", "CreateComponentRequest$description": "Describes the contents of the component.
", "CreateComponentRequest$changeDescription": "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.
", "CreateComponentRequest$kmsKeyId": "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. If you don't specify a key, Image Builder encrypts the component data with a KMS key that Image Builder owns.
", "CreateComponentResponse$requestId": "The request ID that uniquely identifies this request.
", "CreateContainerRecipeRequest$description": "The description of the container recipe.
", "CreateContainerRecipeRequest$imageOsVersionOverride": "Specifies the operating system version for the base image. Use this property only when the base image is a container image from a registry. When the base image is an Image Builder image, the operating system version comes from the parent image.
", "CreateContainerRecipeRequest$parentImage": "The base image for the container recipe. This can be an Image Builder image resource ARN or a container image URI from a registry, for example amazonlinux:latest.
The working directory for use during build and test workflows.
", "CreateContainerRecipeRequest$kmsKeyId": "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.
", "CreateContainerRecipeResponse$requestId": "The request ID that uniquely identifies this request.
", "CreateDistributionConfigurationRequest$description": "The description of the distribution configuration.
", "CreateDistributionConfigurationResponse$requestId": "The request ID that uniquely identifies this request.
", "CreateImagePipelineRequest$description": "The description of the image pipeline.
", "CreateImagePipelineResponse$requestId": "The request ID that uniquely identifies this request.
", "CreateImageRecipeRequest$description": "The description of the image recipe.
", "CreateImageRecipeRequest$parentImage": "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. The AMI must also be in the Region where you're creating the recipe.
", "CreateImageRecipeRequest$workingDirectory": "The working directory used during build and test workflows. If you don't specify a working directory, Image Builder uses /tmp for Linux and macOS build instances, and C:/ for Windows build instances.
The request ID that uniquely identifies this request.
", "CreateImageResponse$requestId": "The request ID that uniquely identifies this request.
", "CreateInfrastructureConfigurationRequest$description": "The description of the infrastructure configuration.
", "CreateInfrastructureConfigurationRequest$subnetId": "The subnet ID in which to place the instance used to customize your Amazon EC2 AMI. If you specify subnetId, you must also specify one or more security group IDs in securityGroupIds. Otherwise, the request fails.
The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.
", "CreateInfrastructureConfigurationResponse$requestId": "The request ID that uniquely identifies this request.
", "CreateLifecyclePolicyRequest$description": "Optional description for the lifecycle policy.
", "CreateWorkflowRequest$description": "Describes the workflow.
", "CreateWorkflowRequest$changeDescription": "Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.
", "CreateWorkflowRequest$kmsKeyId": "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. If you don't specify a key, Image Builder encrypts the workflow document with a KMS key that Image Builder owns.
", "CvssScore$scoringVector": "The vector string of the CVSS score.
", "CvssScore$version": "The CVSS version that generated the score.
", "CvssScore$source": "The source of the CVSS score.
", "CvssScoreAdjustment$metric": "The metric that Amazon Inspector used to adjust the CVSS score.
", "CvssScoreAdjustment$reason": "The reason for the CVSS score adjustment.
", "CvssScoreDetails$scoreSource": "The source for the CVSS score.
", "CvssScoreDetails$cvssSource": "The source of the CVSS data that the Amazon Inspector score for the finding is based on, for example NVD or a vendor security feed.
", "CvssScoreDetails$version": "The CVSS version that generated the score.
", "CvssScoreDetails$scoringVector": "A vector that measures the severity of the vulnerability.
", "DeleteComponentResponse$requestId": "The request ID that uniquely identifies this request.
", "DeleteContainerRecipeResponse$requestId": "The request ID that uniquely identifies this request.
", "DeleteDistributionConfigurationResponse$requestId": "The request ID that uniquely identifies this request.
", "DeleteImagePipelineResponse$requestId": "The request ID that uniquely identifies this request.
", "DeleteImageRecipeResponse$requestId": "The request ID that uniquely identifies this request.
", "DeleteImageResponse$requestId": "The request ID that uniquely identifies this request.
", "DeleteInfrastructureConfigurationResponse$requestId": "The request ID that uniquely identifies this request.
", "DistributeImageRequest$sourceImage": "The source image to distribute. You can specify the source in any of the following formats:
An AMI ID.
An Amazon Web Services Systems Manager Parameter Store reference, prefixed by ssm:, followed by the parameter name or ARN.
An Image Builder image Amazon Resource Name (ARN). An image version ARN resolves to the latest available build version.
Whichever format you use, the source must resolve to an AMI in the current Amazon Web Services Region.
", "Distribution$region": "The target Region.
", "DistributionConfiguration$description": "The description of the distribution configuration.
", "DistributionConfigurationSummary$description": "The description of the distribution configuration.
", "EbsInstanceBlockDeviceSpecification$kmsKeyId": "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.
", "EbsInstanceBlockDeviceSpecification$snapshotId": "The snapshot that defines the device contents.
", "EcrConfiguration$repositoryName": "The name of the container repository where Image Builder pushes the container image for the vulnerability scan. Provide the repository name only (a namespace path is allowed, but not the registry hostname); the repository must already exist in your account. If you don't specify a repository name, Image Builder creates the default repository image-builder-image-scanning-repository in your account.
The name of the launch template to use for Windows fast launch for a Windows AMI.
", "FastLaunchLaunchTemplateSpecification$launchTemplateVersion": "The version of the launch template to use for Windows fast launch for a Windows AMI.
", "GetComponentPolicyResponse$requestId": "The request ID that uniquely identifies this request.
", "GetComponentResponse$requestId": "The request ID that uniquely identifies this request.
", "GetContainerRecipePolicyResponse$requestId": "The request ID that uniquely identifies this request.
", "GetContainerRecipeResponse$requestId": "The request ID that uniquely identifies this request.
", "GetDistributionConfigurationResponse$requestId": "The request ID that uniquely identifies this request.
", "GetImagePipelineResponse$requestId": "The request ID that uniquely identifies this request.
", "GetImagePolicyResponse$requestId": "The request ID that uniquely identifies this request.
", "GetImageRecipePolicyResponse$requestId": "The request ID that uniquely identifies this request.
", "GetImageRecipeResponse$requestId": "The request ID that uniquely identifies this request.
", "GetImageResponse$requestId": "The request ID that uniquely identifies this request.
", "GetInfrastructureConfigurationResponse$requestId": "The request ID that uniquely identifies this request.
", "GetMarketplaceResourceResponse$url": "A time-limited presigned URL for downloading the component artifact from Amazon S3.
", "GetMarketplaceResourceResponse$data": "Returns obfuscated data that contains the YAML content of the component.
", "GetWorkflowExecutionResponse$requestId": "The request ID that uniquely identifies this request.
", "GetWorkflowStepExecutionResponse$requestId": "The request ID that uniquely identifies this request.
", "GetWorkflowStepExecutionResponse$onFailure": "The action that the workflow takes if this step fails, as configured in the workflow document. Abort fails the workflow and rolls back completed steps. Continue proceeds to the next step. If the step doesn't set a value, it defaults to Abort.
The name of the package that's reported to the operating system package manager.
", "ImagePackage$packageVersion": "The version of the package that's reported to the operating system package manager.
", "ImagePipeline$description": "The description of the image pipeline.
", "ImageRecipe$description": "The description of the image recipe.
", "ImageRecipe$owner": "The owner of the image recipe.
", "ImageRecipe$parentImage": "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
The working directory used during build and test workflows. If you don't specify a working directory, Image Builder uses /tmp for Linux and macOS build instances, and C:/ for Windows build instances.
The owner of the image recipe.
", "ImageRecipeSummary$parentImage": "The base image of the image recipe.
", "ImageScanFinding$awsAccountId": "The Amazon Web Services account ID that's associated with the finding.
", "ImageScanFinding$type": "The type of the finding. Image Builder looks for findings of the type PACKAGE_VULNERABILITY that apply to output images, and excludes other types.
The description of the finding.
", "ImageScanFinding$title": "The title of the finding.
", "ImageScanFinding$severity": "The severity of the finding. For more information, see Severity levels for Amazon Inspector findings in the Amazon Inspector User Guide.
", "ImageScanFinding$fixAvailable": "Details about whether a fix is available for any of the packages that are identified in the finding through a version update. Valid values include:
YES – A fix is available for all of the packages identified in the finding.
NO – No fix is available.
PARTIAL – A fix is available for some, but not all, of the packages identified in the finding.
The reason for the scan status for the image.
", "ImageState$reason": "The reason for the status of the image.
", "ImageSummary$owner": "The owner of the image.
", "ImageVersion$owner": "The owner of the image version.
", "ImportComponentRequest$description": "The description of the component. Describes the contents of the component.
", "ImportComponentRequest$changeDescription": "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.
", "ImportComponentRequest$data": "The data of the component. For the SHELL format, this is the plain script content. You must specify exactly one of the data or uri properties. For scripts that exceed the inline length constraint, use the uri property.
The Amazon Resource Name (ARN) of the KMS key that is 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. If you don't specify a key, Image Builder encrypts the component data with a KMS key that Image Builder owns.
", "ImportComponentResponse$requestId": "The request ID that uniquely identifies this request.
", "ImportDiskImageRequest$description": "The description for your disk image import.
", "ImportDiskImageRequest$platform": "The operating system platform for the imported image. Allowed values include the following: Windows.
The name of the base image that is created by the import process. Image Builder generates the image ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. If an image with the same name and semantic version already exists in your account in the same Amazon Web Services Region, the import creates a new build version for it.
", "ImportVmImageRequest$description": "The description for the base image that is created by the import process.
", "ImportVmImageRequest$vmImportTaskId": "The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. The import task doesn't need to be complete when you call ImportVmImage - Image Builder monitors the task and finishes creating the image when the task completes.
The request ID that uniquely identifies this request.
", "InfrastructureConfiguration$description": "The description of the infrastructure configuration.
", "InfrastructureConfiguration$subnetId": "The subnet ID of the infrastructure configuration.
", "InfrastructureConfiguration$keyPair": "The Amazon EC2 key pair of the infrastructure configuration.
", "InfrastructureConfiguration$snsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic to which Image Builder sends image build event notifications. Specify a standard topic. Image Builder doesn't support FIFO topics.
EC2 Image Builder can't send notifications to SNS topics that are encrypted using keys from other accounts. If your SNS topic is encrypted, the key must be owned by the same account that owns your Image Builder resources.
The description of the infrastructure configuration.
", "InstanceBlockDeviceMapping$deviceName": "The device to which these mappings apply.
", "InstanceBlockDeviceMapping$virtualName": "The virtual device name for instance ephemeral devices.
", "InstanceConfiguration$image": "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.
", "LifecycleExecutionResource$accountId": "The account that owns the impacted resource.
", "LifecycleExecutionResource$resourceId": "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
The Amazon Web Services Region where the lifecycle execution resource is stored.
", "LifecycleExecutionResourceAction$reason": "The reason why the lifecycle policy action is taken.
", "LifecycleExecutionResourceState$reason": "Messaging that clarifies the reason for the assigned status.
", "LifecycleExecutionSnapshotResource$snapshotId": "Identifies the impacted snapshot resource.
", "LifecycleExecutionState$reason": "The reason for the current status.
", "LifecyclePolicy$description": "Optional description for the lifecycle policy.
", "LifecyclePolicySummary$description": "Optional description for the lifecycle policy.
", "ListComponentBuildVersionsResponse$requestId": "The request ID that uniquely identifies this request.
", "ListComponentsResponse$requestId": "The request ID that uniquely identifies this request.
", "ListContainerRecipesResponse$requestId": "The request ID that uniquely identifies this request.
", "ListContainerRecipesResponse$nextToken": "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.
", "ListDistributionConfigurationsResponse$requestId": "The request ID that uniquely identifies this request.
", "ListImageBuildVersionsResponse$requestId": "The request ID that uniquely identifies this request.
", "ListImagePackagesResponse$requestId": "The request ID that uniquely identifies this request.
", "ListImagePipelineImagesResponse$requestId": "The request ID that uniquely identifies this request.
", "ListImagePipelinesResponse$requestId": "The request ID that uniquely identifies this request.
", "ListImageRecipesResponse$requestId": "The request ID that uniquely identifies this request.
", "ListImageScanFindingAggregationsResponse$requestId": "The request ID that uniquely identifies this request.
", "ListImageScanFindingAggregationsResponse$aggregationType": "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.
", "ListImageScanFindingsResponse$requestId": "The request ID that uniquely identifies this request.
", "ListImagesResponse$requestId": "The request ID that uniquely identifies this request.
", "ListInfrastructureConfigurationsResponse$requestId": "The request ID that uniquely identifies this request.
", "ListLifecycleExecutionResourcesRequest$parentResourceId": "The Amazon Resource Name (ARN) of an image build version to get the output resources for, such as AMIs or container images in Amazon ECR. You can get this value from the resourceId in the top-level response. If you leave this property empty, the response lists the Image Builder resources that the lifecycle execution identified for lifecycle actions. If the image build version that you specify in parentResourceId wasn't part of this lifecycle execution, the response contains an empty list.
The request ID that uniquely identifies this request.
", "ListWorkflowStepExecutionsResponse$requestId": "The request ID that uniquely identifies this request.
", "NonEmptyStringList$member": null, "PackageVulnerabilityDetails$source": "The source of the vulnerability information.
", "PackageVulnerabilityDetails$sourceUrl": "A link to the source of the vulnerability information.
", "PackageVulnerabilityDetails$vendorSeverity": "The severity that the vendor assigned to this vulnerability type.
", "Placement$availabilityZone": "The Availability Zone where your build and test instances will launch.
", "Placement$hostId": "The ID of the Dedicated Host on which build and test instances run. This only applies if tenancy is host.
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.
The request ID that uniquely identifies this request.
", "PutContainerRecipePolicyResponse$requestId": "The request ID that uniquely identifies this request.
", "PutImagePolicyResponse$requestId": "The request ID that uniquely identifies this request.
", "PutImageRecipePolicyResponse$requestId": "The request ID that uniquely identifies this request.
", "RegionFailure$region": "The Region where the failure occurred.
", "RegionList$member": null, "RemediationRecommendation$text": "The recommended course of action to remediate the finding.
", "RemediationRecommendation$url": "A link to more information about the recommended remediation for this vulnerability.
", "S3ExportConfiguration$roleName": "The name of the role that grants VM Import/Export permission to export images to your S3 bucket.
", "S3ExportConfiguration$s3Bucket": "The S3 bucket in which to store the output disk images for your VM.
", "S3ExportConfiguration$s3Prefix": "The Amazon S3 path for the bucket where the output disk images for your VM are stored.
", "S3Logs$s3BucketName": "The name of an existing Amazon S3 bucket where Image Builder saves build logs. The bucket isn't validated when you create or update the configuration, and Image Builder doesn't create it. The instance profile associated with this infrastructure configuration must have permission to write to the bucket.
", "S3Logs$s3KeyPrefix": "The Amazon S3 key prefix under which Image Builder writes build and test logs in the bucket.
", "Schedule$scheduleExpression": "The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition. You can specify a cron expression, or a rate expression such as rate(1 day).
For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.
", "SecurityGroupIds$member": null, "SendWorkflowStepActionRequest$reason": "The reason for the action. This value is stored with the step execution record and is accessible in subsequent workflow steps via step output references.
", "StartImagePipelineExecutionResponse$requestId": "The request ID that uniquely identifies this request.
", "StringList$member": null, "TargetContainerRepository$repositoryName": "The name of the container repository where the output container image is stored. Provide the repository name only (a namespace path such as team-a/my-repo is allowed, but not the registry hostname).
The description of the distribution configuration.
", "UpdateDistributionConfigurationResponse$requestId": "The request ID that uniquely identifies this request.
", "UpdateImagePipelineRequest$description": "The description of the image pipeline.
", "UpdateImagePipelineResponse$requestId": "The request ID that uniquely identifies this request.
", "UpdateInfrastructureConfigurationRequest$description": "The description of the infrastructure configuration.
", "UpdateInfrastructureConfigurationRequest$subnetId": "The subnet ID in which to place the instance used to customize your Amazon EC2 AMI. If you specify subnetId, you must also specify one or more security group IDs in securityGroupIds. Otherwise, the request fails.
The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.
", "UpdateInfrastructureConfigurationResponse$requestId": "The request ID that uniquely identifies this request.
", "UpdateLifecyclePolicyRequest$description": "Optional description for the lifecycle policy. Because the update replaces the entire configuration, omitting this property removes any existing description.
", "VulnerabilityIdAggregation$vulnerabilityId": "The vulnerability Id for this set of counts.
", "VulnerablePackage$name": "The name of the vulnerable package.
", "VulnerablePackage$version": "The version of the vulnerable package.
", "VulnerablePackage$release": "The release of the vulnerable package.
", "VulnerablePackage$packageManager": "The package manager of the vulnerable package.
", "VulnerablePackage$filePath": "The file path of the vulnerable package.
", "VulnerablePackage$fixedInVersion": "The version of the package that contains the vulnerability fix.
", "VulnerablePackage$remediation": "The code to run in your environment to update packages with a fix available.
", "Workflow$description": "The description of the workflow.
", "Workflow$changeDescription": "Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.
", "Workflow$owner": "The owner of the workflow resource.
", "Workflow$kmsKeyId": "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.
", "WorkflowState$reason": "Describes how or why the workflow changed state.
", "WorkflowSummary$description": "Describes the workflow.
", "WorkflowSummary$changeDescription": "The change description for the current version of the workflow resource.
", "WorkflowSummary$owner": "The owner of the workflow resource.
", "WorkflowVersion$description": "Describes the workflow.
", "WorkflowVersion$owner": "The owner of the workflow resource.
" } }, "NonEmptyStringList": { "base": null, "refs": { "PackageVulnerabilityDetails$referenceUrls": "Links to web pages that contain details about the vulnerabilities that Amazon Inspector identified for the package.
" } }, "NonNegativeDouble": { "base": null, "refs": { "CvssScore$baseScore": "The CVSS base score.
", "CvssScoreDetails$score": "The CVSS score.
", "ImageScanFinding$inspectorScore": "The score that Amazon Inspector assigned for the finding.
" } }, "NullableBoolean": { "base": null, "refs": { "Component$encrypted": "Indicates whether the component data is encrypted at rest. Image Builder encrypts all component data at rest, so this value is always true. This field is retained for backward compatibility.
Specifies whether the recipe's Dockerfile template data is encrypted at rest. Image Builder encrypts all Dockerfile template data at rest, so this value is always true. This field is retained for backward compatibility, and doesn't describe encryption of the output container image.
Specifies whether to collect additional information about the image being created, including the operating system (OS) version and package list. Defaults to true.
Specifies whether to collect additional information about the image being created, including the operating system (OS) version and package list. Defaults to true.
Specifies whether to terminate the instance on failure. 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. Defaults to true.
Specifies whether Image Builder terminates build and test instances when image creation ends without a failure (success, cancellation, or expiration). Defaults to true.
Specifies whether to encrypt the device.
", "EbsInstanceBlockDeviceSpecification$deleteOnTermination": "Specifies whether to delete the associated device on termination.
", "Image$enhancedImageMetadataEnabled": "Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
", "ImagePipeline$enhancedImageMetadataEnabled": "Specifies whether to collect additional information about the image being created, including the operating system (OS) version and package list. Defaults to true.
Specifies whether Amazon Inspector scans for vulnerabilities when you create a new image. You must also enable image tests. For AMI output, imageScanningTypes sets whether Amazon Inspector scans the test instance or the output AMI. For container output, Amazon Inspector scans the container image that Image Builder pushes to the Amazon ECR repository from your ecrConfiguration settings.
To use container image scans, you must activate Amazon Inspector for Amazon ECR scanning in the account and Amazon Web Services Region where the build runs. Amazon Inspector activation is Regional. The Image Builder ListImageScanFindings operation returns the findings of these scans.
Specifies whether tests run after building the image. When enabled, tests run after the image build and before image distribution. Defaults to true.
Indicates whether Image Builder terminates the build and test instances when the image build fails. When false, Image Builder retains the instance so that you can debug it.
Specifies whether Image Builder terminates build and test instances when image creation ends without a failure.
", "ListImagesRequest$includeDeprecated": "Specifies whether to include deprecated Amazon-managed images in the results. Deprecated images that you own are always returned. Defaults to false.
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.
Specifies whether only findings that have a fix available count toward maximumSeverityLabel. When false, Image Builder counts every finding. The default is true.
Specifies whether the Systems Manager agent is removed from your final build image before Image Builder creates the new AMI. If true, the agent is removed. If false, the agent is kept, so that it's included in the AMI. If you don't set this property, Image Builder removes the agent only if Image Builder installed the agent during the build. An agent that was pre-installed on the base image is kept.
Specifies whether to collect additional information about the image being created, including the operating system (OS) version and package list. Defaults to true.
Specifies whether to terminate the instance on failure. 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. Defaults to true.
Specifies whether Image Builder terminates build and test instances when image creation ends without a failure (success, cancellation, or expiration). Defaults to true.
Indicates whether a retry of the image build superseded this runtime instance of the workflow. When you retry a failed image build, Image Builder sets this flag to true on the original workflow executions that the retry re-ran.
The action to take if the workflow fails. With CONTINUE, a failed workflow is logged and image creation proceeds to the next workflow. If you don't set a value, the image build fails when the workflow fails. You can only set this property for test workflows.
The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?.
" } }, "OrganizationalUnitArn": { "base": null, "refs": { "OrganizationalUnitArnList$member": null } }, "OrganizationalUnitArnList": { "base": null, "refs": { "LaunchPermissionConfiguration$organizationalUnitArns": "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.
" } }, "OsVersion": { "base": null, "refs": { "Image$osVersion": "The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
", "ImageSummary$osVersion": "The operating system version of the instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
", "ImageVersion$osVersion": "The operating system version of the image. For example, Amazon Linux 2023 or Microsoft Windows Server 2022.
", "ImportDiskImageRequest$osVersion": "The operating system version for the imported image. The only supported value is Microsoft Windows 11.
The operating system version for the imported VM.
", "OsVersionList$member": null } }, "OsVersionList": { "base": null, "refs": { "Component$supportedOsVersions": "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.
", "ComponentSummary$supportedOsVersions": "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.
", "ComponentVersion$supportedOsVersions": "The operating system (OS) version supported by the component. If OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.
", "CreateComponentRequest$supportedOsVersions": "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.
" } }, "OutputResources": { "base": "The resources produced by this image.
", "refs": { "Image$outputResources": "The output resources that Image Builder produces for this image.
", "ImageSummary$outputResources": "The output resources that Image Builder produced when it created this image.
" } }, "Ownership": { "base": null, "refs": { "ListComponentsRequest$owner": "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, components from the Amazon Web Services Marketplace, third party components, or components that other accounts have shared with you.
", "ListContainerRecipesRequest$owner": "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. For container recipes, the valid owner values are Self, Shared, and Amazon.
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.
Filters the list to images owned by you, by Amazon, or shared with you by other accounts. By default, only your account's images are returned.
", "ListWorkflowsRequest$owner": "Filters results based on the workflow owner. By default, this request returns the workflows that your account owns (Self). Specify Amazon to list the workflows that Image Builder manages. Image Builder rejects the Shared and ThirdParty owner values for workflows, and AWSMarketplace returns no results.
The architecture of the vulnerable package.
" } }, "PackageEpoch": { "base": null, "refs": { "VulnerablePackage$epoch": "The epoch of the vulnerable package.
" } }, "PackageVulnerabilityDetails": { "base": "Information about package vulnerability findings.
", "refs": { "ImageScanFinding$packageVulnerabilityDetails": "An object that contains the details of a package vulnerability finding.
" } }, "PaginationToken": { "base": null, "refs": { "ListComponentBuildVersionsRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListComponentsRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListContainerRecipesRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListImageBuildVersionsRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListImagePackagesRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListImagePipelineImagesRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListImagePipelinesRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListImageRecipesRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListImageScanFindingAggregationsRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListImageScanFindingsRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListImagesRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListInfrastructureConfigurationsRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListLifecycleExecutionResourcesRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListLifecycleExecutionsRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListLifecyclePoliciesRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListWaitingWorkflowStepsRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListWorkflowBuildVersionsRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListWorkflowExecutionsRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListWorkflowStepExecutionsRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
", "ListWorkflowsRequest$nextToken": "A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
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.
" } }, "ParallelGroup": { "base": null, "refs": { "GetWorkflowExecutionResponse$parallelGroup": "The name of the parallel group that this runtime instance of the workflow ran in, if configured. Parallel groups apply only to test workflows.
", "WorkflowConfiguration$parallelGroup": "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.
", "WorkflowExecutionMetadata$parallelGroup": "The name of the test group that included the test workflow resource at runtime.
" } }, "ParentInstanceConfiguration": { "base": "Settings for building on an instance that is already running, instead of an instance that Image Builder launches for the build.
", "refs": { "CreateInfrastructureConfigurationRequest$parentInstance": "The Amazon EC2 Auto Scaling group that Image Builder takes the build instance from, instead of launching a new instance. This applies only to the build phase.
To use this feature, the execution role for the build must have permissions to describe the Auto Scaling group, tag the instance while it's still in the group, and detach it from the group. For more information, see Build on an instance from an Auto Scaling group in the EC2 Image Builder User Guide.
", "InfrastructureConfiguration$parentInstance": "The Amazon EC2 Auto Scaling group that Image Builder takes the build instance from, instead of launching a new instance. This applies only to the build phase.
", "UpdateInfrastructureConfigurationRequest$parentInstance": "The Amazon EC2 Auto Scaling group that Image Builder takes the build instance from, instead of launching a new instance. This applies only to the build phase.
To use this feature, the execution role for the build must have permissions to describe the Auto Scaling group, tag the instance while it's still in the group, and detach it from the group. For more information, see Build on an instance from an Auto Scaling group in the EC2 Image Builder User Guide.
" } }, "PipelineExecutionStartCondition": { "base": null, "refs": { "Schedule$pipelineExecutionStartCondition": "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.
If the recipe references its base image through an Amazon Web Services Systems Manager Parameter Store parameter, a change in the parameter's value also counts as an available dependency update.
The logging configuration that's defined for pipeline execution.
", "refs": { "CreateImagePipelineRequest$loggingConfiguration": "Specifies the logging configuration for the image pipeline. Use this to define custom CloudWatch Logs log groups for your pipeline execution logs and image build logs. The service manages log groups with names starting with /aws/imagebuilder/ using the service-linked role. For custom log group names outside of this prefix, you must also provide an executionRole.
The CloudWatch Logs configuration for the pipeline: the log group for image build logs and the log group for pipeline execution logs.
", "UpdateImagePipelineRequest$loggingConfiguration": "Specifies the logging configuration for the image pipeline. Use this to define custom CloudWatch Logs log groups for your pipeline execution logs and image build logs. The service manages log groups with names starting with /aws/imagebuilder/ using the service-linked role. For custom log group names outside of this prefix, you must also provide an executionRole.
The status of the image pipeline. If you don't specify a status, it defaults to ENABLED. A disabled pipeline doesn't run on its schedule, but you can still start builds manually.
The status of the image pipeline. A disabled pipeline doesn't run on its schedule, but you can still start builds manually. Image Builder can also disable a pipeline automatically when consecutive scheduled builds fail.
", "UpdateImagePipelineRequest$status": "The status of the image pipeline. Defaults to ENABLED when omitted. To keep a pipeline disabled, include this property set to DISABLED in your update request.
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.
", "refs": { "CreateInfrastructureConfigurationRequest$placement": "The instance placement settings that define where the build and test instances that Image Builder launches during image creation run. These settings don't affect instances that you launch from the output image.
", "InfrastructureConfiguration$placement": "The instance placement settings that define where the build and test instances that Image Builder launches during image creation run. These settings don't affect instances that you launch from the output image.
", "InfrastructureConfigurationSummary$placement": "The instance placement settings that define where the build and test instances that Image Builder launches during image creation run. These settings don't affect instances that you launch from the output image.
", "UpdateInfrastructureConfigurationRequest$placement": "The instance placement settings that define where the build and test instances that Image Builder launches during image creation run. These settings don't affect instances that you launch from the output image.
" } }, "Platform": { "base": null, "refs": { "Component$platform": "The operating system platform of the component.
", "ComponentSummary$platform": "The operating system platform of the component.
", "ComponentVersion$platform": "The platform of the component.
", "ContainerRecipe$platform": "The system platform for the container. Container recipes support only the Linux and Windows platforms.
", "ContainerRecipeSummary$platform": "The system platform for the container. Container recipes support only the Linux and Windows platforms.
", "CreateComponentRequest$platform": "The operating system platform of the component.
", "CreateContainerRecipeRequest$platformOverride": "Specifies the operating system platform when you use a custom base image. Container recipes support only the Linux and Windows platforms.
", "Image$platform": "The image operating system platform, such as Linux or Windows.
", "ImagePipeline$platform": "The platform of the image pipeline, inherited from the recipe that the pipeline uses.
", "ImageRecipe$platform": "The platform of the image recipe.
", "ImageRecipeSummary$platform": "The platform of the image recipe.
", "ImageSummary$platform": "The image operating system platform, such as Linux or Windows.
", "ImageVersion$platform": "The operating system platform of the image version, for example \"Windows\" or \"Linux\".
", "ImportComponentRequest$platform": "The platform of the component.
", "ImportVmImageRequest$platform": "The operating system platform for the imported VM.
" } }, "ProductCodeId": { "base": null, "refs": { "ProductCodeListItem$productCodeId": "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.
" } }, "ProductCodeList": { "base": null, "refs": { "Component$productCodes": "Contains product codes that are used for billing purposes for Amazon Web Services Marketplace components.
", "ComponentVersion$productCodes": "Contains product codes that are used for billing purposes for Amazon Web Services Marketplace components.
" } }, "ProductCodeListItem": { "base": "Information about a single product code.
", "refs": { "ProductCodeList$member": null } }, "ProductCodeType": { "base": null, "refs": { "ProductCodeListItem$productCodeType": "The owner of the product code that's billed. If this property is empty, it might mean that the component is not published.
" } }, "PutComponentPolicyRequest": { "base": null, "refs": {} }, "PutComponentPolicyResponse": { "base": null, "refs": {} }, "PutContainerRecipePolicyRequest": { "base": null, "refs": {} }, "PutContainerRecipePolicyResponse": { "base": null, "refs": {} }, "PutImagePolicyRequest": { "base": null, "refs": {} }, "PutImagePolicyResponse": { "base": null, "refs": {} }, "PutImageRecipePolicyRequest": { "base": null, "refs": {} }, "PutImageRecipePolicyResponse": { "base": null, "refs": {} }, "RegionFailure": { "base": "Contains details about a distribution or image configuration failure for a single Region.
", "refs": { "RegionFailureList$member": null } }, "RegionFailureList": { "base": null, "refs": { "DistributionFailureContext$regionFailures": "The details about the failure for each Region where the image didn't finish distribution or configuration.
" } }, "RegionFailureStatus": { "base": null, "refs": { "RegionFailure$status": "The failure status for the Region. Indicates whether the process failed, was canceled, or timed out.
" } }, "RegionList": { "base": null, "refs": { "DistributionConfigurationSummary$regions": "A list of the Regions that the distribution configuration distributes images to.
" } }, "RegisterImageOptions": { "base": "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 .
", "refs": { "ImportDiskImageRequest$registerImageOptions": "Configures Secure Boot and UEFI settings for the imported image.
" } }, "Remediation": { "base": "Information about how to remediate a finding.
", "refs": { "ImageScanFinding$remediation": "An object that contains the details about how to remediate the finding.
" } }, "RemediationRecommendation": { "base": "Details about the recommended course of action to remediate the finding.
", "refs": { "Remediation$recommendation": "An object that contains information about the recommended course of action to remediate the finding.
" } }, "ResourceAlreadyExistsException": { "base": "The resource that you are trying to create already exists.
", "refs": {} }, "ResourceDependencyException": { "base": "You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
", "refs": {} }, "ResourceInUseException": { "base": "The resource that you are trying to operate on is currently in use. Review the message details and retry later.
", "refs": {} }, "ResourceName": { "base": null, "refs": { "Component$name": "The name of the component.
", "ComponentSummary$name": "The name of the component.
", "ComponentVersion$name": "The name of the component.
", "ContainerRecipe$name": "The name of the container recipe.
", "ContainerRecipeSummary$name": "The name of the container recipe.
", "CreateComponentRequest$name": "The name of the component. Image Builder generates the component ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. If a component with the same name and semantic version already exists in your account in the same Amazon Web Services Region, the request creates a new build version for it. If the content is also identical to the latest build version, the request fails because the component already exists.
", "CreateContainerRecipeRequest$name": "The name of the container recipe. The recipe name, combined with the semantic version, must be unique to your account in each Amazon Web Services Region. Image Builder generates the container recipe ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.
", "CreateDistributionConfigurationRequest$name": "The name of the distribution configuration. Distribution configuration names must be unique to your account in each Amazon Web Services Region. Image Builder generates the distribution configuration ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.
", "CreateImagePipelineRequest$name": "The name of the image pipeline. Pipeline names must be unique to your account in each Amazon Web Services Region. Image Builder generates the pipeline ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.
", "CreateImageRecipeRequest$name": "The name of the image recipe. The recipe name, combined with the semantic version, must be unique to your account in each Amazon Web Services Region. Image Builder generates the image recipe ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.
", "CreateInfrastructureConfigurationRequest$name": "The name of the infrastructure configuration. Infrastructure configuration names must be unique to your account in each Amazon Web Services Region. Image Builder generates the infrastructure configuration ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.
", "CreateLifecyclePolicyRequest$name": "The name of the lifecycle policy to create. Policy names must be unique to your account in each Amazon Web Services Region. Image Builder generates the policy ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. You can't change the name after creation.
", "CreateWorkflowRequest$name": "The name of the workflow to create. Image Builder generates the workflow ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. If a workflow with the same name and semantic version already exists in your account in the same Amazon Web Services Region, the request creates a new build version for it. If the content is also identical to the latest build version, the request fails because the workflow already exists.
", "DistributionConfiguration$name": "The name of the distribution configuration.
", "DistributionConfigurationSummary$name": "The name of the distribution configuration.
", "Image$name": "The name of the image.
", "Image$sourcePipelineName": "The name of the image pipeline that created this image. Image Builder doesn't return this field for new images. Use sourcePipelineArn instead.
The name of the image pipeline.
", "ImageRecipe$name": "The name of the image recipe.
", "ImageRecipeSummary$name": "The name of the image recipe.
", "ImageSummary$name": "The name of the image.
", "ImageVersion$name": "The name of this specific version of an Image Builder image.
", "ImportComponentRequest$name": "The name of the component. Image Builder generates the component ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. If a component with the same name and semantic version already exists in your account in the same Amazon Web Services Region, the request creates a new build version for it. If the content is also identical to the latest build version, the request fails because the component already exists.
", "ImportDiskImageRequest$name": "The name of the image resource that's created from the import. Image Builder generates the image ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. If an image with the same name and semantic version already exists in your account in the same Amazon Web Services Region, the import creates a new build version for it.
", "InfrastructureConfiguration$name": "The name of the infrastructure configuration.
", "InfrastructureConfigurationSummary$name": "The name of the infrastructure configuration.
", "LifecyclePolicy$name": "The name of the lifecycle policy.
", "LifecyclePolicyResourceSelectionRecipe$name": "The name of an Image Builder recipe that the lifecycle policy uses for resource selection.
", "LifecyclePolicySummary$name": "The name of the lifecycle policy.
", "Workflow$name": "The name of the workflow resource.
", "WorkflowSummary$name": "The name of the workflow.
", "WorkflowVersion$name": "The name of the workflow.
" } }, "ResourceNotFoundException": { "base": "At least one of the resources referenced by your request does not exist.
", "refs": {} }, "ResourcePolicyDocument": { "base": null, "refs": { "GetComponentPolicyResponse$policy": "The component policy.
", "GetContainerRecipePolicyResponse$policy": "The resource policy for the container recipe, as a JSON policy document. If no policy has been applied, the response contains an empty JSON object ({}).
The resource policy for the image, as a JSON policy document. If the image has no policy applied, the response contains an empty JSON object ({}).
The resource policy for the image recipe, as a JSON policy document. If no policy has been applied, the response contains an empty JSON object ({}).
The policy to apply.
", "PutContainerRecipePolicyRequest$policy": "The policy to apply to the container recipe.
", "PutImagePolicyRequest$policy": "The resource policy to apply to the image, as a JSON policy document. Image Builder validates the policy with Amazon Web Services RAM before applying it, and rejects invalid policies with InvalidParameterValueException.
The policy to apply.
" } }, "ResourceState": { "base": "The state to apply to the image resource in a resource state update request.
", "refs": { "StartResourceStateUpdateRequest$state": "Specifies the lifecycle action to take for this request. For AMI-based images, valid values are AVAILABLE, DEPRECATED, DISABLED, and DELETED. For container-based images, only DELETED is supported.
Additional rules to specify resources that should be exempt from ad-hoc lifecycle actions.
", "refs": { "StartResourceStateUpdateRequest$exclusionRules": "Rules that Image Builder evaluates against each of the image's AMIs. Matching AMIs and their snapshots are skipped. Exclusion rules only take effect when the request includes AMIs. If the target state is DELETED and any resource was skipped, the Image Builder image resource itself is also retained. For the DEPRECATED and DISABLED target states, Image Builder updates the image resource's state regardless of exclusions.
Specifies which underlying resources the resource state update applies to, in addition to the Image Builder image resource itself: distributed AMIs and their snapshots for AMI images, or distributed container images for container images.
", "refs": { "StartResourceStateUpdateRequest$includeResources": "Specifies which underlying resources to update, in addition to the Image Builder image resource itself. Snapshots and containers are only valid for the DELETED state. To set an image to DELETED, you must include its underlying resources. To delete only the Image Builder image record, use the DeleteImage operation instead.
The status to which you want to move the image resource. Set the status to AVAILABLE to restore an image that's currently deprecated or disabled.
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. Tag keys can't begin with aws: or match one of the following reserved keys: CreatedBy, Ec2ImageBuilderArn, Name, or Tags.
The metadata tags assigned to the Amazon EC2 build and test instances that Image Builder launches during image creation.
", "InfrastructureConfigurationSummary$resourceTags": "The metadata tags assigned to the Amazon EC2 build and test instances that Image Builder launches during image creation.
", "UpdateInfrastructureConfigurationRequest$resourceTags": "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. Tag keys can't begin with aws: or match one of the following reserved keys: CreatedBy, Ec2ImageBuilderArn, Name, or Tags.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The maximum number of items to return in a single request. If you don't specify a value, Image Builder returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items than the maximum, with a nextToken to continue paging.
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
", "CreateImageRequest$executionRole": "The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions. This property is required if you specify workflows. If you don't provide a role, Image Builder uses the Image Builder service-linked role in your account, and creates it if it doesn't exist.
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions. You must have permission to pass the role, and the role's trust policy must allow the Image Builder service principal to assume it.
", "DistributeImageRequest$executionRole": "The name or Amazon Resource Name (ARN) of the IAM role that Image Builder assumes to distribute the image.
", "Image$executionRole": "The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
", "ImagePipeline$executionRole": "The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
", "ImportDiskImageRequest$executionRole": "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. If you don't provide a role, Image Builder uses the Image Builder service-linked role in your account, and creates it if it doesn't exist.
", "LifecyclePolicy$executionRole": "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.
", "LifecyclePolicySummary$executionRole": "The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy.
", "StartResourceStateUpdateRequest$executionRole": "The name or Amazon Resource Name (ARN) of the IAM role that's used to update image state. You must provide this property together with includeResources. Neither is valid without the other.
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions. If you omit this property, the pipeline reverts to the Image Builder service-linked role.
", "UpdateLifecyclePolicyRequest$executionRole": "The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions.
" } }, "S3ExportConfiguration": { "base": "Properties that configure exporting the output image to a disk image file in an Amazon S3 bucket, in a format that's compatible with your VMs.
", "refs": { "Distribution$s3ExportConfiguration": "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.
" } }, "S3Logs": { "base": "Amazon S3 logging configuration.
", "refs": { "Logging$s3Logs": "The Amazon S3 logging configuration.
" } }, "ScanResultCondition": { "base": "A condition that sets which findings from an on-demand AMI scan fail the image. Image Builder checks the output AMI's findings against this condition during the test phase.
", "refs": { "ImageScanningConfiguration$scanResultCondition": "The condition that the output AMI's scan results must meet for the image to pass. You can set scanResultCondition only when imageScanningTypes is ON_DEMAND_AMI_CVE. If you omit it, Image Builder starts the scan but does not wait for it or use its results to pass or fail the image.
When you set scanResultCondition, the test phase waits for the scan to finish. Then Image Builder checks the findings against the condition. By default, Image Builder counts only findings that have a fix available. To count every finding, set fixAvailable to false. If a counted finding exceeds maximumSeverityLabel, Image Builder fails the image in the test phase and does not distribute the AMI.
A schedule configures when and how often a pipeline will automatically create a new image.
", "refs": { "CreateImagePipelineRequest$schedule": "The schedule of the image pipeline. If you don't provide a schedule, the pipeline runs only when you call StartImagePipelineExecution.
", "ImagePipeline$schedule": "The schedule of the image pipeline.
", "UpdateImagePipelineRequest$schedule": "The schedule of the image pipeline. Because the update replaces the entire configuration, omitting this property removes any existing schedule. The pipeline then runs only when you call StartImagePipelineExecution.
" } }, "SecurityGroupIds": { "base": null, "refs": { "CreateInfrastructureConfigurationRequest$securityGroupIds": "The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
", "InfrastructureConfiguration$securityGroupIds": "The security group IDs of the infrastructure configuration.
", "UpdateInfrastructureConfigurationRequest$securityGroupIds": "The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
" } }, "SendWorkflowStepActionRequest": { "base": null, "refs": {} }, "SendWorkflowStepActionResponse": { "base": null, "refs": {} }, "ServiceException": { "base": "An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
", "refs": {} }, "ServiceQuotaExceededException": { "base": "You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
", "refs": {} }, "ServiceUnavailableException": { "base": "The service is unable to process your request at this time.
", "refs": {} }, "SeverityCountNumber": { "base": null, "refs": { "SeverityCounts$all": "The total number of findings across all severity levels for the specified filter.
", "SeverityCounts$critical": "The number of critical severity findings for the specified filter.
", "SeverityCounts$high": "The number of high severity findings for the specified filter.
", "SeverityCounts$medium": "The number of medium severity findings for the specified filter.
" } }, "SeverityCounts": { "base": "Includes counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified filter.
", "refs": { "AccountAggregation$severityCounts": "Counts by severity level for medium severity and higher level findings, plus a total for all of the findings.
", "ImageAggregation$severityCounts": "Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image.
", "ImagePipelineAggregation$severityCounts": "Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image pipeline.
", "VulnerabilityIdAggregation$severityCounts": "Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified vulnerability.
" } }, "SnsTopicArn": { "base": null, "refs": { "CreateInfrastructureConfigurationRequest$snsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic to which Image Builder sends image build event notifications. Specify a standard topic. Image Builder doesn't support FIFO topics. Image Builder validates the topic when you create or update the configuration. You must have permission to publish to the topic.
EC2 Image Builder can't send notifications to SNS topics that are encrypted using keys from other accounts. If your SNS topic is encrypted, the key must be owned by the same account that owns your Image Builder resources.
The Amazon Resource Name (ARN) of the SNS topic to which Image Builder sends image build event notifications. Specify a standard topic. Image Builder doesn't support FIFO topics. Image Builder validates the topic when you create or update the configuration. You must have permission to publish to the topic.
EC2 Image Builder can't send notifications to SNS topics that are encrypted using keys from other accounts. If your SNS topic is encrypted, the key must be owned by the same account that owns your Image Builder resources.
The source layer hash of the vulnerable package.
" } }, "SsmParameterConfiguration": { "base": "Configuration for a single Parameter in the Amazon Web Services Systems Manager (SSM) Parameter Store in a given Region.
", "refs": { "SsmParameterConfigurationList$member": null } }, "SsmParameterConfigurationList": { "base": null, "refs": { "Distribution$ssmParameterConfigurations": "Contains settings to update Amazon Web Services Systems Manager (SSM) Parameter Store Parameters with output AMI IDs from the build by target Region.
" } }, "SsmParameterDataType": { "base": null, "refs": { "SsmParameterConfiguration$dataType": "The type of value the parameter contains. We recommend the aws:ec2:image data type.
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.
" } }, "StartImagePipelineExecutionRequest": { "base": null, "refs": {} }, "StartImagePipelineExecutionResponse": { "base": null, "refs": {} }, "StartResourceStateUpdateRequest": { "base": null, "refs": {} }, "StartResourceStateUpdateResponse": { "base": null, "refs": {} }, "StringList": { "base": null, "refs": { "Container$imageUris": "A list of URIs for containers created in the context Region.
", "ContainerDistributionConfiguration$containerTags": "Tags that Image Builder applies to the distributed container image in the target repository. These are repository image tags, not resource tags.
", "EcrConfiguration$containerTags": "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.
", "LaunchPermissionConfiguration$userGroups": "The name of the group that you want to grant launch permission to. The only supported value is all, which makes the distributed AMI public.
For an impacted container image, this identifies a list of URIs for associated container images distributed to ECR repositories.
", "LifecyclePolicyDetailExclusionRulesAmis$regions": "Configures Amazon Web Services Regions that are excluded from the lifecycle action.
" } }, "SystemsManagerAgent": { "base": "Contains settings for the Systems Manager agent on your build instance. This setting applies to Linux and macOS build instances only. Requests that set it for a recipe with a Windows base image are rejected.
", "refs": { "AdditionalInstanceConfiguration$systemsManagerAgent": "The Systems Manager agent settings for your build instance. This setting applies to Linux and macOS build instances only. Requests that set it for a recipe with a Windows base image are rejected.
" } }, "TagKey": { "base": null, "refs": { "ResourceTagMap$key": null, "TagKeyList$member": null, "TagMap$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "The tag keys to remove from the resource.
" } }, "TagMap": { "base": null, "refs": { "AmiDistributionConfiguration$amiTags": "The tags to apply to AMIs distributed to this Region.
", "Component$tags": "The tags that apply to the component.
", "ComponentSummary$tags": "The tags that apply to the component.
", "ContainerRecipe$tags": "Tags that are attached to the container recipe.
", "ContainerRecipeSummary$tags": "Tags that are attached to the container recipe.
", "CreateComponentRequest$tags": "The tags that apply to the component.
", "CreateContainerRecipeRequest$tags": "Tags that are attached to the container recipe.
", "CreateDistributionConfigurationRequest$tags": "The tags of the distribution configuration.
", "CreateImagePipelineRequest$tags": "The tags of the image pipeline.
", "CreateImagePipelineRequest$imageTags": "The tags that Image Builder applies to the Image Builder image resource that this pipeline's scheduled executions create. These tags don't apply to the output AMI. To tag output AMIs, use amiTags in the pipeline's distribution configuration.
The tags of the image recipe.
", "CreateImageRecipeRequest$amiTags": "Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.
", "CreateImageRequest$tags": "The tags of the image.
", "CreateInfrastructureConfigurationRequest$tags": "The metadata tags to assign to the infrastructure configuration resource that Image Builder creates as output. Tags are formatted as key value pairs.
", "CreateLifecyclePolicyRequest$tags": "Tags to apply to the lifecycle policy resource.
", "CreateWorkflowRequest$tags": "Tags that apply to the workflow resource.
", "DistributeImageRequest$tags": "The tags to apply to the new Image Builder image resource that this operation creates. To tag the output AMIs, use amiTags in the distribution configuration.
The tags of the distribution configuration.
", "DistributionConfigurationSummary$tags": "The tags associated with the distribution configuration.
", "Image$tags": "The tags that apply to this image.
", "ImagePipeline$tags": "The tags of this image pipeline.
", "ImagePipeline$imageTags": "The tags that Image Builder applies to the Image Builder image resource that this pipeline's scheduled executions create. These tags don't apply to the output AMI. Builds that you start manually use the tags from the StartImagePipelineExecution request instead.
", "ImageRecipe$tags": "The tags of the image recipe.
", "ImageRecipe$amiTags": "Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.
", "ImageRecipeSummary$tags": "The tags of the image recipe.
", "ImageSummary$tags": "The tags that apply to this image.
", "ImportComponentRequest$tags": "The tags of the component.
", "ImportDiskImageRequest$tags": "Tags that are attached to image resources created from the import.
", "ImportVmImageRequest$tags": "Tags that are attached to the import resources.
", "InfrastructureConfiguration$tags": "The tags of the infrastructure configuration.
", "InfrastructureConfigurationSummary$tags": "The tags of the infrastructure configuration.
", "LifecyclePolicy$tags": "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.
", "LifecyclePolicyDetailExclusionRules$tagMap": "Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image resources that have them.
", "LifecyclePolicyDetailExclusionRulesAmis$tagMap": "Lifecycle actions don't apply to AMIs that have any of these tags. Both the key and the value must match.
", "LifecyclePolicyResourceSelection$tagMap": "A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to.
", "LifecyclePolicySummary$tags": "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.
", "ListTagsForResourceResponse$tags": "The tags for the specified resource.
", "StartImagePipelineExecutionRequest$tags": "The tags for Image Builder to apply to the image resource that's created when pipeline execution starts.
", "TagResourceRequest$tags": "The tags to apply to the resource.
", "UpdateImagePipelineRequest$imageTags": "The tags that Image Builder applies to the Image Builder image resource that this pipeline's scheduled executions create. These tags don't apply to the output AMI. To tag output AMIs, use amiTags in the pipeline's distribution configuration.
The tags that apply to the workflow resource.
", "WorkflowSummary$tags": "Contains a list of tags that are defined for the workflow.
" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagResourceResponse": { "base": null, "refs": {} }, "TagValue": { "base": null, "refs": { "ResourceTagMap$value": null, "TagMap$value": null } }, "TargetContainerRepository": { "base": "The container repository where the output container image is stored.
", "refs": { "ContainerDistributionConfiguration$targetRepository": "The destination repository for the container distribution configuration.
", "ContainerRecipe$targetRepository": "The destination repository for the container image.
", "CreateContainerRecipeRequest$targetRepository": "The destination repository for the container image. The Amazon ECR repository must already exist in the Amazon Web Services Region where the build runs.
" } }, "TargetResourceCount": { "base": null, "refs": { "FastLaunchSnapshotConfiguration$targetResourceCount": "The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
" } }, "TenancyType": { "base": null, "refs": { "Placement$tenancy": "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.
The timezone that applies to the scheduling expression. Specify a value in IANA timezone format, for example Etc/UTC or America/Los_Angeles. If not specified, this defaults to UTC.
You have attempted too many requests for the specific operation.
", "refs": {} }, "UefiData": { "base": null, "refs": { "RegisterImageOptions$uefiData": "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.
" } }, "UntagResourceRequest": { "base": null, "refs": {} }, "UntagResourceResponse": { "base": null, "refs": {} }, "UpdateDistributionConfigurationRequest": { "base": null, "refs": {} }, "UpdateDistributionConfigurationResponse": { "base": null, "refs": {} }, "UpdateImagePipelineRequest": { "base": null, "refs": {} }, "UpdateImagePipelineResponse": { "base": null, "refs": {} }, "UpdateInfrastructureConfigurationRequest": { "base": null, "refs": {} }, "UpdateInfrastructureConfigurationResponse": { "base": null, "refs": {} }, "UpdateLifecyclePolicyRequest": { "base": null, "refs": {} }, "UpdateLifecyclePolicyResponse": { "base": null, "refs": {} }, "Uri": { "base": null, "refs": { "CreateComponentRequest$uri": "The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and you 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 for component size, which is 64 KB by default.
Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.
The Amazon S3 URI for the Dockerfile template that is used to build your container image. You must have permission to read the object. Image Builder reads the object once, when it creates the recipe, and stores its content in the recipe. Later changes to the S3 object don't affect the recipe. You must specify exactly one of the dockerfileTemplateData or dockerfileTemplateUri properties.
The uri of a YAML workflow document file stored in Amazon S3. This must be an S3 URL (s3://bucket/key), and you must have permission to access the S3 bucket it points to. A workflow document that you provide from Amazon S3 can be up to your service quota for workflow size.
Alternatively, you can specify the YAML document inline, using the workflow data property. You must specify exactly one of the data or uri properties.
The uri of the component. Must be an Amazon S3 URL and you 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.
The uri of the ISO disk file that's stored in Amazon S3, in s3://bucket/key format. The key must end with the .iso, .ISO, or .Iso extension, and the bucket must be owned by the account that makes the request.
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 IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhcg==:
#!/bin/bash
mkdir -p /var/bb/
touch /var
The version of the component.
", "ComponentSummary$version": "The version of the component.
", "ComponentVersion$version": "The semantic version of the component.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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. The upper limit is 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: You can 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.
The semantic version of the container recipe.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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. The upper limit is 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: You can 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.
The semantic version of the component. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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. The upper limit is 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.
The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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. The upper limit is 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.
The version of the image recipe.
", "ImageVersion$version": "The semantic version of the image. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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. The upper limit is 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: You can 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.
The semantic version of the component. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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. The upper limit is 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.
The semantic version to attach to the image that's created during the import process. This version follows the semantic version syntax.
", "ImportVmImageRequest$semanticVersion": "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: <major>.<minor>.<patch>/<build>. 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. The upper limit is 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.
The workflow resource version. Workflow resources are immutable. To make a change, you can clone a workflow or create a new version.
", "WorkflowSummary$version": "The version of the workflow.
", "WorkflowVersion$version": "The semantic version of the workflow resource. The format includes three nodes: <major>.<minor>.<patch>.
" } }, "VersionNumberWithBuild": { "base": null, "refs": { "Image$version": "The semantic version of the image.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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. The upper limit is 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: You can 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.
The version of the image.
" } }, "VulnerabilityId": { "base": null, "refs": { "PackageVulnerabilityDetails$vulnerabilityId": "A unique identifier for this vulnerability.
", "VulnerabilityIdList$member": null } }, "VulnerabilityIdAggregation": { "base": "Includes counts of image and pipeline resource findings by vulnerability.
", "refs": { "ImageScanFindingAggregation$vulnerabilityIdAggregation": "Returns an object that contains severity counts based on vulnerability ID.
" } }, "VulnerabilityIdList": { "base": null, "refs": { "PackageVulnerabilityDetails$relatedVulnerabilities": "Vulnerabilities that are often related to the findings for the package.
" } }, "VulnerablePackage": { "base": "Information about a vulnerable package that Amazon Inspector identifies in a finding.
", "refs": { "VulnerablePackageList$member": null } }, "VulnerablePackageList": { "base": null, "refs": { "PackageVulnerabilityDetails$vulnerablePackages": "The packages that this vulnerability impacts.
" } }, "WildcardVersionNumber": { "base": null, "refs": { "CreateContainerRecipeRequest$semanticVersion": "The semantic version of the container recipe. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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. The upper limit is 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.
The semantic version of the image recipe. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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. The upper limit is 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.
The version of the Image Builder recipe specified by the name field.
Windows-specific configuration settings for an ISO import, including the edition to install from a multi-edition Windows ISO file.
", "refs": { "ImportDiskImageRequest$windowsConfiguration": "Specifies Windows settings for ISO imports.
" } }, "WindowsConfigurationImageIndex": { "base": null, "refs": { "WindowsConfiguration$imageIndex": "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.
Defines a process that Image Builder runs during the build, test, or distribution stage of the image creation process.
", "refs": { "GetWorkflowResponse$workflow": "The workflow resource specified in the request.
" } }, "WorkflowBuildVersionArn": { "base": null, "refs": { "CreateWorkflowResponse$workflowBuildVersionArn": "The Amazon Resource Name (ARN) of the workflow resource that the request created.
", "DeleteWorkflowRequest$workflowBuildVersionArn": "The Amazon Resource Name (ARN) of the workflow resource to delete.
", "DeleteWorkflowResponse$workflowBuildVersionArn": "The Amazon Resource Name (ARN) of the workflow resource that this request deleted.
", "GetWorkflowExecutionResponse$workflowBuildVersionArn": "The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow.
", "GetWorkflowStepExecutionResponse$workflowBuildVersionArn": "The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step.
", "ImageFailureContext$workflowArn": "The Amazon Resource Name (ARN) of the workflow build version that was running when the image failed.
", "ListWorkflowStepExecutionsResponse$workflowBuildVersionArn": "The build version Amazon Resource Name (ARN) for the Image Builder workflow resource that defines the steps for this runtime instance of the workflow.
", "Workflow$arn": "The Amazon Resource Name (ARN) of the workflow resource.
", "WorkflowExecutionMetadata$workflowBuildVersionArn": "The Amazon Resource Name (ARN) of the workflow resource build version that ran.
", "WorkflowStepExecution$workflowBuildVersionArn": "The Amazon Resource Name (ARN) of the workflow resource that ran.
", "WorkflowSummary$arn": "The Amazon Resource Name (ARN) of the workflow resource.
" } }, "WorkflowConfiguration": { "base": "Contains control settings and configurable inputs for a workflow resource.
", "refs": { "WorkflowConfigurationList$member": null } }, "WorkflowConfigurationList": { "base": null, "refs": { "CreateImagePipelineRequest$workflows": "The array of workflow configuration objects for builds that this pipeline starts. If you specify workflows, they replace the default workflows that Image Builder otherwise runs for the pipeline's builds. For example, if your list doesn't include a test workflow, the pipeline's builds don't run one. You must also specify executionRole when you provide workflows.
The array of workflow configuration objects for the build. If you specify workflows, they replace the default workflows that Image Builder otherwise runs for the build, and you must also provide an executionRole.
The build, test, and distribution workflow configurations that are associated with the image.
", "ImagePipeline$workflows": "Contains the workflows that run for the image pipeline.
", "UpdateImagePipelineRequest$workflows": "The array of workflow configuration objects for builds that this pipeline starts. If you specify workflows, they replace the default workflows that Image Builder otherwise runs for the pipeline's builds. For example, if your list doesn't include a test workflow, the pipeline's builds don't run one. You must also specify executionRole when you provide workflows.
Contains the YAML document content for the workflow.
" } }, "WorkflowExecutionId": { "base": null, "refs": { "GetWorkflowExecutionRequest$workflowExecutionId": "Use the unique identifier for a runtime instance of the workflow to get runtime details.
", "GetWorkflowExecutionResponse$workflowExecutionId": "The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
", "GetWorkflowStepExecutionResponse$workflowExecutionId": "The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
", "ImageFailureContext$workflowExecutionId": "The unique identifier of the workflow execution that was running when the image failed.
", "ListWorkflowStepExecutionsRequest$workflowExecutionId": "The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
", "ListWorkflowStepExecutionsResponse$workflowExecutionId": "The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
", "WorkflowExecutionMetadata$workflowExecutionId": "Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
", "WorkflowStepExecution$workflowExecutionId": "Uniquely identifies the runtime instance of the workflow that contains the workflow step that ran for the associated image build version.
" } }, "WorkflowExecutionMessage": { "base": null, "refs": { "GetWorkflowExecutionResponse$message": "The output message from the specified runtime instance of the workflow, if applicable.
", "WorkflowExecutionMetadata$message": "The runtime output message from the workflow, if applicable.
" } }, "WorkflowExecutionMetadata": { "base": "Metadata that includes details and status from this runtime instance of the workflow.
", "refs": { "WorkflowExecutionsList$member": null } }, "WorkflowExecutionStatus": { "base": null, "refs": { "GetWorkflowExecutionResponse$status": "The current runtime status for the specified runtime instance of the workflow. COMPLETED, FAILED, ROLLBACK_COMPLETED, CANCELLED, and SKIPPED are terminal states.
The current runtime status for this workflow.
" } }, "WorkflowExecutionsList": { "base": null, "refs": { "ListWorkflowExecutionsResponse$workflowExecutions": "An array of runtime details that represents each time a workflow ran for the requested image build version. Image Builder retains workflow execution records for a limited time, so this array can be empty for older image build versions.
" } }, "WorkflowParameter": { "base": "Contains a key/value pair that sets the named workflow parameter.
", "refs": { "WorkflowParameterList$member": null } }, "WorkflowParameterDescription": { "base": null, "refs": { "WorkflowParameterDetail$description": "Describes this parameter.
" } }, "WorkflowParameterDetail": { "base": "Defines a parameter that's used to provide configuration details for the workflow.
", "refs": { "WorkflowParameterDetailList$member": null } }, "WorkflowParameterDetailList": { "base": null, "refs": { "Workflow$parameters": "An array of input parameters that the image workflow uses to control actions or configure settings.
" } }, "WorkflowParameterList": { "base": null, "refs": { "WorkflowConfiguration$parameters": "Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.
" } }, "WorkflowParameterName": { "base": null, "refs": { "WorkflowParameter$name": "The name of the workflow parameter to set.
", "WorkflowParameterDetail$name": "The name of this input parameter.
" } }, "WorkflowParameterType": { "base": null, "refs": { "WorkflowParameterDetail$type": "The type of input this parameter provides. Supported values are string, integer, boolean, and stringList.
Sets the value for the named workflow parameter.
", "WorkflowParameterDetail$defaultValue": "The default value of this parameter if no input is provided.
" } }, "WorkflowState": { "base": "A group of fields that describe the current status of the workflow.
", "refs": { "Workflow$state": "Describes the current status of the workflow and the reason for that status.
", "WorkflowSummary$state": "Describes the current state of the workflow resource.
" } }, "WorkflowStatus": { "base": null, "refs": { "WorkflowState$status": "The current state of the workflow.
" } }, "WorkflowStepAction": { "base": null, "refs": { "GetWorkflowStepExecutionResponse$action": "The name of the action that the specified step performs.
", "WorkflowStepExecution$action": "The name of the step action.
", "WorkflowStepMetadata$action": "The step action name.
" } }, "WorkflowStepActionType": { "base": null, "refs": { "SendWorkflowStepActionRequest$action": "The action to perform on the paused workflow step. RESUME completes the waiting step, and the workflow continues. STOP fails the step, and the step's onFailure setting determines whether the workflow continues or aborts. The workflow step must be in a waiting state to accept an action. The request fails if the step has already timed out or been actioned.
The current attempt number for the specified runtime instance of the workflow step. The first run is attempt one. The number increases by one for each retry.
", "GetWorkflowStepExecutionResponse$maxAttempts": "The maximum number of attempts allowed for the specified runtime instance of the workflow step, based on the retry configuration in the workflow document. If the step doesn't configure retries, the maximum is one attempt.
", "WorkflowStepMetadata$attemptNumber": "The current attempt number for the workflow step. The first run is attempt one. The number increases by one for each retry.
", "WorkflowStepMetadata$maxAttempts": "The maximum number of attempts allowed for the workflow step, based on the retry configuration in the workflow document. If the step doesn't configure retries, the maximum is one attempt.
" } }, "WorkflowStepCount": { "base": null, "refs": { "GetWorkflowExecutionResponse$totalStepCount": "The total number of steps that the workflow document defines for this runtime instance of the workflow. Image Builder sets this count before any steps run. The sum of succeeded, skipped, and failed steps only reaches this total if every step finishes in one of those states.
", "GetWorkflowExecutionResponse$totalStepsSucceeded": "A runtime count for the number of steps that ran successfully in the specified runtime instance of the workflow.
", "GetWorkflowExecutionResponse$totalStepsFailed": "A runtime count for the number of steps that failed in the specified runtime instance of the workflow.
", "GetWorkflowExecutionResponse$totalStepsSkipped": "A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow.
", "WorkflowExecutionMetadata$totalStepCount": "The total number of steps that the workflow document defines for this runtime instance of the workflow. Image Builder sets this count before any steps run. The sum of succeeded, skipped, and failed steps only reaches this total if every step finishes in one of those states.
", "WorkflowExecutionMetadata$totalStepsSucceeded": "A runtime count for the number of steps in the workflow that ran successfully.
", "WorkflowExecutionMetadata$totalStepsFailed": "A runtime count for the number of steps in the workflow that failed.
", "WorkflowExecutionMetadata$totalStepsSkipped": "A runtime count for the number of steps in the workflow that were skipped.
" } }, "WorkflowStepDescription": { "base": null, "refs": { "GetWorkflowStepExecutionResponse$description": "Describes the specified workflow step.
", "WorkflowStepMetadata$description": "Description of the workflow step.
" } }, "WorkflowStepExecution": { "base": "Contains runtime details for a workflow step that has paused at a WaitForAction step, and is waiting for you to send an action.
The unique identifier for the runtime instance of the workflow step that you want to get runtime details for. To get the identifiers for the steps that ran in a workflow, call ListWorkflowStepExecutions.
", "GetWorkflowStepExecutionResponse$stepExecutionId": "The unique identifier for the runtime instance of the workflow step that you specified in the request.
", "ImageFailureContext$stepExecutionId": "The unique identifier of the workflow step execution that failed.
", "SendWorkflowStepActionRequest$stepExecutionId": "Uniquely identifies the waiting workflow step that you send the action to. To get this identifier, call ListWaitingWorkflowSteps.
", "SendWorkflowStepActionResponse$stepExecutionId": "The unique identifier for the workflow step that received the action, as specified in the request.
", "WorkflowStepExecution$stepExecutionId": "Uniquely identifies the workflow step that ran for the associated image build version.
", "WorkflowStepMetadata$stepExecutionId": "A unique identifier for the workflow step, assigned at runtime.
" } }, "WorkflowStepExecutionList": { "base": null, "refs": { "ListWaitingWorkflowStepsResponse$steps": "An array of the workflow steps that are waiting for action in your Amazon Web Services account. Each step is paused at a WaitForAction step, and remains in the list until you respond with SendWorkflowStepAction or the wait times out.
Reports on the rollback status of the specified runtime instance of the workflow step, if applicable. Rollback runs when the workflow execution fails, and undoes the work that completed steps performed.
", "WorkflowStepMetadata$rollbackStatus": "Reports on the rollback status of the step, if applicable.
" } }, "WorkflowStepExecutionStatus": { "base": null, "refs": { "GetWorkflowStepExecutionResponse$status": "The current status for the specified runtime instance of the workflow step.
", "WorkflowStepMetadata$status": "Runtime status for the workflow step.
" } }, "WorkflowStepExecutionsList": { "base": null, "refs": { "ListWorkflowStepExecutionsResponse$steps": "Contains an array of runtime details that represents each step in this runtime instance of the workflow.
" } }, "WorkflowStepInputs": { "base": null, "refs": { "GetWorkflowStepExecutionResponse$inputs": "Input parameters that Image Builder provided for the specified runtime instance of the workflow step, as a JSON-encoded string.
", "WorkflowStepMetadata$inputs": "Input parameters that Image Builder provides for the workflow step, as a JSON-encoded string.
" } }, "WorkflowStepMessage": { "base": null, "refs": { "GetWorkflowStepExecutionResponse$message": "The output message from the specified runtime instance of the workflow step, if applicable.
", "WorkflowStepMetadata$message": "Detailed output message that the workflow step provides at runtime.
" } }, "WorkflowStepMetadata": { "base": "Runtime details and status for the workflow step.
", "refs": { "WorkflowStepExecutionsList$member": null } }, "WorkflowStepName": { "base": null, "refs": { "GetWorkflowStepExecutionResponse$name": "The name of the specified runtime instance of the workflow step.
", "ImageFailureContext$failedStep": "The name of the workflow step that failed, as it appears in the workflow document.
", "WorkflowStepExecution$name": "The name of the workflow step.
", "WorkflowStepMetadata$name": "The name of the workflow step.
" } }, "WorkflowStepOutputs": { "base": null, "refs": { "GetWorkflowStepExecutionResponse$outputs": "The output values that the specified runtime instance of the workflow step produced, as a JSON-encoded string. For example, a step that launches an instance outputs the instance ID. If the step failed, this field contains the error message.
", "WorkflowStepMetadata$outputs": "The output values that the workflow step produced for this runtime instance of the workflow, as a JSON-encoded string. For example, a step that launches an instance outputs the instance ID. If the step failed, this field contains the error message.
" } }, "WorkflowStepTimeoutSecondsInteger": { "base": null, "refs": { "GetWorkflowStepExecutionResponse$timeoutSeconds": "The maximum duration in seconds for this step to complete its action. If the workflow document doesn't set a timeout for the step, Image Builder applies the default timeout for the step's action. This field returns that value.
" } }, "WorkflowSummary": { "base": "Contains metadata about the workflow resource.
", "refs": { "WorkflowSummaryList$member": null } }, "WorkflowSummaryList": { "base": null, "refs": { "ListWorkflowBuildVersionsResponse$workflowSummaryList": "A list that contains metadata for the build versions of the workflow resource specified in the request.
" } }, "WorkflowType": { "base": null, "refs": { "CreateWorkflowRequest$type": "The image creation stage that this workflow applies to. Image Builder validates the workflow document steps against the stage you specify.
", "GetWorkflowExecutionResponse$type": "The type of workflow that Image Builder ran for the specified runtime instance of the workflow.
", "Workflow$type": "The image creation stage that the workflow applies to.
", "WorkflowExecutionMetadata$type": "Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
", "WorkflowSummary$type": "The image creation stage that this workflow applies to.
", "WorkflowVersion$type": "The image creation stage that this workflow applies to.
" } }, "WorkflowVersion": { "base": "Contains details about this version of the workflow.
", "refs": { "WorkflowVersionList$member": null } }, "WorkflowVersionArnOrBuildVersionArn": { "base": null, "refs": { "GetWorkflowRequest$workflowBuildVersionArn": "The Amazon Resource Name (ARN) of the workflow resource that you want to get. You can specify a build version ARN, or a version ARN with or without wildcards (x) in its version segments. Image Builder resolves version and wildcard ARNs to the most recent matching build version.
The Amazon Resource Name (ARN) of the workflow resource.
" } }, "WorkflowVersionList": { "base": null, "refs": { "ListWorkflowsResponse$workflowVersionList": "A list of workflow versions that match the request criteria.
" } }, "WorkflowWildcardVersionArn": { "base": null, "refs": { "ListWorkflowBuildVersionsRequest$workflowVersionArn": "The Amazon Resource Name (ARN) of the workflow resource for which to get a list of build versions. The version segments can contain wildcards (x) to match multiple versions of the workflow. If you don't specify an ARN, the response lists build versions for all of the workflows in your account.
The Amazon Resource Name (ARN) of the workflow resource.
" } } } }