Interface MarketplaceAgreementClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface MarketplaceAgreementClient
extends AwsClient

Service client for accessing Agreement Service. This can be created using the static builder() method.

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

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

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AcceptAgreementCancellationRequestResponse	acceptAgreementCancellationRequest(Consumer<AcceptAgreementCancellationRequestRequest.Builder> acceptAgreementCancellationRequestRequest)	Allows buyers (acceptors) to accept a cancellation request that is in PENDING_APPROVAL status.
default AcceptAgreementCancellationRequestResponse	acceptAgreementCancellationRequest(AcceptAgreementCancellationRequestRequest acceptAgreementCancellationRequestRequest)	Allows buyers (acceptors) to accept a cancellation request that is in PENDING_APPROVAL status.
default AcceptAgreementPaymentRequestResponse	acceptAgreementPaymentRequest(Consumer<AcceptAgreementPaymentRequestRequest.Builder> acceptAgreementPaymentRequestRequest)	Allows buyers (acceptors) to accept a payment request that is in PENDING_APPROVAL status.
default AcceptAgreementPaymentRequestResponse	acceptAgreementPaymentRequest(AcceptAgreementPaymentRequestRequest acceptAgreementPaymentRequestRequest)	Allows buyers (acceptors) to accept a payment request that is in PENDING_APPROVAL status.
default AcceptAgreementRequestResponse	acceptAgreementRequest(Consumer<AcceptAgreementRequestRequest.Builder> acceptAgreementRequestRequest)	Accepts an agreement request to finalize the agreement.
default AcceptAgreementRequestResponse	acceptAgreementRequest(AcceptAgreementRequestRequest acceptAgreementRequestRequest)	Accepts an agreement request to finalize the agreement.
default BatchCreateBillingAdjustmentRequestResponse	batchCreateBillingAdjustmentRequest(Consumer<BatchCreateBillingAdjustmentRequestRequest.Builder> batchCreateBillingAdjustmentRequestRequest)	Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement.
default BatchCreateBillingAdjustmentRequestResponse	batchCreateBillingAdjustmentRequest(BatchCreateBillingAdjustmentRequestRequest batchCreateBillingAdjustmentRequestRequest)	Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement.
static MarketplaceAgreementClientBuilder	builder()	Create a builder that can be used to configure and create a MarketplaceAgreementClient.
default CancelAgreementResponse	cancelAgreement(Consumer<CancelAgreementRequest.Builder> cancelAgreementRequest)	Allows an acceptor to cancel an active agreement.
default CancelAgreementResponse	cancelAgreement(CancelAgreementRequest cancelAgreementRequest)	Allows an acceptor to cancel an active agreement.
default CancelAgreementCancellationRequestResponse	cancelAgreementCancellationRequest(Consumer<CancelAgreementCancellationRequestRequest.Builder> cancelAgreementCancellationRequestRequest)	Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state.
default CancelAgreementCancellationRequestResponse	cancelAgreementCancellationRequest(CancelAgreementCancellationRequestRequest cancelAgreementCancellationRequestRequest)	Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state.
default CancelAgreementPaymentRequestResponse	cancelAgreementPaymentRequest(Consumer<CancelAgreementPaymentRequestRequest.Builder> cancelAgreementPaymentRequestRequest)	Allows sellers (proposers) to cancel a payment request that is in PENDING_APPROVAL status.
default CancelAgreementPaymentRequestResponse	cancelAgreementPaymentRequest(CancelAgreementPaymentRequestRequest cancelAgreementPaymentRequestRequest)	Allows sellers (proposers) to cancel a payment request that is in PENDING_APPROVAL status.
static MarketplaceAgreementClient	create()	Create a MarketplaceAgreementClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateAgreementRequestResponse	createAgreementRequest(Consumer<CreateAgreementRequestRequest.Builder> createAgreementRequestRequest)	Creates an agreement request that acts as a quote for the terms you want to accept.
default CreateAgreementRequestResponse	createAgreementRequest(CreateAgreementRequestRequest createAgreementRequestRequest)	Creates an agreement request that acts as a quote for the terms you want to accept.
default DescribeAgreementResponse	describeAgreement(Consumer<DescribeAgreementRequest.Builder> describeAgreementRequest)	Provides details about an agreement, such as the proposer, acceptor, start date, and end date.
default DescribeAgreementResponse	describeAgreement(DescribeAgreementRequest describeAgreementRequest)	Provides details about an agreement, such as the proposer, acceptor, start date, and end date.
default GetAgreementCancellationRequestResponse	getAgreementCancellationRequest(Consumer<GetAgreementCancellationRequestRequest.Builder> getAgreementCancellationRequestRequest)	Retrieves detailed information about a specific agreement cancellation request.
default GetAgreementCancellationRequestResponse	getAgreementCancellationRequest(GetAgreementCancellationRequestRequest getAgreementCancellationRequestRequest)	Retrieves detailed information about a specific agreement cancellation request.
default GetAgreementEntitlementsResponse	getAgreementEntitlements(Consumer<GetAgreementEntitlementsRequest.Builder> getAgreementEntitlementsRequest)	Obtains details about the entitlements of an agreement.
default GetAgreementEntitlementsResponse	getAgreementEntitlements(GetAgreementEntitlementsRequest getAgreementEntitlementsRequest)	Obtains details about the entitlements of an agreement.
default GetAgreementEntitlementsIterable	getAgreementEntitlementsPaginator(Consumer<GetAgreementEntitlementsRequest.Builder> getAgreementEntitlementsRequest)	This is a variant of getAgreementEntitlements(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementEntitlementsRequest) operation.
default GetAgreementEntitlementsIterable	getAgreementEntitlementsPaginator(GetAgreementEntitlementsRequest getAgreementEntitlementsRequest)	This is a variant of getAgreementEntitlements(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementEntitlementsRequest) operation.
default GetAgreementPaymentRequestResponse	getAgreementPaymentRequest(Consumer<GetAgreementPaymentRequestRequest.Builder> getAgreementPaymentRequestRequest)	Retrieves detailed information about a specific payment request.
default GetAgreementPaymentRequestResponse	getAgreementPaymentRequest(GetAgreementPaymentRequestRequest getAgreementPaymentRequestRequest)	Retrieves detailed information about a specific payment request.
default GetAgreementTermsResponse	getAgreementTerms(Consumer<GetAgreementTermsRequest.Builder> getAgreementTermsRequest)	Obtains details about the terms in an agreement that you participated in as proposer or acceptor.
default GetAgreementTermsResponse	getAgreementTerms(GetAgreementTermsRequest getAgreementTermsRequest)	Obtains details about the terms in an agreement that you participated in as proposer or acceptor.
default GetAgreementTermsIterable	getAgreementTermsPaginator(Consumer<GetAgreementTermsRequest.Builder> getAgreementTermsRequest)	This is a variant of getAgreementTerms(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest) operation.
default GetAgreementTermsIterable	getAgreementTermsPaginator(GetAgreementTermsRequest getAgreementTermsRequest)	This is a variant of getAgreementTerms(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest) operation.
default GetBillingAdjustmentRequestResponse	getBillingAdjustmentRequest(Consumer<GetBillingAdjustmentRequestRequest.Builder> getBillingAdjustmentRequestRequest)	Retrieves detailed information about a specific billing adjustment request.
default GetBillingAdjustmentRequestResponse	getBillingAdjustmentRequest(GetBillingAdjustmentRequestRequest getBillingAdjustmentRequestRequest)	Retrieves detailed information about a specific billing adjustment request.
default ListAgreementCancellationRequestsResponse	listAgreementCancellationRequests(Consumer<ListAgreementCancellationRequestsRequest.Builder> listAgreementCancellationRequestsRequest)	Lists agreement cancellation requests available to you as a seller or buyer.
default ListAgreementCancellationRequestsResponse	listAgreementCancellationRequests(ListAgreementCancellationRequestsRequest listAgreementCancellationRequestsRequest)	Lists agreement cancellation requests available to you as a seller or buyer.
default ListAgreementCancellationRequestsIterable	listAgreementCancellationRequestsPaginator(Consumer<ListAgreementCancellationRequestsRequest.Builder> listAgreementCancellationRequestsRequest)	This is a variant of listAgreementCancellationRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementCancellationRequestsRequest) operation.
default ListAgreementCancellationRequestsIterable	listAgreementCancellationRequestsPaginator(ListAgreementCancellationRequestsRequest listAgreementCancellationRequestsRequest)	This is a variant of listAgreementCancellationRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementCancellationRequestsRequest) operation.
default ListAgreementChargesResponse	listAgreementCharges(Consumer<ListAgreementChargesRequest.Builder> listAgreementChargesRequest)	Allows acceptors to view charges and purchase orders that are associated with an agreement.
default ListAgreementChargesResponse	listAgreementCharges(ListAgreementChargesRequest listAgreementChargesRequest)	Allows acceptors to view charges and purchase orders that are associated with an agreement.
default ListAgreementChargesIterable	listAgreementChargesPaginator(Consumer<ListAgreementChargesRequest.Builder> listAgreementChargesRequest)	This is a variant of listAgreementCharges(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementChargesRequest) operation.
default ListAgreementChargesIterable	listAgreementChargesPaginator(ListAgreementChargesRequest listAgreementChargesRequest)	This is a variant of listAgreementCharges(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementChargesRequest) operation.
default ListAgreementInvoiceLineItemsResponse	listAgreementInvoiceLineItems(Consumer<ListAgreementInvoiceLineItemsRequest.Builder> listAgreementInvoiceLineItemsRequest)	Allows sellers (proposers) to retrieve aggregated billing data from AWS Marketplace agreements using flexible grouping.
default ListAgreementInvoiceLineItemsResponse	listAgreementInvoiceLineItems(ListAgreementInvoiceLineItemsRequest listAgreementInvoiceLineItemsRequest)	Allows sellers (proposers) to retrieve aggregated billing data from AWS Marketplace agreements using flexible grouping.
default ListAgreementInvoiceLineItemsIterable	listAgreementInvoiceLineItemsPaginator(Consumer<ListAgreementInvoiceLineItemsRequest.Builder> listAgreementInvoiceLineItemsRequest)	This is a variant of listAgreementInvoiceLineItems(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsRequest) operation.
default ListAgreementInvoiceLineItemsIterable	listAgreementInvoiceLineItemsPaginator(ListAgreementInvoiceLineItemsRequest listAgreementInvoiceLineItemsRequest)	This is a variant of listAgreementInvoiceLineItems(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsRequest) operation.
default ListAgreementPaymentRequestsResponse	listAgreementPaymentRequests(Consumer<ListAgreementPaymentRequestsRequest.Builder> listAgreementPaymentRequestsRequest)	Lists payment requests available to you as a seller or buyer.
default ListAgreementPaymentRequestsResponse	listAgreementPaymentRequests(ListAgreementPaymentRequestsRequest listAgreementPaymentRequestsRequest)	Lists payment requests available to you as a seller or buyer.
default ListAgreementPaymentRequestsIterable	listAgreementPaymentRequestsPaginator(Consumer<ListAgreementPaymentRequestsRequest.Builder> listAgreementPaymentRequestsRequest)	This is a variant of listAgreementPaymentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsRequest) operation.
default ListAgreementPaymentRequestsIterable	listAgreementPaymentRequestsPaginator(ListAgreementPaymentRequestsRequest listAgreementPaymentRequestsRequest)	This is a variant of listAgreementPaymentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsRequest) operation.
default ListBillingAdjustmentRequestsResponse	listBillingAdjustmentRequests(Consumer<ListBillingAdjustmentRequestsRequest.Builder> listBillingAdjustmentRequestsRequest)	Lists billing adjustment requests for a specific agreement.
default ListBillingAdjustmentRequestsResponse	listBillingAdjustmentRequests(ListBillingAdjustmentRequestsRequest listBillingAdjustmentRequestsRequest)	Lists billing adjustment requests for a specific agreement.
default ListBillingAdjustmentRequestsIterable	listBillingAdjustmentRequestsPaginator(Consumer<ListBillingAdjustmentRequestsRequest.Builder> listBillingAdjustmentRequestsRequest)	This is a variant of listBillingAdjustmentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsRequest) operation.
default ListBillingAdjustmentRequestsIterable	listBillingAdjustmentRequestsPaginator(ListBillingAdjustmentRequestsRequest listBillingAdjustmentRequestsRequest)	This is a variant of listBillingAdjustmentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsRequest) operation.
default RejectAgreementCancellationRequestResponse	rejectAgreementCancellationRequest(Consumer<RejectAgreementCancellationRequestRequest.Builder> rejectAgreementCancellationRequestRequest)	Allows buyers (acceptors) to reject a cancellation request that is in PENDING_APPROVAL status.
default RejectAgreementCancellationRequestResponse	rejectAgreementCancellationRequest(RejectAgreementCancellationRequestRequest rejectAgreementCancellationRequestRequest)	Allows buyers (acceptors) to reject a cancellation request that is in PENDING_APPROVAL status.
default RejectAgreementPaymentRequestResponse	rejectAgreementPaymentRequest(Consumer<RejectAgreementPaymentRequestRequest.Builder> rejectAgreementPaymentRequestRequest)	Allows buyers (acceptors) to reject a payment request that is in PENDING_APPROVAL status.
default RejectAgreementPaymentRequestResponse	rejectAgreementPaymentRequest(RejectAgreementPaymentRequestRequest rejectAgreementPaymentRequestRequest)	Allows buyers (acceptors) to reject a payment request that is in PENDING_APPROVAL status.
default SearchAgreementsResponse	searchAgreements(Consumer<SearchAgreementsRequest.Builder> searchAgreementsRequest)	Searches across all agreements that a proposer or an acceptor has in AWS Marketplace.
default SearchAgreementsResponse	searchAgreements(SearchAgreementsRequest searchAgreementsRequest)	Searches across all agreements that a proposer or an acceptor has in AWS Marketplace.
default SearchAgreementsIterable	searchAgreementsPaginator(Consumer<SearchAgreementsRequest.Builder> searchAgreementsRequest)	This is a variant of searchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest) operation.
default SearchAgreementsIterable	searchAgreementsPaginator(SearchAgreementsRequest searchAgreementsRequest)	This is a variant of searchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest) operation.
default SendAgreementCancellationRequestResponse	sendAgreementCancellationRequest(Consumer<SendAgreementCancellationRequestRequest.Builder> sendAgreementCancellationRequestRequest)	Allows sellers (proposers) to submit a cancellation request for an active agreement.
default SendAgreementCancellationRequestResponse	sendAgreementCancellationRequest(SendAgreementCancellationRequestRequest sendAgreementCancellationRequestRequest)	Allows sellers (proposers) to submit a cancellation request for an active agreement.
default 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.
default 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.
default MarketplaceAgreementServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default UpdatePurchaseOrdersResponse	updatePurchaseOrders(Consumer<UpdatePurchaseOrdersRequest.Builder> updatePurchaseOrdersRequest)	Allows acceptors to associate purchase orders with agreement charges after an agreement is created.
default UpdatePurchaseOrdersResponse	updatePurchaseOrders(UpdatePurchaseOrdersRequest updatePurchaseOrdersRequest)	Allows acceptors to associate purchase orders with agreement charges after an agreement is created.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

