Skip to content

SendMessageRequest

Source code in docs_src/capo_qconnect/types/send_message_request.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class SendMessageRequest(TypedDict, closed=True):
    assistant_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the Amazon Q in Connect assistant.</p>"""
    session_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the Amazon Q in Connect session.</p>"""
    type: "capo_qconnect.types.message_type.MessageType"
    """<p>The message type.</p>"""
    message: "capo_qconnect.types.message_input.MessageInput"
    """<p>The message data to submit to the Amazon Q in Connect session.</p>"""
    ai_agent_id: NotRequired[
        "capo_qconnect.types.uuid_or_arn_or_either_with_qualifier.UuidOrArnOrEitherWithQualifier"
    ]
    """<p>The identifier of the AI Agent to use for processing the message.</p>"""
    conversation_context: NotRequired[
        "capo_qconnect.types.conversation_context.ConversationContext"
    ]
    """<p>The conversation context before the Amazon Q in Connect session.</p>"""
    configuration: NotRequired[
        "capo_qconnect.types.message_configuration.MessageConfiguration"
    ]
    """<p>The configuration of the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_SendMessage.html">SendMessage</a> request.</p>"""
    client_token: NotRequired["capo_qconnect.types.client_token.ClientToken"]
    """<p>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.</p>"""
    orchestrator_use_case: NotRequired[
        "capo_qconnect.types.non_empty_string.NonEmptyString"
    ]
    """<p>The orchestrator use case for message processing.</p>"""
    metadata: NotRequired["capo_qconnect.types.message_metadata.MessageMetadata"]
    """<p>Additional metadata for the message.</p>"""
    origin_request_id: NotRequired[
        "capo_qconnect.types.non_empty_string.NonEmptyString"
    ]
    """<p>Request identifier from the origin system, used for end-to-end tracing across spans.</p>"""

ai_agent_id instance-attribute 

ai_agent_id: NotRequired[UuidOrArnOrEitherWithQualifier]

The identifier of the AI Agent to use for processing the message.

assistant_id instance-attribute 

assistant_id: UuidOrArn

The identifier of the Amazon Q in Connect assistant.

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 AWS SDK populates this field.For more information about idempotency, see Making retries safe with idempotent APIs.

configuration instance-attribute 

configuration: NotRequired[MessageConfiguration]

The configuration of the SendMessage request.

conversation_context instance-attribute 

conversation_context: NotRequired[ConversationContext]

The conversation context before the Amazon Q in Connect session.

message instance-attribute 

message: MessageInput

The message data to submit to the Amazon Q in Connect session.

metadata instance-attribute 

metadata: NotRequired[MessageMetadata]

Additional metadata for the message.

orchestrator_use_case instance-attribute 

orchestrator_use_case: NotRequired[NonEmptyString]

The orchestrator use case for message processing.

origin_request_id instance-attribute 

origin_request_id: NotRequired[NonEmptyString]

Request identifier from the origin system, used for end-to-end tracing across spans.

session_id instance-attribute 

session_id: UuidOrArn

The identifier of the Amazon Q in Connect session.

type instance-attribute 

type: MessageType

The message type.