aws_sdk_sagemaker/client/list_monitoring_alerts.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 [`ListMonitoringAlerts`](crate::operation::list_monitoring_alerts::builders::ListMonitoringAlertsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_monitoring_alerts::builders::ListMonitoringAlertsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`monitoring_schedule_name(impl Into<String>)`](crate::operation::list_monitoring_alerts::builders::ListMonitoringAlertsFluentBuilder::monitoring_schedule_name) / [`set_monitoring_schedule_name(Option<String>)`](crate::operation::list_monitoring_alerts::builders::ListMonitoringAlertsFluentBuilder::set_monitoring_schedule_name):<br>required: **true**<br><p>The name of a monitoring schedule.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::list_monitoring_alerts::builders::ListMonitoringAlertsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_monitoring_alerts::builders::ListMonitoringAlertsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the result of the previous <code>ListMonitoringAlerts</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of alerts in the history, use the token in the next request.</p><br>
9 /// - [`max_results(i32)`](crate::operation::list_monitoring_alerts::builders::ListMonitoringAlertsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_monitoring_alerts::builders::ListMonitoringAlertsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to display. The default is 100.</p><br>
10 /// - On success, responds with [`ListMonitoringAlertsOutput`](crate::operation::list_monitoring_alerts::ListMonitoringAlertsOutput) with field(s):
11 /// - [`monitoring_alert_summaries(Option<Vec::<MonitoringAlertSummary>>)`](crate::operation::list_monitoring_alerts::ListMonitoringAlertsOutput::monitoring_alert_summaries): <p>A JSON array where each element is a summary for a monitoring alert.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_monitoring_alerts::ListMonitoringAlertsOutput::next_token): <p>If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.</p>
13 /// - On failure, responds with [`SdkError<ListMonitoringAlertsError>`](crate::operation::list_monitoring_alerts::ListMonitoringAlertsError)
14 pub fn list_monitoring_alerts(&self) -> crate::operation::list_monitoring_alerts::builders::ListMonitoringAlertsFluentBuilder {
15 crate::operation::list_monitoring_alerts::builders::ListMonitoringAlertsFluentBuilder::new(self.handle.clone())
16 }
17}