UpdateIndex - Amazon OpenSearch Serverless

UpdateIndex

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.

Request Syntax

{ "id": "string", "indexName": "string", "indexSchema": JSON value }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

id

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

Type: String

Length Constraints: Minimum length of 3. Maximum length of 40.

Pattern: [a-z0-9]{3,40}

Required: Yes

indexName

The name of the index to update.

Type: String

Required: Yes

indexSchema

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

Type: JSON value

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

Thrown when an error internal to the service occurs while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

Thrown when accessing or deleting a resource that does not exist.

HTTP Status Code: 400

ValidationException

Thrown when the HTTP request contains invalid input or is missing required input.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: