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

The Amazon Elasticsearch Service multi-region endpoint

GET

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

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'http://es.{region}.amazonaws.com/2015-01-01/es/instanceTypeLimits//'

Response Example

200 - Example 1

{
  "LimitsByRole": {
    "property1": {
      "StorageTypes": [],
      "InstanceLimits": {
        "InstanceCountLimits": {
          "MinimumInstanceCount": 0,
          "MaximumInstanceCount": 0
        }
      },
      "AdditionalLimits": []
    }
  }
}

Request

Path Params

InstanceType

string

required

The instance type for an Elasticsearch cluster for which Elasticsearch Limits are needed.

ElasticsearchVersion

string

required

Version of Elasticsearch for which Limits are needed.

Query Params

domainName

string

optional

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

Responses

🟢200Success

application/json

Body

Container for the parameters received from <code> <a>DescribeElasticsearchInstanceTypeLimits</a> </code> operation.

LimitsByRole

object (LimitsByRole)

optional

Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following:

data: If the given InstanceType is used as data node
master: If the given InstanceType is used as master node
ultra_warm: If the given InstanceType is used as warm node

Additional properties

object (Limits)

optional

Limits for given InstanceType and for each of it's role.
Limits contains following StorageTypes, InstanceLimits and AdditionalLimits

🟠480BaseException

🟠481InternalException

🟠482InvalidTypeException

🟠483LimitExceededException

🟠484ResourceNotFoundException

🟠485ValidationException

Modified at 2023-08-15 04:15:53

/2015-01-01/es/domain-info

/2015-01-01/es/ccs/inboundConnection/search