{ "version": "2.0", "service": "

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:

", "operations": { "DescribeAgreement": "

Provides details about an agreement, such as the proposer, acceptor, start date, and end date.

", "GetAgreementTerms": "

Obtains details about the terms in an agreement that you participated in as proposer or acceptor.

The details include:

", "SearchAgreements": "

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:

" }, "shapes": { "AWSAccountId": { "base": null, "refs": { "Acceptor$accountId": "

The AWS account ID of the acceptor.

", "Proposer$accountId": "

The AWS account ID of the proposer.

" } }, "AcceptedTerm": { "base": "

A subset of terms proposed by the proposer, which have been accepted by the acceptor as part of agreement creation.

", "refs": { "AcceptedTermList$member": null } }, "AcceptedTermList": { "base": null, "refs": { "GetAgreementTermsOutput$acceptedTerms": "

A subset of terms proposed by the proposer that have been accepted by the acceptor as part of the agreement creation.

" } }, "Acceptor": { "base": "

The details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.

", "refs": { "AgreementViewSummary$acceptor": "

Details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.

", "DescribeAgreementOutput$acceptor": "

The details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.

" } }, "AccessDeniedException": { "base": "

User does not have sufficient access to perform this action.

", "refs": { } }, "AgreementResourceType": { "base": null, "refs": { "Resource$type": "

Type of the resource, which is the product. Values include SaaSProduct or AmiProduct.

" } }, "AgreementStatus": { "base": null, "refs": { "AgreementViewSummary$status": "

The current status of the agreement.

", "DescribeAgreementOutput$status": "

The current status of the agreement.

Statuses include:

" } }, "AgreementType": { "base": null, "refs": { "AgreementViewSummary$agreementType": "

The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.

", "DescribeAgreementOutput$agreementType": "

The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.

" } }, "AgreementViewSummary": { "base": "

A summary of the agreement, including top-level attributes (for example, the agreement ID, version, proposer, and acceptor).

", "refs": { "AgreementViewSummaryList$member": null } }, "AgreementViewSummaryList": { "base": null, "refs": { "SearchAgreementsOutput$agreementViewSummaries": "

A summary of the agreement, including top-level attributes (for example, the agreement ID, version, proposer, and acceptor).

" } }, "Boolean": { "base": null, "refs": { "RenewalTermConfiguration$enableAutoRenew": "

Defines whether the acceptor has chosen to auto-renew the agreement at the end of its lifecycle. Can be set to True or False.

" } }, "BoundedString": { "base": null, "refs": { "ConfigurableUpfrontPricingTermConfiguration$selectorValue": "

Defines the length of time for which the particular pricing/dimension is being purchased by the acceptor.

", "Constraints$multipleDimensionSelection": "

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.

", "Constraints$quantityConfiguration": "

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.

", "Dimension$dimensionKey": "

The name of key value of the dimension.

", "DocumentItem$type": "

Category of the document. Document types include:

", "DocumentItem$url": "

A URL to the legal document for buyers to read. Required when Type is CustomEula.

", "DocumentItem$version": "

Version of standard contracts provided by AWS Marketplace. Required when Type is StandardEula or StandardDsa.

", "EstimatedCharges$agreementValue": "

The total known amount customer has to pay across the lifecycle of the agreement.

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.

", "FixedUpfrontPricingTerm$duration": "

Contract duration for the terms.

", "FixedUpfrontPricingTerm$price": "

Fixed amount to be charged to the customer when this term is accepted.

", "FreeTrialPricingTerm$duration": "

Duration of the free trial period (5–31 days).

", "GrantItem$dimensionKey": "

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.

", "RateCardItem$dimensionKey": "

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.

", "RateCardItem$price": "

Per unit price for the product dimension that’s used for calculating the amount to be charged.

", "RecurringPaymentTerm$billingPeriod": "

Defines the recurrence at which buyers are charged.

", "RecurringPaymentTerm$price": "

Amount charged to the buyer every billing period.

", "ScheduleItem$chargeAmount": "

The price that the customer would pay on the scheduled date (chargeDate).

", "Selector$type": "

Category of selector.

", "Selector$value": "

Contract duration. This field supports the ISO 8601 format.

", "SupportTerm$refundPolicy": "

Free-text field about the refund policy description that will be shown to customers as is on the website and console.

", "ValidationExceptionField$message": "

See applicable actions.

", "ValidationExceptionField$name": "

The name of the field associated with the error.

", "ValidityTerm$agreementDuration": "

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.

" } }, "ByolPricingTerm": { "base": "

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.

", "refs": { "AcceptedTerm$byolPricingTerm": "

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.

" } }, "Catalog": { "base": null, "refs": { "SearchAgreementsInput$catalog": "

The catalog in which the agreement was created.

" } }, "ConfigurableUpfrontPricingTerm": { "base": "

Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.

", "refs": { "AcceptedTerm$configurableUpfrontPricingTerm": "

Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.

" } }, "ConfigurableUpfrontPricingTermConfiguration": { "base": "

Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.

", "refs": { "ConfigurableUpfrontPricingTerm$configuration": "

Additional parameters specified by the acceptor while accepting the term.

" } }, "ConfigurableUpfrontRateCardItem": { "base": "

Within the prepaid payment model defined under ConfigurableUpfrontPricingTerm, the RateCardItem defines all the various rate cards (including pricing and dimensions) that have been proposed.

", "refs": { "ConfigurableUpfrontRateCardList$member": null } }, "ConfigurableUpfrontRateCardList": { "base": null, "refs": { "ConfigurableUpfrontPricingTerm$rateCards": "

A rate card defines the per unit rates for product dimensions.

" } }, "Constraints": { "base": "

Defines limits on how the term can be configured by acceptors.

", "refs": { "ConfigurableUpfrontRateCardItem$constraints": "

Defines limits on how the term can be configured by acceptors.

" } }, "CurrencyCode": { "base": null, "refs": { "ConfigurableUpfrontPricingTerm$currencyCode": "

Defines the currency for the prices mentioned in the term.

", "EstimatedCharges$currencyCode": "

Defines the currency code for the charge.

", "FixedUpfrontPricingTerm$currencyCode": "

Defines the currency for the prices mentioned in this term.

", "PaymentScheduleTerm$currencyCode": "

Defines the currency for the prices mentioned in the term.

", "RecurringPaymentTerm$currencyCode": "

Defines the currency for the prices mentioned in this term.

", "UsageBasedPricingTerm$currencyCode": "

Defines the currency for the prices mentioned in the term.

" } }, "DescribeAgreementInput": { "base": null, "refs": { } }, "DescribeAgreementOutput": { "base": null, "refs": { } }, "Dimension": { "base": "

Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.

", "refs": { "DimensionList$member": null } }, "DimensionList": { "base": null, "refs": { "ConfigurableUpfrontPricingTermConfiguration$dimensions": "

Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.

" } }, "DocumentItem": { "base": "

Includes the list of references to legal resources proposed by the proposer to the acceptor. Each DocumentItem refers to an individual reference.

", "refs": { "DocumentList$member": null } }, "DocumentList": { "base": null, "refs": { "LegalTerm$documents": "

List of references to legal resources proposed to the buyers. An example is the EULA.

" } }, "EstimatedCharges": { "base": "

Estimated cost of the agreement.

", "refs": { "DescribeAgreementOutput$estimatedCharges": "

The estimated cost of the agreement.

" } }, "ExceptionMessage": { "base": null, "refs": { "AccessDeniedException$message": null, "InternalServerException$message": null, "ResourceNotFoundException$message": null, "ThrottlingException$message": null, "ValidationException$message": null } }, "Filter": { "base": "

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.

", "refs": { "FilterList$member": null } }, "FilterList": { "base": null, "refs": { "SearchAgreementsInput$filters": "

The filter name and value pair used to return a specific list of results.

The following filters are supported:

" } }, "FilterName": { "base": null, "refs": { "Filter$name": "

The name of the filter.

" } }, "FilterValue": { "base": null, "refs": { "FilterValueList$member": null } }, "FilterValueList": { "base": null, "refs": { "Filter$values": "

The filter value.

" } }, "FixedUpfrontPricingTerm": { "base": "

Defines a prepaid pricing model where the customers are charged a fixed upfront amount.

", "refs": { "AcceptedTerm$fixedUpfrontPricingTerm": "

Defines a pre-paid pricing model where the customers are charged a fixed upfront amount.

" } }, "FreeTrialPricingTerm": { "base": "

Defines a short-term free pricing model where the buyers aren’t charged anything within a specified limit.

", "refs": { "AcceptedTerm$freeTrialPricingTerm": "

Defines a short-term free pricing model where the buyers aren’t charged anything within a specified limit.

" } }, "GetAgreementTermsInput": { "base": null, "refs": { } }, "GetAgreementTermsOutput": { "base": null, "refs": { } }, "GrantItem": { "base": "

Entitlements granted to the acceptor of fixed upfront as part of agreement execution.

", "refs": { "GrantList$member": null } }, "GrantList": { "base": null, "refs": { "FixedUpfrontPricingTerm$grants": "

Entitlements granted to the acceptor of fixed upfront as part of agreement execution.

", "FreeTrialPricingTerm$grants": "

Entitlements granted to the acceptor of a free trial as part of an agreement execution.

" } }, "InternalServerException": { "base": "

Unexpected error during processing of request.

", "refs": { } }, "LegalTerm": { "base": "

Defines the list of text agreements proposed to the acceptors. An example is the end user license agreement (EULA).

", "refs": { "AcceptedTerm$legalTerm": "

Defines the list of text agreements proposed to the acceptors. An example is the end user license agreement (EULA).

" } }, "MaxResults": { "base": null, "refs": { "GetAgreementTermsInput$maxResults": "

The maximum number of agreements to return in the response.

", "SearchAgreementsInput$maxResults": "

The maximum number of agreements to return in the response.

" } }, "NextToken": { "base": null, "refs": { "GetAgreementTermsInput$nextToken": "

A token to specify where to start pagination

", "GetAgreementTermsOutput$nextToken": "

A token to specify where to start pagination

", "SearchAgreementsInput$nextToken": "

A token to specify where to start pagination.

", "SearchAgreementsOutput$nextToken": "

The token used for pagination. The field is null if there are no more results.

" } }, "OfferId": { "base": null, "refs": { "ProposalSummary$offerId": "

The unique identifier of the offer in AWS Marketplace.

" } }, "PaymentScheduleTerm": { "base": "

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.

", "refs": { "AcceptedTerm$paymentScheduleTerm": "

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.

" } }, "PositiveIntegerWithDefaultValueOne": { "base": null, "refs": { "GrantItem$maxQuantity": "

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.

" } }, "ProposalSummary": { "base": "

A summary of the proposal received from the proposer.

", "refs": { "AgreementViewSummary$proposalSummary": "

A summary of the proposal

", "DescribeAgreementOutput$proposalSummary": "

A summary of the proposal received from the proposer.

" } }, "Proposer": { "base": "

Details of the party proposing the agreement terms,. This is commonly the seller for PurchaseAgreement.

", "refs": { "AgreementViewSummary$proposer": "

Details of the party proposing the agreement terms, most commonly the seller for PurchaseAgreement.

", "DescribeAgreementOutput$proposer": "

The details of the party proposing the agreement terms. This is commonly the seller for PurchaseAgreement.

" } }, "RateCardItem": { "base": "

Defines the per unit rates for each individual product dimension.

", "refs": { "RateCardList$member": null } }, "RateCardList": { "base": null, "refs": { "ConfigurableUpfrontRateCardItem$rateCard": "

Defines the per unit rates for product dimensions.

", "UsageBasedRateCardItem$rateCard": "

Defines the per unit rates for product dimensions.

" } }, "RecurringPaymentTerm": { "base": "

Defines a pricing model where customers are charged a fixed recurring price at the end of each billing period.

", "refs": { "AcceptedTerm$recurringPaymentTerm": "

Defines a pricing model where customers are charged a fixed recurring price at the end of each billing period.

" } }, "RenewalTerm": { "base": "

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. The 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.

", "refs": { "AcceptedTerm$renewalTerm": "

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.

" } }, "RenewalTermConfiguration": { "base": "

Additional parameters specified by the acceptor while accepting the term.

", "refs": { "RenewalTerm$configuration": "

Additional parameters specified by the acceptor while accepting the term.

" } }, "RequestId": { "base": null, "refs": { "AccessDeniedException$requestId": "

The unique identifier for the error.

", "InternalServerException$requestId": "

The unique identifier for the error.

", "ResourceNotFoundException$requestId": "

The unique identifier for the error.

", "ThrottlingException$requestId": "

The unique identifier for the error.

", "ValidationException$requestId": "

The unique identifier associated with the error.

" } }, "Resource": { "base": "

The list of resources involved in the agreement.

", "refs": { "Resources$member": null } }, "ResourceId": { "base": null, "refs": { "AgreementViewSummary$agreementId": "

The unique identifier of the agreement.

", "DescribeAgreementInput$agreementId": "

The unique identifier of the agreement.

", "DescribeAgreementOutput$agreementId": "

The unique identifier of the agreement.

", "GetAgreementTermsInput$agreementId": "

The unique identifier of the agreement.

", "Resource$id": "

The unique identifier of the resource.

We mention the term resource, which is most commonly a product, so a resourceId is also a productId.

", "ResourceNotFoundException$resourceId": "

The unique identifier for the resource.

" } }, "ResourceNotFoundException": { "base": "

Request references a resource which does not exist.

", "refs": { } }, "ResourceType": { "base": null, "refs": { "ResourceNotFoundException$resourceType": "

The type of resource.

" } }, "Resources": { "base": null, "refs": { "ProposalSummary$resources": "

The list of resources involved in the agreement.

" } }, "ScheduleItem": { "base": "

An individual installment of the payment that includes the date and amount of the charge.

", "refs": { "ScheduleList$member": null } }, "ScheduleList": { "base": null, "refs": { "PaymentScheduleTerm$schedule": "

List of the payment schedule where each element defines one installment of payment. It contains the information necessary for calculating the price.

" } }, "SearchAgreementsInput": { "base": null, "refs": { } }, "SearchAgreementsOutput": { "base": null, "refs": { } }, "Selector": { "base": "

Differentiates between the mutually exclusive rate cards in the same pricing term to be selected by the buyer.

", "refs": { "ConfigurableUpfrontRateCardItem$selector": "

Differentiates between the mutually exclusive rate cards in the same pricing term to be selected by the buyer.

" } }, "Sort": { "base": "

An object that contains the SortBy and SortOrder attributes.

", "refs": { "SearchAgreementsInput$sort": "

An object that contains the SortBy and SortOrder attributes.

" } }, "SortBy": { "base": null, "refs": { "Sort$sortBy": "

The attribute on which the data is grouped, which can be by StartTime and EndTime. The default value is EndTime.

" } }, "SortOrder": { "base": null, "refs": { "Sort$sortOrder": "

The sorting order, which can be ASCENDING or DESCENDING. The default value is DESCENDING.

" } }, "SupportTerm": { "base": "

Defines the customer support available for the acceptors when they purchase the software.

", "refs": { "AcceptedTerm$supportTerm": "

Defines the customer support available for the acceptors when they purchase the software.

" } }, "ThrottlingException": { "base": "

Request was denied due to request throttling.

", "refs": { } }, "Timestamp": { "base": null, "refs": { "AgreementViewSummary$acceptanceTime": "

The date and time that the agreement was accepted.

", "AgreementViewSummary$endTime": "

The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.

", "AgreementViewSummary$startTime": "

The date and time when the agreement starts.

", "DescribeAgreementOutput$acceptanceTime": "

The date and time the offer was accepted or the agreement was created.

AcceptanceTime and StartTime can differ for future dated agreements (FDAs).

", "DescribeAgreementOutput$endTime": "

The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.

", "DescribeAgreementOutput$startTime": "

The date and time when the agreement starts.

", "ScheduleItem$chargeDate": "

The date that the customer would pay the price defined in this payment schedule term. Invoices are generated on the date provided.

", "ValidityTerm$agreementEndDate": "

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.

", "ValidityTerm$agreementStartDate": "

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.

" } }, "UnversionedTermType": { "base": null, "refs": { "ByolPricingTerm$type": "

Type of the term being updated.

", "ConfigurableUpfrontPricingTerm$type": "

Category of selector.

", "FixedUpfrontPricingTerm$type": "

Category of the term being updated.

", "FreeTrialPricingTerm$type": "

Category of the term.

", "LegalTerm$type": "

Category of the term being updated.

", "PaymentScheduleTerm$type": "

Type of the term.

", "RecurringPaymentTerm$type": "

Type of the term being updated.

", "RenewalTerm$type": "

Category of the term being updated.

", "SupportTerm$type": "

Category of the term being updated.

", "UsageBasedPricingTerm$type": "

Category of the term.

", "ValidityTerm$type": "

Category of the term being updated.

" } }, "UsageBasedPricingTerm": { "base": "

Defines a usage-based pricing model (typically, pay-as-you-go pricing), where the customers are charged based on product usage.

", "refs": { "AcceptedTerm$usageBasedPricingTerm": "

Defines a usage-based pricing model (typically, pay-as-you-go pricing), where the customers are charged based on product usage.

" } }, "UsageBasedRateCardItem": { "base": "

Within the pay-as-you-go model defined under UsageBasedPricingTerm, the UsageBasedRateCardItem defines an individual rate for a product dimension.

", "refs": { "UsageBasedRateCardList$member": null } }, "UsageBasedRateCardList": { "base": null, "refs": { "UsageBasedPricingTerm$rateCards": "

List of rate cards.

" } }, "ValidationException": { "base": "

The input fails to satisfy the constraints specified by the service.

", "refs": { } }, "ValidationExceptionField": { "base": "

The input fails to satisfy the constraints specified by the service.

", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$fields": "

The fields associated with the error.

" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$reason": "

The reason associated with the error.

" } }, "ValidityTerm": { "base": "

Defines the conditions that will keep an agreement created from this offer valid.

", "refs": { "AcceptedTerm$validityTerm": "

Defines the conditions that will keep an agreement created from this offer valid.

" } }, "ZeroValueInteger": { "base": null, "refs": { "Dimension$dimensionValue": "

The number of units of the dimension the acceptor has purchased.

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.

" } } } }