Interface MarketplaceAgreementAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface MarketplaceAgreementAsyncClient extends AwsClient
Service client for accessing Agreement Service asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

AWS Marketplace is a curated digital catalog that customers can use to find, buy, deploy, and manage third-party software, data, and services to build solutions and run their businesses. The AWS Marketplace Agreement Service provides an API interface that helps AWS Marketplace sellers manage their product-related agreements, including listing, searching, and filtering agreements.

To manage agreements in AWS Marketplace, you must ensure that your AWS Identity and Access Management (IAM) policies and roles are set up. The user must have the required policies/permissions that allow them to carry out the actions in AWS:

  • DescribeAgreement – Grants permission to users to obtain detailed meta data about any of their agreements.

  • GetAgreementTerms – Grants permission to users to obtain details about the terms of an agreement.

  • SearchAgreements – Grants permission to users to search through all their agreements.

  • Field Details

  • Method Details

    • 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 validation.

      Each entry requires a unique clientToken for idempotency. A ValidationException is returned if the adjustment amount exceeds the maximum refundable amount for the invoice.

      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 invoke Throwable.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 The request could not be completed due to a conflict with the current state of the resource.
      • 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 validation.

      Each entry requires a unique clientToken for idempotency. A ValidationException is returned if the adjustment amount exceeds the maximum refundable amount for the invoice.


      This is a convenience which creates an instance of the BatchCreateBillingAdjustmentRequestRequest.Builder avoiding the need to create one manually via BatchCreateBillingAdjustmentRequestRequest.builder()

      Parameters:
      batchCreateBillingAdjustmentRequestRequest - A Consumer that will call methods on BatchCreateBillingAdjustmentRequestRequest.Builder to 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 invoke Throwable.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 The request could not be completed due to a conflict with the current state of the resource.
      • 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 CANCELLED status and can no longer be approved or rejected by the buyer.

      Only cancellation requests in PENDING_APPROVAL status can be cancelled. A ConflictException is 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 invoke Throwable.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 The request could not be completed due to a conflict with the current state of the resource.
      • 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 CANCELLED status and can no longer be approved or rejected by the buyer.

      Only cancellation requests in PENDING_APPROVAL status can be cancelled. A ConflictException is thrown if the cancellation request is in any other status.


      This is a convenience which creates an instance of the CancelAgreementCancellationRequestRequest.Builder avoiding the need to create one manually via CancelAgreementCancellationRequestRequest.builder()

      Parameters:
      cancelAgreementCancellationRequestRequest - A Consumer that will call methods on CancelAgreementCancellationRequestRequest.Builder to 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 invoke Throwable.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 The request could not be completed due to a conflict with the current state of the resource.
      • 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_APPROVAL status. Once cancelled, the payment request transitions to CANCELLED status and can no longer be accepted or rejected by the buyer.

      Only payment requests in PENDING_APPROVAL status can be cancelled. A ConflictException is 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 invoke Throwable.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 The request could not be completed due to a conflict with the current state of the resource.
      • 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_APPROVAL status. Once cancelled, the payment request transitions to CANCELLED status and can no longer be accepted or rejected by the buyer.

      Only payment requests in PENDING_APPROVAL status can be cancelled. A ConflictException is thrown if the payment request is in any other status.


      This is a convenience which creates an instance of the CancelAgreementPaymentRequestRequest.Builder avoiding the need to create one manually via CancelAgreementPaymentRequestRequest.builder()

      Parameters:
      cancelAgreementPaymentRequestRequest - A Consumer that will call methods on CancelAgreementPaymentRequestRequest.Builder to 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 invoke Throwable.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 The request could not be completed due to a conflict with the current state of the resource.
      • 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 invoke Throwable.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.Builder avoiding the need to create one manually via DescribeAgreementRequest.builder()

      Parameters:
      describeAgreementRequest - A Consumer that will call methods on DescribeAgreementRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAgreement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.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.

      The calling identity must be either the acceptor or proposer of the agreement. A ResourceNotFoundException is returned if the cancellation request does not exist.

      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 invoke Throwable.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.

      The calling identity must be either the acceptor or proposer of the agreement. A ResourceNotFoundException is returned if the cancellation request does not exist.


      This is a convenience which creates an instance of the GetAgreementCancellationRequestRequest.Builder avoiding the need to create one manually via GetAgreementCancellationRequestRequest.builder()

      Parameters:
      getAgreementCancellationRequestRequest - A Consumer that will call methods on GetAgreementCancellationRequestRequest.Builder to 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 invoke Throwable.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(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 ResourceNotFoundException is 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 invoke Throwable.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 ResourceNotFoundException is returned if the payment request does not exist.


      This is a convenience which creates an instance of the GetAgreementPaymentRequestRequest.Builder avoiding the need to create one manually via GetAgreementPaymentRequestRequest.builder()

      Parameters:
      getAgreementPaymentRequestRequest - A Consumer that will call methods on GetAgreementPaymentRequestRequest.Builder to 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 invoke Throwable.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 as LegalTerm, RenewalTerm, or ConfigurableUpfrontPricingTerm.

      • 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 for LegalTerm or pricing and dimensions for various pricing terms, such as ConfigurableUpfrontPricingTerm or UsageBasedPricingTerm.

      • Configuration – The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting the EnableAutoRenew flag.

      Parameters:
      getAgreementTermsRequest -
      Returns:
      A Java Future containing the result of the GetAgreementTerms operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.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 as LegalTerm, RenewalTerm, or ConfigurableUpfrontPricingTerm.

      • 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 for LegalTerm or pricing and dimensions for various pricing terms, such as ConfigurableUpfrontPricingTerm or UsageBasedPricingTerm.

      • Configuration – The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting the EnableAutoRenew flag.


      This is a convenience which creates an instance of the GetAgreementTermsRequest.Builder avoiding the need to create one manually via GetAgreementTermsRequest.builder()

      Parameters:
      getAgreementTermsRequest - A Consumer that will call methods on GetAgreementTermsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAgreementTerms operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.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 new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementTermsPublisher publisher = client.getAgreementTermsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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 new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementTermsPublisher publisher = client.getAgreementTermsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getAgreementTerms(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest) operation.


      This is a convenience which creates an instance of the GetAgreementTermsRequest.Builder avoiding the need to create one manually via GetAgreementTermsRequest.builder()

      Parameters:
      getAgreementTermsRequest - A Consumer that will call methods on GetAgreementTermsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.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.

      A ResourceNotFoundException is returned if the billing adjustment request does not exist or the caller does not have permission to access it.

      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 invoke Throwable.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.

      A ResourceNotFoundException is returned if the billing adjustment request does not exist or the caller does not have permission to access it.


      This is a convenience which creates an instance of the GetBillingAdjustmentRequestRequest.Builder avoiding the need to create one manually via GetBillingAdjustmentRequestRequest.builder()

      Parameters:
      getBillingAdjustmentRequestRequest - A Consumer that will call methods on GetBillingAdjustmentRequestRequest.Builder to 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 invoke Throwable.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.

      PartyType is a required parameter. A ValidationException is returned if PartyType is not provided. Pagination is supported through maxResults (1-50, default 20) and nextToken parameters.

      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 invoke Throwable.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.

      PartyType is a required parameter. A ValidationException is returned if PartyType is not provided. Pagination is supported through maxResults (1-50, default 20) and nextToken parameters.


      This is a convenience which creates an instance of the ListAgreementCancellationRequestsRequest.Builder avoiding the need to create one manually via ListAgreementCancellationRequestsRequest.builder()

      Parameters:
      listAgreementCancellationRequestsRequest - A Consumer that will call methods on ListAgreementCancellationRequestsRequest.Builder to 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 invoke Throwable.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 new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementCancellationRequestsPublisher publisher = client.listAgreementCancellationRequestsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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 new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementCancellationRequestsPublisher publisher = client.listAgreementCancellationRequestsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListAgreementCancellationRequestsRequest.builder()

      Parameters:
      listAgreementCancellationRequestsRequest - A Consumer that will call methods on ListAgreementCancellationRequestsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.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 groupBy parameter is required and currently supports only INVOICE_ID as a value. The agreementId parameter 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 invoke Throwable.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 groupBy parameter is required and currently supports only INVOICE_ID as a value. The agreementId parameter is required.


      This is a convenience which creates an instance of the ListAgreementInvoiceLineItemsRequest.Builder avoiding the need to create one manually via ListAgreementInvoiceLineItemsRequest.builder()

      Parameters:
      listAgreementInvoiceLineItemsRequest - A Consumer that will call methods on ListAgreementInvoiceLineItemsRequest.Builder to 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 invoke Throwable.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 new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementInvoiceLineItemsPublisher publisher = client.listAgreementInvoiceLineItemsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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 new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementInvoiceLineItemsPublisher publisher = client.listAgreementInvoiceLineItemsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListAgreementInvoiceLineItemsRequest.builder()

      Parameters:
      listAgreementInvoiceLineItemsRequest - A Consumer that will call methods on ListAgreementInvoiceLineItemsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.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.

      PartyType is a required parameter. A ValidationException is returned if PartyType is not provided. Pagination is supported through maxResults (1-50, default 50) and nextToken parameters.

      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 invoke Throwable.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.

      PartyType is a required parameter. A ValidationException is returned if PartyType is not provided. Pagination is supported through maxResults (1-50, default 50) and nextToken parameters.


      This is a convenience which creates an instance of the ListAgreementPaymentRequestsRequest.Builder avoiding the need to create one manually via ListAgreementPaymentRequestsRequest.builder()

      Parameters:
      listAgreementPaymentRequestsRequest - A Consumer that will call methods on ListAgreementPaymentRequestsRequest.Builder to 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 invoke Throwable.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 new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementPaymentRequestsPublisher publisher = client.listAgreementPaymentRequestsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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 new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementPaymentRequestsPublisher publisher = client.listAgreementPaymentRequestsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListAgreementPaymentRequestsRequest.builder()

      Parameters:
      listAgreementPaymentRequestsRequest - A Consumer that will call methods on ListAgreementPaymentRequestsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.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.

      Pagination is supported through maxResults and nextToken parameters.

      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 invoke Throwable.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.

      Pagination is supported through maxResults and nextToken parameters.


      This is a convenience which creates an instance of the ListBillingAdjustmentRequestsRequest.Builder avoiding the need to create one manually via ListBillingAdjustmentRequestsRequest.builder()

      Parameters:
      listBillingAdjustmentRequestsRequest - A Consumer that will call methods on ListBillingAdjustmentRequestsRequest.Builder to 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 invoke Throwable.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 new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListBillingAdjustmentRequestsPublisher publisher = client.listBillingAdjustmentRequestsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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 new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListBillingAdjustmentRequestsPublisher publisher = client.listBillingAdjustmentRequestsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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.Builder avoiding the need to create one manually via ListBillingAdjustmentRequestsRequest.builder()

      Parameters:
      listBillingAdjustmentRequestsRequest - A Consumer that will call methods on ListBillingAdjustmentRequestsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.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(SearchAgreementsRequest searchAgreementsRequest)

      Searches across all agreements that a proposer has in AWS Marketplace. The search returns a list of agreements with basic agreement information.

      The following filter combinations are supported when the PartyType is Proposer:

      • AgreementType

      • AgreementType + EndTime

      • AgreementType + ResourceType

      • AgreementType + ResourceType + EndTime

      • AgreementType + ResourceType + Status

      • AgreementType + ResourceType + Status + EndTime

      • AgreementType + ResourceId

      • AgreementType + ResourceId + EndTime

      • AgreementType + ResourceId + Status

      • AgreementType + ResourceId + 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 + ResourceId

      • AgreementType + AcceptorAccountId + ResourceId + Status

      • AgreementType + AcceptorAccountId + ResourceId + EndTime

      • AgreementType + AcceptorAccountId + ResourceId + 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 use either BeforeEndTime or AfterEndTime. Only EndTime is supported for sorting.

      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 invoke Throwable.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 has in AWS Marketplace. The search returns a list of agreements with basic agreement information.

      The following filter combinations are supported when the PartyType is Proposer:

      • AgreementType

      • AgreementType + EndTime

      • AgreementType + ResourceType

      • AgreementType + ResourceType + EndTime

      • AgreementType + ResourceType + Status

      • AgreementType + ResourceType + Status + EndTime

      • AgreementType + ResourceId

      • AgreementType + ResourceId + EndTime

      • AgreementType + ResourceId + Status

      • AgreementType + ResourceId + 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 + ResourceId

      • AgreementType + AcceptorAccountId + ResourceId + Status

      • AgreementType + AcceptorAccountId + ResourceId + EndTime

      • AgreementType + AcceptorAccountId + ResourceId + 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 use either BeforeEndTime or AfterEndTime. Only EndTime is supported for sorting.


      This is a convenience which creates an instance of the SearchAgreementsRequest.Builder avoiding the need to create one manually via SearchAgreementsRequest.builder()

      Parameters:
      searchAgreementsRequest - A Consumer that will call methods on SearchAgreementsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchAgreements operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.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 new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.marketplaceagreement.paginators.SearchAgreementsPublisher publisher = client.searchAgreementsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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 new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.marketplaceagreement.paginators.SearchAgreementsPublisher publisher = client.searchAgreementsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the searchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest) operation.


      This is a convenience which creates an instance of the SearchAgreementsRequest.Builder avoiding the need to create one manually via SearchAgreementsRequest.builder()

      Parameters:
      searchAgreementsRequest - A Consumer that will call methods on SearchAgreementsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.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_APPROVAL status, 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 invoke Throwable.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 The request could not be completed due to a conflict with the current state of the resource.
      • 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_APPROVAL status, at which point the buyer can review it.


      This is a convenience which creates an instance of the SendAgreementCancellationRequestRequest.Builder avoiding the need to create one manually via SendAgreementCancellationRequestRequest.builder()

      Parameters:
      sendAgreementCancellationRequestRequest - A Consumer that will call methods on SendAgreementCancellationRequestRequest.Builder to 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 invoke Throwable.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 The request could not be completed due to a conflict with the current state of the resource.
      • 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 in PENDING_APPROVAL status, at which point the buyer can accept or reject it.

      The agreement must be active and have a VariablePaymentTerm to support payment requests. The chargeAmount must not exceed the remaining available balance under the VariablePaymentTerm maxTotalChargeAmount.

      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 invoke Throwable.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 The request could not be completed due to a conflict with the current state of the resource.
      • 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 in PENDING_APPROVAL status, at which point the buyer can accept or reject it.

      The agreement must be active and have a VariablePaymentTerm to support payment requests. The chargeAmount must not exceed the remaining available balance under the VariablePaymentTerm maxTotalChargeAmount.


      This is a convenience which creates an instance of the SendAgreementPaymentRequestRequest.Builder avoiding the need to create one manually via SendAgreementPaymentRequestRequest.builder()

      Parameters:
      sendAgreementPaymentRequestRequest - A Consumer that will call methods on SendAgreementPaymentRequestRequest.Builder to 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 invoke Throwable.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 The request could not be completed due to a conflict with the current state of the resource.
      • 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

      default MarketplaceAgreementServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static MarketplaceAgreementAsyncClient create()
      Create a MarketplaceAgreementAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static MarketplaceAgreementAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a MarketplaceAgreementAsyncClient.