Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . dlm ]

get-lifecycle-policy

Description

Gets detailed information about the specified lifecycle policy.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-lifecycle-policy
--policy-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--policy-id (string)

The identifier of the lifecycle policy.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Policy -> (structure)

Detailed information about the lifecycle policy.

PolicyId -> (string)

The identifier of the lifecycle policy.

Description -> (string)

The description of the lifecycle policy.

State -> (string)

The activation state of the lifecycle policy.

ExecutionRoleArn -> (string)

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

DateCreated -> (timestamp)

The local date and time when the lifecycle policy was created.

DateModified -> (timestamp)

The local date and time when the lifecycle policy was last modified.

PolicyDetails -> (structure)

The configuration of the lifecycle policy

ResourceTypes -> (list)

The resource type.

(string)

TargetTags -> (list)

The target tags.

(structure)

Specifies a tag for a resource.

Key -> (string)

The tag key.

Value -> (string)

The tag value.

Schedules -> (list)

The schedule.

(structure)

Specifies a schedule.

Name -> (string)

The name of the schedule.

TagsToAdd -> (list)

The tags to add to policy-created resources. These tags are added in addition to the default lifecycle tags.

(structure)

Specifies a tag for a resource.

Key -> (string)

The tag key.

Value -> (string)

The tag value.

CreateRule -> (structure)

The create rule.

Interval -> (integer)

The interval. The supported values are 12 and 24.

IntervalUnit -> (string)

The interval unit.

Times -> (list)

The time, in UTC, to start the operation.

The operation occurs within a one-hour window following the specified time.

(string)

RetainRule -> (structure)

The retain rule.

Count -> (integer)

The number of snapshots to keep for each volume, up to a maximum of 1000.