Amazon OpenSearch Serverless でサポートされているオペレーションとプラグイン - Amazon OpenSearch Service
サポートされる OpenSearch API オペレーションとアクセス許可サポートされている OpenSearch プラグイン

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Amazon OpenSearch Serverless でサポートされているオペレーションとプラグイン

Amazon OpenSearch Serverless は、インデックス作成、検索、メタデータ API オペレーションのサブセットの他にも、OpenSearch での利用が可能な各種の OpenSearch プラグインをサポートしています。データアクセスポリシー内にある表で、左側の列にアクセス許可を含めることで、アクセス権限を特定のオペレーションに制限できます。

サポートされる OpenSearch API オペレーションとアクセス許可

次の表に、OpenSearch Serverless がサポートする API オペレーションと、それに対応するデータアクセスポリシー許可を一覧で示します。

データアクセスポリシーでの許可 OpenSearch API オペレーション 説明と注意事項

aoss:CreateIndex

 PUT <index>

インデックスを作成します。詳細については、「Create index」(インデックスの作成) を参照してください。

注記

このアクセス権限は、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>

インデックスの詳細を表示します。詳細については、以下のリソースを参照してください。

aoss:WriteDocument

  • DELETE <index>/_doc/<id>

  • POST <index>/_bulk

  • POST <index>/_create/<id> (検索コレクションタイプのみ)

  • POST <index>/_doc

  • POST <index>/_update/<id> (検索コレクションタイプのみ)

  • POST _bulk

  • PUT <index>/_create/<id> (検索コレクションタイプのみ)

  • PUT <index>/_doc/<id> (検索コレクションタイプのみ)

ドキュメントを作成および更新する。詳細については、以下のリソースを参照してください。

注記

一部の操作は、タイプ SEARCH のコレクションに対してのみ利用可能です。詳細については、「コレクションタイプを選択する」を参照してください。

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

 ドキュメントを読み取ります。詳細については、以下のリソースを参照してください。

aoss:DeleteIndex

 DELETE <target> インデックスを削除します。詳細については、「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

インデックス設定を更新します。詳細については、以下のリソースを参照してください。

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 aliases」(エイリアスを作成する) を参照してください。

  • * テンプレートをプロビジョニングまたは再プロビジョニングします。ML Commons Client および OpenSearch Serverless サービスは、依存ポリシーを管理します。

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

エイリアス、インデックスとフレームワークのテンプレート、パイプラインを操作する方法について説明します。詳細については、以下のリソースを参照してください。

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>

 エイリアス、インデックステンプレート、フレームワークテンプレートを更新します。詳細については、以下のリソースを参照してください。

* テンプレートのプロビジョニングを解除する API。ML Commons Client および OpenSearch Serverless サービスは、依存ポリシーを管理します。

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>

エイリアス、インデックスとフレームワークのテンプレート、パイプラインを削除します。詳細については、以下のリソースを参照してください。

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

モデルとコネクタに関する情報を取得するための GET および検索 APIs について説明します。

aoss:CreateMLResource

  • POST /_plugins/_ml/models/_register

  • POST /_plugins/_ml/model_groups/_register

  • POST /_plugins/_ml/connectors/_create

ML リソースを作成するアクセス許可を付与します。

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>

既存の ML リソースを更新するアクセス許可を付与します。

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>

ML リソースを削除するアクセス許可を付与します。

aoss:ExecuteMLResource

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

モデルを実行するアクセス許可を提供します。

サポートされている OpenSearch プラグイン

OpenSearch Serverless コレクションには、OpenSearch コミュニティから提供される以下のプラグインが、事前にパッケージされて提供されます。Serverless は、自動的にプラグインのデプロイと管理を実行します。

分析プラグイン

マッパープラグイン

スクリプトプラグイン

これらに加えて、OpenSearch Serverless には、モジュールとして出荷されるすべてのプラグインが含まれています。