stop_bot_recommendation

LexModelsV2.Client.stop_bot_recommendation(**kwargs)

Stop an already running Bot Recommendation request.

See also: AWS API Documentation

Request Syntax

response = client.stop_bot_recommendation(
    botId='string',
    botVersion='string',
    localeId='string',
    botRecommendationId='string'
)

Parameters

• botId (string) --

  [REQUIRED]

  The unique identifier of the bot containing the bot recommendation to be stopped.

• botVersion (string) --

  [REQUIRED]

  The version of the bot containing the bot recommendation.

• localeId (string) --

  [REQUIRED]

  The identifier of the language and locale of the bot recommendation to stop. The string must match one of the supported locales. For more information, see Supported languages

• botRecommendationId (string) --

  [REQUIRED]

  The unique identifier of the bot recommendation to be stopped.

Return type

dict

Returns

Response Syntax

{
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'botRecommendationStatus': 'Processing'|'Deleting'|'Deleted'|'Downloading'|'Updating'|'Available'|'Failed'|'Stopping'|'Stopped',
    'botRecommendationId': 'string'
}

Response Structure

• (dict) --

  • botId (string) --

    The unique identifier of the bot containing the bot recommendation that is being stopped.

  • botVersion (string) --

    The version of the bot containing the recommendation that is being stopped.

  • localeId (string) --

    The identifier of the language and locale of the bot response to stop. The string must match one of the supported locales. For more information, see Supported languages

  • botRecommendationStatus (string) --

    The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

  • botRecommendationId (string) --

    The unique identifier of the bot recommendation that is being stopped.

Exceptions

• LexModelsV2.Client.exceptions.ThrottlingException
• LexModelsV2.Client.exceptions.ServiceQuotaExceededException
• LexModelsV2.Client.exceptions.ValidationException
• LexModelsV2.Client.exceptions.ResourceNotFoundException
• LexModelsV2.Client.exceptions.ConflictException
• LexModelsV2.Client.exceptions.PreconditionFailedException
• LexModelsV2.Client.exceptions.ConflictException
• LexModelsV2.Client.exceptions.InternalServerException