Get Index

opensearchservice_get_index

R Documentation

Retrieves information about an OpenSearch index including its schema and semantic enrichment configuration¶

Description¶

Retrieves information about an OpenSearch index including its schema and semantic enrichment configuration. Use this operation to view the current index structure and semantic search settings.

Usage¶

opensearchservice_get_index(DomainName, IndexName)

Arguments¶

DomainName

[required] The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

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(
  DomainName = "string",
  IndexName = "string"
)