Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1450331268.9 KB

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the <code> <a>DomainName</a> </code> to know what Limits are supported for modifying.

get/2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}

Path parameters

InstanceType'm3.medium.elasticsearch' | 'm3.large.elasticsearch' | 'm3.xlarge.elasticsearch' | 'm3.2xlarge.elasticsearch' | 'm4.large.elasticsearch' | 'm4.xlarge.elasticsearch' | 'm4.2xlarge.elasticsearch' | 'm4.4xlarge.elasticsearch' | 'm4.10xlarge.elasticsearch' | 'm5.large.elasticsearch' | 'm5.xlarge.elasticsearch' | 'm5.2xlarge.elasticsearch' | 'm5.4xlarge.elasticsearch' | 'm5.12xlarge.elasticsearch' | 'r5.large.elasticsearch' | 'r5.xlarge.elasticsearch' | 'r5.2xlarge.elasticsearch' | 'r5.4xlarge.elasticsearch' | 'r5.12xlarge.elasticsearch' | 'c5.large.elasticsearch' | 'c5.xlarge.elasticsearch' | 'c5.2xlarge.elasticsearch' | 'c5.4xlarge.elasticsearch' | 'c5.9xlarge.elasticsearch' | 'c5.18xlarge.elasticsearch' | 'ultrawarm1.medium.elasticsearch' | 'ultrawarm1.large.elasticsearch' | 't2.micro.elasticsearch' | 't2.small.elasticsearch' | 't2.medium.elasticsearch' | 'r3.large.elasticsearch' | 'r3.xlarge.elasticsearch' | 'r3.2xlarge.elasticsearch' | 'r3.4xlarge.elasticsearch' | 'r3.8xlarge.elasticsearch' | 'i2.xlarge.elasticsearch' | 'i2.2xlarge.elasticsearch' | 'd2.xlarge.elasticsearch' | 'd2.2xlarge.elasticsearch' | 'd2.4xlarge.elasticsearch' | 'd2.8xlarge.elasticsearch' | 'c4.large.elasticsearch' | 'c4.xlarge.elasticsearch' | 'c4.2xlarge.elasticsearch' | 'c4.4xlarge.elasticsearch' | 'c4.8xlarge.elasticsearch' | 'r4.large.elasticsearch' | 'r4.xlarge.elasticsearch' | 'r4.2xlarge.elasticsearch' | 'r4.4xlarge.elasticsearch' | 'r4.8xlarge.elasticsearch' | 'r4.16xlarge.elasticsearch' | 'i3.large.elasticsearch' | 'i3.xlarge.elasticsearch' | 'i3.2xlarge.elasticsearch' | 'i3.4xlarge.elasticsearch' | 'i3.8xlarge.elasticsearch' | 'i3.16xlarge.elasticsearch' required

The instance type for an Elasticsearch cluster for which Elasticsearch <code> <a>Limits</a> </code> are needed.

ElasticsearchVersionstring required

Version of Elasticsearch for which <code> <a>Limits</a> </code> are needed.

Query parameters

domainNamestring

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch <code> <a>Limits</a> </code> for existing domain.

Response

Success

LimitsByRoleLimitsByRole

Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following: <ul> <li>data: If the given InstanceType is used as data node</li> <li>master: If the given InstanceType is used as master node</li> <li>ultra_warm: If the given InstanceType is used as warm node</li> </ul>