AWS CLI Command Reference

[ aws . imagebuilder ]

create-lifecycle-policy

Description

Creates a lifecycle policy resource.

See also: AWS API Documentation

Synopsis

  create-lifecycle-policy
--name <value>
[--description <value>]
[--status <value>]
--execution-role <value>
--resource-type <value>
--policy-details <value>
--resource-selection <value>
[--tags <value>]
[--client-token <value>]
[--dry-run | --no-dry-run]
[--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

--name (string) [required]

The name of the lifecycle policy to create. Policy names must be unique to your account in each Amazon Web Services Region. Image Builder generates the policy ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. You can’t change the name after creation.

Constraints:

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

--description (string)

Optional description for the lifecycle policy.

Constraints:

  • min: 1
  • max: 1024

--status (string)

Indicates whether the lifecycle policy resource is enabled. If you don’t specify a status, it defaults to ENABLED . Only enabled policies run on their schedule.

Possible values:

  • DISABLED
  • ENABLED

--execution-role (string) [required]

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions. You must have permission to pass the role, and the role’s trust policy must allow the Image Builder service principal to assume it.

Constraints:

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

--resource-type (string) [required]

The type of Image Builder resource that the lifecycle policy applies to. The resource type determines the allowed rule actions: policies for AMI-based Image Builder images support DELETE , DEPRECATE , and DISABLE , and policies for container-based Image Builder images support only DELETE . You can’t change the resource type after creation.

Possible values:

  • AMI_IMAGE
  • CONTAINER_IMAGE

--policy-details (list) [required]

Configuration details for the lifecycle policy rules. A policy can contain at most one rule per action type: one DELETE , one DEPRECATE , and one DISABLE .

Constraints:

  • min: 1
  • max: 3

(structure)

Defines one lifecycle policy rule: the action to take, the filter that determines which resources the rule applies to, and optional exclusion rules.

action -> (structure) [required]

Configuration details for the policy action.

type -> (string) [required]

Specifies the lifecycle action to take. DELETE deletes the image resource and, with includeResources , also removes distributed AMIs, snapshots, or container images. DEPRECATE and DISABLE set the corresponding status on the image resource and, if includeResources.amis is set, on its distributed AMIs.

Possible values:

  • DELETE
  • DEPRECATE
  • DISABLE

includeResources -> (structure)

Specifies which underlying resources the action extends to beyond the Image Builder image resource itself: distributed AMIs, their snapshots, or distributed container images. DELETE rules can include all three, DEPRECATE and DISABLE rules can include AMIs only, and you can only include snapshots together with AMIs.

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.

filter -> (structure) [required]

Specifies the resources that the lifecycle policy applies to.

type -> (string) [required]

Filter resources based on either AGE or COUNT . You can only use the count filter with the DELETE action type.

Possible values:

  • AGE
  • COUNT

value -> (integer) [required]

The number of units for the time period or for the count. For example, a value of 6 might refer to six months or six AMIs.

Note

For count-based filters, this value represents the minimum number of resources to keep on hand. If you have fewer resources than this number, the resource is excluded from lifecycle actions.

Constraints:

  • min: 1
  • max: 1000

unit -> (string)

Defines the unit of time that the lifecycle policy uses to determine impacted resources. This is required for age-based rules.

Possible values:

  • DAYS
  • WEEKS
  • MONTHS
  • YEARS

retainAtLeast -> (integer)

For age-based filters, this is the number of resources to keep on hand after the lifecycle DELETE action is applied. Impacted resources are only deleted if you have more than this number of resources. If you have fewer resources than this number, the impacted resource is not deleted.

Constraints:

  • min: 1
  • max: 10

exclusionRules -> (structure)

Additional rules to specify resources that should be exempt from policy actions.

tagMap -> (map)

Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image resources that have them.

Constraints:

  • min: 1
  • max: 50

key -> (string)

Constraints:

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

value -> (string)

Constraints:

  • max: 256

amis -> (structure)

Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action.

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

JSON Syntax:

[
  {
    "action": {
      "type": "DELETE"|"DEPRECATE"|"DISABLE",
      "includeResources": {
        "amis": true|false,
        "snapshots": true|false,
        "containers": true|false
      }
    },
    "filter": {
      "type": "AGE"|"COUNT",
      "value": integer,
      "unit": "DAYS"|"WEEKS"|"MONTHS"|"YEARS",
      "retainAtLeast": integer
    },
    "exclusionRules": {
      "tagMap": {"string": "string"
        ...},
      "amis": {
        "isPublic": true|false,
        "regions": ["string", ...],
        "sharedAccounts": ["string", ...],
        "lastLaunched": {
          "value": integer,
          "unit": "DAYS"|"WEEKS"|"MONTHS"|"YEARS"
        },
        "tagMap": {"string": "string"
          ...}
      }
    }
  }
  ...
]

--resource-selection (structure) [required]

Selection criteria for the resources that the lifecycle policy applies to. You must specify exactly one selection criteria: either recipes or a tag map, not both.

recipes -> (list)

A list of recipes that are used as selection criteria for the output images that the lifecycle policy applies to.

Constraints:

  • min: 1
  • max: 50

(structure)

Specifies an Image Builder recipe that the lifecycle policy uses for resource selection.

name -> (string) [required]

The name of an Image Builder recipe that the lifecycle policy uses for resource selection.

Constraints:

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

semanticVersion -> (string) [required]

The version of the Image Builder recipe specified by the name field.

Constraints:

  • pattern: ^(?:[0-9]+|x)\.(?:[0-9]+|x)\.(?:[0-9]+|x)$

tagMap -> (map)

A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to.

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:

recipes=[{name=string,semanticVersion=string},{name=string,semanticVersion=string}],tagMap={KeyName1=string,KeyName2=string}

JSON Syntax:

{
  "recipes": [
    {
      "name": "string",
      "semanticVersion": "string"
    }
    ...
  ],
  "tagMap": {"string": "string"
    ...}
}

--tags (map)

Tags to apply to the lifecycle policy resource.

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:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

--dry-run | --no-dry-run (boolean)

Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

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

clientToken -> (string)

The client token that uniquely identifies the request.

Constraints:

  • min: 1
  • max: 64

lifecyclePolicyArn -> (string)

The Amazon Resource Name (ARN) of the lifecycle policy that the request created.

Constraints:

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