aws_sdk_medialive/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    ///   - [`channel_id(impl Into<String>)`](crate::operation::list_alerts::builders::ListAlertsFluentBuilder::channel_id) / [`set_channel_id(Option<String>)`](crate::operation::list_alerts::builders::ListAlertsFluentBuilder::set_channel_id):<br>required: **true**<br>The unique ID of the channel<br>
8    ///   - [`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>The maximum number of items to return<br>
9    ///   - [`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>The next pagination token<br>
10    ///   - [`state_filter(impl Into<String>)`](crate::operation::list_alerts::builders::ListAlertsFluentBuilder::state_filter) / [`set_state_filter(Option<String>)`](crate::operation::list_alerts::builders::ListAlertsFluentBuilder::set_state_filter):<br>required: **false**<br>Specifies the set of alerts to return based on their state. SET - Return only alerts with SET state. CLEARED - Return only alerts with CLEARED state. ALL - Return all alerts.<br>
11    /// - On success, responds with [`ListAlertsOutput`](crate::operation::list_alerts::ListAlertsOutput) with field(s):
12    ///   - [`alerts(Option<Vec::<ChannelAlert>>)`](crate::operation::list_alerts::ListAlertsOutput::alerts): The alerts found for this channel
13    ///   - [`next_token(Option<String>)`](crate::operation::list_alerts::ListAlertsOutput::next_token): The token to use to retrieve the next page of results
14    /// - On failure, responds with [`SdkError<ListAlertsError>`](crate::operation::list_alerts::ListAlertsError)
15    pub fn list_alerts(&self) -> crate::operation::list_alerts::builders::ListAlertsFluentBuilder {
16        crate::operation::list_alerts::builders::ListAlertsFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_medialive/client/list_alerts.rs

aws_sdk_medialive/client/
list_alerts.rs
