Allows 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.
" }, "BatchCreateBillingAdjustmentRequest":{ "name":"BatchCreateBillingAdjustmentRequest", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchCreateBillingAdjustmentRequestInput"}, "output":{"shape":"BatchCreateBillingAdjustmentRequestOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"Allows 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.
" }, "CancelAgreementCancellationRequest":{ "name":"CancelAgreementCancellationRequest", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelAgreementCancellationRequestInput"}, "output":{"shape":"CancelAgreementCancellationRequestOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"Allows 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.
" }, "GetAgreementCancellationRequest":{ "name":"GetAgreementCancellationRequest", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAgreementCancellationRequestInput"}, "output":{"shape":"GetAgreementCancellationRequestOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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.
" }, "GetAgreementEntitlements":{ "name":"GetAgreementEntitlements", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAgreementEntitlementsInput"}, "output":{"shape":"GetAgreementEntitlementsOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Obtains details about the entitlements of an agreement.
", "readonly":true }, "GetAgreementPaymentRequest":{ "name":"GetAgreementPaymentRequest", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAgreementPaymentRequestInput"}, "output":{"shape":"GetAgreementPaymentRequestOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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 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.
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.
" }, "ListAgreementCancellationRequests":{ "name":"ListAgreementCancellationRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAgreementCancellationRequestsInput"}, "output":{"shape":"ListAgreementCancellationRequestsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Lists 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.
", "readonly":true }, "ListAgreementInvoiceLineItems":{ "name":"ListAgreementInvoiceLineItems", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAgreementInvoiceLineItemsInput"}, "output":{"shape":"ListAgreementInvoiceLineItemsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"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.
" }, "RejectAgreementCancellationRequest":{ "name":"RejectAgreementCancellationRequest", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RejectAgreementCancellationRequestInput"}, "output":{"shape":"RejectAgreementCancellationRequestOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"Allows 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:
AgreementType
AgreementType + EndTime
AgreementType + ResourceType
AgreementType + ResourceType + EndTime
AgreementType + ResourceType + Status
AgreementType + ResourceType + Status + EndTime
AgreementType + ResourceIdentifier
AgreementType + ResourceIdentifier + EndTime
AgreementType + ResourceIdentifier + Status
AgreementType + ResourceIdentifier + Status + EndTime
AgreementType + AcceptorAccountId
AgreementType + AcceptorAccountId + EndTime
AgreementType + AcceptorAccountId + Status
AgreementType + AcceptorAccountId + Status + EndTime
AgreementType + AcceptorAccountId + OfferId
AgreementType + AcceptorAccountId + OfferId + Status
AgreementType + AcceptorAccountId + OfferId + EndTime
AgreementType + AcceptorAccountId + OfferId + Status + EndTime
AgreementType + AcceptorAccountId + ResourceIdentifier
AgreementType + AcceptorAccountId + ResourceIdentifier + Status
AgreementType + AcceptorAccountId + ResourceIdentifier + EndTime
AgreementType + AcceptorAccountId + ResourceIdentifier + Status + EndTime
AgreementType + AcceptorAccountId + ResourceType
AgreementType + AcceptorAccountId + ResourceType + EndTime
AgreementType + AcceptorAccountId + ResourceType + Status
AgreementType + AcceptorAccountId + ResourceType + Status + EndTime
AgreementType + Status
AgreementType + Status + EndTime
AgreementType + OfferId
AgreementType + OfferId + EndTime
AgreementType + OfferId + Status
AgreementType + OfferId + Status + EndTime
AgreementType + OfferSetId
AgreementType + OfferSetId + EndTime
AgreementType + OfferSetId + Status
AgreementType + 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:
AgreementType
AgreementType + Status
AgreementType + EndTime
AgreementType + Status + EndTime
AgreementType + ResourceIdentifier
AgreementType + ResourceIdentifier + EndTime
AgreementType + ResourceIdentifier + Status
AgreementType + ResourceIdentifier + Status + EndTime
AgreementType + ResourceType
AgreementType + ResourceType + EndTime
AgreementType + OfferId
AgreementType + OfferId + EndTime
AgreementType + OfferId + Status
AgreementType + OfferId + Status + EndTime
AgreementType + OfferSetId
AgreementType + OfferSetId + EndTime
AgreementType + OfferSetId + Status
AgreementType + 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.
" } }, "shapes":{ "AWSAccountId":{ "type":"string", "max":12, "min":12, "pattern":"[0-9]+" }, "AcceptAgreementCancellationRequestInput":{ "type":"structure", "required":[ "agreementId", "agreementCancellationRequestId" ], "members":{ "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with the cancellation request.
" }, "agreementCancellationRequestId":{ "shape":"AgreementCancellationRequestId", "documentation":"The unique identifier of the cancellation request to accept.
" } } }, "AcceptAgreementCancellationRequestOutput":{ "type":"structure", "members":{ "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with this cancellation request.
" }, "agreementCancellationRequestId":{ "shape":"AgreementCancellationRequestId", "documentation":"The unique identifier of the accepted cancellation request.
" }, "status":{ "shape":"AgreementCancellationRequestStatus", "documentation":"The updated status of the cancellation request, which is APPROVED.
The original reason code provided when the cancellation request was created.
" }, "description":{ "shape":"AgreementCancellationRequestDescription", "documentation":"The detailed description of the cancellation reason, if provided.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time when the cancellation request was originally created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The date and time when the cancellation request was accepted.
" } } }, "AcceptAgreementPaymentRequestInput":{ "type":"structure", "required":[ "paymentRequestId", "agreementId" ], "members":{ "paymentRequestId":{ "shape":"PaymentRequestId", "documentation":"The unique identifier of the payment request to accept.
" }, "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with the payment request.
" }, "purchaseOrderReference":{ "shape":"PurchaseOrderReference", "documentation":"An optional purchase order reference that buyers can provide to associate the payment request with their internal purchase order system.
" } } }, "AcceptAgreementPaymentRequestOutput":{ "type":"structure", "members":{ "paymentRequestId":{ "shape":"PaymentRequestId", "documentation":"The unique identifier of the accepted payment request.
" }, "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with this payment request.
" }, "status":{ "shape":"PaymentRequestStatus", "documentation":"The updated status of the payment request, which is APPROVED.
The descriptive name of the payment request.
" }, "description":{ "shape":"PaymentRequestDescription", "documentation":"The detailed description of the payment request, if provided.
" }, "chargeAmount":{ "shape":"PositiveAmountUpto8Decimals", "documentation":"The amount that was approved to be charged.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"The currency code for the charge amount.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time when the payment request was originally created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The date and time when the payment request was accepted.
" } } }, "AcceptAgreementRequestInput":{ "type":"structure", "required":["agreementRequestId"], "members":{ "agreementRequestId":{ "shape":"AgreementRequestId", "documentation":"The unique identifier of the agreement request.
" }, "purchaseOrders":{ "shape":"PurchaseOrders", "documentation":"A list of purchase orders associated with accepting a marketplace agreement request.
" } } }, "AcceptAgreementRequestOutput":{ "type":"structure", "members":{ "agreementId":{ "shape":"ResourceId", "documentation":"The unique identifier of the agreement created or modified by accepting the agreement request.
" } } }, "AcceptedTerm":{ "type":"structure", "members":{ "legalTerm":{ "shape":"LegalTerm", "documentation":"Defines the list of text agreements proposed to the acceptors. An example is the end user license agreement (EULA).
" }, "supportTerm":{ "shape":"SupportTerm", "documentation":"Defines the customer support available for the acceptors when they purchase the software.
" }, "renewalTerm":{ "shape":"RenewalTerm", "documentation":"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.
Defines a usage-based pricing model (typically, pay-as-you-go pricing), where the customers are charged based on product usage.
" }, "configurableUpfrontPricingTerm":{ "shape":"ConfigurableUpfrontPricingTerm", "documentation":"Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.
" }, "byolPricingTerm":{ "shape":"ByolPricingTerm", "documentation":"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.
" }, "recurringPaymentTerm":{ "shape":"RecurringPaymentTerm", "documentation":"Defines a pricing model where customers are charged a fixed recurring price at the end of each billing period.
" }, "validityTerm":{ "shape":"ValidityTerm", "documentation":"Defines the conditions that will keep an agreement created from this offer valid.
" }, "paymentScheduleTerm":{ "shape":"PaymentScheduleTerm", "documentation":"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.
" }, "freeTrialPricingTerm":{ "shape":"FreeTrialPricingTerm", "documentation":"Defines a short-term free pricing model where the buyers aren’t charged anything within a specified limit.
" }, "fixedUpfrontPricingTerm":{ "shape":"FixedUpfrontPricingTerm", "documentation":"Defines a pre-paid pricing model where the customers are charged a fixed upfront amount.
" }, "variablePaymentTerm":{ "shape":"VariablePaymentTerm", "documentation":"Defines a payment model where sellers can submit variable payment requests up to a maximum charge amount, with configurable approval strategies and expiration timelines.
" } }, "documentation":"A subset of terms proposed by the proposer, which have been accepted by the acceptor as part of agreement creation.
", "union":true }, "AcceptedTermList":{ "type":"list", "member":{"shape":"AcceptedTerm"} }, "Acceptor":{ "type":"structure", "members":{ "accountId":{ "shape":"AWSAccountId", "documentation":"The AWS account ID of the acceptor.
" } }, "documentation":"The details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.
The unique identifier for the error.
" }, "message":{ "shape":"ExceptionMessage", "documentation":"Description of the error.
" }, "reason":{ "shape":"AccessDeniedExceptionReason", "documentation":"The reason for the access denied exception.
" } }, "documentation":"User does not have sufficient access to perform this action.
", "exception":true }, "AccessDeniedExceptionReason":{ "type":"string", "enum":[ "INVALID_ACCOUNT_STATE", "DENIED_BY_PRIVATE_MARKETPLACE_POLICY", "FAILED_KYC_COMPLIANCE", "MISSING_MFA", "INVALID_ACCESS" ] }, "AgreementCancellationRequestCancellationReason":{ "type":"string", "max":2000, "min":1, "sensitive":true }, "AgreementCancellationRequestDescription":{ "type":"string", "max":2000, "min":1, "sensitive":true }, "AgreementCancellationRequestId":{ "type":"string", "max":64, "min":1, "pattern":"acr-[a-zA-Z0-9]+" }, "AgreementCancellationRequestReasonCode":{ "type":"string", "enum":[ "INCORRECT_TERMS_ACCEPTED", "REPLACING_AGREEMENT", "TEST_AGREEMENT", "ALTERNATIVE_PROCUREMENT_CHANNEL", "PRODUCT_DISCONTINUED", "UNINTENDED_RENEWAL", "BUYER_DISSATISFACTION", "OTHER" ] }, "AgreementCancellationRequestRejectionReason":{ "type":"string", "max":2000, "min":1, "sensitive":true }, "AgreementCancellationRequestStatus":{ "type":"string", "enum":[ "PENDING_APPROVAL", "APPROVED", "REJECTED", "CANCELLED", "VALIDATION_FAILED" ] }, "AgreementCancellationRequestStatusMessage":{ "type":"string", "max":2000, "min":1 }, "AgreementCancellationRequestSummary":{ "type":"structure", "members":{ "agreementCancellationRequestId":{ "shape":"AgreementCancellationRequestId", "documentation":"The unique identifier of the cancellation request.
" }, "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with this cancellation request.
" }, "status":{ "shape":"AgreementCancellationRequestStatus", "documentation":"The current status of the cancellation request. Possible values include PENDING_APPROVAL, APPROVED, REJECTED, CANCELLED, and VALIDATION_FAILED.
The reason code provided for the cancellation.
" }, "agreementType":{ "shape":"AgreementType", "documentation":"The type of agreement.
" }, "catalog":{ "shape":"Catalog", "documentation":"The catalog in which the agreement was created.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time when the cancellation request was created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The date and time when the cancellation request was last updated.
" } }, "documentation":"Summary view of an agreement cancellation request.
" }, "AgreementCancellationRequestSummaryList":{ "type":"list", "member":{"shape":"AgreementCancellationRequestSummary"} }, "AgreementEntitlement":{ "type":"structure", "members":{ "resource":{ "shape":"Resource", "documentation":"The resource that the entitlement is provisioned to, such as a product.
" }, "type":{ "shape":"EntitlementType", "documentation":"The type of entitlement.
" }, "registrationToken":{ "shape":"RegistrationToken", "documentation":"A short-lived token required by acceptors to register their account with the product provider. The token is only valid for 30 minutes after creation and is only applicable for purchase agreements.
" }, "status":{ "shape":"AgreementEntitlementStatus", "documentation":"The current state of an entitlement.
" }, "statusReasonCode":{ "shape":"AgreementEntitlementStatusReasonCode", "documentation":"Provides more information about the status of an entitlement.
" }, "licenseArn":{ "shape":"AwsArn", "documentation":"The Amazon Resource Name (ARN) of the AWS License Manager license associated with the entitlement.
" } }, "documentation":"Represents an entitlement associated with an agreement, including the provisioning status, resource, and type.
" }, "AgreementEntitlementList":{ "type":"list", "member":{"shape":"AgreementEntitlement"} }, "AgreementEntitlementStatus":{ "type":"string", "enum":[ "PROVISIONED", "SCHEDULED", "PENDING", "FAILED", "DEPROVISIONED" ] }, "AgreementEntitlementStatusReasonCode":{ "type":"string", "enum":[ "PROVISIONING_IN_PROGRESS", "FUTURE_START_DATE", "INVALID_PAYMENT_INSTRUMENT", "INCOMPATIBLE_CURRENCY", "ACCOUNT_SUSPENDED", "UNSUPPORTED_OPERATION", "AGREEMENT_INACTIVE", "AGREEMENT_ACTIVE", "PRODUCT_RESTRICTED" ] }, "AgreementId":{ "type":"string", "max":64, "min":1, "pattern":"[A-Za-z0-9_/-]+" }, "AgreementInvoiceLineItemGroupSummaries":{ "type":"list", "member":{"shape":"AgreementInvoiceLineItemGroupSummary"} }, "AgreementInvoiceLineItemGroupSummary":{ "type":"structure", "members":{ "agreementId":{ "shape":"ResourceId", "documentation":"The unique identifier of the agreement.
" }, "invoiceId":{ "shape":"ResourceId", "documentation":"The identifier of the invoice for this group.
" }, "pricingCurrencyAmount":{ "shape":"PricingCurrencyAmount", "documentation":"Monetary amounts for this invoice group.
" }, "invoiceBillingPeriod":{ "shape":"InvoiceBillingPeriod", "documentation":"The billing period associated with this group.
" }, "issuedTime":{ "shape":"Timestamp", "documentation":"The timestamp when the invoice containing this group was created.
" }, "invoiceType":{ "shape":"InvoiceType", "documentation":"The type of invoice. Valid values are INVOICE and CREDIT_MEMO.
The entity that issues the invoice.
" } }, "documentation":"A summary of grouped billing data for an agreement invoice line item.
" }, "AgreementProposalId":{ "type":"string", "max":64, "min":1, "pattern":"(at-|ap-)[A-Za-z0-9]+" }, "AgreementRequestId":{ "type":"string", "max":64, "min":1, "pattern":"ar-[A-Za-z0-9]+" }, "AgreementResourceType":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z]+" }, "AgreementStatus":{ "type":"string", "enum":[ "ACTIVE", "ARCHIVED", "CANCELLED", "EXPIRED", "RENEWED", "REPLACED", "ROLLED_BACK", "SUPERSEDED", "TERMINATED" ] }, "AgreementType":{ "type":"string", "max":64, "min":1, "pattern":"[A-Za-z]+" }, "AgreementViewSummary":{ "type":"structure", "members":{ "agreementId":{ "shape":"ResourceId", "documentation":"The unique identifier of the agreement.
" }, "acceptanceTime":{ "shape":"Timestamp", "documentation":"The date and time that the agreement was accepted.
" }, "startTime":{ "shape":"Timestamp", "documentation":"The date and time when the agreement starts.
" }, "endTime":{ "shape":"Timestamp", "documentation":"The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.
The type of agreement.
" }, "acceptor":{ "shape":"Acceptor", "documentation":"Details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.
Details of the party proposing the agreement terms, most commonly the seller for PurchaseAgreement.
A summary of the proposal
" }, "status":{ "shape":"AgreementStatus", "documentation":"The current status of the agreement.
" } }, "documentation":"A summary of the agreement, including top-level attributes (for example, the agreement ID, proposer, and acceptor).
" }, "AgreementViewSummaryList":{ "type":"list", "member":{"shape":"AgreementViewSummary"} }, "AwsArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:aws[a-zA-Z-]*:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}" }, "BatchCreateBillingAdjustmentError":{ "type":"structure", "required":[ "code", "message", "clientToken" ], "members":{ "code":{ "shape":"BillingAdjustmentErrorCode", "documentation":"The error code indicating the reason for failure.
" }, "message":{ "shape":"String", "documentation":"A human-readable message describing the error.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"The client token of the request entry that failed.
" } }, "documentation":"An error for a billing adjustment request entry that failed validation.
" }, "BatchCreateBillingAdjustmentErrorList":{ "type":"list", "member":{"shape":"BatchCreateBillingAdjustmentError"} }, "BatchCreateBillingAdjustmentItem":{ "type":"structure", "required":[ "billingAdjustmentRequestId", "clientToken" ], "members":{ "billingAdjustmentRequestId":{ "shape":"BillingAdjustmentRequestId", "documentation":"The unique identifier of the created billing adjustment request.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"The client token provided in the corresponding request entry.
" } }, "documentation":"A successfully created billing adjustment request item.
" }, "BatchCreateBillingAdjustmentItemList":{ "type":"list", "member":{"shape":"BatchCreateBillingAdjustmentItem"} }, "BatchCreateBillingAdjustmentRequestEntry":{ "type":"structure", "required":[ "agreementId", "originalInvoiceId", "adjustmentAmount", "currencyCode", "adjustmentReasonCode", "clientToken" ], "members":{ "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with the invoice.
" }, "originalInvoiceId":{ "shape":"InvoiceId", "documentation":"The identifier of the original invoice to adjust.
" }, "adjustmentAmount":{ "shape":"PositiveAmountUpto8Decimals", "documentation":"The adjustment amount as a string representation of a decimal number in the currency of the invoice.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"The 3-letter ISO 4217 currency code for the adjustment amount. Must match the currency code of the offer associated with the agreement (e.g., USD).
The reason code for the billing adjustment.
" }, "description":{ "shape":"BillingAdjustmentDescription", "documentation":"An optional detailed description of the adjustment reason.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" } }, "documentation":"An individual entry in a batch billing adjustment request, specifying the invoice and adjustment details.
" }, "BatchCreateBillingAdjustmentRequestEntryList":{ "type":"list", "member":{"shape":"BatchCreateBillingAdjustmentRequestEntry"} }, "BatchCreateBillingAdjustmentRequestInput":{ "type":"structure", "required":["billingAdjustmentRequestEntries"], "members":{ "billingAdjustmentRequestEntries":{ "shape":"BatchCreateBillingAdjustmentRequestEntryList", "documentation":"A list of billing adjustment request entries. Each entry specifies the invoice and adjustment details.
" } } }, "BatchCreateBillingAdjustmentRequestOutput":{ "type":"structure", "required":[ "items", "errors" ], "members":{ "items":{ "shape":"BatchCreateBillingAdjustmentItemList", "documentation":"A list of successfully created billing adjustment items, each containing the billingAdjustmentRequestId and clientToken.
A list of errors for entries that failed validation, each containing the clientToken, error code, and message.
The unique identifier of the billing adjustment request.
" }, "originalInvoiceId":{ "shape":"InvoiceId", "documentation":"The identifier of the original invoice being adjusted.
" }, "adjustmentAmount":{ "shape":"PositiveAmountUpto8Decimals", "documentation":"The adjustment amount as a string representation of a decimal number.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"The currency code for the adjustment amount.
" }, "status":{ "shape":"BillingAdjustmentStatus", "documentation":"The current status of the billing adjustment request.
" }, "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with this billing adjustment request.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time when the billing adjustment request was created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The date and time when the billing adjustment request was last updated.
" }, "agreementType":{ "shape":"AgreementType", "documentation":"The type of agreement.
" }, "catalog":{ "shape":"Catalog", "documentation":"The catalog in which the agreement was created.
" } }, "documentation":"Summary view of a billing adjustment request.
" }, "BillingAdjustmentSummaryList":{ "type":"list", "member":{"shape":"BillingAdjustmentSummary"} }, "Boolean":{ "type":"boolean", "box":true }, "BoundedString":{ "type":"string", "max":4096, "min":1, "pattern":"(.)+" }, "ByolPricingTerm":{ "type":"structure", "members":{ "type":{ "shape":"UnversionedTermType", "documentation":"Type of the term being updated.
" }, "id":{ "shape":"TermId", "documentation":"The unique identifier for the term.
" } }, "documentation":"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.
" }, "CancelAgreementCancellationRequestInput":{ "type":"structure", "required":[ "agreementId", "agreementCancellationRequestId", "cancellationReason" ], "members":{ "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with the cancellation request.
" }, "agreementCancellationRequestId":{ "shape":"AgreementCancellationRequestId", "documentation":"The unique identifier of the cancellation request to cancel.
" }, "cancellationReason":{ "shape":"AgreementCancellationRequestCancellationReason", "documentation":"A required message explaining why the cancellation request is being withdrawn (1-2000 characters).
" } } }, "CancelAgreementCancellationRequestOutput":{ "type":"structure", "members":{ "agreementCancellationRequestId":{ "shape":"AgreementCancellationRequestId", "documentation":"The unique identifier of the cancelled cancellation request.
" }, "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with this cancellation request.
" }, "reasonCode":{ "shape":"AgreementCancellationRequestReasonCode", "documentation":"The original reason code provided when the cancellation request was created.
" }, "description":{ "shape":"AgreementCancellationRequestDescription", "documentation":"The detailed description of the original cancellation reason, if provided.
" }, "status":{ "shape":"AgreementCancellationRequestStatus", "documentation":"The updated status of the cancellation request, which is CANCELLED.
A message providing additional context about the cancellation request status.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time when the cancellation request was originally created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The date and time when the cancellation request was cancelled.
" } } }, "CancelAgreementInput":{ "type":"structure", "required":["agreementId"], "members":{ "agreementId":{ "shape":"ResourceId", "documentation":"The unique identifier of the agreement.
" } } }, "CancelAgreementOutput":{ "type":"structure", "members":{} }, "CancelAgreementPaymentRequestInput":{ "type":"structure", "required":[ "paymentRequestId", "agreementId" ], "members":{ "paymentRequestId":{ "shape":"PaymentRequestId", "documentation":"The unique identifier of the payment request to cancel.
" }, "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with the payment request.
" } } }, "CancelAgreementPaymentRequestOutput":{ "type":"structure", "members":{ "paymentRequestId":{ "shape":"PaymentRequestId", "documentation":"The unique identifier of the cancelled payment request.
" }, "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with this payment request.
" }, "status":{ "shape":"PaymentRequestStatus", "documentation":"The updated status of the payment request, which is CANCELLED.
The descriptive name of the payment request.
" }, "description":{ "shape":"PaymentRequestDescription", "documentation":"The detailed description of the payment request, if provided.
" }, "chargeAmount":{ "shape":"PositiveAmountUpto8Decimals", "documentation":"The amount that was requested to be charged.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"The currency code for the charge amount.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time when the payment request was originally created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The date and time when the payment request was cancelled.
" } } }, "Catalog":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z0-9.-]+" }, "Charge":{ "type":"structure", "members":{ "id":{ "shape":"ResourceId", "documentation":"The unique identifier of the charge.
" }, "revision":{ "shape":"ChargeRevision", "documentation":"The revision number of the charge.
" }, "agreementId":{ "shape":"ResourceId", "documentation":"The unique identifier of the agreement that resulted in this charge.
" }, "agreementType":{ "shape":"AgreementType", "documentation":"The type of agreement that resulted in this charge (for example, PurchaseAgreement).
The purchase order reference associated with the charge, if any.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"The currency code for the charge amount.
" }, "amount":{ "shape":"BoundedString", "documentation":"The amount of the charge.
" }, "time":{ "shape":"Timestamp", "documentation":"The date and time when the charge will be incurred. This is available only when the charge date is known.
" } }, "documentation":"Represents a charge associated with an agreement, including amount, timing, and purchase order details.
" }, "ChargeId":{ "type":"string", "max":64, "min":1, "pattern":"ch-[a-zA-Z0-9]+" }, "ChargeRevision":{ "type":"long", "box":true, "min":1 }, "ChargeSummary":{ "type":"structure", "members":{ "currencyCode":{ "shape":"CurrencyCode", "documentation":"The three-letter currency code for all charges (e.g., USD).
" }, "newAgreementValue":{ "shape":"BoundedString", "documentation":"The total value of the agreement, which includes any amendments.
" }, "newAgreementValueAfterTax":{ "shape":"BoundedString", "documentation":"Expected new agreement value after estimated taxes are applied.
" }, "expectedCharges":{ "shape":"ExpectedChargeList", "documentation":"A list of expected charges for the agreement request.
" }, "estimatedTaxes":{ "shape":"EstimatedTaxes", "documentation":"Provides an aggregated view of estimated tax information for the agreement.
" }, "itemizedCharges":{ "shape":"ItemizedChargeList", "documentation":"An itemized list of charges for the agreement request.
" }, "invoicingEntity":{ "shape":"InvoicingEntity", "documentation":"The entity responsible for issuing the invoice.
" } }, "documentation":"The ChargeSummary provides a detailed breakdown of charges that are associated with an agreement request. This is applicable only when a request is created for a PurchaseAgreement.
Tax and invoicing fields (such as estimatedTaxes, amountAfterTax, newAgreementValueAfterTax, and invoicingEntity) are returned on a best-effort basis and do not cause the request to fail if unavailable.
A null tax amount can have two meanings:
Tax estimation was unavailable at the time of the request.
The charge timing is BILLING_PERIOD, so the charge amount is not determined at request time. In this case, the tax breakdown may still include the tax rate and type.
Category of selector.
" }, "id":{ "shape":"TermId", "documentation":"The unique identifier of the term.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"Defines the currency for the prices mentioned in the term.
" }, "rateCards":{ "shape":"ConfigurableUpfrontRateCardList", "documentation":"A rate card defines the per unit rates for product dimensions.
" }, "configuration":{ "shape":"ConfigurableUpfrontPricingTermConfiguration", "documentation":"Additional parameters specified by the acceptor while accepting the term.
" } }, "documentation":"Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.
" }, "ConfigurableUpfrontPricingTermConfiguration":{ "type":"structure", "required":[ "selectorValue", "dimensions" ], "members":{ "selectorValue":{ "shape":"BoundedString", "documentation":"Defines the length of time for which the particular pricing/dimension is being purchased by the acceptor.
" }, "dimensions":{ "shape":"DimensionList", "documentation":"Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.
" } }, "documentation":"Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.
" }, "ConfigurableUpfrontRateCardItem":{ "type":"structure", "members":{ "selector":{ "shape":"Selector", "documentation":"Differentiates between the mutually exclusive rate cards in the same pricing term to be selected by the buyer.
" }, "constraints":{ "shape":"Constraints", "documentation":"Defines limits on how the term can be configured by acceptors.
" }, "rateCard":{ "shape":"RateCardList", "documentation":"Defines the per unit rates for product dimensions.
" } }, "documentation":"Within the prepaid payment model defined under ConfigurableUpfrontPricingTerm, the RateCardItem defines all the various rate cards (including pricing and dimensions) that have been proposed.
The unique identifier for the error.
" }, "message":{ "shape":"ExceptionMessage", "documentation":"Description of the error.
" }, "resourceId":{ "shape":"ResourceId", "documentation":"The unique identifier of the resource involved in the conflict.
" }, "resourceType":{ "shape":"ResourceType", "documentation":"The type of the resource involved in the conflict.
" } }, "documentation":"Request was denied due to a resource conflict.
", "exception":true }, "Constraints":{ "type":"structure", "members":{ "multipleDimensionSelection":{ "shape":"BoundedString", "documentation":"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.
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.
Defines limits on how the term can be configured by acceptors.
" }, "CreateAgreementRequestInput":{ "type":"structure", "required":[ "intent", "requestedTerms" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "idempotencyToken":true }, "intent":{ "shape":"Intent", "documentation":"The purpose and desired outcome of the agreement request. This is a required parameter that determines how the agreement request is processed.
NEW – Creates a new agreement for terms in the request.
AMEND – Modifies an existing agreement with terms that are accepted in the request.
REPLACE – Creates a new agreement with accepted terms and replaces the existing agreement.
A list of terms that define what is being accepted as part of the agreement. Some terms require configuration.
" }, "sourceAgreementIdentifier":{ "shape":"ResourceId", "documentation":"The agreement's identifier that the request acts upon.
This parameter is required for all non-NEW intents (i.e., AMEND or REPLACE). Don't provide this parameter if the intent is NEW.
The agreement proposal signed by the proposer. The proposal includes the requested resources and the terms that outline an agreement outcome.
This parameter is required if the intent is not AMEND.
Configuration for tax estimation in the agreement request response.
" } } }, "CreateAgreementRequestOutput":{ "type":"structure", "members":{ "agreementRequestId":{ "shape":"AgreementRequestId", "documentation":"The unique identifier of the agreement request created. Use this identifier with AcceptAgreementRequest to accept the agreement.
Provides details of the charges associated with the agreement request. This is only applicable when a request is created for PurchaseAgreement.
The unique identifier of the agreement.
" } } }, "DescribeAgreementOutput":{ "type":"structure", "members":{ "agreementId":{ "shape":"ResourceId", "documentation":"The unique identifier of the agreement.
" }, "acceptor":{ "shape":"Acceptor", "documentation":"The details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.
The details of the party proposing the agreement terms. This is commonly the seller for PurchaseAgreement.
The date and time when the agreement starts.
" }, "endTime":{ "shape":"Timestamp", "documentation":"The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.
The date and time the offer was accepted or the agreement was created.
AcceptanceTime and StartTime can differ for future dated agreements (FDAs).
The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.
The estimated cost of the agreement.
" }, "proposalSummary":{ "shape":"ProposalSummary", "documentation":"A summary of the proposal received from the proposer.
" }, "status":{ "shape":"AgreementStatus", "documentation":"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.
TERMINATED – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).
The name of key value of the dimension.
" }, "dimensionValue":{ "shape":"ZeroValueInteger", "documentation":"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.
Defines the dimensions that the acceptor has purchased from the overall set of dimensions presented in the rate card.
" }, "DimensionList":{ "type":"list", "member":{"shape":"Dimension"}, "min":1 }, "DocumentItem":{ "type":"structure", "members":{ "type":{ "shape":"BoundedString", "documentation":"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.
A URL to the legal document for buyers to read. Required when Type is CustomEula.
Version of standard contracts provided by AWS Marketplace. Required when Type is StandardEula or StandardDsa.
Includes the list of references to legal resources proposed by the proposer to the acceptor. Each DocumentItem refers to an individual reference.
Defines the currency code for the charge.
" }, "agreementValue":{ "shape":"BoundedString", "documentation":"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.
Estimated cost of the agreement.
" }, "EstimatedTaxes":{ "type":"structure", "members":{ "breakdown":{ "shape":"TaxBreakdown", "documentation":"A list of tax breakdown information.
" }, "totalAmount":{ "shape":"BoundedString", "documentation":"The total amount of tax aggregated from the tax breakdown.
" } }, "documentation":"Provides an aggregated view of estimated tax information.
" }, "ExceptionMessage":{ "type":"string", "max":1024, "min":1 }, "ExpectedCharge":{ "type":"structure", "members":{ "id":{ "shape":"ResourceId", "documentation":"Unique identifier of the charge for a given agreement.
" }, "time":{ "shape":"Timestamp", "documentation":"The date and time when the charge is due to be invoiced. This is available only when the charge date is known.
" }, "amount":{ "shape":"BoundedString", "documentation":"The tax-exclusive amount of the charge. Only available when the charge amount is known.
" }, "amountAfterTax":{ "shape":"BoundedString", "documentation":"The tax-inclusive amount the acceptor has to pay. The amount is only present for fixed charges.
" }, "timing":{ "shape":"Timing", "documentation":"Indicates when the charge amount will be incurred. Values include ON_ACCEPTANCE (charged immediately when the agreement request is accepted), BILLING_PERIOD (charged on each billing period), and SCHEDULED (charged at a predetermined future date).
Provides an aggregated view of estimated tax information for this specific charge.
" } }, "documentation":"Estimated charge for the request.
" }, "ExpectedChargeList":{ "type":"list", "member":{"shape":"ExpectedCharge"} }, "Filter":{ "type":"structure", "members":{ "name":{ "shape":"FilterName", "documentation":"The name of the filter.
" }, "values":{ "shape":"FilterValueList", "documentation":"The filter value.
" } }, "documentation":"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.
Category of the term being updated.
" }, "id":{ "shape":"TermId", "documentation":"The unique identifier for the term.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"Defines the currency for the prices mentioned in this term.
" }, "duration":{ "shape":"BoundedString", "documentation":"Contract duration for the terms.
" }, "price":{ "shape":"BoundedString", "documentation":"Fixed amount to be charged to the customer when this term is accepted.
" }, "grants":{ "shape":"GrantList", "documentation":"Entitlements granted to the acceptor of fixed upfront as part of agreement execution.
" } }, "documentation":"Defines a prepaid pricing model where the customers are charged a fixed upfront amount.
" }, "FreeTrialPricingTerm":{ "type":"structure", "members":{ "type":{ "shape":"UnversionedTermType", "documentation":"Category of the term.
" }, "id":{ "shape":"TermId", "documentation":"The unique identifier for the terms.
" }, "duration":{ "shape":"BoundedString", "documentation":"Duration of the free trial period (5–31 days).
" }, "grants":{ "shape":"GrantList", "documentation":"Entitlements granted to the acceptor of a free trial as part of an agreement execution.
" } }, "documentation":"Defines a short-term free pricing model where the buyers aren’t charged anything within a specified limit.
" }, "GetAgreementCancellationRequestInput":{ "type":"structure", "required":[ "agreementCancellationRequestId", "agreementId" ], "members":{ "agreementCancellationRequestId":{ "shape":"AgreementCancellationRequestId", "documentation":"The unique identifier of the cancellation request.
" }, "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with the cancellation request.
" } } }, "GetAgreementCancellationRequestOutput":{ "type":"structure", "members":{ "agreementCancellationRequestId":{ "shape":"AgreementCancellationRequestId", "documentation":"The unique identifier of the cancellation request.
" }, "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with this cancellation request. Use DescribeAgreement to retrieve full agreement details.
The reason code provided for the cancellation.
" }, "description":{ "shape":"AgreementCancellationRequestDescription", "documentation":"The detailed description of the cancellation reason, if provided.
" }, "status":{ "shape":"AgreementCancellationRequestStatus", "documentation":"The current status of the cancellation request.
" }, "statusMessage":{ "shape":"AgreementCancellationRequestStatusMessage", "documentation":"A message providing additional context about the cancellation request status.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time when the cancellation request was created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The date and time when the cancellation request was last updated.
" } } }, "GetAgreementEntitlementsInput":{ "type":"structure", "required":["agreementId"], "members":{ "agreementId":{ "shape":"ResourceId", "documentation":"The unique identifier of the agreement.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of agreement entitlements to return in the response.
" }, "nextToken":{ "shape":"NextToken", "documentation":"A token to specify where to start pagination.
" } } }, "GetAgreementEntitlementsOutput":{ "type":"structure", "members":{ "agreementEntitlements":{ "shape":"AgreementEntitlementList", "documentation":"A list of agreement entitlements which are part of the latest agreement.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token used for pagination. The field is null if there are no more results.
The identifier of the payment request.
" }, "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with the payment request.
" } } }, "GetAgreementPaymentRequestOutput":{ "type":"structure", "members":{ "paymentRequestId":{ "shape":"PaymentRequestId", "documentation":"The unique identifier of the payment request.
" }, "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with this payment request. Use DescribeAgreement to retrieve full agreement details.
The current status of the payment request. Possible values include:
VALIDATING – The payment request is being validated against agreement terms.
VALIDATION_FAILED – The payment request failed validation.
PENDING_APPROVAL – The payment request is awaiting buyer action.
APPROVED – The buyer has approved the payment request.
REJECTED – The buyer has rejected the payment request.
CANCELLED – The seller has cancelled the payment request.
An optional message providing additional context about the payment request status, such as a rejection reason or validation failure details.
" }, "name":{ "shape":"PaymentRequestName", "documentation":"The descriptive name of the payment request.
" }, "description":{ "shape":"PaymentRequestDescription", "documentation":"The detailed description of the payment request, if provided.
" }, "chargeId":{ "shape":"ChargeId", "documentation":"The unique identifier of the charge created after the payment request is approved. This field is only present for approved payment requests and follows the pattern ch-[a-zA-Z0-9]+.
The amount charged or to be charged to the buyer.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"The currency code for the charge amount.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time when the payment request was created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The date and time when the payment request was last updated.
" } } }, "GetAgreementTermsInput":{ "type":"structure", "required":["agreementId"], "members":{ "agreementId":{ "shape":"ResourceId", "documentation":"The unique identifier of the agreement.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of agreements to return in the response.
" }, "nextToken":{ "shape":"NextToken", "documentation":"A token to specify where to start pagination.
" } } }, "GetAgreementTermsOutput":{ "type":"structure", "members":{ "acceptedTerms":{ "shape":"AcceptedTermList", "documentation":"A subset of terms proposed by the proposer that have been accepted by the acceptor as part of the agreement creation.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token used for pagination. The field is null if there are no more results.
The unique identifier of the agreement associated with the billing adjustment request.
" }, "billingAdjustmentRequestId":{ "shape":"BillingAdjustmentRequestId", "documentation":"The unique identifier of the billing adjustment request.
" } } }, "GetBillingAdjustmentRequestOutput":{ "type":"structure", "required":[ "billingAdjustmentRequestId", "agreementId", "adjustmentReasonCode", "originalInvoiceId", "adjustmentAmount", "currencyCode", "status", "createdAt", "updatedAt" ], "members":{ "billingAdjustmentRequestId":{ "shape":"BillingAdjustmentRequestId", "documentation":"The unique identifier of the billing adjustment request.
" }, "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with this billing adjustment request.
" }, "adjustmentReasonCode":{ "shape":"BillingAdjustmentReasonCode", "documentation":"The reason code for the billing adjustment.
" }, "description":{ "shape":"String", "documentation":"The detailed description of the billing adjustment reason, if provided.
" }, "originalInvoiceId":{ "shape":"InvoiceId", "documentation":"The identifier of the original invoice being adjusted.
" }, "adjustmentAmount":{ "shape":"PositiveAmountUpto8Decimals", "documentation":"The adjustment amount as a string representation of a decimal number.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"The currency code for the adjustment amount (e.g., USD).
The current status of the billing adjustment request.
" }, "statusMessage":{ "shape":"BillingAdjustmentStatusMessage", "documentation":"A message providing additional context about the billing adjustment request status. This field is populated only when the status is VALIDATION_FAILED.
The date and time when the billing adjustment request was created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The date and time when the billing adjustment request was last updated.
" } } }, "GrantItem":{ "type":"structure", "members":{ "dimensionKey":{ "shape":"BoundedString", "documentation":"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":{ "shape":"PositiveIntegerWithDefaultValueOne", "documentation":"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.
Entitlements granted to the acceptor of fixed upfront as part of agreement execution.
" }, "GrantList":{ "type":"list", "member":{"shape":"GrantItem"} }, "ISO8601Duration":{ "type":"string", "pattern":"([-+]?)P(?:([-+]?[0-9]+)D)?(T(?:([-+]?[0-9]+)H)?(?:([-+]?[0-9]+)M)?(?:([-+]?[0-9]+)(?:[.,]([0-9]{0,9}))?S)?)?" }, "Integer":{ "type":"integer", "box":true }, "Intent":{ "type":"string", "enum":[ "NEW", "AMEND", "REPLACE" ] }, "InternalServerException":{ "type":"structure", "members":{ "requestId":{ "shape":"RequestId", "documentation":"The unique identifier for the error.
" }, "message":{ "shape":"ExceptionMessage", "documentation":"Description of the error.
" } }, "documentation":"Unexpected error during processing of request.
", "exception":true, "fault":true }, "InvoiceBillingPeriod":{ "type":"structure", "required":[ "month", "year" ], "members":{ "month":{ "shape":"InvoiceBillingPeriodMonthInteger", "documentation":"The billing period month. Valid range: 1-12.
" }, "year":{ "shape":"InvoiceBillingPeriodYearInteger", "documentation":"The billing period year.
" } }, "documentation":"The billing period for an invoice, specified by month and year.
" }, "InvoiceBillingPeriodMonthInteger":{ "type":"integer", "box":true, "max":12, "min":1 }, "InvoiceBillingPeriodYearInteger":{ "type":"integer", "box":true, "max":2050, "min":2023 }, "InvoiceId":{ "type":"string", "max":255, "min":1 }, "InvoiceType":{ "type":"string", "enum":[ "INVOICE", "CREDIT_MEMO" ] }, "InvoicingEntity":{ "type":"structure", "members":{ "legalName":{ "shape":"BoundedString", "documentation":"Legal name of the entity issuing the invoice.
" }, "branchName":{ "shape":"BoundedString", "documentation":"The branch where the issuing entity is operating from.
" } }, "documentation":"The entity responsible for issuing the invoice.
" }, "ItemizedCharge":{ "type":"structure", "members":{ "dimensionKey":{ "shape":"BoundedString", "documentation":"The dimension key as specified in the accepted term.
" }, "newQuantity":{ "shape":"Integer", "documentation":"The requested quantity for this dimension.
" }, "oldQuantity":{ "shape":"Integer", "documentation":"The existing quantity for this dimension from the source agreement. This value is 0 for NEW intent.
The identifier of the expected charge that this itemized charge contributes to.
" }, "incrementalChargeAmount":{ "shape":"BoundedString", "documentation":"The total incremental charge amount for this dimension.
" } }, "documentation":"A breakdown of individual charges or line items within a billing or pricing context.
" }, "ItemizedChargeList":{ "type":"list", "member":{"shape":"ItemizedCharge"} }, "LegalTerm":{ "type":"structure", "members":{ "type":{ "shape":"UnversionedTermType", "documentation":"Category of the term being updated.
" }, "id":{ "shape":"TermId", "documentation":"The unique identifer for the term.
" }, "documents":{ "shape":"DocumentList", "documentation":"List of references to legal resources proposed to the buyers. An example is the EULA.
" } }, "documentation":"Defines the list of text agreements proposed to the acceptors. An example is the end user license agreement (EULA).
" }, "LineItemGroupBy":{ "type":"string", "enum":["INVOICE_ID"] }, "ListAgreementCancellationRequestsInput":{ "type":"structure", "required":["partyType"], "members":{ "partyType":{ "shape":"PartyType", "documentation":"The party type for the cancellation requests. Required parameter. Use Proposer to list cancellation requests where you are the seller, or Acceptor to list cancellation requests where you are the buyer.
An optional parameter to filter cancellation requests for a specific agreement.
" }, "status":{ "shape":"AgreementCancellationRequestStatus", "documentation":"An optional parameter to filter cancellation requests by status.
" }, "agreementType":{ "shape":"AgreementType", "documentation":"An optional parameter to filter cancellation requests by agreement type (e.g., PurchaseAgreement).
An optional parameter to filter cancellation requests by catalog (e.g., AWSMarketplace).
The maximum number of cancellation requests to return in the response.
" }, "nextToken":{ "shape":"NextToken", "documentation":"A token to specify where to start pagination.
" } } }, "ListAgreementCancellationRequestsOutput":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The token used for pagination. The field is null if there are no more results.
An array of AgreementCancellationRequestSummary objects containing summary information about each cancellation request.
The catalog in which the charges were created.
" }, "agreementId":{ "shape":"ResourceId", "documentation":"The unique identifier of the agreement.
" }, "agreementType":{ "shape":"AgreementType", "documentation":"Filter to retrieve charges of a specific agreement type (for example, PurchaseAgreement).
The maximum number of charges to return in the response.
" }, "nextToken":{ "shape":"NextToken", "documentation":"A token to specify where to start pagination.
" } } }, "ListAgreementChargesOutput":{ "type":"structure", "members":{ "items":{ "shape":"Charges", "documentation":"A list of agreement charges.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token used for pagination. The field is null if there are no more results.
The unique identifier of the agreement.
" }, "groupBy":{ "shape":"LineItemGroupBy", "documentation":"Specifies a grouping strategy for line items. Currently supports INVOICE_ID.
An optional filter to retrieve invoice information for a specific invoice.
" }, "invoiceType":{ "shape":"InvoiceType", "documentation":"An optional filter for the type of invoice. Valid values are INVOICE and CREDIT_MEMO.
An optional filter for the billing period associated with the invoice.
" }, "beforeIssuedTime":{ "shape":"Timestamp", "documentation":"An optional filter for invoices issued before the specified timestamp.
" }, "afterIssuedTime":{ "shape":"Timestamp", "documentation":"An optional filter for invoices issued after the specified timestamp.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return in the response.
" }, "nextToken":{ "shape":"NextToken", "documentation":"A token to specify where to start pagination.
" } } }, "ListAgreementInvoiceLineItemsOutput":{ "type":"structure", "members":{ "agreementInvoiceLineItemGroupSummaries":{ "shape":"AgreementInvoiceLineItemGroupSummaries", "documentation":"A list of grouped billing data objects.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token used for pagination. The field is null if there are no more results.
The party type for the payment requests. Required parameter. Use Proposer to list payment requests where you are the seller, or Acceptor to list payment requests where you are the buyer.
An optional parameter to list payment requests by agreement type (e.g., PurchaseAgreement).
An optional parameter to list payment requests by catalog (e.g., AWSMarketplace).
An optional parameter to list payment requests for a specific agreement.
" }, "status":{ "shape":"PaymentRequestStatus", "documentation":"An optional parameter to list payment requests by status. Valid values include VALIDATING, VALIDATION_FAILED, PENDING_APPROVAL, APPROVED, REJECTED, and CANCELLED.
The maximum number of payment requests to return in a single response (1-50). Default is 50.
" }, "nextToken":{ "shape":"NextToken", "documentation":"A token to specify where to start pagination.
" } } }, "ListAgreementPaymentRequestsOutput":{ "type":"structure", "required":["items"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The token used for pagination. The field is null if there are no more results.
An array of PaymentRequestSummary objects containing summary information about each payment request.
The unique identifier of the agreement to list billing adjustment requests for.
" }, "status":{ "shape":"BillingAdjustmentStatus", "documentation":"An optional filter to return billing adjustment requests with the specified status.
" }, "createdAfter":{ "shape":"Timestamp", "documentation":"An optional filter to return billing adjustment requests created after the specified timestamp.
" }, "createdBefore":{ "shape":"Timestamp", "documentation":"An optional filter to return billing adjustment requests created before the specified timestamp.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of billing adjustment requests to return in the response.
" }, "catalog":{ "shape":"Catalog", "documentation":"An optional filter to return billing adjustment requests by catalog (e.g., AWSMarketplace).
An optional filter to return billing adjustment requests by agreement type (e.g., PurchaseAgreement).
A token to specify where to start pagination.
" } } }, "ListBillingAdjustmentRequestsOutput":{ "type":"structure", "required":["items"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The token used for pagination. The field is null if there are no more results.
An array of BillingAdjustmentSummary objects containing summary information about each billing adjustment request.
The unique identifier of the payment request.
" }, "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with this payment request.
" }, "status":{ "shape":"PaymentRequestStatus", "documentation":"The current status of the payment request. Possible values include VALIDATING, VALIDATION_FAILED, PENDING_APPROVAL, APPROVED, REJECTED, and CANCELLED.
The descriptive name of the payment request.
" }, "chargeId":{ "shape":"ChargeId", "documentation":"The unique identifier of the charge created after the payment request is approved. This field is only present for approved payment requests.
" }, "chargeAmount":{ "shape":"PositiveAmountUpto8Decimals", "documentation":"The amount charged or to be charged to the buyer.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"The currency code for the charge amount.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time when the payment request was created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The date and time when the payment request was last updated.
" } }, "documentation":"Summary view of a payment request.
" }, "PaymentRequestSummaryList":{ "type":"list", "member":{"shape":"PaymentRequestSummary"} }, "PaymentScheduleTerm":{ "type":"structure", "members":{ "type":{ "shape":"UnversionedTermType", "documentation":"Type of the term.
" }, "id":{ "shape":"TermId", "documentation":"The unique identifier for the term.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"Defines the currency for the prices mentioned in the term.
" }, "schedule":{ "shape":"ScheduleList", "documentation":"List of the payment schedule where each element defines one installment of payment. It contains the information necessary for calculating the price.
" } }, "documentation":"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.
" }, "PositiveAmountUpto8Decimals":{ "type":"string", "pattern":"[0-9]*(\\.[0-9]{0,8})?" }, "PositiveIntegerWithDefaultValueOne":{ "type":"integer", "box":true, "min":1 }, "PricingCurrencyAmount":{ "type":"structure", "members":{ "amount":{ "shape":"BoundedString", "documentation":"The monetary amount before tax.
" }, "maxAdjustmentAmount":{ "shape":"BoundedString", "documentation":"The maximum refundable amount as a string representation of a decimal number.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"The 3-letter ISO 4217 currency code (e.g., USD, EUR, JPY).
Monetary amounts associated with an invoice line item group.
" }, "ProposalSummary":{ "type":"structure", "members":{ "resources":{ "shape":"Resources", "documentation":"The list of resources involved in the agreement.
" }, "offerId":{ "shape":"OfferId", "documentation":"The unique identifier of the offer in AWS Marketplace.
" }, "offerSetId":{ "shape":"OfferSetId", "documentation":"A unique identifier for the offer set containing this offer. All agreements created from offers in this set include this identifier as context.
" } }, "documentation":"A summary of the proposal received from the proposer.
" }, "Proposer":{ "type":"structure", "members":{ "accountId":{ "shape":"AWSAccountId", "documentation":"The AWS account ID of the proposer.
" } }, "documentation":"Details of the party proposing the agreement terms,. This is commonly the seller for PurchaseAgreement.
The unique identifier of the charge to associate the purchase order with.
" }, "chargeRevision":{ "shape":"ChargeRevision", "documentation":"The revision of the charge.
" }, "agreementId":{ "shape":"ResourceId", "documentation":"The unique identifier of the agreement associated with this charge.
" }, "purchaseOrderReference":{ "shape":"PurchaseOrderReference", "documentation":"The purchase order reference to associate with the charge.
" } }, "documentation":"Contains information about a purchase order association to a charge within an agreement.
" }, "PurchaseOrderReference":{ "type":"string", "min":1 }, "PurchaseOrders":{ "type":"list", "member":{"shape":"PurchaseOrder"}, "max":86, "min":1 }, "RateCardItem":{ "type":"structure", "members":{ "dimensionKey":{ "shape":"BoundedString", "documentation":"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":{ "shape":"BoundedString", "documentation":"Per unit price for the product dimension that’s used for calculating the amount to be charged.
" } }, "documentation":"Defines the per unit rates for each individual product dimension.
" }, "RateCardList":{ "type":"list", "member":{"shape":"RateCardItem"} }, "RecurringPaymentTerm":{ "type":"structure", "members":{ "type":{ "shape":"UnversionedTermType", "documentation":"Type of the term being updated.
" }, "id":{ "shape":"TermId", "documentation":"The unique identifier for the term.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"Defines the currency for the prices mentioned in this term.
" }, "billingPeriod":{ "shape":"BoundedString", "documentation":"Defines the recurrence at which buyers are charged.
" }, "price":{ "shape":"BoundedString", "documentation":"Amount charged to the buyer every billing period.
" } }, "documentation":"Defines a pricing model where customers are charged a fixed recurring price at the end of each billing period.
" }, "RegistrationToken":{ "type":"string", "max":512, "min":1, "pattern":"[A-Za-z0-9+/=.:_-]+" }, "RejectAgreementCancellationRequestInput":{ "type":"structure", "required":[ "agreementId", "agreementCancellationRequestId", "rejectionReason" ], "members":{ "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with the cancellation request.
" }, "agreementCancellationRequestId":{ "shape":"AgreementCancellationRequestId", "documentation":"The unique identifier of the cancellation request to reject.
" }, "rejectionReason":{ "shape":"AgreementCancellationRequestRejectionReason", "documentation":"The reason for rejecting the cancellation request (1-2000 characters). This message is visible to the seller.
" } } }, "RejectAgreementCancellationRequestOutput":{ "type":"structure", "members":{ "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with this cancellation request.
" }, "agreementCancellationRequestId":{ "shape":"AgreementCancellationRequestId", "documentation":"The unique identifier of the rejected cancellation request.
" }, "status":{ "shape":"AgreementCancellationRequestStatus", "documentation":"The updated status of the cancellation request, which is REJECTED.
The rejection reason provided by the buyer.
" }, "reasonCode":{ "shape":"AgreementCancellationRequestReasonCode", "documentation":"The original reason code provided when the cancellation request was created.
" }, "description":{ "shape":"AgreementCancellationRequestDescription", "documentation":"The detailed description of the cancellation reason, if provided.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time when the cancellation request was originally created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The date and time when the cancellation request was rejected.
" } } }, "RejectAgreementPaymentRequestInput":{ "type":"structure", "required":[ "paymentRequestId", "agreementId" ], "members":{ "paymentRequestId":{ "shape":"PaymentRequestId", "documentation":"The unique identifier of the payment request to reject.
" }, "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with the payment request.
" }, "rejectionReason":{ "shape":"PaymentRequestRejectionReason", "documentation":"An optional reason for rejecting the payment request (1-250 characters). This message is visible to the seller.
" } } }, "RejectAgreementPaymentRequestOutput":{ "type":"structure", "members":{ "paymentRequestId":{ "shape":"PaymentRequestId", "documentation":"The unique identifier of the rejected payment request.
" }, "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement associated with this payment request.
" }, "status":{ "shape":"PaymentRequestStatus", "documentation":"The updated status of the payment request, which is REJECTED.
The rejection reason provided by the buyer, if any.
" }, "name":{ "shape":"PaymentRequestName", "documentation":"The descriptive name of the payment request.
" }, "description":{ "shape":"PaymentRequestDescription", "documentation":"The detailed description of the payment request, if provided.
" }, "chargeAmount":{ "shape":"PositiveAmountUpto8Decimals", "documentation":"The amount that was requested to be charged.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"The currency code for the charge amount.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time when the payment request was originally created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The date and time when the payment request was rejected.
" } } }, "RenewalTerm":{ "type":"structure", "members":{ "type":{ "shape":"UnversionedTermType", "documentation":"Category of the term being updated.
" }, "id":{ "shape":"TermId", "documentation":"The unique identifier for the term.
" }, "configuration":{ "shape":"RenewalTermConfiguration", "documentation":"Additional parameters specified by the acceptor while accepting the term.
" } }, "documentation":"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.
Defines whether the acceptor has chosen to auto-renew the agreement at the end of its lifecycle. Can be set to True or False.
Additional parameters specified by the acceptor while accepting the term.
" }, "RequestId":{ "type":"string", "max":128, "min":1, "pattern":"[A-Za-z0-9-]+" }, "RequestedTerm":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"TermId", "documentation":"The unique identifier of the term in the agreement proposal.
" }, "configuration":{ "shape":"RequestedTermConfiguration", "documentation":"Additional configuration for the requested terms. This configuration is applicable only to the terms that accept a customer-provided configuration, such as ConfigurableUpfrontPricingTerm.
Defines what is being accepted as part of the agreement creation or update request, and it includes their configurations.
" }, "RequestedTermConfiguration":{ "type":"structure", "members":{ "configurableUpfrontPricingTermConfiguration":{"shape":"ConfigurableUpfrontPricingTermConfiguration"}, "renewalTermConfiguration":{"shape":"RenewalTermConfiguration"}, "variablePaymentTermConfiguration":{"shape":"VariablePaymentTermConfiguration"} }, "documentation":"A tagged union that represents the term configuration provided by the acceptor. Only one configuration is accepted per term.
", "union":true }, "RequestedTermList":{ "type":"list", "member":{"shape":"RequestedTerm"}, "max":30, "min":1 }, "Resource":{ "type":"structure", "members":{ "id":{ "shape":"ResourceId", "documentation":"The unique identifier of the resource.
We mention the term resource, which is most commonly a product, so a resourceId is also a productId.
Type of the resource, which is the product (for example, SaaSProduct, AmiProduct, ContainerProduct).
The list of resources involved in the agreement.
" }, "ResourceId":{ "type":"string", "max":64, "min":1, "pattern":"[A-Za-z0-9_/-]+" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "requestId":{ "shape":"RequestId", "documentation":"The unique identifier for the error.
" }, "message":{ "shape":"ExceptionMessage", "documentation":"Description of the error.
" }, "resourceId":{ "shape":"ResourceId", "documentation":"The unique identifier for the resource.
" }, "resourceType":{ "shape":"ResourceType", "documentation":"The type of resource.
" } }, "documentation":"Request references a resource which does not exist.
", "exception":true }, "ResourceType":{ "type":"string", "enum":[ "Agreement", "AgreementRequest", "AgreementProposal", "Charge", "PaymentRequest", "Invoice", "AgreementCancellationRequest", "BillingAdjustmentRequest" ] }, "Resources":{ "type":"list", "member":{"shape":"Resource"} }, "ScheduleItem":{ "type":"structure", "members":{ "chargeDate":{ "shape":"Timestamp", "documentation":"The date that the customer would pay the price defined in this payment schedule term. Invoices are generated on the date provided.
" }, "chargeAmount":{ "shape":"BoundedString", "documentation":"The price that the customer would pay on the scheduled date (chargeDate).
" } }, "documentation":"An individual installment of the payment that includes the date and amount of the charge.
" }, "ScheduleList":{ "type":"list", "member":{"shape":"ScheduleItem"} }, "SearchAgreementsInput":{ "type":"structure", "members":{ "catalog":{ "shape":"Catalog", "documentation":"The catalog in which the agreement was created.
" }, "filters":{ "shape":"FilterList", "documentation":"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, SaaSProduct, ProfessionalServicesProduct, or MachineLearningProduct).
PartyType – The party type of the caller. Use Proposer or Acceptor.
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. Supported value includes PurchaseAgreement.
OfferSetId – A unique identifier for the offer set containing this offer. All agreements created from offers in this set include this identifier as context.
An object that contains the SortBy and SortOrder attributes. Only EndTime is supported for SearchAgreements. The default sort is EndTime descending.
The maximum number of agreements to return in the response.
" }, "nextToken":{ "shape":"NextToken", "documentation":"A token to specify where to start pagination.
" } } }, "SearchAgreementsOutput":{ "type":"structure", "members":{ "agreementViewSummaries":{ "shape":"AgreementViewSummaryList", "documentation":"A summary of the agreement, including top-level attributes (for example, the agreement ID, proposer, and acceptor).
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token used for pagination. The field is null if there are no more results.
Category of selector.
" }, "value":{ "shape":"BoundedString", "documentation":"Contract duration. This field supports the ISO 8601 format.
" } }, "documentation":"Differentiates between the mutually exclusive rate cards in the same pricing term to be selected by the buyer.
" }, "SendAgreementCancellationRequestInput":{ "type":"structure", "required":[ "agreementId", "reasonCode" ], "members":{ "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement for which the cancellation request is being submitted.
" }, "reasonCode":{ "shape":"AgreementCancellationRequestReasonCode", "documentation":"The reason code for the cancellation request.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "idempotencyToken":true }, "description":{ "shape":"AgreementCancellationRequestDescription", "documentation":"An optional detailed description of the cancellation reason (1-2000 characters).
" } } }, "SendAgreementCancellationRequestOutput":{ "type":"structure", "members":{ "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement.
" }, "agreementCancellationRequestId":{ "shape":"AgreementCancellationRequestId", "documentation":"The unique identifier for the created cancellation request.
" }, "status":{ "shape":"AgreementCancellationRequestStatus", "documentation":"The current status of the cancellation request. The initial status is PENDING_APPROVAL.
The reason code provided for the cancellation.
" }, "description":{ "shape":"AgreementCancellationRequestDescription", "documentation":"The detailed description of the cancellation reason, if provided.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The time when the cancellation request was created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The time when the cancellation request was last updated.
" } } }, "SendAgreementPaymentRequestInput":{ "type":"structure", "required":[ "agreementId", "termId", "name", "chargeAmount" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "idempotencyToken":true }, "agreementId":{ "shape":"AgreementId", "documentation":"The unique identifier of the agreement for which the payment request is being submitted. Use GetAgreementTerms to retrieve agreement term details.
The unique identifier of the VariablePaymentTerm for the agreement that the payment request is being sent for.
A descriptive name for the payment request (5-64 characters).
" }, "chargeAmount":{ "shape":"PositiveAmountUpto8Decimals", "documentation":"The amount requested to be charged to the buyer, positive decimal value in the currency of the accepted term.
A ValidationException is returned if the chargeAmount exceeds the available balance, if the agreement doesn't have an active VariablePaymentTerm, or if the termId is invalid.
An optional detailed description of the payment request (1-2000 characters).
" } } }, "SendAgreementPaymentRequestOutput":{ "type":"structure", "members":{ "paymentRequestId":{ "shape":"PaymentRequestId", "documentation":"The unique identifier for the sent payment request.
" }, "agreementId":{ "shape":"AgreementId", "documentation":"The agreement identifier for this payment request.
" }, "status":{ "shape":"PaymentRequestStatus", "documentation":"The current status of the payment request. The initial status is PENDING_APPROVAL.
The descriptive name of the payment request.
" }, "description":{ "shape":"PaymentRequestDescription", "documentation":"The detailed description of the payment request, if provided.
" }, "chargeAmount":{ "shape":"PositiveAmountUpto8Decimals", "documentation":"The amount being charged to the buyer.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"The currency code for the charge amount (e.g., USD).
The time when the payment request was created.
" } } }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "requestId":{ "shape":"RequestId", "documentation":"The unique identifier for the error.
" }, "message":{ "shape":"ExceptionMessage", "documentation":"Description of the error.
" }, "quotaCode":{ "shape":"BoundedString", "documentation":"The code of the quota that was exceeded.
" }, "serviceCode":{ "shape":"BoundedString", "documentation":"The code of the service whose quota was exceeded.
" }, "resourceType":{ "shape":"BoundedString", "documentation":"The type of the resource that exceeded the quota.
" }, "resourceId":{ "shape":"ResourceId", "documentation":"The unique identifier of the resource that exceeded the quota.
" } }, "documentation":"Request exceeded the maximum allowed limit (quota) for a specific resource or API operation.
", "exception":true }, "Sort":{ "type":"structure", "members":{ "sortBy":{ "shape":"SortBy", "documentation":"The attribute on which the data is grouped, which can be by StartTime and EndTime. The default value is EndTime.
The sorting order, which can be ASCENDING or DESCENDING. The default value is DESCENDING.
An object that contains the SortBy and SortOrder attributes.
Category of the term being updated.
" }, "id":{ "shape":"TermId", "documentation":"The unique identifier for the term.
" }, "refundPolicy":{ "shape":"BoundedString", "documentation":"Free-text field about the refund policy description that will be shown to customers as is on the website and console.
" } }, "documentation":"Defines the customer support available for the acceptors when they purchase the software.
" }, "TaxBreakdown":{ "type":"list", "member":{"shape":"TaxBreakdownItem"} }, "TaxBreakdownItem":{ "type":"structure", "members":{ "amount":{ "shape":"BoundedString", "documentation":"The estimated tax amount.
" }, "rate":{ "shape":"BoundedString", "documentation":"The tax rate, in decimals.
" }, "type":{ "shape":"BoundedString", "documentation":"The type of tax (for example, VAT, ST, or GST).
" } }, "documentation":"Represents a single tax breakdown entry with amount, rate, and type.
" }, "TaxConfiguration":{ "type":"structure", "members":{ "taxEstimation":{ "shape":"TaxEstimation", "documentation":"Toggle to estimate tax as part of the response. Values include ENABLED and DISABLED. Default is DISABLED.
Configuration controls for tax estimation in the agreement request.
" }, "TaxEstimation":{ "type":"string", "enum":[ "DISABLED", "ENABLED" ] }, "TermId":{ "type":"string", "max":256, "min":1, "pattern":"[A-Za-z0-9+=;,.@\\-_]+" }, "ThrottlingException":{ "type":"structure", "members":{ "requestId":{ "shape":"RequestId", "documentation":"The unique identifier for the error.
" }, "message":{ "shape":"ExceptionMessage", "documentation":"Description of the error.
" } }, "documentation":"Request was denied due to request throttling.
", "exception":true }, "Timestamp":{"type":"timestamp"}, "Timing":{ "type":"string", "enum":[ "ON_ACCEPTANCE", "SCHEDULED", "BILLING_PERIOD" ] }, "UnversionedTermType":{ "type":"string", "max":4096, "min":1, "pattern":"[A-Za-z]+" }, "UpdatePurchaseOrdersInput":{ "type":"structure", "required":["purchaseOrders"], "members":{ "purchaseOrders":{ "shape":"PurchaseOrders", "documentation":"Contains information about purchase order associations.
" } } }, "UpdatePurchaseOrdersOutput":{ "type":"structure", "members":{} }, "UsageBasedPricingTerm":{ "type":"structure", "members":{ "type":{ "shape":"UnversionedTermType", "documentation":"Category of the term.
" }, "id":{ "shape":"TermId", "documentation":"The unique identifier for the term.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"Defines the currency for the prices mentioned in the term.
" }, "rateCards":{ "shape":"UsageBasedRateCardList", "documentation":"List of rate cards.
" } }, "documentation":"Defines a usage-based pricing model (typically, pay-as-you-go pricing), where the customers are charged based on product usage.
" }, "UsageBasedRateCardItem":{ "type":"structure", "members":{ "rateCard":{ "shape":"RateCardList", "documentation":"Defines the per unit rates for product dimensions.
" } }, "documentation":"Within the pay-as-you-go model defined under UsageBasedPricingTerm, the UsageBasedRateCardItem defines an individual rate for a product dimension.
The unique identifier associated with the error.
" }, "message":{ "shape":"ExceptionMessage", "documentation":"Description of the error.
" }, "reason":{ "shape":"ValidationExceptionReason", "documentation":"The reason associated with the error.
" }, "fields":{ "shape":"ValidationExceptionFieldList", "documentation":"The fields associated with the error.
" } }, "documentation":"The input fails to satisfy the constraints specified by the service.
", "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "name", "message" ], "members":{ "name":{ "shape":"BoundedString", "documentation":"The name of the field associated with the error.
" }, "message":{ "shape":"BoundedString", "documentation":"See applicable actions.
" } }, "documentation":"The input fails to satisfy the constraints specified by the service.
" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "MISSING_BILLING_ADJUSTMENTS", "BILLING_ADJUSTMENTS_LIMIT_EXCEEDED", "MISSING_INVOICE_ID", "INVALID_ADJUSTMENT_AMOUNT", "MISSING_ADJUSTMENT_AMOUNT", "INVALID_REASON_CODE", "MISSING_REASON_CODE", "MISSING_DESCRIPTION", "INVALID_INVOICE_ADJUSTMENT_PERIOD", "INVALID_CURRENCY_CODE", "MISSING_CURRENCY_CODE", "EXCEEDED_MAXIMUM_ADJUSTMENT_AMOUNT", "MISSING_BILLING_ADJUSTMENT_REQUEST_ENTRY", "MULTIPLE_AGREEMENT_IDS", "INVALID_AGREEMENT_CANCELLATION_REQUEST_ID", "MISSING_AGREEMENT_CANCELLATION_REQUEST_ID", "MISSING_REASON", "INVALID_REASON", "INVALID_STATUS", "INVALID_AGREEMENT_ID", "MISSING_AGREEMENT_ID", "INVALID_CATALOG", "INVALID_FILTERS", "INVALID_FILTER_NAME", "MISSING_FILTER_NAME", "INVALID_FILTER_VALUES", "MISSING_FILTER_VALUES", "INVALID_SORT_BY", "INVALID_SORT_ORDER", "INVALID_NEXT_TOKEN", "INVALID_MAX_RESULTS", "INVALID_TERM_ID", "MISSING_TERM_ID", "MISSING_NAME", "INVALID_NAME", "INVALID_DESCRIPTION", "MISSING_CHARGE_AMOUNT", "INVALID_CHARGE_AMOUNT", "MISSING_PAYMENT_REQUEST_ID", "INVALID_PAYMENT_REQUEST_ID", "MISSING_PARTY_TYPE", "INVALID_PARTY_TYPE", "UNSUPPORTED_FILTERS", "INVALID_CLIENT_TOKEN", "INVALID_INTENT", "MISSING_INTENT", "INVALID_SOURCE_AGREEMENT_IDENTIFIER", "MISSING_SOURCE_AGREEMENT_IDENTIFIER", "INVALID_AGREEMENT_PROPOSAL_IDENTIFIER", "MISSING_AGREEMENT_PROPOSAL_IDENTIFIER", "INVALID_REQUESTED_TERMS", "MISSING_REQUESTED_TERMS", "INVALID_REQUESTED_TERM_ID", "MISSING_REQUESTED_TERM_ID", "INVALID_REQUESTED_TERM_CONFIGURATION", "MISSING_REQUESTED_TERM_CONFIGURATION", "INVALID_AGREEMENT_REQUEST_ID", "MISSING_AGREEMENT_REQUEST_ID", "INVALID_PURCHASE_ORDERS", "MISSING_PURCHASE_ORDERS", "INVALID_CHARGE_ID", "MISSING_CHARGE_ID", "INVALID_CHARGE_REVISION", "MISSING_CHARGE_REVISION", "INVALID_AGREEMENT_TYPE", "INVALID_PURCHASE_ORDER_REFERENCE", "INACTIVE_AGREEMENT", "SUPERSEDED_AGREEMENT_PROPOSAL", "EXPIRED_AGREEMENT_PROPOSAL", "MISSING_MANDATORY_TERMS", "INCOMPATIBLE_TERMS", "MISSING_USAGE_AGREEMENT", "INVALID_INCREMENTAL_CHARGE", "MISSING_ACCOUNT_ADDRESS", "UNSUPPORTED_ACTION", "INVALID_REJECTION_REASON", "INVALID_PAYMENT_REQUEST_STATUS", "OTHER", "DUPLICATE_CHARGES", "UNSUPPORTED_ACCOUNT_PLAN", "DUPLICATE_AGREEMENT_IN_ORGANIZATION", "MISSING_PURCHASE_ORDER_REFERENCE" ] }, "ValidityTerm":{ "type":"structure", "members":{ "type":{ "shape":"UnversionedTermType", "documentation":"Category of the term being updated.
" }, "id":{ "shape":"TermId", "documentation":"The unique identifier for the term.
" }, "agreementDuration":{ "shape":"BoundedString", "documentation":"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.
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.
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.
Defines the conditions that will keep an agreement created from this offer valid.
" }, "VariablePaymentTerm":{ "type":"structure", "members":{ "type":{ "shape":"UnversionedTermType", "documentation":"Type of the term.
" }, "id":{ "shape":"TermId", "documentation":"The unique identifier for the term.
" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"Defines the currency for the prices mentioned in the term.
" }, "maxTotalChargeAmount":{ "shape":"BoundedString", "documentation":"The maximum total amount that can be charged to the customer through variable payment requests under this term.
" }, "configuration":{ "shape":"VariablePaymentTermConfiguration", "documentation":"Additional parameters specified by the acceptor while accepting the term.
" } }, "documentation":"Defines a payment model where sellers can submit variable payment requests up to a maximum charge amount, with configurable approval strategies and expiration timelines.
" }, "VariablePaymentTermConfiguration":{ "type":"structure", "required":["paymentRequestApprovalStrategy"], "members":{ "paymentRequestApprovalStrategy":{ "shape":"PaymentRequestApprovalStrategy", "documentation":"Defines the strategy for approving payment requests. Values include AUTO_APPROVE_ON_EXPIRATION and WAIT_FOR_APPROVAL
Defines the duration after which a payment request is automatically approved if no further action is taken. This only applies when the payment request approval strategy is set to AUTO_APPROVE_ON_EXPIRATION. The duration is represented in the ISO_8601 format (e.g., P10D for 10 days).
Additional parameters specified by the acceptor while accepting the variable payment term.
" }, "ZeroValueInteger":{ "type":"integer", "min":0 } }, "documentation":"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.