Amazon Data Lifecycle Manager
API Reference (API Version 2018-01-12)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

UpdateLifecyclePolicy

Updates the specified lifecycle policy.

Request Syntax

PATCH /policies/policyId HTTP/1.1 Content-type: application/json { "Description": "string", "ExecutionRoleArn": "string", "PolicyDetails": { "Parameters": { "ExcludeBootVolume": boolean }, "PolicyType": "string", "ResourceTypes": [ "string" ], "Schedules": [ { "CopyTags": boolean, "CreateRule": { "Interval": number, "IntervalUnit": "string", "Times": [ "string" ] }, "Name": "string", "RetainRule": { "Count": number }, "TagsToAdd": [ { "Key": "string", "Value": "string" } ], "VariableTags": [ { "Key": "string", "Value": "string" } ] } ], "TargetTags": [ { "Key": "string", "Value": "string" } ] }, "State": "string" }

URI Request Parameters

The request requires the following URI parameters.

policyId

The identifier of the lifecycle policy.

Request Body

The request accepts the following data in JSON format.

Description

A description of the lifecycle policy.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

ExecutionRoleArn

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

Type: String

Required: No

PolicyDetails

The configuration of the lifecycle policy. You cannot update the policy type or the resource type.

Type: PolicyDetails object

Required: No

State

The desired activation state of the lifecycle policy after creation.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

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

Errors

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

InternalServerException

The service failed in an unexpected way.

HTTP Status Code: 500

InvalidRequestException

Bad request. The request is missing required parameters or has invalid parameters.

HTTP Status Code: 400

LimitExceededException

The request failed because a limit was exceeded.

HTTP Status Code: 429

ResourceNotFoundException

A requested resource was not found.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: