import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetInstancesHealthStatusRequest, GetInstancesHealthStatusResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link GetInstancesHealthStatusCommand}. */ export interface GetInstancesHealthStatusCommandInput extends GetInstancesHealthStatusRequest { } /** * @public * * The output of {@link GetInstancesHealthStatusCommand}. */ export interface GetInstancesHealthStatusCommandOutput extends GetInstancesHealthStatusResponse, __MetadataBearer { } declare const GetInstancesHealthStatusCommand_base: { new (input: GetInstancesHealthStatusCommandInput): import("@smithy/core/client").CommandImpl; new (input: GetInstancesHealthStatusCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Gets the current health status (Healthy, Unhealthy, or * Unknown) of one or more instances that are associated with a specified * service.

* *

There's a brief delay between when you register an instance and when the health status for * the instance is available.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ServiceDiscoveryClient, GetInstancesHealthStatusCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import * // const { ServiceDiscoveryClient, GetInstancesHealthStatusCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import * // import type { ServiceDiscoveryClientConfig } from "@aws-sdk/client-servicediscovery"; * const config = {}; // type is ServiceDiscoveryClientConfig * const client = new ServiceDiscoveryClient(config); * const input = { // GetInstancesHealthStatusRequest * ServiceId: "STRING_VALUE", // required * Instances: [ // InstanceIdList * "STRING_VALUE", * ], * MaxResults: Number("int"), * NextToken: "STRING_VALUE", * }; * const command = new GetInstancesHealthStatusCommand(input); * const response = await client.send(command); * // { // GetInstancesHealthStatusResponse * // Status: { // InstanceHealthStatusMap * // "": "HEALTHY" || "UNHEALTHY" || "UNKNOWN", * // }, * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param GetInstancesHealthStatusCommandInput - {@link GetInstancesHealthStatusCommandInput} * @returns {@link GetInstancesHealthStatusCommandOutput} * @see {@link GetInstancesHealthStatusCommandInput} for command's `input` shape. * @see {@link GetInstancesHealthStatusCommandOutput} for command's `response` shape. * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape. * * @throws {@link InstanceNotFound} (client fault) *

No instance exists with the specified ID, or the instance was recently registered, and * information about the instance hasn't propagated yet.

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

One or more specified values aren't valid. For example, a required value might be missing, a * numeric value might be outside the allowed range, or a string value might exceed length * constraints.

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

No service exists with the specified ID.

* * @throws {@link ServiceDiscoveryServiceException} *

Base exception class for all service exceptions from ServiceDiscovery service.

* * * @example GetInstancesHealthStatus example * ```javascript * // This example gets the current health status of one or more instances that are associate with a specified service. * const input = { * ServiceId: "srv-e4anhexample0004" * }; * const command = new GetInstancesHealthStatusCommand(input); * const response = await client.send(command); * /* response is * { * Status: { * i-abcd1234: "HEALTHY", * i-abcd1235: "UNHEALTHY" * } * } * *\/ * ``` * * @example Get instances health status using service ARN for shared namespace * ```javascript * // This example gets the current health status of instances using a service ARN instead of service ID. This is useful for checking health status of instances associated with shared namespaces. * const input = { * ServiceId: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004" * }; * const command = new GetInstancesHealthStatusCommand(input); * const response = await client.send(command); * /* response is * { * Status: { * i-abcd1234: "HEALTHY", * i-abcd1235: "UNHEALTHY" * } * } * *\/ * ``` * * @public */ export declare class GetInstancesHealthStatusCommand extends GetInstancesHealthStatusCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetInstancesHealthStatusRequest; output: GetInstancesHealthStatusResponse; }; sdk: { input: GetInstancesHealthStatusCommandInput; output: GetInstancesHealthStatusCommandOutput; }; }; }