Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1425213171.1 KB

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 <code>AcceptAgreementRequest</code> with the returned <code>agreementRequestId</code> to finalize the agreement.

post/#X-Amz-Target=AWSMPCommerceService_v20200301.CreateAgreementRequest

Headers

X-Amz-Target'AWSMPCommerceService_v20200301.CreateAgreementRequest' required

Request body

clientTokenstring

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

intent'NEW' | 'AMEND' | 'REPLACE' required
<p>The purpose and desired outcome of the agreement request. This is a required parameter that determines how the agreement request is processed.</p> <ul> <li> <p> <code>NEW</code> – Creates a new agreement for terms in the request.</p> </li> <li> <p> <code>AMEND</code> – Modifies an existing agreement with terms that are accepted in the request.</p> </li> <li> <p> <code>REPLACE</code> – Creates a new agreement with accepted terms and replaces the existing agreement.</p> </li> </ul>
sourceAgreementIdentifierstring
<p>The agreement's identifier that the request acts upon.</p> <important> <p> This parameter is required for all non-<code>NEW</code> intents (i.e., <code>AMEND</code> or <code>REPLACE</code>). Don't provide this parameter if the intent is <code>NEW</code>. </p> </important>
agreementProposalIdentifierstring
<p>The agreement proposal signed by the proposer. The proposal includes the requested resources and the terms that outline an agreement outcome.</p> <important> <p> This parameter is required if the intent is not <code>AMEND</code>.</p> </important>

Response

Success

agreementRequestIdstring

The unique identifier of the agreement request created. Use this identifier with <code>AcceptAgreementRequest</code> to accept the agreement.