Amazon Elasticsearch Service
개발자 가이드 (API 버전 2015-01-01)

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 서명 프로세스 단원을 참조하십시오.

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 도메인의 ARN(Amazon 리소스 이름)입니다.

응답 요소

해당 사항 없음. AddTags 작업이 데이터 구조를 반환하지 않습니다.

오류

AddTags 작업은 다음 오류 중 하나를 반환할 수 있습니다.

다음 예에서는 태그 키가 project인 리소스 태그 하나를 logs Amazon ES 도메인에 연결합니다.

요청

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 }, "DomainEndpointOptions": { "EnforceHTTPS": true|false, “TLSSecurityPolicy”: "<Policy-Min-TLS-1-2-2019-07|Policy-Min-TLS-1-0-2019-07>" } }

요청 파라미터

이 작업은 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 아니요

(사용되지 않음) Elasticsearch 5.3 이상을 실행하는 도메인의 경우 Amazon ES는 시간별 자동 스냅샷을 생성하므로 이 설정이 무의미합니다.

이전 버전의 Elasticsearch를 실행하는 도메인의 경우 Amazon ES는 일별 자동 스냅샷을 생성합니다. 이 값은 서비스에서 스냅샷을 생성하려는 시간에 대한 컨테이너 역할을 수행합니다.

AdvancedOptions AdvancedOptions 아니요 고급 구성 옵션을 지정하는 키-값 페어입니다. 자세한 내용은 고급 옵션 구성을 참조하십시오.
LogPublishingOptions LogPublishingOptions 아니요 로그 게시를 느리게 구성하는 키-값 페어입니다.
EncryptionAtRestOptions EncryptionAtRestOptions 아니요 유휴 시 암호화를 활성화하는 키-값 페어입니다.
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions 아니요 노드 간 암호화를 활성화합니다.
DomainEndpointOptions DomainEndpointOptions 아니요 모든 트래픽에 HTTPS를 요구하도록 할지 여부와 같은 도메인 엔드포인터에 대한 추가 옵션입니다.

응답 요소

필드 데이터 형식 설명
DomainStatus ElasticsearchDomainStatus 새 Amazon ES 도메인의 상태 및 구성을 지정합니다.

오류

CreateElasticsearchDomain은 다음 오류 중 하나를 반환할 수 있습니다.

이 예제에서는 다음 작업을 설명합니다.

  • streaming-logs라는 Amazon ES 도메인을 만듭니다.

  • 6개의 데이터 노드(i3.large)와 3개의 전용 마스터 노드(c4.large)가 있는 클러스터를 만듭니다.

  • 여러 가용 영역을 사용할 수 있습니다.

  • 도메인의 VPC 액세스를 구성합니다.

  • 유휴 암호화와 노드 간 암호화를 활성화합니다.

  • 도메인에 대한 모든 요청에 HTTPS를 요구합니다.

요청

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" ] }, "DomainEndpointOptions": { "EnforceHTTPS": true, "TLSSecurityPolicy": "Policy-Min-TLS-1-2-2019-07" } }

응답

