Skip to content

PutSessionRequest

Source code in docs_src/capo_lex_runtime_v2/types/put_session_request.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class PutSessionRequest(TypedDict, closed=True):
    bot_id: "capo_lex_runtime_v2.types.bot_identifier.BotIdentifier"
    """<p>The identifier of the bot that receives the session data.</p>"""
    bot_alias_id: "capo_lex_runtime_v2.types.bot_alias_identifier.BotAliasIdentifier"
    """<p>The alias identifier of the bot that receives the session data.</p>"""
    locale_id: "capo_lex_runtime_v2.types.locale_id.LocaleId"
    """<p>The locale where the session is in use.</p>"""
    session_id: "capo_lex_runtime_v2.types.session_id.SessionId"
    """<p>The identifier of the session that receives the session data.</p>"""
    messages: NotRequired["capo_lex_runtime_v2.types.messages.Messages"]
    """<p>A list of messages to send to the user. Messages are sent in the order that they are defined in the list.</p>"""
    session_state: "capo_lex_runtime_v2.types.session_state.SessionState"
    """<p>Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.</p>"""
    request_attributes: NotRequired["capo_lex_runtime_v2.types.string_map.StringMap"]
    """<p>Request-specific information passed between Amazon Lex V2 and the client application.</p> <p>The namespace <code>x-amz-lex:</code> is reserved for special attributes. Don't create any request attributes with the prefix <code>x-amz-lex:</code>.</p>"""
    response_content_type: NotRequired[
        "capo_lex_runtime_v2.types.non_empty_string.NonEmptyString"
    ]
    """<p>The message that Amazon Lex V2 returns in the response can be either text or speech depending on the value of this parameter. </p> <ul> <li> <p>If the value is <code>text/plain; charset=utf-8</code>, Amazon Lex V2 returns text in the response.</p> </li> </ul>"""

bot_alias_id instance-attribute 

bot_alias_id: BotAliasIdentifier

The alias identifier of the bot that receives the session data.

bot_id instance-attribute 

bot_id: BotIdentifier

The identifier of the bot that receives the session data.

locale_id instance-attribute 

locale_id: LocaleId

The locale where the session is in use.

messages instance-attribute 

messages: NotRequired[Messages]

A list of messages to send to the user. Messages are sent in the order that they are defined in the list.

request_attributes instance-attribute 

request_attributes: NotRequired[StringMap]

Request-specific information passed between Amazon Lex V2 and the client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

response_content_type instance-attribute 

response_content_type: NotRequired[NonEmptyString]

The message that Amazon Lex V2 returns in the response can be either text or speech depending on the value of this parameter.

  • If the value is text/plain; charset=utf-8, Amazon Lex V2 returns text in the response.

session_id instance-attribute 

session_id: SessionId

The identifier of the session that receives the session data.

session_state instance-attribute 

session_state: SessionState

Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.