amazonka-elasticbeanstalk-1.3.2: Amazon Elastic Beanstalk SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth

Contents

Description

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

See: AWS API Reference for DescribeEnvironmentHealth.

Synopsis

Creating a Request

describeEnvironmentHealth :: DescribeEnvironmentHealth Source

Creates a value of DescribeEnvironmentHealth with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Request Lenses

dehEnvironmentName :: Lens' DescribeEnvironmentHealth (Maybe Text) Source

Specifies the AWS Elastic Beanstalk environment name.

dehAttributeNames :: Lens' DescribeEnvironmentHealth [EnvironmentHealthAttribute] Source

Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk returns all response elements.

dehEnvironmentId :: Lens' DescribeEnvironmentHealth (Maybe Text) Source

Specifies the AWS Elastic Beanstalk environment ID.

Destructuring the Response

Response Lenses

dehrsStatus :: Lens' DescribeEnvironmentHealthResponse (Maybe EnvironmentHealth) Source

Returns the health status value of the environment. For more information, see Health Colors and Statuses.

dehrsCauses :: Lens' DescribeEnvironmentHealthResponse [Text] Source

Returns potential causes for the reported status.

dehrsColor :: Lens' DescribeEnvironmentHealthResponse (Maybe Text) Source

Returns the color indicator that tells you information about the health of the environment. For more information, see Health Colors and Statuses.

dehrsEnvironmentName :: Lens' DescribeEnvironmentHealthResponse (Maybe Text) Source

The AWS Elastic Beanstalk environment name.

dehrsHealthStatus :: Lens' DescribeEnvironmentHealthResponse (Maybe Text) Source

Contains the response body with information about the health of the environment.

dehrsRefreshedAt :: Lens' DescribeEnvironmentHealthResponse (Maybe UTCTime) Source

The date and time the information was last refreshed.