{ "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, "DomainEndpointOptions": { "EnforceHTTPS": true, "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07" }, "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 간 서비스 연결 역할을 삭제합니다. 이 역할은 Amazon ES에게 VPC 엔드포인트를 VPC에 배치할 권한을 부여합니다. 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, "DomainEndpointOptions": { "EnforceHTTPS": true, "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07" }, "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 작업은 다음 오류 중 하나를 반환할 수 있습니다.

다음 예에서는 logsstreaming-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 Map 적용 가능한 모든 인스턴스 한도를 포함한 맵입니다. "data"는 데이터 노드를 의미합니다. "master"는 전용 마스터 노드를 의미합니다.

오류

DescribeElasticsearchInstanceTypeLimits 작업은 다음 오류 중 하나를 반환할 수 있습니다.

다음 예에서는 logsstreaming-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을 포함한 결과를 생성한 경우에만 필요합니다. next-token 입력을 받아 다음 페이지의 결과를 반환하고 응답에 next-token 출력을 제공하여 클라이언트가 더 많은 결과를 가져오는 데 사용할 수 있습니다.

요청 본문

이 작업은 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을 포함한 결과를 생성한 경우에만 필요합니다. next-token 입력을 받아 다음 페이지의 결과를 반환하고 응답에 next-token 출력을 제공하여 클라이언트가 더 많은 결과를 가져오는 데 사용할 수 있습니다.

요청 본문

이 작업은 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을 포함한 결과를 생성한 경우에만 필요합니다. next-token 입력을 받아 다음 페이지의 결과를 반환하고 응답에 next-token 출력을 제공하여 클라이언트가 더 많은 결과를 가져오는 데 사용할 수 있습니다.

요청 본문

이 작업은 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을 포함한 결과를 생성한 경우에만 필요합니다. next-token 입력을 받아 다음 페이지의 결과를 반환하고 응답에 next-token 출력을 제공하여 클라이언트가 더 많은 결과를 가져오는 데 사용할 수 있습니다.

요청 본문

이 작업은 HTTP 요청 본문을 사용하지 않습니다.

응답 요소

필드 데이터 형식 설명
ElasticsearchInstanceTypes List 지정된 Elasticsearch 버전에서 지원되는 모든 인스턴스 유형 목록과 본 인스턴스 유형이 지원하는 기능
NextToken String

페이지 매김에 사용됩니다. 이전 API 호출이 NextToken을 포함한 결과를 생성한 경우에만 필요합니다. next-token 입력을 받아 다음 페이지의 결과를 반환하고 응답에 next-token 출력을 제공하여 클라이언트가 더 많은 결과를 가져오는 데 사용할 수 있습니다.

오류

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을 포함한 결과를 생성한 경우에만 필요합니다. next-token 입력을 받아 다음 페이지의 결과를 반환하고 응답에 next-token 출력을 제공하여 클라이언트가 더 많은 결과를 가져오는 데 사용할 수 있습니다.

요청 본문

이 작업은 HTTP 요청 본문을 사용하지 않습니다.

응답 요소

필드 데이터 형식 설명
ElasticsearchInstanceTypes List 지정된 Elasticsearch 버전을 지원하는 인스턴스 유형 목록입니다.
NextToken String

페이지 매김에 사용됩니다. 이전 API 호출이 NextToken을 포함한 결과를 생성한 경우에만 필요합니다. next-token 입력을 받아 다음 페이지의 결과를 반환하고 응답에 next-token 출력을 제공하여 클라이언트가 더 많은 결과를 가져오는 데 사용할 수 있습니다.

오류

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을 포함한 결과를 생성한 경우에만 필요합니다. next-token 입력을 받아 다음 페이지의 결과를 반환하고 응답에 next-token 출력을 제공하여 클라이언트가 더 많은 결과를 가져오는 데 사용할 수 있습니다.

요청 본문

이 작업은 HTTP 요청 본문을 사용하지 않습니다.

응답 요소

필드 데이터 형식 설명
ElasticsearchVersions List 지원되는 모든 Elasticsearch 버전을 나열합니다.
NextToken String

페이지 매김에 사용됩니다. 이전 API 호출이 NextToken을 포함한 결과를 생성한 경우에만 필요합니다. next-token 입력을 받아 다음 페이지의 결과를 반환하고 응답에 next-token 출력을 제공하여 클라이언트가 더 많은 결과를 가져오는 데 사용할 수 있습니다.

오류

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" } ] }

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.

오류

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 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 개체에 대한 식별자 단원을 참조하십시오.
TagKeys TagKey Amazon ES 도메인에서 제거하려는 리소스 태그의 태그 키 목록입니다.

응답 요소

해당 사항 없음 RemoveTags 작업은 응답 요소를 반환하지 않습니다.

오류

RemoveTags 작업은 다음 오류 중 하나를 반환할 수 있습니다.

다음 예에서는 태그 키가 project인 리소스 태그를 Amazon ES 도메인에서 삭제합니다.

요청

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 도메인에 대해 예약된 서비스 소프트웨어 업데이트를 중단합니다. 도메인의 UpdateStatusPENDING_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 } }, "DomainEndpointOptions": { "EnforceHTTPS": true|false, "TLSSecurityPolicy": "<Policy-Min-TLS-1-2-2019-07|Policy-Min-TLS-1-0-2019-07>" } }

