aws_sdk_forecast/client/describe_monitor.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 [`DescribeMonitor`](crate::operation::describe_monitor::builders::DescribeMonitorFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`monitor_arn(impl Into<String>)`](crate::operation::describe_monitor::builders::DescribeMonitorFluentBuilder::monitor_arn) / [`set_monitor_arn(Option<String>)`](crate::operation::describe_monitor::builders::DescribeMonitorFluentBuilder::set_monitor_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the monitor resource to describe.</p><br>
7 /// - On success, responds with [`DescribeMonitorOutput`](crate::operation::describe_monitor::DescribeMonitorOutput) with field(s):
8 /// - [`monitor_name(Option<String>)`](crate::operation::describe_monitor::DescribeMonitorOutput::monitor_name): <p>The name of the monitor.</p>
9 /// - [`monitor_arn(Option<String>)`](crate::operation::describe_monitor::DescribeMonitorOutput::monitor_arn): <p>The Amazon Resource Name (ARN) of the monitor resource described.</p>
10 /// - [`resource_arn(Option<String>)`](crate::operation::describe_monitor::DescribeMonitorOutput::resource_arn): <p>The Amazon Resource Name (ARN) of the auto predictor being monitored.</p>
11 /// - [`status(Option<String>)`](crate::operation::describe_monitor::DescribeMonitorOutput::status): <p>The status of the monitor resource.</p>
12 /// - [`last_evaluation_time(Option<DateTime>)`](crate::operation::describe_monitor::DescribeMonitorOutput::last_evaluation_time): <p>The timestamp of the latest evaluation completed by the monitor.</p>
13 /// - [`last_evaluation_state(Option<String>)`](crate::operation::describe_monitor::DescribeMonitorOutput::last_evaluation_state): <p>The state of the monitor's latest evaluation.</p>
14 /// - [`baseline(Option<Baseline>)`](crate::operation::describe_monitor::DescribeMonitorOutput::baseline): <p>Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor.</p>
15 /// - [`message(Option<String>)`](crate::operation::describe_monitor::DescribeMonitorOutput::message): <p>An error message, if any, for the monitor.</p>
16 /// - [`creation_time(Option<DateTime>)`](crate::operation::describe_monitor::DescribeMonitorOutput::creation_time): <p>The timestamp for when the monitor resource was created.</p>
17 /// - [`last_modification_time(Option<DateTime>)`](crate::operation::describe_monitor::DescribeMonitorOutput::last_modification_time): <p>The timestamp of the latest modification to the monitor.</p>
18 /// - [`estimated_evaluation_time_remaining_in_minutes(Option<i64>)`](crate::operation::describe_monitor::DescribeMonitorOutput::estimated_evaluation_time_remaining_in_minutes): <p>The estimated number of minutes remaining before the monitor resource finishes its current evaluation.</p>
19 /// - On failure, responds with [`SdkError<DescribeMonitorError>`](crate::operation::describe_monitor::DescribeMonitorError)
20 pub fn describe_monitor(&self) -> crate::operation::describe_monitor::builders::DescribeMonitorFluentBuilder {
21 crate::operation::describe_monitor::builders::DescribeMonitorFluentBuilder::new(self.handle.clone())
22 }
23}