@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSMarketplaceAgreementAsync extends AWSMarketplaceAgreement
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSMarketplaceAgreementAsync
instead.
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.
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<DescribeAgreementResult> |
describeAgreementAsync(DescribeAgreementRequest describeAgreementRequest)
Provides details about an agreement, such as the proposer, acceptor, start date, and end date.
|
Future<DescribeAgreementResult> |
describeAgreementAsync(DescribeAgreementRequest describeAgreementRequest,
AsyncHandler<DescribeAgreementRequest,DescribeAgreementResult> asyncHandler)
Provides details about an agreement, such as the proposer, acceptor, start date, and end date.
|
Future<GetAgreementTermsResult> |
getAgreementTermsAsync(GetAgreementTermsRequest getAgreementTermsRequest)
Obtains details about the terms in an agreement that you participated in as proposer or acceptor.
|
Future<GetAgreementTermsResult> |
getAgreementTermsAsync(GetAgreementTermsRequest getAgreementTermsRequest,
AsyncHandler<GetAgreementTermsRequest,GetAgreementTermsResult> asyncHandler)
Obtains details about the terms in an agreement that you participated in as proposer or acceptor.
|
Future<SearchAgreementsResult> |
searchAgreementsAsync(SearchAgreementsRequest searchAgreementsRequest)
Searches across all agreements that a proposer or an acceptor has in AWS Marketplace.
|
Future<SearchAgreementsResult> |
searchAgreementsAsync(SearchAgreementsRequest searchAgreementsRequest,
AsyncHandler<SearchAgreementsRequest,SearchAgreementsResult> asyncHandler)
Searches across all agreements that a proposer or an acceptor has in AWS Marketplace.
|
describeAgreement, getAgreementTerms, getCachedResponseMetadata, searchAgreements, shutdown
Future<DescribeAgreementResult> describeAgreementAsync(DescribeAgreementRequest describeAgreementRequest)
Provides details about an agreement, such as the proposer, acceptor, start date, and end date.
describeAgreementRequest
- Future<DescribeAgreementResult> describeAgreementAsync(DescribeAgreementRequest describeAgreementRequest, AsyncHandler<DescribeAgreementRequest,DescribeAgreementResult> asyncHandler)
Provides details about an agreement, such as the proposer, acceptor, start date, and end date.
describeAgreementRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAgreementTermsResult> getAgreementTermsAsync(GetAgreementTermsRequest getAgreementTermsRequest)
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.
getAgreementTermsRequest
- Future<GetAgreementTermsResult> getAgreementTermsAsync(GetAgreementTermsRequest getAgreementTermsRequest, AsyncHandler<GetAgreementTermsRequest,GetAgreementTermsResult> asyncHandler)
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.
getAgreementTermsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SearchAgreementsResult> searchAgreementsAsync(SearchAgreementsRequest searchAgreementsRequest)
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
searchAgreementsRequest
- Future<SearchAgreementsResult> searchAgreementsAsync(SearchAgreementsRequest searchAgreementsRequest, AsyncHandler<SearchAgreementsRequest,SearchAgreementsResult> asyncHandler)
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
searchAgreementsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.