Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-ec2-image-builder-getimage-imagebuildversionarn-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 1.0.0
x-release: v4
title: EC2 Image Builder CancelImageCreation Get Image#image Build Version Arn API
description: EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: imagebuilder
x-aws-signingName: imagebuilder
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/imagebuilder-2019-12-02.normal.json
converter:
url: https://github.com/mermade/aws2openapi
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://imagebuilder.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The imagebuilder multi-region endpoint
- url: https://imagebuilder.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The imagebuilder multi-region endpoint
- url: http://imagebuilder.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The imagebuilder endpoint for China (Beijing) and China (Ningxia)
- url: https://imagebuilder.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The imagebuilder endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: GetImage#imageBuildVersionArn
paths:
/GetImage#imageBuildVersionArn:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: GetImage
description: Gets an image.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetImageResponse'
examples:
GetImage200Example:
summary: Default GetImage 200 response
x-microcks-default: true
value:
requestId: example-id-1234
image: example-string
'480':
description: ServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceException'
examples:
GetImage480Example:
summary: Default GetImage 480 response
x-microcks-default: true
value: {}
'481':
description: ClientException
content:
application/json:
schema:
$ref: '#/components/schemas/ClientException'
examples:
GetImage481Example:
summary: Default GetImage 481 response
x-microcks-default: true
value: {}
'482':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'483':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'484':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'485':
description: CallRateLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/CallRateLimitExceededException'
parameters:
- name: imageBuildVersionArn
in: query
required: true
description: The Amazon Resource Name (ARN) of the image that you want to get.
schema:
type: string
pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/(?:(?:([0-9]+|x)\.([0-9]+|x)\.([0-9]+|x))|(?:[0-9]+\.[0-9]+\.[0-9]+/[0-9]+))$
summary: Amazon EC2 Image Builder Get Image
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- GetImage#imageBuildVersionArn
components:
parameters:
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
schemas:
EbsVolumeType:
type: string
enum:
- standard
- io1
- io2
- gp2
- gp3
- sc1
- st1
NullableBoolean:
type: boolean
S3ExportConfiguration:
type: object
required:
- roleName
- diskImageFormat
- s3Bucket
properties:
roleName:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of the role that grants VM Import/Export permission to export images to your S3 bucket.
diskImageFormat:
allOf:
- $ref: '#/components/schemas/DiskImageFormat'
- description: <p>Export the updated image to one of the following supported disk image formats:</p> <ul> <li> <p> <b>Virtual Hard Disk (VHD)</b> – Compatible with Citrix Xen and Microsoft Hyper-V virtualization products.</p> </li> <li> <p> <b>Stream-optimized ESX Virtual Machine Disk (VMDK)</b> – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6.</p> </li> <li> <p> <b>Raw</b> – Raw format.</p> </li> </ul>
s3Bucket:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The S3 bucket in which to store the output disk images for your VM.
s3Prefix:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The Amazon S3 path for the bucket where the output disk images for your VM are stored.
description: Properties that configure export from your build instance to a compatible file format for your VM.
Image:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/ImageBuilderArn'
- description: '<p>The Amazon Resource Name (ARN) of the image.</p> <note> <p>Semantic versioning is included in each object''s Amazon Resource Name (ARN), at the level that applies to that object as follows:</p> <ol> <li> <p>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.</p> </li> <li> <p>Version ARNs have only the first three nodes: <major>.<minor>.<patch></p> </li> <li> <p>Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.</p> </li> </ol> </note>'
type:
allOf:
- $ref: '#/components/schemas/ImageType'
- description: Specifies whether this image produces an AMI or a container image.
name:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the image.
version:
allOf:
- $ref: '#/components/schemas/VersionNumber'
- description: '<p>The semantic version of the image.</p> <note> <p>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.</p> <p> <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.</p> <p> <b>Patterns:</b> 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.</p> <p> <b>Filtering:</b> With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.</p> </note>'
platform:
allOf:
- $ref: '#/components/schemas/Platform'
- description: The image operating system platform, such as Linux or Windows.
enhancedImageMetadataEnabled:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
osVersion:
allOf:
- $ref: '#/components/schemas/OsVersion'
- description: The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
state:
allOf:
- $ref: '#/components/schemas/ImageState'
- description: The state of the image.
imageRecipe:
allOf:
- $ref: '#/components/schemas/ImageRecipe'
- description: 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.
containerRecipe:
allOf:
- $ref: '#/components/schemas/ContainerRecipe'
- description: 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.
sourcePipelineName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the image pipeline that created this image.
sourcePipelineArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the image pipeline that created this image.
infrastructureConfiguration:
allOf:
- $ref: '#/components/schemas/InfrastructureConfiguration'
- description: The infrastructure that Image Builder used to create this image.
distributionConfiguration:
allOf:
- $ref: '#/components/schemas/DistributionConfiguration'
- description: The distribution configuration that Image Builder used to create this image.
imageTestsConfiguration:
allOf:
- $ref: '#/components/schemas/ImageTestsConfiguration'
- description: The image tests that ran when that Image Builder created this image.
dateCreated:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: The date on which Image Builder created this image.
outputResources:
allOf:
- $ref: '#/components/schemas/OutputResources'
- description: The output resources that Image Builder produces for this image.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: The tags that apply to this image.
buildType:
allOf:
- $ref: '#/components/schemas/BuildType'
- description: <p>Indicates the type of build that created this image. The build can be initiated in the following ways:</p> <ul> <li> <p> <b>USER_INITIATED</b> – A manual pipeline build request.</p> </li> <li> <p> <b>SCHEDULED</b> – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.</p> </li> <li> <p> <b>IMPORT</b> – A VM import created the image to use as the base image for the recipe.</p> </li> </ul>
imageSource:
allOf:
- $ref: '#/components/schemas/ImageSource'
- description: The origin of the base image that Image Builder used to build this image.
scanState:
allOf:
- $ref: '#/components/schemas/ImageScanState'
- description: Contains information about the current state of scans for this image.
imageScanningConfiguration:
allOf:
- $ref: '#/components/schemas/ImageScanningConfiguration'
- description: Contains settings for vulnerability scans.
description: An Image Builder image. You must specify exactly one recipe for the image – either a container recipe (<code>containerRecipe</code>), which creates a container image, or an image recipe (<code>imageRecipe</code>), which creates an AMI.
OrganizationArn:
type: string
pattern: ^arn:aws[^:]*:organizations::[0-9]{12}:organization/o-[a-z0-9]{10,32}$
AmiDistributionConfiguration:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/AmiNameString'
- description: The name of the output AMI.
description:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The description of the AMI distribution configuration. Minimum and maximum length are in characters.
targetAccountIds:
allOf:
- $ref: '#/components/schemas/AccountList'
- description: The ID of an account to which you want to distribute an image.
amiTags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: The tags to apply to AMIs distributed to this Region.
kmsKeyId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The KMS key identifier used to encrypt the distributed image.
launchPermission:
allOf:
- $ref: '#/components/schemas/LaunchPermissionConfiguration'
- description: Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
description: Define and configure the output AMIs of the pipeline.
ImageTestsTimeoutMinutes:
type: integer
minimum: 60
maximum: 1440
ImageState:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/ImageStatus'
- description: The status of the image.
reason:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The reason for the status of the image.
description: Image status and the reason for that status.
Distribution:
type: object
required:
- region
properties:
region:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The target Region.
example: example-string
amiDistributionConfiguration:
allOf:
- $ref: '#/components/schemas/AmiDistributionConfiguration'
- description: The specific AMI settings; for example, launch permissions or AMI tags.
example: example-id-1234
containerDistributionConfiguration:
allOf:
- $ref: '#/components/schemas/ContainerDistributionConfiguration'
- description: Container distribution settings for encryption, licensing, and sharing in a specific Region.
example: example-string
licenseConfigurationArns:
allOf:
- $ref: '#/components/schemas/LicenseConfigurationArnList'
- description: The License Manager Configuration to associate with the AMI in the specified Region.
example: arn:aws:service:us-east-1:123456789012:resource/example
launchTemplateConfigurations:
allOf:
- $ref: '#/components/schemas/LaunchTemplateConfigurationList'
- description: A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.
example: example-string
s3ExportConfiguration:
allOf:
- $ref: '#/components/schemas/S3ExportConfiguration'
- description: 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.
example: example-string
fastLaunchConfigurations:
allOf:
- $ref: '#/components/schemas/FastLaunchConfigurationList'
- description: The Windows faster-launching configurations to use for AMI distribution.
example: example-string
description: Defines the settings for a specific Region.
ContainerRecipe:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/ImageBuilderArn'
- description: '<p>The Amazon Resource Name (ARN) of the container recipe.</p> <note> <p>Semantic versioning is included in each object''s Amazon Resource Name (ARN), at the level that applies to that object as follows:</p> <ol> <li> <p>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.</p> </li> <li> <p>Version ARNs have only the first three nodes: <major>.<minor>.<patch></p> </li> <li> <p>Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.</p> </li> </ol> </note>'
containerType:
allOf:
- $ref: '#/components/schemas/ContainerType'
- description: Specifies the type of container, such as Docker.
name:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the container recipe.
description:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The description of the container recipe.
platform:
allOf:
- $ref: '#/components/schemas/Platform'
- description: The system platform for the container, such as Windows or Linux.
owner:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The owner of the container recipe.
version:
allOf:
- $ref: '#/components/schemas/VersionNumber'
- description: '<p>The semantic version of the container recipe.</p> <note> <p>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.</p> <p> <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.</p> <p> <b>Patterns:</b> 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.</p> <p> <b>Filtering:</b> With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.</p> </note>'
components:
allOf:
- $ref: '#/components/schemas/ComponentConfigurationList'
- description: Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
instanceConfiguration:
allOf:
- $ref: '#/components/schemas/InstanceConfiguration'
- description: A group of options that can be used to configure an instance for building and testing container images.
dockerfileTemplateData:
allOf:
- $ref: '#/components/schemas/DockerFileTemplate'
- description: Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
kmsKeyId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
encrypted:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: A flag that indicates if the target container is encrypted.
parentImage:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The base image for the container recipe.
dateCreated:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: The date when this container recipe was created.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: Tags that are attached to the container recipe.
workingDirectory:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The working directory for use during build and test workflows.
targetRepository:
allOf:
- $ref: '#/components/schemas/TargetContainerRepository'
- description: The destination repository for the container image.
description: A container recipe.
ResourceName:
type: string
pattern: ^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$
EbsVolumeSizeInteger:
type: integer
minimum: 1
maximum: 16000
InstanceMetadataOptions:
type: object
properties:
httpTokens:
allOf:
- $ref: '#/components/schemas/HttpTokens'
- description: <p>Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:</p> <ul> <li> <p> <b>required</b> – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.</p> </li> <li> <p> <b>optional</b> – 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.</p> </li> </ul> <p>The default setting is <b>optional</b>.</p>
httpPutResponseHopLimit:
allOf:
- $ref: '#/components/schemas/HttpPutResponseHopLimit'
- description: Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.
description: The instance metadata options that apply to the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html">Configure the instance metadata options</a> in the <i> <i>Amazon EC2 User Guide</i> </i> for Linux instances, or <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html">Configure the instance metadata options</a> in the <i> <i>Amazon EC2 Windows Guide</i> </i> for Windows instances.
ContainerRepositoryService:
type: string
enum:
- ECR
ContainerList:
type: array
items:
$ref: '#/components/schemas/Container'
FastLaunchConfigurationList:
type: array
items:
$ref: '#/components/schemas/FastLaunchConfiguration'
minItems: 1
maxItems: 1000
ComponentVersionArnOrBuildVersionArn:
type: string
pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/(?:(?:([0-9]+|x)\.([0-9]+|x)\.([0-9]+|x))|(?:[0-9]+\.[0-9]+\.[0-9]+/[0-9]+))$
TargetResourceCount:
type: integer
minimum: 1
maximum: 10000
InfrastructureConfiguration:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/ImageBuilderArn'
- description: The Amazon Resource Name (ARN) of the infrastructure configuration.
name:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The name of the infrastructure configuration.
description:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The description of the infrastructure configuration.
instanceTypes:
allOf:
- $ref: '#/components/schemas/InstanceTypeList'
- description: The instance types of the infrastructure configuration.
instanceProfileName:
allOf:
- $ref: '#/components/schemas/InstanceProfileNameType'
- description: The instance profile of the infrastructure configuration.
securityGroupIds:
allOf:
- $ref: '#/components/schemas/SecurityGroupIds'
- description: The security group IDs of the infrastructure configuration.
subnetId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The subnet ID of the infrastructure configuration.
logging:
allOf:
- $ref: '#/components/schemas/Logging'
- description: The logging configuration of the infrastructure configuration.
keyPair:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The Amazon EC2 key pair of the infrastructure configuration.
terminateInstanceOnFailure:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: The terminate instance on failure configuration of the infrastructure configuration.
snsTopicArn:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: <p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.</p> <note> <p>EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.</p> </note>
dateCreated:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: The date on which the infrastructure configuration was created.
dateUpdated:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: The date on which the infrastructure configuration was last updated.
resourceTags:
allOf:
- $ref: '#/components/schemas/ResourceTagMap'
- description: The tags attached to the resource created by Image Builder.
instanceMetadataOptions:
allOf:
- $ref: '#/components/schemas/InstanceMetadataOptions'
- description: The instance metadata option settings for the infrastructure configuration.
tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- description: The tags of the infrastructure configuration.
description: Details of the infrastructure configuration.
ComponentParameterList:
type: array
items:
$ref: '#/components/schemas/ComponentParameter'
minItems: 1
ImageScanState:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/ImageScanStatus'
- description: The current state of vulnerability scans for the image.
reason:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The reason for the scan status for the image.
description: Shows the vulnerability scan status for a specific image, and the reason for that status.
DockerFileTemplate:
type: string
ComponentParameterName:
type: string
pattern: '[^\x00]+'
minLength: 1
maxLength: 256
ImageType:
type: string
enum:
- AMI
- DOCKER
StringList:
type: array
items:
$ref: '#/components/schemas/NonEmptyString'
FastLaunchLaunchTemplateSpecification:
type: object
properties:
launchTemplateId:
allOf:
- $ref: '#/components/schemas/LaunchTemplateId'
- description: The ID of the launch template to use for faster launching for a Windows AMI.
launchTemplateName:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of the launch template to use for faster launching for a Windows AMI.
launchTemplateVersion:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The version of the launch template to use for faster launching for a Windows AMI.
description: <p>Identifies the launch template that the associated Windows AMI uses for launching an instance when faster launching is enabled.</p> <note> <p>You can specify either the <code>launchTemplateName</code> or the <code>launchTemplateId</code>, but not both.</p> </note>
UserDataOverride:
type: string
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
minLength: 1
maxLength: 21847
SecurityGroupIds:
type: array
items:
$ref: '#/components/schemas/NonEmptyString'
BuildType:
type: string
enum:
- USER_INITIATED
- SCHEDULED
- IMPORT
ImageSource:
type: string
enum:
- AMAZON_MA
# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-ec2-image-builder/refs/heads/main/openapi/amazon-ec2-image-builder-getimage-imagebuildversionarn-api-openapi.yml