AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DescribeInstancesHealth operation. Retrives detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElasticBeanstalk.AmazonElasticBeanstalkRequest
      Amazon.ElasticBeanstalk.Model.DescribeInstancesHealthRequest

Namespace: Amazon.ElasticBeanstalk.Model
Assembly: AWSSDK.ElasticBeanstalk.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeInstancesHealthRequest : AmazonElasticBeanstalkRequest
         IAmazonWebServiceRequest

The DescribeInstancesHealthRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AttributeNames System.Collections.Generic.List<System.String>

Gets and sets the property 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.

Public Property EnvironmentId System.String

Gets and sets the property EnvironmentId.

Specify the AWS Elastic Beanstalk environment by ID.

Public Property EnvironmentName System.String

Gets and sets the property EnvironmentName.

Specify the AWS Elastic Beanstalk environment by name.

Public Property NextToken System.String

Gets and sets the property NextToken.

Specify the pagination token returned by a previous call.

Examples

The following operation retrieves health information for instances in an environment named my-env:

To view environment health


var response = client.DescribeInstancesHealth(new DescribeInstancesHealthRequest 
{
    AttributeNames = new List {
        "All"
    },
    EnvironmentName = "my-env"
});

List instanceHealthList = response.InstanceHealthList;
DateTime refreshedAt = response.RefreshedAt;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms