Skip to content

aws.opensearch.describe_domain_health

Example SQL Queries

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

Description

Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

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.

active_availability_zone_count

The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

VARCHAR
availability_zone_count

The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

VARCHAR
cluster_health

The current health status of your cluster.

  • Red - At least one primary shard is not allocated to any node.

  • Yellow - All primary shards are allocated to nodes, but some replicas aren’t.

  • Green - All primary shards and their replicas are allocated to nodes.

  • NotAvailable - Unable to retrieve cluster health.

VARCHAR
data_node_count

The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

VARCHAR
dedicated_master

A boolean that indicates if dedicated master nodes are activated for the domain.

BOOLEAN
domain_state

The current state of the domain.

  • Processing - The domain has updates in progress.

  • Active - Requested changes have been processed and deployed to the domain.

VARCHAR
environment_information

A list of EnvironmentInfo for the domain.

STRUCT(
"availability_zone_information" STRUCT(
"availability_zone_name" VARCHAR,
"zone_status" VARCHAR,
"configured_data_node_count" VARCHAR,
"available_data_node_count" VARCHAR,
"total_shards" VARCHAR,
"total_un_assigned_shards" VARCHAR
)[]
)[]
Show child fields
environment_information[]
Show child fields
environment_information[].availability_zone_information[]
Show child fields
environment_information[].availability_zone_information[].availability_zone_name

The name of the Availability Zone.

environment_information[].availability_zone_information[].available_data_node_count

The number of data nodes active in the Availability Zone.

environment_information[].availability_zone_information[].configured_data_node_count

The total number of data nodes configured in the Availability Zone.

environment_information[].availability_zone_information[].total_shards

The total number of primary and replica shards in the Availability Zone.

environment_information[].availability_zone_information[].total_un_assigned_shards

The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.

environment_information[].availability_zone_information[].zone_status

The current state of the Availability Zone. Current options are Active and StandBy.

  • Active - Data nodes in the Availability Zone are in use.

  • StandBy - Data nodes in the Availability Zone are in a standby state.

  • NotAvailable - Unable to retrieve information.

master_eligible_node_count

The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

VARCHAR
master_node

Indicates whether the domain has an elected master node.

  • Available - The domain has an elected master node.

  • UnAvailable - The master node hasn't yet been elected, and a quorum to elect a new master node hasn't been reached.

VARCHAR
stand_by_availability_zone_count

The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

VARCHAR
total_shards

The total number of primary and replica shards for the domain.

VARCHAR
total_un_assigned_shards

The total number of primary and replica shards not allocated to any of the nodes for the cluster.

VARCHAR
warm_node_count

The number of warm nodes configured for the domain.

VARCHAR