2023/11/30 - AWS Marketplace Agreement Service - 3 new api methods
Changes The AWS Marketplace Agreement Service provides an API interface that helps AWS Marketplace sellers manage their agreements, including listing, filtering, and viewing details about their agreements.
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.
See also: AWS API Documentation
Request Syntax
client.get_agreement_terms(
agreementId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier of the agreement.
integer
The maximum number of agreements to return in the response.
string
A token to specify where to start pagination
dict
Response Syntax
{
'acceptedTerms': [
{
'byolPricingTerm': {
'type': 'string'
},
'configurableUpfrontPricingTerm': {
'configuration': {
'dimensions': [
{
'dimensionKey': 'string',
'dimensionValue': 123
},
],
'selectorValue': 'string'
},
'currencyCode': 'string',
'rateCards': [
{
'constraints': {
'multipleDimensionSelection': 'string',
'quantityConfiguration': 'string'
},
'rateCard': [
{
'dimensionKey': 'string',
'price': 'string'
},
],
'selector': {
'type': 'string',
'value': 'string'
}
},
],
'type': 'string'
},
'fixedUpfrontPricingTerm': {
'currencyCode': 'string',
'duration': 'string',
'grants': [
{
'dimensionKey': 'string',
'maxQuantity': 123
},
],
'price': 'string',
'type': 'string'
},
'freeTrialPricingTerm': {
'duration': 'string',
'grants': [
{
'dimensionKey': 'string',
'maxQuantity': 123
},
],
'type': 'string'
},
'legalTerm': {
'documents': [
{
'type': 'string',
'url': 'string',
'version': 'string'
},
],
'type': 'string'
},
'paymentScheduleTerm': {
'currencyCode': 'string',
'schedule': [
{
'chargeAmount': 'string',
'chargeDate': datetime(2015, 1, 1)
},
],
'type': 'string'
},
'recurringPaymentTerm': {
'billingPeriod': 'string',
'currencyCode': 'string',
'price': 'string',
'type': 'string'
},
'renewalTerm': {
'configuration': {
'enableAutoRenew': True|False
},
'type': 'string'
},
'supportTerm': {
'refundPolicy': 'string',
'type': 'string'
},
'usageBasedPricingTerm': {
'currencyCode': 'string',
'rateCards': [
{
'rateCard': [
{
'dimensionKey': 'string',
'price': 'string'
},
]
},
],
'type': 'string'
},
'validityTerm': {
'agreementDuration': 'string',
'agreementEndDate': datetime(2015, 1, 1),
'agreementStartDate': datetime(2015, 1, 1),
'type': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
acceptedTerms (list) --
A subset of terms proposed by the proposer that have been accepted by the acceptor as part of the agreement creation.
(dict) --
A subset of terms proposed by the proposer, which have been accepted by the acceptor as part of agreement creation.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: byolPricingTerm, configurableUpfrontPricingTerm, fixedUpfrontPricingTerm, freeTrialPricingTerm, legalTerm, paymentScheduleTerm, recurringPaymentTerm, renewalTerm, supportTerm, usageBasedPricingTerm, validityTerm. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
byolPricingTerm (dict) --
Enables you and your customers to move your existing agreements to AWS Marketplace. The customer won't be charged for product usage in AWS Marketplace because they already paid for the product outside of AWS Marketplace.
type (string) --
Type of the term being updated.
configurableUpfrontPricingTerm (dict) --
Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.
configuration (dict) --
Additional parameters specified by the acceptor while accepting the term.
dimensions (list) --
Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.
(dict) --
Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.
dimensionKey (string) --
The name of key value of the dimension.
dimensionValue (integer) --
The number of units of the dimension the acceptor has purchased.
Note
For Agreements with ConfigurableUpfrontPricingTerm , the RateCard section will define the prices and dimensions defined by the seller (proposer), whereas the Configuration section will define the actual dimensions, prices, and units the buyer has chosen to accept.
selectorValue (string) --
Defines the length of time for which the particular pricing/dimension is being purchased by the acceptor.
currencyCode (string) --
Defines the currency for the prices mentioned in the term.
rateCards (list) --
A rate card defines the per unit rates for product dimensions.
(dict) --
Within the prepaid payment model defined under ConfigurableUpfrontPricingTerm , the RateCardItem defines all the various rate cards (including pricing and dimensions) that have been proposed.
constraints (dict) --
Defines limits on how the term can be configured by acceptors.
multipleDimensionSelection (string) --
Determines if buyers are allowed to select multiple dimensions in the rate card. The possible values are Allowed and Disallowed . The default value is Allowed .
quantityConfiguration (string) --
Determines if acceptors are allowed to configure quantity for each dimension in rate card. The possible values are Allowed and Disallowed . The default value is Allowed .
rateCard (list) --
Defines the per unit rates for product dimensions.
(dict) --
Defines the per unit rates for each individual product dimension.
dimensionKey (string) --
Dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.
price (string) --
Per unit price for the product dimension that’s used for calculating the amount to be charged.
selector (dict) --
Differentiates between the mutually exclusive rate cards in the same pricing term to be selected by the buyer.
type (string) --
Category of selector.
value (string) --
Contract duration. This field supports the ISO 8601 format.
type (string) --
Category of selector.
fixedUpfrontPricingTerm (dict) --
Defines a pre-paid pricing model where the customers are charged a fixed upfront amount.
currencyCode (string) --
Defines the currency for the prices mentioned in this term.
duration (string) --
Contract duration for the terms.
grants (list) --
Entitlements granted to the acceptor of fixed upfront as part of agreement execution.
(dict) --
Entitlements granted to the acceptor of fixed upfront as part of agreement execution.
dimensionKey (string) --
Unique dimension key defined in the product document. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.
maxQuantity (integer) --
Maximum amount of capacity that the buyer can be entitled to the given dimension of the product. If MaxQuantity is not provided, the buyer will be able to use an unlimited amount of the given dimension.
price (string) --
Fixed amount to be charged to the customer when this term is accepted.
type (string) --
Category of the term being updated.
freeTrialPricingTerm (dict) --
Defines a short-term free pricing model where the buyers aren’t charged anything within a specified limit.
duration (string) --
Duration of the free trial period (5–31 days).
grants (list) --
Entitlements granted to the acceptor of a free trial as part of an agreement execution.
(dict) --
Entitlements granted to the acceptor of fixed upfront as part of agreement execution.
dimensionKey (string) --
Unique dimension key defined in the product document. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.
maxQuantity (integer) --
Maximum amount of capacity that the buyer can be entitled to the given dimension of the product. If MaxQuantity is not provided, the buyer will be able to use an unlimited amount of the given dimension.
type (string) --
Category of the term.
legalTerm (dict) --
Defines the list of text agreements proposed to the acceptors. An example is the end user license agreement (EULA).
documents (list) --
List of references to legal resources proposed to the buyers. An example is the EULA.
(dict) --
Includes the list of references to legal resources proposed by the proposer to the acceptor. Each DocumentItem refers to an individual reference.
type (string) --
Category of the document. Document types include:
CustomEula – A custom EULA provided by you as seller. A URL for a EULA stored in an accessible Amazon S3 bucket is required for this document type.
CustomDsa – A custom Data Subscription Agreement (DSA) provided by you as seller. A URL for a DSA stored in an accessible Amazon S3 bucket is required for this document type.
StandardEula – The Standard Contract for AWS Marketplace (SCMP). For more information about SCMP, see the AWS Marketplace Seller Guide. You don’t provide a URL for this type because it’s managed by AWS Marketplace.
StandardDsa – DSA for AWS Marketplace. For more information about the DSA, see the AWS Data Exchange User Guide. You don’t provide a URL for this type because it’s managed by AWS Marketplace.
url (string) --
A URL to the legal document for buyers to read. Required when Type is CustomEula .
version (string) --
Version of standard contracts provided by AWS Marketplace. Required when Type is StandardEula or StandardDsa .
type (string) --
Category of the term being updated.
paymentScheduleTerm (dict) --
Defines an installment-based pricing model where customers are charged a fixed price on different dates during the agreement validity period. This is used most commonly for flexible payment schedule pricing.
currencyCode (string) --
Defines the currency for the prices mentioned in the term.
schedule (list) --
List of the payment schedule where each element defines one installment of payment. It contains the information necessary for calculating the price.
(dict) --
An individual installment of the payment that includes the date and amount of the charge.
chargeAmount (string) --
The price that the customer would pay on the scheduled date (chargeDate).
chargeDate (datetime) --
The date that the customer would pay the price defined in this payment schedule term. Invoices are generated on the date provided.
type (string) --
Type of the term.
recurringPaymentTerm (dict) --
Defines a pricing model where customers are charged a fixed recurring price at the end of each billing period.
billingPeriod (string) --
Defines the recurrence at which buyers are charged.
currencyCode (string) --
Defines the currency for the prices mentioned in this term.
price (string) --
Amount charged to the buyer every billing period.
type (string) --
Type of the term being updated.
renewalTerm (dict) --
Defines that on graceful expiration of the agreement (when the agreement ends on its pre-defined end date), a new agreement will be created using the accepted terms on the existing agreement. In other words, the agreement will be renewed. Presence of RenewalTerm in the offer document means that auto-renewal is allowed. Buyers will have the option to accept or decline auto-renewal at the offer acceptance/agreement creation. Buyers can also change this flag from True to False or False to True at anytime during the agreement's lifecycle.
configuration (dict) --
Additional parameters specified by the acceptor while accepting the term.
enableAutoRenew (boolean) --
Defines whether the acceptor has chosen to auto-renew the agreement at the end of its lifecycle. Can be set to True or False .
type (string) --
Category of the term being updated.
supportTerm (dict) --
Defines the customer support available for the acceptors when they purchase the software.
refundPolicy (string) --
Free-text field about the refund policy description that will be shown to customers as is on the website and console.
type (string) --
Category of the term being updated.
usageBasedPricingTerm (dict) --
Defines a usage-based pricing model (typically, pay-as-you-go pricing), where the customers are charged based on product usage.
currencyCode (string) --
Defines the currency for the prices mentioned in the term.
rateCards (list) --
List of rate cards.
(dict) --
Within the pay-as-you-go model defined under UsageBasedPricingTerm , the UsageBasedRateCardItem defines an individual rate for a product dimension.
rateCard (list) --
Defines the per unit rates for product dimensions.
(dict) --
Defines the per unit rates for each individual product dimension.
dimensionKey (string) --
Dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.
price (string) --
Per unit price for the product dimension that’s used for calculating the amount to be charged.
type (string) --
Category of the term.
validityTerm (dict) --
Defines the conditions that will keep an agreement created from this offer valid.
agreementDuration (string) --
Defines the duration that the agreement remains active. If AgreementStartDate isn’t provided, the agreement duration is relative to the agreement signature time. The duration is represented in the ISO_8601 format.
agreementEndDate (datetime) --
Defines the date when the agreement ends. The agreement ends at 23:59:59.999 UTC on the date provided. If AgreementEndDate isn’t provided, the agreement end date is determined by the validity of individual terms.
agreementStartDate (datetime) --
Defines the date when agreement starts. The agreement starts at 00:00:00.000 UTC on the date provided. If AgreementStartDate isn’t provided, the agreement start date is determined based on agreement signature time.
type (string) --
Category of the term being updated.
nextToken (string) --
A token to specify where to start pagination
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
See also: AWS API Documentation
Request Syntax
client.search_agreements(
catalog='string',
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string',
sort={
'sortBy': 'string',
'sortOrder': 'ASCENDING'|'DESCENDING'
}
)
string
The catalog in which the agreement was created.
list
The filter name and value pair used to return a specific list of results.
The following filters are supported:
ResourceIdentifier – The unique identifier of the resource.
ResourceType – Type of the resource, which is the product ( AmiProduct , ContainerProduct , or SaaSProduct ).
PartyType – The party type (either Acceptor or Proposer ) of the caller. For agreements where the caller is the proposer, use the Proposer filter. For agreements where the caller is the acceptor, use the Acceptor filter.
AcceptorAccountId – The AWS account ID of the party accepting the agreement terms.
OfferId – The unique identifier of the offer in which the terms are registered in the agreement token.
Status – The current status of the agreement. Values include ACTIVE , ARCHIVED , CANCELLED , EXPIRED , RENEWED , REPLACED , and TERMINATED .
BeforeEndTime – A date used to filter agreements with a date before the endTime of an agreement.
AfterEndTime – A date used to filter agreements with a date after the endTime of an agreement.
AgreementType – The type of agreement. Values include PurchaseAgreement or VendorInsightsAgreement .
(dict) --
The filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as offerId or productId .
name (string) --
The name of the filter.
values (list) --
The filter value.
(string) --
integer
The maximum number of agreements to return in the response.
string
A token to specify where to start pagination.
dict
An object that contains the SortBy and SortOrder attributes.
sortBy (string) --
The attribute on which the data is grouped, which can be by StartTime and EndTime . The default value is EndTime .
sortOrder (string) --
The sorting order, which can be ASCENDING or DESCENDING . The default value is DESCENDING .
dict
Response Syntax
{
'agreementViewSummaries': [
{
'acceptanceTime': datetime(2015, 1, 1),
'acceptor': {
'accountId': 'string'
},
'agreementId': 'string',
'agreementType': 'string',
'endTime': datetime(2015, 1, 1),
'proposalSummary': {
'offerId': 'string',
'resources': [
{
'id': 'string',
'type': 'string'
},
]
},
'proposer': {
'accountId': 'string'
},
'startTime': datetime(2015, 1, 1),
'status': 'ACTIVE'|'ARCHIVED'|'CANCELLED'|'EXPIRED'|'RENEWED'|'REPLACED'|'ROLLED_BACK'|'SUPERSEDED'|'TERMINATED'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
agreementViewSummaries (list) --
A summary of the agreement, including top-level attributes (for example, the agreement ID, version, proposer, and acceptor).
(dict) --
A summary of the agreement, including top-level attributes (for example, the agreement ID, version, proposer, and acceptor).
acceptanceTime (datetime) --
The date and time that the agreement was accepted.
acceptor (dict) --
Details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.
accountId (string) --
The AWS account ID of the acceptor.
agreementId (string) --
The unique identifier of the agreement.
agreementType (string) --
The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement .
endTime (datetime) --
The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.
proposalSummary (dict) --
A summary of the proposal
offerId (string) --
The unique identifier of the offer in AWS Marketplace.
resources (list) --
The list of resources involved in the agreement.
(dict) --
The list of resources involved in the agreement.
id (string) --
The unique identifier of the resource.
Note
We mention the term resource, which is most commonly a product, so a resourceId is also a productId .
type (string) --
Type of the resource, which is the product. Values include SaaSProduct or AmiProduct .
proposer (dict) --
Details of the party proposing the agreement terms, most commonly the seller for PurchaseAgreement .
accountId (string) --
The AWS account ID of the proposer.
startTime (datetime) --
The date and time when the agreement starts.
status (string) --
The current status of the agreement.
nextToken (string) --
The token used for pagination. The field is null if there are no more results.
Provides details about an agreement, such as the proposer, acceptor, start date, and end date.
See also: AWS API Documentation
Request Syntax
client.describe_agreement(
agreementId='string'
)
string
[REQUIRED]
The unique identifier of the agreement.
dict
Response Syntax
{
'acceptanceTime': datetime(2015, 1, 1),
'acceptor': {
'accountId': 'string'
},
'agreementId': 'string',
'agreementType': 'string',
'endTime': datetime(2015, 1, 1),
'estimatedCharges': {
'agreementValue': 'string',
'currencyCode': 'string'
},
'proposalSummary': {
'offerId': 'string',
'resources': [
{
'id': 'string',
'type': 'string'
},
]
},
'proposer': {
'accountId': 'string'
},
'startTime': datetime(2015, 1, 1),
'status': 'ACTIVE'|'ARCHIVED'|'CANCELLED'|'EXPIRED'|'RENEWED'|'REPLACED'|'ROLLED_BACK'|'SUPERSEDED'|'TERMINATED'
}
Response Structure
(dict) --
acceptanceTime (datetime) --
The date and time the offer was accepted or the agreement was created.
Note
AcceptanceTime and StartTime can differ for future dated agreements (FDAs).
acceptor (dict) --
The details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement .
accountId (string) --
The AWS account ID of the acceptor.
agreementId (string) --
The unique identifier of the agreement.
agreementType (string) --
The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement .
endTime (datetime) --
The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.
estimatedCharges (dict) --
The estimated cost of the agreement.
agreementValue (string) --
The total known amount customer has to pay across the lifecycle of the agreement.
Note
This is the total contract value if accepted terms contain ConfigurableUpfrontPricingTerm or FixedUpfrontPricingTerm . In the case of pure contract pricing, this will be the total value of the contract. In the case of contracts with consumption pricing, this will only include the committed value and not include any overages that occur.
If the accepted terms contain PaymentScheduleTerm , it will be the total payment schedule amount. This occurs when flexible payment schedule is used, and is the sum of all invoice charges in the payment schedule.
In case a customer has amended an agreement, by purchasing more units of any dimension, this will include both the original cost as well as the added cost incurred due to addition of new units.
This is 0 if the accepted terms contain UsageBasedPricingTerm without ConfigurableUpfrontPricingTerm or RecurringPaymentTerm . This occurs for usage-based pricing (such as SaaS metered or AMI/container hourly or monthly), because the exact usage is not known upfront.
currencyCode (string) --
Defines the currency code for the charge.
proposalSummary (dict) --
A summary of the proposal received from the proposer.
offerId (string) --
The unique identifier of the offer in AWS Marketplace.
resources (list) --
The list of resources involved in the agreement.
(dict) --
The list of resources involved in the agreement.
id (string) --
The unique identifier of the resource.
Note
We mention the term resource, which is most commonly a product, so a resourceId is also a productId .
type (string) --
Type of the resource, which is the product. Values include SaaSProduct or AmiProduct .
proposer (dict) --
The details of the party proposing the agreement terms. This is commonly the seller for PurchaseAgreement .
accountId (string) --
The AWS account ID of the proposer.
startTime (datetime) --
The date and time when the agreement starts.
status (string) --
The current status of the agreement.
Statuses include:
ACTIVE – The terms of the agreement are active.
ARCHIVED – The agreement ended without a specified reason.
CANCELLED – The acceptor ended the agreement before the defined end date.
EXPIRED – The agreement ended on the defined end date.
RENEWED – The agreement was renewed into a new agreement (for example, an auto-renewal).
REPLACED – The agreement was replaced using an agreement replacement offer.
ROLLED_BACK (Only applicable to inactive agreement revisions) – The agreement revision has been rolled back because of an error. An earlier revision is now active.
SUPERCEDED (Only applicable to inactive agreement revisions) – The agreement revision is no longer active and another agreement revision is now active.
TERMINATED – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).