요청 파라미터

이 작업은 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를 구성할 키-값 페어.
DomainEndpointOptions DomainEndpointOptions 아니요 모든 트래픽에 HTTPS를 요구하도록 할지 여부와 같은 도메인 엔드포인터에 대한 추가 옵션입니다.

응답 요소

필드 데이터 형식 설명
DomainConfig 문자열 구성을 업데이트한 후 Amazon ES 도메인의 상태입니다.

오류

UpdateElasticsearchDomainConfig은 다음 오류 중 하나를 반환할 수 있습니다.

다음 예제에서는 c5.xlarge.elasticsearch 인스턴스를 사용하도록 streaming-logs 도메인을 다시 구성합니다.

요청

POST es.us-west-1.amazonaws.com/2015-01-01/es/domain/streaming-logs/config { "ElasticsearchClusterConfig": { "InstanceType": "c5.xlarge.elasticsearch" } }

응답

{ "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": 1537308535.899, "PendingDeletion": false, "State": "Active", "UpdateDate": 1554745087.482, "UpdateVersion": 121 } }, "AdvancedOptions": { "Options": { "rest.action.multi.allow_explicit_index": "true" }, "Status": { "CreationDate": 1537308535.899, "PendingDeletion": false, "State": "Active", "UpdateDate": 1537309172.772, "UpdateVersion": 6 } }, "DomainEndpointOptions": { "Options": { "EnforceHTTPS": true, "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07" }, "Status": { "CreationDate": 1.569354204794E9, "PendingDeletion": false, "State": "Active", "UpdateDate": 1.569354684093E9, "UpdateVersion": 6 } }, "EBSOptions": { "Options": { "EBSEnabled": true, "Iops": null, "VolumeSize": 10, "VolumeType": "gp2" }, "Status": { "CreationDate": 1537308535.899, "PendingDeletion": false, "State": "Active", "UpdateDate": 1537309172.772, "UpdateVersion": 6 } }, "ElasticsearchClusterConfig": { "Options": { "DedicatedMasterCount": 3, "DedicatedMasterEnabled": true, "DedicatedMasterType": "c5.large.elasticsearch", "InstanceCount": 3, "InstanceType": "c5.xlarge.elasticsearch", "ZoneAwarenessConfig": { "AvailabilityZoneCount": 3 }, "ZoneAwarenessEnabled": true }, "Status": { "CreationDate": 1537308535.899, "PendingDeletion": false, "State": "Processing", "UpdateDate": 1562008396.658, "UpdateVersion": 148 } }, "ElasticsearchVersion": { "Options": "6.7", "Status": { "CreationDate": 1537308535.899, "PendingDeletion": false, "State": "Active", "UpdateDate": 1559159251.094, "UpdateVersion": 141 } }, "EncryptionAtRestOptions": { "Options": { "Enabled": true, "KmsKeyId": "arn:aws:kms:us-west-1:123456789012:key/1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a" }, "Status": { "CreationDate": 1537308535.899, "PendingDeletion": false, "State": "Active", "UpdateDate": 1537309172.772, "UpdateVersion": 6 } }, "NodeToNodeEncryptionOptions": { "Options": { "Enabled": true }, "Status": { "CreationDate": 1537308535.899, "PendingDeletion": false, "State": "Active", "UpdateDate": 1537309172.772, "UpdateVersion": 6 } }, "VPCOptions": { "Options": { "AvailabilityZones": null, "SecurityGroupIds": null, "SubnetIds": null, "VPCId": null }, "Status": { "CreationDate": 1562008396.78, "PendingDeletion": false, "State": "Active", "UpdateDate": 1562008396.78, "UpdateVersion": 148 } } } }

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 부울 아니요 기본값은 false입니다. true일 경우, Amazon ES가 도메인의 자격을 확인하지만 업그레이드를 수행하지는 않습니다.

응답 요소

필드 데이터 형식 설명
UpgradeElasticsearchDomainResponse Map 작업 세부 정보를 확인하는 기본 응답입니다.

