GetLifecyclePolicy - Amazon Data Lifecycle Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

GetLifecyclePolicy

Gets detailed information about the specified lifecycle policy.

Request Syntax

GET /policies/policyId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

policyId

The identifier of the lifecycle policy.

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

Pattern: policy-[a-f0-9]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Policy": { "DateCreated": "string", "DateModified": "string", "DefaultPolicy": boolean, "Description": "string", "ExecutionRoleArn": "string", "PolicyArn": "string", "PolicyDetails": { "Actions": [ { "CrossRegionCopy": [ { "EncryptionConfiguration": { "CmkArn": "string", "Encrypted": boolean }, "RetainRule": { "Interval": number, "IntervalUnit": "string" }, "Target": "string" } ], "Name": "string" } ], "CopyTags": boolean, "CreateInterval": number, "CrossRegionCopyTargets": [ { "TargetRegion": "string" } ], "EventSource": { "Parameters": { "DescriptionRegex": "string", "EventType": "string", "SnapshotOwner": [ "string" ] }, "Type": "string" }, "Exclusions": { "ExcludeBootVolumes": boolean, "ExcludeTags": [ { "Key": "string", "Value": "string" } ], "ExcludeVolumeTypes": [ "string" ] }, "ExtendDeletion": boolean, "Parameters": { "ExcludeBootVolume": boolean, "ExcludeDataVolumeTags": [ { "Key": "string", "Value": "string" } ], "NoReboot": boolean }, "PolicyLanguage": "string", "PolicyType": "string", "ResourceLocations": [ "string" ], "ResourceType": "string", "ResourceTypes": [ "string" ], "RetainInterval": number, "Schedules": [ { "ArchiveRule": { "RetainRule": { "RetentionArchiveTier": { "Count": number, "Interval": number, "IntervalUnit": "string" } } }, "CopyTags": boolean, "CreateRule": { "CronExpression": "string", "Interval": number, "IntervalUnit": "string", "Location": "string", "Scripts": [ { "ExecuteOperationOnScriptFailure": boolean, "ExecutionHandler": "string", "ExecutionHandlerService": "string", "ExecutionTimeout": number, "MaximumRetryCount": number, "Stages": [ "string" ] } ], "Times": [ "string" ] }, "CrossRegionCopyRules": [ { "CmkArn": "string", "CopyTags": boolean, "DeprecateRule": { "Interval": number, "IntervalUnit": "string" }, "Encrypted": boolean, "RetainRule": { "Interval": number, "IntervalUnit": "string" }, "Target": "string", "TargetRegion": "string" } ], "DeprecateRule": { "Count": number, "Interval": number, "IntervalUnit": "string" }, "FastRestoreRule": { "AvailabilityZones": [ "string" ], "Count": number, "Interval": number, "IntervalUnit": "string" }, "Name": "string", "RetainRule": { "Count": number, "Interval": number, "IntervalUnit": "string" }, "ShareRules": [ { "TargetAccounts": [ "string" ], "UnshareInterval": number, "UnshareIntervalUnit": "string" } ], "TagsToAdd": [ { "Key": "string", "Value": "string" } ], "VariableTags": [ { "Key": "string", "Value": "string" } ] } ], "TargetTags": [ { "Key": "string", "Value": "string" } ] }, "PolicyId": "string", "State": "string", "StatusMessage": "string", "Tags": { "string" : "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.

Policy

Detailed information about the lifecycle policy.

Type: LifecyclePolicy object

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

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 Amazon SDKs, see the following: