List Lifecycle Policies

opensearchserviceserverless_list_lifecycle_policies

R Documentation

Returns a list of OpenSearch Serverless lifecycle policies¶

Description¶

Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

Usage¶

opensearchserviceserverless_list_lifecycle_policies(maxResults,
  nextToken, resources, type)

Arguments¶

maxResults: An optional parameter that specifies the maximum number of results to return. You can use use nextToken to get the next page of results. The default is 10.
nextToken: If your initial list_lifecycle_policies operation returns a nextToken, you can include the returned nextToken in subsequent list_lifecycle_policies operations, which returns results in the next page.
resources: Resource filters that policies can apply to. Currently, the only supported resource type is index.
type: [required] The type of lifecycle policy.

Value¶

A list with the following syntax:

list(
  lifecyclePolicySummaries = list(
    list(
      createdDate = 123,
      description = "string",
      lastModifiedDate = 123,
      name = "string",
      policyVersion = "string",
      type = "retention"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_lifecycle_policies(
  maxResults = 123,
  nextToken = "string",
  resources = list(
    "string"
  ),
  type = "retention"
)