import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeEnvironmentHealthRequest, DescribeEnvironmentHealthResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeEnvironmentHealthCommand}. */ export interface DescribeEnvironmentHealthCommandInput extends DescribeEnvironmentHealthRequest { } /** * @public * * The output of {@link DescribeEnvironmentHealthCommand}. */ export interface DescribeEnvironmentHealthCommandOutput extends DescribeEnvironmentHealthResult, __MetadataBearer { } declare const DescribeEnvironmentHealthCommand_base: { new (input: DescribeEnvironmentHealthCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeEnvironmentHealthCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is * only available with Elastic Beanstalk Enhanced Health.

*

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, DescribeEnvironmentHealthCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import * // const { ElasticBeanstalkClient, DescribeEnvironmentHealthCommand } = 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 = { // DescribeEnvironmentHealthRequest * EnvironmentName: "STRING_VALUE", * EnvironmentId: "STRING_VALUE", * AttributeNames: [ // EnvironmentHealthAttributes * "Status" || "Color" || "Causes" || "ApplicationMetrics" || "InstancesHealth" || "All" || "HealthStatus" || "RefreshedAt", * ], * }; * const command = new DescribeEnvironmentHealthCommand(input); * const response = await client.send(command); * // { // DescribeEnvironmentHealthResult * // EnvironmentName: "STRING_VALUE", * // HealthStatus: "STRING_VALUE", * // Status: "Green" || "Yellow" || "Red" || "Grey", * // Color: "STRING_VALUE", * // Causes: [ // Causes * // "STRING_VALUE", * // ], * // 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"), * // }, * // }, * // InstancesHealth: { // InstanceHealthSummary * // NoData: Number("int"), * // Unknown: Number("int"), * // Pending: Number("int"), * // Ok: Number("int"), * // Info: Number("int"), * // Warning: Number("int"), * // Degraded: Number("int"), * // Severe: Number("int"), * // }, * // RefreshedAt: new Date("TIMESTAMP"), * // }; * * ``` * * @param DescribeEnvironmentHealthCommandInput - {@link DescribeEnvironmentHealthCommandInput} * @returns {@link DescribeEnvironmentHealthCommandOutput} * @see {@link DescribeEnvironmentHealthCommandInput} for command's `input` shape. * @see {@link DescribeEnvironmentHealthCommandOutput} 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 overall health information for an environment named my-env: * const input = { * AttributeNames: [ * "All" * ], * EnvironmentName: "my-env" * }; * const command = new DescribeEnvironmentHealthCommand(input); * const response = await client.send(command); * /* response is * { * ApplicationMetrics: { * Duration: 10, * Latency: { * P10: 0.001, * P50: 0.001, * P75: 0.002, * P85: 0.003, * P90: 0.003, * P95: 0.004, * P99: 0.004, * P999: 0.004 * }, * RequestCount: 45, * StatusCodes: { * Status2xx: 45, * Status3xx: 0, * Status4xx: 0, * Status5xx: 0 * } * }, * Causes: [], * Color: "Green", * EnvironmentName: "my-env", * HealthStatus: "Ok", * InstancesHealth: { * Degraded: 0, * Info: 0, * NoData: 0, * Ok: 1, * Pending: 0, * Severe: 0, * Unknown: 0, * Warning: 0 * }, * RefreshedAt: "2015-08-20T21:09:18Z" * } * *\/ * ``` * * @public */ export declare class DescribeEnvironmentHealthCommand extends DescribeEnvironmentHealthCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeEnvironmentHealthRequest; output: DescribeEnvironmentHealthResult; }; sdk: { input: DescribeEnvironmentHealthCommandInput; output: DescribeEnvironmentHealthCommandOutput; }; }; }