MarketplaceDiscovery class
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.
Constructors
- MarketplaceDiscovery({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl, bool useFipsEndpoint = false, bool useDualStackEndpoint = false})
-
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
getListing(
{required String listingId}) → Future< GetListingOutput> - Provides details about a listing, such as descriptions, badges, categories, pricing model summaries, reviews, and associated products and offers.
-
getOffer(
{required String offerId}) → Future< GetOfferOutput> - Provides details about an offer, such as the pricing model, seller of record, availability dates, badges, and associated products.
-
getOfferSet(
{required String offerSetId}) → Future< GetOfferSetOutput> - 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.
-
getOfferTerms(
{required String offerId, int? maxResults, String? nextToken}) → Future< GetOfferTermsOutput> - 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.
-
getProduct(
{required String productId}) → Future< GetProductOutput> - Provides details about a product, such as descriptions, highlights, categories, fulfillment option summaries, promotional media, and seller engagement options.
-
listFulfillmentOptions(
{required String productId, int? maxResults, String? nextToken}) → Future< ListFulfillmentOptionsOutput> - Returns the fulfillment options available for a product, including deployment details such as version information, operating systems, usage instructions, and release notes.
-
listPurchaseOptions(
{List< PurchaseOptionFilter> ? filters, int? maxResults, String? nextToken}) → Future<ListPurchaseOptionsOutput> - 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.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
searchFacets(
{List< SearchFacetType> ? facetTypes, List<SearchFilter> ? filters, String? nextToken, String? searchText}) → Future<SearchFacetsOutput> - 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.
-
searchListings(
{List< SearchFilter> ? filters, int? maxResults, String? nextToken, String? searchText, SearchListingsSortBy? sortBy, SearchListingsSortOrder? sortOrder}) → Future<SearchListingsOutput> - 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.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited