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(type, resources,
  nextToken, maxResults)

Arguments

type	[required] The type of lifecycle policy.
resources	Resource filters that policies can apply to. Currently, the only supported resource type is index.
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.
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.

Value

A list with the following syntax:

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

Request syntax

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