settlement_records

Creates, updates, deletes, gets or lists a settlement_records resource.

Overview

Name	settlement_records
Type	Resource
Id	aws.wafv2.settlement_records

Fields

The following fields are returned by SELECT queries:

list_settlement_records

Name	Datatype	Description
next_marker	string	When you get a paginated response, this marker indicates that additional results are available. (pattern: <code>.\S.</code>)
settlements	array	The list of settlement records.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_settlement_records	select	region		Retrieves individual settlement transaction records for monetization. Each record represents a single payment transaction between a client and your protected resource. This operation is only available for CLOUDFRONT scope. The maximum supported time window is 90 days. When no CurrencyMode filter is provided, results default to REAL. To retrieve test data, include a CurrencyMode filter with the value TEST.

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_settlement_records

Retrieves individual settlement transaction records for monetization. Each record represents a single payment transaction between a client and your protected resource. This operation is only available for CLOUDFRONT scope. The maximum supported time window is 90 days. When no CurrencyMode filter is provided, results default to REAL. To retrieve test data, include a CurrencyMode filter with the value TEST.

SELECT
next_marker,
settlements
FROM aws.wafv2.settlement_records
WHERE region = '{{ region }}' -- required
;