aws_sdk_lightsail/client/
get_alarms.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 [`GetAlarms`](crate::operation::get_alarms::builders::GetAlarmsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`alarm_name(impl Into<String>)`](crate::operation::get_alarms::builders::GetAlarmsFluentBuilder::alarm_name) / [`set_alarm_name(Option<String>)`](crate::operation::get_alarms::builders::GetAlarmsFluentBuilder::set_alarm_name):<br>required: **false**<br><p>The name of the alarm.</p> <p>Specify an alarm name to return information about a specific alarm.</p><br>
7    ///   - [`page_token(impl Into<String>)`](crate::operation::get_alarms::builders::GetAlarmsFluentBuilder::page_token) / [`set_page_token(Option<String>)`](crate::operation::get_alarms::builders::GetAlarmsFluentBuilder::set_page_token):<br>required: **false**<br><p>The token to advance to the next page of results from your request.</p> <p>To get a page token, perform an initial <code>GetAlarms</code> request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.</p><br>
8    ///   - [`monitored_resource_name(impl Into<String>)`](crate::operation::get_alarms::builders::GetAlarmsFluentBuilder::monitored_resource_name) / [`set_monitored_resource_name(Option<String>)`](crate::operation::get_alarms::builders::GetAlarmsFluentBuilder::set_monitored_resource_name):<br>required: **false**<br><p>The name of the Lightsail resource being monitored by the alarm.</p> <p>Specify a monitored resource name to return information about all alarms for a specific resource.</p><br>
9    /// - On success, responds with [`GetAlarmsOutput`](crate::operation::get_alarms::GetAlarmsOutput) with field(s):
10    ///   - [`alarms(Option<Vec::<Alarm>>)`](crate::operation::get_alarms::GetAlarmsOutput::alarms): <p>An array of objects that describe the alarms.</p>
11    ///   - [`next_page_token(Option<String>)`](crate::operation::get_alarms::GetAlarmsOutput::next_page_token): <p>The token to advance to the next page of results from your request.</p> <p>A next page token is not returned if there are no more results to display.</p> <p>To get the next page of results, perform another <code>GetAlarms</code> request and specify the next page token using the <code>pageToken</code> parameter.</p>
12    /// - On failure, responds with [`SdkError<GetAlarmsError>`](crate::operation::get_alarms::GetAlarmsError)
13    pub fn get_alarms(&self) -> crate::operation::get_alarms::builders::GetAlarmsFluentBuilder {
14        crate::operation::get_alarms::builders::GetAlarmsFluentBuilder::new(self.handle.clone())
15    }
16}
aws_sdk_lightsail/client/get_alarms.rs

aws_sdk_lightsail/client/
get_alarms.rs
