Struct StartOutboundChatContactInput

#[non_exhaustive]
pub struct StartOutboundChatContactInput {
    pub source_endpoint: Option<Endpoint>,
    pub destination_endpoint: Option<Endpoint>,
    pub instance_id: Option<String>,
    pub segment_attributes: Option<HashMap<String, SegmentAttributeValue>>,
    pub attributes: Option<HashMap<String, String>>,
    pub contact_flow_id: Option<String>,
    pub chat_duration_in_minutes: Option<i32>,
    pub participant_details: Option<ParticipantDetails>,
    pub initial_system_message: Option<ChatMessage>,
    pub related_contact_id: Option<String>,
    pub supported_messaging_content_types: Option<Vec<String>>,
    pub client_token: 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.

source_endpoint: Option<Endpoint>

Information about the endpoint.

destination_endpoint: Option<Endpoint>

Information about the endpoint.

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.

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 and connect:SMS.

attributes: Option<HashMap<String, String>>

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.

contact_flow_id: Option<String>

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 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/123ec456-a007-89c0-1234-xxxxxxxxxxxx

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

participant_details: Option<ParticipantDetails>

The customer's details.

initial_system_message: Option<ChatMessage>

A chat message.

related_contact_id: Option<String>

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

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

• 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\]

client_token: Option<String>

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 Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

Implementations

impl StartOutboundChatContactInput

pub fn source_endpoint(&self) -> Option<&Endpoint>

Information about the endpoint.

pub fn destination_endpoint(&self) -> Option<&Endpoint>

Information about the endpoint.

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 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 and connect:SMS.

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

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.

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

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 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/123ec456-a007-89c0-1234-xxxxxxxxxxxx

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 participant_details(&self) -> Option<&ParticipantDetails>

The customer's details.

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

A chat message.

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

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

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

• 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\]

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 client_token(&self) -> Option<&str>

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 Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

impl StartOutboundChatContactInput

pub fn builder() -> StartOutboundChatContactInputBuilder

Creates a new builder-style object to manufacture StartOutboundChatContactInput.

Trait Implementations

impl Clone for StartOutboundChatContactInput

fn clone(&self) -> StartOutboundChatContactInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartOutboundChatContactInput

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

Formats the value using the given formatter.

impl PartialEq for StartOutboundChatContactInput

fn eq(&self, other: &StartOutboundChatContactInput) -> 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 StartOutboundChatContactInput