instances_health_status

Creates, updates, deletes, gets or lists an instances_health_status resource.

Overview

Name	instances_health_status
Type	Resource
Id	aws.servicediscovery.instances_health_status

Fields

The following fields are returned by SELECT queries:

get_instances_health_status

Name	Datatype	Description
next_token	string	If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
status	object	A complex type that contains the IDs and the health status of the instances that you specified in the GetInstancesHealthStatus request.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_instances_health_status	select	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_instances_health_status

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.

SELECT
next_token,
status
FROM aws.servicediscovery.instances_health_status
WHERE region = '{{ region }}' -- required
;