- 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.
ListBotsCommand
This API is in preview release for Amazon Connect and is subject to change.
For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to return both Amazon Lex V1 and V2 bots.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, ListBotsCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, ListBotsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // ListBotsRequest
InstanceId: "STRING_VALUE", // required
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
LexVersion: "V1" || "V2", // required
};
const command = new ListBotsCommand(input);
const response = await client.send(command);
// { // ListBotsResponse
// LexBots: [ // LexBotConfigList
// { // LexBotConfig
// LexBot: { // LexBot
// Name: "STRING_VALUE", // required
// LexRegion: "STRING_VALUE", // required
// },
// LexV2Bot: { // LexV2Bot
// AliasArn: "STRING_VALUE",
// },
// },
// ],
// NextToken: "STRING_VALUE",
// };
ListBotsCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
InstanceIdRequired | string | undefined | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
LexVersionRequired | LexVersion | undefined | The version of Amazon Lex or Amazon Lex V2. |
MaxResults | number | undefined | The maximum number of results to return per page. |
NextToken | string | undefined | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. |
ListBotsCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
LexBots | LexBotConfig[] | undefined | The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance. |
NextToken | string | undefined | If there are additional results, this is the token for the next set of results. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalServiceException | server | Request processing failed because of an error or failure with the service. |
| InvalidRequestException | client | The request is not valid. |
| ResourceNotFoundException | client | The specified resource was not found. |
| ThrottlingException | client | The throttling limit has been exceeded. |
| ConnectServiceException | Base exception class for all service exceptions from Connect service. |