Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

GetEstimatedWaterAllocation

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.

Request Syntax


POST /v1/estimated-water-allocation HTTP/1.1
Content-type: application/json

{
   "AllocationTypes": [ "string" ],
   "FilterBy": { 
      "Dimensions": { 
         "string" : [ "string" ]
      }
   },
   "Granularity": "string",
   "GroupBy": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "TimePeriod": { 
      "End": "string",
      "Start": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

TimePeriod

The date range for fetching estimated water allocation. The range must include the start date of a year for that year's data to be included in the response.

Type: TimePeriod object

Required: Yes

AllocationTypes

The allocation types to include in the results. If absent, returns TOTAL_WATER_WITHDRAWALS allocation types.

Type: Array of strings

Valid Values: TOTAL_WATER_WITHDRAWALS

Required: No

FilterBy

The criteria for filtering estimated water allocation. To determine which dimensions are available to be filtered by, you can first call GetEstimatedWaterAllocationDimensionValues

Type: FilterExpression object

Required: No

Granularity

The time granularity for the results. Only YEARLY_CALENDAR time granularity is currently supported for water allocation. Defaults to YEARLY_CALENDAR if absent.

If requesting partial time periods, data will be returned based on the smallest supported granularity. For example, requesting 2025-04-01T00:00:00Z to 2026-04-01T00:00:00Z with YEARLY_CALENDAR will return all the data for 2026 only.

Type: String

Valid Values: YEARLY_CALENDAR | YEARLY_FISCAL | QUARTERLY_CALENDAR | QUARTERLY_FISCAL | MONTHLY

Required: No

GroupBy

The dimensions available for grouping estimated water allocation.

Type: Array of strings

Valid Values: USAGE_ACCOUNT_ID | REGION | SERVICE

Required: No

MaxResults

The maximum number of results to return in a single call. Default is 1000.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 5000.

Required: No

NextToken

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Results": [ 
      { 
         "AllocationValues": { 
            "string" : { 
               "Unit": "string",
               "Value": number
            }
         },
         "DimensionsValues": { 
            "string" : "string" 
         },
         "ModelVersion": "string",
         "TimePeriod": { 
            "End": "string",
            "Start": "string"
         }
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Results

The result of the requested inputs.

Type: Array of EstimatedWaterAllocation objects

NextToken

The pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

Examples

GetEstimatedWaterAllocation

This example illustrates one usage of GetEstimatedWaterAllocation.

Sample Request


POST /v1/estimated-water-allocation
{
    "TimePeriod": {
        "Start": "2025-01-01T00:00:00Z",
        "End": "2025-12-31T23:59:59.999Z"
    },
    "GroupBy": [
        "SERVICE"
    ],
    "AllocationTypes": [
        "TOTAL_WATER_WITHDRAWALS"
    ],
    "Granularity": "YEARLY_CALENDAR"
}

Sample Response


{
    "Results": [
        {
            "DimensionsValues": {
                "SERVICE": "AmazonEC2"
            },
            "AllocationValues": {
                "TOTAL_WATER_WITHDRAWALS": {
                    "Unit": "m3",
                    "Value": 1
                }
            },
            "ModelVersion": "v1.0.0",
            "TimePeriod": {
                "Start": "2025-01-01T00:00:00Z",
                "End": "2025-12-31T23:59:59.999Z"
            }
        }
    ]
}