List Collections

opensearchserviceserverless_list_collections

R Documentation

Lists all OpenSearch Serverless collections

Description

Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Make sure to include an empty request body {} if you don't include any collection filters in the request.

Usage

opensearchserviceserverless_list_collections(collectionFilters,
  maxResults, nextToken)

Arguments

collectionFilters

A list of filter names and values that you can use for requests.

maxResults

The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

nextToken

If your initial list_collections operation returns a nextToken, you can include the returned nextToken in subsequent list_collections operations, which returns results in the next page.

Value

A list with the following syntax:

list(
  collectionSummaries = list(
    list(
      arn = "string",
      id = "string",
      name = "string",
      status = "CREATING"|"DELETING"|"ACTIVE"|"FAILED"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_collections(
  collectionFilters = list(
    name = "string",
    status = "CREATING"|"DELETING"|"ACTIVE"|"FAILED"
  ),
  maxResults = 123,
  nextToken = "string"
)