DescribeBot - Amazon Lex

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", "botName": "string", "botStatus": "string", "creationDateTime": number, "dataPrivacy": { "childDirected": boolean }, "description": "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]+$

botName

The name of the bot.

Type: String

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

Pattern: ^([0-9a-zA-Z][_-]?)+$

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

Valid Values: Creating | Available | Inactive | Deleting | Failed | Versioning

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 200.

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

HTTP Status Code: 500

ResourceNotFoundException

HTTP Status Code: 404

ServiceQuotaExceededException

HTTP Status Code: 402

ThrottlingException

HTTP Status Code: 429

ValidationException

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: