Interface MarketplaceAgreementClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
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
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionbatchCreateBillingAdjustmentRequest(Consumer<BatchCreateBillingAdjustmentRequestRequest.Builder> batchCreateBillingAdjustmentRequestRequest) Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement.batchCreateBillingAdjustmentRequest(BatchCreateBillingAdjustmentRequestRequest batchCreateBillingAdjustmentRequestRequest) Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement.builder()Create a builder that can be used to configure and create aMarketplaceAgreementClient.cancelAgreementCancellationRequest(Consumer<CancelAgreementCancellationRequestRequest.Builder> cancelAgreementCancellationRequestRequest) Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state.cancelAgreementCancellationRequest(CancelAgreementCancellationRequestRequest cancelAgreementCancellationRequestRequest) Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state.cancelAgreementPaymentRequest(Consumer<CancelAgreementPaymentRequestRequest.Builder> cancelAgreementPaymentRequestRequest) Allows sellers (proposers) to cancel a payment request that is inPENDING_APPROVALstatus.cancelAgreementPaymentRequest(CancelAgreementPaymentRequestRequest cancelAgreementPaymentRequestRequest) Allows sellers (proposers) to cancel a payment request that is inPENDING_APPROVALstatus.static MarketplaceAgreementClientcreate()Create aMarketplaceAgreementClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default DescribeAgreementResponsedescribeAgreement(Consumer<DescribeAgreementRequest.Builder> describeAgreementRequest) Provides details about an agreement, such as the proposer, acceptor, start date, and end date.default DescribeAgreementResponsedescribeAgreement(DescribeAgreementRequest describeAgreementRequest) Provides details about an agreement, such as the proposer, acceptor, start date, and end date.getAgreementCancellationRequest(Consumer<GetAgreementCancellationRequestRequest.Builder> getAgreementCancellationRequestRequest) Retrieves detailed information about a specific agreement cancellation request.getAgreementCancellationRequest(GetAgreementCancellationRequestRequest getAgreementCancellationRequestRequest) Retrieves detailed information about a specific agreement cancellation request.getAgreementPaymentRequest(Consumer<GetAgreementPaymentRequestRequest.Builder> getAgreementPaymentRequestRequest) Retrieves detailed information about a specific payment request.getAgreementPaymentRequest(GetAgreementPaymentRequestRequest getAgreementPaymentRequestRequest) Retrieves detailed information about a specific payment request.default GetAgreementTermsResponsegetAgreementTerms(Consumer<GetAgreementTermsRequest.Builder> getAgreementTermsRequest) Obtains details about the terms in an agreement that you participated in as proposer or acceptor.default GetAgreementTermsResponsegetAgreementTerms(GetAgreementTermsRequest getAgreementTermsRequest) Obtains details about the terms in an agreement that you participated in as proposer or acceptor.default GetAgreementTermsIterablegetAgreementTermsPaginator(Consumer<GetAgreementTermsRequest.Builder> getAgreementTermsRequest) This is a variant ofgetAgreementTerms(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest)operation.default GetAgreementTermsIterablegetAgreementTermsPaginator(GetAgreementTermsRequest getAgreementTermsRequest) This is a variant ofgetAgreementTerms(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest)operation.getBillingAdjustmentRequest(Consumer<GetBillingAdjustmentRequestRequest.Builder> getBillingAdjustmentRequestRequest) Retrieves detailed information about a specific billing adjustment request.getBillingAdjustmentRequest(GetBillingAdjustmentRequestRequest getBillingAdjustmentRequestRequest) Retrieves detailed information about a specific billing adjustment request.listAgreementCancellationRequests(Consumer<ListAgreementCancellationRequestsRequest.Builder> listAgreementCancellationRequestsRequest) Lists agreement cancellation requests available to you as a seller or buyer.listAgreementCancellationRequests(ListAgreementCancellationRequestsRequest listAgreementCancellationRequestsRequest) Lists agreement cancellation requests available to you as a seller or buyer.listAgreementCancellationRequestsPaginator(Consumer<ListAgreementCancellationRequestsRequest.Builder> listAgreementCancellationRequestsRequest) listAgreementCancellationRequestsPaginator(ListAgreementCancellationRequestsRequest listAgreementCancellationRequestsRequest) listAgreementInvoiceLineItems(Consumer<ListAgreementInvoiceLineItemsRequest.Builder> listAgreementInvoiceLineItemsRequest) Allows sellers (proposers) to retrieve aggregated billing data from AWS Marketplace agreements using flexible grouping.listAgreementInvoiceLineItems(ListAgreementInvoiceLineItemsRequest listAgreementInvoiceLineItemsRequest) Allows sellers (proposers) to retrieve aggregated billing data from AWS Marketplace agreements using flexible grouping.listAgreementInvoiceLineItemsPaginator(Consumer<ListAgreementInvoiceLineItemsRequest.Builder> listAgreementInvoiceLineItemsRequest) This is a variant oflistAgreementInvoiceLineItems(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsRequest)operation.listAgreementInvoiceLineItemsPaginator(ListAgreementInvoiceLineItemsRequest listAgreementInvoiceLineItemsRequest) This is a variant oflistAgreementInvoiceLineItems(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementInvoiceLineItemsRequest)operation.listAgreementPaymentRequests(Consumer<ListAgreementPaymentRequestsRequest.Builder> listAgreementPaymentRequestsRequest) Lists payment requests available to you as a seller or buyer.listAgreementPaymentRequests(ListAgreementPaymentRequestsRequest listAgreementPaymentRequestsRequest) Lists payment requests available to you as a seller or buyer.listAgreementPaymentRequestsPaginator(Consumer<ListAgreementPaymentRequestsRequest.Builder> listAgreementPaymentRequestsRequest) This is a variant oflistAgreementPaymentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsRequest)operation.listAgreementPaymentRequestsPaginator(ListAgreementPaymentRequestsRequest listAgreementPaymentRequestsRequest) This is a variant oflistAgreementPaymentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListAgreementPaymentRequestsRequest)operation.listBillingAdjustmentRequests(Consumer<ListBillingAdjustmentRequestsRequest.Builder> listBillingAdjustmentRequestsRequest) Lists billing adjustment requests for a specific agreement.listBillingAdjustmentRequests(ListBillingAdjustmentRequestsRequest listBillingAdjustmentRequestsRequest) Lists billing adjustment requests for a specific agreement.listBillingAdjustmentRequestsPaginator(Consumer<ListBillingAdjustmentRequestsRequest.Builder> listBillingAdjustmentRequestsRequest) This is a variant oflistBillingAdjustmentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsRequest)operation.listBillingAdjustmentRequestsPaginator(ListBillingAdjustmentRequestsRequest listBillingAdjustmentRequestsRequest) This is a variant oflistBillingAdjustmentRequests(software.amazon.awssdk.services.marketplaceagreement.model.ListBillingAdjustmentRequestsRequest)operation.default SearchAgreementsResponsesearchAgreements(Consumer<SearchAgreementsRequest.Builder> searchAgreementsRequest) Searches across all agreements that a proposer has in AWS Marketplace.default SearchAgreementsResponsesearchAgreements(SearchAgreementsRequest searchAgreementsRequest) Searches across all agreements that a proposer has in AWS Marketplace.default SearchAgreementsIterablesearchAgreementsPaginator(Consumer<SearchAgreementsRequest.Builder> searchAgreementsRequest) This is a variant ofsearchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest)operation.default SearchAgreementsIterablesearchAgreementsPaginator(SearchAgreementsRequest searchAgreementsRequest) This is a variant ofsearchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest)operation.sendAgreementCancellationRequest(Consumer<SendAgreementCancellationRequestRequest.Builder> sendAgreementCancellationRequestRequest) Allows sellers (proposers) to submit a cancellation request for an active agreement.sendAgreementCancellationRequest(SendAgreementCancellationRequestRequest sendAgreementCancellationRequestRequest) Allows sellers (proposers) to submit a cancellation request for an active agreement.sendAgreementPaymentRequest(Consumer<SendAgreementPaymentRequestRequest.Builder> sendAgreementPaymentRequestRequest) Allows sellers (proposers) to submit a payment request to buyers (acceptors) for a specific charge amount for an agreement that includes aVariablePaymentTerm.sendAgreementPaymentRequest(SendAgreementPaymentRequestRequest sendAgreementPaymentRequestRequest) Allows sellers (proposers) to submit a payment request to buyers (acceptors) for a specific charge amount for an agreement that includes aVariablePaymentTerm.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadataMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
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 validation.
Each entry requires a unique
clientTokenfor idempotency. AValidationExceptionis returned if the adjustment amount exceeds the maximum refundable amount for the invoice.- Parameters:
batchCreateBillingAdjustmentRequestRequest-- Returns:
- Result of the BatchCreateBillingAdjustmentRequest operation returned by the service.
- See Also:
-
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 validation.
Each entry requires a unique
clientTokenfor idempotency. AValidationExceptionis returned if the adjustment amount exceeds the maximum refundable amount for the invoice.
This is a convenience which creates an instance of the
BatchCreateBillingAdjustmentRequestRequest.Builderavoiding the need to create one manually viaBatchCreateBillingAdjustmentRequestRequest.builder()- Parameters:
batchCreateBillingAdjustmentRequestRequest- AConsumerthat will call methods onBatchCreateBillingAdjustmentRequestRequest.Builderto create a request.- Returns:
- Result of the BatchCreateBillingAdjustmentRequest operation returned by the service.
- See Also:
-
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
CANCELLEDstatus and can no longer be approved or rejected by the buyer.Only cancellation requests in
PENDING_APPROVALstatus can be cancelled. AConflictExceptionis thrown if the cancellation request is in any other status.- Parameters:
cancelAgreementCancellationRequestRequest-- Returns:
- Result of the CancelAgreementCancellationRequest operation returned by the service.
- See Also:
-
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
CANCELLEDstatus and can no longer be approved or rejected by the buyer.Only cancellation requests in
PENDING_APPROVALstatus can be cancelled. AConflictExceptionis thrown if the cancellation request is in any other status.
This is a convenience which creates an instance of the
CancelAgreementCancellationRequestRequest.Builderavoiding the need to create one manually viaCancelAgreementCancellationRequestRequest.builder()- Parameters:
cancelAgreementCancellationRequestRequest- AConsumerthat will call methods onCancelAgreementCancellationRequestRequest.Builderto create a request.- Returns:
- Result of the CancelAgreementCancellationRequest operation returned by the service.
- See Also:
-
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_APPROVALstatus. Once cancelled, the payment request transitions toCANCELLEDstatus and can no longer be accepted or rejected by the buyer.Only payment requests in
PENDING_APPROVALstatus can be cancelled. AConflictExceptionis thrown if the payment request is in any other status.- Parameters:
cancelAgreementPaymentRequestRequest-- Returns:
- Result of the CancelAgreementPaymentRequest operation returned by the service.
- See Also:
-
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_APPROVALstatus. Once cancelled, the payment request transitions toCANCELLEDstatus and can no longer be accepted or rejected by the buyer.Only payment requests in
PENDING_APPROVALstatus can be cancelled. AConflictExceptionis thrown if the payment request is in any other status.
This is a convenience which creates an instance of the
CancelAgreementPaymentRequestRequest.Builderavoiding the need to create one manually viaCancelAgreementPaymentRequestRequest.builder()- Parameters:
cancelAgreementPaymentRequestRequest- AConsumerthat will call methods onCancelAgreementPaymentRequestRequest.Builderto create a request.- Returns:
- Result of the CancelAgreementPaymentRequest operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaDescribeAgreementRequest.builder()- Parameters:
describeAgreementRequest- AConsumerthat will call methods onDescribeAgreementRequest.Builderto create a request.- Returns:
- Result of the DescribeAgreement operation returned by the service.
- See Also:
-
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.
The calling identity must be either the acceptor or proposer of the agreement. A
ResourceNotFoundExceptionis returned if the cancellation request does not exist.- Parameters:
getAgreementCancellationRequestRequest-- Returns:
- Result of the GetAgreementCancellationRequest operation returned by the service.
- See Also:
-
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.
The calling identity must be either the acceptor or proposer of the agreement. A
ResourceNotFoundExceptionis returned if the cancellation request does not exist.
This is a convenience which creates an instance of the
GetAgreementCancellationRequestRequest.Builderavoiding the need to create one manually viaGetAgreementCancellationRequestRequest.builder()- Parameters:
getAgreementCancellationRequestRequest- AConsumerthat will call methods onGetAgreementCancellationRequestRequest.Builderto create a request.- Returns:
- Result of the GetAgreementCancellationRequest operation returned by the service.
- See Also:
-
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
ResourceNotFoundExceptionis returned if the payment request does not exist.- Parameters:
getAgreementPaymentRequestRequest-- Returns:
- Result of the GetAgreementPaymentRequest operation returned by the service.
- See Also:
-
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
ResourceNotFoundExceptionis returned if the payment request does not exist.
This is a convenience which creates an instance of the
GetAgreementPaymentRequestRequest.Builderavoiding the need to create one manually viaGetAgreementPaymentRequestRequest.builder()- Parameters:
getAgreementPaymentRequestRequest- AConsumerthat will call methods onGetAgreementPaymentRequestRequest.Builderto create a request.- Returns:
- Result of the GetAgreementPaymentRequest operation returned by the service.
- See Also:
-
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 asLegalTerm,RenewalTerm, orConfigurableUpfrontPricingTerm. -
TermID– The ID of the particular term, which is common between offer and agreement. -
TermPayload– The key information contained in the term, such as the EULA forLegalTermor pricing and dimensions for various pricing terms, such asConfigurableUpfrontPricingTermorUsageBasedPricingTerm.
-
Configuration– The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting theEnableAutoRenewflag.
- Parameters:
getAgreementTermsRequest-- Returns:
- Result of the GetAgreementTerms operation returned by the service.
- See Also:
-
-
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 asLegalTerm,RenewalTerm, orConfigurableUpfrontPricingTerm. -
TermID– The ID of the particular term, which is common between offer and agreement. -
TermPayload– The key information contained in the term, such as the EULA forLegalTermor pricing and dimensions for various pricing terms, such asConfigurableUpfrontPricingTermorUsageBasedPricingTerm.
-
Configuration– The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting theEnableAutoRenewflag.
This is a convenience which creates an instance of the
GetAgreementTermsRequest.Builderavoiding the need to create one manually viaGetAgreementTermsRequest.builder()- Parameters:
getAgreementTermsRequest- AConsumerthat will call methods onGetAgreementTermsRequest.Builderto create a request.- Returns:
- Result of the GetAgreementTerms operation returned by the service.
- See Also:
-
-
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
2) Using For loopsoftware.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementTermsIterable responses = client.getAgreementTermsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.marketplaceagreement.paginators.GetAgreementTermsIterable responses = client.getAgreementTermsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaGetAgreementTermsRequest.builder()- Parameters:
getAgreementTermsRequest- AConsumerthat will call methods onGetAgreementTermsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
A
ResourceNotFoundExceptionis returned if the billing adjustment request does not exist or the caller does not have permission to access it.- Parameters:
getBillingAdjustmentRequestRequest-- Returns:
- Result of the GetBillingAdjustmentRequest operation returned by the service.
- See Also:
-
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.
A
ResourceNotFoundExceptionis returned if the billing adjustment request does not exist or the caller does not have permission to access it.
This is a convenience which creates an instance of the
GetBillingAdjustmentRequestRequest.Builderavoiding the need to create one manually viaGetBillingAdjustmentRequestRequest.builder()- Parameters:
getBillingAdjustmentRequestRequest- AConsumerthat will call methods onGetBillingAdjustmentRequestRequest.Builderto create a request.- Returns:
- Result of the GetBillingAdjustmentRequest operation returned by the service.
- See Also:
-
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.
PartyTypeis a required parameter. AValidationExceptionis returned ifPartyTypeis not provided. Pagination is supported throughmaxResults(1-50, default 20) andnextTokenparameters.- Parameters:
listAgreementCancellationRequestsRequest-- Returns:
- Result of the ListAgreementCancellationRequests operation returned by the service.
- See Also:
-
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.
PartyTypeis a required parameter. AValidationExceptionis returned ifPartyTypeis not provided. Pagination is supported throughmaxResults(1-50, default 20) andnextTokenparameters.
This is a convenience which creates an instance of the
ListAgreementCancellationRequestsRequest.Builderavoiding the need to create one manually viaListAgreementCancellationRequestsRequest.builder()- Parameters:
listAgreementCancellationRequestsRequest- AConsumerthat will call methods onListAgreementCancellationRequestsRequest.Builderto create a request.- Returns:
- Result of the ListAgreementCancellationRequests operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementCancellationRequestsIterable responses = client.listAgreementCancellationRequestsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementCancellationRequestsIterable responses = client.listAgreementCancellationRequestsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListAgreementCancellationRequestsRequest.builder()- Parameters:
listAgreementCancellationRequestsRequest- AConsumerthat will call methods onListAgreementCancellationRequestsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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
groupByparameter is required and currently supports onlyINVOICE_IDas a value. TheagreementIdparameter is required.- Parameters:
listAgreementInvoiceLineItemsRequest-- Returns:
- Result of the ListAgreementInvoiceLineItems operation returned by the service.
- See Also:
-
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
groupByparameter is required and currently supports onlyINVOICE_IDas a value. TheagreementIdparameter is required.
This is a convenience which creates an instance of the
ListAgreementInvoiceLineItemsRequest.Builderavoiding the need to create one manually viaListAgreementInvoiceLineItemsRequest.builder()- Parameters:
listAgreementInvoiceLineItemsRequest- AConsumerthat will call methods onListAgreementInvoiceLineItemsRequest.Builderto create a request.- Returns:
- Result of the ListAgreementInvoiceLineItems operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementInvoiceLineItemsIterable responses = client.listAgreementInvoiceLineItemsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementInvoiceLineItemsIterable responses = client.listAgreementInvoiceLineItemsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListAgreementInvoiceLineItemsRequest.builder()- Parameters:
listAgreementInvoiceLineItemsRequest- AConsumerthat will call methods onListAgreementInvoiceLineItemsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
PartyTypeis a required parameter. AValidationExceptionis returned ifPartyTypeis not provided. Pagination is supported throughmaxResults(1-50, default 50) andnextTokenparameters.- Parameters:
listAgreementPaymentRequestsRequest-- Returns:
- Result of the ListAgreementPaymentRequests operation returned by the service.
- See Also:
-
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.
PartyTypeis a required parameter. AValidationExceptionis returned ifPartyTypeis not provided. Pagination is supported throughmaxResults(1-50, default 50) andnextTokenparameters.
This is a convenience which creates an instance of the
ListAgreementPaymentRequestsRequest.Builderavoiding the need to create one manually viaListAgreementPaymentRequestsRequest.builder()- Parameters:
listAgreementPaymentRequestsRequest- AConsumerthat will call methods onListAgreementPaymentRequestsRequest.Builderto create a request.- Returns:
- Result of the ListAgreementPaymentRequests operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementPaymentRequestsIterable responses = client.listAgreementPaymentRequestsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListAgreementPaymentRequestsIterable responses = client.listAgreementPaymentRequestsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListAgreementPaymentRequestsRequest.builder()- Parameters:
listAgreementPaymentRequestsRequest- AConsumerthat will call methods onListAgreementPaymentRequestsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
Pagination is supported through
maxResultsandnextTokenparameters.- Parameters:
listBillingAdjustmentRequestsRequest-- Returns:
- Result of the ListBillingAdjustmentRequests operation returned by the service.
- See Also:
-
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.
Pagination is supported through
maxResultsandnextTokenparameters.
This is a convenience which creates an instance of the
ListBillingAdjustmentRequestsRequest.Builderavoiding the need to create one manually viaListBillingAdjustmentRequestsRequest.builder()- Parameters:
listBillingAdjustmentRequestsRequest- AConsumerthat will call methods onListBillingAdjustmentRequestsRequest.Builderto create a request.- Returns:
- Result of the ListBillingAdjustmentRequests operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListBillingAdjustmentRequestsIterable responses = client.listBillingAdjustmentRequestsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.marketplaceagreement.paginators.ListBillingAdjustmentRequestsIterable responses = client.listBillingAdjustmentRequestsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListBillingAdjustmentRequestsRequest.builder()- Parameters:
listBillingAdjustmentRequestsRequest- AConsumerthat will call methods onListBillingAdjustmentRequestsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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
PartyTypeisProposer:-
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 eitherBeforeEndTimeorAfterEndTime. OnlyEndTimeis supported for sorting.- Parameters:
searchAgreementsRequest-- Returns:
- Result of the SearchAgreements operation returned by the service.
- See Also:
-
-
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
PartyTypeisProposer:-
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 eitherBeforeEndTimeorAfterEndTime. OnlyEndTimeis supported for sorting.
This is a convenience which creates an instance of the
SearchAgreementsRequest.Builderavoiding the need to create one manually viaSearchAgreementsRequest.builder()- Parameters:
searchAgreementsRequest- AConsumerthat will call methods onSearchAgreementsRequest.Builderto create a request.- Returns:
- Result of the SearchAgreements operation returned by the service.
- See Also:
-
-
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
2) Using For loopsoftware.amazon.awssdk.services.marketplaceagreement.paginators.SearchAgreementsIterable responses = client.searchAgreementsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.marketplaceagreement.paginators.SearchAgreementsIterable responses = client.searchAgreementsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaSearchAgreementsRequest.builder()- Parameters:
searchAgreementsRequest- AConsumerthat will call methods onSearchAgreementsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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_APPROVALstatus, at which point the buyer can review it.- Parameters:
sendAgreementCancellationRequestRequest-- Returns:
- Result of the SendAgreementCancellationRequest operation returned by the service.
- See Also:
-
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_APPROVALstatus, at which point the buyer can review it.
This is a convenience which creates an instance of the
SendAgreementCancellationRequestRequest.Builderavoiding the need to create one manually viaSendAgreementCancellationRequestRequest.builder()- Parameters:
sendAgreementCancellationRequestRequest- AConsumerthat will call methods onSendAgreementCancellationRequestRequest.Builderto create a request.- Returns:
- Result of the SendAgreementCancellationRequest operation returned by the service.
- See Also:
-
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 inPENDING_APPROVALstatus, at which point the buyer can accept or reject it.The agreement must be active and have a
VariablePaymentTermto support payment requests. ThechargeAmountmust not exceed the remaining available balance under theVariablePaymentTermmaxTotalChargeAmount.- Parameters:
sendAgreementPaymentRequestRequest-- Returns:
- Result of the SendAgreementPaymentRequest operation returned by the service.
- See Also:
-
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 inPENDING_APPROVALstatus, at which point the buyer can accept or reject it.The agreement must be active and have a
VariablePaymentTermto support payment requests. ThechargeAmountmust not exceed the remaining available balance under theVariablePaymentTermmaxTotalChargeAmount.
This is a convenience which creates an instance of the
SendAgreementPaymentRequestRequest.Builderavoiding the need to create one manually viaSendAgreementPaymentRequestRequest.builder()- Parameters:
sendAgreementPaymentRequestRequest- AConsumerthat will call methods onSendAgreementPaymentRequestRequest.Builderto create a request.- Returns:
- Result of the SendAgreementPaymentRequest operation returned by the service.
- See Also:
-
create
Create aMarketplaceAgreementClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aMarketplaceAgreementClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-