コンソールにサインインする
Amazon Elasticsearch Service
開発者ガイド (API バージョン 2015-01-01)

AWS ドキュメント » Amazon Elasticsearch Service » 開発者ガイド » Amazon Elasticsearch Service 設定 API リファレンス

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 の署名プロセス」を参照してください。

Action HTTP メソッド
AddTags POST
CreateElasticsearchDomain POST
DeleteElasticsearchDomain DELETE
DeleteElasticsearchServiceRole DELETE
DescribeElasticsearchDomain GET
DescribeElasticsearchDomainConfig GET
DescribeElasticsearchDomains POST
DescribeElasticsearchInstanceTypeLimits GET
DescribeReservedElasticsearchInstanceOfferings GET
DescribeReservedElasticsearchInstances GET
GetCompatibleElasticsearchVersions GET
GetUpgradeHistory GET
GetUpgradeStatus GET
ListDomainNames GET
ListElasticsearchInstanceTypeDetails GET
ListElasticsearchInstanceTypes GET
ListElasticsearchVersions GET
ListTags GET
PurchaseReservedElasticsearchInstance POST
RemoveTags POST
StartElasticsearchServiceSoftwareUpdate POST
StopElasticsearchServiceSoftwareUpdate POST
UpdateElasticsearchDomainConfig POST
UpgradeElasticsearchDomain POST

AddTags

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

構文

POST /2015-01-01/tags
{
    "ARN": "<DOMAIN_ARN>",
    "TagList": [
        {
            "Key": "<TAG_KEY>",
            "Value": "<TAG_VALUE>"
        }
    ]
}

リクエストパラメータ

この操作ではリクエストパラメータを使用しません。

リクエストボディ

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

レスポンス要素

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

エラー

AddTags オペレーションは次のエラーを返すことができます。

例

次の例は logs Amazon ES ドメインに project のタグキーを伴う単一のリソースタグをアタッチします。

リクエスト

POST es.<AWS_REGION>.amazonaws.com/2015-01-01/tags
{
    "ARN": "<DOMAIN_ARN>",
    "TagList": [
        {
            "Key": "project",
            "Value": "trident"
        }
    ]
}

レスポンス

HTTP/1.1 200 OK
x-amzn-RequestId: 5a6a5790-536c-11e5-9cd2-b36dbf43d89e
Content-Type: application/json
Content-Length: 0
Date: Sat, 05 Sep 2015 01:20:55 GMT

CreateElasticsearchDomain

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

注記

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

構文

POST /2015-01-01/es/domain
{
    "DomainName": "<DOMAIN_NAME>",
    "ElasticsearchVersion": "<VERSION>",
    "ElasticsearchClusterConfig": {
        "InstanceType": "<INSTANCE_TYPE>",
        "InstanceCount": <INSTANCE_COUNT>,
        "DedicatedMasterEnabled": "<TRUE|FALSE>",
        "DedicatedMasterCount": <INSTANCE_COUNT>,
        "DedicatedMasterType": "<INSTANCE_TYPE>",
        "ZoneAwarenessEnabled": "<TRUE|FALSE>",
        "ZoneAwarenessConfig": {
            "AvailabilityZoneCount": <2|3>
        }
    },
    "EBSOptions": {
        "EBSEnabled": "<TRUE|FALSE>",
        "VolumeType": "<VOLUME_TYPE>",
        "VolumeSize": "<VOLUME_SIZE>",
        "Iops": "<VALUE>"
    },
    "VPCOptions": {
        "SubnetIds": [
            "<SUBNET_ID>"
        ],
        "SecurityGroupIds": [
            "<SECURITY_GROUP_ID>"
        ]
    },
    "CognitoOptions": {
        "IdentityPoolId": "us-west-1:12345678-1234-1234-1234-123456789012",
        "RoleArn": "arn:aws:iam::123456789012:role/my-kibana-role",
        "Enabled": true,
        "UserPoolId": "us-west-1_121234567"
    },
    "AccessPolicies": "<ACCESS_POLICY_DOCUMENT>",
    "SnapshotOptions": {
        "AutomatedSnapshotStartHour": <START_HOUR>
    },
    "LogPublishingOptions": {
        "SEARCH_SLOW_LOGS": {
            "CloudWatchLogsLogGroupArn":"<ARN>",
            "Enabled":true
        },
        "INDEX_SLOW_LOGS": {
            "CloudWatchLogsLogGroupArn":"<ARN>",
            "Enabled":true
        }
    },
    "EncryptionAtRestOptions": {
        "Enabled": true,
        "KmsKeyId": "<KEY_ID>"
    },
    "AdvancedOptions": {
        "rest.action.multi.allow_explicit_index": "<TRUE|FALSE>",
        "indices.fielddata.cache.size": "<PERCENTAGE_OF_HEAP>"
    },
    "NodeToNodeEncryptionOptions": {
        "Enabled": true|false
    }
}

リクエストパラメータ

このオペレーションでは 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 アクセスコントロール」を参照してください。
SnapshotOptions SnapshotOptions いいえ ドメインインデックスの自動スナップショットを設定するために必要なパラメータのコンテナ。詳細については、「スナップショットの設定」を参照してください。
AdvancedOptions AdvancedOptions いいえ 詳細な設定オプションを指定するためのキーと値のペア。詳細については「詳細オプションの設定」を参照してください。
LogPublishingOptions LogPublishingOptions いいえ スローログの発行を設定するためのキーと値のペア。
EncryptionAtRestOptions EncryptionAtRestOptions いいえ 保管時に暗号化するためのキーと値のペア。
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions いいえ ノード間の暗号化を有効にする

レスポンス要素

フィールド データタイプ 説明
DomainStatus ElasticsearchDomainStatus 新しい Amazon ES ドメインのステータスと設定を指定します。

エラー

CreateElasticsearchDomain は次のエラーを返すことができます。

例

この例は以下を示します。

  • streaming-logs という名前の Amazon ES ドメインを作成する

  • 6 つのデータノードがあるクラスター (i3.large) および 3 つの専用マスターノード (c4.large) を設定する

  • 複数のアベイラビリティーゾーンを有効にする

  • ドメインの VPC アクセスを設定する

  • 保管時の暗号化およびノード間の暗号化を有効にする

リクエスト

POST https://es.us-west-1.amazonaws.com/2015-01-01/es/domain
{
  "DomainName": "streaming-logs",
  "ElasticsearchVersion": "6.3",
  "ElasticsearchClusterConfig": {
    "InstanceType": "i3.large.elasticsearch",
    "InstanceCount": 6,
    "DedicatedMasterEnabled": "true",
    "DedicatedMasterCount": 3,
    "DedicatedMasterType": "c4.large.elasticsearch",
    "ZoneAwarenessEnabled": "true"
  },
  "EncryptionAtRestOptions": {
    "Enabled": true,
    "KmsKeyId": "1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a"
  },
  "NodeToNodeEncryptionOptions": {
    "Enabled": true
  },
  "VPCOptions": {
    "SubnetIds": [
      "subnet-87654321",
      "subnet-12345678"
    ]
  }
}

レスポンス

{
  "DomainStatus": {
    "ARN": "arn:aws:es:us-west-1:123456789012:domain/streaming-logs",
    "AccessPolicies": "",
    "AdvancedOptions": {
      "rest.action.multi.allow_explicit_index": "true"
    },
    "CognitoOptions": {
      "Enabled": false,
      "IdentityPoolId": null,
      "RoleArn": null,
      "UserPoolId": null
    },
    "Created": true,
    "Deleted": false,
    "DomainId": "123456789012/streaming-logs",
    "DomainName": "streaming-logs",
    "ElasticsearchVersion": "5.5",
    "ElasticsearchClusterConfig": {
        "InstanceType": "m3.medium.elasticsearch",
        "InstanceCount": 6,
        "DedicatedMasterEnabled": "true",
        "DedicatedMasterCount": 3,
        "DedicatedMasterType": "m3.medium.elasticsearch",
        "ZoneAwarenessEnabled": "true",
        "ZoneAwarenessConfig": {
            "AvailabilityZoneCount": 2
        }
    },
    "ElasticsearchClusterConfig": {
      "DedicatedMasterCount": 3,
      "DedicatedMasterEnabled": true,
      "DedicatedMasterType": "c4.large.elasticsearch",
      "InstanceCount": 6,
      "InstanceType": "i3.large.elasticsearch",
      "ZoneAwarenessEnabled": true
    },
    "ElasticsearchVersion": "6.3",
    "EncryptionAtRestOptions": {
      "Enabled": true,
      "KmsKeyId": "arn:aws:kms:us-west-1:123456789012:key/1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a"
    },
    "Endpoint": null,
    "Endpoints": null,
    "LogPublishingOptions": null,
    "NodeToNodeEncryptionOptions": {
      "Enabled": true
    },
    "Processing": true,
    "ServiceSoftwareOptions": {
      "AutomatedUpdateDate": 0,
      "Cancellable": false,
      "CurrentVersion": "LEGACY",
      "Description": "There is no software update available for this domain.",
      "NewVersion": "",
      "UpdateAvailable": false,
      "UpdateStatus": "COMPLETED"
    },
    "SnapshotOptions": {
      "AutomatedSnapshotStartHour": 0
    },
    "UpgradeProcessing": false,
    "VPCOptions": {
      "AvailabilityZones": [
        "us-west-1b",
        "us-west-1c"
      ],
      "SecurityGroupIds": [
        "sg-12345678"
      ],
      "SubnetIds": [
        "subnet-12345678",
        "subnet-87654321"
      ],
      "VPCId": "vpc-12345678"
    }
  }
}

DeleteElasticsearchDomain

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

構文

DELETE /2015-01-01/es/domain/<DOMAIN_NAME>

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

フィールド データタイプ 説明
DomainStatus ElasticsearchDomainStatus 指定した Amazon ES ドメインの設定を指定します。

エラー

DeleteElasticsearchDomain オペレーションは次のエラーを返すことができます。

例

次の例では、weblogs ドメインが削除されます。

リクエスト

DELETE es.<AWS_REGION>.amazonaws.com/2015-01-01/es/domain/weblogs

レスポンス

HTTP/1.1 200 OK
{
    "DomainStatus": {
        "ARN": "arn:aws:es:us-west-1:123456789012:domain/weblogs",
        "AccessPolicies": "",
        "AdvancedOptions": {
            "rest.action.multi.allow_explicit_index": "true"
        },
        "Created": true,
        "Deleted": true,
        "DomainId": "123456789012/weblogs",
        "DomainName": "weblogs",
        "EBSOptions": {
            "EBSEnabled": false,
            "EncryptionEnabled": null,
            "Iops": null,
            "VolumeSize": null,
            "VolumeType": null
        },
        "ElasticsearchClusterConfig": {
            "DedicatedMasterCount": 3,
            "DedicatedMasterEnabled": true,
            "DedicatedMasterType": "m3.medium.elasticsearch",
            "InstanceCount": 6,
            "InstanceType": "m3.medium.elasticsearch",
            "ZoneAwarenessEnabled": true
        },
        "ElasticsearchVersion": "5.5",
        "EncryptionAtRestOptions": {
            "Enabled": true,
            "KmsKeyId": "arn:aws:kms:us-west-1:123456789012:key/1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a"
        },
        "Endpoint": null,
        "Endpoints": null,
        "Processing": true,
        "SnapshotOptions": {
            "AutomatedSnapshotStartHour": 0
        },
        "VPCOptions": {
            "AvailabilityZones": [
                "us-west-1b",
                "us-west-1c"
            ],
            "SecurityGroupIds": [
                "sg-12345678"
            ],
            "SubnetIds": [
                "subnet-87654321",
                "subnet-12345678"
            ],
            "VPCId": "vpc-12345678"
        }
    }
}

DeleteElasticsearchServiceRole

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

注記

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

構文

DELETE /2015-01-01/es/role

リクエストパラメータ

この操作ではリクエストパラメータを使用しません。

リクエストボディ

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

レスポンス要素

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

エラー

DeleteElasticsearchServiceRole は次のエラーを返すことができます。

例

次の例では、サービスにリンクされたロールの削除を示しています。

リクエスト

DELETE es.<AWS_REGION>.amazonaws.com/2015-01-01/es/role

レスポンス

成功した場合、このアクションは応答を返しません。

DescribeElasticsearchDomain

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

構文

GET /2015-01-01/es/domain/<DOMAIN_NAME>

リクエストパラメータ

パラメータ データタイプ 必須? 説明
DomainName DomainName はい 説明する Amazon ES ドメインの名前。

リクエストボディ

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

レスポンス要素

フィールド データタイプ 説明
DomainStatus ElasticsearchDomainStatus 指定された Amazon ES ドメインの構成。

エラー

DescribeElasticsearchDomain は次のエラーを返すことができます。

例

次のサンプルは、streaming-logs ドメインの詳細を返します。

リクエスト

GET es.<AWS_REGION>.amazonaws.com/2015-01-01/es/domain/streaming-logs

レスポンス

{
    "DomainStatus": {
        "ARN": "arn:aws:es:us-west-1:123456789012:domain/streaming-logs",
        "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-west-1:123456789012:domain/streaming-logs/*\",\"Condition\":{\"IpAddress\":{\"aws:SourceIp\":[\"11.222.333.11\",\"11.222.333.12\",\"11.222.333.13\",\"11.222.333.14\",\"11.222.333.15\"]}}}]}",
        "AdvancedOptions": {
            "rest.action.multi.allow_explicit_index": "true"
        },
        "Created": true,
        "Deleted": false,
        "DomainId": "123456789012/streaming-logs",
        "DomainName": "streaming-logs",
        "EBSOptions": {
            "EBSEnabled": true,
            "EncryptionEnabled": false,
            "Iops": null,
            "VolumeSize": 11,
            "VolumeType": "gp2"
        },
        "ElasticsearchClusterConfig": {
            "DedicatedMasterCount": 2,
            "DedicatedMasterEnabled": false,
            "DedicatedMasterType": "m4.large.elasticsearch",
            "InstanceCount": 2,
            "InstanceType": "t2.small.elasticsearch",
            "ZoneAwarenessEnabled": false
        },
        "ElasticsearchVersion": "5.5",
        "EncryptionAtRestOptions": {
            "Enabled": true,
            "KmsKeyId": "arn:aws:kms:us-west-1:123456789012:key/1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a"
        },
        "CognitoOptions": {
            "IdentityPoolId": "us-west-1:12345678-1234-1234-1234-123456789012",
            "RoleArn": "arn:aws:iam::123456789012:role/my-kibana-role",
            "Enabled": true,
            "UserPoolId": "us-west-1_121234567"
        },
        "Endpoint": "search-streaming-logs-oojmrbhufr27n44zdri52wukdy.us-west-1.es.amazonaws.com",
        "Endpoints": null,
        "Processing": false,
        "SnapshotOptions": {
            "AutomatedSnapshotStartHour": 8
        },
        "ServiceSoftwareOptions": {
            "AutomatedUpdateDate": 1530185603,
            "Cancellable": false,
            "CurrentVersion": "LEGACY",
            "Description": "A new software release R1234567 is available. This release will be automatically deployed if no action is taken.",
            "NewVersion": "R1234567",
            "UpdateAvailable": true,
            "UpdateStatus": "ELIGIBLE"
        }
        "VPCOptions": null
    }
}

DescribeElasticsearchDomainConfig

Amazon ES ドメインの構成を表示します。

構文

GET /2015-01-01/es/domain/<DOMAIN_NAME>/config

リクエストパラメータ

パラメータ データタイプ 必須? 説明
DomainName DomainName はい Amazon ES ドメインの名前。

リクエストボディ

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

レスポンス要素

フィールド データタイプ 説明
DomainConfig ElasticsearchDomainConfig Amazon ES ドメインの設定。

エラー

DescribeElasticsearchDomainConfig オペレーションは次のエラーを返すことができます。

例

次の例は、logs ドメインの構成の詳細を返します。

リクエスト

GET es.<AWS_REGION>.amazonaws.com/2015-01-01/es/domain/logs/config

レスポンス

HTTP/1.1 200 OK
{
    "DomainConfig": {
        "AccessPolicies": {
            "Options": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-west-1:123456789012:domain/logs/*\"}]}",
            "Status": {
                "CreationDate": 1499817484.04,
                "PendingDeletion": false,
                "State": "Active",
                "UpdateDate": 1500308955.652,
                "UpdateVersion": 17
            }
        },
        "AdvancedOptions": {
            "Options": {
                "indices.fielddata.cache.size": "",
                "rest.action.multi.allow_explicit_index": "true"
            },
            "Status": {
                "CreationDate": 1499817484.04,
                "PendingDeletion": false,
                "State": "Active",
                "UpdateDate": 1499818054.108,
                "UpdateVersion": 5
            }
        },
        "EBSOptions": {
            "Options": {
                "EBSEnabled": true,
                "EncryptionEnabled": false,
                "Iops": 0,
                "VolumeSize": 10,
                "VolumeType": "gp2"
            },
            "Status": {
                "CreationDate": 1499817484.04,
                "PendingDeletion": false,
                "State": "Active",
                "UpdateDate": 1499818054.108,
                "UpdateVersion": 5
            }
        },
        "ElasticsearchClusterConfig": {
            "Options": {
                "DedicatedMasterCount": 2,
                "DedicatedMasterEnabled": false,
                "DedicatedMasterType": "m4.large.elasticsearch",
                "InstanceCount": 2,
                "InstanceType": "m4.large.elasticsearch",
                "ZoneAwarenessEnabled": false
            },
            "Status": {
                "CreationDate": 1499817484.04,
                "PendingDeletion": false,
                "State": "Active",
                "UpdateDate": 1499966854.612,
                "UpdateVersion": 13
            }
        },
        "ElasticsearchVersion": {
            "Options": "5.5",
            "Status": {
                "PendingDeletion": false,
                "State": "Active",
                "CreationDate": 1436913638.995,
                "UpdateVersion": 6,
                "UpdateDate": 1436914324.278
            },
            "Options": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/logs/*\"}]}"
        },
        "EncryptionAtRestOptions": {
            "Options": {
                "Enabled": true,
                "KmsKeyId": "arn:aws:kms:us-west-1:123456789012:key/1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a"
            },
            "Status": {
                "CreationDate": 1509490412.757,
                "PendingDeletion": false,
                "State": "Active",
                "UpdateDate": 1509490953.717,
                "UpdateVersion": 6
            }
        },
        "LogPublishingOptions":{
            "Status":{
                "CreationDate":1502774634.546,
                "PendingDeletion":false,
                "State":"Processing",
                "UpdateDate":1502779590.448,
                "UpdateVersion":60
            },
            "Options":{
                "INDEX_SLOW_LOGS":{
                    "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:123456789012:log-group:sample-domain",
                    "Enabled":true
                },
                "SEARCH_SLOW_LOGS":{
                    "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:123456789012:log-group:sample-domain",
                    "Enabled":true
                }
            }
        },
        "SnapshotOptions": {
            "Options": {
                "AutomatedSnapshotStartHour": 6
            },
            "Status": {
                "CreationDate": 1499817484.04,
                "PendingDeletion": false,
                "State": "Active",
                "UpdateDate": 1499818054.108,
                "UpdateVersion": 5
            }
        },
        "VPCOptions": {
            "Options": {
                "AvailabilityZones": [
                    "us-west-1b"
                ],
                "SecurityGroupIds": [
                    "sg-12345678"
                ],
                "SubnetIds": [
                    "subnet-12345678"
                ],
                "VPCId": "vpc-12345678"
            },
            "Status": {
                "CreationDate": 1499817484.04,
                "PendingDeletion": false,
                "State": "Active",
                "UpdateDate": 1499818054.108,
                "UpdateVersion": 5
            }
        }
    }
}

DescribeElasticsearchDomains

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

構文

POST /2015-01-01/es/domain-info
{
    "DomainNames": [
        "<DOMAIN_NAME>",
        "<DOMAIN_NAME>",
    ]
}

リクエストパラメータ

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

リクエストボディ

フィールド データタイプ 必須? 説明
DomainNames DomainNameList はい 次の形式の Amazon ES ドメインの配列:

{"DomainNames":["<Domain_Name>","<Domain_Name>"...]

レスポンス要素

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

エラー

DescribeElasticsearchDomains オペレーションは次のエラーを返すことができます。

例

次のサンプルは、logs ドメインと streaming-logs ドメインの詳細を返します。

リクエスト

POST es.<AWS_REGION>.amazonaws.com/2015-01-01/es/domain-info/
{
    "DomainNames": [
        "logs",
        "streaming-logs"
    ]
}

レスポンス

HTTP/1.1 200 OK
{
    "DomainStatusList": [
        {
            "ElasticsearchClusterConfig": {
                "DedicatedMasterEnabled": true,
                "InstanceCount": 3,
                "ZoneAwarenessEnabled": false,
                "DedicatedMasterType": "m3.medium.elasticsearch",
                "InstanceType": "m3.medium.elasticsearch",
                "DedicatedMasterCount": 3
            },
            "ElasticsearchVersion": "5.5",
            "EncryptionAtRestOptions": {
                "Enabled": true,
                "KmsKeyId": "arn:aws:kms:us-west-1:123456789012:key/1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a"
            },
            "Endpoint": "search-streaming-logs-okga24ftzsbz2a2hzhsqw73jpy.us-east-1.es.example.com",
            "Created": true,
            "Deleted": false,
            "DomainName": "streaming-logs",
            "EBSOptions": {
                "EBSEnabled": false
            },
            "VPCOptions": {
                "SubnetIds": [
                    "subnet-d1234567"
                ],
                "VPCId": "vpc-12345678",
                "SecurityGroupIds": [
                    "sg-123456789"
                ],
                "AvailabilityZones": [
                    "us-east-1"
                ]
            },
            "SnapshotOptions": {
                "AutomatedSnapshotStartHour": 0
            },
            "DomainId": "123456789012/streaming-logs",
            "AccessPolicies": "",
            "Processing": false,
            "AdvancedOptions": {
                "rest.action.multi.allow_explicit_index": "true",
                "indices.fielddata.cache.size": ""
            },
            "ARN": "arn:aws:es:us-east-1:123456789012:domain/streaming-logs"
        },
        {
            "ElasticsearchClusterConfig": {
                "DedicatedMasterEnabled": true,
                "InstanceCount": 1,
                "ZoneAwarenessEnabled": false,
                "DedicatedMasterType": "search.m3.medium",
                "InstanceType": "search.m3.xlarge",
                "DedicatedMasterCount": 3
            },
            "ElasticsearchVersion": "5.5",
            "EncryptionAtRestOptions": {
                "Enabled": true,
                "KmsKeyId": "arn:aws:kms:us-west-1:123456789012:key/1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a"
            },
            "Endpoint": "search-logs-p5st2kbt77diuihoqi6omd7jiu.us-east-1.es.example.com",
            "Created": true,
            "Deleted": false,
            "DomainName": "logs",
            "EBSOptions": {
                "Iops": 4000,
                "VolumeSize": 512,
                "VolumeType": "io1",
                "EBSEnabled": true
            },
            "VPCOptions": {
                "SubnetIds": [
                    "subnet-d1234567"
                ],
                "VPCId": "vpc-12345678",
                "SecurityGroupIds": [
                    "sg-123456789"
                ],
                "AvailabilityZones": [
                    "us-east-1"
                ]
            },
            "SnapshotOptions": {
                "AutomatedSnapshotStartHour": 0
            },
            "DomainId": "123456789012/logs",
            "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/logs/*\"}]}",
            "Processing": false,
            "AdvancedOptions": {
                "rest.action.multi.allow_explicit_index": "true"
            },
            "ARN": "arn:aws:es:us-east-1:123456789012:domain/logs"
        }
    ]
}

DescribeElasticsearchInstanceTypeLimits

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

構文

GET 2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}?domainName={DomainName}

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

エラー

DescribeElasticsearchInstanceTypeLimits オペレーションは次のエラーを返すことができます。

例

次のサンプルは、logs ドメインと streaming-logs ドメインの詳細を返します。

リクエスト

GET es.<AWS_REGION>.amazonaws.com/2015-01-01/es/instanceTypeLimits/6.0/m4.large.elasticsearch

レスポンス

HTTP/1.1 200 OK
{
    "LimitsByRole": {
        "data": {
            "AdditionalLimits": [
                {
                    "LimitName": "MaximumNumberOfDataNodesWithoutMasterNode",
                    "LimitValues": [
                        "10"
                    ]
                }
            ],
            "InstanceLimits": {
                "InstanceCountLimits": {
                    "MaximumInstanceCount": 20,
                    "MinimumInstanceCount": 1
                }
            },
            "StorageTypes": [
                {
                    "StorageSubTypeName": "standard",
                    "StorageTypeLimits": [
                        {
                            "LimitName": "MaximumVolumeSize",
                            "LimitValues": [
                                "100"
                            ]
                        },
                        {
                            "LimitName": "MinimumVolumeSize",
                            "LimitValues": [
                                "10"
                            ]
                        }
                    ],
                    "StorageTypeName": "ebs"
                },
                {
                    "StorageSubTypeName": "io1",
                    "StorageTypeLimits": [
                        {
                            "LimitName": "MaximumVolumeSize",
                            "LimitValues": [
                                "512"
                            ]
                        },
                        {
                            "LimitName": "MinimumVolumeSize",
                            "LimitValues": [
                                "35"
                            ]
                        },
                        {
                            "LimitName": "MaximumIops",
                            "LimitValues": [
                                "16000"
                            ]
                        },
                        {
                            "LimitName": "MinimumIops",
                            "LimitValues": [
                                "1000"
                            ]
                        }
                    ],
                    "StorageTypeName": "ebs"
                },
                {
                    "StorageSubTypeName": "gp2",
                    "StorageTypeLimits": [
                        {
                            "LimitName": "MaximumVolumeSize",
                            "LimitValues": [
                                "512"
                            ]
                        },
                        {
                            "LimitName": "MinimumVolumeSize",
                            "LimitValues": [
                                "10"
                            ]
                        }
                    ],
                    "StorageTypeName": "ebs"
                }
            ]
        },
        "master": {
            "AdditionalLimits": [
                {
                    "LimitName": "MaximumNumberOfDataNodesSupported",
                    "LimitValues": [
                        "100"
                    ]
                }
            ],
            "InstanceLimits": {
                "InstanceCountLimits": {
                    "MaximumInstanceCount": 5,
                    "MinimumInstanceCount": 2
                }
            },
            "StorageTypes": null
        }
    }
}

DescribeReservedElasticsearchInstanceOfferings

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

構文

GET /2015-01-01/es/reservedInstanceOfferings?offeringId={OfferingId}&maxResults={MaxResults}&nextToken={NextToken}

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

エラー

DescribeReservedElasticsearchInstanceOfferings オペレーションは次のエラーを返すことができます。

例

リクエスト

GET es.<AWS_REGION>.amazonaws.com/2015-01-01/es/reservedInstanceOfferings

レスポンス

{
  "ReservedElasticsearchInstanceOfferings": [
    {
      "FixedPrice": 100.0,
      "ReservedElasticsearchInstanceOfferingId": "1a2a3a4a5-1a2a-3a4a-5a6a-1a2a3a4a5a6a",
      "RecurringCharges": [
        {
          "RecurringChargeAmount": 0.603,
          "RecurringChargeFrequency": "Hourly"
        }
      ],
      "UsagePrice": 0.0,
      "PaymentOption": "PARTIAL_UPFRONT",
      "Duration": 31536000,
      "ElasticsearchInstanceType": "m4.2xlarge.elasticsearch",
      "CurrencyCode": "USD"
    }
  ]
}

DescribeReservedElasticsearchInstances

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

構文

GET 2015-01-01/es/reservedInstances?reservationId={ReservationId}&maxResults={PageSize}&nextToken={NextToken}

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

フィールド データタイプ 説明
ReservedElasticsearchInstances

ReservedElasticsearchInstances

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

エラー

DescribeReservedElasticsearchInstances オペレーションは次のエラーを返すことができます。

例

リクエスト

GET es.<AWS_REGION>.amazonaws.com/2015-01-01/es/reservedInstances

レスポンス

{
  "ReservedElasticsearchInstances": [
    {
      "FixedPrice": 100.0,
      "ReservedElasticsearchInstanceOfferingId": "1a2a3a4a5-1a2a-3a4a-5a6a-1a2a3a4a5a6a",
      "ReservationName": "my-reservation",
      "PaymentOption": "PARTIAL_UPFRONT",
      "UsagePrice": 0.0,
      "ReservedElasticsearchInstanceId": "9a8a7a6a-5a4a-3a2a-1a0a-9a8a7a6a5a4a",
      "RecurringCharges": [
        {
          "RecurringChargeAmount": 0.603,
          "RecurringChargeFrequency": "Hourly"
        }
      ],
      "State": "payment-pending",
      "StartTime": 1522872571.229,
      "ElasticsearchInstanceCount": 3,
      "Duration": 31536000,
      "ElasticsearchInstanceType": "m4.2xlarge.elasticsearch",
      "CurrencyCode": "USD"
    }
  ]
}

GetCompatibleElasticsearchVersions

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

構文

GET /2015-01-01/es/compatibleVersions?domainName={DomainName}

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

フィールド データタイプ 説明
ElasticsearchVersions Map Elasticsearch バージョンのマップ、およびアップグレード可能なバージョン。

エラー

GetCompatibleElasticsearchVersions オペレーションは次のエラーを返すことができます。

例

次の例には、現在のユーザーが所有するドメイン 3 つすべてが記載されています。

リクエスト

GET es.<AWS_REGION>.amazonaws.com/2015-01-01/es/compatibleVersions

レスポンス

{
    "CompatibleElasticsearchVersions": [
        {
            "SourceVersion": "6.0",
            "TargetVersions": [
                "6.3"
            ]
        },
        {
            "SourceVersion": "5.1",
            "TargetVersions": [
                "5.6"
            ]
        },
        {
            "SourceVersion": "6.2",
            "TargetVersions": [
                "6.3"
            ]
        },
        {
            "SourceVersion": "5.3",
            "TargetVersions": [
                "5.6"
            ]
        },
        {
            "SourceVersion": "5.5",
            "TargetVersions": [
                "5.6"
            ]
        },
        {
            "SourceVersion": "5.6",
            "TargetVersions": [
                "6.3"
            ]
        }
    ]
}

GetUpgradeHistory

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

構文

GET /2015-01-01/es/upgradeDomain/{DomainName}/history?maxResults={MaxResults}&amp;nextToken={NextToken}

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

エラー

GetCompatibleElasticsearchVersions オペレーションは次のエラーを返すことができます。

例

次の例では、指定されたドメイン名のアップグレードの履歴をリスト表示しています。

リクエスト

GET es.<AWS_REGION>.amazonaws.com/2015-01-01/es/upgradeDomain/my-domain/history

レスポンス

{
  "NextToken": null,
  "UpgradeHistories": [
    {
      "StartTimestamp": 1532466876,
      "StepsList": [
        {
          "Issues": [
            "Upgrade automated snapshot 00010e1cbc.2018-07-24t21-14-40 in state FAILED could not be completed successfully"
          ],
          "ProgressPercent": null,
          "UpgradeStep": "SNAPSHOT",
          "UpgradeStepStatus": "FAILED"
        },
        {
          "Issues": null,
          "ProgressPercent": null,
          "UpgradeStep": "PRE_UPGRADE_CHECK",
          "UpgradeStepStatus": "SUCCEEDED"
        }
      ],
      "UpgradeName": "Upgrade from 5.6 to 6.3",
      "UpgradeStatus": "FAILED"
    },
    {
      "StartTimestamp": 1532388708,
      "StepsList": [
        {
          "Issues": null,
          "ProgressPercent": null,
          "UpgradeStep": "PRE_UPGRADE_CHECK",
          "UpgradeStepStatus": "SUCCEEDED"
        }
      ],
      "UpgradeName": "Pre-Upgrade Check from 5.6 to 6.3",
      "UpgradeStatus": "SUCCEEDED"
    },
    {
      "StartTimestamp": 1532378327,
      "StepsList": [
        {
          "Issues": null,
          "ProgressPercent": null,
          "UpgradeStep": "UPGRADE",
          "UpgradeStepStatus": "SUCCEEDED"
        },
        {
          "Issues": null,
          "ProgressPercent": null,
          "UpgradeStep": "SNAPSHOT",
          "UpgradeStepStatus": "SUCCEEDED"
        },
        {
          "Issues": null,
          "ProgressPercent": null,
          "UpgradeStep": "PRE_UPGRADE_CHECK",
          "UpgradeStepStatus": "SUCCEEDED"
        }
      ],
      "UpgradeName": "Upgrade from 5.3 to 5.6",
      "UpgradeStatus": "SUCCEEDED"
    }
  ]
}

GetUpgradeStatus

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

構文

GET /2015-01-01/es/upgradeDomain/{DomainName}/status

リクエストパラメータ

パラメータ データタイプ 必須? 説明
DomainName DomainName はい 既存のドメインの名前です。

リクエストボディ

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

レスポンス要素

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

エラー

GetCompatibleElasticsearchVersions オペレーションは次のエラーを返すことができます。

例

次の例では、指定されたドメイン名のアップグレードのステータスをリスト表示しています。

リクエスト

GET es.<AWS_REGION>.amazonaws.com/2015-01-01/es/upgradeDomain/my-domain/status

レスポンス

{
  "StepStatus": "FAILED",
  "UpgradeName": "Upgrade from 5.6 to 6.3",
  "UpgradeStep": "SNAPSHOT"
}

ListDomainNames

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

構文

GET /2015-01-01/domain

リクエストパラメータ

この操作ではリクエストパラメータを使用しません。

リクエストボディ

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

レスポンス要素

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

エラー

ListDomainNames オペレーションは次のエラーを返すことができます。

例

次の例には、現在のユーザーが所有するドメイン 3 つすべてが記載されています。

リクエスト

GET es.<AWS_REGION>.amazonaws.com/2015-01-01/domain

レスポンス

{
    "DomainNames": [
        {
            "DomainName": "logs"
        },
        {
            "DomainName": "streaming-logs"
        }
    ]
}

ListElasticsearchInstanceTypeDetails

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

構文

GET 2015-01-01/es/instanceTypeDetails/{ElasticsearchVersion}?domainName={DomainName}&maxResults={MaxResults}&nextToken={NextToken}

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

フィールド データタイプ 説明
ElasticsearchInstanceTypes List 指定された Elasticsearch バージョンでサポートされるインスタンスタイプ、およびこれらインスタンスタイプでサポートされている機能を一覧表示します。
NextToken String

ページ分割に使用されます。以前の API 呼び出しで NextToken を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を示します。クライアントは、このトークンを使用してさらに結果を取得できます。

エラー

ListElasticsearchInstanceTypeDetails は次のエラーを返すことができます。

例

リクエスト

GET es.us-west-1.amazonaws.com/2015-01-01/es/instanceTypeDetails/6.2

レスポンス

{
    "ElasticsearchInstanceTypeDetails": [
        {
            "AppLogsEnabled": true,
            "CognitoEnabled": true,
            "EncryptionEnabled": false,
            "InstanceType": "t2.small.elasticsearch"
        },
        {
            "AppLogsEnabled": true,
            "CognitoEnabled": true,
            "EncryptionEnabled": false,
            "InstanceType": "t2.medium.elasticsearch"
        },
        {
            "AppLogsEnabled": true,
            "CognitoEnabled": true,
            "EncryptionEnabled": true,
            "InstanceType": "c4.large.elasticsearch"
        },
        {
            "AppLogsEnabled": true,
            "CognitoEnabled": true,
            "EncryptionEnabled": true,
            "InstanceType": "c4.xlarge.elasticsearch"
        },
        ...
    ],
    "NextToken": null
}

ListElasticsearchInstanceTypes (廃止)

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

構文

GET 2015-01-01/es/instanceTypes/{ElasticsearchVersion}?domainName={DomainName}&maxResults={MaxResults}&nextToken={NextToken}

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

フィールド データタイプ 説明
ElasticsearchInstanceTypes List 指定された Elasticsearch バージョンでサポートされるインスタンスタイプのリスト。
NextToken String

ページ分割に使用されます。以前の API 呼び出しで NextToken を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を示します。クライアントは、このトークンを使用してさらに結果を取得できます。

エラー

ListElasticsearchInstanceTypes は次のエラーを返すことができます。

例

リクエスト

GET es.<AWS_REGION>.amazonaws.com/2015-01-01/es/instanceTypes/6.0

レスポンス

{
    "ElasticsearchInstanceTypes": [
        "t2.small.elasticsearch",
        "t2.medium.elasticsearch",
        "r4.large.elasticsearch",
        "r4.xlarge.elasticsearch",
        "r4.2xlarge.elasticsearch",
        "r4.4xlarge.elasticsearch",
        "r4.8xlarge.elasticsearch",
        "r4.16xlarge.elasticsearch",
        "m4.large.elasticsearch",
        "m4.xlarge.elasticsearch",
        "m4.2xlarge.elasticsearch",
        "m4.4xlarge.elasticsearch",
        "m4.10xlarge.elasticsearch",
        "c4.large.elasticsearch",
        "c4.xlarge.elasticsearch",
        "c4.2xlarge.elasticsearch",
        "c4.4xlarge.elasticsearch",
        "c4.8xlarge.elasticsearch"
    ],
    "NextToken": null
}

ListElasticsearchVersions

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

構文

GET 2015-01-01/es/versions?maxResults={MaxResults}&nextToken={NextToken}

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

フィールド データタイプ 説明
ElasticsearchVersions List サポートされている Elasticsearch バージョンをすべて一覧表示します。
NextToken String

ページ分割に使用されます。以前の API 呼び出しで NextToken を含む結果が生成された場合のみ必要です。次のトークンの入力を受け入れて次のページの結果を返し、応答として次のトークンの出力を示します。クライアントは、このトークンを使用してさらに結果を取得できます。

エラー

ListElasticsearchVersions は次のエラーを返すことができます。

例

リクエスト

GET es.<AWS_REGION>.amazonaws.com/2015-01-01/es/versions

レスポンス

{
    "ElasticsearchVersions": [
        "6.0",
        "5.5",
        "5.3",
        "5.1",
        "2.3",
        "1.5"
    ],
    "NextToken": null
}

ListTags

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

構文

GET /2015-01-01/tags?arn=<DOMAIN_ARN>

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

エラー

ListTags オペレーションは次のエラーを返すことができます。

例

次の例は、logs ドメインにアタッチされるタグを一覧にしています。

リクエスト

GET es.<AWS_REGION>.amazonaws.com/2015-01-01/tags?arn=arn:aws:es:us-west-1:123456789012:domain/logs

レスポンス

HTTP/1.1 200 OK
{
    "TagList": [
        {
            "Key": "Environment",
            "Value": "MacOS"
        },
        {
            "Key": "project",
            "Value": "trident"
        }
    ]
}

PurchaseReservedElasticsearchInstance

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

構文

POST /2015-01-01/es/purchaseReservedInstanceOffering

リクエストパラメータ

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

リクエストボディ

名前 データ型 必須? 説明
ReservationName 文字列 はい 予約の記述名。
ReservedElasticsearchInstanceOfferingId 文字列 はい 提供 ID。
InstanceCount 整数 はい 予約するインスタンスの数。

レスポンス要素

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

エラー

PurchaseReservedElasticsearchInstance オペレーションは次のエラーを返すことができます。

例

リクエスト

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

レスポンス

{
  "ReservationName": "my-reservation",
  "ReservedElasticsearchInstanceId": "9a8a7a6a-5a4a-3a2a-1a0a-9a8a7a6a5a4a"
}

RemoveTags

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

構文

POST es.<AWS_REGION>.amazonaws.com/2015-01-01/tags-removal
{
    "ARN": "<DOMAIN_ARN>",
    "TagKeys": [
        "<TAG_KEY>",
        "<TAG_KEY>",
        ...
    ]
}

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

エラー

RemoveTags オペレーションは次のエラーを返すことができます。

例

次の例では、Amazon ES ドメインから project のタグキーを持つリソースタグを削除します。

リクエスト

POST /2015-01-01/tags-removal
{
    "ARN": "<DOMAIN_ARN>",
    "TagKeys": [
        "project"
    ]
}

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

StartElasticsearchServiceSoftwareUpdate

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

構文

POST es.<AWS_REGION>.amazonaws.com/2015-01-01/es/serviceSoftwareUpdate/start
{
  "DomainName": "<DOMAIN_NAME>"
}

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

エラー

RemoveTags オペレーションは次のエラーを返すことができます。

例

次の例では、my-domain のサービスソフトウェア更新をスケジュール設定します。

リクエスト

POST es.us-west-1.amazonaws.com/2015-01-01/es/serviceSoftwareUpdate/start
{
  "DomainName": "my-domain"
}

レスポンス

{
  "ServiceSoftwareOptions": {
    "AutomatedUpdateDate": 1530185603,
    "Cancellable": true,
    "CurrentVersion": "LEGACY",
    "Description": "An update to release R1234567 has been requested and is pending. Before the update starts, you can cancel it any time",
    "NewVersion": "R1234567",
    "UpdateAvailable": false,
    "UpdateStatus": "PENDING_UPDATE"
  }
}

StopElasticsearchServiceSoftwareUpdate

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

構文

POST es.<AWS_REGION>.amazonaws.com/2015-01-01/es/serviceSoftwareUpdate/stop
{
  "DomainName": "<DOMAIN_NAME>"
}

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

エラー

RemoveTags オペレーションは次のエラーを返すことができます。

例

次の例では、my-domain 用にスケジュール設定されたサービスソフトウェア更新を停止します。

リクエスト

POST es.us-west-1.amazonaws.com/2015-01-01/es/serviceSoftwareUpdate/stop
{
  "DomainName": "my-domain"
}

レスポンス

{
  "ServiceSoftwareOptions": {
    "AutomatedUpdateDate": 1530185603,
    "Cancellable": false,
    "CurrentVersion": "LEGACY",
    "Description": "A new software release R1234567 is available. This release will be automatically deployed if no action is taken.",
    "NewVersion": "R1234567",
    "UpdateAvailable": true,
    "UpdateStatus": "ELIGIBLE"
  }
}

UpdateElasticsearchDomainConfig

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

構文

POST /2015-01-01/es/domain/<DOMAIN_NAME>/config
{
    "ElasticsearchClusterConfig": {
        "InstanceType": "<INSTANCE_TYPE>",
        "Instance_Count": <INSTANCE_COUNT>,
        "DedicatedMasterEnabled": "<TRUE|FALSE>",
        "DedicatedMasterCount": <INSTANCE_COUNT>,
        "DedicatedMasterType": "<INSTANCE_COUNT>",
        "ZoneAwarenessEnabled": "<TRUE|FALSE>"
    },
    "EBSOptions": {
        "EBSEnabled": "<TRUE|FALSE>",
        "VolumeType": "<VOLUME_TYPE>",
        "VolumeSize": "<VOLUME_SIZE>",
        "Iops": "<VALUE>"
    },
    "VPCOptions": {
        "SubnetIds": [
            "<SUBNET_ID>"
        ],
        "SecurityGroupIds": [
            "<SECURITY_GROUP_ID>"
        ]
    },
    "AccessPolicies": "<ACCESS_POLICY_DOCUMENT>",
    "SnapshotOptions": {
        "AutomatedSnapshotStartHour": <START_HOUR>,
        "AdvancedOptions": {
            "rest.action.multi.allow_explicit_index": "<TRUE|FALSE>",
            "indices.fielddata.cache.size": "<PERCENTAGE_OF_HEAP>"
        }
    },
    "LogPublishingOptions": {
        "SEARCH_SLOW_LOGS": {
            "CloudWatchLogsLogGroupArn":"<ARN>",
            "Enabled":true
        },
        "INDEX_SLOW_LOGS": {
            "CloudWatchLogsLogGroupArn":"<ARN>",
            "Enabled":true
        }
    }
}

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

フィールド データタイプ 説明
DomainConfig 文字列 設定を更新した後の Amazon ES ドメインのステータス。

エラー

UpdateElasticsearchDomainConfig は次のエラーを返すことができます。

例

次の例では、毎日午前 3:00 (GMT) からの 1 時間に発生する、streaming-logs ドメインの自動スナップショットを設定します。

リクエスト

POST es.<AWS_REGION>.amazonaws.com/2015-01-01/es/domain/streaming-logs/config
{
    "SnapshotOptions": {
        "AutomatedSnapshotStartHour": 3
    }
}

レスポンス

{
    "DomainConfig": {
        "AccessPolicies": {
            "Options": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-west-1:123456789012:domain/streaming-logs/*\",\"Condition\":{\"IpAddress\":{\"aws:SourceIp\":[\"11.222.333.11\",\"11.222.333.12\",\"11.222.333.13\",\"11.222.333.14\",\"11.222.333.15\"]}}}]}",
            "Status": {
                "CreationDate": 1502213150.329,
                "PendingDeletion": false,
                "State": "Active",
                "UpdateDate": 1502213466.93,
                "UpdateVersion": 6
            }
        },
        "AdvancedOptions": {
            "Options": {
                "rest.action.multi.allow_explicit_index": "true"
            },
            "Status": {
                "CreationDate": 1502213150.329,
                "PendingDeletion": false,
                "State": "Active",
                "UpdateDate": 1502213466.93,
                "UpdateVersion": 6
            }
        },
        "EBSOptions": {
            "Options": {
                "EBSEnabled": true,
                "EncryptionEnabled": false,
                "Iops": null,
                "VolumeSize": 11,
                "VolumeType": "gp2"
            },
            "Status": {
                "CreationDate": 1502213150.329,
                "PendingDeletion": false,
                "State": "Active",
                "UpdateDate": 1502929669.653,
                "UpdateVersion": 23
            }
        },
        "ElasticsearchClusterConfig": {
            "Options": {
                "DedicatedMasterCount": 2,
                "DedicatedMasterEnabled": false,
                "DedicatedMasterType": "m4.large.elasticsearch",
                "InstanceCount": 2,
                "InstanceType": "t2.small.elasticsearch",
                "ZoneAwarenessEnabled": false
            },
            "Status": {
                "CreationDate": 1502213150.329,
                "PendingDeletion": false,
                "State": "Active",
                "UpdateDate": 1502929669.653,
                "UpdateVersion": 23
            }
        },
        "ElasticsearchVersion": {
            "Options": "5.5",
            "Status": {
                "CreationDate": 1502213150.329,
                "PendingDeletion": false,
                "State": "Active",
                "UpdateDate": 1502213466.93,
                "UpdateVersion": 6
            }
        },
        "EncryptionAtRestOptions": {
            "Options": {
                "Enabled": true,
                "KmsKeyId": "arn:aws:kms:us-west-1:123456789012:key/1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a"
            },
            "Status": {
                "CreationDate": 1509490412.757,
                "PendingDeletion": false,
                "State": "Active",
                "UpdateDate": 1509490953.717,
                "UpdateVersion": 6
            }
        },
        "LogPublishingOptions":{
            "Options":{
                "INDEX_SLOW_LOGS":{
                    "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:123456789012:log-group:sample-domain",
                    "Enabled":true
                },
                "SEARCH_SLOW_LOGS":{
                    "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:123456789012:log-group:sample-domain",
                    "Enabled":true
                }
            },
            "Status":{
                "CreationDate":1502774634.546,
                "PendingDeletion":false,
                "State":"Processing",
                "UpdateDate":1502779590.448,
                "UpdateVersion":60
            }
        },
        "SnapshotOptions": {
            "Options": {
                "AutomatedSnapshotStartHour": 3
            },
            "Status": {
                "CreationDate": 1502213150.329,
                "PendingDeletion": false,
                "State": "Active",
                "UpdateDate": 1503093165.447,
                "UpdateVersion": 25
            }
        },
        "VPCOptions": {
            "Options": {
                "AvailabilityZones": null,
                "SecurityGroupIds": null,
                "SubnetIds": null,
                "VPCId": null
            },
            "Status": {
                "CreationDate": 1503093165.597,
                "PendingDeletion": false,
                "State": "Active",
                "UpdateDate": 1503093165.597,
                "UpdateVersion": 25
            }
        }
    }
}

UpgradeElasticsearchDomain

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

構文

POST /2015-01-01/es/upgradeDomain
{
  "DomainName": "String",
  "TargetVersion": "String",
  "PerformCheckOnly": true|false
}

リクエストパラメータ

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

リクエストボディ

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

レスポンス要素

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

エラー

UpdateElasticsearchDomainConfig は次のエラーを返すことができます。

例

次の例では、Amazon ES 5.x ドメインを Elasticsearch 5.6 にアップグレードします。

リクエスト

POST es.<AWS_REGION>.amazonaws.com/2015-01-01/es/upgradeDomain/
{
  "DomainName": "my-domain",
  "TargetVersion": "5.6",
  "PerformCheckOnly": false
}

レスポンス

{
  "DomainName": null,
  "PerformCheckOnly": null,
  "TargetVersion": null,
  "UpgradeId": null
}

データ型

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

AdvancedOptions

Elasticsearch の詳細設定オプションを指定する、キーと値の文字列のペア。

フィールド データタイプ 説明
rest.action.multi.allow_explicit_index キーと値のペア:

rest.action.multi.allow_explicit_index=<true|false>

 HTTP リクエストボディ中で、インデックスへの明示参照を許可するかどうかを指定します。特定のインデックスやドメイン API など、ドメインのサブリソースのアクセスポリシーを設定する場合、このプロパティを無効にする必要があります。詳細については、「URL-based Access Control」を参照してください。サブリソースのためのアクセスポリシーについては、「アクセスポリシーの設定」を参照してください。
indices.fielddata.cache.size キーと値のペア:

indices.fielddata.cache.size=<percentage_of_heap>

 フィールドデータに割り当てられる Java ヒープスペースの割合を指定します。デフォルトでは、この設定は unbounded です。
indices.query.bool.max_clause_count キーと値のペア:

indices.query.bool.max_clause_count=<int>

 Lucene のブールクエリで許可される句の最大数を指定します。デフォルト値は 1024 です。クエリに含まれる句の数が最大数を超えていると、TooManyClauses エラーが発生します。詳細については、Lucene のドキュメントを参照してください。

AdvancedOptionsStatus

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

フィールド データタイプ 説明
オプション AdvancedOptions Elasticsearch の詳細設定オプションを指定するためのキーと値のペア。
ステータス OptionStatus Amazon ES ドメイン用詳細設定オプションの更新のステータス。

ARN

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

CognitoOptions

フィールド データタイプ 説明
Enabled Boolean 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 ロール。

CognitoOptionsStatus

フィールド データタイプ 説明
Options CognitoOptions Kibana で Amazon Cognito 認証を使用するように Amazon ES を設定するためのキーと値のペア。
Status OptionStatus Amazon ES ドメイン用 Amazon Cognito 設定オプションの更新のステータス。

CreateElasticsearchDomainRequest

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

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

DomainID

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

DomainName

Amazon ES ドメインの名前。

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

DomainNameList

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

データタイプ 説明
文字列配列 次の形式の Amazon ES ドメインの配列:

["<Domain_Name>","<Domain_Name>"...]

EBSOptions

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

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

ElasticsearchClusterConfig

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

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

ElasticsearchDomainConfig

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

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

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 Boolean Amazon ES​ ドメインの作成のステータス。ドメイン作成が完了している場合、True。ドメイン作成が進行中の場合、False。
Deleted Boolean Amazon ES​ ドメインの削除のステータス。ドメイン削除が完了している場合、True。ドメイン削除が進行中の場合、False。
Endpoint ServiceUrl インデックス、検索、データアップロードのリクエストを Amazon ES ドメインに送信するために使用されるドメイン固有のエンドポイント。
Endpoints EndpointsMap Amazon ES ドメインが VPC エンドポイントを使用する場合に存在するキー値ペア。
Processing Boolean Amazon ES​ ドメインの構成変更のステータス。サービスが、まだ構成変更を処理している場合、True。構成変更がアクティブである場合、False。ドメインのステータスがアクティブになるのを待ってから、インデックス、検索、データアップロードのリクエストを送信する必要があります。
ElasticsearchVersion 文字列 Elasticsearch バージョン。
ElasticsearchClusterConfig ElasticsearchClusterConfig Amazon ES ドメインのクラスター設定のコンテナ。
EBSOptions EBSOptions Amazon ES ドメインの EBS ベースのストレージを有効にするために必要な、パラメータのコンテナ。詳細については、「EBS ベースのストレージの設定」を参照してください。
AccessPolicies 文字列 新しい Amazon ES ドメインのアクセスポリシーを指定する IAM ポリシードキュメント。詳細については、「アクセスポリシーの設定」を参照してください。
SnapshotOptions SnapshotOptions 毎日実行される、Amazon ES ドメインのインデックスの自動スナップショットの時刻を設定するために必要なパラメータのコンテナ。
VPCOptions VPCDerivedInfo ドメインの VPCOptions に基づいて Amazon ES が取得する情報。
LogPublishingOptions LogPublishingOptions スローログの発行を設定するためのキーと値のペア。
AdvancedOptions AdvancedOptions 詳細な設定オプションを指定するためのキーと値のペア。
EncryptionAtRestOptions EncryptionAtRestOptions 保管時に暗号化するためのキーと値のペア。
CognitoOptions CognitoOptions Kibana で Amazon Cognito 認証を使用するように Amazon ES を設定するためのキーと値のペア。
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions ノード間の暗号化が有効か無効か。

ElasticsearchDomainStatusList

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

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

EncryptionAtRestOptions

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

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

EncryptionAtRestOptionsStatus

ドメインの保管時の暗号化オプションのステータス。

フィールド データタイプ 説明
Options EncryptionAtRestOptions ドメインの保管時の暗号化オプション。
Status OptionStatus ドメインの保管時の暗号化オプションのステータス。

EndpointsMap

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

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

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

LogPublishingOptionsStatus

Amazon ES ドメインのスローログ発行オプションの設定に対する更新のステータス。

フィールド データタイプ 説明
Options LogPublishingOptions ドメインのログ発行オプション
Status OptionStatus Amazon ES ドメイン用スナップショットオプションの更新のステータス

NodeToNodeEncryptionOptions

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

フィールド データタイプ 説明
Enabled Boolean true で有効化する。​

NodeToNodeEncryptionOptionsStatus

ドメインのノード間の暗号化オプションの状態

フィールド データタイプ 説明
Options NodeToNodeEncryptionOptions ノード間の暗号化が有効か無効か。
Status OptionStatus 設定のステータス。

OptionState

Amazon ES ドメインの詳細オプションの更新のステータス。

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

  • RequiresIndexDocuments

  • Processing

  • アクティブ

OptionStatus

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

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

ServiceSoftwareOptions

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

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

ServiceURL

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

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

SnapshotOptions

Amazon ES ドメインで、毎日実行されるインデックスの自動スナップショットの時刻を設定するために必要なパラメータのコンテナ。

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

SnapshotOptionsStatus

毎日実行される、Amazon ES ドメイン用の自動スナップショットの設定に対する更新のステータス。

フィールド データタイプ 説明
Options SnapshotOptions Amazon ES ドメインで、毎日実行されるインデックスの自動スナップショットの時刻を設定するために必要なパラメータのコンテナ
Status OptionStatus Amazon ES ドメイン用スナップショットオプションの更新のステータス

タグ

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

VPCDerivedInfoStatus

フィールド データタイプ 説明
Options VPCDerivedInfo ドメインの VPCOptions に基づいて Amazon ES が取得する情報。
Status OptionStatus Amazon ES ドメイン用 VPC 設定オプションの更新のステータス。

VPCOptions

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

VPCOptionsStatus

フィールド データタイプ 説明
Options VPCOptions VPC で作業に Amazon ES を設定するために必要な値のコンテナ。
Status OptionStatus Amazon ES ドメイン用 VPC 設定オプションの更新のステータス。

ZoneAwarenessConfig

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

エラー

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

例外 説明
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 が返されます。

このページの内容: