Amazon Elasticsearch Service 設定 API リファレンス

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

• アクション

• データ型

• エラー

アクション

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

注記

すべての設定サービスリクエストに、必ず署名してください。詳細については、このガイドの「Amazon Elasticsearch サービスリクエストの署名」、および AWS General Referenceの「署名バージョン 4 の署名プロセス」を参照してください。

アクション	HTTP メソッド
AddTags	POST
AssociatePackage	POST
CreateElasticsearchDomain	POST
CreatePackage	POST
DeleteElasticsearchDomain	DELETE
DeleteElasticsearchServiceRole	DELETE
DeletePackage	DELETE
DescribeElasticsearchDomain	GET
DescribeElasticsearchDomainConfig	GET
DescribeElasticsearchDomains	POST
DescribeElasticsearchInstanceTypeLimits	GET
DescribePackages	POST
DescribeReservedElasticsearchInstanceOfferings	GET
DescribeReservedElasticsearchInstances	GET
DissociatePackage	POST
GetCompatibleElasticsearchVersions	GET
GetUpgradeHistory	GET
GetUpgradeStatus	GET
ListDomainNames	GET
ListDomainsForPackage	GET
ListElasticsearchInstanceTypeDetails	GET
ListElasticsearchInstanceTypes	GET
ListElasticsearchVersions	GET
ListPackagesForDomain	GET
ListTags	GET
PurchaseReservedElasticsearchInstanceOffering	POST
RemoveTags	POST
StartElasticsearchServiceSoftwareUpdate	POST
StopElasticsearchServiceSoftwareUpdate	POST
UpdateElasticsearchDomainConfig	POST
UpgradeElasticsearchDomain	POST

AddTags

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

構文

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

リクエストパラメータ

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

リクエストボディ

パラメータ	データ型	必須?	説明
TagList	TagList	あり	リソースタグの一覧。
ARN	ARN	あり	リソースタグを添付する Amazon ES ドメインの Amazon リソースネーム (ARN)。

レスポンス要素

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

AssociatePackage

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

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

フィールド	データタイプ
DomainPackageDetails	DomainPackageDetails

CreateElasticsearchDomain

Amazon ES ドメインを作成します。詳細については、「 Amazon ES ドメインの作成」を参照してください。

注記

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

構文

POST https://es.us-east-1.amazonaws.com/2015-01-01/es/domain
{
  "ElasticsearchClusterConfig": {
    "ZoneAwarenessConfig": {
      "AvailabilityZoneCount": 3
    },
    "ZoneAwarenessEnabled": true|false,
    "InstanceCount": 3,
    "DedicatedMasterEnabled": true|false,
    "DedicatedMasterType": "c5.large.elasticsearch",
    "DedicatedMasterCount": 3,
    "InstanceType": "r5.large.elasticsearch",
    "WarmCount": 3,
    "WarmEnabled": true|false,
    "WarmType": "ultrawarm1.large.elasticsearch"
  },
  "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"
  },
  "SnapshotOptions": {
    "AutomatedSnapshotStartHour": 3
  },
  "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"
  },
  "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/CognitoAccessForAmazonES"
  },
  "NodeToNodeEncryptionOptions": {
    "Enabled": true|false
  },
  "DomainEndpointOptions": {
    "EnforceHTTPS": true|false,
    "TLSSecurityPolicy": "Policy-Min-TLS-1-2-2019-07|Policy-Min-TLS-1-0-2019-07"
  },
  "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"
    }
  },
  "ElasticsearchVersion": "7.1",
  "DomainName": "my-domain",
  "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"123456789012\"]},\"Action\":[\"es:es:ESHttp*\"],\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/my-domain/*\"}]}"
}

リクエストパラメータ

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

リクエストボディ

