aws_sdk_ssmsap/client/
list_operation_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 [`ListOperationEvents`](crate::operation::list_operation_events::builders::ListOperationEventsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_operation_events::builders::ListOperationEventsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`operation_id(impl Into<String>)`](crate::operation::list_operation_events::builders::ListOperationEventsFluentBuilder::operation_id) / [`set_operation_id(Option<String>)`](crate::operation::list_operation_events::builders::ListOperationEventsFluentBuilder::set_operation_id):<br>required: **true**<br><p>The ID of the operation.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_operation_events::builders::ListOperationEventsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_operation_events::builders::ListOperationEventsFluentBuilder::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 nextToken value.</p> <p>If you do not specify a value for <code>MaxResults</code>, the request returns 50 items per page by default.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_operation_events::builders::ListOperationEventsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_operation_events::builders::ListOperationEventsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use to retrieve the next page of results. This value is null when there are no more results to return.</p><br>
10    ///   - [`filters(Filter)`](crate::operation::list_operation_events::builders::ListOperationEventsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::list_operation_events::builders::ListOperationEventsFluentBuilder::set_filters):<br>required: **false**<br><p>Optionally specify filters to narrow the returned operation event items.</p> <p>Valid filter names include <code>status</code>, <code>resourceID</code>, and <code>resourceType</code>. The valid operator for all three filters is <code>Equals</code>.</p><br>
11    /// - On success, responds with [`ListOperationEventsOutput`](crate::operation::list_operation_events::ListOperationEventsOutput) with field(s):
12    ///   - [`operation_events(Option<Vec::<OperationEvent>>)`](crate::operation::list_operation_events::ListOperationEventsOutput::operation_events): <p>A returned list of operation events that meet the filter criteria.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_operation_events::ListOperationEventsOutput::next_token): <p>The token to use to retrieve the next page of results. This value is null when there are no more results to return.</p>
14    /// - On failure, responds with [`SdkError<ListOperationEventsError>`](crate::operation::list_operation_events::ListOperationEventsError)
15    pub fn list_operation_events(&self) -> crate::operation::list_operation_events::builders::ListOperationEventsFluentBuilder {
16        crate::operation::list_operation_events::builders::ListOperationEventsFluentBuilder::new(self.handle.clone())
17    }
18}