Creates an immutable version of the bot. When you create the first version of a bot, Amazon Lex sets the version number to 1. Subsequent bot versions increase in an increment of 1. The version number will always represent the total number of versions created of the bot, not the current number of versions. If a bot version is deleted, that bot version number will not be reused.
Request Syntax
PUT /bots/botId/botversions/ HTTP/1.1
Content-type: application/json
{
"botVersionLocaleSpecification": {
"string" : {
"sourceBotVersion": "string"
}
},
"description": "string"
}URI Request Parameters
The request uses the following URI parameters.
- botId
-
The identifier of the bot to create the version for.
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: Yes
Request Body
The request accepts the following data in JSON format.
- botVersionLocaleSpecification
-
Specifies the locales that Amazon Lex adds to this version. You can choose the
Draftversion or any other previously published version for each locale. When you specify a source version, the locale data is copied from the source version to the new version.Type: String to BotVersionLocaleDetails object map
Map Entries: Maximum number of items.
Required: Yes
- description
-
A description of the version. Use the description to help identify the version in lists.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 200.
Required: No
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"botId": "string",
"botStatus": "string",
"botVersion": "string",
"botVersionLocaleSpecification": {
"string" : {
"sourceBotVersion": "string"
}
},
"creationDateTime": number,
"description": "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 bot identifier specified in the request.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - botStatus
-
When you send a request to create or update a bot, Amazon Lex sets the status response element to
Creating. After Amazon Lex builds the bot, it sets status toAvailable. If Amazon Lex can't build the bot, it sets status toFailed.Type: String
Valid Values:
Creating | Available | Inactive | Deleting | Failed | Versioning | Importing | Updating - botVersion
-
The version number assigned to the version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern:
^[0-9]+$ - botVersionLocaleSpecification
-
The source versions used for each locale in the new version.
Type: String to BotVersionLocaleDetails object map
Map Entries: Maximum number of items.
- creationDateTime
-
A timestamp of the date and time that the version was created.
Type: Timestamp
- description
-
The description of the version specified in the request.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 200.
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
- 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
- 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:
