- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeBotCommand
Provides metadata information about a bot.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LexModelsV2Client, DescribeBotCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import
// const { LexModelsV2Client, DescribeBotCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import
const client = new LexModelsV2Client(config);
const input = { // DescribeBotRequest
botId: "STRING_VALUE", // required
};
const command = new DescribeBotCommand(input);
const response = await client.send(command);
// { // DescribeBotResponse
// botId: "STRING_VALUE",
// botName: "STRING_VALUE",
// description: "STRING_VALUE",
// roleArn: "STRING_VALUE",
// dataPrivacy: { // DataPrivacy
// childDirected: true || false, // required
// },
// idleSessionTTLInSeconds: Number("int"),
// botStatus: "Creating" || "Available" || "Inactive" || "Deleting" || "Failed" || "Versioning" || "Importing" || "Updating",
// creationDateTime: new Date("TIMESTAMP"),
// lastUpdatedDateTime: new Date("TIMESTAMP"),
// botType: "Bot" || "BotNetwork",
// botMembers: [ // BotMembers
// { // BotMember
// botMemberId: "STRING_VALUE", // required
// botMemberName: "STRING_VALUE", // required
// botMemberAliasId: "STRING_VALUE", // required
// botMemberAliasName: "STRING_VALUE", // required
// botMemberVersion: "STRING_VALUE", // required
// },
// ],
// failureReasons: [ // FailureReasons
// "STRING_VALUE",
// ],
// errorLogSettings: { // ErrorLogSettings
// enabled: true || false, // required
// },
// };
DescribeBotCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
botId Required | string | undefined | The unique identifier of the bot to describe. |
DescribeBotCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
botId | string | undefined | The unique identifier of the bot. |
botMembers | BotMember[] | undefined | The list of bots in the network that was described. |
botName | string | undefined | The name of the bot. |
botStatus | BotStatus | undefined | The current status of the bot. When the status is |
botType | BotType | undefined | The type of the bot that was described. |
creationDateTime | Date | undefined | A timestamp of the date and time that the bot was created. |
dataPrivacy | DataPrivacy | undefined | Settings for managing data privacy of the bot and its conversations with users. |
description | string | undefined | The description of the bot. |
errorLogSettings | ErrorLogSettings | undefined | Contains the configuration for error logging that specifies where and how bot errors are recorded, including destinations like CloudWatch Logs. |
failureReasons | string[] | undefined | If the |
idleSessionTTLInSeconds | number | undefined | The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. |
lastUpdatedDateTime | Date | undefined | A timestamp of the date and time that the bot was last updated. |
roleArn | string | undefined | The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InternalServerException | server | The service encountered an unexpected condition. Try your request again. |
ResourceNotFoundException | client | You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again. |
ServiceQuotaExceededException | client | You have reached a quota for your bot. |
ThrottlingException | client | Your request rate is too high. Reduce the frequency of requests. |
ValidationException | client | One of the input parameters in your request isn't valid. Check the parameters and try your request again. |
LexModelsV2ServiceException | Base exception class for all service exceptions from LexModelsV2 service. |