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.

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

Methods

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

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

Data DescribeEnvironmentHealth

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEnvironmentHealth -> c DescribeEnvironmentHealth

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEnvironmentHealth

toConstr :: DescribeEnvironmentHealth -> Constr

dataTypeOf :: DescribeEnvironmentHealth -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEnvironmentHealth)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEnvironmentHealth)

gmapT :: (forall b. Data b => b -> b) -> DescribeEnvironmentHealth -> DescribeEnvironmentHealth

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEnvironmentHealth -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEnvironmentHealth -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeEnvironmentHealth -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEnvironmentHealth -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEnvironmentHealth -> m DescribeEnvironmentHealth

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEnvironmentHealth -> m DescribeEnvironmentHealth

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEnvironmentHealth -> m DescribeEnvironmentHealth

Read DescribeEnvironmentHealth

Methods

readsPrec :: Int -> ReadS DescribeEnvironmentHealth

readList :: ReadS [DescribeEnvironmentHealth]

readPrec :: ReadPrec DescribeEnvironmentHealth

readListPrec :: ReadPrec [DescribeEnvironmentHealth]

Show DescribeEnvironmentHealth

Methods

showsPrec :: Int -> DescribeEnvironmentHealth -> ShowS

show :: DescribeEnvironmentHealth -> String

showList :: [DescribeEnvironmentHealth] -> ShowS

Generic DescribeEnvironmentHealth

Associated Types

type Rep DescribeEnvironmentHealth :: * -> *

Methods

from :: DescribeEnvironmentHealth -> Rep DescribeEnvironmentHealth x

to :: Rep DescribeEnvironmentHealth x -> DescribeEnvironmentHealth

Hashable DescribeEnvironmentHealth

Methods

hashWithSalt :: Int -> DescribeEnvironmentHealth -> Int

hash :: DescribeEnvironmentHealth -> Int

NFData DescribeEnvironmentHealth

Methods

rnf :: DescribeEnvironmentHealth -> ()

AWSRequest DescribeEnvironmentHealth

Associated Types

type Rs DescribeEnvironmentHealth :: *

Methods

request :: DescribeEnvironmentHealth -> Request DescribeEnvironmentHealth

response :: MonadResource m => Logger -> Service -> Proxy * DescribeEnvironmentHealth -> ClientResponse -> m (Response DescribeEnvironmentHealth)

ToPath DescribeEnvironmentHealth

Methods

toPath :: DescribeEnvironmentHealth -> ByteString

ToHeaders DescribeEnvironmentHealth

Methods

toHeaders :: DescribeEnvironmentHealth -> [Header]

ToQuery DescribeEnvironmentHealth

Methods

toQuery :: DescribeEnvironmentHealth -> QueryString

type Rep DescribeEnvironmentHealth

type Rep DescribeEnvironmentHealth = D1 (MetaData "DescribeEnvironmentHealth" "Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth" "amazonka-elasticbeanstalk-1.4.4-6xLHE3NeRVu3b9wYCxQH97" False) (C1 (MetaCons "DescribeEnvironmentHealth'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dehEnvironmentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dehAttributeNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [EnvironmentHealthAttribute]))) (S1 (MetaSel (Just Symbol "_dehEnvironmentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Rs DescribeEnvironmentHealth

type Rs DescribeEnvironmentHealth = DescribeEnvironmentHealthResponse

Request Lenses

dehEnvironmentName :: Lens' DescribeEnvironmentHealth (Maybe Text)

Specifies the AWS Elastic Beanstalk environment name.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

dehAttributeNames :: Lens' DescribeEnvironmentHealth [EnvironmentHealthAttribute]

Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk only returns the name of the environment.

dehEnvironmentId :: Lens' DescribeEnvironmentHealth (Maybe Text)

Specifies the AWS Elastic Beanstalk environment ID.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

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

Methods

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

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

Data DescribeEnvironmentHealthResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEnvironmentHealthResponse -> c DescribeEnvironmentHealthResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEnvironmentHealthResponse

toConstr :: DescribeEnvironmentHealthResponse -> Constr

dataTypeOf :: DescribeEnvironmentHealthResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEnvironmentHealthResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEnvironmentHealthResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeEnvironmentHealthResponse -> DescribeEnvironmentHealthResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEnvironmentHealthResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEnvironmentHealthResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeEnvironmentHealthResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEnvironmentHealthResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEnvironmentHealthResponse -> m DescribeEnvironmentHealthResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEnvironmentHealthResponse -> m DescribeEnvironmentHealthResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEnvironmentHealthResponse -> m DescribeEnvironmentHealthResponse

Read DescribeEnvironmentHealthResponse

Methods

readsPrec :: Int -> ReadS DescribeEnvironmentHealthResponse

readList :: ReadS [DescribeEnvironmentHealthResponse]

readPrec :: ReadPrec DescribeEnvironmentHealthResponse

readListPrec :: ReadPrec [DescribeEnvironmentHealthResponse]

Show DescribeEnvironmentHealthResponse

Methods

showsPrec :: Int -> DescribeEnvironmentHealthResponse -> ShowS

show :: DescribeEnvironmentHealthResponse -> String

showList :: [DescribeEnvironmentHealthResponse] -> ShowS

Generic DescribeEnvironmentHealthResponse

Associated Types

type Rep DescribeEnvironmentHealthResponse :: * -> *

Methods

from :: DescribeEnvironmentHealthResponse -> Rep DescribeEnvironmentHealthResponse x

to :: Rep DescribeEnvironmentHealthResponse x -> DescribeEnvironmentHealthResponse

NFData DescribeEnvironmentHealthResponse

Methods

rnf :: DescribeEnvironmentHealthResponse -> ()

type Rep DescribeEnvironmentHealthResponse

type Rep DescribeEnvironmentHealthResponse = D1 (MetaData "DescribeEnvironmentHealthResponse" "Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth" "amazonka-elasticbeanstalk-1.4.4-6xLHE3NeRVu3b9wYCxQH97" False) (C1 (MetaCons "DescribeEnvironmentHealthResponse'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dehrsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EnvironmentHealth))) (S1 (MetaSel (Just Symbol "_dehrsCauses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_dehrsApplicationMetrics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ApplicationMetrics))) (S1 (MetaSel (Just Symbol "_dehrsColor") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dehrsEnvironmentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dehrsHealthStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dehrsInstancesHealth") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe InstanceHealthSummary))) ((:*:) (S1 (MetaSel (Just Symbol "_dehrsRefreshedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) (S1 (MetaSel (Just Symbol "_dehrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))))

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.