aws_sdk_ssmcontacts/client/
list_engagements.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 [`ListEngagements`](crate::operation::list_engagements::builders::ListEngagementsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_engagements::builders::ListEngagementsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_engagements::builders::ListEngagementsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_engagements::builders::ListEngagementsFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token to continue to the next page of results.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_engagements::builders::ListEngagementsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_engagements::builders::ListEngagementsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of engagements per page of results.</p><br>
9    ///   - [`incident_id(impl Into<String>)`](crate::operation::list_engagements::builders::ListEngagementsFluentBuilder::incident_id) / [`set_incident_id(Option<String>)`](crate::operation::list_engagements::builders::ListEngagementsFluentBuilder::set_incident_id):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the incident you're listing engagements for.</p><br>
10    ///   - [`time_range_value(TimeRange)`](crate::operation::list_engagements::builders::ListEngagementsFluentBuilder::time_range_value) / [`set_time_range_value(Option<TimeRange>)`](crate::operation::list_engagements::builders::ListEngagementsFluentBuilder::set_time_range_value):<br>required: **false**<br><p>The time range to lists engagements for an incident.</p><br>
11    /// - On success, responds with [`ListEngagementsOutput`](crate::operation::list_engagements::ListEngagementsOutput) with field(s):
12    ///   - [`next_token(Option<String>)`](crate::operation::list_engagements::ListEngagementsOutput::next_token): <p>The pagination token to continue to the next page of results.</p>
13    ///   - [`engagements(Vec::<Engagement>)`](crate::operation::list_engagements::ListEngagementsOutput::engagements): <p>A list of each engagement that occurred during the specified time range of an incident.</p>
14    /// - On failure, responds with [`SdkError<ListEngagementsError>`](crate::operation::list_engagements::ListEngagementsError)
15    pub fn list_engagements(&self) -> crate::operation::list_engagements::builders::ListEngagementsFluentBuilder {
16        crate::operation::list_engagements::builders::ListEngagementsFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_ssmcontacts/client/list_engagements.rs

aws_sdk_ssmcontacts/client/
list_engagements.rs
