AWS CLI Command Reference

[ aws . imagebuilder ]

list-image-build-versionsÂķ

DescriptionÂķ

Returns a list of image build versions.

See also: AWS API Documentation

list-image-build-versions is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: imageSummaryList

SynopsisÂķ

  list-image-build-versions
[--image-version-arn <value>]
[--filters <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

OptionsÂķ

--image-version-arn (string)

The Amazon Resource Name (ARN) of the image version whose build versions you want to retrieve. The ARN must specify an exact version (<major>.<minor>.<patch> ) - wildcards aren’t allowed. This parameter is optional. If you don’t specify it, Image Builder returns build versions for all of the images in your account.

Constraints:

  • pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):image/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+$

--filters (list)

Use the following filters to streamline results:

  • name
  • osVersion
  • platform
  • type
  • version

Constraints:

  • min: 1
  • max: 10

(structure)

A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

name -> (string)

The name of the filter. Filter names are case-sensitive.

Constraints:

  • pattern: ^[a-zA-Z]{1,1024}$

values -> (list)

The filter values. Filter values are case-sensitive.

Constraints:

  • min: 1
  • max: 10

(string)

Constraints:

  • pattern: ^[0-9a-zA-Z./_ :,{}"-]{1,1024}$

Shorthand Syntax:

name=string,values=string,string ...

JSON Syntax:

[
  {
    "name": "string",
    "values": ["string", ...]
  }
  ...
]

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

  • min: 1
  • max: 25

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global OptionsÂķ

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

ExamplesÂķ

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To list image build versions

The following list-image-build-versions example lists all of the image build versions with a semantic version.

aws imagebuilder list-image-build-versions \
    --image-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03

Output:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "imageSummaryList": [
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/7",
            "name": "MyBasicRecipe",
            "version": "2019.12.03/7",
            "platform": "Windows",
            "state": {
                "status": "FAILED",
                "reason": "Can't start SSM Automation for arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/7 during building. Parameter \"iamInstanceProfileName\" has a null value."
            },
            "owner": "123456789012",
            "dateCreated": "2020-02-19T18:56:11.511Z",
            "outputResources": {
                "amis": []
            },
            "tags": {}
        },
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/6",
            "name": "MyBasicRecipe",
            "version": "2019.12.03/6",
            "platform": "Windows",
            "state": {
                "status": "FAILED",
                "reason": "An internal error has occurred."
            },
            "owner": "123456789012",
            "dateCreated": "2020-02-18T22:49:08.142Z",
            "outputResources": {
                "amis": [
                    {
                        "region": "us-west-2",
                        "image": "ami-a1b2c3d4567890ab",
                        "name": "MyBasicRecipe 2020-02-18T22-49-38.704Z",
                        "description": "This example image recipe creates a Windows 2016 image."
                    },
                    {
                        "region": "us-west-2",
                        "image": "ami-a1b2c3d4567890ab",
                        "name": "Name 2020-02-18T22-49-08.131Z",
                        "description": "Copies AMI to eu-west-2 and exports to S3"
                    },
                    {
                        "region": "eu-west-2",
                        "image": "ami-a1b2c3d4567890ab",
                        "name": "My 6 image 2020-02-18T22-49-08.131Z",
                        "description": "Copies AMI to eu-west-2 and exports to S3"
                    }
                ]
            },
            "tags": {}
        },
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/5",
            "name": "MyBasicRecipe",
            "version": "2019.12.03/5",
            "platform": "Windows",
            "state": {
                "status": "AVAILABLE"
            },
            "owner": "123456789012",
            "dateCreated": "2020-02-18T16:51:48.403Z",
            "outputResources": {
                "amis": [
                    {
                        "region": "us-west-2",
                        "image": "ami-a1b2c3d4567890ab",
                        "name": "MyBasicRecipe 2020-02-18T16-52-18.965Z",
                        "description": "This example image recipe creates a Windows 2016 image."
                    }
                ]
            },
            "tags": {}
        },
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/4",
            "name": "MyBasicRecipe",
            "version": "2019.12.03/4",
            "platform": "Windows",
            "state": {
                "status": "AVAILABLE"
            },
            "owner": "123456789012",
            "dateCreated": "2020-02-18T16:50:01.827Z",
            "outputResources": {
                "amis": [
                    {
                        "region": "us-west-2",
                        "image": "ami-a1b2c3d4567890ab",
                        "name": "MyBasicRecipe 2020-02-18T16-50-32.280Z",
                        "description": "This example image recipe creates a Windows 2016 image."
                    }
                ]
            },
            "tags": {}
        },
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/3",
            "name": "MyBasicRecipe",
            "version": "2019.12.03/3",
            "platform": "Windows",
            "state": {
                "status": "AVAILABLE"
            },
            "owner": "123456789012",
            "dateCreated": "2020-02-14T23:14:13.597Z",
            "outputResources": {
                "amis": [
                    {
                        "region": "us-west-2",
                        "image": "ami-a1b2c3d4567890ab",
                        "name": "MyBasicRecipe 2020-02-14T23-14-44.243Z",
                        "description": "This example image recipe creates a Windows 2016 image."
                    }
                ]
            },
            "tags": {}
        },
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/2",
            "name": "MyBasicRecipe",
            "version": "2019.12.03/2",
            "platform": "Windows",
            "state": {
                "status": "FAILED",
                "reason": "SSM execution 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111' failed with status = 'Failed' and failure message = 'Step fails when it is verifying the command has completed. Command a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 returns unexpected invocation result: \n{Status=[Failed], ResponseCode=[1], Output=[\n----------ERROR-------\nfailed to run commands: exit status 1], OutputPayload=[{\"Status\":\"Failed\",\"ResponseCode\":1,\"Output\":\"\\n----------ERROR-------\\nfailed to run commands: exit status 1\",\"CommandId\":\"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111\"}], CommandId=[a1b2c3d4-5678-90ab-cdef-EXAMPLE11111]}. Please refer to Automation Service Troubleshooting Guide for more diagnosis details.'"
            },
            "owner": "123456789012",
            "dateCreated": "2020-02-14T22:57:42.593Z",
            "outputResources": {
                "amis": []
            },
            "tags": {}
        }
    ]
}

