Interface MarketplaceAgreementClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@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.
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 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 SearchAgreementsResponse	searchAgreements(Consumer<SearchAgreementsRequest.Builder> searchAgreementsRequest)	Searches across all agreements that a proposer or an acceptor has in AWS Marketplace.
default SearchAgreementsResponse	searchAgreements(SearchAgreementsRequest searchAgreementsRequest)	Searches across all agreements that a proposer or an acceptor has in AWS Marketplace.
default SearchAgreementsIterable	searchAgreementsPaginator(Consumer<SearchAgreementsRequest.Builder> searchAgreementsRequest)	This is a variant of searchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest) operation.
default SearchAgreementsIterable	searchAgreementsPaginator(SearchAgreementsRequest searchAgreementsRequest)	This is a variant of searchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest) operation.
default 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

describeAgreement

default DescribeAgreementResponse describeAgreement(DescribeAgreementRequest describeAgreementRequest)
                                             throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
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

describeAgreement

default DescribeAgreementResponse describeAgreement(Consumer<DescribeAgreementRequest.Builder> describeAgreementRequest)
                                             throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
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

getAgreementTerms

default GetAgreementTermsResponse getAgreementTerms(GetAgreementTermsRequest getAgreementTermsRequest)
                                             throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
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

getAgreementTerms

default GetAgreementTermsResponse getAgreementTerms(Consumer<GetAgreementTermsRequest.Builder> getAgreementTermsRequest)
                                             throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
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

getAgreementTermsPaginator

default GetAgreementTermsIterable getAgreementTermsPaginator(GetAgreementTermsRequest getAgreementTermsRequest)
                                                      throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
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

getAgreementTermsPaginator

default GetAgreementTermsIterable getAgreementTermsPaginator(Consumer<GetAgreementTermsRequest.Builder> getAgreementTermsRequest)
                                                      throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
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

searchAgreements

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

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

The following filter combinations are supported:

• PartyType as Proposer + AgreementType + ResourceIdentifier

• PartyType as Proposer + AgreementType + OfferId

• PartyType as Proposer + AgreementType + AcceptorAccountId

• PartyType as Proposer + AgreementType + Status

• PartyType as Proposer + AgreementType + ResourceIdentifier + Status

• PartyType as Proposer + AgreementType + OfferId + Status

• PartyType as Proposer + AgreementType + AcceptorAccountId + Status

• PartyType as Proposer + AgreementType + ResourceType + Status

• PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceType + Status

• PartyType as Proposer + AgreementType + AcceptorAccountId + OfferId

• PartyType as Proposer + AgreementType + AcceptorAccountId + OfferId + Status

• PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceIdentifier

• PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceIdentifier + Status

• PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceType

Parameters:

searchAgreementsRequest -

Returns:

Result of the SearchAgreements operation returned by the service.

See Also:

• AWS API Documentation

searchAgreements

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

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

The following filter combinations are supported:

• PartyType as Proposer + AgreementType + ResourceIdentifier

• PartyType as Proposer + AgreementType + OfferId

• PartyType as Proposer + AgreementType + AcceptorAccountId

• PartyType as Proposer + AgreementType + Status

• PartyType as Proposer + AgreementType + ResourceIdentifier + Status

• PartyType as Proposer + AgreementType + OfferId + Status

• PartyType as Proposer + AgreementType + AcceptorAccountId + Status

• PartyType as Proposer + AgreementType + ResourceType + Status

• PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceType + Status

• PartyType as Proposer + AgreementType + AcceptorAccountId + OfferId

• PartyType as Proposer + AgreementType + AcceptorAccountId + OfferId + Status

• PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceIdentifier

• PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceIdentifier + Status

• PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceType

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

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