aws_sdk_internetmonitor/client/

get_monitor.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetMonitor`](crate::operation::get_monitor::builders::GetMonitorFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`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.</p><br>
    ///   - [`linked_account_id(impl Into<String>)`](crate::operation::get_monitor::builders::GetMonitorFluentBuilder::linked_account_id) / [`set_linked_account_id(Option<String>)`](crate::operation::get_monitor::builders::GetMonitorFluentBuilder::set_linked_account_id):<br>required: **false**<br><p>The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html">Internet Monitor cross-account observability</a> in the Amazon CloudWatch Internet Monitor User Guide.</p><br>
    /// - On success, responds with [`GetMonitorOutput`](crate::operation::get_monitor::GetMonitorOutput) with field(s):
    ///   - [`monitor_name(String)`](crate::operation::get_monitor::GetMonitorOutput::monitor_name): <p>The name of the monitor.</p>
    ///   - [`monitor_arn(String)`](crate::operation::get_monitor::GetMonitorOutput::monitor_arn): <p>The Amazon Resource Name (ARN) of the monitor.</p>
    ///   - [`resources(Vec::<String>)`](crate::operation::get_monitor::GetMonitorOutput::resources): <p>The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).</p>
    ///   - [`status(MonitorConfigState)`](crate::operation::get_monitor::GetMonitorOutput::status): <p>The status of the monitor.</p>
    ///   - [`created_at(DateTime)`](crate::operation::get_monitor::GetMonitorOutput::created_at): <p>The time when the monitor was created.</p>
    ///   - [`modified_at(DateTime)`](crate::operation::get_monitor::GetMonitorOutput::modified_at): <p>The last time that the monitor was modified.</p>
    ///   - [`processing_status(Option<MonitorProcessingStatusCode>)`](crate::operation::get_monitor::GetMonitorOutput::processing_status): <p>The health of the data processing for the monitor.</p>
    ///   - [`processing_status_info(Option<String>)`](crate::operation::get_monitor::GetMonitorOutput::processing_status_info): <p>Additional information about the health of the data processing for the monitor.</p>
    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_monitor::GetMonitorOutput::tags): <p>The tags that have been added to monitor.</p>
    ///   - [`max_city_networks_to_monitor(Option<i32>)`](crate::operation::get_monitor::GetMonitorOutput::max_city_networks_to_monitor): <p>The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. This limit can help control billing costs.</p> <p>To learn more, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html">Choosing a city-network maximum value </a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
    ///   - [`internet_measurements_log_delivery(Option<InternetMeasurementsLogDelivery>)`](crate::operation::get_monitor::GetMonitorOutput::internet_measurements_log_delivery): <p>Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.</p>
    ///   - [`traffic_percentage_to_monitor(Option<i32>)`](crate::operation::get_monitor::GetMonitorOutput::traffic_percentage_to_monitor): <p>The percentage of the internet-facing traffic for your application to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.</p> <p>To learn more, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html">Choosing an application traffic percentage to monitor </a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
    ///   - [`health_events_config(Option<HealthEventsConfig>)`](crate::operation::get_monitor::GetMonitorOutput::health_events_config): <p>The list of health event threshold configurations. The threshold percentage for a health score determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview"> Change health event thresholds</a> in the Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
    /// - On failure, responds with [`SdkError<GetMonitorError>`](crate::operation::get_monitor::GetMonitorError)
    pub fn get_monitor(&self) -> crate::operation::get_monitor::builders::GetMonitorFluentBuilder {
        crate::operation::get_monitor::builders::GetMonitorFluentBuilder::new(self.handle.clone())
    }
}