Skip to content

GetBotAliasesRequest

Source code in docs_src/capo_lex_model_building_service/types/get_bot_aliases_request.py
class GetBotAliasesRequest(TypedDict, closed=True):
    bot_name: "capo_lex_model_building_service.types.bot_name.BotName"
    """<p>The name of the bot.</p>"""
    next_token: NotRequired[
        "capo_lex_model_building_service.types.next_token.NextToken"
    ]
    """<p>A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request. </p>"""
    max_results: NotRequired[
        "capo_lex_model_building_service.types.max_results.MaxResults"
    ]
    """<p>The maximum number of aliases to return in the response. The default is 50. . </p>"""
    name_contains: NotRequired[
        "capo_lex_model_building_service.types.alias_name.AliasName"
    ]
    """<p>Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."</p>"""

bot_name instance-attribute

bot_name: BotName

The name of the bot.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of aliases to return in the response. The default is 50. .

name_contains instance-attribute

name_contains: NotRequired[AliasName]

Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

next_token instance-attribute

next_token: NotRequired[NextToken]

A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.