Skip to content
AWS for Query.Farm

aws.opensearch.describe_domain_nodes

Example SQL Queries

SELECT * FROM
aws.opensearch.describe_domain_nodes
WHERE
"domain_name" = 'VALUE';

Description

Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

Table Definition

Column NameColumn Data Type
domain_name Required Input Column

The name of the 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.

domain_nodes_status_list

Contains nodes information list DomainNodesStatusList with details about the all nodes on the requested domain.

STRUCT(
    "node_id" VARCHAR,
    "node_type" VARCHAR,
    "availability_zone" VARCHAR,
    "instance_type" VARCHAR,
    "node_status" VARCHAR,
    "storage_type" VARCHAR,
    "storage_volume_type" VARCHAR,
    "storage_size" VARCHAR
)[]
Show child fields
domain_nodes_status_list[]
Show child fields
domain_nodes_status_list[].availability_zone

The Availability Zone of the node.

domain_nodes_status_list[].instance_type

The instance type information of the node.

domain_nodes_status_list[].node_id

The ID of the node.

domain_nodes_status_list[].node_status

Indicates if the node is active or in standby.

domain_nodes_status_list[].node_type

Indicates whether the nodes is a data, master, or ultrawarm node.

domain_nodes_status_list[].storage_size

The storage size of the node, in GiB.

domain_nodes_status_list[].storage_type

Indicates if the node has EBS or instance storage.

domain_nodes_status_list[].storage_volume_type

If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. Only applicable for data nodes.