Skip to content

Update Lifecycle Policy

opensearchserviceserverless_update_lifecycle_policy R Documentation

Updates an OpenSearch Serverless access policy

Description

Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.

Usage

opensearchserviceserverless_update_lifecycle_policy(clientToken,
  description, name, policy, policyVersion, type)

Arguments

clientToken

A unique, case-sensitive identifier to ensure idempotency of the request.

description

A description of the lifecycle policy.

name

[required] The name of the policy.

policy

The JSON policy document to use as the content for the lifecycle policy.

policyVersion

[required] The version of the policy being updated.

type

[required] The type of lifecycle policy.

Value

A list with the following syntax: 

list(
  lifecyclePolicyDetail = list(
    createdDate = 123,
    description = "string",
    lastModifiedDate = 123,
    name = "string",
    policy = list(),
    policyVersion = "string",
    type = "retention"
  )
)

Request syntax

svc$update_lifecycle_policy(
  clientToken = "string",
  description = "string",
  name = "string",
  policy = "string",
  policyVersion = "string",
  type = "retention"
)