Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeBotVersion

Provides metadata about a version of a bot.

Request Syntax


GET /bots/botId/botversions/botVersion/ HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

botId

The identifier of the bot containing the version to return metadata for.

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

botVersion

The version of the bot to return metadata for.

Length Constraints: Minimum length of 1. Maximum length of 5.

Pattern: ^[0-9]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "botId": "string",
   "botMembers": [ 
      { 
         "botMemberAliasId": "string",
         "botMemberAliasName": "string",
         "botMemberId": "string",
         "botMemberName": "string",
         "botMemberVersion": "string"
      }
   ],
   "botName": "string",
   "botStatus": "string",
   "botType": "string",
   "botVersion": "string",
   "creationDateTime": number,
   "dataPrivacy": { 
      "childDirected": boolean
   },
   "description": "string",
   "failureReasons": [ "string" ],
   "idleSessionTTLInSeconds": number,
   "parentBotNetworks": [ 
      { 
         "botId": "string",
         "botVersion": "string"
      }
   ],
   "roleArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

botId

The identifier of the bot that contains the version.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

botMembers

The members of bot network in the version that was described.

Type: Array of BotMember objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

botName

The name of the bot that contains the version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^([0-9a-zA-Z][_-]?){1,100}$

botStatus

The current status of the bot. When the status is Available, the bot version is ready for use.

Type: String

botType

The type of the bot in the version that was described.

Type: String

Valid Values: Bot | BotNetwork

botVersion

The version of the bot that was described.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 5.

Pattern: ^[0-9]+$

creationDateTime

A timestamp of the date and time that the bot version was created.

Type: Timestamp

dataPrivacy

Data privacy settings for the bot version.

Type: DataPrivacy object

description

The description specified for the bot.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

failureReasons

If the botStatus is Failed, this contains a list of reasons that the version couldn't be built.

Type: Array of strings

idleSessionTTLInSeconds

The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.

Type: Integer

Valid Range: Minimum value of 60. Maximum value of 86400.

parentBotNetworks

A list of the networks to which the bot version you described belongs.

Type: Array of ParentBotNetwork objects

Array Members: Minimum number of 0 items. Maximum number of 30 items.

roleArn

The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 2048.

Pattern: ^arn:aws:iam::[0-9]{12}:role/.*$

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

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

HTTP Status Code: 500

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