Update Collection

opensearchserviceserverless_update_collection

R Documentation

Updates an OpenSearch Serverless collection¶

Description¶

Updates an OpenSearch Serverless collection.

Usage¶

opensearchserviceserverless_update_collection(id, description,
  clientToken)

Arguments¶

id

[required] The unique identifier of the collection.

description

A description of the collection.

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"|"DELETING"|"ACTIVE"|"FAILED",
    type = "SEARCH"|"TIMESERIES"|"VECTORSEARCH",
    description = "string",
    arn = "string",
    createdDate = 123,
    lastModifiedDate = 123
  )
)

Request syntax¶

svc$update_collection(
  id = "string",
  description = "string",
  clientToken = "string"
)