aws_sdk_wellarchitected/client/
list_notifications.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 [`ListNotifications`](crate::operation::list_notifications::builders::ListNotificationsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_notifications::builders::ListNotificationsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`workload_id(impl Into<String>)`](crate::operation::list_notifications::builders::ListNotificationsFluentBuilder::workload_id) / [`set_workload_id(Option<String>)`](crate::operation::list_notifications::builders::ListNotificationsFluentBuilder::set_workload_id):<br>required: **false**<br><p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_notifications::builders::ListNotificationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_notifications::builders::ListNotificationsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use to retrieve the next set of results.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_notifications::builders::ListNotificationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_notifications::builders::ListNotificationsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return for this request.</p><br>
10    ///   - [`resource_arn(impl Into<String>)`](crate::operation::list_notifications::builders::ListNotificationsFluentBuilder::resource_arn) / [`set_resource_arn(Option<String>)`](crate::operation::list_notifications::builders::ListNotificationsFluentBuilder::set_resource_arn):<br>required: **false**<br><p>The ARN for the related resource for the notification.</p><note>  <p>Only one of <code>WorkloadID</code> or <code>ResourceARN</code> should be specified.</p> </note><br>
11    /// - On success, responds with [`ListNotificationsOutput`](crate::operation::list_notifications::ListNotificationsOutput) with field(s):
12    ///   - [`notification_summaries(Option<Vec::<NotificationSummary>>)`](crate::operation::list_notifications::ListNotificationsOutput::notification_summaries): <p>List of lens notification summaries in a workload.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_notifications::ListNotificationsOutput::next_token): <p>The token to use to retrieve the next set of results.</p>
14    /// - On failure, responds with [`SdkError<ListNotificationsError>`](crate::operation::list_notifications::ListNotificationsError)
15    pub fn list_notifications(&self) -> crate::operation::list_notifications::builders::ListNotificationsFluentBuilder {
16        crate::operation::list_notifications::builders::ListNotificationsFluentBuilder::new(self.handle.clone())
17    }
18}