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.

GetLifecyclePolicies

Gets summary information about all or the specified data lifecycle policies.

To get complete information about a policy, use GetLifecyclePolicy.

Request Syntax

GET /policies?policyIds=PolicyIds&resourceTypes=ResourceTypes&state=State&tagsToAdd=TagsToAdd&targetTags=TargetTags HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

PolicyIds

The identifiers of the data lifecycle policies.

ResourceTypes

The resource type.

Array Members: Fixed number of 1 item.

Valid Values: VOLUME | INSTANCE

State

The activation state.

Valid Values: ENABLED | DISABLED | ERROR

TagsToAdd

The tags to add to objects created by the policy.

Tags are strings in the format key=value.

These user-defined tags are added in addition to the AWS-added lifecycle tags.

Array Members: Minimum number of 0 items. Maximum number of 50 items.

TargetTags

The target tag for a policy.

Tags are strings in the format key=value.

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Policies": [ { "Description": "string", "PolicyId": "string", "State": "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.

Policies

Summary information about the lifecycle policies.

Type: Array of LifecyclePolicySummary objects

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: