Skip to content

ListIntentsRequest

Source code in docs_src/capo_lex_models_v2/types/list_intents_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class ListIntentsRequest(TypedDict, closed=True):
    bot_id: "capo_lex_models_v2.types.id.Id"
    """<p>The unique identifier of the bot that contains the intent.</p>"""
    bot_version: "capo_lex_models_v2.types.bot_version.BotVersion"
    """<p>The version of the bot that contains the intent.</p>"""
    locale_id: "capo_lex_models_v2.types.locale_id.LocaleId"
    """<p>The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>"""
    sort_by: NotRequired["capo_lex_models_v2.types.intent_sort_by.IntentSortBy"]
    """<p>Determines the sort order for the response from the <code>ListIntents</code> operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.</p>"""
    filters: NotRequired["capo_lex_models_v2.types.intent_filters.IntentFilters"]
    """<p>Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.</p>"""
    max_results: NotRequired["capo_lex_models_v2.types.max_results.MaxResults"]
    """<p>The maximum number of intents to return in each page of results. If there are fewer results than the max 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>ListIntents</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>ListIntents</code> request to return the next page of results. For a complete set of results, call the <code>ListIntents</code> operation until the <code>nextToken</code> returned in the response is null.</p>"""

bot_id instance-attribute 

bot_id: Id

The unique identifier of the bot that contains the intent.

bot_version instance-attribute 

bot_version: BotVersion

The version of the bot that contains the intent.

filters instance-attribute 

filters: NotRequired[IntentFilters]

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

locale_id instance-attribute 

locale_id: LocaleId

The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

next_token instance-attribute 

next_token: NotRequired[NextToken]

If the response from the ListIntents 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 ListIntents request to return the next page of results. For a complete set of results, call the ListIntents operation until the nextToken returned in the response is null.

sort_by instance-attribute 

sort_by: NotRequired[IntentSortBy]

Determines the sort order for the response from the ListIntents operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.