ImageSummary
An image summary.
Contents
- arn
-
The Amazon Resource Name (ARN) of the image.
Type: String
Pattern:
^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$Required: No
- 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.
Type: String
Valid Values:
USER_INITIATED | SCHEDULED | IMPORTRequired: No
-
- dateCreated
-
The date on which Image Builder created this image.
Type: String
Required: No
- deprecationTime
-
The time when deprecation occurs for an image resource. This can be a past or future date.
Type: Timestamp
Required: No
- imageSource
-
The origin of the base image that Image Builder used to build this image.
Type: String
Valid Values:
AMAZON_MANAGED | AWS_MARKETPLACE | IMPORTED | CUSTOMRequired: No
- lifecycleExecutionId
-
Identifies the last runtime instance of the lifecycle policy to take action on the image.
Type: String
Pattern:
^lce-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Required: No
- name
-
The name of the image.
Type: String
Pattern:
^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$Required: No
- 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.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- outputResources
-
The output resources that Image Builder produced when it created this image.
Type: OutputResources object
Required: No
- owner
-
The owner of the image.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- platform
-
The image operating system platform, such as Linux or Windows.
Type: String
Valid Values:
Windows | Linux | macOSRequired: No
- state
-
The state of the image.
Type: ImageState object
Required: No
-
The tags that apply to this image.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$Value Length Constraints: Maximum length of 256.
Required: No
- type
-
Specifies whether this image produces an AMI or a container image.
Type: String
Valid Values:
AMI | DOCKERRequired: No
- version
-
The version of the image.
Type: String
Pattern:
^[0-9]+\.[0-9]+\.[0-9]+$Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
