[ aws . dlm ]

get-lifecycle-policies

Description

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

To get complete information about a policy, use GetLifecyclePolicy .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-lifecycle-policies
[--policy-ids <value>]
[--state <value>]
[--resource-types <value>]
[--target-tags <value>]
[--tags-to-add <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--policy-ids (list)

The identifiers of the data lifecycle policies.

(string)

Syntax:

"string" "string" ...

--state (string)

The activation state.

Possible values:

• ENABLED

• DISABLED

• ERROR

--resource-types (list)

The resource type.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  VOLUME
  INSTANCE

--target-tags (list)

The target tag for a policy.

Tags are strings in the format key=value .

(string)

Syntax:

"string" "string" ...

--tags-to-add (list)

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.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Examples

To get a summary of your lifecycle policies

The following get-lifecycle-policies example lists all of your lifecycle policies.

aws dlm get-lifecycle-policies

Output:

{
    "Policies": [
        {
            "PolicyId": "policy-0123456789abcdef0",
            "Description": "My first policy",
            "State": "ENABLED"
        }
    ]
}

Output

Policies -> (list)

Summary information about the lifecycle policies.

(structure)

Summary information about a 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.

Tags -> (map)

The tags.

key -> (string)

value -> (string)

PolicyType -> (string)

The type of policy. EBS_SNAPSHOT_MANAGEMENT indicates that the policy manages the lifecycle of Amazon EBS snapshots. IMAGE_MANAGEMENT indicates that the policy manages the lifecycle of EBS-backed AMIs.