API の新バージョンと廃止されたアクション Actions データ型 Errors

Amazon OpenSearch Service 用の設定 API リファレンス

このリファレンスでは、Amazon OpenSearch サービス設定 API のアクション、データタイプ、エラーについて説明します。設定 API は、HTTP 経由で OpenSearch Service ドメインを作成および設定するのに使用できる REST API です。また、AWS CLIOpenSearch Service ドメインを設定します。詳細については、「Amazon OpenSearch サービスのドメインの作成と管理」を参照してください。

API の新バージョンと廃止されたアクション
アクション
データ型
エラー

API の新バージョンと廃止されたアクション

重要

以下のアクションは、Amazon OpenSearch Service API のバージョン 2021-01-01 で廃止され、より簡潔でエンジンに依存しないエンドポイントに置き換えられました。ただし、AWS CLIと設定APIは引き続きそれらを受け入れます。

非推奨のアクション	置換
`AcceptInboundCrossClusterSearchConnection`	`AcceptInboundConnection`
`CreateElasticsearchDomain`	`CreateDomain`
`CreateOutboundCrossClusterSearchConnection`	`CreateOutboundConnection`
`CreateElasticsearchServiceRole`	置き換えはありません。を使用するIAM APIサービスにリンクされたロールを作成するには
`DeleteElasticsearchDomain`	`DeleteDomain`
`DeleteElasticsearchServiceRole`	置き換えはありません。を使用するIAM APIサービスにリンクされたロールを削除するには
`DeleteInboundCrossClusterSearchConnection`	`DeleteInboundConnection`
`DescribeElasticsearchDomain`	`DescribeDomain`
`DescribeElasticsearchDomainConfig`	`DescribeDomainConfig`
`DescribeElasticsearchInstanceTypeLimits`	`DescribeInstanceTypeLimits`
`DescribeInboundCrossClusterSearchConnections`	`DescribeInboundConnections`
`DescribeOutboundCrossClusterSearchConnections`	`DescribeOutboundConnections`
`DescribeReservedElasticsearchInstanceOfferings`	`DescribeReservedInstanceOfferings`
`DescribeReservedElasticsearchInstances`	`DescribeReservedInstances`
`GetCompatibleElasticsearchVersions`	`GetCompatibleVersions`
`ListElasticsearchInstanceTypeDetails`	`ListInstanceTypeDetails`
`ListElasticsearchVersions`	`ListVersions`
`PurchaseReservedElasticsearchInstanceOffering`	`PurchaseReservedInstanceOffering`
`RejectInboundCrossClusterSearchConnection`	`RejectInboundConnection`
`StartElasticsearchServiceSoftwareUpdate`	`StartServiceSoftwareUpdate`
`StopElasticsearchServiceSoftwareUpdate`	`StopServiceSoftwareUpdate`
`UpdateElasticsearchDomainConfig`	`UpdateDomainConfig`
`UpgradeElasticsearchDomain`	`UpgradeDomain`

Actions

次の表では、Amazon OpenSearch Service 設定 API に対して REST インターフェイスが実行される各オペレーションに必要な、HTTP メソッドへのクイックリファレンスをご覧いただけます。各オペレーションの説明には、必要な HTTP メソッドも記載されています。

注記

すべての設定サービスリクエストに、必ず署名してください。詳細については、「」を参照してください。Amazon OpenSearch Service リクエストの署名このガイドの「」を参照してください。署名バージョン 4 の署名プロセスのAWS全般のリファレンス。

アクション	HTTP method
結合接続を受け入れる	`PUT`
AddTags	`POST`
AssociatePackage	`POST`
キャンセルサービスSoftwareアップデート	`POST`
CreateDomain	`POST`
アウトバウンド接続の作成	`POST`
CreatePackage	`POST`
DeleteDomain	`DELETE`
インバウンド接続の削除	`DELETE`
アウトバウンド接続の削除	`DELETE`
DeletePackage	`DELETE`
DescribeDomainAutoTunes	`GET`
DescribeDomain	`GET`
記述ドメイン設定	`GET`
DescribeDomains	`POST`
説明インスタンスタイプエリミット	`GET`
説明インバウンド接続	`POST`
説明アウトバウンド接続	`POST`
DescribePackages	`POST`
説明予約済みインスタンス・オファリング	`GET`
DescribeReservedInstances	`GET`
DissociatePackage	`POST`
互換バージョンの取得	`GET`
GetPackageVersionHistory	`GET`
GetUpgradeHistory	`GET`
GetUpgradeStatus	`GET`
ListDomainNames	`GET`
ListDomainsForPackage	`GET`
リストバージョン	`GET`
リストインスタンスタイプの詳細	`GET`
ListPackagesForDomain	`GET`
ListTags	`GET`
購入予約インスタンスオファリング	`POST`
バインド接続を拒否する	`PUT`
RemoveTags	`POST`
StartServiceSoftwareUpdate	`POST`
UpdateDomainConfig	`POST`
UpdatePackage	`POST`
アップグレードドメイン	`POST`

AcceptInboundConnection

ターゲットドメインの所有者に、インバウンドのクラスター間検索接続リクエストの受け入れを許可します。

Syntax


PUT https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/inboundConnection/connection-id/accept

パラメータのリクエスト

このオペレーションでは HTTP リクエストパラメータを使用しません。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`CrossClusterSearchConnection`	オブジェクト	インバウンド接続の詳細。

AddTags

OpenSearch Service ドメインにリソースタグを添付します。詳細については、「Amazon OpenSearch Service ドメインのタグ付け」を参照してください。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/tags
{
  "ARN": "domain-arn",
  "TagList": [{
    "Key": "tag-key",
    "Value": "tag-value"
  }]
}

パラメータのリクエスト

このオペレーションではリクエストパラメータを使用しません。

リクエストボディ

Parameter	データ型	必須?	説明
`TagList`	TagList	はい	リソースタグの一覧。
`ARN`	ARN	はい	リソースタグを添付する OpenSearch サービスドメインの Amazon リソースネーム（ARN）。

レスポンス要素

AddTags オペレーションはデータ構造を返しません。

AssociatePackage

OpenSearch Service ドメインにパッケージを関連付けます。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/packages/associate/package-id/domain-name

パラメータのリクエスト

Parameter	データ型	必須?	説明
`PackageID`	文字列	はい	ドメインに関連付けるパッケージの内部 ID。DescribePackages を使用して、この値を検索します。
`DomainName`	DomainName	はい	パッケージを関連付けるドメインの名前。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型
`DomainPackageDetails`	DomainPackageDetails

CreateDomain

OpenSearch サービスのドメインを作成します。詳細については、「 OpenSearch Service ドメインの作成」を参照してください。

注記

