aws_sdk_connect/client/
start_outbound_chat_contact.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartOutboundChatContact`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`source_endpoint(Endpoint)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::source_endpoint) / [`set_source_endpoint(Option<Endpoint>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::set_source_endpoint):<br>required: **true**<br><p>Information about the endpoint.</p><br>
    ///   - [`destination_endpoint(Endpoint)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::destination_endpoint) / [`set_destination_endpoint(Option<Endpoint>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::set_destination_endpoint):<br>required: **true**<br><p>Information about the endpoint.</p><br>
    ///   - [`instance_id(impl Into<String>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p><br>
    ///   - [`segment_attributes(impl Into<String>, SegmentAttributeValue)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::segment_attributes) / [`set_segment_attributes(Option<HashMap::<String, SegmentAttributeValue>>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::set_segment_attributes):<br>required: **true**<br><p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</p> <ul>  <li>   <p>Attribute keys can include only alphanumeric, <code>-</code>, and <code>_</code>.</p></li>  <li>   <p>This field can be used to show channel subtype, such as <code>connect:Guide</code> and <code>connect:SMS</code>.</p></li> </ul><br>
    ///   - [`attributes(impl Into<String>, impl Into<String>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::attributes) / [`set_attributes(Option<HashMap::<String, String>>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::set_attributes):<br>required: **false**<br><p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p><br>
    ///   - [`contact_flow_id(impl Into<String>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::contact_flow_id) / [`set_contact_flow_id(Option<String>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::set_contact_flow_id):<br>required: **true**<br><p>The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to <b>Routing, Contact Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold:</p> <ul>  <li>   <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>123ec456-a007-89c0-1234-xxxxxxxxxxxx</b></p></li> </ul><br>
    ///   - [`chat_duration_in_minutes(i32)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::chat_duration_in_minutes) / [`set_chat_duration_in_minutes(Option<i32>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::set_chat_duration_in_minutes):<br>required: **false**<br><p>The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).</p><br>
    ///   - [`participant_details(ParticipantDetails)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::participant_details) / [`set_participant_details(Option<ParticipantDetails>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::set_participant_details):<br>required: **false**<br><p>The customer's details.</p><br>
    ///   - [`initial_system_message(ChatMessage)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::initial_system_message) / [`set_initial_system_message(Option<ChatMessage>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::set_initial_system_message):<br>required: **false**<br><p>A chat message.</p><br>
    ///   - [`related_contact_id(impl Into<String>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::related_contact_id) / [`set_related_contact_id(Option<String>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::set_related_contact_id):<br>required: **false**<br><p>The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.</p><br>
    ///   - [`supported_messaging_content_types(impl Into<String>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::supported_messaging_content_types) / [`set_supported_messaging_content_types(Option<Vec::<String>>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::set_supported_messaging_content_types):<br>required: **false**<br><p>The supported chat message content types. Supported types are:</p> <ul>  <li>   <p><code>text/plain</code></p></li>  <li>   <p><code>text/markdown</code></p></li>  <li>   <p><code>application/json, application/vnd.amazonaws.connect.message.interactive</code></p></li>  <li>   <p><code>application/vnd.amazonaws.connect.message.interactive.response</code></p></li> </ul> <p>Content types must always contain <code>text/plain</code>. You can then put any other supported type in the list. For example, all the following lists are valid because they contain <code>text/plain</code>:</p> <ul>  <li>   <p><code>\[text/plain, text/markdown, application/json\]</code></p></li>  <li>   <p><code>\[text/markdown, text/plain\]</code></p></li>  <li>   <p><code>\[text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response\]</code></p></li> </ul><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS 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>. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.</p><br>
    /// - On success, responds with [`StartOutboundChatContactOutput`](crate::operation::start_outbound_chat_contact::StartOutboundChatContactOutput) with field(s):
    ///   - [`contact_id(Option<String>)`](crate::operation::start_outbound_chat_contact::StartOutboundChatContactOutput::contact_id): <p>The identifier of this contact within the Amazon Connect instance.</p>
    /// - On failure, responds with [`SdkError<StartOutboundChatContactError>`](crate::operation::start_outbound_chat_contact::StartOutboundChatContactError)
    pub fn start_outbound_chat_contact(&self) -> crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder {
        crate::operation::start_outbound_chat_contact::builders::StartOutboundChatContactFluentBuilder::new(self.handle.clone())
    }
}