Struct StartChatContactInput

#[non_exhaustive]
pub struct StartChatContactInput {
    pub instance_id: Option<String>,
    pub contact_flow_id: Option<String>,
    pub attributes: Option<HashMap<String, String>>,
    pub participant_details: Option<ParticipantDetails>,
    pub initial_message: Option<ChatMessage>,
    pub client_token: Option<String>,
    pub chat_duration_in_minutes: Option<i32>,
    pub supported_messaging_content_types: Option<Vec<String>>,
    pub persistent_chat: Option<PersistentChat>,
    pub related_contact_id: Option<String>,
    pub segment_attributes: Option<HashMap<String, SegmentAttributeValue>>,
    pub customer_id: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

instance_id: Option<String>

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

contact_flow_id: Option<String>

The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, 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

attributes: Option<HashMap<String, String>>

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.

participant_details: Option<ParticipantDetails>

Information identifying the participant.

initial_message: Option<ChatMessage>

The initial message to be sent to the newly created chat. If you have a Lex bot in your flow, the initial message is not delivered to the Lex bot.

client_token: Option<String>

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.

chat_duration_in_minutes: Option<i32>

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).

supported_messaging_content_types: Option<Vec<String>>

The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and application/vnd.amazonaws.connect.message.interactive.response.

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, application/vnd.amazonaws.connect.message.interactive.response\].

The type application/vnd.amazonaws.connect.message.interactive is required to use the Show view flow block.

persistent_chat: Option<PersistentChat>

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.

related_contact_id: Option<String>

The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.

You cannot provide data for both RelatedContactId and PersistentChat.

segment_attributes: Option<HashMap<String, SegmentAttributeValue>>

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.

Attribute keys can include only alphanumeric, -, and _.

This field can be used to show channel subtype, such as connect:Guide.

The types application/vnd.amazonaws.connect.message.interactive and application/vnd.amazonaws.connect.message.interactive.response must be present in the SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as { "connect:Subtype": {"valueString" : "connect:Guide" }}.

customer_id: Option<String>

The customer's identification number. For example, the CustomerId may be a customer number from your CRM.

Implementations

impl StartChatContactInput

pub fn instance_id(&self) -> Option<&str>

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

pub fn contact_flow_id(&self) -> Option<&str>

The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, 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

pub fn attributes(&self) -> Option<&HashMap<String, String>>

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.

pub fn participant_details(&self) -> Option<&ParticipantDetails>

Information identifying the participant.

pub fn initial_message(&self) -> Option<&ChatMessage>

The initial message to be sent to the newly created chat. If you have a Lex bot in your flow, the initial message is not delivered to the Lex bot.

pub fn client_token(&self) -> Option<&str>

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.

pub fn chat_duration_in_minutes(&self) -> Option<i32>

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).

pub fn supported_messaging_content_types(&self) -> &[String]

The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and application/vnd.amazonaws.connect.message.interactive.response.

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, application/vnd.amazonaws.connect.message.interactive.response\].

The type application/vnd.amazonaws.connect.message.interactive is required to use the Show view flow block.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .supported_messaging_content_types.is_none().

pub fn persistent_chat(&self) -> Option<&PersistentChat>

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.

pub fn related_contact_id(&self) -> Option<&str>

The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.

You cannot provide data for both RelatedContactId and PersistentChat.

pub fn segment_attributes( &self, ) -> Option<&HashMap<String, SegmentAttributeValue>>

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.

Attribute keys can include only alphanumeric, -, and _.

This field can be used to show channel subtype, such as connect:Guide.

The types application/vnd.amazonaws.connect.message.interactive and application/vnd.amazonaws.connect.message.interactive.response must be present in the SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as { "connect:Subtype": {"valueString" : "connect:Guide" }}.

pub fn customer_id(&self) -> Option<&str>

The customer's identification number. For example, the CustomerId may be a customer number from your CRM.

impl StartChatContactInput

pub fn builder() -> StartChatContactInputBuilder

Creates a new builder-style object to manufacture StartChatContactInput.

Trait Implementations

impl Clone for StartChatContactInput

fn clone(&self) -> StartChatContactInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartChatContactInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StartChatContactInput

fn eq(&self, other: &StartChatContactInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartChatContactInput