aws_sdk_notifications/client/
list_notification_events.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 [`ListNotificationEvents`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`start_time(DateTime)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::set_start_time):<br>required: **false**<br><p>The earliest time of events to return from this call.</p><br>
8    ///   - [`end_time(DateTime)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::set_end_time):<br>required: **false**<br><p>Latest time of events to return from this call.</p><br>
9    ///   - [`locale(LocaleCode)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::locale) / [`set_locale(Option<LocaleCode>)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::set_locale):<br>required: **false**<br><p>The locale code of the language used for the retrieved <code>NotificationEvent</code>. The default locale is English <code>(en_US)</code>.</p><br>
10    ///   - [`source(impl Into<String>)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::source) / [`set_source(Option<String>)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::set_source):<br>required: **false**<br><p>The matched event source.</p> <p>Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p><br>
11    ///   - [`include_child_events(bool)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::include_child_events) / [`set_include_child_events(Option<bool>)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::set_include_child_events):<br>required: **false**<br><p>Include aggregated child events in the result.</p><br>
12    ///   - [`aggregate_notification_event_arn(impl Into<String>)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::aggregate_notification_event_arn) / [`set_aggregate_notification_event_arn(Option<String>)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::set_aggregate_notification_event_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the <code>aggregatedNotificationEventArn</code> to match.</p><br>
13    ///   - [`max_results(i32)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to be returned in this call. Defaults to 20.</p><br>
14    ///   - [`next_token(impl Into<String>)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::set_next_token):<br>required: **false**<br><p>The start token for paginated calls. Retrieved from the response of a previous <code>ListEventRules</code> call. Next token uses Base64 encoding.</p><br>
15    ///   - [`organizational_unit_id(impl Into<String>)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::organizational_unit_id) / [`set_organizational_unit_id(Option<String>)`](crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::set_organizational_unit_id):<br>required: **false**<br><p>The unique identifier of the organizational unit used to filter notification events.</p><br>
16    /// - On success, responds with [`ListNotificationEventsOutput`](crate::operation::list_notification_events::ListNotificationEventsOutput) with field(s):
17    ///   - [`next_token(Option<String>)`](crate::operation::list_notification_events::ListNotificationEventsOutput::next_token): <p>A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.</p>
18    ///   - [`notification_events(Vec::<NotificationEventOverview>)`](crate::operation::list_notification_events::ListNotificationEventsOutput::notification_events): <p>The list of notification events.</p>
19    /// - On failure, responds with [`SdkError<ListNotificationEventsError>`](crate::operation::list_notification_events::ListNotificationEventsError)
20    pub fn list_notification_events(&self) -> crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder {
21        crate::operation::list_notification_events::builders::ListNotificationEventsFluentBuilder::new(self.handle.clone())
22    }
23}