For more information, see Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI in the EC2 Image Builder Users Guide.

OutputÂķ

requestId -> (string)

The request ID that uniquely identifies this request.

Constraints:

  • min: 1
  • max: 1024

imageSummaryList -> (list)

The list of image build versions.

(structure)

An image summary.

arn -> (string)

The Amazon Resource Name (ARN) of the image.

Constraints:

  • pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):(?: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]+)?)?$

name -> (string)

The name of the image.

Constraints:

  • pattern: ^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$

type -> (string)

Specifies whether this image produces an AMI or a container image.

Possible values:

  • AMI
  • DOCKER

version -> (string)

The version of the image.

Constraints:

  • min: 5
  • max: 64
  • pattern: ^[0-9]+\.[0-9]+\.[0-9]+(?:/[0-9]+)?$

platform -> (string)

The image operating system platform, such as Linux or Windows.

Possible values:

  • Windows
  • Linux
  • macOS

osVersion -> (string)

The operating system version of the instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

Constraints:

  • min: 1

state -> (structure)

The state of the image.

status -> (string)

The status of the image. A new image moves through build, test, and distribution statuses during creation, and ends in the AVAILABLE , FAILED , or CANCELLED state. The DEPRECATED , DISABLED , and DELETED statuses come from later resource management actions.

Possible values:

  • PENDING
  • CREATING
  • BUILDING
  • TESTING
  • DISTRIBUTING
  • INTEGRATING
  • AVAILABLE
  • CANCELLED
  • FAILED
  • DEPRECATED
  • DELETED
  • DISABLED

reason -> (string)

The reason for the status of the image.

Constraints:

  • min: 1
  • max: 1024

failureContext -> (structure)

The details about the failure, for images that failed to complete. Image Builder only sets this property when the image status is FAILED .

imageStatus -> (string)

The status that the image had when the failure occurred. This indicates the stage of the image creation process where the image failed, for example BUILDING or DISTRIBUTING .

Possible values:

  • PENDING
  • CREATING
  • BUILDING
  • TESTING
  • DISTRIBUTING
  • INTEGRATING
  • AVAILABLE
  • CANCELLED
  • FAILED
  • DEPRECATED
  • DELETED
  • DISABLED

workflowExecutionId -> (string)

The unique identifier of the workflow execution that was running when the image failed.

Constraints:

  • pattern: ^wf-[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}$

workflowArn -> (string)

The Amazon Resource Name (ARN) of the workflow build version that was running when the image failed.

Constraints:

  • max: 1024
  • pattern: ^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):workflow/(build|test|distribution)/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$

stepExecutionId -> (string)

The unique identifier of the workflow step execution that failed.

Constraints:

  • pattern: ^step-[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}$

failedStep -> (string)

The name of the workflow step that failed, as it appears in the workflow document.

Constraints:

  • pattern: ^[A-Za-z][A-Za-z0-9-_]{1,99}$

componentFailure -> (structure)

The details about the component that failed, if the failure occurred while a component was running.

componentArn -> (string)

The Amazon Resource Name (ARN) of the component build version that failed.

Constraints:

  • pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):component/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$

