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 manage their product-related agreements, including listing, searching, and filtering agreements.

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

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

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

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

Field Summary

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
static MarketplaceAgreementClientBuilder	builder()	Create a builder that can be used to configure and create a MarketplaceAgreementClient.
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 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 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 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 SearchAgreementsResponse	searchAgreements(Consumer<SearchAgreementsRequest.Builder> searchAgreementsRequest)	Searches across all agreements that a proposer has in AWS Marketplace.
default SearchAgreementsResponse	searchAgreements(SearchAgreementsRequest searchAgreementsRequest)	Searches across all agreements that a proposer 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 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()

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

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

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

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

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

searchAgreements

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

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

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

• AgreementType

• AgreementType + EndTime

• AgreementType + ResourceType

• AgreementType + ResourceType + EndTime

• AgreementType + ResourceType + Status

• AgreementType + ResourceType + Status + EndTime

• AgreementType + ResourceId

• AgreementType + ResourceId + EndTime

• AgreementType + ResourceId + Status

• AgreementType + ResourceId + Status + EndTime

• AgreementType + AcceptorAccountId

• AgreementType + AcceptorAccountId + EndTime

• AgreementType + AcceptorAccountId + Status

• AgreementType + AcceptorAccountId + Status + EndTime

• AgreementType + AcceptorAccountId + OfferId

• AgreementType + AcceptorAccountId + OfferId + Status

• AgreementType + AcceptorAccountId + OfferId + EndTime

• AgreementType + AcceptorAccountId + OfferId + Status + EndTime

• AgreementType + AcceptorAccountId + ResourceId

• AgreementType + AcceptorAccountId + ResourceId + Status

• AgreementType + AcceptorAccountId + ResourceId + EndTime

• AgreementType + AcceptorAccountId + ResourceId + Status + EndTime

• AgreementType + AcceptorAccountId + ResourceType

• AgreementType + AcceptorAccountId + ResourceType + EndTime

• AgreementType + AcceptorAccountId + ResourceType + Status

• AgreementType + AcceptorAccountId + ResourceType + Status + EndTime

• AgreementType + Status

• AgreementType + Status + EndTime

• AgreementType + OfferId

• AgreementType + OfferId + EndTime

• AgreementType + OfferId + Status

• AgreementType + OfferId + Status + EndTime

• AgreementType + OfferSetId

• AgreementType + OfferSetId + EndTime

• AgreementType + OfferSetId + Status

• AgreementType + OfferSetId + Status + EndTime

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

Parameters:

searchAgreementsRequest -

Returns:

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

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

• AgreementType

• AgreementType + EndTime

• AgreementType + ResourceType

• AgreementType + ResourceType + EndTime

• AgreementType + ResourceType + Status

• AgreementType + ResourceType + Status + EndTime

• AgreementType + ResourceId

• AgreementType + ResourceId + EndTime

• AgreementType + ResourceId + Status

• AgreementType + ResourceId + Status + EndTime

• AgreementType + AcceptorAccountId

• AgreementType + AcceptorAccountId + EndTime

• AgreementType + AcceptorAccountId + Status

• AgreementType + AcceptorAccountId + Status + EndTime

• AgreementType + AcceptorAccountId + OfferId

• AgreementType + AcceptorAccountId + OfferId + Status

• AgreementType + AcceptorAccountId + OfferId + EndTime

• AgreementType + AcceptorAccountId + OfferId + Status + EndTime

• AgreementType + AcceptorAccountId + ResourceId

• AgreementType + AcceptorAccountId + ResourceId + Status

• AgreementType + AcceptorAccountId + ResourceId + EndTime

• AgreementType + AcceptorAccountId + ResourceId + Status + EndTime

• AgreementType + AcceptorAccountId + ResourceType

• AgreementType + AcceptorAccountId + ResourceType + EndTime

• AgreementType + AcceptorAccountId + ResourceType + Status

• AgreementType + AcceptorAccountId + ResourceType + Status + EndTime

• AgreementType + Status

• AgreementType + Status + EndTime

• AgreementType + OfferId

• AgreementType + OfferId + EndTime

• AgreementType + OfferId + Status

• AgreementType + OfferId + Status + EndTime

• AgreementType + OfferSetId

• AgreementType + OfferSetId + EndTime

• AgreementType + OfferSetId + Status

• AgreementType + OfferSetId + Status + EndTime

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

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

Parameters:

searchAgreementsRequest - A Consumer that will call methods on SearchAgreementsRequest.Builder to create a request.

Returns:

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

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

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