LexRuntimeService / Client / delete_session

delete_session

LexRuntimeService.Client.delete_session(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_session(
    botName='string',
    botAlias='string',
    userId='string'
)

Parameters:

• botName (string) –

  [REQUIRED]

  The name of the bot that contains the session data.

• botAlias (string) –

  [REQUIRED]

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

• userId (string) –

  [REQUIRED]

  The identifier of the user associated with the session data.

Return type:

dict

Returns:

Response Syntax

{
    'botName': 'string',
    'botAlias': 'string',
    'userId': 'string',
    'sessionId': 'string'
}

Response Structure

• (dict) –

  • botName (string) –

    The name of the bot associated with the session data.

  • botAlias (string) –

    The alias in use for the bot associated with the session data.

  • userId (string) –

    The ID of the client application user.

  • sessionId (string) –

    The unique identifier for the session.

Exceptions

• LexRuntimeService.Client.exceptions.NotFoundException

• LexRuntimeService.Client.exceptions.BadRequestException

• LexRuntimeService.Client.exceptions.LimitExceededException

• LexRuntimeService.Client.exceptions.InternalFailureException

• LexRuntimeService.Client.exceptions.ConflictException