Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateLifecyclePolicy

Create a lifecycle policy resource.

Request Syntax


PUT /CreateLifecyclePolicy HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "executionRole": "string",
   "name": "string",
   "policyDetails": [ 
      { 
         "action": { 
            "includeResources": { 
               "amis": boolean,
               "containers": boolean,
               "snapshots": boolean
            },
            "type": "string"
         },
         "exclusionRules": { 
            "amis": { 
               "isPublic": boolean,
               "lastLaunched": { 
                  "unit": "string",
                  "value": number
               },
               "regions": [ "string" ],
               "sharedAccounts": [ "string" ],
               "tagMap": { 
                  "string" : "string" 
               }
            },
            "tagMap": { 
               "string" : "string" 
            }
         },
         "filter": { 
            "retainAtLeast": number,
            "type": "string",
            "unit": "string",
            "value": number
         }
      }
   ],
   "resourceSelection": { 
      "recipes": [ 
         { 
            "name": "string",
            "semanticVersion": "string"
         }
      ],
      "tagMap": { 
         "string" : "string" 
      }
   },
   "resourceType": "string",
   "status": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Required: Yes

description

Optional description for the lifecycle policy.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

executionRole

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

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

Required: Yes

name

The name of the lifecycle policy to create.

Type: String

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

Required: Yes

policyDetails

Configuration details for the lifecycle policy rules.

Type: Array of LifecyclePolicyDetail objects

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Required: Yes

resourceSelection

Selection criteria for the resources that the lifecycle policy applies to.

Type: LifecyclePolicyResourceSelection object

Required: Yes

resourceType

The type of Image Builder resource that the lifecycle policy applies to.

Type: String

Valid Values: AMI_IMAGE | CONTAINER_IMAGE

Required: Yes

status

Indicates whether the lifecycle policy resource is enabled.

Type: String

Valid Values: DISABLED | ENABLED

Required: No

tags

Tags to apply to the lifecycle policy resource.

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

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "clientToken": "string",
   "lifecyclePolicyArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

clientToken

The client token that uniquely identifies the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

lifecyclePolicyArn

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

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws):lifecycle-policy/[a-z0-9-_]+$

Errors

For information about the errors that are common to all actions, see Common Errors.

CallRateLimitExceededException

You have exceeded the permitted request rate for the specific operation.

HTTP Status Code: 429

ClientException

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.

HTTP Status Code: 400

ForbiddenException

You are not authorized to perform the requested operation.

HTTP Status Code: 403

IdempotentParameterMismatchException

You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.

HTTP Status Code: 400

InvalidRequestException

You have requested an action that that the service doesn't support.

HTTP Status Code: 400

ResourceAlreadyExistsException

The resource that you are trying to create already exists.

HTTP Status Code: 400

ResourceInUseException

The resource that you are trying to operate on is currently in use. Review the message details and retry later.

HTTP Status Code: 400

ServiceException

This exception is thrown when the service encounters an unrecoverable exception.

HTTP Status Code: 500

ServiceQuotaExceededException

You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.

HTTP Status Code: 402

ServiceUnavailableException

The service is unable to process your request at this time.

HTTP Status Code: 503