Update Collection Group

opensearchserviceserverless_update_collection_group

R Documentation

Updates the description and capacity limits of a collection group

Description

Updates the description and capacity limits of a collection group.

Usage

opensearchserviceserverless_update_collection_group(id, description,
  capacityLimits, clientToken)

Arguments

id	[required] The unique identifier of the collection group to update.
description	A new description for the collection group.
capacityLimits	Updated capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
clientToken	Unique, case-sensitive identifier to ensure idempotency of the request.

Value

A list with the following syntax:

list(
  updateCollectionGroupDetail = list(
    id = "string",
    arn = "string",
    name = "string",
    description = "string",
    capacityLimits = list(
      maxIndexingCapacityInOCU = 123.0,
      maxSearchCapacityInOCU = 123.0,
      minIndexingCapacityInOCU = 123.0,
      minSearchCapacityInOCU = 123.0
    ),
    createdDate = 123,
    lastModifiedDate = 123
  )
)

Request syntax

svc$update_collection_group(
  id = "string",
  description = "string",
  capacityLimits = list(
    maxIndexingCapacityInOCU = 123.0,
    maxSearchCapacityInOCU = 123.0,
    minIndexingCapacityInOCU = 123.0,
    minSearchCapacityInOCU = 123.0
  ),
  clientToken = "string"
)