View a markdown version of this page

EstimatedWaterAllocation - AWS Sustainability

EstimatedWaterAllocation

Contains estimated water allocation data for a specific time period and dimension grouping.

Contents

Note

In the following list, the required parameters are described first.

AllocationValues

The allocation values for the requested water allocation types.

Type: String to WaterAllocation object map

Valid Keys: TOTAL_WATER_WITHDRAWALS

Required: Yes

DimensionsValues

The dimensions used to group water allocation values.

Type: String to string map

Valid Keys: USAGE_ACCOUNT_ID | REGION | SERVICE

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: Yes

ModelVersion

The semantic version-formatted string that indicates the methodology version used to calculate the water allocation values.

Note

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.

Type: String

Pattern: 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-]+)*))?

Required: Yes

TimePeriod

The reporting period for water allocation values.

Type: TimePeriod object

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: