LexModelsV2 / Client / list_bots

list_bots#

LexModelsV2.Client.list_bots(**kwargs)#

Gets a list of available bots.

See also: AWS API Documentation

Request Syntax

response = client.list_bots(
    sortBy={
        'attribute': 'BotName',
        'order': 'Ascending'|'Descending'
    },
    filters=[
        {
            'name': 'BotName'|'BotType',
            'values': [
                'string',
            ],
            'operator': 'CO'|'EQ'|'NE'
        },
    ],
    maxResults=123,
    nextToken='string'
)
Parameters:

  • sortBy (dict) –

    Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.

    • attribute (string) – [REQUIRED]

      The attribute to use to sort the list of bots.

    • order (string) – [REQUIRED]

      The order to sort the list. You can choose ascending or descending.

  • filters (list) –

    Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

    • (dict) –

      Filters the responses returned by the ListBots operation.

      • name (string) – [REQUIRED]

        The name of the field to filter the list of bots.

      • values (list) – [REQUIRED]

        The value to use for filtering the list of bots.

        • (string) –

      • operator (string) – [REQUIRED]

        The operator to use for the filter. Specify EQ when the ListBots operation should return only aliases that equal the specified value. Specify CO when the ListBots operation should return aliases that contain the specified value.

  • maxResults (integer) – The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

  • nextToken (string) –

    If the response from the ListBots operation contains more results than specified in the maxResults parameter, a token is returned in the response.

    Use the returned token in the nextToken parameter of a ListBots request to return the next page of results. For a complete set of results, call the ListBots operation until the nextToken returned in the response is null.

Return type:

dict

Returns:

Response Syntax

{
    'botSummaries': [
        {
            'botId': 'string',
            'botName': 'string',
            'description': 'string',
            'botStatus': 'Creating'|'Available'|'Inactive'|'Deleting'|'Failed'|'Versioning'|'Importing'|'Updating',
            'latestBotVersion': 'string',
            'lastUpdatedDateTime': datetime(2015, 1, 1),
            'botType': 'Bot'|'BotNetwork'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • botSummaries (list) –

      Summary information for the bots that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more bots available, the nextToken field contains a token to the next page of results.

      • (dict) –

        Summary information about a bot returned by the ListBots operation.

        • botId (string) –

          The unique identifier assigned to the bot. Use this ID to get detailed information about the bot with the DescribeBot operation.

        • botName (string) –

          The name of the bot.

        • description (string) –

          The description of the bot.

        • botStatus (string) –

          The current status of the bot. When the status is Available the bot is ready for use.

        • latestBotVersion (string) –

          The latest numerical version in use for the bot.

        • lastUpdatedDateTime (datetime) –

          The date and time that the bot was last updated.

        • botType (string) –

          The type of the bot.

    • nextToken (string) –

      A token that indicates whether there are more results to return in a response to the ListBots operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBots operation request to get the next page of results.

Exceptions