パラメータ	データ型	必須?	説明
DomainName	DomainName	あり	作成する Amazon ES ドメインの名前。
ElasticsearchVersion	文字列	いいえ	Elasticsearch のバージョン。指定されない場合、デフォルトとして 1.5 が使用されます。サポートされているバージョンの詳細なリストについては、「サポートされる Elasticsearch バージョン」を参照してください。
ElasticsearchClusterConfig	ElasticsearchClusterConfig	いいえ	Amazon ES ドメインのクラスター設定のコンテナ。
EBSOptions	EBSOptions	いいえ	Amazon ES ドメインの EBS ベースのストレージを有効にするために必要な、パラメータのコンテナ。詳細については、「EBS ベースのストレージの設定」を参照してください。
VPCOptions	VPCOptions	いいえ	VPC アクセスドメインを設定するために必要な値のコンテナ。これらの値を指定しない場合、Amazon ES はパブリックエンドポイントでドメインを作成します。詳細については、「Amazon Elasticsearch Service ドメインの VPC サポート」を参照してください。
CognitoOptions	CognitoOptions	いいえ	Kibana で Amazon Cognito 認証を使用するように Amazon ES を設定するためのキーと値のペア。
AccessPolicies	文字列	いいえ	新しい Amazon ES ドメインのアクセスポリシーを指定する IAM ポリシードキュメント。詳細については、「Amazon Elasticsearch Service の Identity and Access Management」を参照してください。
SnapshotOptions	SnapshotOptions	いいえ	DEPRECATED.Elasticsearch 5.3 以降を実行しているドメインの場合、Amazon ES は 1 時間ごとに自動的にスナップショットを作成するため、この設定は適用されません。 Elasticsearch の以前のバージョンを実行しているドメインでは、Amazon ES は 1 日ごとに自動的にスナップショットを作成します。この値は、サービスでスナップショットを作成する時刻のコンテナとして動作します。
AdvancedOptions	AdvancedOptions	いいえ	詳細な設定オプションを指定するためのキーと値のペア。詳細については「詳細オプションの設定」を参照してください。
LogPublishingOptions	LogPublishingOptions	いいえ	スローログの発行を設定するためのキーと値のペア。
EncryptionAtRestOptions	EncryptionAtRestOptions	いいえ	保管時に暗号化するためのキーと値のペア。
NodeToNodeEncryptionOptions	NodeToNodeEncryptionOptions	いいえ	ノード間の暗号化を有効にします。
DomainEndpointOptions	DomainEndpointOptions	いいえ	ドメインエンドポイントの追加オプション (すべてのトラフィックで HTTPS を必須にするかどうかなど)。
AdvancedSecurityOptions	AdvancedSecurityOptions	いいえ	きめ細かなアクセスコントロールのオプション。

レスポンス要素

フィールド	データタイプ
DomainStatus	ElasticsearchDomainStatus

CreatePackage

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

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

フィールド	データタイプ
PackageDetails	PackageDetails

DeleteElasticsearchDomain

Amazon ES ドメインと、ドメインにあるすべてのデータを削除します。ドメインは削除された後、復元できません。

構文

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

リクエストパラメータ

パラメータ	データ型	必須?	説明
DomainName	DomainName	あり	削除する Amazon ES ドメインの名前。

リクエストボディ

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

レスポンス要素

フィールド	データタイプ
DomainStatus	ElasticsearchDomainStatus

DeleteElasticsearchServiceRole

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

注記

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

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

DeletePackage

Amazon ES からパッケージを削除します。パッケージは、どの Amazon ES ドメインにも関連付けてはいけません。

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

フィールド	データタイプ
PackageDetails	PackageDetails

DescribeElasticsearchDomain

ドメイン ID、ドメインサービスエンドポイント、ドメイン ARN など、指定された Amazon ES ドメインの設定を説明します。

構文

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

リクエストパラメータ

パラメータ	データ型	必須?	説明
DomainName	DomainName	あり	説明する Amazon ES ドメインの名前。

リクエストボディ

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

レスポンス要素

フィールド	データタイプ
DomainStatus	ElasticsearchDomainStatus

DescribeElasticsearchDomainConfig

Amazon ES ドメインの設定を表示します。

構文

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

リクエストパラメータ

パラメータ	データ型	必須?	説明
DomainName	DomainName	あり	説明する必要がある Amazon ES ドメイン設定の名前。

リクエストボディ

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

レスポンス要素

フィールド	データタイプ
DomainConfig	ElasticsearchDomainConfig

DescribeElasticsearchDomains

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

構文

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

リクエストパラメータ

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

リクエストボディ

フィールド	データ型	必須?	説明
DomainNames	DomainNameList	あり	Amazon ES ドメイン名の配列。

レスポンス要素

フィールド	データタイプ
DomainStatusList	ElasticsearchDomainStatusList

DescribeElasticsearchInstanceTypeLimits

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

構文

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

リクエストパラメータ

パラメータ	データ型	必須?	説明
ElasticsearchVersion	文字列	はい	Elasticsearch バージョン。サポートされているバージョンのリストについては、「サポートされる Elasticsearch バージョン」を参照してください。
InstanceType	文字列	はい	インスタンスタイプ。リージョン別のインスタンスタイプを表示するには、「Amazon Elasticsearch Service 料金表」を参照してください。
DomainName	DomainName	いいえ	既存のドメインの名前。既存のドメインの制限が必要な場合にのみ指定します。

リクエストボディ

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

レスポンス要素

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

DescribePackages

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

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

DescribeReservedElasticsearchInstanceOfferings

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

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

フィールド	データタイプ	説明
ReservedElasticsearchInstanceOfferings	ReservedElasticsearchInstanceOfferings	リザーブドインスタンスの提供タイプに関するすべての情報のコンテナ。詳細については、「リザーブドインスタンスを購入する (AWS CLI)」を参照してください。

