AutoScaling / Client / set_instance_health

set_instance_health#

AutoScaling.Client.set_instance_health(**kwargs)#

Sets the health status of the specified instance.

For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.

response = client.set_instance_health(
    InstanceId='string',
    HealthStatus='string',
    ShouldRespectGracePeriod=True|False
)

Parameters:

InstanceId (string) –
[REQUIRED]

The ID of the instance.
HealthStatus (string) –
[REQUIRED]

The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.
ShouldRespectGracePeriod (boolean) –
If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set this to False, to have the call not respect the grace period associated with the group.

For more information about the health check grace period, see CreateAutoScalingGroup in the Amazon EC2 Auto Scaling API Reference.

Returns:

None

This example sets the health status of the specified instance to Unhealthy.

response = client.set_instance_health(
    HealthStatus='Unhealthy',
    InstanceId='i-93633f9b',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}