View Source AWS.MarketplaceAgreement (aws-elixir v1.0.11)
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 and buyers manage their product-related agreements, including listing, searching, creating, 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.
Link to this section Summary
Functions
Allows buyers (acceptors) to accept a cancellation request that is in
PENDING_APPROVAL status.
Allows buyers (acceptors) to accept a payment request that is in
PENDING_APPROVAL status.
Accepts an agreement request to finalize the agreement.
Allows sellers (proposers) to submit billing adjustment requests for one or more invoices within an agreement.
Allows an acceptor to cancel an active agreement.
Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state.
Allows sellers (proposers) to cancel a payment request that is in
PENDING_APPROVAL status.
Creates an agreement request that acts as a quote for the terms you want to accept.
Provides details about an agreement, such as the proposer, acceptor, start date, and end date.
Retrieves detailed information about a specific agreement cancellation request.
Obtains details about the entitlements of an agreement.
Retrieves detailed information about a specific payment request.
Obtains details about the terms in an agreement that you participated in as proposer or acceptor.
Retrieves detailed information about a specific billing adjustment request.
Lists agreement cancellation requests available to you as a seller or buyer.
Allows acceptors to view charges and purchase orders that are associated with an agreement.
Allows sellers (proposers) to retrieve aggregated billing data from AWS Marketplace agreements using flexible grouping.
Lists payment requests available to you as a seller or buyer.
Lists billing adjustment requests for a specific agreement.
Allows buyers (acceptors) to reject a cancellation request that is in
PENDING_APPROVAL status.
Allows buyers (acceptors) to reject a payment request that is in
PENDING_APPROVAL status.
Searches across all agreements that a proposer or an acceptor has in AWS Marketplace.
Allows sellers (proposers) to submit a cancellation request for an active agreement.
Allows sellers (proposers) to submit a payment request to buyers (acceptors) for
a specific charge amount for an agreement that includes a VariablePaymentTerm.
Allows acceptors to associate purchase orders with agreement charges after an agreement is created.
Link to this section Functions
accept_agreement_cancellation_request(client, input, options \\ [])
View SourceAllows buyers (acceptors) to accept a cancellation request that is in
PENDING_APPROVAL status.
Once accepted, the cancellation request transitions to APPROVED status and the
agreement cancellation will be processed.
Only cancellation requests in PENDING_APPROVAL status can be accepted. A
ConflictException is thrown if the cancellation request is in any other
status.
Allows buyers (acceptors) to accept a payment request that is in
PENDING_APPROVAL status.
Once accepted, the payment request transitions to APPROVED status and the
charge will be processed. Buyers can optionally provide a purchase order
reference for their internal tracking.
Only payment requests in PENDING_APPROVAL status can be accepted. A
ConflictException is thrown if the payment request is in any other status.
Accepts an agreement request to finalize the agreement.
The acceptor can optionally provide purchase orders to associate with the agreement charges.
batch_create_billing_adjustment_request(client, input, options \\ [])
View SourceAllows 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 to process.
Each entry requires a unique clientToken for idempotency.
Allows an acceptor to cancel an active agreement.
Not all agreements are eligible for cancellation. Use the error response to determine why a cancellation request was rejected.
cancel_agreement_cancellation_request(client, input, options \\ [])
View SourceAllows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state.
Once cancelled, the cancellation request transitions to CANCELLED status and
can no longer be approved or rejected by the buyer.
Only cancellation requests in PENDING_APPROVAL status can be cancelled. A
ConflictException is thrown if the cancellation request is in any other
status.
Allows sellers (proposers) to cancel a payment request that is in
PENDING_APPROVAL status.
Once cancelled, the payment request transitions to CANCELLED status and can no
longer be accepted or rejected by the buyer.
Only payment requests in PENDING_APPROVAL status can be cancelled. A
ConflictException is thrown if the payment request is in any other status.
Creates an agreement request that acts as a quote for the terms you want to accept.
The agreement request captures the requested terms, calculates charges, and
returns a summary. Use AcceptAgreementRequest with the returned
agreementRequestId to finalize the agreement.
Provides details about an agreement, such as the proposer, acceptor, start date, and end date.
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.
Obtains details about the entitlements of an agreement.
Retrieves detailed information about a specific payment request.
Both sellers (proposers) and buyers (acceptors) can use this operation to view payment requests associated with their agreements. The response includes the current status, charge details, timestamps, and the charge ID if the request has been approved.
The calling identity must be either the acceptor or proposer of the payment
request. A ResourceNotFoundException is returned if the payment request does
not exist.
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.
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.
list_agreement_cancellation_requests(client, input, options \\ [])
View SourceLists 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.
PartyType is a required parameter. A ValidationException is returned if
PartyType is not provided.
Allows acceptors to view charges and purchase orders that are associated with an agreement.
The response includes details about all charges regardless of whether a purchase order is linked to each charge.
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 groupBy parameter is required and supports only INVOICE_ID as a value.
The agreementId parameter is required.
Lists payment requests available to you as a seller or buyer.
Both sellers (proposers) and buyers (acceptors) can use this operation to find payment requests by specifying their party type and applying optional parameters.
PartyType is a required parameter. A ValidationException is returned if
PartyType is not provided. Pagination is supported through maxResults (1-50,
default 50) and nextToken parameters.
Lists billing adjustment requests for a specific agreement.
Sellers (proposers) can use this operation to view all billing adjustment requests associated with an agreement.
reject_agreement_cancellation_request(client, input, options \\ [])
View SourceAllows buyers (acceptors) to reject a cancellation request that is in
PENDING_APPROVAL status.
Once rejected, the cancellation request transitions to REJECTED status and the
agreement remains active. Buyers must provide a reason for the rejection.
Only cancellation requests in PENDING_APPROVAL status can be rejected. A
ConflictException is thrown if the cancellation request is in any other
status.
Allows buyers (acceptors) to reject a payment request that is in
PENDING_APPROVAL status.
Once rejected, the payment request transitions to REJECTED status and cannot
be accepted. Buyers can optionally provide a reason for the rejection.
Only payment requests in PENDING_APPROVAL status can be rejected. A
ConflictException is thrown if the payment request is in any other status.
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 when the PartyType is
Proposer:
AgreementTypeAgreementType+EndTimeAgreementType+ResourceTypeAgreementType+ResourceType+EndTimeAgreementType+ResourceType+StatusAgreementType+ResourceType+Status+EndTimeAgreementType+ResourceIdentifierAgreementType+ResourceIdentifier+EndTimeAgreementType+ResourceIdentifier+StatusAgreementType+ResourceIdentifier+Status+EndTimeAgreementType+AcceptorAccountIdAgreementType+AcceptorAccountId+EndTimeAgreementType+AcceptorAccountId+StatusAgreementType+AcceptorAccountId+Status+EndTimeAgreementType+AcceptorAccountId+OfferIdAgreementType+AcceptorAccountId+OfferId+StatusAgreementType+AcceptorAccountId+OfferId+EndTimeAgreementType+AcceptorAccountId+OfferId+Status+EndTimeAgreementType+AcceptorAccountId+ResourceIdentifierAgreementType+AcceptorAccountId+ResourceIdentifier+StatusAgreementType+AcceptorAccountId+ResourceIdentifier+EndTimeAgreementType+AcceptorAccountId+ResourceIdentifier+Status+EndTimeAgreementType+AcceptorAccountId+ResourceTypeAgreementType+AcceptorAccountId+ResourceType+EndTimeAgreementType+AcceptorAccountId+ResourceType+StatusAgreementType+AcceptorAccountId+ResourceType+Status
EndTimeAgreementType+StatusAgreementType+Status+EndTimeAgreementType+OfferIdAgreementType+OfferId+EndTimeAgreementType+OfferId+StatusAgreementType+OfferId+Status+EndTimeAgreementType+OfferSetIdAgreementType+OfferSetId+EndTimeAgreementType+OfferSetId+StatusAgreementType+OfferSetId+Status+EndTime
To filter by EndTime, you can use BeforeEndTime and/or AfterEndTime. Only
EndTime is supported for sorting.
The following filter combinations are supported when the PartyType is
Acceptor:
AgreementTypeAgreementType+StatusAgreementType+EndTimeAgreementType+Status+EndTimeAgreementType+ResourceIdentifierAgreementType+ResourceIdentifier+EndTimeAgreementType+ResourceIdentifier+StatusAgreementType+ResourceIdentifier+Status+EndTimeAgreementType+ResourceTypeAgreementType+ResourceType+EndTimeAgreementType+OfferIdAgreementType+OfferId+EndTimeAgreementType+OfferId+StatusAgreementType+OfferId+Status+EndTimeAgreementType+OfferSetIdAgreementType+OfferSetId+EndTimeAgreementType+OfferSetId+StatusAgreementType+OfferSetId+Status+EndTime
Allows sellers (proposers) to submit a cancellation request for an active agreement.
The cancellation request is created in PENDING_APPROVAL status, at which point
the buyer can review it.
Allows sellers (proposers) to submit a payment request to buyers (acceptors) for
a specific charge amount for an agreement that includes a VariablePaymentTerm.
The payment request is created in PENDING_APPROVAL status, at which point the
buyer can accept or reject it.
The agreement must be active and have a VariablePaymentTerm to support payment
requests. The chargeAmount must not exceed the remaining available balance
under the VariablePaymentTerm maxTotalChargeAmount.
Allows acceptors to associate purchase orders with agreement charges after an agreement is created.