Skip to content

ListSlotsRequest

Source code in docs_src/capo_lex_models_v2/types/list_slots_request.py
class ListSlotsRequest(TypedDict, closed=True):
    bot_id: "capo_lex_models_v2.types.id.Id"
    """<p>The identifier of the bot that contains the slot.</p>"""
    bot_version: "capo_lex_models_v2.types.bot_version.BotVersion"
    """<p>The version of the bot that contains the slot.</p>"""
    locale_id: "capo_lex_models_v2.types.locale_id.LocaleId"
    """<p>The identifier of the language and locale of the slots 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>"""
    intent_id: "capo_lex_models_v2.types.id.Id"
    """<p>The unique identifier of the intent that contains the slot.</p>"""
    sort_by: NotRequired["capo_lex_models_v2.types.slot_sort_by.SlotSortBy"]
    """<p>Determines the sort order for the response from the <code>ListSlots</code> operation. You can choose to sort by the slot name or last updated date in either ascending or descending order.</p>"""
    filters: NotRequired["capo_lex_models_v2.types.slot_filters.SlotFilters"]
    """<p>Provides the specification of a filter used to limit the slots 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 slots 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>ListSlots</code> operation contains more results than specified in the <code>maxResults</code> parameter, a token is returned in the response. Use that token in the <code>nextToken</code> parameter to return the next page of results.</p>"""

bot_id instance-attribute

bot_id: Id

The identifier of the bot that contains the slot.

bot_version instance-attribute

bot_version: BotVersion

The version of the bot that contains the slot.

filters instance-attribute

filters: NotRequired[SlotFilters]

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

intent_id instance-attribute

intent_id: Id

The unique identifier of the intent that contains the slot.

locale_id instance-attribute

locale_id: LocaleId

The identifier of the language and locale of the slots 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 slots 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 ListSlots operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

sort_by instance-attribute

sort_by: NotRequired[SlotSortBy]

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