Batch Get Collection Group

opensearchserviceserverless_batch_get_collection_group

R Documentation

Returns attributes for one or more collection groups, including capacity limits and the number of collections in each group

Description

Returns attributes for one or more collection groups, including capacity limits and the number of collections in each group. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Usage

opensearchserviceserverless_batch_get_collection_group(ids, names)

Arguments

ids	A list of collection group IDs. You can't provide names and IDs in the same request.
names	A list of collection group names. You can't provide names and IDs in the same request.

Value

A list with the following syntax:

list(
  collectionGroupDetails = list(
    list(
      id = "string",
      arn = "string",
      name = "string",
      standbyReplicas = "ENABLED"|"DISABLED",
      description = "string",
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      ),
      createdDate = 123,
      capacityLimits = list(
        maxIndexingCapacityInOCU = 123.0,
        maxSearchCapacityInOCU = 123.0,
        minIndexingCapacityInOCU = 123.0,
        minSearchCapacityInOCU = 123.0
      ),
      numberOfCollections = 123
    )
  ),
  collectionGroupErrorDetails = list(
    list(
      id = "string",
      name = "string",
      errorMessage = "string",
      errorCode = "string"
    )
  )
)

Request syntax

svc$batch_get_collection_group(
  ids = list(
    "string"
  ),
  names = list(
    "string"
  )
)