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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.

Synopsis

Creating a Request

data DescribeInstancesHealth Source #

Parameters for a call to DescribeInstancesHealth.

See: newDescribeInstancesHealth smart constructor.

Constructors

DescribeInstancesHealth'

Fields

nextToken :: Maybe Text
Specify the pagination token returned by a previous call.
environmentName :: Maybe Text
Specify the AWS Elastic Beanstalk environment by name.
attributeNames :: Maybe [InstancesHealthAttribute]
Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no attribute names are specified, returns a list of instances.
environmentId :: Maybe Text
Specify the AWS Elastic Beanstalk environment by ID.

Instances

Instances details

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

newDescribeInstancesHealth :: DescribeInstancesHealth Source #

Create a value of DescribeInstancesHealth 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:nextToken:DescribeInstancesHealth', describeInstancesHealth_nextToken - Specify the pagination token returned by a previous call.

$sel:environmentName:DescribeInstancesHealth', describeInstancesHealth_environmentName - Specify the AWS Elastic Beanstalk environment by name.

$sel:attributeNames:DescribeInstancesHealth', describeInstancesHealth_attributeNames - Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no attribute names are specified, returns a list of instances.

$sel:environmentId:DescribeInstancesHealth', describeInstancesHealth_environmentId - Specify the AWS Elastic Beanstalk environment by ID.

Request Lenses

describeInstancesHealth_nextToken :: Lens' DescribeInstancesHealth (Maybe Text) Source #

Specify the pagination token returned by a previous call.

describeInstancesHealth_environmentName :: Lens' DescribeInstancesHealth (Maybe Text) Source #

Specify the AWS Elastic Beanstalk environment by name.

describeInstancesHealth_attributeNames :: Lens' DescribeInstancesHealth (Maybe [InstancesHealthAttribute]) Source #

Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no attribute names are specified, returns a list of instances.

describeInstancesHealth_environmentId :: Lens' DescribeInstancesHealth (Maybe Text) Source #

Specify the AWS Elastic Beanstalk environment by ID.

Destructuring the Response

data DescribeInstancesHealthResponse Source #

Detailed health information about the Amazon EC2 instances in an AWS Elastic Beanstalk environment.

See: newDescribeInstancesHealthResponse smart constructor.

Constructors

DescribeInstancesHealthResponse'

Fields

instanceHealthList :: Maybe [SingleInstanceHealth]
Detailed health information about each instance.
The output differs slightly between Linux and Windows environments. There is a difference in the members that are supported under the <CPUUtilization> type.
nextToken :: Maybe Text
Pagination token for the next page of results, if available.
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 DescribeInstancesHealthResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth Methods (==) :: DescribeInstancesHealthResponse -> DescribeInstancesHealthResponse -> Bool # (/=) :: DescribeInstancesHealthResponse -> DescribeInstancesHealthResponse -> Bool #
Read DescribeInstancesHealthResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth Methods readsPrec :: Int -> ReadS DescribeInstancesHealthResponse # readList :: ReadS [DescribeInstancesHealthResponse] # readPrec :: ReadPrec DescribeInstancesHealthResponse # readListPrec :: ReadPrec [DescribeInstancesHealthResponse] #
Show DescribeInstancesHealthResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth Methods showsPrec :: Int -> DescribeInstancesHealthResponse -> ShowS # show :: DescribeInstancesHealthResponse -> String # showList :: [DescribeInstancesHealthResponse] -> ShowS #
Generic DescribeInstancesHealthResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth Associated Types type Rep DescribeInstancesHealthResponse :: Type -> Type # Methods from :: DescribeInstancesHealthResponse -> Rep DescribeInstancesHealthResponse x # to :: Rep DescribeInstancesHealthResponse x -> DescribeInstancesHealthResponse #
NFData DescribeInstancesHealthResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth Methods rnf :: DescribeInstancesHealthResponse -> () #
type Rep DescribeInstancesHealthResponse Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth type Rep DescribeInstancesHealthResponse = D1 ('MetaData "DescribeInstancesHealthResponse" "Amazonka.ElasticBeanstalk.DescribeInstancesHealth" "libZSservicesZSamazonka-elasticbeanstalkZSamazonka-elasticbeanstalk" 'False) (C1 ('MetaCons "DescribeInstancesHealthResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "instanceHealthList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SingleInstanceHealth])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "refreshedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeInstancesHealthResponse Source #

Arguments

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

Create a value of DescribeInstancesHealthResponse 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:instanceHealthList:DescribeInstancesHealthResponse', describeInstancesHealthResponse_instanceHealthList - Detailed health information about each instance.

The output differs slightly between Linux and Windows environments. There is a difference in the members that are supported under the <CPUUtilization> type.

$sel:nextToken:DescribeInstancesHealth', describeInstancesHealthResponse_nextToken - Pagination token for the next page of results, if available.

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

$sel:httpStatus:DescribeInstancesHealthResponse', describeInstancesHealthResponse_httpStatus - The response's http status code.

Response Lenses

describeInstancesHealthResponse_instanceHealthList :: Lens' DescribeInstancesHealthResponse (Maybe [SingleInstanceHealth]) Source #

Detailed health information about each instance.

The output differs slightly between Linux and Windows environments. There is a difference in the members that are supported under the <CPUUtilization> type.

describeInstancesHealthResponse_nextToken :: Lens' DescribeInstancesHealthResponse (Maybe Text) Source #

Pagination token for the next page of results, if available.

describeInstancesHealthResponse_refreshedAt :: Lens' DescribeInstancesHealthResponse (Maybe UTCTime) Source #

The date and time that the health information was retrieved.

describeInstancesHealthResponse_httpStatus :: Lens' DescribeInstancesHealthResponse Int Source #

The response's http status code.