acceptAgreementCancellationRequest

default AcceptAgreementCancellationRequestResponse acceptAgreementCancellationRequest(AcceptAgreementCancellationRequestRequest acceptAgreementCancellationRequestRequest)
                                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Allows buyers (acceptors) to accept a cancellation request that is in PENDING_APPROVAL status. Once accepted, the cancellation request transitions to APPROVED status and the agreement cancellation will be processed.

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

Parameters:

acceptAgreementCancellationRequestRequest -

Returns:

Result of the AcceptAgreementCancellationRequest operation returned by the service.

See Also:

• AWS API Documentation

acceptAgreementCancellationRequest

default AcceptAgreementCancellationRequestResponse acceptAgreementCancellationRequest(Consumer<AcceptAgreementCancellationRequestRequest.Builder> acceptAgreementCancellationRequestRequest)
                                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Allows buyers (acceptors) to accept a cancellation request that is in PENDING_APPROVAL status. Once accepted, the cancellation request transitions to APPROVED status and the agreement cancellation will be processed.

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

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

Parameters:

acceptAgreementCancellationRequestRequest - A Consumer that will call methods on AcceptAgreementCancellationRequestRequest.Builder to create a request.

Returns:

Result of the AcceptAgreementCancellationRequest operation returned by the service.

See Also:

• AWS API Documentation

acceptAgreementPaymentRequest

default AcceptAgreementPaymentRequestResponse acceptAgreementPaymentRequest(AcceptAgreementPaymentRequestRequest acceptAgreementPaymentRequestRequest)
                                                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Allows buyers (acceptors) to accept a payment request that is in PENDING_APPROVAL status. Once accepted, the payment request transitions to APPROVED status and the charge will be processed. Buyers can optionally provide a purchase order reference for their internal tracking.

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

Parameters:

acceptAgreementPaymentRequestRequest -

Returns:

Result of the AcceptAgreementPaymentRequest operation returned by the service.

See Also:

• AWS API Documentation

acceptAgreementPaymentRequest

default AcceptAgreementPaymentRequestResponse acceptAgreementPaymentRequest(Consumer<AcceptAgreementPaymentRequestRequest.Builder> acceptAgreementPaymentRequestRequest)
                                                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Allows buyers (acceptors) to accept a payment request that is in PENDING_APPROVAL status. Once accepted, the payment request transitions to APPROVED status and the charge will be processed. Buyers can optionally provide a purchase order reference for their internal tracking.

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

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

Parameters:

acceptAgreementPaymentRequestRequest - A Consumer that will call methods on AcceptAgreementPaymentRequestRequest.Builder to create a request.

Returns:

Result of the AcceptAgreementPaymentRequest operation returned by the service.

See Also:

• AWS API Documentation

acceptAgreementRequest

default AcceptAgreementRequestResponse acceptAgreementRequest(AcceptAgreementRequestRequest acceptAgreementRequestRequest)
                                                       throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Accepts an agreement request to finalize the agreement. The acceptor can optionally provide purchase orders to associate with the agreement charges.

Parameters:

acceptAgreementRequestRequest -

Returns:

Result of the AcceptAgreementRequest operation returned by the service.

See Also:

• AWS API Documentation

acceptAgreementRequest

default AcceptAgreementRequestResponse acceptAgreementRequest(Consumer<AcceptAgreementRequestRequest.Builder> acceptAgreementRequestRequest)
                                                       throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Accepts an agreement request to finalize the agreement. The acceptor can optionally provide purchase orders to associate with the agreement charges.

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

Parameters:

acceptAgreementRequestRequest - A Consumer that will call methods on AcceptAgreementRequestRequest.Builder to create a request.

Returns:

Result of the AcceptAgreementRequest operation returned by the service.

See Also:

• AWS API Documentation

batchCreateBillingAdjustmentRequest

default BatchCreateBillingAdjustmentRequestResponse batchCreateBillingAdjustmentRequest(BatchCreateBillingAdjustmentRequestRequest batchCreateBillingAdjustmentRequestRequest)
                                                                                 throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement. Each entry in the batch specifies an invoice and the adjustment amount. The operation returns successfully created adjustment request IDs and any errors for entries that failed to process.

Each entry requires a unique clientToken for idempotency.

Parameters:

batchCreateBillingAdjustmentRequestRequest -

Returns:

Result of the BatchCreateBillingAdjustmentRequest operation returned by the service.

See Also:

• AWS API Documentation

batchCreateBillingAdjustmentRequest

default BatchCreateBillingAdjustmentRequestResponse batchCreateBillingAdjustmentRequest(Consumer<BatchCreateBillingAdjustmentRequestRequest.Builder> batchCreateBillingAdjustmentRequestRequest)
                                                                                 throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement. Each entry in the batch specifies an invoice and the adjustment amount. The operation returns successfully created adjustment request IDs and any errors for entries that failed to process.