phaseName -> (string)

The name of the phase in the component document where the failure occurred, such as build , validate , or test .

Constraints:

  • min: 1
  • max: 1024

stepName -> (string)

The name of the step in the component document that failed.

Constraints:

  • min: 1
  • max: 1024

action -> (string)

The action that the failed step runs, for example ExecuteBash .

Constraints:

  • min: 1
  • max: 1024

errorMessage -> (string)

The error message from the step that failed. Image Builder truncates messages that are longer than 1024 characters. The component log in Amazon CloudWatch Logs contains the full output.

Constraints:

  • min: 1
  • max: 384000

distributionFailure -> (structure)

The details about the distribution failure, if the failure occurred while Image Builder distributed or configured the image.

errorMessage -> (string)

The error message for the distribution failure.

Constraints:

  • min: 1
  • max: 384000

regionFailures -> (list)

The details about the failure for each Region where the image didn’t finish distribution or configuration.

Constraints:

  • min: 1
  • max: 256

(structure)

Contains details about a distribution or image configuration failure for a single Region.

region -> (string)

The Region where the failure occurred.

Constraints:

  • min: 1
  • max: 1024

status -> (string)

The failure status for the Region. Indicates whether the process failed, was canceled, or timed out.

Possible values:

  • FAILED
  • CANCELLED
  • TIMED_OUT

imageConfigurationStep -> (string)

The image configuration step where the failure occurred. Image Builder sets this property when the failure happened during post-distribution configuration, such as launch template updates or virtual machine (VM) export. This property doesn’t appear for failures that occurred while Image Builder copied the image to the Region.

Possible values:

  • ASSOCIATE_LICENSES
  • UPDATE_LAUNCH_TEMPLATES
  • PUT_SSM_PARAMETERS
  • UPDATE_FAST_LAUNCH_CONFIGURATIONS
  • EXPORT_AMI

errorMessage -> (string)

The error message for the failure in the Region.

Constraints:

  • min: 1
  • max: 384000

targetAccountId -> (string)

The account ID of the account that the image was distributed to in the Region.

Constraints:

  • pattern: ^[0-9]{12}$

owner -> (string)

The owner of the image.

Constraints:

  • min: 1
  • max: 1024

dateCreated -> (string)

The date on which Image Builder created this image.

outputResources -> (structure)

The output resources that Image Builder produced when it created this image.

amis -> (list)

The Amazon EC2 AMIs created by this image. The list contains one entry per AMI, including copies that distribution created in each target Amazon Web Services Region and account.

(structure)

Details of an Amazon EC2 AMI.

region -> (string)

The Amazon Web Services Region of the Amazon EC2 AMI.

Constraints:

  • min: 1
  • max: 1024

image -> (string)

The AMI ID of the Amazon EC2 AMI.

Constraints:

  • min: 1
  • max: 1024

name -> (string)

The name of the Amazon EC2 AMI.

Constraints:

  • min: 1
  • max: 1024

description -> (string)

The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.

Constraints:

  • min: 1
  • max: 1024

state -> (structure)

The state of the AMI, which includes the status and, if applicable, the reason for that status.

status -> (string)

The status of the image. A new image moves through build, test, and distribution statuses during creation, and ends in the AVAILABLE , FAILED , or CANCELLED state. The DEPRECATED , DISABLED , and DELETED statuses come from later resource management actions.

Possible values:

  • PENDING
  • CREATING
  • BUILDING
  • TESTING
  • DISTRIBUTING
  • INTEGRATING
  • AVAILABLE
  • CANCELLED
  • FAILED
  • DEPRECATED
  • DELETED
  • DISABLED

reason -> (string)

The reason for the status of the image.

Constraints:

  • min: 1
  • max: 1024

failureContext -> (structure)

The details about the failure, for images that failed to complete. Image Builder only sets this property when the image status is FAILED .

imageStatus -> (string)

The status that the image had when the failure occurred. This indicates the stage of the image creation process where the image failed, for example BUILDING or DISTRIBUTING .

Possible values:

  • PENDING
  • CREATING
  • BUILDING
  • TESTING
  • DISTRIBUTING
  • INTEGRATING
  • AVAILABLE
  • CANCELLED
  • FAILED
  • DEPRECATED
  • DELETED
  • DISABLED

workflowExecutionId -> (string)

The unique identifier of the workflow execution that was running when the image failed.

Constraints:

  • pattern: ^wf-[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}$

workflowArn -> (string)

The Amazon Resource Name (ARN) of the workflow build version that was running when the image failed.

Constraints:

  • max: 1024
  • pattern: ^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):workflow/(build|test|distribution)/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$

stepExecutionId -> (string)

The unique identifier of the workflow step execution that failed.

