Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth
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.
- describeEnvironmentHealth :: DescribeEnvironmentHealth
- data DescribeEnvironmentHealth
- dehEnvironmentName :: Lens' DescribeEnvironmentHealth (Maybe Text)
- dehAttributeNames :: Lens' DescribeEnvironmentHealth [EnvironmentHealthAttribute]
- dehEnvironmentId :: Lens' DescribeEnvironmentHealth (Maybe Text)
- describeEnvironmentHealthResponse :: Int -> DescribeEnvironmentHealthResponse
- data DescribeEnvironmentHealthResponse
- dehrsStatus :: Lens' DescribeEnvironmentHealthResponse (Maybe EnvironmentHealth)
- dehrsCauses :: Lens' DescribeEnvironmentHealthResponse [Text]
- dehrsApplicationMetrics :: Lens' DescribeEnvironmentHealthResponse (Maybe ApplicationMetrics)
- dehrsColor :: Lens' DescribeEnvironmentHealthResponse (Maybe Text)
- dehrsEnvironmentName :: Lens' DescribeEnvironmentHealthResponse (Maybe Text)
- dehrsHealthStatus :: Lens' DescribeEnvironmentHealthResponse (Maybe Text)
- dehrsInstancesHealth :: Lens' DescribeEnvironmentHealthResponse (Maybe InstanceHealthSummary)
- dehrsRefreshedAt :: Lens' DescribeEnvironmentHealthResponse (Maybe UTCTime)
- dehrsResponseStatus :: Lens' DescribeEnvironmentHealthResponse Int
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:
data DescribeEnvironmentHealth Source
See the example below to learn how to create a request body.
See: describeEnvironmentHealth
smart constructor.
Instances
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
describeEnvironmentHealthResponse Source
Arguments
:: Int | |
-> DescribeEnvironmentHealthResponse |
Creates a value of DescribeEnvironmentHealthResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeEnvironmentHealthResponse Source
See the example below for a sample response.
See: describeEnvironmentHealthResponse
smart constructor.
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.
dehrsApplicationMetrics :: Lens' DescribeEnvironmentHealthResponse (Maybe ApplicationMetrics) Source
Undocumented member.
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.
dehrsInstancesHealth :: Lens' DescribeEnvironmentHealthResponse (Maybe InstanceHealthSummary) Source
Undocumented member.
dehrsRefreshedAt :: Lens' DescribeEnvironmentHealthResponse (Maybe UTCTime) Source
The date and time the information was last refreshed.
dehrsResponseStatus :: Lens' DescribeEnvironmentHealthResponse Int Source
The response status code.