Skip to content

GetSessionRequest

Source code in docs_src/capo_lex_runtime_service/types/get_session_request.py
class GetSessionRequest(TypedDict, closed=True):
    bot_name: "capo_lex_runtime_service.types.bot_name.BotName"
    """<p>The name of the bot that contains the session data.</p>"""
    bot_alias: "capo_lex_runtime_service.types.bot_alias.BotAlias"
    """<p>The alias in use for the bot that contains the session data.</p>"""
    user_id: "capo_lex_runtime_service.types.user_id.UserId"
    """<p>The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. </p>"""
    checkpoint_label_filter: NotRequired[
        "capo_lex_runtime_service.types.intent_summary_checkpoint_label.IntentSummaryCheckpointLabel"
    ]
    """<p>A string used to filter the intents returned in the <code>recentIntentSummaryView</code> structure. </p> <p>When you specify a filter, only intents with their <code>checkpointLabel</code> field set to that string are returned.</p>"""

bot_alias instance-attribute

bot_alias: BotAlias

The alias in use for the bot that contains the session data.

bot_name instance-attribute

bot_name: BotName

The name of the bot that contains the session data.

checkpoint_label_filter instance-attribute

checkpoint_label_filter: NotRequired[IntentSummaryCheckpointLabel]

A string used to filter the intents returned in the recentIntentSummaryView structure.

When you specify a filter, only intents with their checkpointLabel field set to that string are returned.

user_id instance-attribute

user_id: UserId

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.