Skip to main content

products

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

Overview

Nameproducts
TypeResource
Idaws.marketplace_discovery.products

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
catalogstringThe name of the catalog that the product belongs to. (pattern: <code>[\w-]+</code>)
categoriesarrayThe categories used to classify this product into logical groups.
deployed_on_awsstringIndicates whether the product is deployed on AWS infrastructure. (DEPLOYED, NOT_DEPLOYED, NOT_APPLICABLE)
fulfillment_option_summariesarrayA summary of fulfillment options available for deploying or accessing the product, such as AMI, SaaS, or Container.
highlightsarrayA list of key features that the product offers to customers.
logo_thumbnail_urlstringThe URL of the logo thumbnail image for the product. (pattern: <code>https?:​//.*</code>)
long_descriptionstringA detailed description of what the product does, in paragraph format. (pattern: <code>.\S.</code>)
manufacturerobjectThe entity who manufactured the product.
product_idstringThe unique identifier of the product. (pattern: <code>[\w-]+</code>)
product_namestringThe human-readable display name of the product. (pattern: <code>.\S.</code>)
promotional_mediaarrayEmbedded promotional media provided by the creator of the product, such as images and videos.
resourcesarrayResources that provide further information about using the product or requesting support, such as documentation links, support contacts, and usage instructions.
seller_engagementsarrayEngagement options available to potential buyers, such as requesting a private offer or requesting a demo.
short_descriptionstringA 1–3 sentence summary describing the key aspects of the product. (pattern: <code>.\S.</code>)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_productselectregionProvides details about a product, such as descriptions, highlights, categories, fulfillment option summaries, promotional media, and seller engagement options.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Provides details about a product, such as descriptions, highlights, categories, fulfillment option summaries, promotional media, and seller engagement options.

SELECT
catalog,
categories,
deployed_on_aws,
fulfillment_option_summaries,
highlights,
logo_thumbnail_url,
long_description,
manufacturer,
product_id,
product_name,
promotional_media,
resources,
seller_engagements,
short_description
FROM aws.marketplace_discovery.products
WHERE region = '{{ region }}' -- required
;