Get Index

opensearchserviceserverless_get_index

R Documentation

Retrieves information about an index in an OpenSearch Serverless collection, including its schema definition¶

Description¶

Retrieves information about an index in an OpenSearch Serverless collection, including its schema definition. The index might be configured to conduct automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment.

Usage¶

opensearchserviceserverless_get_index(id, indexName)

Arguments¶

id

[required] The unique identifier of the collection containing the index.

indexName

[required] The name of the index to retrieve information about.

Value¶

A list with the following syntax:

list(
  indexSchema = list()
)

Request syntax¶

svc$get_index(
  id = "string",
  indexName = "string"
)