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

ListBots

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.

Request Syntax


GET /instance/InstanceId/bots?lexVersion=LexVersion&maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

Required: Yes

LexVersion

The version of Amazon Lex or Amazon Lex V2.

Valid Values: V1 | V2

Required: Yes

MaxResults

The maximum number of results to return per page.

Valid Range: Minimum value of 1. Maximum value of 25.

NextToken

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.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "LexBots": [ 
      { 
         "LexBot": { 
            "LexRegion": "string",
            "Name": "string"
         },
         "LexV2Bot": { 
            "AliasArn": "string"
         }
      }
   ],
   "NextToken": "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.

LexBots

The names and AWS Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.

Type: Array of LexBotConfig objects

NextToken

If there are additional results, this is the token for the next set of results.

Type: String

Errors

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

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429