Skip to content

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

Description

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.

Usage

servicediscovery_get_instances_health_status(ServiceId, Instances,
  MaxResults, NextToken)

Arguments

  • ServiceId

    [required] The ID or Amazon Resource Name (ARN) of the service that the instance is associated with. For services created in a shared namespace, specify the service ARN. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.

  • Instances

    An array that contains the IDs of all the instances that you want to get the health status for.

    If you omit Instances, Cloud Map returns the health status for all the instances that are associated with the specified service.

    To get the IDs for the instances that you've registered by using a specified service, submit a list_instances request.

  • MaxResults

    The maximum number of instances that you want Cloud Map to return in the response to a get_instances_health_status request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances.

  • NextToken

    For the first get_instances_health_status request, omit this value.

    If more than MaxResults instances match the specified criteria, you can submit another get_instances_health_status request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

Value

A list with the following syntax:

list(
  Status = list(
    "HEALTHY"|"UNHEALTHY"|"UNKNOWN"
  ),
  NextToken = "string"
)

Request syntax

svc$get_instances_health_status(
  ServiceId = "string",
  Instances = list(
    "string"
  ),
  MaxResults = 123,
  NextToken = "string"
)

Examples

# This example gets the current health status of one or more instances
# that are associate with a specified service.
svc$get_instances_health_status(
  ServiceId = "srv-e4anhexample0004"
)