Skip to content

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,
  nextToken, maxResults)

Arguments

  • collectionFilters

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

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

  • 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(
  collectionSummaries = list(
    list(
      id = "string",
      name = "string",
      status = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"FAILED"|"UPDATE_FAILED",
      arn = "string",
      kmsKeyArn = "string",
      collectionGroupName = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

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