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(id, clientToken)

Arguments¶

• 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.

• clientToken

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

Value¶

A list with the following syntax:

list(
  deleteCollectionDetail = list(
    id = "string",
    name = "string",
    status = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"FAILED"|"UPDATE_FAILED",
    deletionProtection = "ENABLED"|"DISABLED"
  )
)

Request syntax¶

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