ElasticsearchService / Client / list_elasticsearch_instance_types

list_elasticsearch_instance_types#

ElasticsearchService.Client.list_elasticsearch_instance_types(**kwargs)#

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

See also: AWS API Documentation

Request Syntax

response = client.list_elasticsearch_instance_types(
    ElasticsearchVersion='string',
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • ElasticsearchVersion (string) –

    [REQUIRED]

    Version of Elasticsearch for which list of supported elasticsearch instance types are needed.

  • DomainName (string) – DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.

  • MaxResults (integer) – Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.

  • NextToken (string) – NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

Return type:

dict

Returns:

Response Syntax

{
    'ElasticsearchInstanceTypes': [
        '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',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Container for the parameters returned by ListElasticsearchInstanceTypes operation.

    • ElasticsearchInstanceTypes (list) –

      List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion

      • (string) –

    • NextToken (string) –

      In case if there are more results available NextToken would be present, make further request to the same API with received NextToken to paginate remaining results.

Exceptions