agreement_charges

Creates, updates, deletes, gets or lists an agreement_charges resource.

Overview

Name	agreement_charges
Type	Resource
Id	aws.marketplace_agreement.agreement_charges

Fields

The following fields are returned by SELECT queries:

list_agreement_charges

Name	Datatype	Description
id	string	The unique identifier of the charge. (pattern: <code>[A-Za-z0-9_/-]+</code>)
agreement_id	string	The unique identifier of the agreement that resulted in this charge. (pattern: <code>[A-Za-z0-9_/-]+</code>)
agreement_type	string	The type of agreement that resulted in this charge (for example, PurchaseAgreement). (pattern: <code>[A-Za-z]+</code>)
amount	string	The amount of the charge. (pattern: <code>(.)+</code>)
currency_code	string	The currency code for the charge amount. (pattern: <code>[A-Z]+</code>)
purchase_order_reference	string	The purchase order reference associated with the charge, if any.
revision	integer (int64)	The revision number of the charge.
time	string (date-time)	The date and time when the charge will be incurred. This is available only when the charge date is known.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_agreement_charges	select	region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_agreement_charges

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.

SELECT
id,
agreement_id,
agreement_type,
amount,
currency_code,
purchase_order_reference,
revision,
time
FROM aws.marketplace_agreement.agreement_charges
WHERE region = '{{ region }}' -- required
;