aws_sdk_connectcontactlens/client/
list_realtime_contact_analysis_segments.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListRealtimeContactAnalysisSegments`](crate::operation::list_realtime_contact_analysis_segments::builders::ListRealtimeContactAnalysisSegmentsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_realtime_contact_analysis_segments::builders::ListRealtimeContactAnalysisSegmentsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_id(impl Into<String>)`](crate::operation::list_realtime_contact_analysis_segments::builders::ListRealtimeContactAnalysisSegmentsFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::list_realtime_contact_analysis_segments::builders::ListRealtimeContactAnalysisSegmentsFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Amazon Connect instance.</p><br>
    ///   - [`contact_id(impl Into<String>)`](crate::operation::list_realtime_contact_analysis_segments::builders::ListRealtimeContactAnalysisSegmentsFluentBuilder::contact_id) / [`set_contact_id(Option<String>)`](crate::operation::list_realtime_contact_analysis_segments::builders::ListRealtimeContactAnalysisSegmentsFluentBuilder::set_contact_id):<br>required: **true**<br><p>The identifier of the contact.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_realtime_contact_analysis_segments::builders::ListRealtimeContactAnalysisSegmentsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_realtime_contact_analysis_segments::builders::ListRealtimeContactAnalysisSegmentsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_realtime_contact_analysis_segments::builders::ListRealtimeContactAnalysisSegmentsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_realtime_contact_analysis_segments::builders::ListRealtimeContactAnalysisSegmentsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p><br>
    /// - On success, responds with [`ListRealtimeContactAnalysisSegmentsOutput`](crate::operation::list_realtime_contact_analysis_segments::ListRealtimeContactAnalysisSegmentsOutput) with field(s):
    ///   - [`segments(Option<Vec::<RealtimeContactAnalysisSegment>>)`](crate::operation::list_realtime_contact_analysis_segments::ListRealtimeContactAnalysisSegmentsOutput::segments): <p>An analyzed transcript or category.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_realtime_contact_analysis_segments::ListRealtimeContactAnalysisSegmentsOutput::next_token): <p>If there are additional results, this is the token for the next set of results. If response includes <code>nextToken</code> there are two possible scenarios:</p> <ul>  <li>   <p>There are more segments so another call is required to get them.</p></li>  <li>   <p>There are no more segments at this time, but more may be available later (real-time analysis is in progress) so the client should call the operation again to get new segments.</p></li> </ul> <p>If response does not include <code>nextToken</code>, the analysis is completed (successfully or failed) and there are no more segments to retrieve.</p>
    /// - On failure, responds with [`SdkError<ListRealtimeContactAnalysisSegmentsError>`](crate::operation::list_realtime_contact_analysis_segments::ListRealtimeContactAnalysisSegmentsError)
    pub fn list_realtime_contact_analysis_segments(
        &self,
    ) -> crate::operation::list_realtime_contact_analysis_segments::builders::ListRealtimeContactAnalysisSegmentsFluentBuilder {
        crate::operation::list_realtime_contact_analysis_segments::builders::ListRealtimeContactAnalysisSegmentsFluentBuilder::new(
            self.handle.clone(),
        )
    }
}