OpenSearchServiceServerless / Client / get_index

get_index

OpenSearchServiceServerless.Client.get_index(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_index(
    id='string',
    indexName='string'
)
Parameters:

  • id (string) –

    [REQUIRED]

    The unique identifier of the collection containing the index.

  • 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 definition for the index, including field mappings and settings.

Exceptions