오류

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 기반 액세스 제어 단원을 참조하십시오. 하위 리소스에 대한 액세스 정책에 관한 자세한 내용은 액세스 정책 구성을 참조하십시오.
indices.fielddata.cache.size 키-값 페어:

indices.fielddata.cache.size=<percentage_of_heap>

필드 데이터에 할당되는 Java 힙 공간의 백분율을 지정합니다. 기본적으로 이 설정은 무한입니다.
indices.query.bool.max_clause_count 키-값 페어:

indices.query.bool.max_clause_count=<int>

Lucene 부울 쿼리 하나에 허용되는 최대 절 수를 지정합니다. 기본값은 1024입니다. 절 수가 허용되는 개수 이상인 쿼리는 TooManyClauses 오류를 일으킵니다. 자세한 내용은 Lucene 설명서 단원을 참조하십시오.

AdvancedOptionsStatus

Amazon ES 도메인의 고급 구성 옵션에 대한 업데이트 상태입니다.

필드 데이터 형식 설명
Options AdvancedOptions 고급 Elasticsearch 구성 옵션을 지정하는 키-값 페어입니다.
Status 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.
RoleArn 문자열 Amazon ES에서 사용자 풀과 자격 증명 풀의 구성을 허용하는 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 정책 문서입니다. 자세한 내용은 액세스 정책 구성을 참조하십시오.
DomainEndpointOptions DomainEndpointOptions 모든 트래픽에 HTTPS를 요구하도록 할지 여부와 같은 도메인 엔드포인터에 대한 추가 옵션입니다.
SnapshotOptions SnapshotOptions (사용되지 않음) 도메인 인덱스의 자동 스냅샷을 구성하는 데 필요한 파라미터의 컨테이너입니다.
VPCOptions VPCOptions VPC에서 사용할 Amazon ES를 구성하는 데 필요한 값을 저장하는 컨테이너입니다.
LogPublishingOptions LogPublishingOptions 로그 게시를 느리게 구성하는 키-값 페어입니다.
AdvancedOptions AdvancedOptionsStatus 고급 구성 옵션을 지정하는 키-값 페어입니다.
CognitoOptions CognitoOptions Kibana에 Amazon Cognito 인증을 사용하도록 Amazon ES를 구성할 키-값 페어.
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions 노드 간 암호화를 활성화하기 위해 true를 지정합니다.

DomainEndpointOptions

Field 데이터 형식 설명
EnforceHTTPS 부울 True로 설정하면 도메인에 대한 모든 트랙픽이 HTTPS를 통해 도착해야 합니다.
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>"...]

EBSOptions

Amazon ES 도메인에 EBS 기반 스토리지를 사용하도록 하는 데 필요한 매개변수의 컨테이너입니다. 자세한 내용은 EBS 기반 스토리지 구성을 참조하십시오.

필드 데이터 형식 설명
EBSEnabled 부울(Boolean) Amazon ES 도메인의 데이터 노드에 EBS 볼륨을 연결할지 여부를 지정합니다.
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 영역 인식 구성 옵션을 위한 컨테이너입니다. ZoneAwarenessEnabledtrue일 경우에만 필수입니다.

ElasticsearchDomainConfig

Amazon ES 도메인의 구성을 위한 컨테이너입니다.

필드 데이터 형식 설명
ElasticsearchVersion 문자열 Elasticsearch 버전입니다.
ElasticsearchClusterConfig ElasticsearchClusterConfig Amazon ES 도메인의 클러스터 구성을 위한 컨테이너입니다.
EBSOptions EBSOptions Amazon ES 도메인에 대해 구성된 EBS 옵션을 위한 컨테이너입니다.
AccessPolicies 문자열 Amazon ES 도메인에 대한 액세스 정책을 지정합니다. 자세한 내용은 액세스 정책 구성을 참조하십시오.
SnapshotOptions SnapshotOptions (사용되지 않음) 서비스가 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 개체에 대한 식별자 단원을 참조하십시오.
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 Amazon ES가 도메인의 VPCOptions를 기반으로 도출하는 정보입니다.
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 도메인이 Amazon CloudWatch에 Elasticsearch 애플리케이션 및 느린 로그를 게시할지 여부를 지정합니다. Elasticsearch REST API를 사용하는 느린 로그 모음을 계속 활성화해야 합니다. 자세한 내용은 느린 로그에 대한 Elasticsearch 로깅 임계값 설정 단원을 참조하십시오.

