listings

Creates, updates, deletes, gets or lists a listings resource.

Overview

Name	listings
Type	Resource
Id	aws.marketplace_discovery.listings

Fields

The following fields are returned by SELECT queries:

get_listing

Name	Datatype	Description
associated_entities	array	The products and offers associated with this listing. Each entity contains product and offer information.
badges	array	Badges indicating special attributes of the listing, such as free tier eligibility, free trial availability, or Quick Launch support.
catalog	string	The name of the catalog that the listing belongs to. (pattern: <code>[\w-]+</code>)
categories	array	The categories used to classify this listing into logical groups.
fulfillment_option_summaries	array	A summary of fulfillment options available for deploying or accessing the listing, such as AMI, SaaS, or Container.
highlights	array	A list of key features that the listing offers to customers.
integration_guide	string	Optional guidance explaining how to use data in this listing. Primarily defines how to integrate with a multi-product listing.
listing_id	string	The unique identifier of the listing. (pattern: <code>[\w-]+</code>)
listing_name	string	The human-readable display name of the listing. (pattern: <code>.\S.</code>)
logo_thumbnail_url	string	The URL of the logo thumbnail image for the listing. (pattern: <code>https?:​//.*</code>)
long_description	string	A detailed description of what the listing offers, in paragraph format. (pattern: <code>.\S.</code>)
pricing_models	array	The pricing models for offers associated with this listing, such as usage-based, contract, BYOL, or free.
pricing_units	array	The pricing units that define the billing dimensions for offers associated with this listing, such as users, hosts, or data.
promotional_media	array	Embedded promotional media provided by the creator of the product, such as images and videos.
publisher	object	The entity who created and published the listing.
resources	array	Resources that provide further information about using the product or requesting support, such as documentation links, support contacts, and usage instructions.
review_summary	object	A summary of customer reviews available for the listing, including average rating and total review count by source.
seller_engagements	array	Engagement options available to potential buyers, such as requesting a private offer or requesting a demo.
short_description	string	A 1–3 sentence summary describing the key aspects of the listing. (pattern: <code>.\S.</code>)
use_cases	array	Use cases associated with the listing, describing scenarios where the product can be applied.

search_listings

Name	Datatype	Description
associated_entities	array	The products associated with this listing.
badges	array	Badges indicating special attributes of the listing.
catalog	string	The name of the catalog that the listing belongs to. (pattern: <code>[\w-]+</code>)
categories	array	The categories used to classify this listing into logical groups.
fulfillment_option_summaries	array	A summary of fulfillment options available for the listing.
listing_id	string	The unique identifier of the listing. (pattern: <code>[\w-]+</code>)
listing_name	string	The human-readable display name of the listing. (pattern: <code>.\S.</code>)
logo_thumbnail_url	string	The URL of the logo thumbnail image for the listing. (pattern: <code>https?:​//.*</code>)
pricing_models	array	The pricing models for offers associated with this listing.
pricing_units	array	The pricing units that define the billing dimensions for offers associated with this listing.
publisher	object	The entity who created and published the listing.
review_summary	object	A summary of customer reviews for the listing.
short_description	string	A 1–3 sentence summary describing the key aspects of the listing. (pattern: <code>.\S.</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_listing	select	region		Provides details about a listing, such as descriptions, badges, categories, pricing model summaries, reviews, and associated products and offers.
search_listings	select	region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_listing

Provides details about a listing, such as descriptions, badges, categories, pricing model summaries, reviews, and associated products and offers.

SELECT
associated_entities,
badges,
catalog,
categories,
fulfillment_option_summaries,
highlights,
integration_guide,
listing_id,
listing_name,
logo_thumbnail_url,
long_description,
pricing_models,
pricing_units,
promotional_media,
publisher,
resources,
review_summary,
seller_engagements,
short_description,
use_cases
FROM aws.marketplace_discovery.listings
WHERE region = '{{ region }}' -- required
;

search_listings

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.

SELECT
associated_entities,
badges,
catalog,
categories,
fulfillment_option_summaries,
listing_id,
listing_name,
logo_thumbnail_url,
pricing_models,
pricing_units,
publisher,
review_summary,
short_description
FROM aws.marketplace_discovery.listings
WHERE region = '{{ region }}' -- required
;