aws_sdk_lookoutmetrics/client/list_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 [`ListAlerts`](crate::operation::list_alerts::builders::ListAlertsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_alerts::builders::ListAlertsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`anomaly_detector_arn(impl Into<String>)`](crate::operation::list_alerts::builders::ListAlertsFluentBuilder::anomaly_detector_arn) / [`set_anomaly_detector_arn(Option<String>)`](crate::operation::list_alerts::builders::ListAlertsFluentBuilder::set_anomaly_detector_arn):<br>required: **false**<br><p>The ARN of the alert's detector.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::list_alerts::builders::ListAlertsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_alerts::builders::ListAlertsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the result of the previous request is truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</p><br>
9 /// - [`max_results(i32)`](crate::operation::list_alerts::builders::ListAlertsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_alerts::builders::ListAlertsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results that will be displayed by the request.</p><br>
10 /// - On success, responds with [`ListAlertsOutput`](crate::operation::list_alerts::ListAlertsOutput) with field(s):
11 /// - [`alert_summary_list(Option<Vec::<AlertSummary>>)`](crate::operation::list_alerts::ListAlertsOutput::alert_summary_list): <p>Contains information about an alert.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_alerts::ListAlertsOutput::next_token): <p>If the response is truncated, the service returns this token. To retrieve the next set of results, use this token in the next request.</p>
13 /// - On failure, responds with [`SdkError<ListAlertsError>`](crate::operation::list_alerts::ListAlertsError)
14 pub fn list_alerts(&self) -> crate::operation::list_alerts::builders::ListAlertsFluentBuilder {
15 crate::operation::list_alerts::builders::ListAlertsFluentBuilder::new(self.handle.clone())
16 }
17}