Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

DescribeInstanceTypeLimits

Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

Request Syntax


GET /2021-01-01/opensearch/instanceTypeLimits/EngineVersion/InstanceType?domainName=DomainName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DomainName

The name of the domain. Only specify if you need the limits for an existing domain.

Length Constraints: Minimum length of 3. Maximum length of 28.

Pattern: [a-z][a-z0-9\-]+

EngineVersion

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

Length Constraints: Minimum length of 14. Maximum length of 18.

Pattern: ^Elasticsearch_[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$

Required: Yes

InstanceType

The OpenSearch Service instance type for which you need limit information.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "LimitsByRole": { 
      "string" : { 
         "AdditionalLimits": [ 
            { 
               "LimitName": "string",
               "LimitValues": [ "string" ]
            }
         ],
         "InstanceLimits": { 
            "InstanceCountLimits": { 
               "MaximumInstanceCount": number,
               "MinimumInstanceCount": number
            }
         },
         "StorageTypes": [ 
            { 
               "StorageSubTypeName": "string",
               "StorageTypeLimits": [ 
                  { 
                     "LimitName": "string",
                     "LimitValues": [ "string" ]
                  }
               ],
               "StorageTypeName": "string"
            }
         ]
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

LimitsByRole

Map that contains all applicable instance type limits.data refers to data nodes.master refers to dedicated master nodes.

Type: String to Limits object map

Errors

For information about the errors that are common to all actions, see Common Errors.

BaseException

An error occurred while processing the request.

HTTP Status Code: 400

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

InvalidTypeException

An exception for trying to create or access a sub-resource that's either invalid or not supported.

HTTP Status Code: 409

LimitExceededException

An exception for trying to create more than the allowed number of resources or sub-resources.

HTTP Status Code: 409

ResourceNotFoundException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeInstanceTypeLimits.

Sample Request


GET /2021-01-01/opensearch/instanceTypeLimits/OpenSearch_1.0/c5.large.search?domainName=mydomain HTTP/1.1
Host: es.us-east-1.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.15.0 Python/3.11.6 Darwin/23.2.0 exe/x86_64 prompt/off command/opensearch.describe-instance-type-limits
X-Amz-Date: 20240118T183818Z
X-Amz-Security-Token: IQoJb3JpZ2luX2VjEI3wEaCXVz==
Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240118/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=b8e8474eba198ee0a30b422c5196860943c1ed944a599160aa070268db1c17fa

Sample Response


{
	"LimitsByRole": {
		"data": {
			"AdditionalLimits": [{
				"LimitName": "MaximumNumberOfDataNodesWithoutMasterNode",
				"LimitValues": ["10"]
			}],
			"InstanceLimits": {
				"InstanceCountLimits": {
					"MaximumInstanceCount": 80,
					"MinimumInstanceCount": 1
				}
			},
			"StorageTypes": [{
				"StorageSubTypeName": "standard",
				"StorageTypeLimits": [{
					"LimitName": "MaximumVolumeSize",
					"LimitValues": ["100"]
				}, {
					"LimitName": "MinimumVolumeSize",
					"LimitValues": ["10"]
				}],
				"StorageTypeName": "ebs"
			}, {
				"StorageSubTypeName": "io1",
				"StorageTypeLimits": [{
					"LimitName": "MaximumVolumeSize",
					"LimitValues": ["256"]
				}, {
					"LimitName": "MinimumVolumeSize",
					"LimitValues": ["35"]
				}, {
					"LimitName": "MaximumIops",
					"LimitValues": ["16000"]
				}, {
					"LimitName": "MinimumIops",
					"LimitValues": ["1000"]
				}],
				"StorageTypeName": "ebs"
			}, {
				"StorageSubTypeName": "gp2",
				"StorageTypeLimits": [{
					"LimitName": "MaximumVolumeSize",
					"LimitValues": ["256"]
				}, {
					"LimitName": "MinimumVolumeSize",
					"LimitValues": ["10"]
				}],
				"StorageTypeName": "ebs"
			}, {
				"StorageSubTypeName": "gp3",
				"StorageTypeLimits": [{
					"LimitName": "MaximumVolumeSize",
					"LimitValues": ["256"]
				}, {
					"LimitName": "MinimumVolumeSize",
					"LimitValues": ["10"]
				}, {
					"LimitName": "MaximumIops",
					"LimitValues": ["20000"]
				}, {
					"LimitName": "MinimumIops",
					"LimitValues": ["3000"]
				}, {
					"LimitName": "MaximumThroughput",
					"LimitValues": ["593"]
				}, {
					"LimitName": "MinimumThroughput",
					"LimitValues": ["125"]
				}],
				"StorageTypeName": "ebs"
			}]
		},
		"master": {
			"AdditionalLimits": [{
				"LimitName": "MaximumNumberOfDataNodesSupported",
				"LimitValues": ["200"]
			}],
			"InstanceLimits": {
				"InstanceCountLimits": {
					"MaximumInstanceCount": 5,
					"MinimumInstanceCount": 2
				}
			},
			"StorageTypes": null
		}
	}
}