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

UpdateLifecyclePolicy

Update the specified lifecycle policy.

Request Syntax


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

{
   "clientToken": "string",
   "description": "string",
   "executionRole": "string",
   "lifecyclePolicyArn": "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"
}

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) of the IAM role that Image Builder uses to update the lifecycle policy.

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

lifecyclePolicyArn

The Amazon Resource Name (ARN) of the lifecycle policy resource.

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-_]+$

Required: Yes

policyDetails

The configuration details for a lifecycle policy resource.

Type: Array of LifecyclePolicyDetail objects

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

Required: Yes

resourceSelection

Selection criteria for resources that the lifecycle policy applies to.

Type: LifecyclePolicyResourceSelection object

Required: Yes

resourceType

The type of image 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

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "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.

lifecyclePolicyArn

The ARN of the image lifecycle policy resource that was updated.

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

InvalidParameterCombinationException

You have specified two or more mutually exclusive parameters. Review the error message for details.

HTTP Status Code: 400

InvalidRequestException

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

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

ServiceUnavailableException

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

HTTP Status Code: 503