Supported operations and plugins in Amazon OpenSearch Serverless - Amazon OpenSearch Service
Supported OpenSearch API operations and permissionsSupported OpenSearch plugins
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Supported operations and plugins in Amazon OpenSearch Serverless

Amazon OpenSearch Serverless supports a variety of OpenSearch plugins, as well as a subset of the indexing, search, and metadata API operations available in OpenSearch. You can include the permissions in the left column of the table within data access policies in order to limit access to certain operations.

Supported OpenSearch API operations and permissions

The following table lists the API operations that OpenSearch Serverless supports, along with their corresponding IAM permissions:

Data access policy permission OpenSearch API operations Description and caveats

aoss:CreateIndex

 PUT <index>

Create indexes. For more information, see Create index.

Note

This permission also applies to creating indexes with the sample data on OpenSearch Dashboards.

aoss:DescribeIndex

  • GET <index>

  • GET <index>/_mapping

  • GET <index>/_mappings

  • GET <index>/_setting

  • GET <index>/_setting/<setting>

  • GET <index>/_settings

  • GET <index>/_settings/<setting>

  • GET _cat/indices

  • GET _mapping

  • GET _mappings

  • GET _resolve/index/<index>

  • HEAD <index>

Describe indexes. For more information, see the following resources:

aoss:WriteDocument

  • DELETE <index>/_doc/<id>

  • POST <index>/_bulk

  • POST <index>/_create/<id> (for search collection types only)

  • POST <index>/_doc

  • POST <index>/_update/<id>

  • POST _bulk

  • PUT <index>/_create/<id> (for search collection types only)

  • PUT <index>/_doc/<id> (for search collection types only)

Write and update documents. For more information, see the following resources:

Note

Some operations are only allowed for collections of type SEARCH. For more information, see Choosing a collection type.

aoss:ReadDocument

  • GET <index>/_analyze

  • GET <index>/_doc/<id>

  • GET <index>/_explain/<id>

  • GET <index>/_mget

  • GET <index>/_source/<id>

  • GET <index>/_count

  • GET <index>/_field_caps

  • GET <index>/_msearch

  • GET <index>/_rank_eval

  • GET <index>/_search

  • GET <index>/_validate/<query>

  • GET _analyze

  • GET _field_caps

  • GET _mget

  • GET _search

  • HEAD <index>/_doc/<id>

  • HEAD <index>/_source/<id>

  • POST <index>/_analyze

  • POST <index>/_explain/<id>

  • POST <index>/_count

  • POST <index>/_field_caps

  • POST <index>/_rank_eval

  • POST <index>/_search

  • POST _analyze

  • POST _field_caps

  • POST _search

 Read documents. For more information, see the following resources:

aoss:DeleteIndex

 DELETE <target> Delete indexes. For more information, see Delete index.

aoss:UpdateIndex

  • POST _mapping

  • POST <index>/_mapping/

  • POST <index>/_mappings/

  • POST <index>/_setting

  • POST <index>/_settings

  • POST _setting

  • POST _settings

  • PUT _mapping

  • PUT <index>/_mapping

  • PUT <index>/_mappings/

  • PUT <index>/_setting

  • PUT <index>/_settings

  • PUT _setting

  • PUT _settings

Update index settings. For more information, see the following resources:

aoss:CreateCollectionItems

 POST _aliases Create index aliases. For more information, see Create aliases.

aoss:DescribeCollectionItems

  • GET <index>/_alias/<alias>

  • GET _alias

  • GET _alias/<alias>

  • GET _cat/aliases

  • GET _cat/templates

  • GET _cat/templates/<template_name>

  • GET _component_template

  • GET _component_template/<component-template>

  • GET _index_template

  • GET _index_template/<index-template>

  • HEAD _alias/<alias>

  • HEAD _component_template/<component-template>

  • HEAD _index_template/<name>

  • HEAD <index>/_alias/<alias>

Describe aliases and index templates. For more information, see the following resources:

aoss:UpdateCollectionItems

  • POST <index>/_alias/<alias>

  • POST <index>/_aliases/<alias>

  • POST _component_template/<component-template>

  • POST _index_template/<index-template>

  • PUT <index>/_alias/<alias>

  • PUT <index>/_aliases/<alias>

  • PUT _component_template/<component-template>

  • PUT _index_template/<index-template>

Update aliases and index templates. For more information, see the following resources:

aoss:DeleteCollectionItems

  • DELETE <index>/_alias/<alias>

  • DELETE _component_template/<component-template>

  • DELETE _index_template/<index-template>

  • DELETE <index>/_aliases/<alias>

Delete aliases and index templates. For more information, see the following resources:

Supported OpenSearch plugins

OpenSearch Serverless collections come prepackaged with the following plugins from the OpenSearch community. Serverless automatically deploys and manages plugins for you.

Analysis plugins

Mapper plugins

Scripting plugins

In addition, OpenSearch Serverless includes all plugins that ship as modules.