LexModelsV2 / Client / stop_bot_analyzer

stop_bot_analyzer¶

LexModelsV2.Client.stop_bot_analyzer(**kwargs)¶

Cancels an ongoing bot analysis execution. Once stopped, the analysis cannot be resumed and no recommendations will be generated.

Request Syntax

response = client.stop_bot_analyzer(
    botId='string',
    botAnalyzerRequestId='string'
)

Parameters:

botId (string) –
[REQUIRED]

The unique identifier of the bot.
botAnalyzerRequestId (string) –
[REQUIRED]

The unique identifier of the analysis request to stop.

Return type:

dict

Returns:

Response Syntax

{
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'botAnalyzerStatus': 'Processing'|'Available'|'Failed'|'Stopping'|'Stopped',
    'botAnalyzerRequestId': 'string'
}

Response Structure

(dict) –
- botId (string) –
  
  The unique identifier of the bot.
- botVersion (string) –
  
  The version of the bot.
- localeId (string) –
  
  The locale identifier of the bot locale.
- botAnalyzerStatus (string) –
  
  The updated status of the analysis. The status will be Stopping and will eventually transition to Stopped.
  
  Valid Values: Processing | Available | Failed | Stopping | Stopped
- botAnalyzerRequestId (string) –
  
  The unique identifier of the analysis request.

Exceptions

LexModelsV2.Client.exceptions.ThrottlingException
LexModelsV2.Client.exceptions.ValidationException
LexModelsV2.Client.exceptions.ResourceNotFoundException
LexModelsV2.Client.exceptions.InternalServerException