libZSservicesZSamazonka-elasticbeanstalkZSamazonka-elasticbeanstalk
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ElasticBeanstalk.DescribeInstancesHealth

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

Instances

Instances details
Eq DescribeInstancesHealth Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth

Read DescribeInstancesHealth Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth

Show DescribeInstancesHealth Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth

Generic DescribeInstancesHealth Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth

Associated Types

type Rep DescribeInstancesHealth :: Type -> Type #

NFData DescribeInstancesHealth Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth

Methods

rnf :: DescribeInstancesHealth -> () #

Hashable DescribeInstancesHealth Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth

AWSRequest DescribeInstancesHealth Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth

ToHeaders DescribeInstancesHealth Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth

ToPath DescribeInstancesHealth Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth

ToQuery DescribeInstancesHealth Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth

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

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

Instances

Instances details
Eq DescribeInstancesHealthResponse Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth

Read DescribeInstancesHealthResponse Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth

Show DescribeInstancesHealthResponse Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth

Generic DescribeInstancesHealthResponse Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth

Associated Types

type Rep DescribeInstancesHealthResponse :: Type -> Type #

NFData DescribeInstancesHealthResponse Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.DescribeInstancesHealth

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 #

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.