Skip to content

Delete Collection

opensearchserviceserverless_delete_collection R Documentation

Deletes an OpenSearch Serverless collection

Description

Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Usage

opensearchserviceserverless_delete_collection(clientToken, id)

Arguments

clientToken

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

id

[required] The unique identifier of the collection. For example, ⁠1iu5usc406kd⁠. The ID is part of the collection endpoint. You can also retrieve it using the list_collections API.

Value

A list with the following syntax: 

list(
  deleteCollectionDetail = list(
    id = "string",
    name = "string",
    status = "CREATING"|"DELETING"|"ACTIVE"|"FAILED"
  )
)

Request syntax

svc$delete_collection(
  clientToken = "string",
  id = "string"
)