Skip to content

SearchFacetsInput

Source code in docs_src/capo_marketplace_discovery/types/search_facets_input.py
class SearchFacetsInput(TypedDict, closed=True):
    locale: NotRequired["capo_marketplace_discovery.types.locale.Locale"]
    """<p>A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See <code>Locale</code> for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.</p>"""
    search_text: NotRequired["capo_marketplace_discovery.types.search_text.SearchText"]
    """<p>The search query text to filter listings before retrieving facets.</p>"""
    filters: NotRequired[
        "capo_marketplace_discovery.types.search_filter_list.SearchFilterList"
    ]
    """<p>Filters to apply before retrieving facets. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.</p>"""
    facet_types: NotRequired[
        "capo_marketplace_discovery.types.facet_type_list.FacetTypeList"
    ]
    """<p>A list of specific facet types to retrieve. If empty or null, all available facets are returned.</p>"""
    next_token: NotRequired["capo_marketplace_discovery.types.next_token.NextToken"]
    """<p>If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token to retrieve the next page.</p>"""

facet_types instance-attribute

facet_types: NotRequired[FacetTypeList]

A list of specific facet types to retrieve. If empty or null, all available facets are returned.

filters instance-attribute

filters: NotRequired[SearchFilterList]

Filters to apply before retrieving facets. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.

locale instance-attribute

locale: NotRequired[Locale]

A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See Locale for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.

next_token instance-attribute

next_token: NotRequired[NextToken]

If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

search_text instance-attribute

search_text: NotRequired[SearchText]

The search query text to filter listings before retrieving facets.