MarketplaceDiscovery / Client / search_listings

search_listings¶

MarketplaceDiscovery.Client.search_listings(**kwargs)¶

Returns a list of product listings based on search criteria and filters. You can search by keyword, filter by category, pricing model, fulfillment type, and other attributes, and sort results by relevance or customer rating.

Request Syntax

response = client.search_listings(
    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',
            ]
        },
    ],
    maxResults=123,
    sortBy='RELEVANCE'|'AVERAGE_CUSTOMER_RATING',
    sortOrder='DESCENDING'|'ASCENDING',
    nextToken='string'
)

Parameters:

searchText (string) – The search query text to find relevant listings.
filters (list) –
Filters to narrow search results. 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) –
maxResults (integer) – The maximum number of results that are returned per call. You can use nextToken to get more results.
sortBy (string) – The field to sort results by. Valid values are RELEVANCE and AVERAGE_CUSTOMER_RATING.
sortOrder (string) – The sort direction. Valid values are DESCENDING and ASCENDING.
nextToken (string) – If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

Return type:

dict

Returns:

Response Syntax

{
    'totalResults': 123,
    'listingSummaries': [
        {
            'listingId': 'string',
            'listingName': 'string',
            'publisher': {
                'sellerProfileId': 'string',
                'displayName': 'string'
            },
            'catalog': 'string',
            'shortDescription': 'string',
            'logoThumbnailUrl': 'string',
            'categories': [
                {
                    'categoryId': 'string',
                    'displayName': 'string'
                },
            ],
            'fulfillmentOptionSummaries': [
                {
                    'fulfillmentOptionType': 'AMAZON_MACHINE_IMAGE'|'API'|'CLOUDFORMATION_TEMPLATE'|'CONTAINER'|'HELM'|'EKS_ADD_ON'|'EC2_IMAGE_BUILDER_COMPONENT'|'DATA_EXCHANGE'|'PROFESSIONAL_SERVICES'|'SAAS'|'SAGEMAKER_ALGORITHM'|'SAGEMAKER_MODEL',
                    'displayName': 'string'
                },
            ],
            'badges': [
                {
                    'displayName': 'string',
                    'badgeType': 'AWS_FREE_TIER'|'FREE_TRIAL'|'DEPLOYED_ON_AWS'|'QUICK_LAUNCH'|'MULTI_PRODUCT'
                },
            ],
            'reviewSummary': {
                'reviewSourceSummaries': [
                    {
                        'sourceName': 'string',
                        'sourceId': 'AWS_MARKETPLACE',
                        'sourceUrl': 'string',
                        'averageRating': 'string',
                        'totalReviews': 123
                    },
                ]
            },
            'pricingModels': [
                {
                    'pricingModelType': 'USAGE'|'CONTRACT'|'BYOL'|'FREE',
                    'displayName': 'string'
                },
            ],
            'pricingUnits': [
                {
                    'pricingUnitType': 'USERS'|'HOSTS'|'BANDWIDTH'|'DATA'|'TIERS'|'REQUESTS'|'UNITS',
                    'displayName': 'string'
                },
            ],
            'associatedEntities': [
                {
                    'product': {
                        'productId': 'string',
                        'productName': 'string',
                        'manufacturer': {
                            'sellerProfileId': 'string',
                            'displayName': 'string'
                        }
                    }
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- totalResults (integer) –
  
  The total number of listings matching the search criteria.
- listingSummaries (list) –
  
  The listing summaries matching the search criteria. Each summary includes the listing name, description, badges, categories, pricing models, reviews, and associated products.
  - (dict) –
    
    Summary information about a listing returned by search operations, including the listing name, description, badges, categories, pricing models, reviews, and associated products.
    - listingId (string) –
      
      The unique identifier of the listing.
    - listingName (string) –
      
      The human-readable display name of the listing.
    - publisher (dict) –
      
      The entity who created and published the listing.
      - sellerProfileId (string) –
        
        The unique identifier of the seller profile.
      - displayName (string) –
        
        The human-readable name of the seller.
    - catalog (string) –
      
      The name of the catalog that the listing belongs to.
    - shortDescription (string) –
      
      A 1–3 sentence summary describing the key aspects of the listing.
    - logoThumbnailUrl (string) –
      
      The URL of the logo thumbnail image for the listing.
    - categories (list) –
      
      The categories used to classify this listing into logical groups.
      - (dict) –
        
        A category used to classify a listing or product into a logical group.
        
        categoryId (string) –
        
        The machine-readable identifier of the category.
        
        displayName (string) –
        
        The human-readable name of the category.
    - fulfillmentOptionSummaries (list) –
      
      A summary of fulfillment options available for the listing.
      - (dict) –
        
        A summary of a fulfillment option available for deploying or accessing a listing or product.
        
        fulfillmentOptionType (string) –
        
        The machine-readable type of the fulfillment option, such as SAAS or AMAZON_MACHINE_IMAGE.
        
        displayName (string) –
        
        The human-readable name of the fulfillment option type.
    - badges (list) –
      
      Badges indicating special attributes of the listing.
      - (dict) –
        
        A badge indicating a special attribute of a listing, such as free tier eligibility or Quick Launch support.
        
        displayName (string) –
        
        The human-readable name of the badge.
        
        badgeType (string) –
        
        The machine-readable type of the badge.
    - reviewSummary (dict) –
      
      A summary of customer reviews for the listing.
      - reviewSourceSummaries (list) –
        
        Review summaries from different sources, such as AWS Marketplace.
        
        (dict) –
        
        A review summary from a specific source, including the average rating and total review count.
        
        sourceName (string) –
        
        The name of the review source, such as AWS Marketplace.
        
        sourceId (string) –
        
        The machine-readable identifier of the review source.
        
        sourceUrl (string) –
        
        The URL where the reviews can be accessed at the source.
        
        averageRating (string) –
        
        The average rating across all reviews from this source.
        
        totalReviews (integer) –
        
        The total number of reviews available from this source.
    - pricingModels (list) –
      
      The pricing models for offers associated with this listing.
      - (dict) –
        
        A pricing model that determines how buyers are charged for a listing, such as usage-based, contract, BYOL, or free.
        
        pricingModelType (string) –
        
        The machine-readable type of the pricing model.
        
        displayName (string) –
        
        The human-readable name of the pricing model.
    - pricingUnits (list) –
      
      The pricing units that define the billing dimensions for offers associated with this listing.
      - (dict) –
        
        A pricing unit that defines the billing dimension for a listing, such as users, hosts, bandwidth, or data.
        
        pricingUnitType (string) –
        
        The machine-readable type of the pricing unit.
        
        displayName (string) –
        
        The human-readable name of the pricing unit.
    - associatedEntities (list) –
      
      The products associated with this listing.
      - (dict) –
        
        A product associated with a listing summary.
        
        product (dict) –
        
        Information about the associated product.
        
        productId (string) –
        
        The unique identifier of the product.
        
        productName (string) –
        
        The human-readable display name of the product.
        
        manufacturer (dict) –
        
        The entity who manufactured the product.
        
        sellerProfileId (string) –
        
        The unique identifier of the seller profile.
        
        displayName (string) –
        
        The human-readable name of the seller.
- nextToken (string) –
  
  If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

Exceptions

MarketplaceDiscovery.Client.exceptions.ThrottlingException
MarketplaceDiscovery.Client.exceptions.AccessDeniedException
MarketplaceDiscovery.Client.exceptions.ValidationException
MarketplaceDiscovery.Client.exceptions.InternalServerException