List Collection Groups

opensearchserviceserverless_list_collection_groups

R Documentation

Returns a list of collection groups

Description

Returns a list of collection groups. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Usage

opensearchserviceserverless_list_collection_groups(nextToken,
  maxResults)

Arguments

nextToken	If your initial list_collection_groups operation returns a nextToken, you can include the returned nextToken in subsequent list_collection_groups operations, which returns results in the next page.
maxResults	The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

Value

A list with the following syntax:

list(
  collectionGroupSummaries = list(
    list(
      id = "string",
      arn = "string",
      name = "string",
      numberOfCollections = 123,
      createdDate = 123,
      capacityLimits = list(
        maxIndexingCapacityInOCU = 123.0,
        maxSearchCapacityInOCU = 123.0,
        minIndexingCapacityInOCU = 123.0,
        minSearchCapacityInOCU = 123.0
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_collection_groups(
  nextToken = "string",
  maxResults = 123
)