Interface MarketplaceAgreementAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
AWS Marketplace is a curated digital catalog that customers can use to find, buy, deploy, and manage third-party software, data, and services to build solutions and run their businesses. The AWS Marketplace Agreement Service provides an API interface that helps AWS Marketplace sellers manage their product-related agreements, including listing, searching, and filtering agreements.
To manage agreements in AWS Marketplace, you must ensure that your AWS Identity and Access Management (IAM) policies and roles are set up. The user must have the required policies/permissions that allow them to carry out the actions in AWS:
-
DescribeAgreement
– Grants permission to users to obtain detailed meta data about any of their agreements. -
GetAgreementTerms
– Grants permission to users to obtain details about the terms of an agreement. -
SearchAgreements
– Grants permission to users to search through all their agreements.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value 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 aMarketplaceAgreementAsyncClient
.create()
Create aMarketplaceAgreementAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.describeAgreement
(Consumer<DescribeAgreementRequest.Builder> describeAgreementRequest) Provides details about an agreement, such as the proposer, acceptor, start date, and end date.describeAgreement
(DescribeAgreementRequest describeAgreementRequest) Provides details about an agreement, such as the proposer, acceptor, start date, and end date.getAgreementTerms
(Consumer<GetAgreementTermsRequest.Builder> getAgreementTermsRequest) Obtains details about the terms in an agreement that you participated in as proposer or acceptor.getAgreementTerms
(GetAgreementTermsRequest getAgreementTermsRequest) Obtains details about the terms in an agreement that you participated in as proposer or acceptor.default GetAgreementTermsPublisher
getAgreementTermsPaginator
(Consumer<GetAgreementTermsRequest.Builder> getAgreementTermsRequest) This is a variant ofgetAgreementTerms(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest)
operation.default GetAgreementTermsPublisher
getAgreementTermsPaginator
(GetAgreementTermsRequest getAgreementTermsRequest) This is a variant ofgetAgreementTerms(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest)
operation.searchAgreements
(Consumer<SearchAgreementsRequest.Builder> searchAgreementsRequest) Searches across all agreements that a proposer or an acceptor has in AWS Marketplace.searchAgreements
(SearchAgreementsRequest searchAgreementsRequest) Searches across all agreements that a proposer or an acceptor has in AWS Marketplace.default SearchAgreementsPublisher
searchAgreementsPaginator
(Consumer<SearchAgreementsRequest.Builder> searchAgreementsRequest) This is a variant ofsearchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest)
operation.default SearchAgreementsPublisher
searchAgreementsPaginator
(SearchAgreementsRequest searchAgreementsRequest) This is a variant ofsearchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods 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
-
describeAgreement
default CompletableFuture<DescribeAgreementResponse> describeAgreement(DescribeAgreementRequest describeAgreementRequest) Provides details about an agreement, such as the proposer, acceptor, start date, and end date.
- Parameters:
describeAgreementRequest
-- Returns:
- A Java Future containing the result of the DescribeAgreement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MarketplaceAgreementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAgreement
default CompletableFuture<DescribeAgreementResponse> describeAgreement(Consumer<DescribeAgreementRequest.Builder> describeAgreementRequest) Provides details about an agreement, such as the proposer, acceptor, start date, and end date.
This is a convenience which creates an instance of the
DescribeAgreementRequest.Builder
avoiding the need to create one manually viaDescribeAgreementRequest.builder()
- Parameters:
describeAgreementRequest
- AConsumer
that will call methods onDescribeAgreementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAgreement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MarketplaceAgreementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAgreementTerms
default CompletableFuture<GetAgreementTermsResponse> getAgreementTerms(GetAgreementTermsRequest getAgreementTermsRequest) Obtains details about the terms in an agreement that you participated in as proposer or acceptor.
The details include:
-
TermType
– The type of term, such asLegalTerm
,RenewalTerm
, orConfigurableUpfrontPricingTerm
. -
TermID
– The ID of the particular term, which is common between offer and agreement. -
TermPayload
– The key information contained in the term, such as the EULA forLegalTerm
or pricing and dimensions for various pricing terms, such asConfigurableUpfrontPricingTerm
orUsageBasedPricingTerm
.
-
Configuration
– The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting theEnableAutoRenew
flag.
- Parameters:
getAgreementTermsRequest
-- Returns:
- A Java Future containing the result of the GetAgreementTerms operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MarketplaceAgreementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getAgreementTerms
default CompletableFuture<GetAgreementTermsResponse> getAgreementTerms(Consumer<GetAgreementTermsRequest.Builder> getAgreementTermsRequest) Obtains details about the terms in an agreement that you participated in as proposer or acceptor.
The details include:
-
TermType
– The type of term, such asLegalTerm
,RenewalTerm
, orConfigurableUpfrontPricingTerm
. -
TermID
– The ID of the particular term, which is common between offer and agreement. -
TermPayload
– The key information contained in the term, such as the EULA forLegalTerm
or pricing and dimensions for various pricing terms, such asConfigurableUpfrontPricingTerm
orUsageBasedPricingTerm
.
-
Configuration
– The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting theEnableAutoRenew
flag.
This is a convenience which creates an instance of the
GetAgreementTermsRequest.Builder
avoiding the need to create one manually viaGetAgreementTermsRequest.builder()
- Parameters:
getAgreementTermsRequest
- AConsumer
that will call methods onGetAgreementTermsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAgreementTerms operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MarketplaceAgreementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getAgreementTermsPaginator
default GetAgreementTermsPublisher getAgreementTermsPaginator(GetAgreementTermsRequest getAgreementTermsRequest) This is a variant of
getAgreementTerms(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementTermsPublisher publisher = client.getAgreementTermsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementTermsPublisher publisher = client.getAgreementTermsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsResponse response) { //... }; });
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
getAgreementTerms(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest)
operation.- Parameters:
getAgreementTermsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MarketplaceAgreementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAgreementTermsPaginator
default GetAgreementTermsPublisher getAgreementTermsPaginator(Consumer<GetAgreementTermsRequest.Builder> getAgreementTermsRequest) This is a variant of
getAgreementTerms(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementTermsPublisher publisher = client.getAgreementTermsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementTermsPublisher publisher = client.getAgreementTermsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsResponse response) { //... }; });
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
getAgreementTerms(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest)
operation.
This is a convenience which creates an instance of the
GetAgreementTermsRequest.Builder
avoiding the need to create one manually viaGetAgreementTermsRequest.builder()
- Parameters:
getAgreementTermsRequest
- AConsumer
that will call methods onGetAgreementTermsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MarketplaceAgreementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchAgreements
default CompletableFuture<SearchAgreementsResponse> searchAgreements(SearchAgreementsRequest searchAgreementsRequest) Searches across all agreements that a proposer or an acceptor has in AWS Marketplace. The search returns a list of agreements with basic agreement information.
The following filter combinations are supported:
-
PartyType
asProposer
+AgreementType
+ResourceIdentifier
-
PartyType
asProposer
+AgreementType
+OfferId
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
-
PartyType
asProposer
+AgreementType
+Status
-
PartyType
asProposer
+AgreementType
+ResourceIdentifier
+Status
-
PartyType
asProposer
+AgreementType
+OfferId
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+Status
-
PartyType
asProposer
+AgreementType
+ResourceType
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceType
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+OfferId
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+OfferId
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceIdentifier
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceIdentifier
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceType
- Parameters:
searchAgreementsRequest
-- Returns:
- A Java Future containing the result of the SearchAgreements operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MarketplaceAgreementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
searchAgreements
default CompletableFuture<SearchAgreementsResponse> searchAgreements(Consumer<SearchAgreementsRequest.Builder> searchAgreementsRequest) Searches across all agreements that a proposer or an acceptor has in AWS Marketplace. The search returns a list of agreements with basic agreement information.
The following filter combinations are supported:
-
PartyType
asProposer
+AgreementType
+ResourceIdentifier
-
PartyType
asProposer
+AgreementType
+OfferId
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
-
PartyType
asProposer
+AgreementType
+Status
-
PartyType
asProposer
+AgreementType
+ResourceIdentifier
+Status
-
PartyType
asProposer
+AgreementType
+OfferId
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+Status
-
PartyType
asProposer
+AgreementType
+ResourceType
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceType
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+OfferId
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+OfferId
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceIdentifier
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceIdentifier
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceType
This is a convenience which creates an instance of the
SearchAgreementsRequest.Builder
avoiding the need to create one manually viaSearchAgreementsRequest.builder()
- Parameters:
searchAgreementsRequest
- AConsumer
that will call methods onSearchAgreementsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SearchAgreements operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MarketplaceAgreementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
searchAgreementsPaginator
default SearchAgreementsPublisher searchAgreementsPaginator(SearchAgreementsRequest searchAgreementsRequest) This is a variant of
searchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.marketplaceagreement.paginators.SearchAgreementsPublisher publisher = client.searchAgreementsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.marketplaceagreement.paginators.SearchAgreementsPublisher publisher = client.searchAgreementsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsResponse response) { //... }; });
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
searchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest)
operation.- Parameters:
searchAgreementsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MarketplaceAgreementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchAgreementsPaginator
default SearchAgreementsPublisher searchAgreementsPaginator(Consumer<SearchAgreementsRequest.Builder> searchAgreementsRequest) This is a variant of
searchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.marketplaceagreement.paginators.SearchAgreementsPublisher publisher = client.searchAgreementsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.marketplaceagreement.paginators.SearchAgreementsPublisher publisher = client.searchAgreementsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsResponse response) { //... }; });
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
searchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest)
operation.
This is a convenience which creates an instance of the
SearchAgreementsRequest.Builder
avoiding the need to create one manually viaSearchAgreementsRequest.builder()
- Parameters:
searchAgreementsRequest
- AConsumer
that will call methods onSearchAgreementsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by the service.
- AccessDeniedException User does not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MarketplaceAgreementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aMarketplaceAgreementAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aMarketplaceAgreementAsyncClient
.
-