Skip to content

Updates an OpenSearch Serverless collection

Description

Updates an OpenSearch Serverless collection.

Usage

opensearchserviceserverless_update_collection(id, description,
  vectorOptions, deletionProtection, clientToken)

Arguments

  • id

[required] The unique identifier of the collection.

  • description

A description of the collection.

  • vectorOptions

Configuration options for vector search capabilities in the collection.

  • deletionProtection

Indicates whether to enable or disable deletion protection for the collection. When set to ENABLED, the collection cannot be deleted.

  • clientToken

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

Value

A list with the following syntax:

list(
  updateCollectionDetail = list(
    id = "string",
    name = "string",
    status = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"FAILED"|"UPDATE_FAILED",
    type = "SEARCH"|"TIMESERIES"|"VECTORSEARCH",
    description = "string",
    vectorOptions = list(
      ServerlessVectorAcceleration = "ENABLED"|"DISABLED"|"ALLOWED"
    ),
    arn = "string",
    createdDate = 123,
    lastModifiedDate = 123,
    deletionProtection = "ENABLED"|"DISABLED"
  )
)

Request syntax

svc$update_collection(
  id = "string",
  description = "string",
  vectorOptions = list(
    ServerlessVectorAcceleration = "ENABLED"|"DISABLED"|"ALLOWED"
  ),
  deletionProtection = "ENABLED"|"DISABLED",
  clientToken = "string"
)