aws_sdk_networkmonitor/client/
get_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 [`GetMonitor`](crate::operation::get_monitor::builders::GetMonitorFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`monitor_name(impl Into<String>)`](crate::operation::get_monitor::builders::GetMonitorFluentBuilder::monitor_name) / [`set_monitor_name(Option<String>)`](crate::operation::get_monitor::builders::GetMonitorFluentBuilder::set_monitor_name):<br>required: **true**<br><p>The name of the monitor that details are returned for.</p><br>
7    /// - On success, responds with [`GetMonitorOutput`](crate::operation::get_monitor::GetMonitorOutput) with field(s):
8    ///   - [`monitor_arn(String)`](crate::operation::get_monitor::GetMonitorOutput::monitor_arn): <p>The ARN of the selected monitor.</p>
9    ///   - [`monitor_name(String)`](crate::operation::get_monitor::GetMonitorOutput::monitor_name): <p>The name of the monitor.</p>
10    ///   - [`state(MonitorState)`](crate::operation::get_monitor::GetMonitorOutput::state): <p>Lists the status of the <code>state</code> of each monitor.</p>
11    ///   - [`aggregation_period(i64)`](crate::operation::get_monitor::GetMonitorOutput::aggregation_period): <p>The aggregation period for the specified monitor.</p>
12    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_monitor::GetMonitorOutput::tags): <p>The list of key-value pairs assigned to the monitor.</p>
13    ///   - [`probes(Option<Vec::<Probe>>)`](crate::operation::get_monitor::GetMonitorOutput::probes): <p>The details about each probe associated with that monitor.</p>
14    ///   - [`created_at(DateTime)`](crate::operation::get_monitor::GetMonitorOutput::created_at): <p>The time and date when the monitor was created.</p>
15    ///   - [`modified_at(DateTime)`](crate::operation::get_monitor::GetMonitorOutput::modified_at): <p>The time and date when the monitor was last modified.</p>
16    /// - On failure, responds with [`SdkError<GetMonitorError>`](crate::operation::get_monitor::GetMonitorError)
17    pub fn get_monitor(&self) -> crate::operation::get_monitor::builders::GetMonitorFluentBuilder {
18        crate::operation::get_monitor::builders::GetMonitorFluentBuilder::new(self.handle.clone())
19    }
20}