How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon EC2 Image Builder GetImage#imageBuildVersionArn API

The GetImage#imageBuildVersionArn API from Amazon EC2 Image Builder — 1 operation(s) for getimage#imagebuildversionarn.

Amazon EC2 Image Builder GetImage#imageBuildVersionArn API is one of 54 APIs that Amazon EC2 Image Builder publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include GetImage#imageBuildVersionArn. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a getting-started guide, pricing, an API reference, and 3 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 101 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://imagebuilder.{region}.amazonaws.com, https://imagebuilder.{region}.amazonaws.com, http://imagebuilder.{region}.amazonaws.com.cn, https://imagebuilder.{region}.amazonaws.com.cn.

1 operations 1 paths 101 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://imagebuilder.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon EC2 Image Builder GetImage#imageBuildVersionArn API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

GetImage#imageBuildVersionArn 1
GET
/GetImage#imageBuildVersionArn
Amazon EC2 Image Builder Get Image
GetImage 8 params → 200480481482483484485

Schemas 101

The contract defines 101 schemas that model the data the API accepts and returns. The most detailed are Image (22 properties), ContainerRecipe (17 properties), InfrastructureConfiguration (16 properties), ImageRecipe (14 properties). Each schema is shown below with its type and property counts.

EbsVolumeType
string
NullableBoolean
boolean
S3ExportConfiguration
object
Properties that configure export from your build instance to a compatible file format for your VM.
4 properties 3 required
Image
object
An Image Builder image. You must specify exactly one recipe for the image – either a container recipe ( containerRecipe ), which creates a container image, or…
22 properties
OrganizationArn
string
AmiDistributionConfiguration
object
Define and configure the output AMIs of the pipeline.
6 properties
ImageTestsTimeoutMinutes
integer
ImageState
object
Image status and the reason for that status.
2 properties
Distribution
object
Defines the settings for a specific Region.
7 properties 1 required
ContainerRecipe
object
A container recipe.
17 properties
ResourceName
string
EbsVolumeSizeInteger
integer
InstanceMetadataOptions
object
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 insta…
2 properties
ContainerRepositoryService
string
ContainerList
array
FastLaunchConfigurationList
array
ComponentVersionArnOrBuildVersionArn
string
TargetResourceCount
integer
InfrastructureConfiguration
object
Details of the infrastructure configuration.
16 properties
ComponentParameterList
array
ImageScanState
object
Shows the vulnerability scan status for a specific image, and the reason for that status.
2 properties
DockerFileTemplate
string
ComponentParameterName
string
ImageType
string
StringList
array
FastLaunchLaunchTemplateSpecification
object
Identifies the launch template that the associated Windows AMI uses for launching an instance when faster launching is enabled. You can specify either the laun…
3 properties
UserDataOverride
string
SecurityGroupIds
array
BuildType
string
ImageSource
string
InvalidRequestException
ServiceException
EbsVolumeThroughput
integer
DistributionConfiguration
object
A distribution configuration.
8 properties 1 required
LaunchTemplateId
string
InstanceBlockDeviceMappings
array
LaunchTemplateConfigurationList
array
DistributionTimeoutMinutes
integer
LaunchPermissionConfiguration
object
Describes the configuration for a launch permission. The launch permission modification request is sent to the Amazon EC2 ModifyImageAttribute API on behalf of…
4 properties
EmptyString
string
InstanceProfileNameType
string
ResourceTagMap
object
HttpTokens
string
AccountList
array
AmiNameString
string
Arn
string
VersionNumber
string
EbsInstanceBlockDeviceSpecification
object
Amazon EBS-specific block device mapping specifications.
8 properties
ImageScanStatus
string
Container
object
A container encapsulates the runtime environment for an application.
2 properties
AmiList
array
OrganizationalUnitArnList
array
InstanceBlockDeviceMapping
object
Defines block device mappings for the instance used to configure your image.
4 properties
DistributionList
array
ImageStatus
string
FastLaunchConfiguration
object
Define and configure faster launching for output Windows AMIs.
5 properties 1 required
EcrConfiguration
object
Settings that Image Builder uses to configure the ECR repository and the output container images that Amazon Inspector scans.
2 properties
NonEmptyString
string
ServiceUnavailableException
ClientException
InstanceConfiguration
object
Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.
2 properties
Ami
object
Details of an Amazon EC2 AMI.
6 properties
Boolean
boolean
LaunchTemplateConfiguration
object
Identifies an Amazon EC2 launch template to use for a specific account.
3 properties 1 required
TargetContainerRepository
object
The container repository where the output container image is stored.
2 properties 2 required
ComponentConfigurationList
array
S3Logs
object
Amazon S3 logging configuration.
2 properties
ForbiddenException
ContainerType
string
EbsIopsInteger
integer
CallRateLimitExceededException
ComponentParameterValue
string
LicenseConfigurationArnList
array
ImageBuilderArn
string
OrganizationArnList
array
ContainerDistributionConfiguration
object
Container distribution settings for encryption, licensing, and sharing in a specific Region.
3 properties 1 required
FastLaunchSnapshotConfiguration
object
Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
1 property
Platform
string
Logging
object
Logging configuration defines where Image Builder uploads your logs.
1 property
HttpPutResponseHopLimit
integer
AccountId
string
ImageRecipe
object
An image recipe.
14 properties
ComponentParameter
object
Contains a key/value pair that sets the named component parameter.
2 properties 2 required
OrganizationalUnitArn
string
ImageScanningConfiguration
object
Contains settings for Image Builder image resource and container image scans.
2 properties
LicenseConfigurationArn
string
ComponentConfiguration
object
Configuration details of the component.
2 properties 1 required
ImageTestsConfiguration
object
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.
2 properties
ComponentParameterValueList
array
OutputResources
object
The resources produced by this image.
2 properties
DateTime
string
MaxParallelLaunches
integer
SystemsManagerAgent
object
Contains settings for the Systems Manager agent on your build instance.
1 property
TagMap
object
InstanceType
string
TagValue
string
InstanceTypeList
array
AdditionalInstanceConfiguration
object
In addition to your infrastructure configuration, these settings provide an extra layer of control over your build instances. You can also specify commands to…
2 properties
OsVersion
string
DiskImageFormat
string
GetImageResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-ec2-image-builder-getimage-imagebuildversionarn-api-openapi.yml Raw ↑

Other APIs Amazon EC2 Image Builder publishes across the network.

Amazon EC2 Image Builder CancelImageCreation API
Amazon EC2 Image Builder CreateComponent API
Amazon EC2 Image Builder CreateContainerRecipe API
Amazon EC2 Image Builder CreateDistributionConfiguration API
Amazon EC2 Image Builder CreateImage API
Amazon EC2 Image Builder CreateImagePipeline API
Amazon EC2 Image Builder CreateImageRecipe API
Amazon EC2 Image Builder CreateInfrastructureConfiguration API
Amazon EC2 Image Builder DeleteComponent#componentBuildVersionArn API
Amazon EC2 Image Builder DeleteContainerRecipe#containerRecipeArn API
Amazon EC2 Image Builder DeleteDistributionConfiguration#distributionConfigurationArn API
Amazon EC2 Image Builder DeleteImage#imageBuildVersionArn API
Where this information came from

This is an independent, third-party profile of Amazon EC2 Image Builder GetImage#imageBuildVersionArn API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.