Struct aws_sdk_connect::operation::start_chat_contact::builders::StartChatContactFluentBuilder
source · pub struct StartChatContactFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartChatContact
.
Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
-
API rate limit is exceeded. API TPS throttling returns a
TooManyRequests
exception. -
The quota for concurrent active chats is exceeded. Active chat throttling returns a
LimitExceededException
.
If you use the ChatDurationInMinutes
parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
For more information about chat, see Chat in the Amazon Connect Administrator Guide.
Implementations§
source§impl StartChatContactFluentBuilder
impl StartChatContactFluentBuilder
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<StartChatContact, AwsResponseRetryClassifier>, SdkError<StartChatContactError>>
pub async fn customize( self ) -> Result<CustomizableOperation<StartChatContact, AwsResponseRetryClassifier>, SdkError<StartChatContactError>>
Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.
sourcepub async fn send(
self
) -> Result<StartChatContactOutput, SdkError<StartChatContactError>>
pub async fn send( self ) -> Result<StartChatContactOutput, SdkError<StartChatContactError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn instance_id(self, input: impl Into<String>) -> Self
pub fn instance_id(self, input: impl Into<String>) -> Self
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
sourcepub fn set_instance_id(self, input: Option<String>) -> Self
pub fn set_instance_id(self, input: Option<String>) -> Self
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
sourcepub fn contact_flow_id(self, input: impl Into<String>) -> Self
pub fn contact_flow_id(self, input: impl Into<String>) -> Self
The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
sourcepub fn set_contact_flow_id(self, input: Option<String>) -> Self
pub fn set_contact_flow_id(self, input: Option<String>) -> Self
The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
sourcepub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to Attributes
.
To override the contents of this collection use set_attributes
.
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
sourcepub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_attributes(self, input: Option<HashMap<String, String>>) -> Self
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
sourcepub fn participant_details(self, input: ParticipantDetails) -> Self
pub fn participant_details(self, input: ParticipantDetails) -> Self
Information identifying the participant.
sourcepub fn set_participant_details(self, input: Option<ParticipantDetails>) -> Self
pub fn set_participant_details(self, input: Option<ParticipantDetails>) -> Self
Information identifying the participant.
sourcepub fn initial_message(self, input: ChatMessage) -> Self
pub fn initial_message(self, input: ChatMessage) -> Self
The initial message to be sent to the newly created chat.
sourcepub fn set_initial_message(self, input: Option<ChatMessage>) -> Self
pub fn set_initial_message(self, input: Option<ChatMessage>) -> Self
The initial message to be sent to the newly created chat.
sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
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 Making retries safe with idempotent APIs.
sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
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 Making retries safe with idempotent APIs.
sourcepub fn chat_duration_in_minutes(self, input: i32) -> Self
pub fn chat_duration_in_minutes(self, input: i32) -> Self
The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
sourcepub fn set_chat_duration_in_minutes(self, input: Option<i32>) -> Self
pub fn set_chat_duration_in_minutes(self, input: Option<i32>) -> Self
The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
sourcepub fn supported_messaging_content_types(self, input: impl Into<String>) -> Self
pub fn supported_messaging_content_types(self, input: impl Into<String>) -> Self
Appends an item to SupportedMessagingContentTypes
.
To override the contents of this collection use set_supported_messaging_content_types
.
The supported chat message content types. Content types must always contain text/plain
. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain
: [text/plain, text/markdown, application/json]
, [text/markdown, text/plain]
, [text/plain, application/json]
.
sourcepub fn set_supported_messaging_content_types(
self,
input: Option<Vec<String>>
) -> Self
pub fn set_supported_messaging_content_types( self, input: Option<Vec<String>> ) -> Self
The supported chat message content types. Content types must always contain text/plain
. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain
: [text/plain, text/markdown, application/json]
, [text/markdown, text/plain]
, [text/plain, application/json]
.
sourcepub fn persistent_chat(self, input: PersistentChat) -> Self
pub fn persistent_chat(self, input: PersistentChat) -> Self
Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.
sourcepub fn set_persistent_chat(self, input: Option<PersistentChat>) -> Self
pub fn set_persistent_chat(self, input: Option<PersistentChat>) -> Self
Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.
Trait Implementations§
source§impl Clone for StartChatContactFluentBuilder
impl Clone for StartChatContactFluentBuilder
source§fn clone(&self) -> StartChatContactFluentBuilder
fn clone(&self) -> StartChatContactFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more