OpenSearchService / Client / update_index

update_index

OpenSearchService.Client.update_index(**kwargs)

Updates an existing OpenSearch index schema and semantic enrichment configuration. This operation allows modification of field mappings and semantic search settings for text fields. Changes to semantic enrichment configuration will apply to newly ingested documents.

See also: AWS API Documentation

Request Syntax

response = client.update_index(
    DomainName='string',
    IndexName='string',
    IndexSchema={...}|[...]|123|123.4|'string'|True|None
)
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 update.

  • IndexSchema (document) –

    [REQUIRED]

    The updated JSON schema for the index including any changes to mappings, settings, and semantic enrichment configuration.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'CREATED'|'UPDATED'|'DELETED'
}

Response Structure

  • (dict) –

    • Status (string) –

      The status of the index update operation.

Exceptions