Connect / Client / list_lex_bots

list_lex_bots#

Connect.Client.list_lex_bots(**kwargs)#

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.

Request Syntax

response = client.list_lex_bots(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

InstanceId (string) –
[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
NextToken (string) – 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.
MaxResults (integer) – The maximum number of results to return per page. If no value is specified, the default is 10.

Return type:

dict

Returns:

Response Syntax

{
    'LexBots': [
        {
            'Name': 'string',
            'LexRegion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- LexBots (list) –
  
  The names and Amazon Web Services Regions of the Amazon Lex bots associated with the specified instance.
  - (dict) –
    
    Configuration information of an Amazon Lex bot.
    - Name (string) –
      
      The name of the Amazon Lex bot.
    - LexRegion (string) –
      
      The Amazon Web Services Region where the Amazon Lex bot was created.
- NextToken (string) –
  
  If there are additional results, this is the token for the next set of results.

Exceptions

Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.InternalServiceException
Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.ThrottlingException