OpenSearchService / Client / get_index

get_index

OpenSearchService.Client.get_index(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_index(
    DomainName='string',
    IndexName='string'
)
Parameters:

  • DomainName (string) –

    [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 (string) –

    [REQUIRED]

    The name of the index to retrieve information about.

Return type:

dict

Returns:

Response Syntax

{
    'IndexSchema': {...}|[...]|123|123.4|'string'|True|None
}

Response Structure

  • (dict) –

    • IndexSchema (document) –

      The JSON schema of the index including mappings, settings, and semantic enrichment configuration.

Exceptions