Struct aws_sdk_servicediscovery::client::fluent_builders::GetInstancesHealthStatus

pub struct GetInstancesHealthStatus { /* private fields */ }

Fluent builder constructing a request to GetInstancesHealthStatus.

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.

Implementations

impl GetInstancesHealthStatus

pub async fn send(
    self
) -> Result<GetInstancesHealthStatusOutput, SdkError<GetInstancesHealthStatusError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> GetInstancesHealthStatusPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn service_id(self, input: impl Into<String>) -> Self

The ID of the service that the instance is associated with.

pub fn set_service_id(self, input: Option<String>) -> Self

The ID of the service that the instance is associated with.

pub fn instances(self, input: impl Into<String>) -> Self

Appends an item to Instances.

To override the contents of this collection use set_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 ListInstances request.

pub fn set_instances(self, input: Option<Vec<String>>) -> Self

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 ListInstances request.

pub fn max_results(self, input: i32) -> Self

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

pub fn set_max_results(self, input: Option<i32>) -> Self

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

pub fn next_token(self, input: impl Into<String>) -> Self

For the first GetInstancesHealthStatus request, omit this value.

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.

pub fn set_next_token(self, input: Option<String>) -> Self

For the first GetInstancesHealthStatus request, omit this value.

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.

Trait Implementations

impl Clone for GetInstancesHealthStatus

fn clone(&self) -> GetInstancesHealthStatus

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetInstancesHealthStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.