aws_sdk_qconnect/client/list_spans.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 [`ListSpans`](crate::operation::list_spans::builders::ListSpansFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_spans::builders::ListSpansFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`assistant_id(impl Into<String>)`](crate::operation::list_spans::builders::ListSpansFluentBuilder::assistant_id) / [`set_assistant_id(Option<String>)`](crate::operation::list_spans::builders::ListSpansFluentBuilder::set_assistant_id):<br>required: **true**<br><p>UUID or ARN of the Connect AI Assistant resource</p><br>
8 /// - [`session_id(impl Into<String>)`](crate::operation::list_spans::builders::ListSpansFluentBuilder::session_id) / [`set_session_id(Option<String>)`](crate::operation::list_spans::builders::ListSpansFluentBuilder::set_session_id):<br>required: **true**<br><p>UUID or ARN of the Connect AI Session resource</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::list_spans::builders::ListSpansFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_spans::builders::ListSpansFluentBuilder::set_next_token):<br>required: **false**<br><p>Pagination token for retrieving the next page of results</p><br>
10 /// - [`max_results(i32)`](crate::operation::list_spans::builders::ListSpansFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_spans::builders::ListSpansFluentBuilder::set_max_results):<br>required: **false**<br><p>Maximum number of spans to return per page</p><br>
11 /// - On success, responds with [`ListSpansOutput`](crate::operation::list_spans::ListSpansOutput) with field(s):
12 /// - [`spans(Vec::<Span>)`](crate::operation::list_spans::ListSpansOutput::spans): <p>Array of span objects for the session</p>
13 /// - [`next_token(Option<String>)`](crate::operation::list_spans::ListSpansOutput::next_token): <p>Pagination token for retrieving additional results</p>
14 /// - On failure, responds with [`SdkError<ListSpansError>`](crate::operation::list_spans::ListSpansError)
15 pub fn list_spans(&self) -> crate::operation::list_spans::builders::ListSpansFluentBuilder {
16 crate::operation::list_spans::builders::ListSpansFluentBuilder::new(self.handle.clone())
17 }
18}