Copyright	(c) 2013-2021 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

Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

Creating a Request

data DescribeEnvironmentHealth Source #

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

See: newDescribeEnvironmentHealth smart constructor.

Constructors

DescribeEnvironmentHealth'

Fields

environmentName :: Maybe Text
Specify the environment by name.
You must specify either this or an EnvironmentName, or both.
attributeNames :: Maybe [EnvironmentHealthAttribute]
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.
environmentId :: Maybe Text
Specify the environment by ID.
You must specify either this or an EnvironmentName, or both.

Instances

Instances details

Eq DescribeEnvironmentHealth Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth Methods (==) :: DescribeEnvironmentHealth -> DescribeEnvironmentHealth -> Bool # (/=) :: DescribeEnvironmentHealth -> DescribeEnvironmentHealth -> Bool #
Read DescribeEnvironmentHealth Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth Methods readsPrec :: Int -> ReadS DescribeEnvironmentHealth # readList :: ReadS [DescribeEnvironmentHealth] # readPrec :: ReadPrec DescribeEnvironmentHealth # readListPrec :: ReadPrec [DescribeEnvironmentHealth] #
Show DescribeEnvironmentHealth Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth Methods showsPrec :: Int -> DescribeEnvironmentHealth -> ShowS # show :: DescribeEnvironmentHealth -> String # showList :: [DescribeEnvironmentHealth] -> ShowS #
Generic DescribeEnvironmentHealth Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth Associated Types type Rep DescribeEnvironmentHealth :: Type -> Type # Methods from :: DescribeEnvironmentHealth -> Rep DescribeEnvironmentHealth x # to :: Rep DescribeEnvironmentHealth x -> DescribeEnvironmentHealth #
NFData DescribeEnvironmentHealth Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth Methods rnf :: DescribeEnvironmentHealth -> () #
Hashable DescribeEnvironmentHealth Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth Methods hashWithSalt :: Int -> DescribeEnvironmentHealth -> Int # hash :: DescribeEnvironmentHealth -> Int #
AWSRequest DescribeEnvironmentHealth Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth Associated Types type AWSResponse DescribeEnvironmentHealth # Methods request :: DescribeEnvironmentHealth -> Request DescribeEnvironmentHealth # response :: MonadResource m => Logger -> Service -> Proxy DescribeEnvironmentHealth -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEnvironmentHealth))) #
ToHeaders DescribeEnvironmentHealth Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth Methods toHeaders :: DescribeEnvironmentHealth -> [Header] #
ToPath DescribeEnvironmentHealth Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth Methods toPath :: DescribeEnvironmentHealth -> ByteString #
ToQuery DescribeEnvironmentHealth Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth Methods toQuery :: DescribeEnvironmentHealth -> QueryString #
type Rep DescribeEnvironmentHealth Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth type Rep DescribeEnvironmentHealth = D1 ('MetaData "DescribeEnvironmentHealth" "Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth" "libZSservicesZSamazonka-elasticbeanstalkZSamazonka-elasticbeanstalk" 'False) (C1 ('MetaCons "DescribeEnvironmentHealth'" 'PrefixI 'True) (S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "attributeNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EnvironmentHealthAttribute])) :: S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse DescribeEnvironmentHealth Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth type AWSResponse DescribeEnvironmentHealth = DescribeEnvironmentHealthResponse

newDescribeEnvironmentHealth :: DescribeEnvironmentHealth Source #

Create a value of DescribeEnvironmentHealth with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:environmentName:DescribeEnvironmentHealth', describeEnvironmentHealth_environmentName - Specify the environment by name.

You must specify either this or an EnvironmentName, or both.

$sel:attributeNames:DescribeEnvironmentHealth', describeEnvironmentHealth_attributeNames - 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.

$sel:environmentId:DescribeEnvironmentHealth', describeEnvironmentHealth_environmentId - Specify the environment by ID.

You must specify either this or an EnvironmentName, or both.

Request Lenses

describeEnvironmentHealth_environmentName :: Lens' DescribeEnvironmentHealth (Maybe Text) Source #

Specify the environment by name.

You must specify either this or an EnvironmentName, or both.

describeEnvironmentHealth_attributeNames :: Lens' DescribeEnvironmentHealth (Maybe [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.

describeEnvironmentHealth_environmentId :: Lens' DescribeEnvironmentHealth (Maybe Text) Source #

Specify the environment by ID.

You must specify either this or an EnvironmentName, or both.

Destructuring the Response

data DescribeEnvironmentHealthResponse Source #

Health details for an AWS Elastic Beanstalk environment.

See: newDescribeEnvironmentHealthResponse smart constructor.

Constructors

DescribeEnvironmentHealthResponse'

Fields

