Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
- 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:
dehEnvironmentName
- Specify the environment by name. You must specify either this or an EnvironmentName, or both.dehAttributeNames
- Specify the response elements to return. To retrieve all attributes, set toAll
. If no attribute names are specified, returns the name of the environment.dehEnvironmentId
- Specify the environment by ID. You must specify either this or an EnvironmentName, or both.
data DescribeEnvironmentHealth Source #
See the example below to learn how to create a request body.
See: describeEnvironmentHealth
smart constructor.
Request Lenses
dehEnvironmentName :: Lens' DescribeEnvironmentHealth (Maybe Text) Source #
Specify the environment by name. You must specify either this or an EnvironmentName, or both.
dehAttributeNames :: Lens' DescribeEnvironmentHealth [EnvironmentHealthAttribute] Source #
Specify the response elements to return. To retrieve all attributes, set to All
. If no attribute names are specified, returns the name of the environment.
dehEnvironmentId :: Lens' DescribeEnvironmentHealth (Maybe Text) Source #
Specify the environment by ID. You must specify either this or an EnvironmentName, or both.
Destructuring the Response
describeEnvironmentHealthResponse Source #
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:
dehrsStatus
- The environment's operational status.Ready
,Launching
,Updating
,Terminating
, orTerminated
.dehrsCauses
- Descriptions of the data that contributed to the environment's current health status.dehrsApplicationMetrics
- Application request metrics for the environment.dehrsColor
- The health color of the environment.dehrsEnvironmentName
- The environment's name.dehrsHealthStatus
- The health status of the environment. For example,Ok
.dehrsInstancesHealth
- Summary health information for the instances in the environment.dehrsRefreshedAt
- The date and time that the health information was retrieved.dehrsResponseStatus
- -- | The response status code.
data DescribeEnvironmentHealthResponse Source #
Health details for an AWS Elastic Beanstalk environment.
See: describeEnvironmentHealthResponse
smart constructor.
Response Lenses
dehrsStatus :: Lens' DescribeEnvironmentHealthResponse (Maybe EnvironmentHealth) Source #
The environment's operational status. Ready
, Launching
, Updating
, Terminating
, or Terminated
.
dehrsCauses :: Lens' DescribeEnvironmentHealthResponse [Text] Source #
Descriptions of the data that contributed to the environment's current health status.
dehrsApplicationMetrics :: Lens' DescribeEnvironmentHealthResponse (Maybe ApplicationMetrics) Source #
Application request metrics for the environment.
dehrsColor :: Lens' DescribeEnvironmentHealthResponse (Maybe Text) Source #
The health color of the environment.
dehrsEnvironmentName :: Lens' DescribeEnvironmentHealthResponse (Maybe Text) Source #
The environment's name.
dehrsHealthStatus :: Lens' DescribeEnvironmentHealthResponse (Maybe Text) Source #
The health status of the environment. For example, Ok
.
dehrsInstancesHealth :: Lens' DescribeEnvironmentHealthResponse (Maybe InstanceHealthSummary) Source #
Summary health information for the instances in the environment.
dehrsRefreshedAt :: Lens' DescribeEnvironmentHealthResponse (Maybe UTCTime) Source #
The date and time that the health information was retrieved.
dehrsResponseStatus :: Lens' DescribeEnvironmentHealthResponse Int Source #
- - | The response status code.