Interface MarketplaceDiscoveryClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Create a builder that can be used to configure and create aMarketplaceDiscoveryClient.static MarketplaceDiscoveryClientcreate()Create aMarketplaceDiscoveryClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default GetListingResponsegetListing(Consumer<GetListingRequest.Builder> getListingRequest) Provides details about a listing, such as descriptions, badges, categories, pricing model summaries, reviews, and associated products and offers.default GetListingResponsegetListing(GetListingRequest getListingRequest) Provides details about a listing, such as descriptions, badges, categories, pricing model summaries, reviews, and associated products and offers.default GetOfferResponsegetOffer(Consumer<GetOfferRequest.Builder> getOfferRequest) Provides details about an offer, such as the pricing model, seller of record, availability dates, badges, and associated products.default GetOfferResponsegetOffer(GetOfferRequest getOfferRequest) Provides details about an offer, such as the pricing model, seller of record, availability dates, badges, and associated products.default GetOfferSetResponsegetOfferSet(Consumer<GetOfferSetRequest.Builder> getOfferSetRequest) Provides details about an offer set, which is a bundle of offers across multiple products.default GetOfferSetResponsegetOfferSet(GetOfferSetRequest getOfferSetRequest) Provides details about an offer set, which is a bundle of offers across multiple products.default GetOfferTermsResponsegetOfferTerms(Consumer<GetOfferTermsRequest.Builder> getOfferTermsRequest) 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.default GetOfferTermsResponsegetOfferTerms(GetOfferTermsRequest getOfferTermsRequest) 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.default GetOfferTermsIterablegetOfferTermsPaginator(Consumer<GetOfferTermsRequest.Builder> getOfferTermsRequest) This is a variant ofgetOfferTerms(software.amazon.awssdk.services.marketplacediscovery.model.GetOfferTermsRequest)operation.default GetOfferTermsIterablegetOfferTermsPaginator(GetOfferTermsRequest getOfferTermsRequest) This is a variant ofgetOfferTerms(software.amazon.awssdk.services.marketplacediscovery.model.GetOfferTermsRequest)operation.default GetProductResponsegetProduct(Consumer<GetProductRequest.Builder> getProductRequest) Provides details about a product, such as descriptions, highlights, categories, fulfillment option summaries, promotional media, and seller engagement options.default GetProductResponsegetProduct(GetProductRequest getProductRequest) Provides details about a product, such as descriptions, highlights, categories, fulfillment option summaries, promotional media, and seller engagement options.default ListFulfillmentOptionsResponselistFulfillmentOptions(Consumer<ListFulfillmentOptionsRequest.Builder> listFulfillmentOptionsRequest) Returns the fulfillment options available for a product, including deployment details such as version information, operating systems, usage instructions, and release notes.default ListFulfillmentOptionsResponselistFulfillmentOptions(ListFulfillmentOptionsRequest listFulfillmentOptionsRequest) Returns the fulfillment options available for a product, including deployment details such as version information, operating systems, usage instructions, and release notes.default ListFulfillmentOptionsIterablelistFulfillmentOptionsPaginator(Consumer<ListFulfillmentOptionsRequest.Builder> listFulfillmentOptionsRequest) This is a variant oflistFulfillmentOptions(software.amazon.awssdk.services.marketplacediscovery.model.ListFulfillmentOptionsRequest)operation.default ListFulfillmentOptionsIterablelistFulfillmentOptionsPaginator(ListFulfillmentOptionsRequest listFulfillmentOptionsRequest) This is a variant oflistFulfillmentOptions(software.amazon.awssdk.services.marketplacediscovery.model.ListFulfillmentOptionsRequest)operation.default ListPurchaseOptionsResponselistPurchaseOptions(Consumer<ListPurchaseOptionsRequest.Builder> listPurchaseOptionsRequest) Returns the purchase options (offers and offer sets) available to the buyer.default ListPurchaseOptionsResponselistPurchaseOptions(ListPurchaseOptionsRequest listPurchaseOptionsRequest) Returns the purchase options (offers and offer sets) available to the buyer.default ListPurchaseOptionsIterablelistPurchaseOptionsPaginator(Consumer<ListPurchaseOptionsRequest.Builder> listPurchaseOptionsRequest) This is a variant oflistPurchaseOptions(software.amazon.awssdk.services.marketplacediscovery.model.ListPurchaseOptionsRequest)operation.default ListPurchaseOptionsIterablelistPurchaseOptionsPaginator(ListPurchaseOptionsRequest listPurchaseOptionsRequest) This is a variant oflistPurchaseOptions(software.amazon.awssdk.services.marketplacediscovery.model.ListPurchaseOptionsRequest)operation.default SearchFacetsResponsesearchFacets(Consumer<SearchFacetsRequest.Builder> searchFacetsRequest) Returns available facet values for filtering listings, such as categories, pricing models, fulfillment option types, publishers, and customer ratings.default SearchFacetsResponsesearchFacets(SearchFacetsRequest searchFacetsRequest) Returns available facet values for filtering listings, such as categories, pricing models, fulfillment option types, publishers, and customer ratings.default SearchFacetsIterablesearchFacetsPaginator(Consumer<SearchFacetsRequest.Builder> searchFacetsRequest) This is a variant ofsearchFacets(software.amazon.awssdk.services.marketplacediscovery.model.SearchFacetsRequest)operation.default SearchFacetsIterablesearchFacetsPaginator(SearchFacetsRequest searchFacetsRequest) This is a variant ofsearchFacets(software.amazon.awssdk.services.marketplacediscovery.model.SearchFacetsRequest)operation.default SearchListingsResponsesearchListings(Consumer<SearchListingsRequest.Builder> searchListingsRequest) Returns a list of product listings based on search criteria and filters.default SearchListingsResponsesearchListings(SearchListingsRequest searchListingsRequest) Returns a list of product listings based on search criteria and filters.default SearchListingsIterablesearchListingsPaginator(Consumer<SearchListingsRequest.Builder> searchListingsRequest) This is a variant ofsearchListings(software.amazon.awssdk.services.marketplacediscovery.model.SearchListingsRequest)operation.default SearchListingsIterablesearchListingsPaginator(SearchListingsRequest searchListingsRequest) This is a variant ofsearchListings(software.amazon.awssdk.services.marketplacediscovery.model.SearchListingsRequest)operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadataMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
getListing
default GetListingResponse getListing(GetListingRequest getListingRequest) throws ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException Provides details about a listing, such as descriptions, badges, categories, pricing model summaries, reviews, and associated products and offers.
- Parameters:
getListingRequest-- Returns:
- Result of the GetListing operation returned by the service.
- See Also:
-
getListing
default GetListingResponse getListing(Consumer<GetListingRequest.Builder> getListingRequest) throws ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException Provides details about a listing, such as descriptions, badges, categories, pricing model summaries, reviews, and associated products and offers.
This is a convenience which creates an instance of the
GetListingRequest.Builderavoiding the need to create one manually viaGetListingRequest.builder()- Parameters:
getListingRequest- AConsumerthat will call methods onGetListingRequest.Builderto create a request.- Returns:
- Result of the GetListing operation returned by the service.
- See Also:
-
getOffer
default GetOfferResponse getOffer(GetOfferRequest getOfferRequest) throws ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException Provides details about an offer, such as the pricing model, seller of record, availability dates, badges, and associated products.
- Parameters:
getOfferRequest-- Returns:
- Result of the GetOffer operation returned by the service.
- See Also:
-
getOffer
default GetOfferResponse getOffer(Consumer<GetOfferRequest.Builder> getOfferRequest) throws ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException Provides details about an offer, such as the pricing model, seller of record, availability dates, badges, and associated products.
This is a convenience which creates an instance of the
GetOfferRequest.Builderavoiding the need to create one manually viaGetOfferRequest.builder()- Parameters:
getOfferRequest- AConsumerthat will call methods onGetOfferRequest.Builderto create a request.- Returns:
- Result of the GetOffer operation returned by the service.
- See Also:
-
getOfferSet
default GetOfferSetResponse getOfferSet(GetOfferSetRequest getOfferSetRequest) throws ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException 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.
- Parameters:
getOfferSetRequest-- Returns:
- Result of the GetOfferSet operation returned by the service.
- See Also:
-
getOfferSet
default GetOfferSetResponse getOfferSet(Consumer<GetOfferSetRequest.Builder> getOfferSetRequest) throws ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException 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.
This is a convenience which creates an instance of the
GetOfferSetRequest.Builderavoiding the need to create one manually viaGetOfferSetRequest.builder()- Parameters:
getOfferSetRequest- AConsumerthat will call methods onGetOfferSetRequest.Builderto create a request.- Returns:
- Result of the GetOfferSet operation returned by the service.
- See Also:
-
getOfferTerms
default GetOfferTermsResponse getOfferTerms(GetOfferTermsRequest getOfferTermsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException 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.
- Parameters:
getOfferTermsRequest-- Returns:
- Result of the GetOfferTerms operation returned by the service.
- See Also:
-
getOfferTerms
default GetOfferTermsResponse getOfferTerms(Consumer<GetOfferTermsRequest.Builder> getOfferTermsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException 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.
This is a convenience which creates an instance of the
GetOfferTermsRequest.Builderavoiding the need to create one manually viaGetOfferTermsRequest.builder()- Parameters:
getOfferTermsRequest- AConsumerthat will call methods onGetOfferTermsRequest.Builderto create a request.- Returns:
- Result of the GetOfferTerms operation returned by the service.
- See Also:
-
getOfferTermsPaginator
default GetOfferTermsIterable getOfferTermsPaginator(GetOfferTermsRequest getOfferTermsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException This is a variant of
getOfferTerms(software.amazon.awssdk.services.marketplacediscovery.model.GetOfferTermsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.marketplacediscovery.paginators.GetOfferTermsIterable responses = client.getOfferTermsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.marketplacediscovery.paginators.GetOfferTermsIterable responses = client .getOfferTermsPaginator(request); for (software.amazon.awssdk.services.marketplacediscovery.model.GetOfferTermsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.marketplacediscovery.paginators.GetOfferTermsIterable responses = client.getOfferTermsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getOfferTerms(software.amazon.awssdk.services.marketplacediscovery.model.GetOfferTermsRequest)operation.- Parameters:
getOfferTermsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getOfferTermsPaginator
default GetOfferTermsIterable getOfferTermsPaginator(Consumer<GetOfferTermsRequest.Builder> getOfferTermsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException This is a variant of
getOfferTerms(software.amazon.awssdk.services.marketplacediscovery.model.GetOfferTermsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.marketplacediscovery.paginators.GetOfferTermsIterable responses = client.getOfferTermsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.marketplacediscovery.paginators.GetOfferTermsIterable responses = client .getOfferTermsPaginator(request); for (software.amazon.awssdk.services.marketplacediscovery.model.GetOfferTermsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.marketplacediscovery.paginators.GetOfferTermsIterable responses = client.getOfferTermsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getOfferTerms(software.amazon.awssdk.services.marketplacediscovery.model.GetOfferTermsRequest)operation.
This is a convenience which creates an instance of the
GetOfferTermsRequest.Builderavoiding the need to create one manually viaGetOfferTermsRequest.builder()- Parameters:
getOfferTermsRequest- AConsumerthat will call methods onGetOfferTermsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getProduct
default GetProductResponse getProduct(GetProductRequest getProductRequest) throws ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException Provides details about a product, such as descriptions, highlights, categories, fulfillment option summaries, promotional media, and seller engagement options.
- Parameters:
getProductRequest-- Returns:
- Result of the GetProduct operation returned by the service.
- See Also:
-
getProduct
default GetProductResponse getProduct(Consumer<GetProductRequest.Builder> getProductRequest) throws ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException Provides details about a product, such as descriptions, highlights, categories, fulfillment option summaries, promotional media, and seller engagement options.
This is a convenience which creates an instance of the
GetProductRequest.Builderavoiding the need to create one manually viaGetProductRequest.builder()- Parameters:
getProductRequest- AConsumerthat will call methods onGetProductRequest.Builderto create a request.- Returns:
- Result of the GetProduct operation returned by the service.
- See Also:
-
listFulfillmentOptions
default ListFulfillmentOptionsResponse listFulfillmentOptions(ListFulfillmentOptionsRequest listFulfillmentOptionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException Returns the fulfillment options available for a product, including deployment details such as version information, operating systems, usage instructions, and release notes.
- Parameters:
listFulfillmentOptionsRequest-- Returns:
- Result of the ListFulfillmentOptions operation returned by the service.
- See Also:
-
listFulfillmentOptions
default ListFulfillmentOptionsResponse listFulfillmentOptions(Consumer<ListFulfillmentOptionsRequest.Builder> listFulfillmentOptionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException Returns the fulfillment options available for a product, including deployment details such as version information, operating systems, usage instructions, and release notes.
This is a convenience which creates an instance of the
ListFulfillmentOptionsRequest.Builderavoiding the need to create one manually viaListFulfillmentOptionsRequest.builder()- Parameters:
listFulfillmentOptionsRequest- AConsumerthat will call methods onListFulfillmentOptionsRequest.Builderto create a request.- Returns:
- Result of the ListFulfillmentOptions operation returned by the service.
- See Also:
-
listFulfillmentOptionsPaginator
default ListFulfillmentOptionsIterable listFulfillmentOptionsPaginator(ListFulfillmentOptionsRequest listFulfillmentOptionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException This is a variant of
listFulfillmentOptions(software.amazon.awssdk.services.marketplacediscovery.model.ListFulfillmentOptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.marketplacediscovery.paginators.ListFulfillmentOptionsIterable responses = client.listFulfillmentOptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.marketplacediscovery.paginators.ListFulfillmentOptionsIterable responses = client .listFulfillmentOptionsPaginator(request); for (software.amazon.awssdk.services.marketplacediscovery.model.ListFulfillmentOptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.marketplacediscovery.paginators.ListFulfillmentOptionsIterable responses = client.listFulfillmentOptionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFulfillmentOptions(software.amazon.awssdk.services.marketplacediscovery.model.ListFulfillmentOptionsRequest)operation.- Parameters:
listFulfillmentOptionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFulfillmentOptionsPaginator
default ListFulfillmentOptionsIterable listFulfillmentOptionsPaginator(Consumer<ListFulfillmentOptionsRequest.Builder> listFulfillmentOptionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException This is a variant of
listFulfillmentOptions(software.amazon.awssdk.services.marketplacediscovery.model.ListFulfillmentOptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.marketplacediscovery.paginators.ListFulfillmentOptionsIterable responses = client.listFulfillmentOptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.marketplacediscovery.paginators.ListFulfillmentOptionsIterable responses = client .listFulfillmentOptionsPaginator(request); for (software.amazon.awssdk.services.marketplacediscovery.model.ListFulfillmentOptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.marketplacediscovery.paginators.ListFulfillmentOptionsIterable responses = client.listFulfillmentOptionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFulfillmentOptions(software.amazon.awssdk.services.marketplacediscovery.model.ListFulfillmentOptionsRequest)operation.
This is a convenience which creates an instance of the
ListFulfillmentOptionsRequest.Builderavoiding the need to create one manually viaListFulfillmentOptionsRequest.builder()- Parameters:
listFulfillmentOptionsRequest- AConsumerthat will call methods onListFulfillmentOptionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPurchaseOptions
default ListPurchaseOptionsResponse listPurchaseOptions(ListPurchaseOptionsRequest listPurchaseOptionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException 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_IDfilter to specify the product for which to retrieve purchase options, or aVISIBILITY_SCOPEfilter to retrieve purchase options by visibility.- Parameters:
listPurchaseOptionsRequest-- Returns:
- Result of the ListPurchaseOptions operation returned by the service.
- See Also:
-
listPurchaseOptions
default ListPurchaseOptionsResponse listPurchaseOptions(Consumer<ListPurchaseOptionsRequest.Builder> listPurchaseOptionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException 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_IDfilter to specify the product for which to retrieve purchase options, or aVISIBILITY_SCOPEfilter to retrieve purchase options by visibility.
This is a convenience which creates an instance of the
ListPurchaseOptionsRequest.Builderavoiding the need to create one manually viaListPurchaseOptionsRequest.builder()- Parameters:
listPurchaseOptionsRequest- AConsumerthat will call methods onListPurchaseOptionsRequest.Builderto create a request.- Returns:
- Result of the ListPurchaseOptions operation returned by the service.
- See Also:
-
listPurchaseOptionsPaginator
default ListPurchaseOptionsIterable listPurchaseOptionsPaginator(ListPurchaseOptionsRequest listPurchaseOptionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException This is a variant of
listPurchaseOptions(software.amazon.awssdk.services.marketplacediscovery.model.ListPurchaseOptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.marketplacediscovery.paginators.ListPurchaseOptionsIterable responses = client.listPurchaseOptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.marketplacediscovery.paginators.ListPurchaseOptionsIterable responses = client .listPurchaseOptionsPaginator(request); for (software.amazon.awssdk.services.marketplacediscovery.model.ListPurchaseOptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.marketplacediscovery.paginators.ListPurchaseOptionsIterable responses = client.listPurchaseOptionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPurchaseOptions(software.amazon.awssdk.services.marketplacediscovery.model.ListPurchaseOptionsRequest)operation.- Parameters:
listPurchaseOptionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPurchaseOptionsPaginator
default ListPurchaseOptionsIterable listPurchaseOptionsPaginator(Consumer<ListPurchaseOptionsRequest.Builder> listPurchaseOptionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException This is a variant of
listPurchaseOptions(software.amazon.awssdk.services.marketplacediscovery.model.ListPurchaseOptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.marketplacediscovery.paginators.ListPurchaseOptionsIterable responses = client.listPurchaseOptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.marketplacediscovery.paginators.ListPurchaseOptionsIterable responses = client .listPurchaseOptionsPaginator(request); for (software.amazon.awssdk.services.marketplacediscovery.model.ListPurchaseOptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.marketplacediscovery.paginators.ListPurchaseOptionsIterable responses = client.listPurchaseOptionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPurchaseOptions(software.amazon.awssdk.services.marketplacediscovery.model.ListPurchaseOptionsRequest)operation.
This is a convenience which creates an instance of the
ListPurchaseOptionsRequest.Builderavoiding the need to create one manually viaListPurchaseOptionsRequest.builder()- Parameters:
listPurchaseOptionsRequest- AConsumerthat will call methods onListPurchaseOptionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchFacets
default SearchFacetsResponse searchFacets(SearchFacetsRequest searchFacetsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException 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.
- Parameters:
searchFacetsRequest-- Returns:
- Result of the SearchFacets operation returned by the service.
- See Also:
-
searchFacets
default SearchFacetsResponse searchFacets(Consumer<SearchFacetsRequest.Builder> searchFacetsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException 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.
This is a convenience which creates an instance of the
SearchFacetsRequest.Builderavoiding the need to create one manually viaSearchFacetsRequest.builder()- Parameters:
searchFacetsRequest- AConsumerthat will call methods onSearchFacetsRequest.Builderto create a request.- Returns:
- Result of the SearchFacets operation returned by the service.
- See Also:
-
searchFacetsPaginator
default SearchFacetsIterable searchFacetsPaginator(SearchFacetsRequest searchFacetsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException This is a variant of
searchFacets(software.amazon.awssdk.services.marketplacediscovery.model.SearchFacetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.marketplacediscovery.paginators.SearchFacetsIterable responses = client.searchFacetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.marketplacediscovery.paginators.SearchFacetsIterable responses = client .searchFacetsPaginator(request); for (software.amazon.awssdk.services.marketplacediscovery.model.SearchFacetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.marketplacediscovery.paginators.SearchFacetsIterable responses = client.searchFacetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchFacets(software.amazon.awssdk.services.marketplacediscovery.model.SearchFacetsRequest)operation.- Parameters:
searchFacetsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchFacetsPaginator
default SearchFacetsIterable searchFacetsPaginator(Consumer<SearchFacetsRequest.Builder> searchFacetsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException This is a variant of
searchFacets(software.amazon.awssdk.services.marketplacediscovery.model.SearchFacetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.marketplacediscovery.paginators.SearchFacetsIterable responses = client.searchFacetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.marketplacediscovery.paginators.SearchFacetsIterable responses = client .searchFacetsPaginator(request); for (software.amazon.awssdk.services.marketplacediscovery.model.SearchFacetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.marketplacediscovery.paginators.SearchFacetsIterable responses = client.searchFacetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchFacets(software.amazon.awssdk.services.marketplacediscovery.model.SearchFacetsRequest)operation.
This is a convenience which creates an instance of the
SearchFacetsRequest.Builderavoiding the need to create one manually viaSearchFacetsRequest.builder()- Parameters:
searchFacetsRequest- AConsumerthat will call methods onSearchFacetsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchListings
default SearchListingsResponse searchListings(SearchListingsRequest searchListingsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException 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.
- Parameters:
searchListingsRequest-- Returns:
- Result of the SearchListings operation returned by the service.
- See Also:
-
searchListings
default SearchListingsResponse searchListings(Consumer<SearchListingsRequest.Builder> searchListingsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException 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.
This is a convenience which creates an instance of the
SearchListingsRequest.Builderavoiding the need to create one manually viaSearchListingsRequest.builder()- Parameters:
searchListingsRequest- AConsumerthat will call methods onSearchListingsRequest.Builderto create a request.- Returns:
- Result of the SearchListings operation returned by the service.
- See Also:
-
searchListingsPaginator
default SearchListingsIterable searchListingsPaginator(SearchListingsRequest searchListingsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException This is a variant of
searchListings(software.amazon.awssdk.services.marketplacediscovery.model.SearchListingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.marketplacediscovery.paginators.SearchListingsIterable responses = client.searchListingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.marketplacediscovery.paginators.SearchListingsIterable responses = client .searchListingsPaginator(request); for (software.amazon.awssdk.services.marketplacediscovery.model.SearchListingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.marketplacediscovery.paginators.SearchListingsIterable responses = client.searchListingsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchListings(software.amazon.awssdk.services.marketplacediscovery.model.SearchListingsRequest)operation.- Parameters:
searchListingsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchListingsPaginator
default SearchListingsIterable searchListingsPaginator(Consumer<SearchListingsRequest.Builder> searchListingsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, MarketplaceDiscoveryException This is a variant of
searchListings(software.amazon.awssdk.services.marketplacediscovery.model.SearchListingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.marketplacediscovery.paginators.SearchListingsIterable responses = client.searchListingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.marketplacediscovery.paginators.SearchListingsIterable responses = client .searchListingsPaginator(request); for (software.amazon.awssdk.services.marketplacediscovery.model.SearchListingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.marketplacediscovery.paginators.SearchListingsIterable responses = client.searchListingsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchListings(software.amazon.awssdk.services.marketplacediscovery.model.SearchListingsRequest)operation.
This is a convenience which creates an instance of the
SearchListingsRequest.Builderavoiding the need to create one manually viaSearchListingsRequest.builder()- Parameters:
searchListingsRequest- AConsumerthat will call methods onSearchListingsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
create
Create aMarketplaceDiscoveryClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aMarketplaceDiscoveryClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-