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 and buyers manage their product-related agreements, including listing, searching, creating, 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
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionacceptAgreementCancellationRequest(Consumer<AcceptAgreementCancellationRequestRequest.Builder> acceptAgreementCancellationRequestRequest) Allows buyers (acceptors) to accept a cancellation request that is inPENDING_APPROVALstatus.acceptAgreementCancellationRequest(AcceptAgreementCancellationRequestRequest acceptAgreementCancellationRequestRequest) Allows buyers (acceptors) to accept a cancellation request that is inPENDING_APPROVALstatus.acceptAgreementPaymentRequest(Consumer<AcceptAgreementPaymentRequestRequest.Builder> acceptAgreementPaymentRequestRequest) Allows buyers (acceptors) to accept a payment request that is inPENDING_APPROVALstatus.acceptAgreementPaymentRequest(AcceptAgreementPaymentRequestRequest acceptAgreementPaymentRequestRequest) Allows buyers (acceptors) to accept a payment request that is inPENDING_APPROVALstatus.acceptAgreementRequest(Consumer<AcceptAgreementRequestRequest.Builder> acceptAgreementRequestRequest) Accepts an agreement request to finalize the agreement.acceptAgreementRequest(AcceptAgreementRequestRequest acceptAgreementRequestRequest) Accepts an agreement request to finalize the agreement.batchCreateBillingAdjustmentRequest(Consumer<BatchCreateBillingAdjustmentRequestRequest.Builder> batchCreateBillingAdjustmentRequestRequest) Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement.batchCreateBillingAdjustmentRequest(BatchCreateBillingAdjustmentRequestRequest batchCreateBillingAdjustmentRequestRequest) Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement.builder()Create a builder that can be used to configure and create aMarketplaceAgreementAsyncClient.default CompletableFuture<CancelAgreementResponse> cancelAgreement(Consumer<CancelAgreementRequest.Builder> cancelAgreementRequest) Allows an acceptor to cancel an active agreement.default CompletableFuture<CancelAgreementResponse> cancelAgreement(CancelAgreementRequest cancelAgreementRequest) Allows an acceptor to cancel an active agreement.cancelAgreementCancellationRequest(Consumer<CancelAgreementCancellationRequestRequest.Builder> cancelAgreementCancellationRequestRequest) Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state.cancelAgreementCancellationRequest(CancelAgreementCancellationRequestRequest cancelAgreementCancellationRequestRequest) Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state.cancelAgreementPaymentRequest(Consumer<CancelAgreementPaymentRequestRequest.Builder> cancelAgreementPaymentRequestRequest) Allows sellers (proposers) to cancel a payment request that is inPENDING_APPROVALstatus.cancelAgreementPaymentRequest(CancelAgreementPaymentRequestRequest cancelAgreementPaymentRequestRequest) Allows sellers (proposers) to cancel a payment request that is inPENDING_APPROVALstatus.create()Create aMarketplaceAgreementAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createAgreementRequest(Consumer<CreateAgreementRequestRequest.Builder> createAgreementRequestRequest) Creates an agreement request that acts as a quote for the terms you want to accept.createAgreementRequest(CreateAgreementRequestRequest createAgreementRequestRequest) Creates an agreement request that acts as a quote for the terms you want to accept.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.getAgreementCancellationRequest(Consumer<GetAgreementCancellationRequestRequest.Builder> getAgreementCancellationRequestRequest) Retrieves detailed information about a specific agreement cancellation request.getAgreementCancellationRequest(GetAgreementCancellationRequestRequest getAgreementCancellationRequestRequest) Retrieves detailed information about a specific agreement cancellation request.getAgreementEntitlements(Consumer<GetAgreementEntitlementsRequest.Builder> getAgreementEntitlementsRequest) Obtains details about the entitlements of an agreement.getAgreementEntitlements(GetAgreementEntitlementsRequest getAgreementEntitlementsRequest) Obtains details about the entitlements of an agreement.getAgreementEntitlementsPaginator(Consumer<GetAgreementEntitlementsRequest.Builder> getAgreementEntitlementsRequest) This is a variant ofgetAgreementEntitlements(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementEntitlementsRequest)operation.getAgreementEntitlementsPaginator(GetAgreementEntitlementsRequest getAgreementEntitlementsRequest) This is a variant ofgetAgreementEntitlements(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementEntitlementsRequest)operation.getAgreementPaymentRequest(Consumer<GetAgreementPaymentRequestRequest.Builder> getAgreementPaymentRequestRequest) Retrieves detailed information about a specific payment request.getAgreementPaymentRequest(GetAgreementPaymentRequestRequest getAgreementPaymentRequestRequest) Retrieves detailed information about a specific payment request.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 GetAgreementTermsPublishergetAgreementTermsPaginator(Consumer<GetAgreementTermsRequest.Builder> getAgreementTermsRequest) This is a variant ofgetAgreementTerms(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest)operation.default GetAgreementTermsPublishergetAgreementTermsPaginator(GetAgreementTermsRequest getAgreementTermsRequest) This is a variant ofgetAgreementTerms(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest)operation.getBillingAdjustmentRequest(Consumer<GetBillingAdjustmentRequestRequest.Builder> getBillingAdjustmentRequestRequest) Retrieves detailed information about a specific billing adjustment request.getBillingAdjustmentRequest(GetBillingAdjustmentRequestRequest getBillingAdjustmentRequestRequest) Retrieves detailed information about a specific billing adjustment request.listAgreementCancellationRequests(Consumer<ListAgreementCancellationRequestsRequest.Builder> listAgreementCancellationRequestsRequest) Lists agreement cancellation requests available to you as a seller or buyer.listAgreementCancellationRequests(ListAgreementCancellationRequestsRequest listAgreementCancellationRequestsRequest) Lists agreement cancellation requests available to you as a seller or buyer.listAgreementCancellationRequestsPaginator(Consumer<ListAgreementCancellationRequestsRequest.Builder> listAgreementCancellationRequestsRequest) listAgreementCancellationRequestsPaginator(ListAgreementCancellationRequestsRequest listAgreementCancellationRequestsRequest) listAgreementCharges(Consumer<ListAgreementChargesRequest.Builder> listAgreementChargesRequest) Allows acceptors to view charges and purchase orders that are associated with an agreement.listAgreementCharges(ListAgreementChargesRequest listAgreementChargesRequest) Allows acceptors to view charges and purchase orders that are associated with an agreement.default ListAgreementChargesPublisherlistAgreementChargesPaginator(Consumer<ListAgreementChargesRequest.Builder> listAgreementChargesRequest) This is a variant oflistAgreementCharges(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementChargesRequest)operation.default ListAgreementChargesPublisherlistAgreementChargesPaginator(ListAgreementChargesRequest listAgreementChargesRequest) This is a variant oflistAgreementCharges(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementChargesRequest)operation.listAgreementInvoiceLineItems(Consumer<ListAgreementInvoiceLineItemsRequest.Builder> listAgreementInvoiceLineItemsRequest) Allows sellers (proposers) to retrieve aggregated billing data from AWS Marketplace agreements using flexible grouping.listAgreementInvoiceLineItems(ListAgreementInvoiceLineItemsRequest listAgreementInvoiceLineItemsRequest) Allows sellers (proposers) to retrieve aggregated billing data from AWS Marketplace agreements using flexible grouping.listAgreementInvoiceLineItemsPaginator(Consumer<ListAgreementInvoiceLineItemsRequest.Builder> listAgreementInvoiceLineItemsRequest) This is a variant oflistAgreementInvoiceLineItems(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsRequest)operation.listAgreementInvoiceLineItemsPaginator(ListAgreementInvoiceLineItemsRequest listAgreementInvoiceLineItemsRequest) This is a variant oflistAgreementInvoiceLineItems(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsRequest)operation.listAgreementPaymentRequests(Consumer<ListAgreementPaymentRequestsRequest.Builder> listAgreementPaymentRequestsRequest) Lists payment requests available to you as a seller or buyer.listAgreementPaymentRequests(ListAgreementPaymentRequestsRequest listAgreementPaymentRequestsRequest) Lists payment requests available to you as a seller or buyer.listAgreementPaymentRequestsPaginator(Consumer<ListAgreementPaymentRequestsRequest.Builder> listAgreementPaymentRequestsRequest) This is a variant oflistAgreementPaymentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsRequest)operation.listAgreementPaymentRequestsPaginator(ListAgreementPaymentRequestsRequest listAgreementPaymentRequestsRequest) This is a variant oflistAgreementPaymentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsRequest)operation.listBillingAdjustmentRequests(Consumer<ListBillingAdjustmentRequestsRequest.Builder> listBillingAdjustmentRequestsRequest) Lists billing adjustment requests for a specific agreement.listBillingAdjustmentRequests(ListBillingAdjustmentRequestsRequest listBillingAdjustmentRequestsRequest) Lists billing adjustment requests for a specific agreement.listBillingAdjustmentRequestsPaginator(Consumer<ListBillingAdjustmentRequestsRequest.Builder> listBillingAdjustmentRequestsRequest) This is a variant oflistBillingAdjustmentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsRequest)operation.listBillingAdjustmentRequestsPaginator(ListBillingAdjustmentRequestsRequest listBillingAdjustmentRequestsRequest) This is a variant oflistBillingAdjustmentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsRequest)operation.rejectAgreementCancellationRequest(Consumer<RejectAgreementCancellationRequestRequest.Builder> rejectAgreementCancellationRequestRequest) Allows buyers (acceptors) to reject a cancellation request that is inPENDING_APPROVALstatus.rejectAgreementCancellationRequest(RejectAgreementCancellationRequestRequest rejectAgreementCancellationRequestRequest) Allows buyers (acceptors) to reject a cancellation request that is inPENDING_APPROVALstatus.rejectAgreementPaymentRequest(Consumer<RejectAgreementPaymentRequestRequest.Builder> rejectAgreementPaymentRequestRequest) Allows buyers (acceptors) to reject a payment request that is inPENDING_APPROVALstatus.rejectAgreementPaymentRequest(RejectAgreementPaymentRequestRequest rejectAgreementPaymentRequestRequest) Allows buyers (acceptors) to reject a payment request that is inPENDING_APPROVALstatus.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 SearchAgreementsPublishersearchAgreementsPaginator(Consumer<SearchAgreementsRequest.Builder> searchAgreementsRequest) This is a variant ofsearchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest)operation.default SearchAgreementsPublishersearchAgreementsPaginator(SearchAgreementsRequest searchAgreementsRequest) This is a variant ofsearchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest)operation.sendAgreementCancellationRequest(Consumer<SendAgreementCancellationRequestRequest.Builder> sendAgreementCancellationRequestRequest) Allows sellers (proposers) to submit a cancellation request for an active agreement.sendAgreementCancellationRequest(SendAgreementCancellationRequestRequest sendAgreementCancellationRequestRequest) Allows sellers (proposers) to submit a cancellation request for an active agreement.sendAgreementPaymentRequest(Consumer<SendAgreementPaymentRequestRequest.Builder> sendAgreementPaymentRequestRequest) Allows sellers (proposers) to submit a payment request to buyers (acceptors) for a specific charge amount for an agreement that includes aVariablePaymentTerm.sendAgreementPaymentRequest(SendAgreementPaymentRequestRequest sendAgreementPaymentRequestRequest) Allows sellers (proposers) to submit a payment request to buyers (acceptors) for a specific charge amount for an agreement that includes aVariablePaymentTerm.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationupdatePurchaseOrders(Consumer<UpdatePurchaseOrdersRequest.Builder> updatePurchaseOrdersRequest) Allows acceptors to associate purchase orders with agreement charges after an agreement is created.updatePurchaseOrders(UpdatePurchaseOrdersRequest updatePurchaseOrdersRequest) Allows acceptors to associate purchase orders with agreement charges after an agreement is created.Methods 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
-
acceptAgreementCancellationRequest
default CompletableFuture<AcceptAgreementCancellationRequestResponse> acceptAgreementCancellationRequest(AcceptAgreementCancellationRequestRequest acceptAgreementCancellationRequestRequest) Allows buyers (acceptors) to accept a cancellation request that is in
PENDING_APPROVALstatus. Once accepted, the cancellation request transitions toAPPROVEDstatus and the agreement cancellation will be processed.Only cancellation requests in
PENDING_APPROVALstatus can be accepted. AConflictExceptionis thrown if the cancellation request is in any other status.- Parameters:
acceptAgreementCancellationRequestRequest-- Returns:
- A Java Future containing the result of the AcceptAgreementCancellationRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
acceptAgreementCancellationRequest
default CompletableFuture<AcceptAgreementCancellationRequestResponse> acceptAgreementCancellationRequest(Consumer<AcceptAgreementCancellationRequestRequest.Builder> acceptAgreementCancellationRequestRequest) Allows buyers (acceptors) to accept a cancellation request that is in
PENDING_APPROVALstatus. Once accepted, the cancellation request transitions toAPPROVEDstatus and the agreement cancellation will be processed.Only cancellation requests in
PENDING_APPROVALstatus can be accepted. AConflictExceptionis thrown if the cancellation request is in any other status.
This is a convenience which creates an instance of the
AcceptAgreementCancellationRequestRequest.Builderavoiding the need to create one manually viaAcceptAgreementCancellationRequestRequest.builder()- Parameters:
acceptAgreementCancellationRequestRequest- AConsumerthat will call methods onAcceptAgreementCancellationRequestRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AcceptAgreementCancellationRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
acceptAgreementPaymentRequest
default CompletableFuture<AcceptAgreementPaymentRequestResponse> acceptAgreementPaymentRequest(AcceptAgreementPaymentRequestRequest acceptAgreementPaymentRequestRequest) Allows buyers (acceptors) to accept a payment request that is in
PENDING_APPROVALstatus. Once accepted, the payment request transitions toAPPROVEDstatus and the charge will be processed. Buyers can optionally provide a purchase order reference for their internal tracking.Only payment requests in
PENDING_APPROVALstatus can be accepted. AConflictExceptionis thrown if the payment request is in any other status.- Parameters:
acceptAgreementPaymentRequestRequest-- Returns:
- A Java Future containing the result of the AcceptAgreementPaymentRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
acceptAgreementPaymentRequest
default CompletableFuture<AcceptAgreementPaymentRequestResponse> acceptAgreementPaymentRequest(Consumer<AcceptAgreementPaymentRequestRequest.Builder> acceptAgreementPaymentRequestRequest) Allows buyers (acceptors) to accept a payment request that is in
PENDING_APPROVALstatus. Once accepted, the payment request transitions toAPPROVEDstatus and the charge will be processed. Buyers can optionally provide a purchase order reference for their internal tracking.Only payment requests in
PENDING_APPROVALstatus can be accepted. AConflictExceptionis thrown if the payment request is in any other status.
This is a convenience which creates an instance of the
AcceptAgreementPaymentRequestRequest.Builderavoiding the need to create one manually viaAcceptAgreementPaymentRequestRequest.builder()- Parameters:
acceptAgreementPaymentRequestRequest- AConsumerthat will call methods onAcceptAgreementPaymentRequestRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AcceptAgreementPaymentRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
acceptAgreementRequest
default CompletableFuture<AcceptAgreementRequestResponse> acceptAgreementRequest(AcceptAgreementRequestRequest acceptAgreementRequestRequest) Accepts an agreement request to finalize the agreement. The acceptor can optionally provide purchase orders to associate with the agreement charges.
- Parameters:
acceptAgreementRequestRequest-- Returns:
- A Java Future containing the result of the AcceptAgreementRequest 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.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by the service.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
acceptAgreementRequest
default CompletableFuture<AcceptAgreementRequestResponse> acceptAgreementRequest(Consumer<AcceptAgreementRequestRequest.Builder> acceptAgreementRequestRequest) Accepts an agreement request to finalize the agreement. The acceptor can optionally provide purchase orders to associate with the agreement charges.
This is a convenience which creates an instance of the
AcceptAgreementRequestRequest.Builderavoiding the need to create one manually viaAcceptAgreementRequestRequest.builder()- Parameters:
acceptAgreementRequestRequest- AConsumerthat will call methods onAcceptAgreementRequestRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AcceptAgreementRequest 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.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by the service.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
batchCreateBillingAdjustmentRequest
default CompletableFuture<BatchCreateBillingAdjustmentRequestResponse> batchCreateBillingAdjustmentRequest(BatchCreateBillingAdjustmentRequestRequest batchCreateBillingAdjustmentRequestRequest) Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement. Each entry in the batch specifies an invoice and the adjustment amount. The operation returns successfully created adjustment request IDs and any errors for entries that failed to process.
Each entry requires a unique
clientTokenfor idempotency.- Parameters:
batchCreateBillingAdjustmentRequestRequest-- Returns:
- A Java Future containing the result of the BatchCreateBillingAdjustmentRequest 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.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
batchCreateBillingAdjustmentRequest
default CompletableFuture<BatchCreateBillingAdjustmentRequestResponse> batchCreateBillingAdjustmentRequest(Consumer<BatchCreateBillingAdjustmentRequestRequest.Builder> batchCreateBillingAdjustmentRequestRequest) Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement. Each entry in the batch specifies an invoice and the adjustment amount. The operation returns successfully created adjustment request IDs and any errors for entries that failed to process.
Each entry requires a unique
clientTokenfor idempotency.
This is a convenience which creates an instance of the
BatchCreateBillingAdjustmentRequestRequest.Builderavoiding the need to create one manually viaBatchCreateBillingAdjustmentRequestRequest.builder()- Parameters:
batchCreateBillingAdjustmentRequestRequest- AConsumerthat will call methods onBatchCreateBillingAdjustmentRequestRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchCreateBillingAdjustmentRequest 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.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
cancelAgreement
default CompletableFuture<CancelAgreementResponse> cancelAgreement(CancelAgreementRequest cancelAgreementRequest) Allows an acceptor to cancel an active agreement. Not all agreements are eligible for cancellation. Use the error response to determine why a cancellation request was rejected.
- Parameters:
cancelAgreementRequest-- Returns:
- A Java Future containing the result of the CancelAgreement 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.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by the service.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
cancelAgreement
default CompletableFuture<CancelAgreementResponse> cancelAgreement(Consumer<CancelAgreementRequest.Builder> cancelAgreementRequest) Allows an acceptor to cancel an active agreement. Not all agreements are eligible for cancellation. Use the error response to determine why a cancellation request was rejected.
This is a convenience which creates an instance of the
CancelAgreementRequest.Builderavoiding the need to create one manually viaCancelAgreementRequest.builder()- Parameters:
cancelAgreementRequest- AConsumerthat will call methods onCancelAgreementRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CancelAgreement 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.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by the service.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
cancelAgreementCancellationRequest
default CompletableFuture<CancelAgreementCancellationRequestResponse> cancelAgreementCancellationRequest(CancelAgreementCancellationRequestRequest cancelAgreementCancellationRequestRequest) Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state. Once cancelled, the cancellation request transitions to
CANCELLEDstatus and can no longer be approved or rejected by the buyer.Only cancellation requests in
PENDING_APPROVALstatus can be cancelled. AConflictExceptionis thrown if the cancellation request is in any other status.- Parameters:
cancelAgreementCancellationRequestRequest-- Returns:
- A Java Future containing the result of the CancelAgreementCancellationRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
cancelAgreementCancellationRequest
default CompletableFuture<CancelAgreementCancellationRequestResponse> cancelAgreementCancellationRequest(Consumer<CancelAgreementCancellationRequestRequest.Builder> cancelAgreementCancellationRequestRequest) Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state. Once cancelled, the cancellation request transitions to
CANCELLEDstatus and can no longer be approved or rejected by the buyer.Only cancellation requests in
PENDING_APPROVALstatus can be cancelled. AConflictExceptionis thrown if the cancellation request is in any other status.
This is a convenience which creates an instance of the
CancelAgreementCancellationRequestRequest.Builderavoiding the need to create one manually viaCancelAgreementCancellationRequestRequest.builder()- Parameters:
cancelAgreementCancellationRequestRequest- AConsumerthat will call methods onCancelAgreementCancellationRequestRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CancelAgreementCancellationRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
cancelAgreementPaymentRequest
default CompletableFuture<CancelAgreementPaymentRequestResponse> cancelAgreementPaymentRequest(CancelAgreementPaymentRequestRequest cancelAgreementPaymentRequestRequest) Allows sellers (proposers) to cancel a payment request that is in
PENDING_APPROVALstatus. Once cancelled, the payment request transitions toCANCELLEDstatus and can no longer be accepted or rejected by the buyer.Only payment requests in
PENDING_APPROVALstatus can be cancelled. AConflictExceptionis thrown if the payment request is in any other status.- Parameters:
cancelAgreementPaymentRequestRequest-- Returns:
- A Java Future containing the result of the CancelAgreementPaymentRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
cancelAgreementPaymentRequest
default CompletableFuture<CancelAgreementPaymentRequestResponse> cancelAgreementPaymentRequest(Consumer<CancelAgreementPaymentRequestRequest.Builder> cancelAgreementPaymentRequestRequest) Allows sellers (proposers) to cancel a payment request that is in
PENDING_APPROVALstatus. Once cancelled, the payment request transitions toCANCELLEDstatus and can no longer be accepted or rejected by the buyer.Only payment requests in
PENDING_APPROVALstatus can be cancelled. AConflictExceptionis thrown if the payment request is in any other status.
This is a convenience which creates an instance of the
CancelAgreementPaymentRequestRequest.Builderavoiding the need to create one manually viaCancelAgreementPaymentRequestRequest.builder()- Parameters:
cancelAgreementPaymentRequestRequest- AConsumerthat will call methods onCancelAgreementPaymentRequestRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CancelAgreementPaymentRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
createAgreementRequest
default CompletableFuture<CreateAgreementRequestResponse> createAgreementRequest(CreateAgreementRequestRequest createAgreementRequestRequest) Creates an agreement request that acts as a quote for the terms you want to accept. The agreement request captures the requested terms, calculates charges, and returns a summary. Use
AcceptAgreementRequestwith the returnedagreementRequestIdto finalize the agreement.- Parameters:
createAgreementRequestRequest-- Returns:
- A Java Future containing the result of the CreateAgreementRequest 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.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by the service.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- ServiceQuotaExceededException Request exceeded the maximum allowed limit (quota) for a specific resource or API operation.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
createAgreementRequest
default CompletableFuture<CreateAgreementRequestResponse> createAgreementRequest(Consumer<CreateAgreementRequestRequest.Builder> createAgreementRequestRequest) Creates an agreement request that acts as a quote for the terms you want to accept. The agreement request captures the requested terms, calculates charges, and returns a summary. Use
AcceptAgreementRequestwith the returnedagreementRequestIdto finalize the agreement.
This is a convenience which creates an instance of the
CreateAgreementRequestRequest.Builderavoiding the need to create one manually viaCreateAgreementRequestRequest.builder()- Parameters:
createAgreementRequestRequest- AConsumerthat will call methods onCreateAgreementRequestRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateAgreementRequest 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.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by the service.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- ServiceQuotaExceededException Request exceeded the maximum allowed limit (quota) for a specific resource or API operation.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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(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.
- ResourceNotFoundException Request references a resource which does not exist.
- 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:
-
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.Builderavoiding the need to create one manually viaDescribeAgreementRequest.builder()- Parameters:
describeAgreementRequest- AConsumerthat will call methods onDescribeAgreementRequest.Builderto 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.
- ResourceNotFoundException Request references a resource which does not exist.
- 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:
-
getAgreementCancellationRequest
default CompletableFuture<GetAgreementCancellationRequestResponse> getAgreementCancellationRequest(GetAgreementCancellationRequestRequest getAgreementCancellationRequestRequest) Retrieves detailed information about a specific agreement cancellation request. Both sellers (proposers) and buyers (acceptors) can use this operation to view cancellation requests associated with their agreements.
- Parameters:
getAgreementCancellationRequestRequest-- Returns:
- A Java Future containing the result of the GetAgreementCancellationRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- 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:
-
getAgreementCancellationRequest
default CompletableFuture<GetAgreementCancellationRequestResponse> getAgreementCancellationRequest(Consumer<GetAgreementCancellationRequestRequest.Builder> getAgreementCancellationRequestRequest) Retrieves detailed information about a specific agreement cancellation request. Both sellers (proposers) and buyers (acceptors) can use this operation to view cancellation requests associated with their agreements.
This is a convenience which creates an instance of the
GetAgreementCancellationRequestRequest.Builderavoiding the need to create one manually viaGetAgreementCancellationRequestRequest.builder()- Parameters:
getAgreementCancellationRequestRequest- AConsumerthat will call methods onGetAgreementCancellationRequestRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAgreementCancellationRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- 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:
-
getAgreementEntitlements
default CompletableFuture<GetAgreementEntitlementsResponse> getAgreementEntitlements(GetAgreementEntitlementsRequest getAgreementEntitlementsRequest) Obtains details about the entitlements of an agreement.
- Parameters:
getAgreementEntitlementsRequest-- Returns:
- A Java Future containing the result of the GetAgreementEntitlements 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.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by the service.
- ResourceNotFoundException Request references a resource which does not exist.
- 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:
-
getAgreementEntitlements
default CompletableFuture<GetAgreementEntitlementsResponse> getAgreementEntitlements(Consumer<GetAgreementEntitlementsRequest.Builder> getAgreementEntitlementsRequest) Obtains details about the entitlements of an agreement.
This is a convenience which creates an instance of the
GetAgreementEntitlementsRequest.Builderavoiding the need to create one manually viaGetAgreementEntitlementsRequest.builder()- Parameters:
getAgreementEntitlementsRequest- AConsumerthat will call methods onGetAgreementEntitlementsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAgreementEntitlements 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.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by the service.
- ResourceNotFoundException Request references a resource which does not exist.
- 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:
-
getAgreementEntitlementsPaginator
default GetAgreementEntitlementsPublisher getAgreementEntitlementsPaginator(GetAgreementEntitlementsRequest getAgreementEntitlementsRequest) This is a variant of
getAgreementEntitlements(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementEntitlementsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementEntitlementsPublisher publisher = client.getAgreementEntitlementsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementEntitlementsPublisher publisher = client.getAgreementEntitlementsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementEntitlementsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementEntitlementsResponse 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
getAgreementEntitlements(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementEntitlementsRequest)operation.- Parameters:
getAgreementEntitlementsRequest-- 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.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by the service.
- ResourceNotFoundException Request references a resource which does not exist.
- 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:
-
getAgreementEntitlementsPaginator
default GetAgreementEntitlementsPublisher getAgreementEntitlementsPaginator(Consumer<GetAgreementEntitlementsRequest.Builder> getAgreementEntitlementsRequest) This is a variant of
getAgreementEntitlements(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementEntitlementsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementEntitlementsPublisher publisher = client.getAgreementEntitlementsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementEntitlementsPublisher publisher = client.getAgreementEntitlementsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementEntitlementsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementEntitlementsResponse 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
getAgreementEntitlements(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementEntitlementsRequest)operation.
This is a convenience which creates an instance of the
GetAgreementEntitlementsRequest.Builderavoiding the need to create one manually viaGetAgreementEntitlementsRequest.builder()- Parameters:
getAgreementEntitlementsRequest- AConsumerthat will call methods onGetAgreementEntitlementsRequest.Builderto 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.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by the service.
- ResourceNotFoundException Request references a resource which does not exist.
- 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:
-
getAgreementPaymentRequest
default CompletableFuture<GetAgreementPaymentRequestResponse> getAgreementPaymentRequest(GetAgreementPaymentRequestRequest getAgreementPaymentRequestRequest) Retrieves detailed information about a specific payment request. Both sellers (proposers) and buyers (acceptors) can use this operation to view payment requests associated with their agreements. The response includes the current status, charge details, timestamps, and the charge ID if the request has been approved.
The calling identity must be either the acceptor or proposer of the payment request. A
ResourceNotFoundExceptionis returned if the payment request does not exist.- Parameters:
getAgreementPaymentRequestRequest-- Returns:
- A Java Future containing the result of the GetAgreementPaymentRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- 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:
-
getAgreementPaymentRequest
default CompletableFuture<GetAgreementPaymentRequestResponse> getAgreementPaymentRequest(Consumer<GetAgreementPaymentRequestRequest.Builder> getAgreementPaymentRequestRequest) Retrieves detailed information about a specific payment request. Both sellers (proposers) and buyers (acceptors) can use this operation to view payment requests associated with their agreements. The response includes the current status, charge details, timestamps, and the charge ID if the request has been approved.
The calling identity must be either the acceptor or proposer of the payment request. A
ResourceNotFoundExceptionis returned if the payment request does not exist.
This is a convenience which creates an instance of the
GetAgreementPaymentRequestRequest.Builderavoiding the need to create one manually viaGetAgreementPaymentRequestRequest.builder()- Parameters:
getAgreementPaymentRequestRequest- AConsumerthat will call methods onGetAgreementPaymentRequestRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAgreementPaymentRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- 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:
-
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 forLegalTermor pricing and dimensions for various pricing terms, such asConfigurableUpfrontPricingTermorUsageBasedPricingTerm.
-
Configuration– The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting theEnableAutoRenewflag.
- 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.
- ResourceNotFoundException Request references a resource which does not exist.
- 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:
-
-
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 forLegalTermor pricing and dimensions for various pricing terms, such asConfigurableUpfrontPricingTermorUsageBasedPricingTerm.
-
Configuration– The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting theEnableAutoRenewflag.
This is a convenience which creates an instance of the
GetAgreementTermsRequest.Builderavoiding the need to create one manually viaGetAgreementTermsRequest.builder()- Parameters:
getAgreementTermsRequest- AConsumerthat will call methods onGetAgreementTermsRequest.Builderto 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.
- ResourceNotFoundException Request references a resource which does not exist.
- 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:
-
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementTermsPublisher publisher = client.getAgreementTermsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.
- ResourceNotFoundException Request references a resource which does not exist.
- 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:
-
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementTermsPublisher publisher = client.getAgreementTermsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaGetAgreementTermsRequest.builder()- Parameters:
getAgreementTermsRequest- AConsumerthat will call methods onGetAgreementTermsRequest.Builderto 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.
- ResourceNotFoundException Request references a resource which does not exist.
- 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:
-
getBillingAdjustmentRequest
default CompletableFuture<GetBillingAdjustmentRequestResponse> getBillingAdjustmentRequest(GetBillingAdjustmentRequestRequest getBillingAdjustmentRequestRequest) Retrieves detailed information about a specific billing adjustment request. Sellers (proposers) can use this operation to view the status and details of a billing adjustment request they submitted.
- Parameters:
getBillingAdjustmentRequestRequest-- Returns:
- A Java Future containing the result of the GetBillingAdjustmentRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- 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:
-
getBillingAdjustmentRequest
default CompletableFuture<GetBillingAdjustmentRequestResponse> getBillingAdjustmentRequest(Consumer<GetBillingAdjustmentRequestRequest.Builder> getBillingAdjustmentRequestRequest) Retrieves detailed information about a specific billing adjustment request. Sellers (proposers) can use this operation to view the status and details of a billing adjustment request they submitted.
This is a convenience which creates an instance of the
GetBillingAdjustmentRequestRequest.Builderavoiding the need to create one manually viaGetBillingAdjustmentRequestRequest.builder()- Parameters:
getBillingAdjustmentRequestRequest- AConsumerthat will call methods onGetBillingAdjustmentRequestRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetBillingAdjustmentRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- 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:
-
listAgreementCancellationRequests
default CompletableFuture<ListAgreementCancellationRequestsResponse> listAgreementCancellationRequests(ListAgreementCancellationRequestsRequest listAgreementCancellationRequestsRequest) Lists agreement cancellation requests available to you as a seller or buyer. Both sellers (proposers) and buyers (acceptors) can use this operation to find cancellation requests by specifying their party type and applying optional filters.
PartyTypeis a required parameter. AValidationExceptionis returned ifPartyTypeis not provided.- Parameters:
listAgreementCancellationRequestsRequest-- Returns:
- A Java Future containing the result of the ListAgreementCancellationRequests 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:
-
listAgreementCancellationRequests
default CompletableFuture<ListAgreementCancellationRequestsResponse> listAgreementCancellationRequests(Consumer<ListAgreementCancellationRequestsRequest.Builder> listAgreementCancellationRequestsRequest) Lists agreement cancellation requests available to you as a seller or buyer. Both sellers (proposers) and buyers (acceptors) can use this operation to find cancellation requests by specifying their party type and applying optional filters.
PartyTypeis a required parameter. AValidationExceptionis returned ifPartyTypeis not provided.
This is a convenience which creates an instance of the
ListAgreementCancellationRequestsRequest.Builderavoiding the need to create one manually viaListAgreementCancellationRequestsRequest.builder()- Parameters:
listAgreementCancellationRequestsRequest- AConsumerthat will call methods onListAgreementCancellationRequestsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAgreementCancellationRequests 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:
-
listAgreementCancellationRequestsPaginator
default ListAgreementCancellationRequestsPublisher listAgreementCancellationRequestsPaginator(ListAgreementCancellationRequestsRequest listAgreementCancellationRequestsRequest) This is a variant of
listAgreementCancellationRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementCancellationRequestsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementCancellationRequestsPublisher publisher = client.listAgreementCancellationRequestsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementCancellationRequestsPublisher publisher = client.listAgreementCancellationRequestsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementCancellationRequestsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementCancellationRequestsResponse 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
listAgreementCancellationRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementCancellationRequestsRequest)operation.- Parameters:
listAgreementCancellationRequestsRequest-- 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:
-
listAgreementCancellationRequestsPaginator
default ListAgreementCancellationRequestsPublisher listAgreementCancellationRequestsPaginator(Consumer<ListAgreementCancellationRequestsRequest.Builder> listAgreementCancellationRequestsRequest) This is a variant of
listAgreementCancellationRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementCancellationRequestsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementCancellationRequestsPublisher publisher = client.listAgreementCancellationRequestsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementCancellationRequestsPublisher publisher = client.listAgreementCancellationRequestsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementCancellationRequestsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementCancellationRequestsResponse 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
listAgreementCancellationRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementCancellationRequestsRequest)operation.
This is a convenience which creates an instance of the
ListAgreementCancellationRequestsRequest.Builderavoiding the need to create one manually viaListAgreementCancellationRequestsRequest.builder()- Parameters:
listAgreementCancellationRequestsRequest- AConsumerthat will call methods onListAgreementCancellationRequestsRequest.Builderto 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:
-
listAgreementCharges
default CompletableFuture<ListAgreementChargesResponse> listAgreementCharges(ListAgreementChargesRequest listAgreementChargesRequest) Allows acceptors to view charges and purchase orders that are associated with an agreement. The response includes details about all charges regardless of whether a purchase order is linked to each charge.
- Parameters:
listAgreementChargesRequest-- Returns:
- A Java Future containing the result of the ListAgreementCharges 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:
-
listAgreementCharges
default CompletableFuture<ListAgreementChargesResponse> listAgreementCharges(Consumer<ListAgreementChargesRequest.Builder> listAgreementChargesRequest) Allows acceptors to view charges and purchase orders that are associated with an agreement. The response includes details about all charges regardless of whether a purchase order is linked to each charge.
This is a convenience which creates an instance of the
ListAgreementChargesRequest.Builderavoiding the need to create one manually viaListAgreementChargesRequest.builder()- Parameters:
listAgreementChargesRequest- AConsumerthat will call methods onListAgreementChargesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAgreementCharges 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:
-
listAgreementChargesPaginator
default ListAgreementChargesPublisher listAgreementChargesPaginator(ListAgreementChargesRequest listAgreementChargesRequest) This is a variant of
listAgreementCharges(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementChargesRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementChargesPublisher publisher = client.listAgreementChargesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementChargesPublisher publisher = client.listAgreementChargesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementChargesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementChargesResponse 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
listAgreementCharges(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementChargesRequest)operation.- Parameters:
listAgreementChargesRequest-- 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:
-
listAgreementChargesPaginator
default ListAgreementChargesPublisher listAgreementChargesPaginator(Consumer<ListAgreementChargesRequest.Builder> listAgreementChargesRequest) This is a variant of
listAgreementCharges(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementChargesRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementChargesPublisher publisher = client.listAgreementChargesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementChargesPublisher publisher = client.listAgreementChargesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementChargesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementChargesResponse 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
listAgreementCharges(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementChargesRequest)operation.
This is a convenience which creates an instance of the
ListAgreementChargesRequest.Builderavoiding the need to create one manually viaListAgreementChargesRequest.builder()- Parameters:
listAgreementChargesRequest- AConsumerthat will call methods onListAgreementChargesRequest.Builderto 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:
-
listAgreementInvoiceLineItems
default CompletableFuture<ListAgreementInvoiceLineItemsResponse> listAgreementInvoiceLineItems(ListAgreementInvoiceLineItemsRequest listAgreementInvoiceLineItemsRequest) Allows sellers (proposers) to retrieve aggregated billing data from AWS Marketplace agreements using flexible grouping. Supports invoice-level aggregation with filtering by billing period, invoice type, and issued date.
The
groupByparameter is required and supports onlyINVOICE_IDas a value. TheagreementIdparameter is required.- Parameters:
listAgreementInvoiceLineItemsRequest-- Returns:
- A Java Future containing the result of the ListAgreementInvoiceLineItems 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:
-
listAgreementInvoiceLineItems
default CompletableFuture<ListAgreementInvoiceLineItemsResponse> listAgreementInvoiceLineItems(Consumer<ListAgreementInvoiceLineItemsRequest.Builder> listAgreementInvoiceLineItemsRequest) Allows sellers (proposers) to retrieve aggregated billing data from AWS Marketplace agreements using flexible grouping. Supports invoice-level aggregation with filtering by billing period, invoice type, and issued date.
The
groupByparameter is required and supports onlyINVOICE_IDas a value. TheagreementIdparameter is required.
This is a convenience which creates an instance of the
ListAgreementInvoiceLineItemsRequest.Builderavoiding the need to create one manually viaListAgreementInvoiceLineItemsRequest.builder()- Parameters:
listAgreementInvoiceLineItemsRequest- AConsumerthat will call methods onListAgreementInvoiceLineItemsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAgreementInvoiceLineItems 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:
-
listAgreementInvoiceLineItemsPaginator
default ListAgreementInvoiceLineItemsPublisher listAgreementInvoiceLineItemsPaginator(ListAgreementInvoiceLineItemsRequest listAgreementInvoiceLineItemsRequest) This is a variant of
listAgreementInvoiceLineItems(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementInvoiceLineItemsPublisher publisher = client.listAgreementInvoiceLineItemsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementInvoiceLineItemsPublisher publisher = client.listAgreementInvoiceLineItemsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsResponse 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
listAgreementInvoiceLineItems(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsRequest)operation.- Parameters:
listAgreementInvoiceLineItemsRequest-- 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:
-
listAgreementInvoiceLineItemsPaginator
default ListAgreementInvoiceLineItemsPublisher listAgreementInvoiceLineItemsPaginator(Consumer<ListAgreementInvoiceLineItemsRequest.Builder> listAgreementInvoiceLineItemsRequest) This is a variant of
listAgreementInvoiceLineItems(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementInvoiceLineItemsPublisher publisher = client.listAgreementInvoiceLineItemsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementInvoiceLineItemsPublisher publisher = client.listAgreementInvoiceLineItemsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsResponse 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
listAgreementInvoiceLineItems(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsRequest)operation.
This is a convenience which creates an instance of the
ListAgreementInvoiceLineItemsRequest.Builderavoiding the need to create one manually viaListAgreementInvoiceLineItemsRequest.builder()- Parameters:
listAgreementInvoiceLineItemsRequest- AConsumerthat will call methods onListAgreementInvoiceLineItemsRequest.Builderto 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:
-
listAgreementPaymentRequests
default CompletableFuture<ListAgreementPaymentRequestsResponse> listAgreementPaymentRequests(ListAgreementPaymentRequestsRequest listAgreementPaymentRequestsRequest) Lists payment requests available to you as a seller or buyer. Both sellers (proposers) and buyers (acceptors) can use this operation to find payment requests by specifying their party type and applying optional parameters.
PartyTypeis a required parameter. AValidationExceptionis returned ifPartyTypeis not provided. Pagination is supported throughmaxResults(1-50, default 50) andnextTokenparameters.- Parameters:
listAgreementPaymentRequestsRequest-- Returns:
- A Java Future containing the result of the ListAgreementPaymentRequests 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:
-
listAgreementPaymentRequests
default CompletableFuture<ListAgreementPaymentRequestsResponse> listAgreementPaymentRequests(Consumer<ListAgreementPaymentRequestsRequest.Builder> listAgreementPaymentRequestsRequest) Lists payment requests available to you as a seller or buyer. Both sellers (proposers) and buyers (acceptors) can use this operation to find payment requests by specifying their party type and applying optional parameters.
PartyTypeis a required parameter. AValidationExceptionis returned ifPartyTypeis not provided. Pagination is supported throughmaxResults(1-50, default 50) andnextTokenparameters.
This is a convenience which creates an instance of the
ListAgreementPaymentRequestsRequest.Builderavoiding the need to create one manually viaListAgreementPaymentRequestsRequest.builder()- Parameters:
listAgreementPaymentRequestsRequest- AConsumerthat will call methods onListAgreementPaymentRequestsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAgreementPaymentRequests 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:
-
listAgreementPaymentRequestsPaginator
default ListAgreementPaymentRequestsPublisher listAgreementPaymentRequestsPaginator(ListAgreementPaymentRequestsRequest listAgreementPaymentRequestsRequest) This is a variant of
listAgreementPaymentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementPaymentRequestsPublisher publisher = client.listAgreementPaymentRequestsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementPaymentRequestsPublisher publisher = client.listAgreementPaymentRequestsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsResponse 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
listAgreementPaymentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsRequest)operation.- Parameters:
listAgreementPaymentRequestsRequest-- 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:
-
listAgreementPaymentRequestsPaginator
default ListAgreementPaymentRequestsPublisher listAgreementPaymentRequestsPaginator(Consumer<ListAgreementPaymentRequestsRequest.Builder> listAgreementPaymentRequestsRequest) This is a variant of
listAgreementPaymentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementPaymentRequestsPublisher publisher = client.listAgreementPaymentRequestsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementPaymentRequestsPublisher publisher = client.listAgreementPaymentRequestsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsResponse 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
listAgreementPaymentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsRequest)operation.
This is a convenience which creates an instance of the
ListAgreementPaymentRequestsRequest.Builderavoiding the need to create one manually viaListAgreementPaymentRequestsRequest.builder()- Parameters:
listAgreementPaymentRequestsRequest- AConsumerthat will call methods onListAgreementPaymentRequestsRequest.Builderto 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:
-
listBillingAdjustmentRequests
default CompletableFuture<ListBillingAdjustmentRequestsResponse> listBillingAdjustmentRequests(ListBillingAdjustmentRequestsRequest listBillingAdjustmentRequestsRequest) Lists billing adjustment requests for a specific agreement. Sellers (proposers) can use this operation to view all billing adjustment requests associated with an agreement.
- Parameters:
listBillingAdjustmentRequestsRequest-- Returns:
- A Java Future containing the result of the ListBillingAdjustmentRequests 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:
-
listBillingAdjustmentRequests
default CompletableFuture<ListBillingAdjustmentRequestsResponse> listBillingAdjustmentRequests(Consumer<ListBillingAdjustmentRequestsRequest.Builder> listBillingAdjustmentRequestsRequest) Lists billing adjustment requests for a specific agreement. Sellers (proposers) can use this operation to view all billing adjustment requests associated with an agreement.
This is a convenience which creates an instance of the
ListBillingAdjustmentRequestsRequest.Builderavoiding the need to create one manually viaListBillingAdjustmentRequestsRequest.builder()- Parameters:
listBillingAdjustmentRequestsRequest- AConsumerthat will call methods onListBillingAdjustmentRequestsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListBillingAdjustmentRequests 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:
-
listBillingAdjustmentRequestsPaginator
default ListBillingAdjustmentRequestsPublisher listBillingAdjustmentRequestsPaginator(ListBillingAdjustmentRequestsRequest listBillingAdjustmentRequestsRequest) This is a variant of
listBillingAdjustmentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListBillingAdjustmentRequestsPublisher publisher = client.listBillingAdjustmentRequestsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.marketplaceagreement.paginators.ListBillingAdjustmentRequestsPublisher publisher = client.listBillingAdjustmentRequestsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsResponse 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
listBillingAdjustmentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsRequest)operation.- Parameters:
listBillingAdjustmentRequestsRequest-- 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:
-
listBillingAdjustmentRequestsPaginator
default ListBillingAdjustmentRequestsPublisher listBillingAdjustmentRequestsPaginator(Consumer<ListBillingAdjustmentRequestsRequest.Builder> listBillingAdjustmentRequestsRequest) This is a variant of
listBillingAdjustmentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListBillingAdjustmentRequestsPublisher publisher = client.listBillingAdjustmentRequestsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.marketplaceagreement.paginators.ListBillingAdjustmentRequestsPublisher publisher = client.listBillingAdjustmentRequestsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsResponse 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
listBillingAdjustmentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsRequest)operation.
This is a convenience which creates an instance of the
ListBillingAdjustmentRequestsRequest.Builderavoiding the need to create one manually viaListBillingAdjustmentRequestsRequest.builder()- Parameters:
listBillingAdjustmentRequestsRequest- AConsumerthat will call methods onListBillingAdjustmentRequestsRequest.Builderto 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:
-
rejectAgreementCancellationRequest
default CompletableFuture<RejectAgreementCancellationRequestResponse> rejectAgreementCancellationRequest(RejectAgreementCancellationRequestRequest rejectAgreementCancellationRequestRequest) Allows buyers (acceptors) to reject a cancellation request that is in
PENDING_APPROVALstatus. Once rejected, the cancellation request transitions toREJECTEDstatus and the agreement remains active. Buyers must provide a reason for the rejection.Only cancellation requests in
PENDING_APPROVALstatus can be rejected. AConflictExceptionis thrown if the cancellation request is in any other status.- Parameters:
rejectAgreementCancellationRequestRequest-- Returns:
- A Java Future containing the result of the RejectAgreementCancellationRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
rejectAgreementCancellationRequest
default CompletableFuture<RejectAgreementCancellationRequestResponse> rejectAgreementCancellationRequest(Consumer<RejectAgreementCancellationRequestRequest.Builder> rejectAgreementCancellationRequestRequest) Allows buyers (acceptors) to reject a cancellation request that is in
PENDING_APPROVALstatus. Once rejected, the cancellation request transitions toREJECTEDstatus and the agreement remains active. Buyers must provide a reason for the rejection.Only cancellation requests in
PENDING_APPROVALstatus can be rejected. AConflictExceptionis thrown if the cancellation request is in any other status.
This is a convenience which creates an instance of the
RejectAgreementCancellationRequestRequest.Builderavoiding the need to create one manually viaRejectAgreementCancellationRequestRequest.builder()- Parameters:
rejectAgreementCancellationRequestRequest- AConsumerthat will call methods onRejectAgreementCancellationRequestRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the RejectAgreementCancellationRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
rejectAgreementPaymentRequest
default CompletableFuture<RejectAgreementPaymentRequestResponse> rejectAgreementPaymentRequest(RejectAgreementPaymentRequestRequest rejectAgreementPaymentRequestRequest) Allows buyers (acceptors) to reject a payment request that is in
PENDING_APPROVALstatus. Once rejected, the payment request transitions toREJECTEDstatus and cannot be accepted. Buyers can optionally provide a reason for the rejection.Only payment requests in
PENDING_APPROVALstatus can be rejected. AConflictExceptionis thrown if the payment request is in any other status.- Parameters:
rejectAgreementPaymentRequestRequest-- Returns:
- A Java Future containing the result of the RejectAgreementPaymentRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
rejectAgreementPaymentRequest
default CompletableFuture<RejectAgreementPaymentRequestResponse> rejectAgreementPaymentRequest(Consumer<RejectAgreementPaymentRequestRequest.Builder> rejectAgreementPaymentRequestRequest) Allows buyers (acceptors) to reject a payment request that is in
PENDING_APPROVALstatus. Once rejected, the payment request transitions toREJECTEDstatus and cannot be accepted. Buyers can optionally provide a reason for the rejection.Only payment requests in
PENDING_APPROVALstatus can be rejected. AConflictExceptionis thrown if the payment request is in any other status.
This is a convenience which creates an instance of the
RejectAgreementPaymentRequestRequest.Builderavoiding the need to create one manually viaRejectAgreementPaymentRequestRequest.builder()- Parameters:
rejectAgreementPaymentRequestRequest- AConsumerthat will call methods onRejectAgreementPaymentRequestRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the RejectAgreementPaymentRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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 when the
PartyTypeisProposer:-
AgreementType -
AgreementType+EndTime -
AgreementType+ResourceType -
AgreementType+ResourceType+EndTime -
AgreementType+ResourceType+Status -
AgreementType+ResourceType+Status+EndTime -
AgreementType+ResourceIdentifier -
AgreementType+ResourceIdentifier+EndTime -
AgreementType+ResourceIdentifier+Status -
AgreementType+ResourceIdentifier+Status+EndTime -
AgreementType+AcceptorAccountId -
AgreementType+AcceptorAccountId+EndTime -
AgreementType+AcceptorAccountId+Status -
AgreementType+AcceptorAccountId+Status+EndTime -
AgreementType+AcceptorAccountId+OfferId -
AgreementType+AcceptorAccountId+OfferId+Status -
AgreementType+AcceptorAccountId+OfferId+EndTime -
AgreementType+AcceptorAccountId+OfferId+Status+EndTime -
AgreementType+AcceptorAccountId+ResourceIdentifier -
AgreementType+AcceptorAccountId+ResourceIdentifier+Status -
AgreementType+AcceptorAccountId+ResourceIdentifier+EndTime -
AgreementType+AcceptorAccountId+ResourceIdentifier+Status+EndTime -
AgreementType+AcceptorAccountId+ResourceType -
AgreementType+AcceptorAccountId+ResourceType+EndTime -
AgreementType+AcceptorAccountId+ResourceType+Status -
AgreementType+AcceptorAccountId+ResourceType+Status+EndTime -
AgreementType+Status -
AgreementType+Status+EndTime -
AgreementType+OfferId -
AgreementType+OfferId+EndTime -
AgreementType+OfferId+Status -
AgreementType+OfferId+Status+EndTime -
AgreementType+OfferSetId -
AgreementType+OfferSetId+EndTime -
AgreementType+OfferSetId+Status -
AgreementType+OfferSetId+Status+EndTime
To filter by
EndTime, you can useBeforeEndTimeand/orAfterEndTime. OnlyEndTimeis supported for sorting.The following filter combinations are supported when the
PartyTypeisAcceptor:-
AgreementType -
AgreementType+Status -
AgreementType+EndTime -
AgreementType+Status+EndTime -
AgreementType+ResourceIdentifier -
AgreementType+ResourceIdentifier+EndTime -
AgreementType+ResourceIdentifier+Status -
AgreementType+ResourceIdentifier+Status+EndTime -
AgreementType+ResourceType -
AgreementType+ResourceType+EndTime -
AgreementType+OfferId -
AgreementType+OfferId+EndTime -
AgreementType+OfferId+Status -
AgreementType+OfferId+Status+EndTime -
AgreementType+OfferSetId -
AgreementType+OfferSetId+EndTime -
AgreementType+OfferSetId+Status -
AgreementType+OfferSetId+Status+EndTime
- 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 when the
PartyTypeisProposer:-
AgreementType -
AgreementType+EndTime -
AgreementType+ResourceType -
AgreementType+ResourceType+EndTime -
AgreementType+ResourceType+Status -
AgreementType+ResourceType+Status+EndTime -
AgreementType+ResourceIdentifier -
AgreementType+ResourceIdentifier+EndTime -
AgreementType+ResourceIdentifier+Status -
AgreementType+ResourceIdentifier+Status+EndTime -
AgreementType+AcceptorAccountId -
AgreementType+AcceptorAccountId+EndTime -
AgreementType+AcceptorAccountId+Status -
AgreementType+AcceptorAccountId+Status+EndTime -
AgreementType+AcceptorAccountId+OfferId -
AgreementType+AcceptorAccountId+OfferId+Status -
AgreementType+AcceptorAccountId+OfferId+EndTime -
AgreementType+AcceptorAccountId+OfferId+Status+EndTime -
AgreementType+AcceptorAccountId+ResourceIdentifier -
AgreementType+AcceptorAccountId+ResourceIdentifier+Status -
AgreementType+AcceptorAccountId+ResourceIdentifier+EndTime -
AgreementType+AcceptorAccountId+ResourceIdentifier+Status+EndTime -
AgreementType+AcceptorAccountId+ResourceType -
AgreementType+AcceptorAccountId+ResourceType+EndTime -
AgreementType+AcceptorAccountId+ResourceType+Status -
AgreementType+AcceptorAccountId+ResourceType+Status+EndTime -
AgreementType+Status -
AgreementType+Status+EndTime -
AgreementType+OfferId -
AgreementType+OfferId+EndTime -
AgreementType+OfferId+Status -
AgreementType+OfferId+Status+EndTime -
AgreementType+OfferSetId -
AgreementType+OfferSetId+EndTime -
AgreementType+OfferSetId+Status -
AgreementType+OfferSetId+Status+EndTime
To filter by
EndTime, you can useBeforeEndTimeand/orAfterEndTime. OnlyEndTimeis supported for sorting.The following filter combinations are supported when the
PartyTypeisAcceptor:-
AgreementType -
AgreementType+Status -
AgreementType+EndTime -
AgreementType+Status+EndTime -
AgreementType+ResourceIdentifier -
AgreementType+ResourceIdentifier+EndTime -
AgreementType+ResourceIdentifier+Status -
AgreementType+ResourceIdentifier+Status+EndTime -
AgreementType+ResourceType -
AgreementType+ResourceType+EndTime -
AgreementType+OfferId -
AgreementType+OfferId+EndTime -
AgreementType+OfferId+Status -
AgreementType+OfferId+Status+EndTime -
AgreementType+OfferSetId -
AgreementType+OfferSetId+EndTime -
AgreementType+OfferSetId+Status -
AgreementType+OfferSetId+Status+EndTime
This is a convenience which creates an instance of the
SearchAgreementsRequest.Builderavoiding the need to create one manually viaSearchAgreementsRequest.builder()- Parameters:
searchAgreementsRequest- AConsumerthat will call methods onSearchAgreementsRequest.Builderto 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.marketplaceagreement.paginators.SearchAgreementsPublisher publisher = client.searchAgreementsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.marketplaceagreement.paginators.SearchAgreementsPublisher publisher = client.searchAgreementsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaSearchAgreementsRequest.builder()- Parameters:
searchAgreementsRequest- AConsumerthat will call methods onSearchAgreementsRequest.Builderto 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:
-
sendAgreementCancellationRequest
default CompletableFuture<SendAgreementCancellationRequestResponse> sendAgreementCancellationRequest(SendAgreementCancellationRequestRequest sendAgreementCancellationRequestRequest) Allows sellers (proposers) to submit a cancellation request for an active agreement. The cancellation request is created in
PENDING_APPROVALstatus, at which point the buyer can review it.- Parameters:
sendAgreementCancellationRequestRequest-- Returns:
- A Java Future containing the result of the SendAgreementCancellationRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
sendAgreementCancellationRequest
default CompletableFuture<SendAgreementCancellationRequestResponse> sendAgreementCancellationRequest(Consumer<SendAgreementCancellationRequestRequest.Builder> sendAgreementCancellationRequestRequest) Allows sellers (proposers) to submit a cancellation request for an active agreement. The cancellation request is created in
PENDING_APPROVALstatus, at which point the buyer can review it.
This is a convenience which creates an instance of the
SendAgreementCancellationRequestRequest.Builderavoiding the need to create one manually viaSendAgreementCancellationRequestRequest.builder()- Parameters:
sendAgreementCancellationRequestRequest- AConsumerthat will call methods onSendAgreementCancellationRequestRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SendAgreementCancellationRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
sendAgreementPaymentRequest
default CompletableFuture<SendAgreementPaymentRequestResponse> sendAgreementPaymentRequest(SendAgreementPaymentRequestRequest sendAgreementPaymentRequestRequest) Allows sellers (proposers) to submit a payment request to buyers (acceptors) for a specific charge amount for an agreement that includes a
VariablePaymentTerm. The payment request is created inPENDING_APPROVALstatus, at which point the buyer can accept or reject it.The agreement must be active and have a
VariablePaymentTermto support payment requests. ThechargeAmountmust not exceed the remaining available balance under theVariablePaymentTermmaxTotalChargeAmount.- Parameters:
sendAgreementPaymentRequestRequest-- Returns:
- A Java Future containing the result of the SendAgreementPaymentRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
sendAgreementPaymentRequest
default CompletableFuture<SendAgreementPaymentRequestResponse> sendAgreementPaymentRequest(Consumer<SendAgreementPaymentRequestRequest.Builder> sendAgreementPaymentRequestRequest) Allows sellers (proposers) to submit a payment request to buyers (acceptors) for a specific charge amount for an agreement that includes a
VariablePaymentTerm. The payment request is created inPENDING_APPROVALstatus, at which point the buyer can accept or reject it.The agreement must be active and have a
VariablePaymentTermto support payment requests. ThechargeAmountmust not exceed the remaining available balance under theVariablePaymentTermmaxTotalChargeAmount.
This is a convenience which creates an instance of the
SendAgreementPaymentRequestRequest.Builderavoiding the need to create one manually viaSendAgreementPaymentRequestRequest.builder()- Parameters:
sendAgreementPaymentRequestRequest- AConsumerthat will call methods onSendAgreementPaymentRequestRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SendAgreementPaymentRequest 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
updatePurchaseOrders
default CompletableFuture<UpdatePurchaseOrdersResponse> updatePurchaseOrders(UpdatePurchaseOrdersRequest updatePurchaseOrdersRequest) Allows acceptors to associate purchase orders with agreement charges after an agreement is created.
- Parameters:
updatePurchaseOrdersRequest-- Returns:
- A Java Future containing the result of the UpdatePurchaseOrders 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:
-
updatePurchaseOrders
default CompletableFuture<UpdatePurchaseOrdersResponse> updatePurchaseOrders(Consumer<UpdatePurchaseOrdersRequest.Builder> updatePurchaseOrdersRequest) Allows acceptors to associate purchase orders with agreement charges after an agreement is created.
This is a convenience which creates an instance of the
UpdatePurchaseOrdersRequest.Builderavoiding the need to create one manually viaUpdatePurchaseOrdersRequest.builder()- Parameters:
updatePurchaseOrdersRequest- AConsumerthat will call methods onUpdatePurchaseOrdersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdatePurchaseOrders 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.
- ResourceNotFoundException Request references a resource which does not exist.
- ThrottlingException Request was denied due to request throttling.
- InternalServerException Unexpected error during processing of request.
- ConflictException Request was denied due to a resource conflict.
- 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:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aMarketplaceAgreementAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aMarketplaceAgreementAsyncClient.
-