aws_sdk_observabilityadmin/client/get_telemetry_evaluation_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 [`GetTelemetryEvaluationStatus`](crate::operation::get_telemetry_evaluation_status::builders::GetTelemetryEvaluationStatusFluentBuilder) operation.
4 ///
5 /// - The fluent builder takes no input, just [`send`](crate::operation::get_telemetry_evaluation_status::builders::GetTelemetryEvaluationStatusFluentBuilder::send) it.
6 /// - On success, responds with [`GetTelemetryEvaluationStatusOutput`](crate::operation::get_telemetry_evaluation_status::GetTelemetryEvaluationStatusOutput) with field(s):
7 /// - [`status(Option<Status>)`](crate::operation::get_telemetry_evaluation_status::GetTelemetryEvaluationStatusOutput::status): <p>The onboarding status of the telemetry config feature.</p>
8 /// - [`failure_reason(Option<String>)`](crate::operation::get_telemetry_evaluation_status::GetTelemetryEvaluationStatusOutput::failure_reason): <p>Describes the reason for the failure status. The field will only be populated if <code>Status</code> is <code>FAILED_START</code> or <code>FAILED_STOP</code>.</p>
9 /// - [`home_region(Option<String>)`](crate::operation::get_telemetry_evaluation_status::GetTelemetryEvaluationStatusOutput::home_region): <p>The Amazon Web Services Region that is designated as the home region for multi-region telemetry evaluation. The home region is the single management point for all multi-region operations on this account. This field is only present when multi-region telemetry evaluation is active.</p>
10 /// - [`region_statuses(Option<Vec::<RegionStatus>>)`](crate::operation::get_telemetry_evaluation_status::GetTelemetryEvaluationStatusOutput::region_statuses): <p>A list of per-region telemetry evaluation statuses. Each entry indicates the evaluation status for a specific spoke region included in the multi-region configuration. This field is only present when multi-region telemetry evaluation is active.</p>
11 /// - On failure, responds with [`SdkError<GetTelemetryEvaluationStatusError>`](crate::operation::get_telemetry_evaluation_status::GetTelemetryEvaluationStatusError)
12 pub fn get_telemetry_evaluation_status(
13 &self,
14 ) -> crate::operation::get_telemetry_evaluation_status::builders::GetTelemetryEvaluationStatusFluentBuilder {
15 crate::operation::get_telemetry_evaluation_status::builders::GetTelemetryEvaluationStatusFluentBuilder::new(self.handle.clone())
16 }
17}