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.

Submits a request to change the health status of a custom health check to healthy or unhealthy.

You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the status for RouteĀ 53 health checks, which you define using HealthCheckConfig.

For more information, see HealthCheckCustomConfig.

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 BeginUpdateInstanceCustomHealthStatus and EndUpdateInstanceCustomHealthStatus.

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

Syntax

C#
public virtual Task<UpdateInstanceCustomHealthStatusResponse> UpdateInstanceCustomHealthStatusAsync(
         UpdateInstanceCustomHealthStatusRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ServiceDiscovery.Model.UpdateInstanceCustomHealthStatusRequest

Container for the necessary parameters to execute the UpdateInstanceCustomHealthStatus 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 UpdateInstanceCustomHealthStatus service method, as returned by ServiceDiscovery.

Exceptions

ExceptionCondition
CustomHealthNotFoundException The health check for the instance that's specified by ServiceId and InstanceId isn't a custom health check.
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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also