openapi: 3.0.0
info:
version: 2019-12-02
x-release: v4
title: EC2 Image Builder CancelImageCreation GetImage#imageBuildVersionArn 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
version: 1.0.0
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:
schemas:
LaunchTemplateConfigurationList:
type: array
items:
$ref: '#/components/schemas/LaunchTemplateConfiguration'
minItems: 1
maxItems: 100
Platform:
type: string
enum:
- Windows
- Linux
ImageType:
type: string
enum:
- AMI
- DOCKER
InstanceProfileNameType:
type: string
pattern: ^[\w+=,.@-]+$
minLength: 1
maxLength: 256
FastLaunchConfigurationList:
type: array
items:
$ref: '#/components/schemas/FastLaunchConfiguration'
minItems: 1
maxItems: 1000
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.
InstanceConfiguration:
type: object
properties:
image:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.
blockDeviceMappings:
allOf:
- $ref: '#/components/schemas/InstanceBlockDeviceMappings'
- description: Defines the block devices to attach for building an instance from this Image Builder AMI.
description: Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.
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.
ServiceUnavailableException: {}
Ami:
type: object
properties:
region:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The Amazon Web Services Region of the Amazon EC2 AMI.
image:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The AMI ID of the Amazon EC2 AMI.
name:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of the Amazon EC2 AMI.
description:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.
state:
$ref: '#/components/schemas/ImageState'
accountId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The account ID of the owner of the AMI.
description: Details of an Amazon EC2 AMI.
LaunchTemplateId:
type: string
pattern: ^lt-[a-z0-9-_]{17}$
ComponentParameterName:
type: string
pattern: '[^\x00]+'
minLength: 1
maxLength: 256
EmptyString:
type: string
minLength: 0
maxLength: 0
OrganizationalUnitArnList:
type: array
items:
$ref: '#/components/schemas/OrganizationalUnitArn'
minItems: 1
maxItems: 25
ImageScanningConfiguration:
type: object
properties:
imageScanningEnabled:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
ecrConfiguration:
allOf:
- $ref: '#/components/schemas/EcrConfiguration'
- description: Contains Amazon ECR settings for vulnerability scans.
description: Contains settings for Image Builder image resource and container image scans.
AmiNameString:
type: string
pattern: ^[-_A-Za-z0-9{][-_A-Za-z0-9\s:{}\.]+[-_A-Za-z0-9}]$
minLength: 1
maxLength: 127
SecurityGroupIds:
type: array
items:
$ref: '#/components/schemas/NonEmptyString'
OrganizationArnList:
type: array
items:
$ref: '#/components/schemas/OrganizationArn'
minItems: 1
maxItems: 25
MaxParallelLaunches:
type: integer
minimum: 1
maximum: 10000
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>
DiskImageFormat:
type: string
enum:
- VMDK
- RAW
- VHD
LaunchTemplateConfiguration:
type: object
required:
- launchTemplateId
properties:
launchTemplateId:
allOf:
- $ref: '#/components/schemas/LaunchTemplateId'
- description: Identifies the Amazon EC2 launch template to use.
accountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: The account ID that this configuration applies to.
setDefaultVersion:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Set the specified Amazon EC2 launch template as the default launch template for the specified account.
description: Identifies an Amazon EC2 launch template to use for a specific account.
InvalidRequestException: {}
DockerFileTemplate:
type: string
AdditionalInstanceConfiguration:
type: object
properties:
systemsManagerAgent:
allOf:
- $ref: '#/components/schemas/SystemsManagerAgent'
- description: Contains settings for the Systems Manager agent on your build instance.
userDataOverride:
allOf:
- $ref: '#/components/schemas/UserDataOverride'
- description: <p>Use this property to provide commands or a command script to run when you launch your build instance.</p> <p>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.</p> <note> <p>The user data is always base 64 encoded. For example, the following commands are encoded as <code>IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$</code>:</p> <p> <i>#!/bin/bash</i> </p> <p>mkdir -p /var/bb/</p> <p>touch /var</p> </note>
description: <p>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.</p> <p>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.</p>
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.
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.
SystemsManagerAgent:
type: object
properties:
uninstallAfterBuild:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
example: example-string
description: Contains settings for the Systems Manager agent on your build instance.
InstanceBlockDeviceMappings:
type: array
items:
$ref: '#/components/schemas/InstanceBlockDeviceMapping'
Logging:
type: object
properties:
s3Logs:
allOf:
- $ref: '#/components/schemas/S3Logs'
- description: The Amazon S3 logging configuration.
description: Logging configuration defines where Image Builder uploads your logs.
Container:
type: object
properties:
region:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: Containers and container images are Region-specific. This is the Region context for the container.
imageUris:
allOf:
- $ref: '#/components/schemas/StringList'
- description: A list of URIs for containers created in the context Region.
description: A container encapsulates the runtime environment for an application.
EbsVolumeThroughput:
type: integer
minimum: 125
maximum: 1000
HttpTokens:
type: string
pattern: optional|required
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.
VersionNumber:
type: string
pattern: ^[0-9]+\.[0-9]+\.[0-9]+$
StringList:
type: array
items:
$ref: '#/components/schemas/NonEmptyString'
DistributionList:
type: array
items:
$ref: '#/components/schemas/Distribution'
ImageSource:
type: string
enum:
- AMAZON_MANAGED
- AWS_MARKETPLACE
- IMPORTED
- CUSTOM
ImageStatus:
type: string
enum:
- PENDING
- CREATING
- BUILDING
- TESTING
- DISTRIBUTING
- INTEGRATING
- AVAILABLE
- CANCELLED
- FAILED
- DEPRECATED
- DELETED
LicenseConfigurationArnList:
type: array
items:
$ref: '#/components/schemas/LicenseConfigurationArn'
minItems: 1
maxItems: 50
OrganizationalUnitArn:
type: string
pattern: ^arn:aws[^:]*:organizations::[0-9]{12}:ou/o-[a-z0-9]{10,32}/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}
AccountList:
type: array
items:
$ref: '#/components/schemas/AccountId'
minItems: 1
maxItems: 1536
CallRateLimitExceededException: {}
TagValue:
type: string
maxLength: 256
AccountId:
type: string
pattern: ^[0-9]{12}$
DistributionTimeoutMinutes:
type: integer
minimum: 30
maximum: 720
ImageRecipe:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/ImageBuilderArn'
- description: The Amazon Resource Name (ARN) of the image recipe.
type:
allOf:
- $ref:
# --- 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