Skip to content
AWS for Query.Farm

aws.opensearch.describe_instance_type_limits

Example SQL Queries

SELECT * FROM
aws.opensearch.describe_instance_type_limits
WHERE
"instance_type" = 'VALUE'
AND "engine_version" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
engine_version Required Input Column

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

VARCHAR
instance_type Required Input Column

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

VARCHAR
domain_name Input Column

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

VARCHAR
_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.

limits_by_role

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

MAP(VARCHAR, STRUCT(
        "storage_types" STRUCT(
            "storage_type_name" VARCHAR,
            "storage_sub_type_name" VARCHAR,
            "storage_type_limits" STRUCT(
                "limit_name" VARCHAR,
                "limit_values" VARCHAR[]
            )[]
        )[],
        "instance_limits" STRUCT(
            "instance_count_limits" STRUCT(
                "minimum_instance_count" BIGINT,
                "maximum_instance_count" BIGINT
            )
        ),
        "additional_limits" STRUCT(
            "limit_name" VARCHAR,
            "limit_values" VARCHAR[]
        )[]
    ))