Using the AWS Marketplace Agreement API
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 buyers and sellers manage their agreements, including listing, searching, and filtering agreements.
Key concepts
The following table describes key concepts used in the AWS Marketplace Agreement API.
| Concept | Description |
|---|---|
| Acceptor | The party that accepts all or a subset of the terms extended by the proposer in an agreement. For most common use cases, acceptors are the buyers of the product. |
| Agreement | A document that binds two parties, including the proposer (commonly, the seller/ISV or channel partner) and the acceptor (commonly, the buyer) and defines the terms and conditions applicable between them. |
| Agreement Cancellation Request | A request initiated by the seller (proposer) to cancel an active agreement. The buyer (acceptor) can accept or reject the cancellation request. If accepted, the agreement cancellation workflow executes asynchronously and the agreement status changes to cancelled. If rejected, the agreement remains active and the seller can submit a new cancellation request. |
| Agreement Proposal | Entity referring to the set of terms/offer proposed by the seller/proposer. |
| Agreement Request | Entity referring to resource created as a result of customer action, outlining the agreement creation/modification parameters, request lifecycle and estimated outcome upon acceptance of the request. |
| Billable dimension | Elements related to how the product is priced. For example, Amazon Elastic Compute Cloud (Amazon EC2) instances for Amazon Machine Image (AMI) products, or premium compared to read-only users for software as a service (SaaS) products. |
| Channel Partners (CP) | Organizations that are authorized by the product owner (ISV) to resell their products on their behalf on AWS Marketplace. |
| Independent Software Vendors (ISVs) | Sellers that list and manage their own products in AWS Marketplace. |
| Intent | Intent represents the motivation the buyer has while creating the Agreement. Currently supported intents are New, Amend, and Replace during agreement creation flow. |
| Payment Request | A request initiated by the seller (proposer) for payment associated with an agreement. The buyer (acceptor) can accept or reject the payment request. |
| Proposer | The party that extends the initial set of terms in an agreement, most commonly by using an offer. |
| Purchase Orders | Organizations require buyers to use purchase orders to buy from approved suppliers, track what they buy, and ensure spending is forecasted, budgeted, approved, and assigned to the responsible cost center(s). |
| Resource | A unit or resource that sellers intend to sell in AWS Marketplace, often referred to as a base product. A base product is not complete for buyer consumption until product information, deployment attributes, and billing information are added. A product describes the product information, software deployment attributes, and billing mechanism of the listing that a seller intends to sell. The product must be paired with an offer to become a transactable unit that can be sold and be used by buyers in AWS Marketplace. |
| Term | A unit within an agreement that governs how an agreement is enforced (for example, pricing). |
Endpoint
You can access the AWS Marketplace Agreement Service with the following endpoints:
| Endpoint | Region | Supported IP Protocols |
|---|---|---|
agreement-marketplace.us-east-1.api.aws |
US East (N. Virginia) | IPv4, IPv6 |
Permissions
The Agreements API uses standard AWS Signature Version 4 (SigV4) authentication. You must have valid AWS credentials and the appropriate IAM permissions to call the API. For details, see Access control for the AWS Marketplace Agreement API.
