Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

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

Creating a Request

data DescribeEnvironmentHealth

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

See: newDescribeEnvironmentHealth smart constructor.

Constructors

DescribeEnvironmentHealth'

Fields

• 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.

• environmentName :: Maybe Text

  Specify the environment by name.

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

Instances

ToHeaders DescribeEnvironmentHealth

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

Methods

toHeaders :: DescribeEnvironmentHealth -> [Header]

ToPath DescribeEnvironmentHealth

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

Methods

toPath :: DescribeEnvironmentHealth -> ByteString

ToQuery DescribeEnvironmentHealth

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

Methods

toQuery :: DescribeEnvironmentHealth -> QueryString

AWSRequest DescribeEnvironmentHealth

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

Associated Types

type AWSResponse DescribeEnvironmentHealth

Methods

request :: (Service -> Service) -> DescribeEnvironmentHealth -> Request DescribeEnvironmentHealth

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEnvironmentHealth -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEnvironmentHealth)))

Generic DescribeEnvironmentHealth

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

Associated Types

type Rep DescribeEnvironmentHealth :: Type -> Type

Methods

from :: DescribeEnvironmentHealth -> Rep DescribeEnvironmentHealth x

to :: Rep DescribeEnvironmentHealth x -> DescribeEnvironmentHealth

Read DescribeEnvironmentHealth

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

Methods

readsPrec :: Int -> ReadS DescribeEnvironmentHealth

readList :: ReadS [DescribeEnvironmentHealth]

readPrec :: ReadPrec DescribeEnvironmentHealth

readListPrec :: ReadPrec [DescribeEnvironmentHealth]

Show DescribeEnvironmentHealth

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

Methods

showsPrec :: Int -> DescribeEnvironmentHealth -> ShowS

show :: DescribeEnvironmentHealth -> String

showList :: [DescribeEnvironmentHealth] -> ShowS

NFData DescribeEnvironmentHealth

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

Methods

rnf :: DescribeEnvironmentHealth -> ()

Eq DescribeEnvironmentHealth

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

Methods

(==) :: DescribeEnvironmentHealth -> DescribeEnvironmentHealth -> Bool

(/=) :: DescribeEnvironmentHealth -> DescribeEnvironmentHealth -> Bool

Hashable DescribeEnvironmentHealth

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

Methods

hashWithSalt :: Int -> DescribeEnvironmentHealth -> Int

hash :: DescribeEnvironmentHealth -> Int

type AWSResponse DescribeEnvironmentHealth

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

type AWSResponse DescribeEnvironmentHealth = DescribeEnvironmentHealthResponse

type Rep DescribeEnvironmentHealth

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

type Rep DescribeEnvironmentHealth = D1 ('MetaData "DescribeEnvironmentHealth" "Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth" "amazonka-elasticbeanstalk-2.0-HLGGuY0kjXTIKSbM7JuMHy" 'False) (C1 ('MetaCons "DescribeEnvironmentHealth'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EnvironmentHealthAttribute])) :*: (S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeEnvironmentHealth :: DescribeEnvironmentHealth

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

DescribeEnvironmentHealth, describeEnvironmentHealth_environmentId - Specify the environment by ID.

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

DescribeEnvironmentHealth, describeEnvironmentHealth_environmentName - Specify the environment by name.

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

Request Lenses

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

describeEnvironmentHealth_environmentId :: Lens' DescribeEnvironmentHealth (Maybe Text)

Specify the environment by ID.

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

describeEnvironmentHealth_environmentName :: Lens' DescribeEnvironmentHealth (Maybe Text)

Specify the environment by name.

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

Destructuring the Response

data DescribeEnvironmentHealthResponse

Health details for an AWS Elastic Beanstalk environment.

See: newDescribeEnvironmentHealthResponse smart constructor.

Constructors

DescribeEnvironmentHealthResponse'

Fields

• applicationMetrics :: Maybe ApplicationMetrics

  Application request metrics for the environment.

• causes :: Maybe [Text]

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

• 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.

• status :: Maybe EnvironmentHealth

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeEnvironmentHealthResponse

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

Associated Types

type Rep DescribeEnvironmentHealthResponse :: Type -> Type

Methods

from :: DescribeEnvironmentHealthResponse -> Rep DescribeEnvironmentHealthResponse x

to :: Rep DescribeEnvironmentHealthResponse x -> DescribeEnvironmentHealthResponse

Read DescribeEnvironmentHealthResponse

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

Methods

readsPrec :: Int -> ReadS DescribeEnvironmentHealthResponse

readList :: ReadS [DescribeEnvironmentHealthResponse]

readPrec :: ReadPrec DescribeEnvironmentHealthResponse

readListPrec :: ReadPrec [DescribeEnvironmentHealthResponse]

Show DescribeEnvironmentHealthResponse

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

Methods

showsPrec :: Int -> DescribeEnvironmentHealthResponse -> ShowS

show :: DescribeEnvironmentHealthResponse -> String

showList :: [DescribeEnvironmentHealthResponse] -> ShowS

NFData DescribeEnvironmentHealthResponse

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

Methods

rnf :: DescribeEnvironmentHealthResponse -> ()

Eq DescribeEnvironmentHealthResponse

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

Methods

(==) :: DescribeEnvironmentHealthResponse -> DescribeEnvironmentHealthResponse -> Bool

(/=) :: DescribeEnvironmentHealthResponse -> DescribeEnvironmentHealthResponse -> Bool

type Rep DescribeEnvironmentHealthResponse

Defined in Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth

type Rep DescribeEnvironmentHealthResponse = D1 ('MetaData "DescribeEnvironmentHealthResponse" "Amazonka.ElasticBeanstalk.DescribeEnvironmentHealth" "amazonka-elasticbeanstalk-2.0-HLGGuY0kjXTIKSbM7JuMHy" 'False) (C1 ('MetaCons "DescribeEnvironmentHealthResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "applicationMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApplicationMetrics)) :*: S1 ('MetaSel ('Just "causes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (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 "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnvironmentHealth)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeEnvironmentHealthResponse

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:

DescribeEnvironmentHealthResponse, describeEnvironmentHealthResponse_applicationMetrics - Application request metrics for the environment.

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

DescribeEnvironmentHealthResponse, describeEnvironmentHealthResponse_color - The health color of the environment.

DescribeEnvironmentHealth, describeEnvironmentHealthResponse_environmentName - The environment's name.

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.

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

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

Response Lenses

describeEnvironmentHealthResponse_applicationMetrics :: Lens' DescribeEnvironmentHealthResponse (Maybe ApplicationMetrics)

Application request metrics for the environment.

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

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

describeEnvironmentHealthResponse_color :: Lens' DescribeEnvironmentHealthResponse (Maybe Text)

The health color of the environment.

describeEnvironmentHealthResponse_environmentName :: Lens' DescribeEnvironmentHealthResponse (Maybe Text)

The environment's name.

describeEnvironmentHealthResponse_healthStatus :: Lens' DescribeEnvironmentHealthResponse (Maybe Text)

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

describeEnvironmentHealthResponse_instancesHealth :: Lens' DescribeEnvironmentHealthResponse (Maybe InstanceHealthSummary)

Summary health information for the instances in the environment.

describeEnvironmentHealthResponse_refreshedAt :: Lens' DescribeEnvironmentHealthResponse (Maybe UTCTime)

The date and time that the health information was retrieved.

describeEnvironmentHealthResponse_status :: Lens' DescribeEnvironmentHealthResponse (Maybe EnvironmentHealth)

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

describeEnvironmentHealthResponse_httpStatus :: Lens' DescribeEnvironmentHealthResponse Int

The response's http status code.