AWS CLI Command Reference

[ aws . imagebuilder ]

start-resource-state-updateÂķ

DescriptionÂķ

Begins an ad-hoc state change for the specified image build version. This is a one-time operation - if you schedule the update, it runs only once. If the request includes underlying resources, or schedules the update far enough in the future, Image Builder runs the update as an asynchronous lifecycle execution and returns its identifier. Otherwise, for target states other than DELETED , the state change applies immediately. If a request that starts a lifecycle execution arrives while the image already has one in progress, Image Builder rejects it.

See also: AWS API Documentation

SynopsisÂķ

  start-resource-state-update
--resource-arn <value>
--state <value>
[--execution-role <value>]
[--include-resources <value>]
[--exclusion-rules <value>]
[--update-at <value>]
[--client-token <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Âķ

--resource-arn (string) [required]

The Amazon Resource Name (ARN) of the image build version to update. The image must be in one of these terminal states: AVAILABLE , DEPRECATED , DISABLED , FAILED , or CANCELLED . Images with FAILED or CANCELLED status can transition only to DELETED .

Constraints:

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

--state (structure) [required]

Specifies the lifecycle action to take for this request. For AMI-based images, valid values are AVAILABLE , DEPRECATED , DISABLED , and DELETED . For container-based images, only DELETED is supported.

status -> (string)

The status to which you want to move the image resource. Set the status to AVAILABLE to restore an image that’s currently deprecated or disabled.

Possible values:

  • AVAILABLE
  • DELETED
  • DEPRECATED
  • DISABLED

Shorthand Syntax:

status=string

JSON Syntax:

{
  "status": "AVAILABLE"|"DELETED"|"DEPRECATED"|"DISABLED"
}

--execution-role (string)

The name or Amazon Resource Name (ARN) of the IAM role that’s used to update image state. You must provide this property together with includeResources . Neither is valid without the other.

Constraints:

  • min: 1
  • max: 2048
  • pattern: ^(?:arn:aws(?:-[a-z]+)*:iam::[0-9]{12}:role/)?[a-zA-Z_0-9+=,.@\-_/]+$

--include-resources (structure)

Specifies which underlying resources to update, in addition to the Image Builder image resource itself. Snapshots and containers are only valid for the DELETED state. To set an image to DELETED , you must include its underlying resources. To delete only the Image Builder image record, use the DeleteImage operation instead.

amis -> (boolean)

Specifies whether the lifecycle action should apply to distributed AMIs.

snapshots -> (boolean)

Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.

containers -> (boolean)

Specifies whether the lifecycle action should apply to distributed containers.

Shorthand Syntax:

amis=boolean,snapshots=boolean,containers=boolean

JSON Syntax:

{
  "amis": true|false,
  "snapshots": true|false,
  "containers": true|false
}

--exclusion-rules (structure)

Rules that Image Builder evaluates against each of the image’s AMIs. Matching AMIs and their snapshots are skipped. Exclusion rules only take effect when the request includes AMIs. If the target state is DELETED and any resource was skipped, the Image Builder image resource itself is also retained. For the DEPRECATED and DISABLED target states, Image Builder updates the image resource’s state regardless of exclusions.

amis -> (structure)

Defines criteria for AMIs that Image Builder should exclude from the resource state update.

isPublic -> (boolean)

Configures whether public AMIs are excluded from the lifecycle action.

regions -> (list)

Configures Amazon Web Services Regions that are excluded from the lifecycle action.

(string)

Constraints:

  • min: 1
  • max: 1024

sharedAccounts -> (list)

The lifecycle action doesn’t apply to AMIs that are shared with any of the specified Amazon Web Services accounts.

Constraints:

  • min: 1
  • max: 1536

(string)

Constraints:

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

lastLaunched -> (structure)

Configures Image Builder to exclude AMIs that were launched within the specified time period from lifecycle actions. AMIs with no recorded last-launched time aren’t excluded by this rule.

value -> (integer) [required]

The integer number of units for the time period. For example 6 (months).

Constraints:

  • min: 1
  • max: 365

unit -> (string) [required]

Defines the unit of time that the lifecycle policy uses to calculate elapsed time since the last launch.

Possible values:

  • DAYS
  • WEEKS
  • MONTHS
  • YEARS

tagMap -> (map)

Lifecycle actions don’t apply to AMIs that have any of these tags. Both the key and the value must match.

Constraints:

  • min: 1
  • max: 50

key -> (string)

Constraints:

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

value -> (string)

Constraints:

  • max: 256

Shorthand Syntax:

amis={isPublic=boolean,regions=[string,string],sharedAccounts=[string,string],lastLaunched={value=integer,unit=string},tagMap={KeyName1=string,KeyName2=string}}

JSON Syntax:

{
  "amis": {
    "isPublic": true|false,
    "regions": ["string", ...],
    "sharedAccounts": ["string", ...],
    "lastLaunched": {
      "value": integer,
      "unit": "DAYS"|"WEEKS"|"MONTHS"|"YEARS"
    },
    "tagMap": {"string": "string"
      ...}
  }
}

--update-at (timestamp)

The timestamp that indicates when resources are updated by a lifecycle action. This property is valid only when the target status is DEPRECATED , and the value must be a future time. If you don’t specify a value, Image Builder begins the state update right away. For a scheduled deprecation, included AMIs get their EC2 deprecation time set immediately, and Image Builder schedules the image resource to transition to DEPRECATED at that time.

--client-token (string)

A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference .

Constraints:

  • min: 1
  • max: 64

--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

OutputÂķ

lifecycleExecutionId -> (string)

Identifies the lifecycle execution that performs the resource state update. Image Builder only returns this field when it started a lifecycle execution for the update. Use it with GetLifecycleExecution to track progress.

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

resourceArn -> (string)

The requested Amazon Resource Name (ARN) of the Image Builder resource for the asynchronous update.

Constraints:

  • pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):image/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$
© Copyright 2026, Amazon Web Services. Created using Sphinx.