DescribeReservedElasticsearchInstances

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

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

DissociatePackage

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

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

フィールド	データタイプ
DomainPackageDetails	DomainPackageDetails

GetCompatibleElasticsearchVersions

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

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

フィールド	データタイプ	説明
CompatibleElasticsearchVersions	マップ	Elasticsearch バージョンのマップ、およびアップグレード可能なバージョン。 { "CompatibleElasticsearchVersions": [{ "SourceVersion": "6.7", "TargetVersions": ["6.8"] }] }

GetUpgradeHistory

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

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

GetUpgradeStatus

ドメインの Elasticsearch バージョンアップグレードの最新のステータスを返します。

構文

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

リクエストパラメータ

パラメータ	データ型	必須?	説明
DomainName	DomainName	あり	既存のドメインの名前。

リクエストボディ

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

レスポンス要素

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

ListDomainNames

アクティブリージョン内で現在のユーザーが所有するすべての Amazon ES ドメイン名を表示します。

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

フィールド	データタイプ	説明
DomainNameList	DomainNameList	現在のユーザーが所有するすべての Amazon ES ドメイン名。

ListDomainsForPackage

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

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

ListElasticsearchInstanceTypeDetails

指定された Elasticsearch バージョンでサポートされているすべての Elasticsearch インスタンスタイプ、およびこれらのインスタンスタイプでサポートされている機能を一覧表示します。

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

ListElasticsearchInstanceTypes (廃止)

指定された Elasticsearch バージョンでサポートされているすべての Elasticsearch インスタンスタイプを一覧表示します。このアクションは廃止されました。代わりに ListElasticsearchInstanceTypeDetails を使用してください。

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

ListElasticsearchVersions

Amazon ES でサポートされている Elasticsearch バージョンをすべて一覧表示します。

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

ListPackagesForDomain

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

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

ListTags

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

構文

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

リクエストパラメータ

パラメータ	データ型	必須?	説明
ARN	ARN	はい	Amazon ES ドメインの Amazon リソースネーム (ARN)。

リクエストボディ

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

レスポンス要素

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

PurchaseReservedElasticsearchInstanceOffering

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

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

フィールド	データタイプ	説明
ReservationName	文字列	予約の名前。
ReservedElasticsearchInstanceId	文字列	予約 ID。

RemoveTags

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

構文

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

リクエストパラメータ

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

リクエストボディ

パラメータ	データ型	必須?	説明
ARN	ARN	はい	Amazon ES ドメインの Amazon リソースネーム (ARN)。詳細については、AWS Identity and Access Management の使用の「IAM エンティティのための ID」を参照してください。
TagKeys	TagKey	はい	Amazon ES ドメインから削除するリソースタグのタグキーのリスト。

レスポンス要素

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

StartElasticsearchServiceSoftwareUpdate

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

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

StopElasticsearchServiceSoftwareUpdate

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

構文

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

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

UpdateElasticsearchDomainConfig

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

構文

POST https://es.us-east-1.amazonaws.com/2015-01-01/es/domain/<DOMAIN_NAME>/config
{
  "ElasticsearchClusterConfig": {
    "ZoneAwarenessConfig": {
      "AvailabilityZoneCount": 3
    },
    "ZoneAwarenessEnabled": true|false,
    "InstanceCount": 3,
    "DedicatedMasterEnabled": true|false,
    "DedicatedMasterType": "c5.large.elasticsearch",
    "DedicatedMasterCount": 3,
    "InstanceType": "r5.large.elasticsearch",
    "WarmCount": 6,
    "WarmType": "ultrawarm1.medium.elasticsearch"
  },
  "EBSOptions": {
    "EBSEnabled": true|false,
    "VolumeType": "io1|gp2|standard",
    "Iops": 1000,
    "VolumeSize": 35
  },
  "SnapshotOptions": {
    "AutomatedSnapshotStartHour": 3
  },
  "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"
  },
  "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/CognitoAccessForAmazonES"
  },
  "DomainEndpointOptions": {
    "EnforceHTTPS": true|false,
    "TLSSecurityPolicy": "Policy-Min-TLS-1-2-2019-07|Policy-Min-TLS-1-0-2019-07"
  },
  "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": {
    "InternalUserDatabaseEnabled": true|false,
    "MasterUserOptions": {
      "MasterUserARN": "arn:aws:iam::123456789012:role/my-master-user-role"
      "MasterUserName": "my-master-username",
      "MasterUserPassword": "my-master-password"
    }
  },
  "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 リクエストパラメータを使用しません。

リクエストボディ

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

レスポンス要素

フィールド	データタイプ
DomainConfig	ElasticsearchDomainConfig

UpgradeElasticsearchDomain

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

構文

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

リクエストパラメータ

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

