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

DescribeBot

Provides metadata information about a bot.

Request Syntax


GET /bots/botId/ HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

botId

The unique identifier of the bot to describe.

Length Constraints: Fixed length of 10.

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

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",
   "creationDateTime": number,
   "dataPrivacy": { 
      "childDirected": boolean
   },
   "description": "string",
   "errorLogSettings": { 
      "enabled": boolean
   },
   "failureReasons": [ "string" ],
   "idleSessionTTLInSeconds": number,
   "lastUpdatedDateTime": number,
   "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 unique identifier of the bot.

Type: String

Length Constraints: Fixed length of 10.

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

botMembers

The list of bots in the network 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.

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 is ready to be used in conversations with users.

Type: String

botType

The type of the bot that was described.

Type: String

Valid Values: Bot | BotNetwork

creationDateTime

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

Type: Timestamp

dataPrivacy

Settings for managing data privacy of the bot and its conversations with users.

Type: DataPrivacy object

description

The description of the bot.

Type: String

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

errorLogSettings

Contains the configuration for error logging that specifies where and how bot errors are recorded, including destinations like CloudWatch Logs.

Type: ErrorLogSettings object

failureReasons

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

Type: Array of strings

idleSessionTTLInSeconds

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

Type: Integer

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

lastUpdatedDateTime

A timestamp of the date and time that the bot was last updated.

Type: Timestamp

roleArn

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

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.

retryAfterSeconds: The number of seconds after which the user can invoke the API again.

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