Each entry requires a unique clientToken for idempotency.

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:

Result of the BatchCreateBillingAdjustmentRequest operation returned by the service.

See Also:

• AWS API Documentation

cancelAgreement

default CancelAgreementResponse cancelAgreement(CancelAgreementRequest cancelAgreementRequest)
                                         throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Allows an acceptor to cancel an active agreement. Not all agreements are eligible for cancellation. Use the error response to determine why a cancellation request was rejected.

Parameters:

cancelAgreementRequest -

Returns:

Result of the CancelAgreement operation returned by the service.

See Also:

• AWS API Documentation

cancelAgreement

default CancelAgreementResponse cancelAgreement(Consumer<CancelAgreementRequest.Builder> cancelAgreementRequest)
                                         throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Allows an acceptor to cancel an active agreement. Not all agreements are eligible for cancellation. Use the error response to determine why a cancellation request was rejected.

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

Parameters:

cancelAgreementRequest - A Consumer that will call methods on CancelAgreementRequest.Builder to create a request.

Returns:

Result of the CancelAgreement operation returned by the service.

See Also:

• AWS API Documentation

cancelAgreementCancellationRequest

default CancelAgreementCancellationRequestResponse cancelAgreementCancellationRequest(CancelAgreementCancellationRequestRequest cancelAgreementCancellationRequestRequest)
                                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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:

Result of the CancelAgreementCancellationRequest operation returned by the service.

See Also:

• AWS API Documentation

cancelAgreementCancellationRequest

default CancelAgreementCancellationRequestResponse cancelAgreementCancellationRequest(Consumer<CancelAgreementCancellationRequestRequest.Builder> cancelAgreementCancellationRequestRequest)
                                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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:

Result of the CancelAgreementCancellationRequest operation returned by the service.

See Also:

• AWS API Documentation

cancelAgreementPaymentRequest

default CancelAgreementPaymentRequestResponse cancelAgreementPaymentRequest(CancelAgreementPaymentRequestRequest cancelAgreementPaymentRequestRequest)
                                                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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:

Result of the CancelAgreementPaymentRequest operation returned by the service.

See Also:

• AWS API Documentation

cancelAgreementPaymentRequest

default CancelAgreementPaymentRequestResponse cancelAgreementPaymentRequest(Consumer<CancelAgreementPaymentRequestRequest.Builder> cancelAgreementPaymentRequestRequest)
                                                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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:

Result of the CancelAgreementPaymentRequest operation returned by the service.

See Also:

• AWS API Documentation

createAgreementRequest

default CreateAgreementRequestResponse createAgreementRequest(CreateAgreementRequestRequest createAgreementRequestRequest)
                                                       throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Creates an agreement request that acts as a quote for the terms you want to accept. The agreement request captures the requested terms, calculates charges, and returns a summary. Use AcceptAgreementRequest with the returned agreementRequestId to finalize the agreement.

Parameters:

createAgreementRequestRequest -

Returns:

Result of the CreateAgreementRequest operation returned by the service.

See Also:

• AWS API Documentation

createAgreementRequest

default CreateAgreementRequestResponse createAgreementRequest(Consumer<CreateAgreementRequestRequest.Builder> createAgreementRequestRequest)
                                                       throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Creates an agreement request that acts as a quote for the terms you want to accept. The agreement request captures the requested terms, calculates charges, and returns a summary. Use AcceptAgreementRequest with the returned agreementRequestId to finalize the agreement.

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

Parameters:

createAgreementRequestRequest - A Consumer that will call methods on CreateAgreementRequestRequest.Builder to create a request.

Returns:

Result of the CreateAgreementRequest operation returned by the service.

See Also:

• AWS API Documentation

describeAgreement

default DescribeAgreementResponse describeAgreement(DescribeAgreementRequest describeAgreementRequest)
                                             throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Provides details about an agreement, such as the proposer, acceptor, start date, and end date.

Parameters:

describeAgreementRequest -

Returns:

Result of the DescribeAgreement operation returned by the service.

See Also:

• AWS API Documentation
• Code Example

describeAgreement

default DescribeAgreementResponse describeAgreement(Consumer<DescribeAgreementRequest.Builder> describeAgreementRequest)
                                             throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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:

Result of the DescribeAgreement operation returned by the service.

See Also:

• AWS API Documentation
• Code Example

getAgreementCancellationRequest

default GetAgreementCancellationRequestResponse getAgreementCancellationRequest(GetAgreementCancellationRequestRequest getAgreementCancellationRequestRequest)
                                                                         throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Retrieves detailed information about a specific agreement cancellation request. Both sellers (proposers) and buyers (acceptors) can use this operation to view cancellation requests associated with their agreements.

Parameters:

getAgreementCancellationRequestRequest -

Returns:

Result of the GetAgreementCancellationRequest operation returned by the service.

See Also:

• AWS API Documentation

getAgreementCancellationRequest

default GetAgreementCancellationRequestResponse getAgreementCancellationRequest(Consumer<GetAgreementCancellationRequestRequest.Builder> getAgreementCancellationRequestRequest)
                                                                         throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Retrieves detailed information about a specific agreement cancellation request. Both sellers (proposers) and buyers (acceptors) can use this operation to view cancellation requests associated with their agreements.

This is a convenience which creates an instance of the GetAgreementCancellationRequestRequest.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:

Result of the GetAgreementCancellationRequest operation returned by the service.

See Also:

• AWS API Documentation

getAgreementEntitlements

default GetAgreementEntitlementsResponse getAgreementEntitlements(GetAgreementEntitlementsRequest getAgreementEntitlementsRequest)
                                                           throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Obtains details about the entitlements of an agreement.

Parameters:

getAgreementEntitlementsRequest -

Returns:

Result of the GetAgreementEntitlements operation returned by the service.

See Also:

• AWS API Documentation

getAgreementEntitlements

default GetAgreementEntitlementsResponse getAgreementEntitlements(Consumer<GetAgreementEntitlementsRequest.Builder> getAgreementEntitlementsRequest)
                                                           throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Obtains details about the entitlements of an agreement.

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

Parameters:

getAgreementEntitlementsRequest - A Consumer that will call methods on GetAgreementEntitlementsRequest.Builder to create a request.

Returns:

Result of the GetAgreementEntitlements operation returned by the service.

See Also:

• AWS API Documentation

getAgreementEntitlementsPaginator

default GetAgreementEntitlementsIterable getAgreementEntitlementsPaginator(GetAgreementEntitlementsRequest getAgreementEntitlementsRequest)
                                                                    throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

This is a variant of getAgreementEntitlements(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementEntitlementsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementEntitlementsIterable responses = client.getAgreementEntitlementsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementEntitlementsIterable responses = client
             .getAgreementEntitlementsPaginator(request);
     for (software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementEntitlementsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementEntitlementsIterable responses = client.getAgreementEntitlementsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

getAgreementEntitlementsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getAgreementEntitlementsPaginator

default GetAgreementEntitlementsIterable getAgreementEntitlementsPaginator(Consumer<GetAgreementEntitlementsRequest.Builder> getAgreementEntitlementsRequest)
                                                                    throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

This is a variant of getAgreementEntitlements(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementEntitlementsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementEntitlementsIterable responses = client.getAgreementEntitlementsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementEntitlementsIterable responses = client
             .getAgreementEntitlementsPaginator(request);
     for (software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementEntitlementsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementEntitlementsIterable responses = client.getAgreementEntitlementsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

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

Parameters:

getAgreementEntitlementsRequest - A Consumer that will call methods on GetAgreementEntitlementsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getAgreementPaymentRequest

default GetAgreementPaymentRequestResponse getAgreementPaymentRequest(GetAgreementPaymentRequestRequest getAgreementPaymentRequestRequest)
                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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:

Result of the GetAgreementPaymentRequest operation returned by the service.

See Also:

• AWS API Documentation

getAgreementPaymentRequest

default GetAgreementPaymentRequestResponse getAgreementPaymentRequest(Consumer<GetAgreementPaymentRequestRequest.Builder> getAgreementPaymentRequestRequest)
                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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:

Result of the GetAgreementPaymentRequest operation returned by the service.

See Also:

• AWS API Documentation

getAgreementTerms

default GetAgreementTermsResponse getAgreementTerms(GetAgreementTermsRequest getAgreementTermsRequest)
                                             throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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:

Result of the GetAgreementTerms operation returned by the service.

See Also:

• AWS API Documentation
• Code Example

getAgreementTerms

default GetAgreementTermsResponse getAgreementTerms(Consumer<GetAgreementTermsRequest.Builder> getAgreementTermsRequest)
                                             throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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:

Result of the GetAgreementTerms operation returned by the service.

See Also:

• AWS API Documentation
• Code Example

getAgreementTermsPaginator

default GetAgreementTermsIterable getAgreementTermsPaginator(GetAgreementTermsRequest getAgreementTermsRequest)
                                                      throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

This is a variant of getAgreementTerms(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementTermsIterable responses = client.getAgreementTermsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementTermsIterable responses = client
             .getAgreementTermsPaginator(request);
     for (software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementTermsIterable responses = client.getAgreementTermsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

getAgreementTermsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation
• Code Example

getAgreementTermsPaginator

default GetAgreementTermsIterable getAgreementTermsPaginator(Consumer<GetAgreementTermsRequest.Builder> getAgreementTermsRequest)
                                                      throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

This is a variant of getAgreementTerms(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementTermsIterable responses = client.getAgreementTermsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementTermsIterable responses = client
             .getAgreementTermsPaginator(request);
     for (software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementTermsIterable responses = client.getAgreementTermsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the 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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation
• Code Example

getBillingAdjustmentRequest

default GetBillingAdjustmentRequestResponse getBillingAdjustmentRequest(GetBillingAdjustmentRequestRequest getBillingAdjustmentRequestRequest)
                                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Retrieves detailed information about a specific billing adjustment request. Sellers (proposers) can use this operation to view the status and details of a billing adjustment request they submitted.

Parameters:

getBillingAdjustmentRequestRequest -

Returns:

Result of the GetBillingAdjustmentRequest operation returned by the service.

See Also:

• AWS API Documentation

getBillingAdjustmentRequest

default GetBillingAdjustmentRequestResponse getBillingAdjustmentRequest(Consumer<GetBillingAdjustmentRequestRequest.Builder> getBillingAdjustmentRequestRequest)
                                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Retrieves detailed information about a specific billing adjustment request. Sellers (proposers) can use this operation to view the status and details of a billing adjustment request they submitted.

This is a convenience which creates an instance of the GetBillingAdjustmentRequestRequest.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:

Result of the GetBillingAdjustmentRequest operation returned by the service.

See Also:

• AWS API Documentation

listAgreementCancellationRequests

default ListAgreementCancellationRequestsResponse listAgreementCancellationRequests(ListAgreementCancellationRequestsRequest listAgreementCancellationRequestsRequest)
                                                                             throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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.

Parameters:

listAgreementCancellationRequestsRequest -

Returns:

Result of the ListAgreementCancellationRequests operation returned by the service.

See Also:

• AWS API Documentation

listAgreementCancellationRequests

default ListAgreementCancellationRequestsResponse listAgreementCancellationRequests(Consumer<ListAgreementCancellationRequestsRequest.Builder> listAgreementCancellationRequestsRequest)
                                                                             throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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.

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:

Result of the ListAgreementCancellationRequests operation returned by the service.

See Also:

• AWS API Documentation

listAgreementCancellationRequestsPaginator

default ListAgreementCancellationRequestsIterable listAgreementCancellationRequestsPaginator(ListAgreementCancellationRequestsRequest listAgreementCancellationRequestsRequest)
                                                                                      throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

This is a variant of listAgreementCancellationRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementCancellationRequestsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementCancellationRequestsIterable responses = client.listAgreementCancellationRequestsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementCancellationRequestsIterable responses = client
             .listAgreementCancellationRequestsPaginator(request);
     for (software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementCancellationRequestsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementCancellationRequestsIterable responses = client.listAgreementCancellationRequestsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listAgreementCancellationRequestsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAgreementCancellationRequestsPaginator

default ListAgreementCancellationRequestsIterable listAgreementCancellationRequestsPaginator(Consumer<ListAgreementCancellationRequestsRequest.Builder> listAgreementCancellationRequestsRequest)
                                                                                      throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

This is a variant of listAgreementCancellationRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementCancellationRequestsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementCancellationRequestsIterable responses = client.listAgreementCancellationRequestsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementCancellationRequestsIterable responses = client
             .listAgreementCancellationRequestsPaginator(request);
     for (software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementCancellationRequestsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementCancellationRequestsIterable responses = client.listAgreementCancellationRequestsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the 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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAgreementCharges

default ListAgreementChargesResponse listAgreementCharges(ListAgreementChargesRequest listAgreementChargesRequest)
                                                   throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Allows acceptors to view charges and purchase orders that are associated with an agreement. The response includes details about all charges regardless of whether a purchase order is linked to each charge.

Parameters:

listAgreementChargesRequest -

Returns:

Result of the ListAgreementCharges operation returned by the service.

See Also:

• AWS API Documentation

listAgreementCharges

default ListAgreementChargesResponse listAgreementCharges(Consumer<ListAgreementChargesRequest.Builder> listAgreementChargesRequest)
                                                   throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Allows acceptors to view charges and purchase orders that are associated with an agreement. The response includes details about all charges regardless of whether a purchase order is linked to each charge.

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

Parameters:

listAgreementChargesRequest - A Consumer that will call methods on ListAgreementChargesRequest.Builder to create a request.

Returns:

Result of the ListAgreementCharges operation returned by the service.

See Also:

• AWS API Documentation

listAgreementChargesPaginator

default ListAgreementChargesIterable listAgreementChargesPaginator(ListAgreementChargesRequest listAgreementChargesRequest)
                                                            throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

This is a variant of listAgreementCharges(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementChargesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementChargesIterable responses = client.listAgreementChargesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementChargesIterable responses = client
             .listAgreementChargesPaginator(request);
     for (software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementChargesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementChargesIterable responses = client.listAgreementChargesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listAgreementChargesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAgreementChargesPaginator

default ListAgreementChargesIterable listAgreementChargesPaginator(Consumer<ListAgreementChargesRequest.Builder> listAgreementChargesRequest)
                                                            throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

This is a variant of listAgreementCharges(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementChargesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementChargesIterable responses = client.listAgreementChargesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementChargesIterable responses = client
             .listAgreementChargesPaginator(request);
     for (software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementChargesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementChargesIterable responses = client.listAgreementChargesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

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

Parameters:

listAgreementChargesRequest - A Consumer that will call methods on ListAgreementChargesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAgreementInvoiceLineItems

default ListAgreementInvoiceLineItemsResponse listAgreementInvoiceLineItems(ListAgreementInvoiceLineItemsRequest listAgreementInvoiceLineItemsRequest)
                                                                     throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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 supports only INVOICE_ID as a value. The agreementId parameter is required.

Parameters:

listAgreementInvoiceLineItemsRequest -

Returns:

Result of the ListAgreementInvoiceLineItems operation returned by the service.

See Also:

• AWS API Documentation

listAgreementInvoiceLineItems

default ListAgreementInvoiceLineItemsResponse listAgreementInvoiceLineItems(Consumer<ListAgreementInvoiceLineItemsRequest.Builder> listAgreementInvoiceLineItemsRequest)
                                                                     throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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 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:

Result of the ListAgreementInvoiceLineItems operation returned by the service.

See Also:

• AWS API Documentation

listAgreementInvoiceLineItemsPaginator

default ListAgreementInvoiceLineItemsIterable listAgreementInvoiceLineItemsPaginator(ListAgreementInvoiceLineItemsRequest listAgreementInvoiceLineItemsRequest)
                                                                              throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

This is a variant of listAgreementInvoiceLineItems(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementInvoiceLineItemsIterable responses = client.listAgreementInvoiceLineItemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementInvoiceLineItemsIterable responses = client
             .listAgreementInvoiceLineItemsPaginator(request);
     for (software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementInvoiceLineItemsIterable responses = client.listAgreementInvoiceLineItemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listAgreementInvoiceLineItemsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAgreementInvoiceLineItemsPaginator

default ListAgreementInvoiceLineItemsIterable listAgreementInvoiceLineItemsPaginator(Consumer<ListAgreementInvoiceLineItemsRequest.Builder> listAgreementInvoiceLineItemsRequest)
                                                                              throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

This is a variant of listAgreementInvoiceLineItems(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementInvoiceLineItemsIterable responses = client.listAgreementInvoiceLineItemsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementInvoiceLineItemsIterable responses = client
             .listAgreementInvoiceLineItemsPaginator(request);
     for (software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementInvoiceLineItemsIterable responses = client.listAgreementInvoiceLineItemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the 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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAgreementPaymentRequests

default ListAgreementPaymentRequestsResponse listAgreementPaymentRequests(ListAgreementPaymentRequestsRequest listAgreementPaymentRequestsRequest)
                                                                   throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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:

Result of the ListAgreementPaymentRequests operation returned by the service.

See Also:

• AWS API Documentation

listAgreementPaymentRequests

default ListAgreementPaymentRequestsResponse listAgreementPaymentRequests(Consumer<ListAgreementPaymentRequestsRequest.Builder> listAgreementPaymentRequestsRequest)
                                                                   throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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:

Result of the ListAgreementPaymentRequests operation returned by the service.

See Also:

• AWS API Documentation

listAgreementPaymentRequestsPaginator

default ListAgreementPaymentRequestsIterable listAgreementPaymentRequestsPaginator(ListAgreementPaymentRequestsRequest listAgreementPaymentRequestsRequest)
                                                                            throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

This is a variant of listAgreementPaymentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementPaymentRequestsIterable responses = client.listAgreementPaymentRequestsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementPaymentRequestsIterable responses = client
             .listAgreementPaymentRequestsPaginator(request);
     for (software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementPaymentRequestsIterable responses = client.listAgreementPaymentRequestsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listAgreementPaymentRequestsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAgreementPaymentRequestsPaginator

default ListAgreementPaymentRequestsIterable listAgreementPaymentRequestsPaginator(Consumer<ListAgreementPaymentRequestsRequest.Builder> listAgreementPaymentRequestsRequest)
                                                                            throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

This is a variant of listAgreementPaymentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementPaymentRequestsIterable responses = client.listAgreementPaymentRequestsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementPaymentRequestsIterable responses = client
             .listAgreementPaymentRequestsPaginator(request);
     for (software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementPaymentRequestsIterable responses = client.listAgreementPaymentRequestsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the 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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listBillingAdjustmentRequests

default ListBillingAdjustmentRequestsResponse listBillingAdjustmentRequests(ListBillingAdjustmentRequestsRequest listBillingAdjustmentRequestsRequest)
                                                                     throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Lists billing adjustment requests for a specific agreement. Sellers (proposers) can use this operation to view all billing adjustment requests associated with an agreement.

Parameters:

listBillingAdjustmentRequestsRequest -

Returns:

Result of the ListBillingAdjustmentRequests operation returned by the service.

See Also:

• AWS API Documentation

listBillingAdjustmentRequests

default ListBillingAdjustmentRequestsResponse listBillingAdjustmentRequests(Consumer<ListBillingAdjustmentRequestsRequest.Builder> listBillingAdjustmentRequestsRequest)
                                                                     throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Lists billing adjustment requests for a specific agreement. Sellers (proposers) can use this operation to view all billing adjustment requests associated with an agreement.

This is a convenience which creates an instance of the ListBillingAdjustmentRequestsRequest.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:

Result of the ListBillingAdjustmentRequests operation returned by the service.

See Also:

• AWS API Documentation

listBillingAdjustmentRequestsPaginator

default ListBillingAdjustmentRequestsIterable listBillingAdjustmentRequestsPaginator(ListBillingAdjustmentRequestsRequest listBillingAdjustmentRequestsRequest)
                                                                              throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

This is a variant of listBillingAdjustmentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListBillingAdjustmentRequestsIterable responses = client.listBillingAdjustmentRequestsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceagreement.paginators.ListBillingAdjustmentRequestsIterable responses = client
             .listBillingAdjustmentRequestsPaginator(request);
     for (software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListBillingAdjustmentRequestsIterable responses = client.listBillingAdjustmentRequestsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

listBillingAdjustmentRequestsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listBillingAdjustmentRequestsPaginator

default ListBillingAdjustmentRequestsIterable listBillingAdjustmentRequestsPaginator(Consumer<ListBillingAdjustmentRequestsRequest.Builder> listBillingAdjustmentRequestsRequest)
                                                                              throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

This is a variant of listBillingAdjustmentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListBillingAdjustmentRequestsIterable responses = client.listBillingAdjustmentRequestsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceagreement.paginators.ListBillingAdjustmentRequestsIterable responses = client
             .listBillingAdjustmentRequestsPaginator(request);
     for (software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.ListBillingAdjustmentRequestsIterable responses = client.listBillingAdjustmentRequestsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the 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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

rejectAgreementCancellationRequest

default RejectAgreementCancellationRequestResponse rejectAgreementCancellationRequest(RejectAgreementCancellationRequestRequest rejectAgreementCancellationRequestRequest)
                                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Allows buyers (acceptors) to reject a cancellation request that is in PENDING_APPROVAL status. Once rejected, the cancellation request transitions to REJECTED status and the agreement remains active. Buyers must provide a reason for the rejection.

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

Parameters:

rejectAgreementCancellationRequestRequest -

Returns:

Result of the RejectAgreementCancellationRequest operation returned by the service.

See Also:

• AWS API Documentation

rejectAgreementCancellationRequest

default RejectAgreementCancellationRequestResponse rejectAgreementCancellationRequest(Consumer<RejectAgreementCancellationRequestRequest.Builder> rejectAgreementCancellationRequestRequest)
                                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Allows buyers (acceptors) to reject a cancellation request that is in PENDING_APPROVAL status. Once rejected, the cancellation request transitions to REJECTED status and the agreement remains active. Buyers must provide a reason for the rejection.

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

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

Parameters:

rejectAgreementCancellationRequestRequest - A Consumer that will call methods on RejectAgreementCancellationRequestRequest.Builder to create a request.

Returns:

Result of the RejectAgreementCancellationRequest operation returned by the service.

See Also:

• AWS API Documentation

rejectAgreementPaymentRequest

default RejectAgreementPaymentRequestResponse rejectAgreementPaymentRequest(RejectAgreementPaymentRequestRequest rejectAgreementPaymentRequestRequest)
                                                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Allows buyers (acceptors) to reject a payment request that is in PENDING_APPROVAL status. Once rejected, the payment request transitions to REJECTED status and cannot be accepted. Buyers can optionally provide a reason for the rejection.

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

Parameters:

rejectAgreementPaymentRequestRequest -

Returns:

Result of the RejectAgreementPaymentRequest operation returned by the service.

See Also:

• AWS API Documentation

rejectAgreementPaymentRequest

default RejectAgreementPaymentRequestResponse rejectAgreementPaymentRequest(Consumer<RejectAgreementPaymentRequestRequest.Builder> rejectAgreementPaymentRequestRequest)
                                                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Allows buyers (acceptors) to reject a payment request that is in PENDING_APPROVAL status. Once rejected, the payment request transitions to REJECTED status and cannot be accepted. Buyers can optionally provide a reason for the rejection.

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

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

Parameters:

rejectAgreementPaymentRequestRequest - A Consumer that will call methods on RejectAgreementPaymentRequestRequest.Builder to create a request.

Returns:

Result of the RejectAgreementPaymentRequest operation returned by the service.

See Also:

• AWS API Documentation

searchAgreements

default SearchAgreementsResponse searchAgreements(SearchAgreementsRequest searchAgreementsRequest)
                                           throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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

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

• AgreementType

• AgreementType + EndTime

• AgreementType + ResourceType

• AgreementType + ResourceType + EndTime

• AgreementType + ResourceType + Status

• AgreementType + ResourceType + Status + EndTime

• AgreementType + ResourceIdentifier

• AgreementType + ResourceIdentifier + EndTime

• AgreementType + ResourceIdentifier + Status

• AgreementType + ResourceIdentifier + Status + EndTime

• AgreementType + AcceptorAccountId

• AgreementType + AcceptorAccountId + EndTime

• AgreementType + AcceptorAccountId + Status

• AgreementType + AcceptorAccountId + Status + EndTime

• AgreementType + AcceptorAccountId + OfferId

• AgreementType + AcceptorAccountId + OfferId + Status

• AgreementType + AcceptorAccountId + OfferId + EndTime

• AgreementType + AcceptorAccountId + OfferId + Status + EndTime

• AgreementType + AcceptorAccountId + ResourceIdentifier

• AgreementType + AcceptorAccountId + ResourceIdentifier + Status

• AgreementType + AcceptorAccountId + ResourceIdentifier + EndTime

• AgreementType + AcceptorAccountId + ResourceIdentifier + Status + EndTime

• AgreementType + AcceptorAccountId + ResourceType

• AgreementType + AcceptorAccountId + ResourceType + EndTime

• AgreementType + AcceptorAccountId + ResourceType + Status

• AgreementType + AcceptorAccountId + ResourceType + Status + EndTime

• AgreementType + Status

• AgreementType + Status + EndTime

• AgreementType + OfferId

• AgreementType + OfferId + EndTime

• AgreementType + OfferId + Status

• AgreementType + OfferId + Status + EndTime

• AgreementType + OfferSetId

• AgreementType + OfferSetId + EndTime

• AgreementType + OfferSetId + Status

• AgreementType + OfferSetId + Status + EndTime

To filter by EndTime, you can use BeforeEndTime and/or AfterEndTime. Only EndTime is supported for sorting.

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

• AgreementType

• AgreementType + Status

• AgreementType + EndTime

• AgreementType + Status + EndTime

• AgreementType + ResourceIdentifier

• AgreementType + ResourceIdentifier + EndTime

• AgreementType + ResourceIdentifier + Status

• AgreementType + ResourceIdentifier + Status + EndTime

• AgreementType + ResourceType

• AgreementType + ResourceType + EndTime

• AgreementType + OfferId

• AgreementType + OfferId + EndTime

• AgreementType + OfferId + Status

• AgreementType + OfferId + Status + EndTime

• AgreementType + OfferSetId

• AgreementType + OfferSetId + EndTime

• AgreementType + OfferSetId + Status

• AgreementType + OfferSetId + Status + EndTime

Parameters:

searchAgreementsRequest -

Returns:

Result of the SearchAgreements operation returned by the service.

See Also:

• AWS API Documentation

searchAgreements

default SearchAgreementsResponse searchAgreements(Consumer<SearchAgreementsRequest.Builder> searchAgreementsRequest)
                                           throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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

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

• AgreementType

• AgreementType + EndTime

• AgreementType + ResourceType

• AgreementType + ResourceType + EndTime

• AgreementType + ResourceType + Status

• AgreementType + ResourceType + Status + EndTime

• AgreementType + ResourceIdentifier

• AgreementType + ResourceIdentifier + EndTime

• AgreementType + ResourceIdentifier + Status

• AgreementType + ResourceIdentifier + Status + EndTime

• AgreementType + AcceptorAccountId

• AgreementType + AcceptorAccountId + EndTime

• AgreementType + AcceptorAccountId + Status

• AgreementType + AcceptorAccountId + Status + EndTime

• AgreementType + AcceptorAccountId + OfferId

• AgreementType + AcceptorAccountId + OfferId + Status

• AgreementType + AcceptorAccountId + OfferId + EndTime

• AgreementType + AcceptorAccountId + OfferId + Status + EndTime

• AgreementType + AcceptorAccountId + ResourceIdentifier

• AgreementType + AcceptorAccountId + ResourceIdentifier + Status

• AgreementType + AcceptorAccountId + ResourceIdentifier + EndTime

• AgreementType + AcceptorAccountId + ResourceIdentifier + Status + EndTime

• AgreementType + AcceptorAccountId + ResourceType

• AgreementType + AcceptorAccountId + ResourceType + EndTime

• AgreementType + AcceptorAccountId + ResourceType + Status

• AgreementType + AcceptorAccountId + ResourceType + Status + EndTime

• AgreementType + Status

• AgreementType + Status + EndTime

• AgreementType + OfferId

• AgreementType + OfferId + EndTime

• AgreementType + OfferId + Status

• AgreementType + OfferId + Status + EndTime

• AgreementType + OfferSetId

• AgreementType + OfferSetId + EndTime

• AgreementType + OfferSetId + Status

• AgreementType + OfferSetId + Status + EndTime

To filter by EndTime, you can use BeforeEndTime and/or AfterEndTime. Only EndTime is supported for sorting.

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

• AgreementType

• AgreementType + Status

• AgreementType + EndTime

• AgreementType + Status + EndTime

• AgreementType + ResourceIdentifier

• AgreementType + ResourceIdentifier + EndTime

• AgreementType + ResourceIdentifier + Status

• AgreementType + ResourceIdentifier + Status + EndTime

• AgreementType + ResourceType

• AgreementType + ResourceType + EndTime

• AgreementType + OfferId

• AgreementType + OfferId + EndTime

• AgreementType + OfferId + Status

• AgreementType + OfferId + Status + EndTime

• AgreementType + OfferSetId

• AgreementType + OfferSetId + EndTime

• AgreementType + OfferSetId + Status

• AgreementType + OfferSetId + Status + EndTime

This is a convenience which creates an instance of the SearchAgreementsRequest.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:

Result of the SearchAgreements operation returned by the service.

See Also:

• AWS API Documentation

searchAgreementsPaginator

default SearchAgreementsIterable searchAgreementsPaginator(SearchAgreementsRequest searchAgreementsRequest)
                                                    throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

This is a variant of searchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.SearchAgreementsIterable responses = client.searchAgreementsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceagreement.paginators.SearchAgreementsIterable responses = client
             .searchAgreementsPaginator(request);
     for (software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.SearchAgreementsIterable responses = client.searchAgreementsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

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

Parameters:

searchAgreementsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchAgreementsPaginator

default SearchAgreementsIterable searchAgreementsPaginator(Consumer<SearchAgreementsRequest.Builder> searchAgreementsRequest)
                                                    throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

This is a variant of searchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.SearchAgreementsIterable responses = client.searchAgreementsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.marketplaceagreement.paginators.SearchAgreementsIterable responses = client
             .searchAgreementsPaginator(request);
     for (software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.marketplaceagreement.paginators.SearchAgreementsIterable responses = client.searchAgreementsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the 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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

sendAgreementCancellationRequest

default SendAgreementCancellationRequestResponse sendAgreementCancellationRequest(SendAgreementCancellationRequestRequest sendAgreementCancellationRequestRequest)
                                                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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:

Result of the SendAgreementCancellationRequest operation returned by the service.

See Also:

• AWS API Documentation

sendAgreementCancellationRequest

default SendAgreementCancellationRequestResponse sendAgreementCancellationRequest(Consumer<SendAgreementCancellationRequestRequest.Builder> sendAgreementCancellationRequestRequest)
                                                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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:

Result of the SendAgreementCancellationRequest operation returned by the service.

See Also:

• AWS API Documentation

sendAgreementPaymentRequest

default SendAgreementPaymentRequestResponse sendAgreementPaymentRequest(SendAgreementPaymentRequestRequest sendAgreementPaymentRequestRequest)
                                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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:

Result of the SendAgreementPaymentRequest operation returned by the service.

See Also:

• AWS API Documentation

sendAgreementPaymentRequest

default SendAgreementPaymentRequestResponse sendAgreementPaymentRequest(Consumer<SendAgreementPaymentRequestRequest.Builder> sendAgreementPaymentRequestRequest)
                                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

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:

Result of the SendAgreementPaymentRequest operation returned by the service.

See Also:

• AWS API Documentation

updatePurchaseOrders

default UpdatePurchaseOrdersResponse updatePurchaseOrders(UpdatePurchaseOrdersRequest updatePurchaseOrdersRequest)
                                                   throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Allows acceptors to associate purchase orders with agreement charges after an agreement is created.

Parameters:

updatePurchaseOrdersRequest -

Returns:

Result of the UpdatePurchaseOrders operation returned by the service.

See Also:

• AWS API Documentation

updatePurchaseOrders

default UpdatePurchaseOrdersResponse updatePurchaseOrders(Consumer<UpdatePurchaseOrdersRequest.Builder> updatePurchaseOrdersRequest)
                                                   throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
MarketplaceAgreementException

Allows acceptors to associate purchase orders with agreement charges after an agreement is created.

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

Parameters:

updatePurchaseOrdersRequest - A Consumer that will call methods on UpdatePurchaseOrdersRequest.Builder to create a request.

Returns:

Result of the UpdatePurchaseOrders operation returned by the service.

See Also:

• AWS API Documentation

create

static MarketplaceAgreementClient create()

Create a MarketplaceAgreementClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static MarketplaceAgreementClientBuilder builder()

Create a builder that can be used to configure and create a MarketplaceAgreementClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

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