StopBotRecommendationCommand

Suggest an Edit

Stop an already running Bot Recommendation request.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { LexModelsV2Client, StopBotRecommendationCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import
// const { LexModelsV2Client, StopBotRecommendationCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import
const client = new LexModelsV2Client(config);
const input = { // StopBotRecommendationRequest
  botId: "STRING_VALUE", // required
  botVersion: "STRING_VALUE", // required
  localeId: "STRING_VALUE", // required
  botRecommendationId: "STRING_VALUE", // required
};
const command = new StopBotRecommendationCommand(input);
const response = await client.send(command);
// { // StopBotRecommendationResponse
//   botId: "STRING_VALUE",
//   botVersion: "STRING_VALUE",
//   localeId: "STRING_VALUE",
//   botRecommendationStatus: "Processing" || "Deleting" || "Deleted" || "Downloading" || "Updating" || "Available" || "Failed" || "Stopping" || "Stopped",
//   botRecommendationId: "STRING_VALUE",
// };

StopBotRecommendationCommand Input

See StopBotRecommendationCommandInput for more details

Parameter
Type
Description
botId
Required
string | undefined

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

botRecommendationId
Required
string | undefined

The unique identifier of the bot recommendation to be stopped.

botVersion
Required
string | undefined

The version of the bot containing the bot recommendation.

localeId
Required
string | undefined

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 

StopBotRecommendationCommand Output

See StopBotRecommendationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
botId
string | undefined

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

botRecommendationId
string | undefined

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

botRecommendationStatus
BotRecommendationStatus | undefined

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

botVersion
string | undefined

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

localeId
string | undefined

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 

Throws

Name
Fault
Details
ConflictException
client

The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

InternalServerException
server

The service encountered an unexpected condition. Try your request again.

PreconditionFailedException
client

Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

ResourceNotFoundException
client

You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

ServiceQuotaExceededException
client

You have reached a quota for your bot.

ThrottlingException
client

Your request rate is too high. Reduce the frequency of requests.

ValidationException
client

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

LexModelsV2ServiceException
Base exception class for all service exceptions from LexModelsV2 service.