Skip to content

Gets summary information about all or the specified data lifecycle policies

Description

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

To get complete information about a policy, use get_lifecycle_policy.

Usage

dlm_get_lifecycle_policies(PolicyIds, State, ResourceTypes, TargetTags,
  TagsToAdd, DefaultPolicyType)

Arguments

  • PolicyIds

The identifiers of the data lifecycle policies.

  • State

The activation state.

  • ResourceTypes

The resource type.

  • TargetTags

The target tag for a policy.

Tags are strings in the format key=value.

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

  • DefaultPolicyType

[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

Value

A list with the following syntax:

list(
  Policies = list(
    list(
      PolicyId = "string",
      Description = "string",
      State = "ENABLED"|"DISABLED"|"ERROR",
      Tags = list(
        "string"
      ),
      PolicyType = "EBS_SNAPSHOT_MANAGEMENT"|"IMAGE_MANAGEMENT"|"EVENT_BASED_POLICY",
      DefaultPolicy = TRUE|FALSE
    )
  )
)

Request syntax

svc$get_lifecycle_policies(
  PolicyIds = list(
    "string"
  ),
  State = "ENABLED"|"DISABLED"|"ERROR",
  ResourceTypes = list(
    "VOLUME"|"INSTANCE"
  ),
  TargetTags = list(
    "string"
  ),
  TagsToAdd = list(
    "string"
  ),
  DefaultPolicyType = "VOLUME"|"INSTANCE"|"ALL"
)