LexRuntimeV2 / Client / delete_session

delete_session#

LexRuntimeV2.Client.delete_session(**kwargs)#

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

You can use this operation to restart a conversation with a bot. When you remove a session, the entire history of the session is removed so that you can start again.

You don’t need to delete a session. Sessions have a time limit and will expire. Set the session time limit when you create the bot. The default is 5 minutes, but you can specify anything between 1 minute and 24 hours.

If you specify a bot or alias ID that doesn’t exist, you receive a BadRequestException.

If the locale doesn’t exist in the bot, or if the locale hasn’t been enables for the alias, you receive a BadRequestException .

See also: AWS API Documentation

Request Syntax

response = client.delete_session(
    botId='string',
    botAliasId='string',
    localeId='string',
    sessionId='string'
)
Parameters:

  • botId (string) –

    [REQUIRED]

    The identifier of the bot that contains the session data.

  • botAliasId (string) –

    [REQUIRED]

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

  • localeId (string) –

    [REQUIRED]

    The locale where the session is in use.

  • sessionId (string) –

    [REQUIRED]

    The identifier of the session to delete.

Return type:

dict

Returns:

Response Syntax

{
    'botId': 'string',
    'botAliasId': 'string',
    'localeId': 'string',
    'sessionId': 'string'
}

Response Structure

  • (dict) –

    • botId (string) –

      The identifier of the bot that contained the session data.

    • botAliasId (string) –

      The alias identifier in use for the bot that contained the session data.

    • localeId (string) –

      The locale where the session was used.

    • sessionId (string) –

      The identifier of the deleted session.

Exceptions

  • LexRuntimeV2.Client.exceptions.AccessDeniedException

  • LexRuntimeV2.Client.exceptions.ResourceNotFoundException

  • LexRuntimeV2.Client.exceptions.ValidationException

  • LexRuntimeV2.Client.exceptions.ThrottlingException

  • LexRuntimeV2.Client.exceptions.InternalServerException

  • LexRuntimeV2.Client.exceptions.ConflictException