Skip to content

GetBotChannelAssociationsRequest

Source code in docs_src/capo_lex_model_building_service/types/get_bot_channel_associations_request.py
class GetBotChannelAssociationsRequest(TypedDict, closed=True):
    bot_name: "capo_lex_model_building_service.types.bot_name.BotName"
    """<p>The name of the Amazon Lex bot in the association.</p>"""
    bot_alias: "capo_lex_model_building_service.types.alias_name_or_list_all.AliasNameOrListAll"
    """<p>An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.</p>"""
    next_token: NotRequired[
        "capo_lex_model_building_service.types.next_token.NextToken"
    ]
    """<p>A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, 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 associations to return in the response. The default is 50. </p>"""
    name_contains: NotRequired[
        "capo_lex_model_building_service.types.bot_channel_name.BotChannelName"
    ]
    """<p>Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To return all bot channel associations, use a hyphen ("-") as the <code>nameContains</code> parameter.</p>"""

bot_alias instance-attribute

bot_alias: AliasNameOrListAll

An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

bot_name instance-attribute

bot_name: BotName

The name of the Amazon Lex bot in the association.

max_results instance-attribute

max_results: NotRequired[MaxResults]

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

name_contains instance-attribute

name_contains: NotRequired[BotChannelName]

Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To return all bot channel associations, use a hyphen ("-") as the nameContains parameter.

next_token instance-attribute

next_token: NotRequired[NextToken]

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