Create Collection

opensearchserviceserverless_create_collection

R Documentation

Creates a new OpenSearch Serverless collection

Description

Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Usage

opensearchserviceserverless_create_collection(name, type, description,
  tags, standbyReplicas, clientToken)

Arguments

name	[required] Name of the collection.
type	The type of collection.
description	Description of the collection.
tags	An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
standbyReplicas	Indicates whether standby replicas should be used for a collection.
clientToken	Unique, case-sensitive identifier to ensure idempotency of the request.

Value

A list with the following syntax:

list(
  createCollectionDetail = list(
    id = "string",
    name = "string",
    status = "CREATING"|"DELETING"|"ACTIVE"|"FAILED",
    type = "SEARCH"|"TIMESERIES"|"VECTORSEARCH",
    description = "string",
    arn = "string",
    kmsKeyArn = "string",
    standbyReplicas = "ENABLED"|"DISABLED",
    createdDate = 123,
    lastModifiedDate = 123
  )
)

Request syntax

svc$create_collection(
  name = "string",
  type = "SEARCH"|"TIMESERIES"|"VECTORSEARCH",
  description = "string",
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  standbyReplicas = "ENABLED"|"DISABLED",
  clientToken = "string"
)