status :: Maybe EnvironmentHealth
The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.
causes :: Maybe [Text]
Descriptions of the data that contributed to the environment's current health status.
applicationMetrics :: Maybe ApplicationMetrics
Application request metrics for the environment.
color :: Maybe Text
The health color of the environment.
environmentName :: Maybe Text
The environment's name.
healthStatus :: Maybe Text
The health status of the environment. For example, Ok.
instancesHealth :: Maybe InstanceHealthSummary
Summary health information for the instances in the environment.
refreshedAt :: Maybe ISO8601
The date and time that the health information was retrieved.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeEnvironmentHealthResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth Methods (==) :: DescribeEnvironmentHealthResponse -> DescribeEnvironmentHealthResponse -> Bool # (/=) :: DescribeEnvironmentHealthResponse -> DescribeEnvironmentHealthResponse -> Bool #
Read DescribeEnvironmentHealthResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth Methods readsPrec :: Int -> ReadS DescribeEnvironmentHealthResponse # readList :: ReadS [DescribeEnvironmentHealthResponse] # readPrec :: ReadPrec DescribeEnvironmentHealthResponse # readListPrec :: ReadPrec [DescribeEnvironmentHealthResponse] #
Show DescribeEnvironmentHealthResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth Methods showsPrec :: Int -> DescribeEnvironmentHealthResponse -> ShowS # show :: DescribeEnvironmentHealthResponse -> String # showList :: [DescribeEnvironmentHealthResponse] -> ShowS #
Generic DescribeEnvironmentHealthResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth Associated Types type Rep DescribeEnvironmentHealthResponse :: Type -> Type # Methods from :: DescribeEnvironmentHealthResponse -> Rep DescribeEnvironmentHealthResponse x # to :: Rep DescribeEnvironmentHealthResponse x -> DescribeEnvironmentHealthResponse #
NFData DescribeEnvironmentHealthResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth Methods rnf :: DescribeEnvironmentHealthResponse -> () #
type Rep DescribeEnvironmentHealthResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth type Rep DescribeEnvironmentHealthResponse = D1 ('MetaData "DescribeEnvironmentHealthResponse" "Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth" "libZSservicesZSamazonka-elasticbeanstalkZSamazonka-elasticbeanstalk" 'False) (C1 ('MetaCons "DescribeEnvironmentHealthResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnvironmentHealth)) :: S1 ('MetaSel ('Just "causes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "applicationMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApplicationMetrics)) :: S1 ('MetaSel ('Just "color") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "healthStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "instancesHealth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceHealthSummary)) :: (S1 ('MetaSel ('Just "refreshedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeEnvironmentHealthResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeEnvironmentHealthResponse'`
-> DescribeEnvironmentHealthResponse

Create a value of DescribeEnvironmentHealthResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:DescribeEnvironmentHealthResponse', describeEnvironmentHealthResponse_status - The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.

$sel:causes:DescribeEnvironmentHealthResponse', describeEnvironmentHealthResponse_causes - Descriptions of the data that contributed to the environment's current health status.

$sel:applicationMetrics:DescribeEnvironmentHealthResponse', describeEnvironmentHealthResponse_applicationMetrics - Application request metrics for the environment.

$sel:color:DescribeEnvironmentHealthResponse', describeEnvironmentHealthResponse_color - The health color of the environment.

$sel:environmentName:DescribeEnvironmentHealth', describeEnvironmentHealthResponse_environmentName - The environment's name.

$sel:healthStatus:DescribeEnvironmentHealthResponse', describeEnvironmentHealthResponse_healthStatus - The health status of the environment. For example, Ok.

$sel:instancesHealth:DescribeEnvironmentHealthResponse', describeEnvironmentHealthResponse_instancesHealth - Summary health information for the instances in the environment.

$sel:refreshedAt:DescribeEnvironmentHealthResponse', describeEnvironmentHealthResponse_refreshedAt - The date and time that the health information was retrieved.

$sel:httpStatus:DescribeEnvironmentHealthResponse', describeEnvironmentHealthResponse_httpStatus - The response's http status code.

Response Lenses

describeEnvironmentHealthResponse_status :: Lens' DescribeEnvironmentHealthResponse (Maybe EnvironmentHealth) Source #

The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.

describeEnvironmentHealthResponse_causes :: Lens' DescribeEnvironmentHealthResponse (Maybe [Text]) Source #

Descriptions of the data that contributed to the environment's current health status.

describeEnvironmentHealthResponse_applicationMetrics :: Lens' DescribeEnvironmentHealthResponse (Maybe ApplicationMetrics) Source #

Application request metrics for the environment.

describeEnvironmentHealthResponse_color :: Lens' DescribeEnvironmentHealthResponse (Maybe Text) Source #

The health color of the environment.

describeEnvironmentHealthResponse_environmentName :: Lens' DescribeEnvironmentHealthResponse (Maybe Text) Source #

The environment's name.

describeEnvironmentHealthResponse_healthStatus :: Lens' DescribeEnvironmentHealthResponse (Maybe Text) Source #

The health status of the environment. For example, Ok.

describeEnvironmentHealthResponse_instancesHealth :: Lens' DescribeEnvironmentHealthResponse (Maybe InstanceHealthSummary) Source #

Summary health information for the instances in the environment.

describeEnvironmentHealthResponse_refreshedAt :: Lens' DescribeEnvironmentHealthResponse (Maybe UTCTime) Source #

The date and time that the health information was retrieved.

describeEnvironmentHealthResponse_httpStatus :: Lens' DescribeEnvironmentHealthResponse Int Source #

The response's http status code.