aws_sdk_devopsguru/client/
list_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 [`ListEvents`](crate::operation::list_events::builders::ListEventsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_events::builders::ListEventsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`filters(ListEventsFilters)`](crate::operation::list_events::builders::ListEventsFluentBuilder::filters) / [`set_filters(Option<ListEventsFilters>)`](crate::operation::list_events::builders::ListEventsFluentBuilder::set_filters):<br>required: **true**<br><p>A <code>ListEventsFilters</code> object used to specify which events to return.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_events::builders::ListEventsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_events::builders::ListEventsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_events::builders::ListEventsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_events::builders::ListEventsFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p><br>
10    ///   - [`account_id(impl Into<String>)`](crate::operation::list_events::builders::ListEventsFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::list_events::builders::ListEventsFluentBuilder::set_account_id):<br>required: **false**<br><p>The ID of the Amazon Web Services account.</p><br>
11    /// - On success, responds with [`ListEventsOutput`](crate::operation::list_events::ListEventsOutput) with field(s):
12    ///   - [`events(Vec::<Event>)`](crate::operation::list_events::ListEventsOutput::events): <p>A list of the requested events.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_events::ListEventsOutput::next_token): <p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>
14    /// - On failure, responds with [`SdkError<ListEventsError>`](crate::operation::list_events::ListEventsError)
15    pub fn list_events(&self) -> crate::operation::list_events::builders::ListEventsFluentBuilder {
16        crate::operation::list_events::builders::ListEventsFluentBuilder::new(self.handle.clone())
17    }
18}