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

Network.AWS.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

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 to All . 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.

Instances

Eq DescribeEnvironmentHealth Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth Methods (==) :: DescribeEnvironmentHealth -> DescribeEnvironmentHealth -> Bool # (/=) :: DescribeEnvironmentHealth -> DescribeEnvironmentHealth -> Bool #
Data DescribeEnvironmentHealth Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.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 Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth Methods readsPrec :: Int -> ReadS DescribeEnvironmentHealth # readList :: ReadS [DescribeEnvironmentHealth] # readPrec :: ReadPrec DescribeEnvironmentHealth # readListPrec :: ReadPrec [DescribeEnvironmentHealth] #
Show DescribeEnvironmentHealth Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth Methods showsPrec :: Int -> DescribeEnvironmentHealth -> ShowS # show :: DescribeEnvironmentHealth -> String # showList :: [DescribeEnvironmentHealth] -> ShowS #
Generic DescribeEnvironmentHealth Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth Associated Types type Rep DescribeEnvironmentHealth :: Type -> Type # Methods from :: DescribeEnvironmentHealth -> Rep DescribeEnvironmentHealth x # to :: Rep DescribeEnvironmentHealth x -> DescribeEnvironmentHealth #
Hashable DescribeEnvironmentHealth Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth Methods hashWithSalt :: Int -> DescribeEnvironmentHealth -> Int # hash :: DescribeEnvironmentHealth -> Int #
AWSRequest DescribeEnvironmentHealth Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth Associated Types type Rs DescribeEnvironmentHealth :: Type # Methods request :: DescribeEnvironmentHealth -> Request DescribeEnvironmentHealth # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeEnvironmentHealth -> ClientResponse -> m (Response DescribeEnvironmentHealth) #
ToHeaders DescribeEnvironmentHealth Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth Methods toHeaders :: DescribeEnvironmentHealth -> [Header] #
ToPath DescribeEnvironmentHealth Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth Methods toPath :: DescribeEnvironmentHealth -> ByteString #
ToQuery DescribeEnvironmentHealth Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth Methods toQuery :: DescribeEnvironmentHealth -> QueryString #
NFData DescribeEnvironmentHealth Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth Methods rnf :: DescribeEnvironmentHealth -> () #
type Rep DescribeEnvironmentHealth Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth type Rep DescribeEnvironmentHealth = D1 (MetaData "DescribeEnvironmentHealth" "Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth" "amazonka-elasticbeanstalk-1.6.1-3CoYM4SK8sc46jAbvlY69V" False) (C1 (MetaCons "DescribeEnvironmentHealth'" PrefixI True) (S1 (MetaSel (Just "_dehEnvironmentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_dehAttributeNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [EnvironmentHealthAttribute])) :: S1 (MetaSel (Just "_dehEnvironmentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))
type Rs DescribeEnvironmentHealth Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth type Rs DescribeEnvironmentHealth = DescribeEnvironmentHealthResponse

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 #

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 - The environment's operational status. Ready , Launching , Updating , Terminating , or Terminated .
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.

Instances

Eq DescribeEnvironmentHealthResponse Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth Methods (==) :: DescribeEnvironmentHealthResponse -> DescribeEnvironmentHealthResponse -> Bool # (/=) :: DescribeEnvironmentHealthResponse -> DescribeEnvironmentHealthResponse -> Bool #
Data DescribeEnvironmentHealthResponse Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth 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 Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth Methods readsPrec :: Int -> ReadS DescribeEnvironmentHealthResponse # readList :: ReadS [DescribeEnvironmentHealthResponse] # readPrec :: ReadPrec DescribeEnvironmentHealthResponse # readListPrec :: ReadPrec [DescribeEnvironmentHealthResponse] #
Show DescribeEnvironmentHealthResponse Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth Methods showsPrec :: Int -> DescribeEnvironmentHealthResponse -> ShowS # show :: DescribeEnvironmentHealthResponse -> String # showList :: [DescribeEnvironmentHealthResponse] -> ShowS #
Generic DescribeEnvironmentHealthResponse Source #
Instance details Defined in Network.AWS.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 Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth Methods rnf :: DescribeEnvironmentHealthResponse -> () #
type Rep DescribeEnvironmentHealthResponse Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth type Rep DescribeEnvironmentHealthResponse = D1 (MetaData "DescribeEnvironmentHealthResponse" "Network.AWS.ElasticBeanstalk.DescribeEnvironmentHealth" "amazonka-elasticbeanstalk-1.6.1-3CoYM4SK8sc46jAbvlY69V" False) (C1 (MetaCons "DescribeEnvironmentHealthResponse'" PrefixI True) (((S1 (MetaSel (Just "_dehrsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EnvironmentHealth)) :: S1 (MetaSel (Just "_dehrsCauses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 (MetaSel (Just "_dehrsApplicationMetrics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ApplicationMetrics)) :: S1 (MetaSel (Just "_dehrsColor") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_dehrsEnvironmentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_dehrsHealthStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_dehrsInstancesHealth") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe InstanceHealthSummary)) :: (S1 (MetaSel (Just "_dehrsRefreshedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 (MetaSel (Just "_dehrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))))