MarketplaceDiscoveryClient

The AWS Marketplace Discovery API provides programmatic access to the AWS Marketplace catalog, including searching and browsing listings, retrieving product details and fulfillment options, and accessing public and private offer pricing and terms.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion
Link copied to clipboard
class Config

Properties

Link copied to clipboard

MarketplaceDiscoveryClient's configuration

Functions

Link copied to clipboard
abstract suspend fun getListing(input: GetListingRequest): GetListingResponse

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

Link copied to clipboard
abstract suspend fun getOffer(input: GetOfferRequest): GetOfferResponse

Provides details about an offer, such as the pricing model, seller of record, availability dates, badges, and associated products.

Link copied to clipboard
abstract suspend fun getOfferSet(input: GetOfferSetRequest): GetOfferSetResponse

Provides details about an offer set, which is a bundle of offers across multiple products. Includes the seller, availability dates, buyer notes, and associated product-offer pairs.

Link copied to clipboard

Returns the terms attached to an offer, such as pricing terms (usage-based, contract, BYOL, free trial), legal terms, payment schedules, validity terms, support terms, and renewal terms.

Link copied to clipboard
abstract suspend fun getProduct(input: GetProductRequest): GetProductResponse

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

Link copied to clipboard

Returns the fulfillment options available for a product, including deployment details such as version information, operating systems, usage instructions, and release notes.

Link copied to clipboard
abstract suspend fun listPurchaseOptions(input: ListPurchaseOptionsRequest = ListPurchaseOptionsRequest { }): ListPurchaseOptionsResponse

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.

Link copied to clipboard
abstract suspend fun searchFacets(input: SearchFacetsRequest = SearchFacetsRequest { }): SearchFacetsResponse

Returns available facet values for filtering listings, such as categories, pricing models, fulfillment option types, publishers, and customer ratings. Each facet value includes a count of matching listings.

Link copied to clipboard
abstract suspend fun searchListings(input: SearchListingsRequest = SearchListingsRequest { }): SearchListingsResponse

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.

Inherited functions

Link copied to clipboard

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

Link copied to clipboard

Provides details about an offer, such as the pricing model, seller of record, availability dates, badges, and associated products.

Link copied to clipboard

Provides details about an offer set, which is a bundle of offers across multiple products. Includes the seller, availability dates, buyer notes, and associated product-offer pairs.

Link copied to clipboard

Returns the terms attached to an offer, such as pricing terms (usage-based, contract, BYOL, free trial), legal terms, payment schedules, validity terms, support terms, and renewal terms.

Link copied to clipboard

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

Link copied to clipboard

Returns the fulfillment options available for a product, including deployment details such as version information, operating systems, usage instructions, and release notes.

Link copied to clipboard

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.

Link copied to clipboard

Returns available facet values for filtering listings, such as categories, pricing models, fulfillment option types, publishers, and customer ratings. Each facet value includes a count of matching listings.

Link copied to clipboard

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.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.