aws_sdk_connectparticipant/client/
get_transcript.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 [`GetTranscript`](crate::operation::get_transcript::builders::GetTranscriptFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_transcript::builders::GetTranscriptFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`contact_id(impl Into<String>)`](crate::operation::get_transcript::builders::GetTranscriptFluentBuilder::contact_id) / [`set_contact_id(Option<String>)`](crate::operation::get_transcript::builders::GetTranscriptFluentBuilder::set_contact_id):<br>required: **false**<br><p>The contactId from the current contact chain for which transcript is needed.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::get_transcript::builders::GetTranscriptFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_transcript::builders::GetTranscriptFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in the page. Default: 10.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::get_transcript::builders::GetTranscriptFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_transcript::builders::GetTranscriptFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.</p><br>
10    ///   - [`scan_direction(ScanDirection)`](crate::operation::get_transcript::builders::GetTranscriptFluentBuilder::scan_direction) / [`set_scan_direction(Option<ScanDirection>)`](crate::operation::get_transcript::builders::GetTranscriptFluentBuilder::set_scan_direction):<br>required: **false**<br><p>The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.</p><br>
11    ///   - [`sort_order(SortKey)`](crate::operation::get_transcript::builders::GetTranscriptFluentBuilder::sort_order) / [`set_sort_order(Option<SortKey>)`](crate::operation::get_transcript::builders::GetTranscriptFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order for the records. Default: DESCENDING.</p><br>
12    ///   - [`start_position(StartPosition)`](crate::operation::get_transcript::builders::GetTranscriptFluentBuilder::start_position) / [`set_start_position(Option<StartPosition>)`](crate::operation::get_transcript::builders::GetTranscriptFluentBuilder::set_start_position):<br>required: **false**<br><p>A filtering option for where to start.</p><br>
13    ///   - [`connection_token(impl Into<String>)`](crate::operation::get_transcript::builders::GetTranscriptFluentBuilder::connection_token) / [`set_connection_token(Option<String>)`](crate::operation::get_transcript::builders::GetTranscriptFluentBuilder::set_connection_token):<br>required: **true**<br><p>The authentication token associated with the participant's connection.</p><br>
14    /// - On success, responds with [`GetTranscriptOutput`](crate::operation::get_transcript::GetTranscriptOutput) with field(s):
15    ///   - [`initial_contact_id(Option<String>)`](crate::operation::get_transcript::GetTranscriptOutput::initial_contact_id): <p>The initial contact ID for the contact.</p>
16    ///   - [`transcript(Option<Vec::<Item>>)`](crate::operation::get_transcript::GetTranscriptOutput::transcript): <p>The list of messages in the session.</p>
17    ///   - [`next_token(Option<String>)`](crate::operation::get_transcript::GetTranscriptOutput::next_token): <p>The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.</p>
18    /// - On failure, responds with [`SdkError<GetTranscriptError>`](crate::operation::get_transcript::GetTranscriptError)
19    pub fn get_transcript(&self) -> crate::operation::get_transcript::builders::GetTranscriptFluentBuilder {
20        crate::operation::get_transcript::builders::GetTranscriptFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_connectparticipant/client/get_transcript.rs

aws_sdk_connectparticipant/client/
get_transcript.rs