Constraints:

  • pattern: ^step-[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}$

failedStep -> (string)

The name of the workflow step that failed, as it appears in the workflow document.

Constraints:

  • pattern: ^[A-Za-z][A-Za-z0-9-_]{1,99}$

componentFailure -> (structure)

The details about the component that failed, if the failure occurred while a component was running.

componentArn -> (string)

The Amazon Resource Name (ARN) of the component build version that failed.

Constraints:

  • pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):component/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$

phaseName -> (string)

The name of the phase in the component document where the failure occurred, such as build , validate , or test .

Constraints:

  • min: 1
  • max: 1024

stepName -> (string)

The name of the step in the component document that failed.

Constraints:

  • min: 1
  • max: 1024

action -> (string)

The action that the failed step runs, for example ExecuteBash .

Constraints:

  • min: 1
  • max: 1024

errorMessage -> (string)

The error message from the step that failed. Image Builder truncates messages that are longer than 1024 characters. The component log in Amazon CloudWatch Logs contains the full output.

Constraints:

  • min: 1
  • max: 384000

distributionFailure -> (structure)

The details about the distribution failure, if the failure occurred while Image Builder distributed or configured the image.

errorMessage -> (string)

The error message for the distribution failure.

Constraints:

  • min: 1
  • max: 384000

regionFailures -> (list)

The details about the failure for each Region where the image didn’t finish distribution or configuration.

Constraints:

  • min: 1
  • max: 256

(structure)

Contains details about a distribution or image configuration failure for a single Region.

region -> (string)

The Region where the failure occurred.

Constraints:

  • min: 1
  • max: 1024

status -> (string)

The failure status for the Region. Indicates whether the process failed, was canceled, or timed out.

Possible values:

  • FAILED
  • CANCELLED
  • TIMED_OUT

imageConfigurationStep -> (string)

The image configuration step where the failure occurred. Image Builder sets this property when the failure happened during post-distribution configuration, such as launch template updates or virtual machine (VM) export. This property doesn’t appear for failures that occurred while Image Builder copied the image to the Region.

Possible values:

  • ASSOCIATE_LICENSES
  • UPDATE_LAUNCH_TEMPLATES
  • PUT_SSM_PARAMETERS
  • UPDATE_FAST_LAUNCH_CONFIGURATIONS
  • EXPORT_AMI

errorMessage -> (string)

The error message for the failure in the Region.

Constraints:

  • min: 1
  • max: 384000

targetAccountId -> (string)

The account ID of the account that the image was distributed to in the Region.

Constraints:

  • pattern: ^[0-9]{12}$

accountId -> (string)

The account ID of the owner of the AMI.

Constraints:

  • min: 1
  • max: 1024

containers -> (list)

The container images that Image Builder created when it built this image, stored in the output Amazon ECR repository.

(structure)

Details of the container images that are output resources of an image build in a given Amazon Web Services Region: the Region, and the URIs of the container images.

region -> (string)

Containers and container images are Region-specific. This is the Region context for the container.

Constraints:

  • min: 1
  • max: 1024

imageUris -> (list)

A list of URIs for containers created in the context Region.

(string)

Constraints:

  • min: 1
  • max: 1024

tags -> (map)

The tags that apply to this image.

Constraints:

  • min: 1
  • max: 50

key -> (string)

Constraints:

  • min: 1
  • max: 128
  • pattern: ^(?!aws:)[a-zA-Z0-9\s_.:/=+\-@]*$

value -> (string)

Constraints:

  • max: 256

buildType -> (string)

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.
  • IMPORT_ISO – An ISO disk import created the image.

Possible values:

  • USER_INITIATED
  • SCHEDULED
  • IMPORT
  • IMPORT_ISO

imageSource -> (string)

The origin of the base image that Image Builder used to build this image.

Possible values:

  • AMAZON_MANAGED
  • AWS_MARKETPLACE
  • IMPORTED
  • CUSTOM

deprecationTime -> (timestamp)

The time when deprecation occurs for an image resource. This can be a past or future date.

lifecycleExecutionId -> (string)

Identifies the last runtime instance of the lifecycle policy to take action on the image.

Constraints:

  • 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}$

loggingConfiguration -> (structure)

The logging configuration that’s defined for the image.

logGroupName -> (string)

The log group name that Image Builder uses for image creation. If not specified, the log group name defaults to /aws/imagebuilder/image-name .

Constraints:

  • min: 1
  • max: 512
  • pattern: ^[a-zA-Z0-9\-_/\.]{1,512}$

nextToken -> (string)

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.

Constraints:

  • min: 1
  • max: 65535
© Copyright 2026, Amazon Web Services. Created using Sphinx.