products
Creates, updates, deletes, gets or lists a products resource.
Overview
| Name | products |
| Type | Resource |
| Id | aws.marketplace_discovery.products |
Fields
The following fields are returned by SELECT queries:
- get_product
| Name | Datatype | Description |
|---|---|---|
catalog | string | The name of the catalog that the product belongs to. (pattern: <code>[\w-]+</code>) |
categories | array | The categories used to classify this product into logical groups. |
deployed_on_aws | string | Indicates whether the product is deployed on AWS infrastructure. (DEPLOYED, NOT_DEPLOYED, NOT_APPLICABLE) |
fulfillment_option_summaries | array | A summary of fulfillment options available for deploying or accessing the product, such as AMI, SaaS, or Container. |
highlights | array | A list of key features that the product offers to customers. |
logo_thumbnail_url | string | The URL of the logo thumbnail image for the product. (pattern: <code>https?://.*</code>) |
long_description | string | A detailed description of what the product does, in paragraph format. (pattern: <code>.\S.</code>) |
manufacturer | object | The entity who manufactured the product. |
product_id | string | The unique identifier of the product. (pattern: <code>[\w-]+</code>) |
product_name | string | The human-readable display name of the product. (pattern: <code>.\S.</code>) |
promotional_media | array | Embedded promotional media provided by the creator of the product, such as images and videos. |
resources | array | Resources that provide further information about using the product or requesting support, such as documentation links, support contacts, and usage instructions. |
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 product. (pattern: <code>.\S.</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_product | select | region | Provides 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.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_product
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
;