Batch Get Collection

opensearchserviceserverless_batch_get_collection

R Documentation

Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint

Description

Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Usage

opensearchserviceserverless_batch_get_collection(ids, names)

Arguments

ids

A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the list_collections API.

names

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

Value

A list with the following syntax:

list(
  collectionDetails = list(
    list(
      arn = "string",
      collectionEndpoint = "string",
      createdDate = 123,
      dashboardEndpoint = "string",
      description = "string",
      failureCode = "string",
      failureMessage = "string",
      id = "string",
      kmsKeyArn = "string",
      lastModifiedDate = 123,
      name = "string",
      standbyReplicas = "ENABLED"|"DISABLED",
      status = "CREATING"|"DELETING"|"ACTIVE"|"FAILED",
      type = "SEARCH"|"TIMESERIES"|"VECTORSEARCH"
    )
  ),
  collectionErrorDetails = list(
    list(
      errorCode = "string",
      errorMessage = "string",
      id = "string",
      name = "string"
    )
  )
)

Request syntax

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