estimated_water_allocations

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

Overview

Name	estimated_water_allocations
Type	Resource
Id	aws.sustainability.estimated_water_allocations

Fields

The following fields are returned by SELECT queries:

get_estimated_water_allocation

Name	Datatype	Description
allocation_values	object	The allocation values for the requested water allocation types.
dimensions_values	object	The dimensions used to group water allocation values.
model_version	string	The semantic version-formatted string that indicates the methodology version used to calculate the water allocation values. The AWS Sustainability service reflects the most recent model version for every month. You will not see two entries for the same month with different ModelVersion values. (pattern: <code>v(0|[1-9]\d*).(0|[1-9]\d*).(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-])(?:.(?:0|[1-9]\d|\d*[a-zA-Z-][0-9a-zA-Z-]))))?(?:+([0-9a-zA-Z-]+(?:.[0-9a-zA-Z-]+)*))?</code>)
time_period	object	Represents a duration of time defined by start and end timestamps.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_estimated_water_allocation	select	region		Returns estimated water allocation values based on customer grouping and filtering parameters. We recommend using pagination to ensure that the operation returns quickly and successfully.

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

get_estimated_water_allocation

Returns estimated water allocation values based on customer grouping and filtering parameters. We recommend using pagination to ensure that the operation returns quickly and successfully.

SELECT
allocation_values,
dimensions_values,
model_version,
time_period
FROM aws.sustainability.estimated_water_allocations
WHERE region = '{{ region }}' -- required
;