import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeInstancesHealthRequest, DescribeInstancesHealthResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeInstancesHealthCommand}. */ export interface DescribeInstancesHealthCommandInput extends DescribeInstancesHealthRequest { } /** * @public * * The output of {@link DescribeInstancesHealthCommand}. */ export interface DescribeInstancesHealthCommandOutput extends DescribeInstancesHealthResult, __MetadataBearer { } declare const DescribeInstancesHealthCommand_base: { new (input: DescribeInstancesHealthCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeInstancesHealthCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Retrieves detailed information about the health of instances in your Elastic Beanstalk environments. This operation requires enhanced health reporting.

*

This action only returns information about environments that the calling principle has IAM permissions to access. For example, consider a case where * a user only has permission to access one of three environments. When the user calls this action, the response will only include the one environment that * the user has permission to access instead of all three environments. If the user doesn’t have access to any of the environments an empty result is * returned.

* *

The AWSElasticBeanstalkReadOnly * managed policy allows operators to view information about resources related to Elastic Beanstalk environments. For more information, see Managing Elastic Beanstalk user policies in the Elastic Beanstalk Developer * Guide. For detailed instructions to attach a policy to a user or group, see the section Controlling access with managed policies in the * same topic.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ElasticBeanstalkClient, DescribeInstancesHealthCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import * // const { ElasticBeanstalkClient, DescribeInstancesHealthCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import * // import type { ElasticBeanstalkClientConfig } from "@aws-sdk/client-elastic-beanstalk"; * const config = {}; // type is ElasticBeanstalkClientConfig * const client = new ElasticBeanstalkClient(config); * const input = { // DescribeInstancesHealthRequest * EnvironmentName: "STRING_VALUE", * EnvironmentId: "STRING_VALUE", * AttributeNames: [ // InstancesHealthAttributes * "HealthStatus" || "Color" || "Causes" || "ApplicationMetrics" || "RefreshedAt" || "LaunchedAt" || "System" || "Deployment" || "AvailabilityZone" || "InstanceType" || "All", * ], * NextToken: "STRING_VALUE", * }; * const command = new DescribeInstancesHealthCommand(input); * const response = await client.send(command); * // { // DescribeInstancesHealthResult * // InstanceHealthList: [ // InstanceHealthList * // { // SingleInstanceHealth * // InstanceId: "STRING_VALUE", * // HealthStatus: "STRING_VALUE", * // Color: "STRING_VALUE", * // Causes: [ // Causes * // "STRING_VALUE", * // ], * // LaunchedAt: new Date("TIMESTAMP"), * // ApplicationMetrics: { // ApplicationMetrics * // Duration: Number("int"), * // RequestCount: Number("int"), * // StatusCodes: { // StatusCodes * // Status2xx: Number("int"), * // Status3xx: Number("int"), * // Status4xx: Number("int"), * // Status5xx: Number("int"), * // }, * // Latency: { // Latency * // P999: Number("double"), * // P99: Number("double"), * // P95: Number("double"), * // P90: Number("double"), * // P85: Number("double"), * // P75: Number("double"), * // P50: Number("double"), * // P10: Number("double"), * // }, * // }, * // System: { // SystemStatus * // CPUUtilization: { // CPUUtilization * // User: Number("double"), * // Nice: Number("double"), * // System: Number("double"), * // Idle: Number("double"), * // IOWait: Number("double"), * // IRQ: Number("double"), * // SoftIRQ: Number("double"), * // Privileged: Number("double"), * // }, * // LoadAverage: [ // LoadAverage * // Number("double"), * // ], * // }, * // Deployment: { // Deployment * // VersionLabel: "STRING_VALUE", * // DeploymentId: Number("long"), * // Status: "STRING_VALUE", * // DeploymentTime: new Date("TIMESTAMP"), * // }, * // AvailabilityZone: "STRING_VALUE", * // InstanceType: "STRING_VALUE", * // }, * // ], * // RefreshedAt: new Date("TIMESTAMP"), * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeInstancesHealthCommandInput - {@link DescribeInstancesHealthCommandInput} * @returns {@link DescribeInstancesHealthCommandOutput} * @see {@link DescribeInstancesHealthCommandInput} for command's `input` shape. * @see {@link DescribeInstancesHealthCommandOutput} for command's `response` shape. * @see {@link ElasticBeanstalkClientResolvedConfig | config} for ElasticBeanstalkClient's `config` shape. * * @throws {@link ElasticBeanstalkServiceException} (client fault) *

A generic service exception has occurred.

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

One or more input parameters is not valid. Please correct the input parameters and try * the operation again.

* * @throws {@link ElasticBeanstalkSyntheticServiceException} *

Base exception class for all service exceptions from ElasticBeanstalk service.

* * * @example To view environment health * ```javascript * // The following operation retrieves health information for instances in an environment named my-env: * const input = { * AttributeNames: [ * "All" * ], * EnvironmentName: "my-env" * }; * const command = new DescribeInstancesHealthCommand(input); * const response = await client.send(command); * /* response is * { * InstanceHealthList: [ * { * ApplicationMetrics: { * Duration: 10, * Latency: { * P10: 0, * P50: 0.001, * P75: 0.002, * P85: 0.003, * P90: 0.004, * P95: 0.005, * P99: 0.006, * P999: 0.006 * }, * RequestCount: 48, * StatusCodes: { * Status2xx: 47, * Status3xx: 0, * Status4xx: 1, * Status5xx: 0 * } * }, * Causes: [], * Color: "Green", * HealthStatus: "Ok", * InstanceId: "i-08691cc7", * LaunchedAt: "2015-08-13T19:17:09Z", * System: { * CPUUtilization: { * IOWait: 0.2, * IRQ: 0, * Idle: 97.8, * Nice: 0.1, * SoftIRQ: 0.1, * System: 0.3, * User: 1.5 * }, * LoadAverage: [ * 0, * 0.02, * 0.05 * ] * } * } * ], * RefreshedAt: "2015-08-20T21:09:08Z" * } * *\/ * ``` * * @public */ export declare class DescribeInstancesHealthCommand extends DescribeInstancesHealthCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeInstancesHealthRequest; output: DescribeInstancesHealthResult; }; sdk: { input: DescribeInstancesHealthCommandInput; output: DescribeInstancesHealthCommandOutput; }; }; }