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 data access policy 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> (for search collection types only)

  • 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>/_analyz

  • 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

  • GET /_search/point_in_time/_all

  • HEAD <index>/_doc/<id>

  • HEAD <index>/_source/<id>

  • POST /_plugins/_sql

  • POST /_plugins/_ppl

  • POST /_plugins/_sql/_explain

  • POST /_plugins/_ppl/_explain

  • POST /_plugins/_ppl/_close

  • POST <index>/_analyze

  • POST /_search/point_in_time

  • 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

  • DELETE /_search/point_in_time/_all

  • DELETE /_search/point_in_time

 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

  • POST /_plugins/_flow_framework/workflow

  • * POST /_plugins/_flow_framework/workflow/<workflow_id>/_provision

  • PUT _ingest/pipeline/<pipeline-id>

  • PUT _search/pipeline/<pipeline-id>

  • Create index aliases, pipelines, and templates. For more information, see Create aliases.

  • * Provision or re-provision templates. The ML Commons Client and OpenSearch Serverless services manage dependent policies.

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>

  • GET _ingest/pipeline/<pipeline-id>

  • GET _ingest/pipeline/_simulate

  • GET /_plugins/_flow_framework/workflow/<workflow-id>

  • GET /_plugins/_flow_framework/workflow/_search

  • GET /_plugins/_flow_framework/workflow/<workflow-id>/_status

  • GET /_plugins/_flow_framework/workflow/state/_search

  • GET /_plugins/_flow_framework/workflow/_steps

  • GET /_plugins/_flow_framework/workflow/_step?workflow_step=<step_name>

  • GET _search/pipeline/<pipeline-id>

  • HEAD _alias/<alias>

  • HEAD _component_template/<component-template>

  • HEAD _index_template/<name>

  • HEAD <index>/_alias/<alias>

  • POST _ingest/pipeline/_simulate

  • POST /_plugins/_flow_framework/workflow/_search

  • POST /_plugins/_flow_framework/workflow/state/_search

Describes how to work with aliases, index and framework templates, and pipelines. 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>

  • * POST /_plugins/_flow_framework/workflow/<workflow_id>/_deprovision

  • PUT <index>/_alias/<alias>

  • PUT <index>/_aliases/<alias>

  • PUT _component_template/<component-template>

  • PUT _index_template/<index-template>

  • PUT /_plugins/_flow_framework/workflow/<workflow_id>

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

* The API to de-provision templates. The ML Commons Client and OpenSearch Serverless services manage dependent policies.

aoss:DeleteCollectionItems

  • DELETE <index>/_alias/<alias>

  • DELETE _component_template/<component-template>

  • DELETE _index_template/<index-template>

  • DELETE <index>/_aliases/<alias>

  • DELETE _search/pipeline/<pipeline-id>

  • DELETE _ingest/pipeline/<pipeline-id>

  • DELETE /_plugins/_flow_framework/workflow/<workflow_id>

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

aoss:DescribeMLResource

  • GET /_plugins/_ml/models/<model_id>

  • GET /_plugins_ml/models/_search

  • GET /_plugins/_ml/model_groups/<model_group_id>

  • GET /_plugins/_ml/model_groups/_search

  • GET /_plugins/_ml/connectors/<connector_id>

  • GET /_plugins/_ml/connectors/_search

  • GET /_plugins/_ml/profile/tasks/<task_id>

  • POST /_plugins/_ml/models/_search

  • POST /_plugins/_ml/model_groups/_search

  • POST /_plugins/_ml/connectors/_search

Describes GET and search APIs to retrieve information about models, and connectors.

aoss:CreateMLResource

  • POST /_plugins/_ml/models/_register

  • POST /_plugins/_ml/model_groups/_register

  • POST /_plugins/_ml/connectors/_create

Provides permission to create ML resources.

aoss:UpdateMLResource

  • PUT /_plugins/_ml/models/<model_id>

  • POST /_plugins/_ml/models/<model_id>/_deploy

  • POST /_plugins/_ml/models/<model_id>/_undeploy

  • PUT /_plugins/_ml/model_groups/<model_group_id>

  • PUT /_plugins/_ml/connectors/<connector_id>

Provides permission to update existing ML resources.

aoss:DeleteMLResource

  • DELETE /_plugins/_ml/models/<model_id>

  • DELETE _plugins/_ml/model_groups/<model_group_id>

  • DELETE /_plugins/_ml/connectors/<connector_id>

  • DELETE /_plugins/_ml/tasks/<task_id>

Provides permission to delete ML resources.

aoss:ExecuteMLResource

  • POST /_plugins/_ml/models/<model_id>/_predict

Provides permission to run models.

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.