list_instance_type_details

OpenSearchService.Client.list_instance_type_details(**kwargs)

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

See also: AWS API Documentation

Request Syntax

response = client.list_instance_type_details(
    EngineVersion='string',
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)

Parameters

• EngineVersion (string) --

  [REQUIRED]

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

• DomainName (string) -- Name of the domain to list instance type details for.
• MaxResults (integer) -- An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
• NextToken (string) -- If your initial ListInstanceTypeDetails operation returns a nextToken , you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.

Return type

dict

Returns

Response Syntax

{
    'InstanceTypeDetails': [
        {
            'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'EncryptionEnabled': True|False,
            'CognitoEnabled': True|False,
            'AppLogsEnabled': True|False,
            'AdvancedSecurityEnabled': True|False,
            'WarmEnabled': True|False,
            'InstanceRole': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • InstanceTypeDetails (list) --

    Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.

    • (dict) --

      Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

      • InstanceType (string) --

        The instance type.

      • EncryptionEnabled (boolean) --

        Whether encryption at rest and node-to-node encryption are supported for the instance type.

      • CognitoEnabled (boolean) --

        Whether Amazon Cognito access is supported for the instance type.

      • AppLogsEnabled (boolean) --

        Whether logging is supported for the instance type.

      • AdvancedSecurityEnabled (boolean) --

        Whether fine-grained access control is supported for the instance type.

      • WarmEnabled (boolean) --

        Whether UltraWarm is supported for the instance type.

      • InstanceRole (list) --

        Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.

        • (string) --

  • NextToken (string) --

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Exceptions

• OpenSearchService.Client.exceptions.BaseException
• OpenSearchService.Client.exceptions.InternalException
• OpenSearchService.Client.exceptions.ResourceNotFoundException
• OpenSearchService.Client.exceptions.ValidationException