Skip to content

StartAssistantContactRequest

Source code in docs_src/capo_connect/types/start_assistant_contact_request.py
class StartAssistantContactRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Connect Customer 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>"""
    ai_agent: "capo_connect.types.ai_agent_input.AiAgentInput"
    """<p>The AI agent configuration for this contact.</p>"""
    participant_details: "capo_connect.types.participant_details.ParticipantDetails"
    """<p>The display name and other details that identify the chat participant.</p>"""
    initial_message: NotRequired["capo_connect.types.chat_message.ChatMessage"]
    """<p>The initial message to send to the newly created chat.</p>"""
    attributes: NotRequired["capo_connect.types.attributes.Attributes"]
    """<p>A map of key-value pairs to associate with the contact. We make these attributes available to flows as standard contact attributes.</p> <p>You can provide up to 32,768 UTF-8 bytes across all key-value pairs for each contact.</p>"""
    client_token: NotRequired["capo_connect.types.client_token.ClientToken"]
    """<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>"""
    persistent_chat: NotRequired["capo_connect.types.persistent_chat.PersistentChat"]
    """<p>The configuration that enables persistent chat. For more information about persistent chat and its use cases, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>.</p>"""
    related_contact_id: NotRequired["capo_connect.types.contact_id.ContactId"]
    """<p>The identifier of an Connect Customer contact related to the new assistant contact.</p> <note> <p>You cannot provide both <code>RelatedContactId</code> and <code>PersistentChat</code>.</p> </note>"""

ai_agent instance-attribute

ai_agent: AiAgentInput

The AI agent configuration for this contact.

attributes instance-attribute

attributes: NotRequired[Attributes]

A map of key-value pairs to associate with the contact. We make these attributes available to flows as standard contact attributes.

You can provide up to 32,768 UTF-8 bytes across all key-value pairs for each contact.

client_token instance-attribute

client_token: NotRequired[ClientToken]

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.

initial_message instance-attribute

initial_message: NotRequired[ChatMessage]

The initial message to send to the newly created chat.

instance_id instance-attribute

instance_id: InstanceId

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

participant_details instance-attribute

participant_details: ParticipantDetails

The display name and other details that identify the chat participant.

persistent_chat instance-attribute

persistent_chat: NotRequired[PersistentChat]

The configuration that enables persistent chat. For more information about persistent chat and its use cases, see Enable persistent chat.

related_contact_id instance-attribute

related_contact_id: NotRequired[ContactId]

The identifier of an Connect Customer contact related to the new assistant contact.

You cannot provide both RelatedContactId and PersistentChat.