Returns attributes for one or more collections, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints¶

Description¶

Returns attributes for one or more collections, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints. 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(
      id = "string",
      name = "string",
      status = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"FAILED"|"UPDATE_FAILED",
      type = "SEARCH"|"TIMESERIES"|"VECTORSEARCH",
      description = "string",
      arn = "string",
      kmsKeyArn = "string",
      standbyReplicas = "ENABLED"|"DISABLED",
      deletionProtection = "ENABLED"|"DISABLED",
      vectorOptions = list(
        ServerlessVectorAcceleration = "ENABLED"|"DISABLED"|"ALLOWED"
      ),
      createdDate = 123,
      lastModifiedDate = 123,
      collectionEndpoint = "string",
      dashboardEndpoint = "string",
      fipsEndpoints = list(
        collectionEndpoint = "string",
        dashboardEndpoint = "string"
      ),
      failureCode = "string",
      failureMessage = "string",
      collectionGroupName = "string"
    )
  ),
  collectionErrorDetails = list(
    list(
      id = "string",
      name = "string",
      errorMessage = "string",
      errorCode = "string"
    )
  )
)

Request syntax¶

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