Skip to content

ListBotsRequest

Source code in docs_src/capo_lex_models_v2/types/list_bots_request.py 
14
15
16
17
18
19
20
21
22
class ListBotsRequest(TypedDict, closed=True):
    sort_by: NotRequired["capo_lex_models_v2.types.bot_sort_by.BotSortBy"]
    """<p>Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.</p>"""
    filters: NotRequired["capo_lex_models_v2.types.bot_filters.BotFilters"]
    """<p>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.</p>"""
    max_results: NotRequired["capo_lex_models_v2.types.max_results.MaxResults"]
    """<p>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.</p>"""
    next_token: NotRequired["capo_lex_models_v2.types.next_token.NextToken"]
    """<p>If the response from the <code>ListBots</code> operation contains more results than specified in the <code>maxResults</code> parameter, a token is returned in the response. </p> <p>Use the returned token in the <code>nextToken</code> parameter of a <code>ListBots</code> request to return the next page of results. For a complete set of results, call the <code>ListBots</code> operation until the <code>nextToken</code> returned in the response is null.</p>"""

filters instance-attribute 

filters: NotRequired[BotFilters]

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.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

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.

next_token instance-attribute 

next_token: NotRequired[NextToken]

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.

sort_by instance-attribute 

sort_by: NotRequired[BotSortBy]

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