v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1757167.0 KB

Returns session information for a specified bot, alias, and user ID.

get/bot/{botName}/alias/{botAlias}/user/{userId}/session/

Path parameters

botNamestring required

The name of the bot that contains the session data.

botAliasstring required

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

userIdstring required

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

Query parameters

checkpointLabelFilterstring
<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>

Response

Success

sessionAttributesobject

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

sessionIdstring

A unique identifier for the session.