リクエストボディ

パラメータ	データ型	必須?	説明
DomainName	文字列	はい	アップグレードする Amazon ES ドメインの名前。
TargetVersion	文字列	はい	アップグレードする Elasticsearch バージョン。「GetCompatibleElasticsearchVersions」を参照してください。
PerformCheckOnly	Boolean	いいえ	デフォルトは false です。true の場合、Amazon ES はドメインの適格性を確認しますが、アップグレードは実行しません。

レスポンス要素

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

データ型

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

AdvancedOptions

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

フィールド	データタイプ	説明
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 のドキュメントを参照してください。

ARN

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

AdvancedSecurityOptions

フィールド	データタイプ	説明
Enabled	Boolean	きめ細かなアクセスコントロールを有効にするには True。
InternalUserDatabaseEnabled	Boolean	内部ユーザーデータベースを有効にするには true。
MasterUserOptions	MasterUserOptions	マスターユーザーに関する情報のコンテナ。

CognitoOptions

フィールド	データタイプ	説明
Enabled	ブール値	Kibana の Amazon Cognito 認証を有効または無効にするかどうか。「Kibana の Amazon Cognito 認証」を参照してください。
UserPoolId	文字列	Amazon ES で Kibana 認証に使用する Amazon Cognito ユーザープール ID。
IdentityPoolId	文字列	Amazon ES で Kibana 認証に使用する Amazon Cognito ID プール ID。
RoleArn	文字列	Amazon ES でユーザープールと ID プールの設定を許可する AmazonESCognitoAccess ロール。

CreateElasticsearchDomainRequest

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

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

DomainEndpointOptions

フィールド	データタイプ	説明
EnforceHTTPS	Boolean	ドメインへのすべてのトラフィックが HTTPS 経由で到着することを要求する場合は true。
TLSSecurityPolicy	文字列	ドメインへのトラフィックに必要な最小 TLS バージョン。有効な値は TLS 1.0 (デフォルト) または 1.2 です。 Policy-Min-TLS-1-0-2019-07 Policy-Min-TLS-1-2-2019-07

DomainID

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

DomainName

Amazon ES ドメインの名前。

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

DomainNameList

Amazon ES ドメイン名の文字列。

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

DomainPackageDetails

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

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

EBSOptions

Amazon ES ドメインの EBS ベースのストレージを有効にするために必要な、パラメータのコンテナ。詳細については、「EBS ベースのストレージの設定」を参照してください。

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

ElasticsearchClusterConfig

Amazon ES ドメインのクラスター設定のコンテナ。

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

ElasticsearchDomainConfig

Amazon ES ドメイン設定のコンテナ。

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

ElasticsearchDomainStatus

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

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

ElasticsearchDomainStatusList

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

フィールド	データタイプ	説明
DomainStatusList	ElasticsearchDomainStatus	指定された各 Amazon ES ドメインのステータスを格納するリスト。

EncryptionAtRestOptions

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

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

EndpointsMap

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

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

フィルター

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

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

LogPublishingOptions

Amazon ES ドメインから Elasticsearch アプリケーションとスローログを Amazon CloudWatch に発行するかどうかを指定します。さらに、Elasticsearch REST API を使用してスローログのコレクションを有効にする必要があります。詳細については、「スローログの Elasticsearch ログしきい値の設定」を参照してください。

フィールド	データタイプ	説明
INDEX_SLOW_LOGS	Key-value	CloudWatch ロググループや、そのロググループに Elasticsearch インデックススローログを発行するかどうかを定義するキーと値のペア。 "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group:sample-domain", "Enabled":true
SEARCH_SLOW_LOGS	Key-value	CloudWatch ロググループや、そのロググループに Elasticsearch 検索スローログを発行するかどうかを定義するキーと値のペア。 "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group:sample-domain", "Enabled":true
ES_APPLICATION_LOGS	Key-value	CloudWatch ロググループや、そのロググループに Elasticsearch エラーログを発行するかどうかを定義するキーと値のペア。 "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

Amazon ES ドメインの詳細オプションの更新の状態。

フィールド	データタイプ	説明
OptionStatus	文字列	3 つの有効な値のうちの 1 つ: RequiresIndexDocuments Processing Active

OptionStatus

Amazon ES ドメイン用設定オプションの更新のステータス。

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

PackageDetails

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

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

PackageSource

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

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

ServiceSoftwareOptions

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

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

ServiceURL

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

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

SnapshotOptions

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

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

Tag

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

TagKey

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

TagList

フィールド	データタイプ	説明
Tag	Tag	Amazon ES ドメインに添付されたリソースタグ。

TagValue

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

VPCDerivedInfo

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

VPCOptions

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

ZoneAwarenessConfig

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

エラー

Amazon ES は次のエラーをスローします。

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