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.

Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service.

There's a brief delay between when you register an instance and when the health status for the instance is available.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginGetInstancesHealthStatus and EndGetInstancesHealthStatus.

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

Syntax

C#
public abstract Task<GetInstancesHealthStatusResponse> GetInstancesHealthStatusAsync(
         GetInstancesHealthStatusRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ServiceDiscovery.Model.GetInstancesHealthStatusRequest

Container for the necessary parameters to execute the GetInstancesHealthStatus service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the GetInstancesHealthStatus service method, as returned by ServiceDiscovery.

Exceptions

ExceptionCondition
InstanceNotFoundException No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
InvalidInputException One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
ServiceNotFoundException No service exists with the specified ID.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also