필드 데이터 형식 설명
INDEX_SLOW_LOGS 키-값

CloudWatch 로그 그룹 및 Elasticsearch의 인덱스 느린 로그 여부를 정의하는 두 개의 키-값 페어는 다음 위치에 게시되어야 합니다.

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

CloudWatch 로그 그룹 및 Elasticsearch 검색 느린 로그 여부를 정의하는 두 개의 키-값 페어는 다음 위치에 게시되어야 합니다.

"CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group:sample-domain", "Enabled":true
ES_APPLICATION_LOGS 키-값 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개 중 하나:
  • RequiresIndexDocuments

  • 처리 중

  • 활성 상태

OptionStatus

Amazon ES 도메인의 구성 옵션에 대한 업데이트 상태입니다.

필드 데이터 형식 설명
CreationDate 타임스탬프 Amazon ES 도메인이 생성된 날짜와 시간
UpdateDate 타임스탬프 Amazon ES 도메인이 업데이트된 날짜와 시간
UpdateVersion 정수 개체의 최신 버전을 지정하는 정수
State OptionState Amazon ES 도메인의 구성 옵션에 대한 업데이트 상태
PendingDeletion 부울(Boolean) 서비스가 Amazon ES 도메인 및 도메인의 모든 리소스를 영구히 삭제하기 위한 요청을 처리 중인지 여부를 나타냅니다.

ServiceSoftwareOptions

최신 서비스 소프트웨어와 관련된 도메인 상태에 대한 컨테이너입니다.

필드 데이터 형식 설명
UpdateAvailable 부울(Boolean) 도메인에 대해 서비스 소프트웨어 업데이트를 사용할 수 있는지 여부입니다.
Cancellable 부울(Boolean) 도메인 업데이트를 요청한 경우 업데이트를 취소할 수 있는지 여부입니다.
AutomatedUpdateDate Timestamp 배포 창이 닫히는 Epoch 시간입니다. 이 시간 후 Amazon ES는 소프트웨어 업그레이드 일정을 자동으로 예약합니다.
UpdateStatus 문자열 업데이트의 상태입니다. 값은 ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, NOT_ELIGIBLE입니다.
Description 문자열 상태에 대한 자세한 설명입니다.
CurrentVersion 문자열 현재 서비스 소프트웨어 버전입니다.
NewVersion 문자열 최신 서비스 소프트웨어 버전입니다.

ServiceURL

Amazon ES 도메인으로 인덱스, 검색 및 데이터 업로드 요청을 제출하는 데 사용되는 도메인별 엔드포인트입니다.

필드 데이터 형식 설명
ServiceURL 문자열 Amazon ES 도메인으로 인덱스, 검색 및 데이터 업로드 요청을 제출하는 데 사용되는 도메인별 엔드포인트입니다.

SnapshotOptions

(사용되지 않음) Amazon Elasticsearch Service 인덱스 스냅샷 작업 단원을 참조하십시오. Amazon ES 도메인 인덱스의 일일 자동 스냅샷 생성 시간을 구성하는 데 필요한 파라미터의 컨테이너입니다.

Field 데이터 형식 설명
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의 태그 세트에 키-값 페어가 있을 수 있습니다.

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 Amazon ES가 도메인의 VPCOptions를 기반으로 도출하는 정보입니다.
Status OptionStatus Amazon ES 도메인의 VPC 구성 옵션에 대한 업데이트 상태입니다.

VPCOptions

필드 데이터 형식 설명
SubnetIds StringList 도메인의 VPC 엔드포인트와 연결된 서브넷 ID의 목록입니다. 도메인에서 여러 가용 영역으르 사용할 경우 영역당 2개의 서브넷 ID를 제공해야 합니다. 그렇지 않은 경우 하나만 제공합니다. 자세한 내용은 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 개수입니다. 유효 값은 23입니다.

오류

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을 반환합니다.

이 페이지에서: