aws_sdk_connect/client/
start_contact_streaming.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartContactStreaming`](crate::operation::start_contact_streaming::builders::StartContactStreamingFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_id(impl Into<String>)`](crate::operation::start_contact_streaming::builders::StartContactStreamingFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::start_contact_streaming::builders::StartContactStreamingFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p><br>
    ///   - [`contact_id(impl Into<String>)`](crate::operation::start_contact_streaming::builders::StartContactStreamingFluentBuilder::contact_id) / [`set_contact_id(Option<String>)`](crate::operation::start_contact_streaming::builders::StartContactStreamingFluentBuilder::set_contact_id):<br>required: **true**<br><p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</p><br>
    ///   - [`chat_streaming_configuration(ChatStreamingConfiguration)`](crate::operation::start_contact_streaming::builders::StartContactStreamingFluentBuilder::chat_streaming_configuration) / [`set_chat_streaming_configuration(Option<ChatStreamingConfiguration>)`](crate::operation::start_contact_streaming::builders::StartContactStreamingFluentBuilder::set_chat_streaming_configuration):<br>required: **true**<br><p>The streaming configuration, such as the Amazon SNS streaming endpoint.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::start_contact_streaming::builders::StartContactStreamingFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_contact_streaming::builders::StartContactStreamingFluentBuilder::set_client_token):<br>required: **true**<br><p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p><br>
    /// - On success, responds with [`StartContactStreamingOutput`](crate::operation::start_contact_streaming::StartContactStreamingOutput) with field(s):
    ///   - [`streaming_id(String)`](crate::operation::start_contact_streaming::StartContactStreamingOutput::streaming_id): <p>The identifier of the streaming configuration enabled.</p>
    /// - On failure, responds with [`SdkError<StartContactStreamingError>`](crate::operation::start_contact_streaming::StartContactStreamingError)
    pub fn start_contact_streaming(&self) -> crate::operation::start_contact_streaming::builders::StartContactStreamingFluentBuilder {
        crate::operation::start_contact_streaming::builders::StartContactStreamingFluentBuilder::new(self.handle.clone())
    }
}