MarketplaceDiscovery / Paginator / SearchFacets

SearchFacets

class MarketplaceDiscovery.Paginator.SearchFacets

paginator = client.get_paginator('search_facets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MarketplaceDiscovery.Client.search_facets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    locale='string',
    searchText='string',
    filters=[
        {
            'filterType': 'MIN_AVERAGE_CUSTOMER_RATING'|'MAX_AVERAGE_CUSTOMER_RATING'|'CATEGORY'|'PUBLISHER'|'FULFILLMENT_OPTION_TYPE'|'PRICING_MODEL'|'PRICING_UNIT'|'DEPLOYED_ON_AWS'|'NUMBER_OF_PRODUCTS',
            'filterValues': [
                'string',
            ]
        },
    ],
    facetTypes=[
        'AVERAGE_CUSTOMER_RATING'|'CATEGORY'|'PUBLISHER'|'FULFILLMENT_OPTION_TYPE'|'PRICING_MODEL'|'PRICING_UNIT'|'DEPLOYED_ON_AWS'|'NUMBER_OF_PRODUCTS',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• locale (string) – 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.

• searchText (string) – The search query text to filter listings before retrieving facets.

• filters (list) –

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

  • (dict) –

    A filter used to narrow search results by attribute, such as category, pricing model, or fulfillment type.

    • filterType (string) – [REQUIRED]

      The type of filter to apply.

    • filterValues (list) – [REQUIRED]

      The values to filter by. Term filters accept multiple values (OR logic). Range filters (MIN/MAX_AVERAGE_CUSTOMER_RATING) accept a single value between 0.0 and 5.0.

      • (string) –

• facetTypes (list) –

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

  • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'totalResults': 123,
    'listingFacets': {
        'string': [
            {
                'value': 'string',
                'displayName': 'string',
                'parent': 'string',
                'count': 123
            },
        ]
    },
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • totalResults (integer) –

    The total number of listings matching the search criteria.

  • listingFacets (dict) –

    A map of facet types to their corresponding facet values. Each facet value includes a display name, internal value, and count of matching listings.

    • (string) –

      • (list) –

        • (dict) –

          A facet value with display information and a count of matching listings. Used to build filter and browse experiences.

          • value (string) –

            The internal value used for filtering when passed back in a search filter.

          • displayName (string) –

            The human-readable name of the facet value, suitable for display in a user interface.

          • parent (string) –

            The parent facet value for hierarchical facets, such as subcategories.

          • count (integer) –

            The number of listings matching this facet value.

  • NextToken (string) –

    A token to resume pagination.