aws_sdk_route53/client/
get_health_check_status.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetHealthCheckStatus`](crate::operation::get_health_check_status::builders::GetHealthCheckStatusFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`health_check_id(impl Into<String>)`](crate::operation::get_health_check_status::builders::GetHealthCheckStatusFluentBuilder::health_check_id) / [`set_health_check_id(Option<String>)`](crate::operation::get_health_check_status::builders::GetHealthCheckStatusFluentBuilder::set_health_check_id):<br>required: **true**<br><p>The ID for the health check that you want the current status for. When you created the health check, <code>CreateHealthCheck</code> returned the ID in the response, in the <code>HealthCheckId</code> element.</p><note>  <p>If you want to check the status of a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use <code>GetHealthCheckStatus</code> to get the status of a calculated health check.</p> </note><br>
7    /// - On success, responds with [`GetHealthCheckStatusOutput`](crate::operation::get_health_check_status::GetHealthCheckStatusOutput) with field(s):
8    ///   - [`health_check_observations(Vec::<HealthCheckObservation>)`](crate::operation::get_health_check_status::GetHealthCheckStatusOutput::health_check_observations): <p>A list that contains one <code>HealthCheckObservation</code> element for each Amazon Route 53 health checker that is reporting a status about the health check endpoint.</p>
9    /// - On failure, responds with [`SdkError<GetHealthCheckStatusError>`](crate::operation::get_health_check_status::GetHealthCheckStatusError)
10    pub fn get_health_check_status(&self) -> crate::operation::get_health_check_status::builders::GetHealthCheckStatusFluentBuilder {
11        crate::operation::get_health_check_status::builders::GetHealthCheckStatusFluentBuilder::new(self.handle.clone())
12    }
13}