[ 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

Synopsis

  get-lifecycle-policies
[--policy-ids <value>]
[--state <value>]
[--resource-types <value>]
[--target-tags <value>]
[--tags-to-add <value>]
[--default-policy-type <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

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 Amazon Web Services-added lifecycle tags.

(string)

Syntax:

"string" "string" ...

--default-policy-type (string)

[Default policies only] Specifies the type of default policy to get. Specify one of the following:

• VOLUME - To get only the default policy for EBS snapshots
• INSTANCE - To get only the default policy for EBS-backed AMIs
• ALL - To get all default policies

Possible values:

• VOLUME
• INSTANCE
• ALL

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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. EVENT_BASED_POLICY indicates that the policy automates cross-account snapshot copies for snapshots that are shared with your account.

DefaultPolicy -> (boolean)

[Default policies only] The type of default policy. Values include:

• VOLUME - Default policy for EBS snapshots
• INSTANCE - Default policy for EBS-backed AMIs