Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth

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.

Creating a Request

describeEnvironmentHealth :: DescribeEnvironmentHealth

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
• dehAttributeNames
• dehEnvironmentId

data DescribeEnvironmentHealth

See the example below to learn how to create a request body.

See: describeEnvironmentHealth smart constructor.

Instances

Eq DescribeEnvironmentHealth

Data DescribeEnvironmentHealth

Read DescribeEnvironmentHealth

Show DescribeEnvironmentHealth

Generic DescribeEnvironmentHealth

AWSRequest DescribeEnvironmentHealth

ToPath DescribeEnvironmentHealth

ToHeaders DescribeEnvironmentHealth

ToQuery DescribeEnvironmentHealth

Typeable * DescribeEnvironmentHealth

type Rep DescribeEnvironmentHealth

type Rs DescribeEnvironmentHealth = DescribeEnvironmentHealthResponse

Request Lenses

dehEnvironmentName :: Lens' DescribeEnvironmentHealth (Maybe Text)

Specifies the AWS Elastic Beanstalk environment name.

dehAttributeNames :: Lens' DescribeEnvironmentHealth [EnvironmentHealthAttribute]

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)

Specifies the AWS Elastic Beanstalk environment ID.

Destructuring the Response

describeEnvironmentHealthResponse

Arguments

:: Int

dehrsResponseStatus

-> 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:

• dehrsStatus
• dehrsCauses
• dehrsApplicationMetrics
• dehrsColor
• dehrsEnvironmentName
• dehrsHealthStatus
• dehrsInstancesHealth
• dehrsRefreshedAt
• dehrsResponseStatus

data DescribeEnvironmentHealthResponse

See the example below for a sample response.

See: describeEnvironmentHealthResponse smart constructor.

Instances

Eq DescribeEnvironmentHealthResponse

Data DescribeEnvironmentHealthResponse

Read DescribeEnvironmentHealthResponse

Show DescribeEnvironmentHealthResponse

Generic DescribeEnvironmentHealthResponse

Typeable * DescribeEnvironmentHealthResponse

type Rep DescribeEnvironmentHealthResponse

Response Lenses

dehrsStatus :: Lens' DescribeEnvironmentHealthResponse (Maybe EnvironmentHealth)

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

dehrsCauses :: Lens' DescribeEnvironmentHealthResponse [Text]

Returns potential causes for the reported status.

dehrsApplicationMetrics :: Lens' DescribeEnvironmentHealthResponse (Maybe ApplicationMetrics)

Undocumented member.

dehrsColor :: Lens' DescribeEnvironmentHealthResponse (Maybe Text)

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)

The AWS Elastic Beanstalk environment name.

dehrsHealthStatus :: Lens' DescribeEnvironmentHealthResponse (Maybe Text)

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

dehrsInstancesHealth :: Lens' DescribeEnvironmentHealthResponse (Maybe InstanceHealthSummary)

Undocumented member.

dehrsRefreshedAt :: Lens' DescribeEnvironmentHealthResponse (Maybe UTCTime)

The date and time the information was last refreshed.

dehrsResponseStatus :: Lens' DescribeEnvironmentHealthResponse Int

The response status code.