import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeDomainHealthRequest, DescribeDomainHealthResponse } from "../models/models_0"; import type { OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeDomainHealthCommand}. */ export interface DescribeDomainHealthCommandInput extends DescribeDomainHealthRequest { } /** * @public * * The output of {@link DescribeDomainHealthCommand}. */ export interface DescribeDomainHealthCommandOutput extends DescribeDomainHealthResponse, __MetadataBearer { } declare const DescribeDomainHealthCommand_base: { new (input: DescribeDomainHealthCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeDomainHealthCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { OpenSearchClient, DescribeDomainHealthCommand } from "@aws-sdk/client-opensearch"; // ES Modules import * // const { OpenSearchClient, DescribeDomainHealthCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import * // import type { OpenSearchClientConfig } from "@aws-sdk/client-opensearch"; * const config = {}; // type is OpenSearchClientConfig * const client = new OpenSearchClient(config); * const input = { // DescribeDomainHealthRequest * DomainName: "STRING_VALUE", // required * }; * const command = new DescribeDomainHealthCommand(input); * const response = await client.send(command); * // { // DescribeDomainHealthResponse * // DomainState: "Active" || "Processing" || "NotAvailable", * // AvailabilityZoneCount: "STRING_VALUE", * // ActiveAvailabilityZoneCount: "STRING_VALUE", * // StandByAvailabilityZoneCount: "STRING_VALUE", * // DataNodeCount: "STRING_VALUE", * // DedicatedMaster: true || false, * // MasterEligibleNodeCount: "STRING_VALUE", * // WarmNodeCount: "STRING_VALUE", * // MasterNode: "Available" || "UnAvailable", * // ClusterHealth: "Red" || "Yellow" || "Green" || "NotAvailable", * // TotalShards: "STRING_VALUE", * // TotalUnAssignedShards: "STRING_VALUE", * // EnvironmentInformation: [ // EnvironmentInfoList * // { // EnvironmentInfo * // AvailabilityZoneInformation: [ // AvailabilityZoneInfoList * // { // AvailabilityZoneInfo * // AvailabilityZoneName: "STRING_VALUE", * // ZoneStatus: "Active" || "StandBy" || "NotAvailable", * // ConfiguredDataNodeCount: "STRING_VALUE", * // AvailableDataNodeCount: "STRING_VALUE", * // TotalShards: "STRING_VALUE", * // TotalUnAssignedShards: "STRING_VALUE", * // }, * // ], * // }, * // ], * // }; * * ``` * * @param DescribeDomainHealthCommandInput - {@link DescribeDomainHealthCommandInput} * @returns {@link DescribeDomainHealthCommandOutput} * @see {@link DescribeDomainHealthCommandInput} for command's `input` shape. * @see {@link DescribeDomainHealthCommandOutput} for command's `response` shape. * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape. * * @throws {@link BaseException} (client fault) *

An error occurred while processing the request.

* * @throws {@link DisabledOperationException} (client fault) *

An error occured because the client wanted to access an unsupported operation.

* * @throws {@link InternalException} (server fault) *

Request processing failed because of an unknown error, exception, or internal failure.

* * @throws {@link ResourceNotFoundException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link ValidationException} (client fault) *

An exception for accessing or deleting a resource that doesn't exist.

* * @throws {@link OpenSearchServiceException} *

Base exception class for all service exceptions from OpenSearch service.

* * * @public */ export declare class DescribeDomainHealthCommand extends DescribeDomainHealthCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeDomainHealthRequest; output: DescribeDomainHealthResponse; }; sdk: { input: DescribeDomainHealthCommandInput; output: DescribeDomainHealthCommandOutput; }; }; }