Skip to content

CreateParticipantConnectionRequest

Source code in docs_src/capo_connectparticipant/types/create_participant_connection_request.py 
13
14
15
16
17
18
19
20
21
22
23
class CreateParticipantConnectionRequest(TypedDict, closed=True):
    type: NotRequired[
        "capo_connectparticipant.types.connection_type_list.ConnectionTypeList"
    ]
    """<p>Type of connection information required. If you need <code>CONNECTION_CREDENTIALS</code> along with marking participant as connected, pass <code>CONNECTION_CREDENTIALS</code> in <code>Type</code>.</p>"""
    participant_token: (
        "capo_connectparticipant.types.participant_token.ParticipantToken"
    )
    """<p>This is a header parameter.</p> <p>The ParticipantToken as obtained from <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html">StartChatContact</a> API response.</p>"""
    connect_participant: NotRequired["capo_connectparticipant.types.bool.Bool"]
    """<p>Amazon Connect Participant is used to mark the participant as connected for customer participant in message streaming, as well as for agent or manager participant in non-streaming chats.</p>"""

connect_participant instance-attribute 

connect_participant: NotRequired[Bool]

Amazon Connect Participant is used to mark the participant as connected for customer participant in message streaming, as well as for agent or manager participant in non-streaming chats.

participant_token instance-attribute 

participant_token: ParticipantToken

This is a header parameter.

The ParticipantToken as obtained from StartChatContact API response.

type instance-attribute 

type: NotRequired[ConnectionTypeList]

Type of connection information required. If you need CONNECTION_CREDENTIALS along with marking participant as connected, pass CONNECTION_CREDENTIALS in Type.