StopBotRecommendation
Stop an already running Bot Recommendation request.
Request Syntax
PUT /bots/botId/botversions/botVersion/botlocales/localeId/botrecommendations/botRecommendationId/stopbotrecommendation HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- botId
-
The unique identifier of the bot containing the bot recommendation to be stopped.
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: Yes
- botRecommendationId
-
The unique identifier of the bot recommendation to be stopped.
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: Yes
- botVersion
-
The version of the bot containing the bot recommendation.
Length Constraints: Fixed length of 5.
Pattern:
^DRAFT$Required: Yes
- localeId
-
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
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botRecommendationId": "string",
"botRecommendationStatus": "string",
"botVersion": "string",
"localeId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
- botId
-
The unique identifier of the bot containing the bot recommendation that is being stopped.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - botRecommendationId
-
The unique identifier of the bot recommendation that is being stopped.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - botRecommendationStatus
-
The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
Type: String
Valid Values:
Processing | Deleting | Deleted | Downloading | Updating | Available | Failed | Stopping | Stopped - botVersion
-
The version of the bot containing the recommendation that is being stopped.
Type: String
Length Constraints: Fixed length of 5.
Pattern:
^DRAFT$ - localeId
-
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
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
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.
HTTP Status Code: 409
- ConflictException
-
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.
HTTP Status Code: 409
- InternalServerException
-
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
- PreconditionFailedException
-
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
- ResourceNotFoundException
-
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
You have reached a quota for your bot.
HTTP Status Code: 402
- ThrottlingException
-
Your request rate is too high. Reduce the frequency of requests.
HTTP Status Code: 429
- ValidationException
-
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