OpenSearch Service ドメインを作成する際に、同じ名前のドメインが既に存在しても、API からエラーは報告されません。その代わりに、既存ドメインの詳細が返されます。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain
{
  "ClusterConfig": {
    "ZoneAwarenessConfig": {
      "AvailabilityZoneCount": 3
    },
    "ZoneAwarenessEnabled": true|false,
    "InstanceCount": 3,
    "DedicatedMasterEnabled": true|false,
    "DedicatedMasterType": "c5.large.search",
    "DedicatedMasterCount": 3,
    "InstanceType": "r5.large.search",
    "WarmCount": 3,
    "WarmEnabled": true|false,
    "WarmType": "ultrawarm1.large.search",
    "ColdStorageOptions": {
       "Enabled": true|false
    },
  "EBSOptions": {
    "EBSEnabled": true|false,
    "VolumeType": "io1|gp2|standard",
    "Iops": 1000,
    "VolumeSize": 35
  },
  "EncryptionAtRestOptions": {
    "Enabled": true|false,
    "KmsKeyId":"arn:aws:kms:us-east-1:123456789012:alias/my-key"
  },
  "VPCOptions": {
    "VPCId": "vpc-12345678",
    "SubnetIds": ["subnet-abcdefg1", "subnet-abcdefg2", "subnet-abcdefg3"],
    "SecurityGroupIds": ["sg-12345678"]
  },
  "AdvancedOptions": {
    "rest.action.multi.allow_explicit_index": "true|false",
    "indices.fielddata.cache.size": "40",
    "indices.query.bool.max_clause_count": "1024",
    "override_main_response_version": "true|false"
  },
  "CognitoOptions": {
    "Enabled": true|false,
    "UserPoolId": "us-east-1_121234567",
    "IdentityPoolId": "us-east-1:12345678-1234-1234-1234-123456789012",
    "RoleArn": "arn:aws:iam::123456789012:role/service-role/CognitoAccessForAmazonOpenSearch"
  },
  "NodeToNodeEncryptionOptions": {
    "Enabled": true|false
  },
  "DomainEndpointOptions": {
    "EnforceHTTPS": true|false,
    "TLSSecurityPolicy": "Policy-Min-TLS-1-2-2019-07|Policy-Min-TLS-1-0-2019-07",
    "CustomEndpointEnabled": "true|false",
    "CustomEndpoint": "www.my-custom-endpoint.com",
    "CustomEndpointCertificateArn": "arn:aws:iam::123456789012:certificate/my-certificate"
  },
  "LogPublishingOptions": {
    "SEARCH_SLOW_LOGS": {
      "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group1:sample-domain",
      "Enabled":true|false
    },
    "INDEX_SLOW_LOGS": {
      "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group2:sample-domain",
      "Enabled":true|false
    },
    "ES_APPLICATION_LOGS": {
      "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group3:sample-domain",
      "Enabled":true|false
    }
  },
  "AdvancedSecurityOptions": {
    "Enabled": true|false,
    "InternalUserDatabaseEnabled": true|false,
    "MasterUserOptions": {
      "MasterUserARN": "arn:aws:iam::123456789012:role/my-master-user-role"
      "MasterUserName": "my-master-username",
      "MasterUserPassword": "my-master-password"
    }
  },
  "AutoTuneOptions": {
    "DesiredState": "ENABLED|DISABLED",
    "MaintenanceSchedules": [{
      "StartAt": 1234567890,
      "Duration": {
        "Value": 2,
        "Unit": "HOURS"
      },
      "CronExpressionForRecurrence": "cron(0 0 ? * 3 *)"
    }]
  },
  "TagList": [
    {
      "Key": "stack",
      "Value": "prod"
    }
  ],
  "EngineVersion": "OpenSearch_1.0",
  "DomainName": "my-domain",
  "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"123456789012\"]},\"Action\":[\"esListDomainNames:ESHttp*\"],\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/my-domain/*\"}]}"
}

パラメータのリクエスト

このオペレーションでは HTTP リクエストパラメータを使用しません。

リクエストボディ

Parameter	データ型	必須?	説明
`DomainName`	DomainName	はい	作成する OpenSearch Service ドメインの名前。
`EngineVersion`	文字列	いいえ	OpenSearchまたはElasticsearchのバージョン。Elasticsearch_X.YまたはOpenSearch_X.yのフォーマットである。デフォルトはOpenSearchの最新バージョンである。サポートされているバージョンの詳細なリストについては、「サポートされているバージョンのOpenSearchおよびElasticsear」を参照してください。
`ClusterConfig`	ClusterConfig	いいえ	OpenSearch サービスドメインのクラスター設定のコンテナ。
`EBSOptions`	EBSOptions	いいえ	OpenSearch サービスドメインの EBS ベースのストレージを有効にするために必要な、パラメータのコンテナ。
`VPCOptions`	VPCOptions	いいえ	VPC アクセスドメインを設定するために必要な値のコンテナ。これらの値を指定しない場合、OpenSearch Service はパブリックエンドポイントでドメインを作成します。詳細については、「VPC 内で Amazon OpenSearch サービスのドメインを起動する」を参照してください。
`CognitoOptions`	CognitoOptions	いいえ	OpenSearch ダッシュボードで Amazon Cognito 認証を使用するように OpenSearch サービスを設定するためのキーと値のペア。
`AccessPolicies`	文字列	いいえ	新しい OpenSearch サービスドメインのアクセスポリシーを指定する IAM ポリシードキュメント。詳細については、「Amazon OpenSearch Service での Identity and Access Management」を参照してください。
`SnapshotOptions`	SnapshotOptions	いいえ	DEPRECATED. ドメインインデックスの自動スナップショットを設定するために必要なパラメータのコンテナ。
`AdvancedOptions`	AdvancedOptions	いいえ	詳細な設定オプションを指定するためのキーと値のペア。詳細については、「高度なクラスターパラメータ」を参照してください。
`LogPublishingOptions`	LogPublishingOptions	いいえ	スローログの発行を設定するためのキーと値のペア。
`EncryptionAtRestOptions`	EncryptionAtRestOptions	いいえ	保管時に暗号化するためのキーと値のペア。
`NodeToNodeEncryptionOptions`	NodeToNodeEncryptionOptions	いいえ	ノード間の暗号化を有効にします。
`DomainEndpointOptions`	DomainEndpointOptions	いいえ	ドメインエンドポイントの追加オプション (すべてのトラフィックで HTTPS を必須にするかどうかなど)。
`AdvancedSecurityOptions`	AdvancedSecurityOptions	いいえ	きめ細かなアクセスコントロールのオプション。
`AutoTuneOptions`	AutoTuneOptions	いいえ	自動調整のオプション
`TagList`	TagList	いいえ	作成時にドメインに追加するタグのリスト。

レスポンス要素

フィールド	データ型
`DomainStatus`	DomainStatus

CreateOutboundConnection

ソースドメインからターゲットドメインへの新しいクラスター検索接続を作成します。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/outboundConnection
{
   "ConnectionAlias":"connection-name",
   "LocalDomainInfo":{
      "AWSDomainInformation":{
         "DomainName":"domain-name",
         "Region":"us-east-1"
      }
   },
   "RemoteDomainInfo":{
      "AWSDomainInformation":{
         "OwnerId":"account-id",
         "DomainName":"domain-name",
         "Region":"us-east-1"
      }
   }
}

パラメータのリクエスト

このオペレーションでは HTTP リクエストパラメータを使用しません。

リクエストボディ

Parameter	データ型	必須?	説明
`ConnectionAlias`	文字列	はい	コレクションの名前。
`LocalDomainInfo`	オブジェクト	はい	ソースドメインの名前とリージョン。
`RemoteDomainInfo`	オブジェクト	はい	ターゲットドメインの名前とリージョン。

レスポンス要素

フィールド	データ型	説明
`SourceDomainInfo`	オブジェクト	ソースドメインの名前とリージョン。
`DestinationDomainInfo`	オブジェクト	ターゲットドメインの名前とリージョン。
`ConnectionAlias`	文字列	コレクションの名前。
`ConnectionStatus`	文字列	接続のステータス。
`ConnectionId`	文字列	アウトバウンド接続の ID。

CreatePackage

OpenSearch Service ドメインで使用するパッケージを追加します。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/packages
{
  "PackageName": "my-package-name",
  "PackageType": "TXT-DICTIONARY",
  "PackageDescription": "My synonym file.",
  "PackageSource": {
    "S3BucketName": "my-s3-bucket",
    "S3Key": "synonyms.txt"
  }
}

パラメータのリクエスト

このオペレーションではリクエストパラメータを使用しません。

リクエストボディ

Parameter	データ型	必須?	説明
`PackageName`	文字列	はい	パッケージの一意の名前。
`PackageType`	文字列	はい	パッケージのタイプ。現在のところ、`TXT-DICTIONARY` のみサポートされます。
`PackageDescription`	文字列	いいえ	パッケージの説明。
`PackageSource`	PackageSource	はい	パッケージの S3 バケットとキー。

レスポンス要素

フィールド	データ型
`PackageDetails`	PackageDetails

ElasticsearchServiceRole (廃止)

OpenSearch サービスと Amazon EC2 間のサービスにリンクされたロールを作成します。このアクションは廃止されました。OpenSearch Service は、サービスリンクされたロールの作成と削除を自動的に処理します。

このロールは、VPC 内に VPC エンドポイントを配置する許可を OpenSearch サービスに付与します。サービスにリンクされたロールは、正常に機能するように VPC エンドポイントが作成されるドメインに配置する必要があります。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/role

パラメータのリクエスト

このオペレーションではリクエストパラメータを使用しません。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

CreateServiceRole オペレーションはデータ構造を返しません。

DeleteDomain

OpenSearch Service ドメインとそのデータを削除します。ドメインを削除した後で回復することはできません。

Syntax


DELETE https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name

パラメータのリクエスト

Parameter	データ型	必須?	説明
`DomainName`	DomainName	はい	削除する OpenSearch Service ドメインの名前。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型
`DomainStatus`	DomainStatus

DeleteElasticsearchServiceRole (廃止)

OpenSearch サービスと Amazon EC2 間のサービスにリンクされたロールを削除します。このアクションは廃止されました。OpenSearch サービスは、ロールの作成と削除を自動的に処理します。

注記

このアクションは、ドメインがサービスにリンクされたロールを使用していない場合のみ成功します。

Syntax


DELETE https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/role

パラメータのリクエスト

このオペレーションではリクエストパラメータを使用しません。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

DeleteElasticsearchServiceRole オペレーションはデータ構造を返しません。

DeleteInboundConnection

ターゲットドメインの所有者に、既存のインバウンドクラスター間検索接続の削除を許可します。

Syntax


DELETE https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/inboundConnection/connection-id

パラメータのリクエスト

このオペレーションでは HTTP リクエストパラメータを使用しません。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`CrossClusterSearchConnection`	オブジェクト	インバウンド接続の詳細。

DeleteOutboundConnection

ソースドメインの所有者に、既存のアウトバウンドクラスター間検索接続の削除を許可します。

Syntax


DELETE https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/outboundConnection/connection-id

パラメータのリクエスト

このオペレーションでは HTTP リクエストパラメータを使用しません。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`CrossClusterSearchConnection`	オブジェクト	アウトバウンド接続の詳細。

DeletePackage

OpenSearch Service からパッケージを削除します。パッケージを OpenSearch Service ドメインに関連付けることができません。

Syntax


DELETE https://es.us-east-1.amazonaws.com/2021-01-01/packages/package-id

パラメータのリクエスト

Parameter	データ型	必須?	説明
`PackageID`	文字列	はい	削除するパッケージの内部 ID。DescribePackages を使用して、この値を検索します。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型
`PackageDetails`	PackageDetails

DescribeDomainAutoTunes

Auto-Tune がドメインに対して行った最適化のリストを返します。

Syntax


GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name/autoTunes

パラメータのリクエスト

Parameter	データ型	必須?	説明
`DomainName`	DomainName	はい	自動調整の詳細を設定する OpenSearch サービスドメインの名前。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`AutoTunes`	リスト	最適化のリスト。
`NextToken`	文字列	ページ分割に使用されます。以前の API 呼び出しで `NextToken` を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を提供します。クライアントは、このトークンを使用してさらに結果を取得できます。

DescribeDomain

指定された OpenSearch Service ドメインについて、ドメイン ID、ドメインサービスエンドポイント、ドメイン ARN など、設定を説明します。

Syntax


GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name

パラメータのリクエスト

Parameter	データ型	必須?	説明
`DomainName`	DomainName	はい	説明する OpenSearch Service ドメインの名前。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型
`DomainStatus`	DomainStatus

DescribeDomainConfig

OpenSearch Service ドメインの構成を表示します。

Syntax


GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name/config

パラメータのリクエスト

Parameter	データ型	必須?	説明
`DomainName`	DomainName	はい	説明する OpenSearch サービスのドメイン設定の名前。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型
`DomainConfig`	DomainConfig

DescribeDomains

最大 5 つの指定された OpenSearch サービスドメインのドメイン設定を説明します。情報には、ドメイン ID、ドメインのサービスエンドポイント、ドメイン ARN が含まれます。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain-info
{
  "DomainNames": [
    "domain-name1",
    "domain-name2",
  ]
}

パラメータのリクエスト

このオペレーションでは HTTP リクエストパラメータを使用しません。

リクエストボディ

フィールド	データ型	必須?	説明
`DomainNames`	DomainNameList	はい	OpenSearch Service ドメイン名の配列。

レスポンス要素

フィールド	データ型
`DomainStatusList`	DomainStatusList

DescribeInstanceTypeLimits

特定の OpenSearch または Elasticsearch バージョンとインスタンスタイプのインスタンス数、ストレージ、およびマスターノードの制限について説明します。

Syntax


GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/instanceTypeLimits/engine-version/instance-type?domainName=domain-name

パラメータのリクエスト

Parameter	データ型	必須?	説明
`EngineVersion`	文字列	はい	OpenSearchまたはElasticsearchのバージョン。Elasticsearch_X.YまたはOpenSearch_X.yのフォーマットである。デフォルトはOpenSearchの最新バージョンである。サポートされているバージョンの詳細なリストについては、サポートされているバージョンのOpenSearchおよびElasticsear. バージョン. サポートされているバージョンのリストについては、「サポートされているバージョンのOpenSearchおよびElasticsear」を参照してください。
`InstanceType`	文字列	はい	インスタンスタイプ。リージョン別のインスタンスタイプを表示するには、Amazon OpenSearch Service。
`DomainName`	DomainName	いいえ	既存のドメインの名前。既存のドメインの制限が必要な場合にのみ指定します。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`LimitsByRole`	マップ	該当するすべてのインスタンスタイプの制限を含むマップです。`"data"` はデータノードを指します。`"master"` は専用マスターノードを指します。

DescribeInboundConnections

ターゲットドメインのすべてのインバウンドクラスター間検索接続を一覧表示します。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/inboundConnection/search
{
  "Filters": [
    {
      "Name": filter-name (str),
      "Values" : [val1, val2, ..] (list of strings)
    },
    ....
    "MaxResults": int (Optional, default value - 100), 
    "NextToken": "next-token-string (optional)"
  ]
}

パラメータのリクエスト

このオペレーションでは HTTP リクエストパラメータを使用しません。

リクエストボディ

Parameter	データ型	必須?	説明
`Filters`	オブジェクト	いいえ	describe リクエストに使用できるフィルター名と値のリスト。サポートされるフィールドは、`connection-id`、`local-domain-info.domain-name`、`local-domain-info.owner-id`、`local-domain-info.region`、および `remote-domain-info.domain-name` です。
`MaxResults`	整数	いいえ	結果の数を制限します。デフォルトは 100 です。
`NextToken`	文字列	いいえ	ページ分割に使用されます。以前の API 呼び出しで `NextToken` を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を提供します。クライアントは、このトークンを使用してさらに結果を取得できます。

レスポンス要素

フィールド	データ型	説明
`CrossClusterSearchConnections`	オブジェクト	インバウンド接続のリスト。
`NextToken`	文字列	ページ分割に使用されます。以前の API 呼び出しで `NextToken` を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を提供します。クライアントは、このトークンを使用してさらに結果を取得できます。

DescribeOutboundConnections

ソースドメインのすべてのアウトバウンドクラスター間検索接続を一覧表示します。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/outboundConnection/search
{
  "Filters": [
    {
      "Name": filter-name (str),
      "Values" : [val1, val2, ..] (list of strings)
    },
    ....
    "MaxResults": int (Optional, default value - 100), 
    "NextToken": "next-token-string (optional)"
  ]
}

パラメータのリクエスト

このオペレーションでは HTTP リクエストパラメータを使用しません。

リクエストボディ

Parameter	データ型	必須?	説明
`Filters`	オブジェクト	いいえ	describe リクエストに使用できるフィルター名と値のリスト。サポートされるフィールドは、`connection-id`、`remote-domain-info.domain-name`、`remote-domain-info.owner-id`、`remote-domain-info.region`、および `local-domain-info.domain-name` です。
`MaxResults`	整数	いいえ	結果の数を制限します。デフォルトは 100 です。
`NextToken`	文字列	いいえ	ページ分割に使用されます。以前の API 呼び出しで `NextToken` を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を提供します。クライアントは、このトークンを使用してさらに結果を取得できます。

レスポンス要素

フィールド	データ型	説明
`CrossClusterSearchConnections`	オブジェクト	アウトバウンド接続のリスト。
`NextToken`	文字列	ページ分割に使用されます。以前の API 呼び出しで `NextToken` を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を提供します。クライアントは、このトークンを使用してさらに結果を取得できます。

DescribePackages

OpenSearch Service で使用可能なすべてのパッケージについて説明します。フィルタリング、結果数の制限、ページ分割のオプションが含まれます。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/packages/describe
{
  "Filters": [{
    "Name": "PackageStatus",
    "Value": [
      "DELETING", "AVAILABLE"
    ]
  }],
  "MaxResults": 5,
  "NextToken": "next-token",
}

パラメータのリクエスト

このオペレーションではリクエストパラメータを使用しません。

リクエストボディ

Parameter	データ型	必須?	説明
`Filters`	Filters	いいえ	指定された値に一致するパッケージのみを返します。
`MaxResults`	整数	いいえ	結果をパッケージの最大数に制限します。
`NextToken`	文字列	いいえ	ページ分割に使用されます。以前の API コールに null 以外の `NextToken` 値が含まれている場合にのみ必要です。指定されている場合は、次のページの結果を返します。

レスポンス要素

フィールド	データ型	説明
`PackageDetailsList`	リスト	PackageDetails オブジェクトのリスト

DescribeReservedInstanceOfferings

指定されたリージョンで利用できるリザーブドインスタンスの提供タイプについて説明します。

Syntax


GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/reservedInstanceOfferings?offeringId=offering-id&maxResults=max-results&nextToken=next-token

パラメータのリクエスト

Parameter	データ型	必須?	説明
`OfferingId`	文字列	いいえ	提供 ID。
`MaxResults`	整数	いいえ	結果の数を制限します。30～100 を指定する必要があります。
`NextToken`	文字列	いいえ	ページ分割に使用されます。以前の API 呼び出しで `NextToken` を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を提供します。クライアントは、このトークンを使用してさらに結果を取得できます。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`ReservedInstanceOfferings`	予約インスタンス・オファリング	リザーブドインスタンスの提供タイプに関するすべての情報のコンテナ。詳細については、「リザーブドインスタンスを購入する (AWSCLI)」を参照してください。

DescribeReservedInstances

指定されたリージョンで予約しているインスタンスについて説明します。

Syntax


GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/reservedInstances?reservationId=reservation-id&maxResults=max-results&nextToken=next-token

パラメータのリクエスト

Parameter	データ型	必須?	説明
`ReservationId`	文字列	いいえ	予約 ID。予約を購入した後に割り当てられます。
`MaxResults`	整数	いいえ	結果の数を制限します。30～100 を指定する必要があります。
`NextToken`	文字列	いいえ	ページ分割に使用されます。以前の API 呼び出しで `NextToken` を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を提供します。クライアントは、このトークンを使用してさらに結果を取得できます。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`ReservedInstances`	ReservedInstance	予約したインスタンスに関するすべての情報のコンテナ。詳細については、「リザーブドインスタンスを購入する (AWSCLI)」を参照してください。

DissociatePackage

指定された OpenSearch Service ドメインからパッケージを削除します。関連付け解除を成功させるためには、パッケージを OpenSearch インデックスとともに使用することはできません。このパッケージは、後で関連付けのために OpenSearch サービスで引き続き利用可能です。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/packages/dissociate/package-id/domain-name

パラメータのリクエスト

Parameter	データ型	必須?	説明
`PackageID`	文字列	はい	ドメインとの関連付けを解除するパッケージの内部 ID。ListPackagesForDomain を使用して、この値を検索します。
`DomainName`	DomainName	はい	パッケージの関連付けを解除するドメインの名前。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型
`DomainPackageDetails`	DomainPackageDetails

GetCompatibleVersions

OpenSearch または Elasticsearch バージョンのマップ、およびアップグレード可能なバージョンを返します。

Syntax


GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/compatibleVersions?domainName=domain-name

パラメータのリクエスト

Parameter	データ型	必須?	説明
`DomainName`	DomainName	いいえ	既存のドメインの名前。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`CompatibleVersions`	マップ	OpenSearch または Elasticsearch バージョンのマップ、およびアップグレード可能なバージョン。 `{ "CompatibleVersions": [{ "SourceVersion": "Elasticsearch_7.10", "TargetVersions": ["OpenSearch_1.0"] }] }`

GetPackageVersionHistory

OpenSearch バージョンのマップ、およびアップグレード可能なバージョンを返します。

Syntax


GET https://es.us-east-1.amazonaws.com/2021-01-01/packages/package-id/history?maxResults=max-results&amp;nextToken=next-token

パラメータのリクエスト

Parameter	データ型	必須?	説明
`PackageID`	文字列	はい	既存のドメインの名前。
`MaxResults`	整数	いいえ	結果の数を制限します。30～100 を指定する必要があります。
`NextToken`	文字列	いいえ	ページ分割に使用されます。以前の API 呼び出しで `NextToken` を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を提供します。クライアントは、このトークンを使用してさらに結果を取得できます。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`PackageVersionHistoryList`	マップ	指定されたパッケージのコミットメッセージ、更新tmies、およびバージョンのリスト： `"PackageVersionHistoryList": [ { CommitMessage": "Add new synonyms", "CreatedAt": 1.605225005466E9, "PackageVersion": "v4" } ]`

GetUpgradeHistory

ドメインの最新の 10 個のアップグレードオペレーションのリストを返します。

Syntax


GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/upgradeDomain/domain-name/history?maxResults=max-results&amp;nextToken=next-token

パラメータのリクエスト

Parameter	データ型	必須?	説明
`MaxResults`	整数	いいえ	結果の数を制限します。30～100 を指定する必要があります。
`DomainName`	DomainName	はい	既存のドメインの名前。
`NextToken`	文字列	いいえ	ページ分割に使用されます。以前の API 呼び出しで `NextToken` を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を提供します。クライアントは、このトークンを使用してさらに結果を取得できます。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`UpgradeHistoryList`	UpgradeHistoryList	過去 10 のアップグレードオペレーションの結果のログのコンテナ。

GetUpgradeStatus

ドメインの OpenSearch または Elasticsearch バージョンの最新のステータスを返します。

Syntax


GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/upgradeDomain/domain-name/status

パラメータのリクエスト

Parameter	データ型	必須?	説明
`DomainName`	DomainName	はい	既存のドメインの名前。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`UpgradeStepItem`	UpgradeStepItem	ドメインのバージョンアップグレードの最新のステータスのコンテナ。

ListDomainNames

現在のユーザーが所有するすべての OpenSearch サービスドメインの名前を表示しますアクティブなリージョンで。

Syntax


GET https://es.us-east-1.amazonaws.com/2021-01-01/domain

パラメータのリクエスト

フィールド	データ型	必須?	説明
`EngineType`	文字列	いいえ	出力をドメインエンジンタイプ別にフィルタリングします。許容値は次のとおりです。`Elasticsearch`および`OpenSearch`。

このオペレーションではリクエストパラメータを使用しません。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`DomainNameList`	DomainNameList	現在のユーザーが所有するすべての OpenSearch サービスドメインの名前。

ListDomainsForPackage

パッケージが関連付けられているすべての OpenSearch サービスドメインを一覧表示します。

Syntax


GET https://es.us-east-1.amazonaws.com/2021-01-01/packages/package-id/domains?maxResults=max-results&amp;nextToken=next-token

パラメータのリクエスト

Parameter	データ型	必須?	説明
`PackageID`	文字列	はい	ドメインを一覧表示するパッケージ。
`MaxResults`	整数	いいえ	結果の数を制限します。
`NextToken`	文字列	いいえ	ページ分割に使用されます。以前の API 呼び出しで `NextToken` を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を提供します。クライアントは、このトークンを使用してさらに結果を取得できます。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`DomainPackageDetailsList`	リスト	DomainPackageDetails オブジェクトのリスト
`NextToken`	文字列	ページ分割に使用されます。以前の API 呼び出しで `NextToken` を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を提供します。クライアントは、このトークンを使用してさらに結果を取得できます。

ListVersions

OpenSearch サービスでサポートされるすべての OpenSearch バージョンとElasticsearch

Syntax


GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/versions?maxResults=max-results&nextToken=next-token

パラメータのリクエスト

Parameter	データ型	必須?	説明
`MaxResults`	整数	いいえ	結果の数を制限します。30～100 を指定する必要があります。
`NextToken`	文字列	いいえ	ページ分割に使用されます。以前の API 呼び出しで `NextToken` を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を提供します。クライアントは、このトークンを使用してさらに結果を取得できます。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

ListInstanceTypeDetails

特定の OpenSearch バージョンまたは Elasticsearch バージョンのすべてのインスタンスタイプと使用可能な機能を一覧表示します。

Syntax


GET https://es.us-east-1.amazonaws.com/2021-01-01/instanceTypeDetails/engine-version?domainName=domain-name?maxResults=max-results&nextToken=next-token

パラメータのリクエスト

Parameter	データ型	必須?	説明
`EngineVersion`	文字列	はい	OpenSearchまたはElasticsearchのバージョン。Elasticsearch_X.YまたはOpenSearch_X.yのフォーマットである。デフォルトはOpenSearchの最新バージョンである。サポートされているバージョンの詳細なリストについては、「サポートされているバージョンのOpenSearchおよびElasticsear」を参照してください。
`DomainName`	DomainName	はい	インスタンスタイプの詳細を一覧表示するドメインの名前。
`MaxResults`	整数	いいえ	結果の数を制限します。30～100 を指定する必要があります。
`NextToken`	文字列	いいえ	ページ分割に使用されます。以前の API 呼び出しで `NextToken` を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を提供します。クライアントは、このトークンを使用してさらに結果を取得できます。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`InstanceTypeDetails`	リスト	指定された OpenSearch または Elasticsearch バージョンでサポートされているすべてのインスタンスタイプと機能をリストします。
`NextToken`	文字列	ページ分割に使用されます。以前の API 呼び出しで `NextToken` を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を提供します。クライアントは、このトークンを使用してさらに結果を取得できます。

ListPackagesForDomain

OpenSearch Service ドメインに関連付けられているすべてのパッケージを一覧表示します。

Syntax


GET https://es.us-east-1.amazonaws.com/2021-01-01/domain/domain-name/packages?maxResults=max-results&amp;nextToken=next-token

パラメータのリクエスト

Parameter	データ型	必須?	説明
`DomainName`	文字列	はい	関連するパッケージを一覧表示するドメインの名前。
`MaxResults`	整数	いいえ	結果の数を制限します。
`NextToken`	文字列	いいえ	ページ分割に使用されます。以前の API 呼び出しで `NextToken` を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を提供します。クライアントは、このトークンを使用してさらに結果を取得できます。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`DomainPackageDetailsList`	`List`	DomainPackageDetails オブジェクトのリスト
`NextToken`	`String`	ページ分割に使用されます。以前の API 呼び出しで `NextToken` を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を提供します。クライアントは、このトークンを使用してさらに結果を取得できます。

OpenSearch Service ドメインのすべてのリソースタグを表示します。

Syntax


GET https://es.us-east-1.amazonaws.com/2021-01-01/tags?arn=domain-arn

パラメータのリクエスト

Parameter	データ型	必須?	説明
`ARN`	ARN	はい	OpenSearch Service ドメインの Amazon リソースネーム (ARN)。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`TagList`	TagList	リソースタグの一覧。詳細については、「Amazon OpenSearch Service ドメインのタグ付け」を参照してください。

PurchaseReservedInstanceOffering

リザーブドインスタンスを購入します。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/purchaseReservedInstanceOffering
{
  "ReservationName" : "my-reservation",
  "ReservedInstanceOfferingId" : "1a2a3a4a5-1a2a-3a4a-5a6a-1a2a3a4a5a6a",
  "InstanceCount" : 3
}

パラメータのリクエスト

このオペレーションでは HTTP リクエストパラメータを使用しません。

リクエストボディ

名前	データ型	必須?	説明
`ReservationName`	文字列	はい	予約のわかりやすい名前。5 ～ 64 文字にする必要があります。
`ReservedInstanceOfferingId`	文字列	はい	提供 ID。
`InstanceCount`	整数	はい	予約する必要があるインスタンスの数。

レスポンス要素

フィールド	データ型	説明
`ReservationName`	文字列	予約の名前。
`ReservedInstanceId`	文字列	予約 ID。

RejectInboundConnection

ターゲットドメインの所有者に、インバウンドのクラスター間検索接続リクエストの拒否を許可します。

Syntax


PUT https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/inboundConnection/connection-id/reject

パラメータのリクエスト

このオペレーションでは HTTP リクエストパラメータを使用しません。

リクエストボディ

このオペレーションでは HTTP リクエストボディを使用しません。

レスポンス要素

フィールド	データ型	説明
`CrossClusterSearchConnection`	オブジェクト	インバウンド接続の詳細。

RemoveTags

OpenSearch サービスドメインから指定したリソースタグを削除します。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/tags-removal
{
  "ARN": "arn:aws:es:us-east-1:123456789012:domain/my-domain",
  "TagKeys": [
    "tag-key1",
    "tag-key2"
  ]
}

パラメータのリクエスト

このオペレーションでは HTTP リクエストパラメータを使用しません。

リクエストボディ

Parameter	データ型	必須?	説明
`ARN`	ARN	はい	OpenSearch Service ドメインの Amazon リソースネーム (ARN)。詳細については、「」を参照してください。IAM IDのAWS Identity and Access Managementユーザーガイド。
`TagKeys`	TagKey	はい	OpenSearch サービスドメインから削除するリソースタグのタグキーのリスト。

レスポンス要素

RemoveTags オペレーションでは、レスポンス要素は返しません。

StartServiceSoftwareUpdate

OpenSearch Service ドメインのサービスソフトウェア更新をスケジュール設定します。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/serviceSoftwareUpdate/start
{
  "DomainName": "domain-name"
}

パラメータのリクエスト

このオペレーションでは HTTP リクエストパラメータを使用しません。

リクエストボディ

Parameter	データ型	必須?	説明
`DomainName`	DomainName	はい	最新のサービスソフトウェアに更新する OpenSearch サービスドメインの名前。

レスポンス要素

フィールド	データ型	説明
`ServiceSoftwareOptions`	`ServiceSoftwareOptions`	最新のサービスソフトウェアに対するドメインの状態を表すコンテナ。

CancelServiceSoftwareUpdate

OpenSearch サービスドメインのスケジュール設定されたサービスソフトウェア更新を停止します。ドメインの UpdateStatus が PENDING_UPDATE の場合にのみ機能します。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/serviceSoftwareUpdate/stop
{
  "DomainName": "domain-name"
}

パラメータのリクエスト

このオペレーションでは HTTP リクエストパラメータを使用しません。

リクエストボディ

Parameter	データ型	必須?	説明
`DomainName`	DomainName	はい	最新のサービスソフトウェアに更新する OpenSearch サービスドメインの名前。

レスポンス要素

フィールド	データ型	説明
`ServiceSoftwareOptions`	ServiceSoftwareOptions	最新のサービスソフトウェアに対するドメインの状態を表すコンテナ。

UpdateDomainConfig

インスタンスタイプやインスタンス数など、OpenSearch Service ドメインの設定を変更します。更新する値の指定のみ必要です。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name/config
{
  "ClusterConfig": {
    "ZoneAwarenessConfig": {
      "AvailabilityZoneCount": 3
    },
    "ZoneAwarenessEnabled": true|false,
    "InstanceCount": 3,
    "DedicatedMasterEnabled": true|false,
    "DedicatedMasterType": "c5.large.search",
    "DedicatedMasterCount": 3,
    "InstanceType": "r5.large.search",
    "WarmCount": 6,
    "WarmType": "ultrawarm1.medium.search",
    "ColdStorageOptions": {
       "Enabled": true|false
    },
  "EBSOptions": {
    "EBSEnabled": true|false,
    "VolumeType": "io1|gp2|standard",
    "Iops": 1000,
    "VolumeSize": 35
  },
  "SnapshotOptions": {
    "AutomatedSnapshotStartHour": 3
  },
  "EncryptionAtRestOptions": {
    "Enabled": true|false,
    "KmsKeyId":"arn:aws:kms:us-east-1:123456789012:alias/my-key"
  },
  "NodeToNodeEncryptionOptions": {
    "Enabled": true|false
  },
  "VPCOptions": {
    "SubnetIds": ["subnet-abcdefg1", "subnet-abcdefg2", "subnet-abcdefg3"],
    "SecurityGroupIds": ["sg-12345678"]
  },
  "AdvancedOptions": {
    "rest.action.multi.allow_explicit_index": "true|false",
    "indices.fielddata.cache.size": "40",
    "indices.query.bool.max_clause_count": "1024",
    "override_main_response_version": "true|false"
  },
  "CognitoOptions": {
    "Enabled": true|false,
    "UserPoolId": "us-east-1_121234567",
    "IdentityPoolId": "us-east-1:12345678-1234-1234-1234-123456789012",
    "RoleArn": "arn:aws:iam::123456789012:role/service-role/CognitoAccessForAmazonOpenSearch"
  },
  "DomainEndpointOptions": {
    "EnforceHTTPS": true|false,
    "TLSSecurityPolicy": "Policy-Min-TLS-1-2-2019-07|Policy-Min-TLS-1-0-2019-07",
    "CustomEndpointEnabled": "true|false",
    "CustomEndpoint": "www.my-custom-endpoint.com",
    "CustomEndpointCertificateArn": "arn:aws:iam::123456789012:certificate/my-certificate"
  },
  "LogPublishingOptions": {
    "SEARCH_SLOW_LOGS": {
      "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group1:sample-domain",
      "Enabled":true|false
    },
    "INDEX_SLOW_LOGS": {
      "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group2:sample-domain",
      "Enabled":true|false
    },
    "ES_APPLICATION_LOGS": {
      "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group3:sample-domain",
      "Enabled":true|false
    }
  },
  "AdvancedSecurityOptions": {
    "Enabled": true|false,
    "InternalUserDatabaseEnabled": true|false,
    "MasterUserOptions": {
      "MasterUserARN": "arn:aws:iam::123456789012:role/my-master-user-role"
      "MasterUserName": "my-master-username",
      "MasterUserPassword": "my-master-password"
    },
    "SAMLOptions": {
      "Enabled": true,
      "Idp": {
        "EntityId": "entity-id",
        "MetadataContent": "metadata-content-with-quotes-escaped"
      },
      "RolesKey": "optional-roles-key",
      "SessionTimeoutMinutes": 180,
      "SubjectKey": "optional-subject-key"
    }
  },
  "AutoTuneOptions": {
    "DesiredState": "ENABLED|DISABLED",
    "MaintenanceSchedules": [{
      "StartAt": 1234567890,
      "Duration": {
        "Value": 2,
        "Unit": "HOURS"
      },
      "CronExpressionForRecurrence": "cron(0 0 ? * 3 *)"
    }],
    "RollbackOnDisable": "NO_ROLLBACK|DEFAULT_ROLLBACK"
  },
  "DomainName": "my-domain",
  "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"*\"]},\"Action\":[\"es:*\"],\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/my-domain/*\"}]}"
}

パラメータのリクエスト

このオペレーションでは HTTP リクエストパラメータを使用しません。

リクエストボディ

Parameter	データ型	必須?	説明
`DomainName`	DomainName	はい	設定を更新する OpenSearch サービスドメインの名前。
`ClusterConfig`	ClusterConfig	いいえ	EC2 インスタンスのインスタンスタイプや数など、クラスター設定に対して行う変更。
`EBSOptions`	EBSOptions	いいえ	データノードにアタッチされた EBS ボリュームのサイズ。
`VPCOptions`	VPCOptions	いいえ	VPC で動作するように OpenSearch サービスを設定するために必要な値のコンテナ。詳細については、「VPC 内で Amazon OpenSearch サービスのドメインを起動する」を参照してください。
`SnapshotOptions`	SnapshotOptions	いいえ	DEPRECATED. OpenSearch サービスドメインでサービスがインデックスの自動スナップショットを毎日作成する時間。
`AdvancedOptions`	AdvancedOptions	いいえ	詳細な設定オプションを指定するためのキーと値のペア。詳細については、「高度なクラスターパラメータ」を参照してください。
`AccessPolicies`	文字列	いいえ	OpenSearch Service ドメインのアクセスポリシーを指定します。詳細については、「アクセスポリシーの設定」を参照してください。
`LogPublishingOptions`	LogPublishingOptions	いいえ	スローログの発行を設定するためのキーと値の文字列のペア。
`CognitoOptions`	CognitoOptions	いいえ	OpenSearch ダッシュボードで Amazon Cognito 認証を使用するように OpenSearch サービスを設定するためのキーと値のペア。
`DomainEndpointOptions`	DomainEndpointOptions	いいえ	ドメインエンドポイントの追加オプション (すべてのトラフィックで HTTPS を必須にするかどうかなど)。
`AdvancedSecurityOptions`	AdvancedSecurityOptions	いいえ	きめ細かなアクセスコントロールのオプション。
`AutoTuneOptions`	AutoTuneOptions	いいえ	自動調整のオプション
`NodeToNodeEncryptionOptions`	NodeToNodeEncryptionOptions	いいえ	ノード間の暗号化を有効にします。
`EncryptionAtRestOptions`	EncryptionAtRestOptions	いいえ	保管時に暗号化するためのキーと値のペア。

レスポンス要素

フィールド	データ型
`DomainConfig`	DomainConfig

UpdatePackage

OpenSearch Service ドメインで使用するパッケージを更新します。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/packages/update
{
  "PackageID": "F11111111",
  "PackageDescription": "My synonym file.",
  "CommitMessage": "Added some synonyms.",
  "PackageSource": {
    "S3BucketName": "my-s3-bucket",
    "S3Key": "synonyms.txt"
  }
}

パラメータのリクエスト

このオペレーションではリクエストパラメータを使用しません。

リクエストボディ

Parameter	データ型	必須?	説明
`PackageID`	文字列	はい	パッケージの一意の ID。
`PackageDescription`	文字列	いいえ	パッケージの説明。
`CommitMessage`	文字列	いいえ	更新されたファイルのコミットメッセージ。
`PackageSource`	PackageSource	はい	パッケージの S3 バケットとキー。

レスポンス要素

フィールド	データ型
`PackageDetails`	PackageDetails

UpgradeDomain

OpenSearch サービスドメインを OpenSearch または Elasticsearch の新しいバージョンにアップグレードします。または、アップグレードの適格性を確認します。

Syntax


POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/upgradeDomain
{
  "DomainName": "domain-name",
  "TargetVersion": "OpenSearch_1.0",
  "PerformCheckOnly": true|false
}

パラメータのリクエスト

このオペレーションでは HTTP リクエストパラメータを使用しません。

リクエストボディ

Parameter	データ型	必須?	説明
`DomainName`	文字列	はい	アップグレードする OpenSearch Service ドメインの名前。
`TargetVersion`	文字列	はい	アップグレードする OpenSearch または Elasticsearch のバージョンを、OpenSearch_X.Y または Elasticsearch_X.Y の形式で指定します。GetCompatibleVersions。
`PerformCheckOnly`	ブール値	いいえ	デフォルトは `false` です。もし`true`OpenSearch Service はドメインの適格性を確認しますが、アップグレードは実行しません。
`AdvancedOptions`	AdvancedOptions	いいえ	のみが`override_main_response_version`パラメーターであり、その他の詳細オプションではありません。このオプションは、OpenSearch バージョンへのアップグレード時にのみ含めることができます。ドメインがそのバージョンを 7.10 と報告し、Elasticsearch OSS クライアントおよびプラグインで引き続き動作するようにするかどうかを指定します。

レスポンス要素

フィールド	データ型	説明
`UpgradeDomainResponse`	マップ	オペレーションの詳細を確認する基本レスポンス。

データ型

このセクションでは、設定 APIで使用されるデータタイプについて説明します。

AdvancedOptions

OpenSearch の詳細設定オプションを指定するキーと値のペア。

フィールド	データ型	説明
`rest.action.multi.allow_explicit_index`	キーと値のペア: `"rest.action.multi.allow_explicit_index":"true"`	ブール値ではなく文字列の使用に注意してください。HTTP リクエストボディ中で、インデックスへの明示参照を許可するかどうかを指定します。特定のインデックスやドメイン API など、ドメインのサブリソースのアクセスポリシーを設定する場合、このプロパティを無効にする必要があります。サブリソースのためのアクセスポリシーの詳細については、」アクセスポリシーの設定。
`indices.fielddata.cache.size`	キーと値のペア: `"indices.fielddata.cache.size":"80"`	整数ではなく文字列の使用に注意してください。フィールドデータに割り当てられる Java ヒープスペースの割合を指定します。デフォルトでは、この設定は unbounded です。
`indices.query.bool.max_clause_count`	キーと値のペア: `"indices.query.bool.max_clause_count":"1024"`	整数ではなく文字列の使用に注意してください。Lucene のブールクエリで許可される句の最大数を指定します。デフォルトは 1,024 です。クエリに含まれる句の数が最大数を超えていると、`TooManyClauses` エラーが発生します。詳細については、Lucene のドキュメントを参照してください。
`override_main_response_version`	キーと値のペア: `"override_main_response_version":"true"`	ブール値ではなく文字列の使用に注意してください。ドメインがそのバージョンを 7.10 と報告し、Elasticsearch OSS クライアントとプラグインがそのバージョンを継続できるようにするかどうかを指定します。OpenSearch ドメインを作成する場合や、Elasticsearch OSS バージョンから OpenSearch にアップグレードする場合のみ関連します。デフォルトは`false`ドメインの作成時に`true`ドメインをアップグレードするときに使用します。

AdvancedSecurityOptions

フィールド	データ型	説明
`Enabled`	ブール値	きめ細かなアクセスコントロールを有効にするには True。
`InternalUserDatabaseEnabled`	ブール値	内部ユーザーデータベースを有効にするには true。
`MasterUserOptions`	MasterUserOptions	マスターユーザーに関する情報のコンテナ。
`SAMLOptions`	Samloptions	OpenSearch ダッシュボードの SAML 設定に関する情報のためのコンテナ。

ARN

フィールド	データ型	説明
`ARN`	文字列	OpenSearch Service ドメインの Amazon リソースネーム (ARN)。詳細については、「」を参照してください。IAM ARNのAWS Identity and Access Managementユーザーガイド。

AutoTuneOptions

フィールドデータ型説明

DesiredState 文字列 ENABLED または DISABLED です。

MaintenanceSchedules

リスト

Auto-Tuneが変更をデプロイできるメンテナンススケジュールのリスト：


{
  "StartAt": 1234567890,
  "Duration": {
    "Value": 2,
    "Unit": "HOURS"
  },
  "CronExpressionForRecurrence": "cron(* * ? * * *)"
}

メンテナンススケジュールは上書きされ、追加されません。リクエストにスケジュールが含まれていない場合、リクエストは既存のスケジュールをすべて削除します。既存のスケジュールを保持するには、DescribeDomainConfigを最初に使用し、MaintenanceSchedules部分を、このセクションのベースとして使用します。

StartAtはエポック時間、Valueは長整数です。

RollbackOnDisable

文字列

自動調整を無効にする場合は、NO_ROLLBACKを使用して以前のすべての自動調整設定を保持するか、DEFAULT_ROLLBACKをクリックすると、OpenSearch サービスのデフォルトに戻ります。

DEFAULT_ROLLBACK を指定する場合は、MaintenanceScheduleリクエストの「」を参照してください。それ以外の場合、OpenSearch サービスはロールバックを実行できません。

CognitoOptions

フィールド	データ型	説明
`Enabled`	ブール値	OpenSearch ダッシュボードの Amazon Cognito 認証を有効または無効にするかどうか。「OpenSearch ダッシュボードの Amazon Cognito 認証の設定」を参照してください。
`UserPoolId`	文字列	OpenSearch サービスで OpenSearch ダッシュボード認証に使用する Amazon Cognito ユーザープール ID。
`IdentityPoolId`	文字列	OpenSearch サービスで OpenSearch ダッシュボード認証に使用する Amazon Cognito ID プール ID。
`RoleArn`	文字列	-`AmazonOpenSearchServiceCognitoAccess`OpenSearch Service でユーザープールと ID プールの設定を許可するロール。

ColdStorageOptions

OpenSearch サービスドメインのコールドストレージを有効にするために必要な、パラメータのコンテナ。

フィールド	データ型	説明
`Enabled`	ブール値	ドメインでコールドストレージを有効または無効にするかどうか。「Amazon OpenSearch Service 用のコールドストレージ」を参照してください。

CreateDomainRequest

CreateDomain サービス運用に必要なパラメータのコンテナ。

フィールド	データ型	説明
`DomainName`	DomainName	作成する OpenSearch Service ドメインの名前。
`ClusterConfig`	ClusterConfig	OpenSearch サービスドメインのクラスター設定のコンテナ。
`EBSOptions`	EBSOptions	OpenSearch サービスドメインの EBS ベースのストレージを有効にするために必要な、パラメータのコンテナ。
`AccessPolicies`	文字列	新しい OpenSearch サービスドメインのアクセスポリシーを指定する IAM ポリシードキュメント。詳細については、「アクセスポリシーの設定」を参照してください。
`DomainEndpointOptions`	DomainEndpointOptions	ドメインエンドポイントの追加オプション (すべてのトラフィックで HTTPS を必須にするかどうかなど)。
`SnapshotOptions`	SnapshotOptions	DEPRECATED. ドメインインデックスの自動スナップショットを設定するために必要なパラメータのコンテナ。
`VPCOptions`	VPCOptions	VPC で動作するように OpenSearch サービスを設定するために必要な値のコンテナ。
`LogPublishingOptions`	LogPublishingOptions	スローログの発行を設定するためのキーと値の文字列のペア。
`AdvancedOptions`	AdvancedOptions	詳細な設定オプションを指定するためのキーと値のペア。
`CognitoOptions`	CognitoOptions	OpenSearch ダッシュボードで Amazon Cognito 認証を使用するように OpenSearch サービスを設定するためのキーと値のペア。
`NodeToNodeEncryptionOptions`	NodeToNodeEncryptionOptions	ノード間の暗号化を有効にするには `true` を指定します。

DomainEndpointOptions

フィールド	データ型	説明
`EnforceHTTPS`	ブール値	ドメインへのすべてのトラフィックが HTTPS 経由で到着することを要求する場合は `true`。
`TLSSecurityPolicy`	文字列	ドメインへのトラフィックに必要な最小 TLS バージョン。有効な値は TLS 1.0 (デフォルト) または 1.2 です。 `Policy-Min-TLS-1-0-2019-07` `Policy-Min-TLS-1-2-2019-07`
`CustomEndpointEnabled`	ブール値	ドメインのカスタムエンドポイントを有効にするかどうか。
`CustomEndpoint`	文字列	カスタムエンドポイントの完全修飾 URL。
`CustomEndpointCertificateArn`	文字列	ACM で管理されるセキュリティ証明書の ARN。

DomainID

データ型	説明
文字列	OpenSearch Service ドメイン用の一意の識別子。

DomainName

OpenSearch サービスのドメインの名前。

データ型	説明
文字列	OpenSearch サービスのドメインの名前。ドメイン名は、AWS リージョン内の同じアカウントによって所有されるドメイン間で一意です。ドメイン名は小文字で始まり、3~28 文字で構成される必要があります。有効な文字は、a ～ z (小文字のみ)、0 ～ 9、– (ハイフン) です。

DomainNameList

OpenSearch Service ドメイン名の文字列。

データ型	説明
文字列配列	次の形式の OpenSearch Service ドメインの配列: `["<Domain_Name>","<Domain_Name>"...]`

DomainPackageDetails

ドメインに関連付けられているパッケージに関する情報。

フィールド	データ型	説明
DomainName	文字列	パッケージを関連付けたドメインの名前。
DomainPackageStatus	文字列	関連付けの状態。値は、`ASSOCIATING`、`ASSOCIATION_FAILED`、`ACTIVE`、`DISSOCIATING`、および `DISSOCIATION_FAILED` です。
ErrorDetails	文字列	パッケージがエラー状態にある場合の追加情報。それ以外の場合は Null です。
LastUpdated	タイムスタンプ	関連付けのステータスに対する最新の更新のタイムスタンプ。
PackageID	文字列	パッケージの内部 ID。
PackageName	文字列	ユーザーが指定したパッケージの名前。
PackageType	文字列	現在のところ、`TXT-DICTIONARY` のみサポートされます。
ReferencePath	文字列	OpenSearch サービスクラスターノードでのパッケージの場所を示します。辞書ファイルの `synonym_path` と同じです。

EBSOptions

OpenSearch サービスドメインの EBS ベースのストレージを有効にするために必要な、パラメータのコンテナ。

フィールド	データ型	説明
`EBSEnabled`	ブール値	EBS ボリュームを OpenSearch サービスドメインのデータノードにアタッチするかどうかを示します。
`VolumeType`	文字列	データノードにアタッチされた EBS ボリュームのタイプを指定します。
`VolumeSize`	文字列	データノードにアタッチされた EBS ボリュームのサイズ (GiB) を指定します。
`Iops`	文字列	データノードにアタッチされた EBS ボリュームのベースライン入出力 (I/O) パフォーマンスを指定します。プロビジョニングされた IOPS EBS ボリュームタイプに対してのみ適用できます。

ClusterConfig

OpenSearch サービスドメインのクラスター設定のコンテナ。

フィールド	データ型	説明
`InstanceType`	文字列	クラスターのデータノードのインスタンスタイプ。
`InstanceCount`	整数	クラスターのインスタンスの数。
`DedicatedMasterEnabled`	ブール値	専用マスターノードがクラスターに対して有効かどうかを表します。クラスターが専用マスターノードを使用する場合は、`True`。クラスターが専用マスターノードを使用しない場合は、`False`。詳細については、「Amazon OpenSearch サービスの専用マスターノード」を参照してください。
`DedicatedMasterType`	文字列	クラスターの専用マスターノードの OpenSearch サービスのインスタンスタイプ。
`DedicatedMasterCount`	整数	クラスター内の専用マスターノードの数。この数値は1より大きくする必要があります。そうでない場合は、検証例外が発生します。
`ZoneAwarenessEnabled`	ブール値	複数のアベイラビリティーゾーンが有効になっているかどうかを示します。詳細については、「Amazon OpenSearch サービスでのマルチ AZ ドメインの設定」を参照してください。
`ZoneAwarenessConfig`	ZoneAwarenessConfig	ゾーン対応設定オプションのコンテナ。`ZoneAwarenessEnabled` が `true` の場合のみ必須です。
`WarmEnabled`	ブール値	クラスターのウォームストレージを有効にするかどうか。
`WarmCount`	整数	クラスターのウォームノード数。
`WarmType`	文字列	クラスターのウォームノードのインスタンスタイプ。
`WarmStorage`	整数	プロビジョニングされたウォームストレージの総量 (GiB)。
`ColdStorageOptions`	ColdStorageOptions	コールドストレージ設定オプションのコンテナ。

DomainConfig

OpenSearch Service ドメイン設定のコンテナ。

フィールド	データ型	説明
`EngineVersion`	文字列	OpenSearchまたはElasticsear
`ClusterConfig`	ClusterConfig	OpenSearch サービスドメインのクラスター設定のコンテナ。
`EBSOptions`	EBSOptions	OpenSearch サービスドメイン用に設定された EBS オプションのコンテナ。
`AccessPolicies`	文字列	OpenSearch Service ドメインのアクセスポリシーを指定します。詳細については、「アクセスポリシーの設定」を参照してください。
`SnapshotOptions`	SnapshotOptions	DEPRECATED. ドメインインデックスの自動スナップショットを設定するために必要なパラメータのコンテナ。
`DomainEndpointOptions`	DomainEndpointOptions	ドメインエンドポイントの追加オプション (すべてのトラフィックで HTTPS を必須にするかどうかなど)。
`VPCOptions`	VPCDerivedInfo	ドメインの現在の VPCOptions と設定におけるすべての更新状態。
`LogPublishingOptions`	LogPublishingOptions	スローログの発行を設定するためのキーと値のペア。
`AdvancedOptions`	AdvancedOptions	詳細な設定オプションを指定するためのキーと値のペア。
`EncryptionAtRestOptions`	EncryptionAtRestOptions	保管時に暗号化するためのキーと値のペア。
`NodeToNodeEncryptionOptions`	NodeToNodeEncryptionOptions	ノード間の暗号化が有効か無効か。

DomainStatus

DomainStatus データ構造のコンテンツのコンテナ。

フィールド	データ型	説明
`DomainID`	DomainID	OpenSearch Service ドメイン用の一意の識別子。
`DomainName`	DomainName	OpenSearch サービスのドメインの名前。ドメイン名は、AWS リージョン内の同じアカウントによって所有されるドメイン間で一意です。ドメイン名は小文字で始まり、3~28 文字で構成される必要があります。有効な文字は、a ～ z (小文字のみ)、0 ～ 9、– (ハイフン) です。
`ARN`	ARN	OpenSearch Service ドメインの Amazon リソースネーム (ARN)。詳細については、「」を参照してください。IAM IDのAWS Identity and Access Managementユーザーガイド。
`Created`	ブール値	OpenSearch サービスドメインの作成のステータス。`True`ドメインの作成が完了している場合。`False`ドメインの作成がまだ進行中の場合。
`Deleted`	ブール値	OpenSearch サービスドメインの削除のステータス。`True`ドメインの削除が完了した場合。`False`ドメインの削除がまだ進行中の場合。
`Endpoint`	ServiceUrl	インデックス、検索、データアップロードのリクエストを OpenSearch Service ドメインに送信するために使用されるドメイン固有のエンドポイント。
`Endpoints`	EndpointsMap	OpenSearch サービスドメインが VPC エンドポイントを使用する場合に存在するキー値ペア。
`Processing`	ブール値	OpenSearch Service ドメインの設定の変更のステータス。`True`サービスが、まだ構成変更を処理している場合、。`False`構成変更がアクティブである場合、。ドメインのステータスがアクティブになるのを待ってから、インデックス、検索、データアップロードのリクエストを送信する必要があります。
`EngineVersion`	文字列	OpenSearchまたはElasticsear
`ClusterConfig`	ClusterConfig	OpenSearch サービスドメインのクラスター設定のコンテナ。
`EBSOptions`	EBSOptions	OpenSearch サービスドメインの EBS ベースのストレージを有効にするために必要な、パラメータのコンテナ。
`AccessPolicies`	文字列	新しい OpenSearch サービスドメインのアクセスポリシーを指定する IAM ポリシードキュメント。詳細については、「アクセスポリシーの設定」を参照してください。
`SnapshotOptions`	SnapshotOptions	DEPRECATED. 毎日実行されるOpenSearch Service ドメインインデックスの自動スナップショットの時刻を設定するために必要なパラメータのコンテナ。
`VPCOptions`	VPCDerivedInfo	OpenSearch サービスがVPCOptionsドメインの「」を参照してください。
`LogPublishingOptions`	LogPublishingOptions	スローログの発行を設定するためのキーと値のペア。
`AdvancedOptions`	AdvancedOptions	詳細な設定オプションを指定するためのキーと値のペア。
`EncryptionAtRestOptions`	EncryptionAtRestOptions	保管時に暗号化するためのキーと値のペア。
`CognitoOptions`	CognitoOptions	OpenSearch ダッシュボードで Amazon Cognito 認証を使用するように OpenSearch サービスを設定するためのキーと値のペア。
`NodeToNodeEncryptionOptions`	NodeToNodeEncryptionOptions	ノード間の暗号化が有効か無効か。
`UpgradeProcessing`	ブール値	新しい OpenSearch バージョンまたは Elasticsearch バージョンへのアップグレードが進行中の場合は True。
`ServiceSoftwareOptions`	ServiceSoftwareOptions	ドメインのサービスソフトウェアのステータス。

DomainStatusList

指定された各 OpenSearch サービスドメインのステータスを格納するリスト。

フィールド	データ型	説明
`DomainStatusList`	DomainStatus	指定された各 OpenSearch サービスドメインのステータスを格納するリスト。

EncryptionAtRestOptions

ドメインで保管時のデータを暗号化するかどうかと、暗号化する場合は使用する AWS Key Management Service (KMS) キーを指定します。新しいドメインの作成にのみ使用でき、既存のドメインの更新には使用できません。詳細については、「保管時のデータの暗号化を有効にする」を参照してください。

フィールド	データ型	説明
`Enabled`	ブール値	保管時に暗号化するには `true` を指定します。
`KmsKeyId`	文字列	KMS キー ID。形式は `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a` です。

EndpointsMap

VPC エンドポイントを含むキー値ペア。OpenSearch Service ドメインが VPC 内にある場合にのみ存在します。

フィールド	データ型	説明
`Endpoints`	キー値文字列のペア: `"vpc": "<VPC_ENDPOINT>"`	ドメインの VPC エンドポイント。

Filters

DescribePackages レスポンスに含まれるパッケージをフィルタリングします。

フィールド	データ型	説明
`Name`	文字列	PackageDetails の任意のフィールド。
`Value`	リスト	指定されたフィールドの値のリスト。

LogPublishingOptions

OpenSearch サービスドメインが OpenSearch アプリケーションとスローログを Amazon CloudWatch に発行するかどうかを指定します。それでも有効にする必要がcollectionOpenSearch REST API を使用してスローログの。詳細については、「低速ログに対する OpenSearch ロギングしきい値の設定」を参照してください。

フィールドデータ型説明

INDEX_SLOW_LOGS

Key-value

CloudWatch ロググループや、そのロググループに OpenSearch インデックススローログを発行するかどうかを定義するキーと値のペア。


"CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group:sample-domain",
"Enabled":true

SEARCH_SLOW_LOGS

Key-value

CloudWatch ロググループや、そのロググループに OpenSearch 検索スローログを発行するかどうかを定義するキーと値のペア。


"CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group:sample-domain",
"Enabled":true

ES_APPLICATION_LOGS

Key-value

CloudWatch ロググループや、そこに OpenSearch エラーログを発行するかどうかを定義するキーと値のペア。


"CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group:sample-domain",
"Enabled":true

MasterUserOptions

フィールド	データ型	説明
`MasterUserARN`	文字列	マスターユーザーの ARN。AdvancedSecurityOptions で `InternalUserDatabaseEnabled` が `false` である場合にのみ指定します。
`MasterUserName`	文字列	マスターユーザーのユーザー名。AdvancedSecurityOptions で `InternalUserDatabaseEnabled` が `true` である場合にのみ指定します。
`MasterUserPassword`	文字列	マスターユーザーのパスワード。AdvancedSecurityOptions で `InternalUserDatabaseEnabled` が `true` である場合にのみ指定します。

NodeToNodeEncryptionOptions

ノード間の暗号化を有効または無効にします。

フィールド	データ型	説明
`Enabled`	ブール値	`true` で有効化します。

OptionState

OpenSearch サービスドメインの詳細オプションの更新の状態。

フィールド	データ型	説明
`OptionStatus`	文字列	3 つの有効な値のうちの 1 つ: RequiresIndexDocuments Processing アクティブ

OptionStatus

OpenSearch サービスドメイン用設定オプションの更新のステータス。

フィールド	データ型	説明
`CreationDate`	タイムスタンプ	OpenSearch Service ドメインが作成された日時。
`UpdateDate`	タイムスタンプ	OpenSearch Service ドメインが更新された日時。
`UpdateVersion`	整数	エンティティの最新バージョンを指定する整数
`State`	OptionState	OpenSearch サービスドメイン用設定オプションの更新の状態。
`PendingDeletion`	ブール値	OpenSearch Service ドメインとそのリソースすべてを完全に削除するリクエストを、サービスが処理しているかどうかを表します。

PackageDetails

パッケージに関する基本情報。

フィールド	データ型	説明
`CreatedAt`	タイムスタンプ	パッケージが作成された時刻。
`ErrorDetails`	文字列	パッケージがエラー状態にある場合の追加情報。それ以外の場合は Null です。
`PackageDescription`	文字列	ユーザーが指定したパッケージの説明。
`PackageID`	文字列	パッケージの内部 ID。
`PackageName`	文字列	ユーザーが指定したパッケージの名前。
`PackageStatus`	文字列	値は、`COPYING`、`COPY_FAILED`、`AVAILABLE`、`DELETING`、`DELETE_FAILED` です。
`PackageType`	文字列	現在のところ、`TXT-DICTIONARY` のみサポートされます。

PackageSource

OpenSearch Service に追加するパッケージのバケットとキー。

フィールド	データ型	説明
`S3BucketName`	文字列	パッケージを含むバケットの名前。
`S3Key`	文字列	パッケージのキー (ファイル名)。

SAMLOptions

フィールド	データ型	説明
`Enabled`	ブール値	OpenSearch ダッシュボードの SAML 認証を有効にするかどうか。
`MasterUserName`	文字列	SAML IdP からのこのユーザー名は、クラスターに対する完全なアクセス許可を受け取ります。これは、新しいマスターユーザ。
`MasterBackendRole`	文字列	SAML IdP のこのバックエンドロールは、クラスターに対する完全なアクセス許可を受け取ります。これは、新しいマスターユーザ。
`Idp`	オブジェクト	ID プロバイダーからの情報のコンテナ。次の 2 つの要素が含まれます。 `"Idp": { "EntityId": "entity-id", "MetadataContent": "metadata-content-with-quotes-escaped" }`
`RolesKey`	文字列	バックエンドロールに使用する SAML アサーションの要素。デフォルトは `roles` です。
`SubjectKey`	文字列	ユーザー名に使用する SAML アサーションの要素。デフォルトは `NameID` です。
`SessionTimeoutMinutes`	整数	ユーザーのログインからのセッションの継続時間 (分単位)。デフォルトは 60 です。最大値は1,440 (24時間) です。

ServiceSoftwareOptions

最新のサービスソフトウェアに対するドメインの状態を表すコンテナ。

フィールド	データ型	説明
`UpdateAvailable`	ブール値	ドメインでサービスソフトウェア更新が利用可能かどうか。
`Cancellable`	ブール値	ドメインの更新をリクエストしている場合は、更新をキャンセルできるかどうか。
`AutomatedUpdateDate`	タイムスタンプ	必要な更新のためにデプロイのウィンドウが閉じるエポック時刻。この時間を過ぎると、OpenSearch サービスは自動的にソフトウェアアップグレードのスケジュールを設定します。
`UpdateStatus`	文字列	更新のステータス。値は、`ELIGIBLE`、`PENDING_UPDATE`、`IN_PROGRESS`、`COMPLETED`、および `NOT_ELIGIBLE` です。
`Description`	文字列	ステータスに関する詳細な説明。
`CurrentVersion`	文字列	現在のサービスソフトウェアバージョン。
`NewVersion`	文字列	最新のサービスソフトウェアバージョン。
`OptionalDeployment`	ブール値	サービスソフトウェアの更新がオプションであるかどうか。

ServiceURL

インデックス、検索、データアップロードのリクエストを OpenSearch Service ドメインに送信するために使用されるドメイン固有のエンドポイント。

フィールド	データ型	説明
`ServiceURL`	文字列	インデックス、検索、データアップロードのリクエストを OpenSearch Service ドメインに送信するために使用されるドメイン固有のエンドポイント。

SnapshotOptions

DEPRECATED. 「Amazon OpenSearch サービスでのインデックススナップショットの作成」を参照してください。OpenSearch Service ドメインで、毎日実行されるインデックスの自動スナップショットの時刻を設定するために必要なパラメータのコンテナ。

フィールド	データ型	説明
`AutomatedSnapshotStartHour`	整数	DEPRECATED. OpenSearch Service ドメインで、サービスがインデックスの自動スナップショットを毎日作成する時間。

Tag

フィールド	データ型	説明
`Key`	TagKey	タグに必要な名前。タグキーは添付される OpenSearch サービスドメインで一意にする必要があります。詳細については、「Amazon OpenSearch Service ドメインのタグ付け」を参照してください。
`Value`	TagValue	タグの文字列値 (オプション)。タグ値は `null` を指定できます。また、タグセット内で一意である必要はありません。例えば、project/Trinity と cost-center/Trinity のタグセット内に 1 つのキーと値のペアを使用できます。

TagKey

フィールド	データ型	説明
`Key`	文字列	タグの名前。文字列は 128 文字まで設定できます。

フィールド	データ型	説明
`Tag`	Tag	OpenSearch Service ドメインに添付されたリソースタグ。

TagValue

フィールド	データ型	説明
`Value`	文字列	`TagKey` に対し、値を保持します。文字列は 256 文字まで設定できます。

VPCDerivedInfo

フィールド	データ型	説明
`VPCId`	文字列	VPC の ID。VPC を作成する場合に Amazon VPC はこの値を生成します。
`SubnetIds`	StringList	ドメインの VPC エンドポイントに関連付けられるサブネット ID のリスト。詳細については、「」を参照してください。VPC とサブネットのAmazon VPC User Guide。
`AvailabilityZones`	StringList	VPC サブネットに関連付けられるアベイラビリティーゾーンのリスト。詳細については、「」を参照してください。VPC とサブネットの基本のAmazon VPC User Guide。
`SecurityGroupIds`	StringList	ドメインの VPC エンドポイントに関連付けられるセキュリティグループ ID のリスト。詳細については、Amazon VPC ユーザーガイドの「VPC のセキュリティグループ」を参照してください。

VPCOptions

フィールド	データ型	説明
`SubnetIds`	StringList	ドメインの VPC エンドポイントに関連付けられるサブネット ID のリスト。ドメインで複数のアベイラビリティーゾーンが使用されている場合は、ゾーンごとに 1 つずつ、2 つのサブネット ID を提供する必要があります。それ以外の場合は、1 つのみを指定します。詳細については、次を参照してください。VPC とサブネットのAmazon VPC User Guide。
`SecurityGroupIds`	StringList	ドメインの VPC エンドポイントに関連付けられるセキュリティグループ ID のリスト。セキュリティグループ ID を提供しない場合、OpenSearch Service は VPC にデフォルトのセキュリティグループを使用します。詳細については、次を参照してください。VPC のセキュリティグループのAmazon VPC User Guide。
`VPCId`	文字列	VPC の ID。

ZoneAwarenessConfig

フィールド	データ型	説明
`AvailabilityZoneCount`	整数	複数のアベイラビリティーゾーン (AZ) を有効にした場合、このフィールドはドメインで使用するゾーンの数です。有効な値は、`2` および `3` です。

Errors

OpenSearch Service は次のエラーをスローします。

Exception	説明
`BaseException`	すべてのサービスエラーにスローされます。エラーの HTTP ステータスコードを格納します。
`ValidationException`	HTTP リクエストに無効な入力が含まれているか、必要な入力が欠けていると、スローされます。HTTP ステータスコード 400 を返します。
`DisabledOperationException`	クライアントがサポート対象外のオペレーションを実行しようとするとスローされます。HTTP ステータスコード 409 を返します。
`InternalException`	リクエストの処理中にサービスの内部エラーが発生するとスローされます。HTTP ステータスコード 500 を返します。
`InvalidTypeException`	OpenSearch Service ドメインの、無効、またはサポートされていないサブリソースを作成またはアクセスしようとするとスローされます。HTTP ステータスコード 409 を返します。
`LimitExceededException`	OpenSearch Service ドメインリソースとサブリソースを、許可された数以上作成しようとしたり、許可されていないタイプを作成しようとすると、スローされます。HTTP ステータスコード 409 を返します。
`ResourceNotFoundException`	存在しないリソースにアクセスしたり、削除すると、スローされます。HTTP ステータスコード 400 を返します。
`ResourceAlreadyExistsException`	クライアントが OpenSearch サービスドメイン内にすでに存在するリソースを作成しようとすると、スローされます。HTTP ステータスコード 400 を返します。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

トラブルシューティング

ドキュメント履歴