Skip to content

Batch Get Effective Lifecycle Policy

opensearchserviceserverless_batch_get_effective_lifecycle_policy R Documentation

Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes

Description

Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.

Usage

opensearchserviceserverless_batch_get_effective_lifecycle_policy(
  resourceIdentifiers)

Arguments

resourceIdentifiers

[required] The unique identifiers of policy types and resource names.

Value

A list with the following syntax:

list(
  effectiveLifecyclePolicyDetails = list(
    list(
      noMinRetentionPeriod = TRUE|FALSE,
      policyName = "string",
      resource = "string",
      resourceType = "index",
      retentionPeriod = "string",
      type = "retention"
    )
  ),
  effectiveLifecyclePolicyErrorDetails = list(
    list(
      errorCode = "string",
      errorMessage = "string",
      resource = "string",
      type = "retention"
    )
  )
)

Request syntax

svc$batch_get_effective_lifecycle_policy(
  resourceIdentifiers = list(
    list(
      resource = "string",
      type = "retention"
    )
  )
)