| Column Name | Column Data Type |
by_name Input Column
Requests a list of images with a specific recipe name. | BOOLEAN |
filters Input Column
Use the following filters to streamline results: -
name -
osVersion -
platform -
type -
version | STRUCT( "name" VARCHAR, "values" VARCHAR[] )[] |
Show child fields- filters[]
Show child fields- filters[].name
The name of the filter. Filter names are case-sensitive.
- filters[].values[]
|
include_deprecated Input Column
Includes deprecated images in the response list. | BOOLEAN |
max_results Input Column
The maximum items to return in a request. | BIGINT |
next_token Input Column
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. | VARCHAR |
owner Input Column
The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT( "type" VARCHAR, "name" VARCHAR, "account_id" VARCHAR, "via_profile_name" VARCHAR, "assumed_role_arn" VARCHAR, "organization" STRUCT( "account_name" VARCHAR, "id" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[], "master_account" STRUCT( "id" VARCHAR, "email" VARCHAR ), "parents" STRUCT( "type" VARCHAR, "id" VARCHAR, "name" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[] )[] ) ) |
Show child fields- _aws_profile.account_id
The AWS account id
- _aws_profile.assumed_role_arn
The ARN of the assumed role
- _aws_profile.name
The unique name of the profile.
- _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization
- _aws_profile.organization.id
The organization id
- _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address
- _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent
- _aws_profile.organization.parents[].name
The name of the parent
- _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role'
- _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
image_version_list
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: 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. | STRUCT( "arn" VARCHAR, "name" VARCHAR, "type" VARCHAR, "version" VARCHAR, "platform" VARCHAR, "os_version" VARCHAR, "owner" VARCHAR, "date_created" VARCHAR, "build_type" VARCHAR, "image_source" VARCHAR )[] |
Show child fields- image_version_list[]
Show child fields- image_version_list[].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.
- image_version_list[].build_type
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.
- image_version_list[].date_created
The date on which this specific version of the Image Builder image was created.
- image_version_list[].image_source
The origin of the base image that Image Builder used to build this image.
- image_version_list[].name
The name of this specific version of an Image Builder image.
- image_version_list[].os_version
The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
- image_version_list[].owner
The owner of the image version.
- image_version_list[].platform
The operating system platform of the image version, for example "Windows" or "Linux".
- image_version_list[].type
Specifies whether this image produces an AMI or a container image.
- image_version_list[].version
Details for a specific version of an Image Builder 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, with an upper limit of 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: 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.
|
request_id
The request ID that uniquely identifies this request. | VARCHAR |