OpenSearch Service Serverless

Creates an index within an OpenSearch Serverless collection. Unlike other OpenSearch indexes, indexes created by this API are automatically configured to conduct automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment in the OpenSearch User Guide.

See also: AWS API Documentation

Request Syntax

client.create_index(
    id='string',
    indexName='string',
    indexSchema={...}|[...]|123|123.4|'string'|True|None
)

type id:

string

param id:

[REQUIRED]

The unique identifier of the collection in which to create the index.

type indexName:

string

param indexName:

[REQUIRED]

The name of the index to create. Index names must be lowercase and can't begin with underscores (_) or hyphens (-).

type indexSchema:

:ref:`document<document>`

param indexSchema:

The JSON schema definition for the index, including field mappings and settings.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Updates an existing index in an OpenSearch Serverless collection. This operation allows you to modify the index schema, including adding new fields or changing field mappings. You can also enable automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment.

See also: AWS API Documentation

Request Syntax

client.update_index(
    id='string',
    indexName='string',
    indexSchema={...}|[...]|123|123.4|'string'|True|None
)

type id:

string

param id:

[REQUIRED]

The unique identifier of the collection containing the index to update.

type indexName:

string

param indexName:

[REQUIRED]

The name of the index to update.

type indexSchema:

:ref:`document<document>`

param indexSchema:

The updated JSON schema definition for the index, including field mappings and settings.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

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

client.get_index(
    id='string',
    indexName='string'
)

type id:

string

param id:

[REQUIRED]

The unique identifier of the collection containing the index.

type indexName:

string

param indexName:

[REQUIRED]

The name of the index to retrieve information about.

rtype:

dict

returns:

Response Syntax

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

Response Structure

• (dict) --

  • indexSchema (:ref:`document<document>`) --

    The JSON schema definition for the index, including field mappings and settings.

Deletes an index from an OpenSearch Serverless collection. Be aware that 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

client.delete_index(
    id='string',
    indexName='string'
)

type id:

string

param id:

[REQUIRED]

The unique identifier of the collection containing the index to delete.

type indexName:

string

param indexName:

[REQUIRED]

The name of the index to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --