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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aMarketplaceAgreementClient
.static MarketplaceAgreementClient
create()
Create aMarketplaceAgreementClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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 ofgetAgreementTerms(software.amazon.awssdk.services.marketplaceagreement.model.GetAgreementTermsRequest)
operation.default GetAgreementTermsIterable
getAgreementTermsPaginator
(GetAgreementTermsRequest getAgreementTermsRequest) This is a variant ofgetAgreementTerms(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 ofsearchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest)
operation.default SearchAgreementsIterable
searchAgreementsPaginator
(SearchAgreementsRequest searchAgreementsRequest) This is a variant ofsearchAgreements(software.amazon.awssdk.services.marketplaceagreement.model.SearchAgreementsRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic 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
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
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:
-
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 viaDescribeAgreementRequest.builder()
- Parameters:
describeAgreementRequest
- AConsumer
that will call methods onDescribeAgreementRequest.Builder
to create a request.- Returns:
- Result of the DescribeAgreement operation returned by the service.
- See Also:
-
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 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 forLegalTerm
or pricing and dimensions for various pricing terms, such asConfigurableUpfrontPricingTerm
orUsageBasedPricingTerm
.
-
Configuration
– The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting theEnableAutoRenew
flag.
- 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, 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 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 forLegalTerm
or pricing and dimensions for various pricing terms, such asConfigurableUpfrontPricingTerm
orUsageBasedPricingTerm
.
-
Configuration
– The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting theEnableAutoRenew
flag.
This is a convenience which creates an instance of the
GetAgreementTermsRequest.Builder
avoiding the need to create one manually viaGetAgreementTermsRequest.builder()
- Parameters:
getAgreementTermsRequest
- AConsumer
that will call methods onGetAgreementTermsRequest.Builder
to create a request.- Returns:
- Result of the GetAgreementTerms operation returned by the service.
- See Also:
-
-
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 Streamsoftware.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, 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 Streamsoftware.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.Builder
avoiding the need to create one manually viaGetAgreementTermsRequest.builder()
- Parameters:
getAgreementTermsRequest
- AConsumer
that will call methods onGetAgreementTermsRequest.Builder
to 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 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
asProposer
+AgreementType
+ResourceIdentifier
-
PartyType
asProposer
+AgreementType
+OfferId
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
-
PartyType
asProposer
+AgreementType
+Status
-
PartyType
asProposer
+AgreementType
+ResourceIdentifier
+Status
-
PartyType
asProposer
+AgreementType
+OfferId
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+Status
-
PartyType
asProposer
+AgreementType
+ResourceType
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceType
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+OfferId
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+OfferId
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceIdentifier
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceIdentifier
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceType
- 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 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
asProposer
+AgreementType
+ResourceIdentifier
-
PartyType
asProposer
+AgreementType
+OfferId
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
-
PartyType
asProposer
+AgreementType
+Status
-
PartyType
asProposer
+AgreementType
+ResourceIdentifier
+Status
-
PartyType
asProposer
+AgreementType
+OfferId
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+Status
-
PartyType
asProposer
+AgreementType
+ResourceType
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceType
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+OfferId
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+OfferId
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceIdentifier
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceIdentifier
+Status
-
PartyType
asProposer
+AgreementType
+AcceptorAccountId
+ResourceType
This is a convenience which creates an instance of the
SearchAgreementsRequest.Builder
avoiding the need to create one manually viaSearchAgreementsRequest.builder()
- Parameters:
searchAgreementsRequest
- AConsumer
that will call methods onSearchAgreementsRequest.Builder
to 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 Streamsoftware.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 Streamsoftware.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.Builder
avoiding the need to create one manually viaSearchAgreementsRequest.builder()
- Parameters:
searchAgreementsRequest
- AConsumer
that will call methods onSearchAgreementsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
create
Create aMarketplaceAgreementClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aMarketplaceAgreementClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-