purchase_options

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

Overview

Name	purchase_options
Type	Resource
Id	aws.marketplace_discovery.purchase_options

Fields

The following fields are returned by SELECT queries:

list_purchase_options

Name	Datatype	Description
associated_entities	array	The products, offers, and offer sets associated with this purchase option.
available_from_time	string (date-time)	The date and time when the purchase option became available to the buyer.
badges	array	Badges indicating special attributes of the purchase option, such as private pricing or future dated.
catalog	string	The name of the catalog that the purchase option belongs to. (pattern: <code>[\w-]+</code>)
expiration_time	string (date-time)	The date and time when the purchase option expires and is no longer available for procurement.
purchase_option_id	string	The unique identifier of the purchase option. (pattern: <code>.\S.</code>)
purchase_option_name	string	The display name of the purchase option. (pattern: <code>.\S.</code>)
purchase_option_type	string	The type of purchase option. Values are OFFER for a single-product offer or OFFERSET for a bundled offer set. (OFFER, OFFERSET)
seller_of_record	object	The entity responsible for selling the product under this purchase option.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_purchase_options	select	region		Returns the purchase options (offers and offer sets) available to the buyer. You can filter results by product, seller, purchase option type, visibility scope, and availability status. You must include at least one of the following filters in the request: a PRODUCT_ID filter to specify the product for which to retrieve purchase options, or a VISIBILITY_SCOPE filter to retrieve purchase options by visibility.

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

list_purchase_options

Returns the purchase options (offers and offer sets) available to the buyer. You can filter results by product, seller, purchase option type, visibility scope, and availability status. You must include at least one of the following filters in the request: a PRODUCT_ID filter to specify the product for which to retrieve purchase options, or a VISIBILITY_SCOPE filter to retrieve purchase options by visibility.

SELECT
associated_entities,
available_from_time,
badges,
catalog,
expiration_time,
purchase_option_id,
purchase_option_name,
purchase_option_type,
seller_of_record
FROM aws.marketplace_discovery.purchase_options
WHERE region = '{{ region }}' -- required
;