Skip to content
AWS for Query.Farm

aws.opensearch.list_instance_type_details

Example SQL Queries

SELECT * FROM
aws.opensearch.list_instance_type_details
WHERE
"engine_version" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
engine_version Required Input Column

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

VARCHAR
domain_name Input Column

The name of the domain.

VARCHAR
instance_type Input Column

An optional parameter that lists information for a given instance type.

VARCHAR
max_results Input Column

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

BIGINT
next_token Input Column

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

VARCHAR
retrieve_a_zs Input Column

An optional parameter that specifies the Availability Zones for the domain.

BOOLEAN
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

instance_type_details

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

STRUCT(
    "instance_type" VARCHAR,
    "encryption_enabled" BOOLEAN,
    "cognito_enabled" BOOLEAN,
    "app_logs_enabled" BOOLEAN,
    "advanced_security_enabled" BOOLEAN,
    "warm_enabled" BOOLEAN,
    "instance_role" VARCHAR[],
    "availability_zones" VARCHAR[]
)[]
Show child fields
instance_type_details[]
Show child fields
instance_type_details[].advanced_security_enabled

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

instance_type_details[].app_logs_enabled

Whether logging is supported for the instance type.

instance_type_details[].availability_zones[]
instance_type_details[].cognito_enabled

Whether Amazon Cognito access is supported for the instance type.

instance_type_details[].encryption_enabled

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

instance_type_details[].instance_role[]
instance_type_details[].instance_type

The instance type.

instance_type_details[].warm_enabled

Whether UltraWarm is supported for the instance type.