GetEstimatedWaterAllocationRequest ¶

class GetEstimatedWaterAllocationRequest(TypedDict, closed=True):
    time_period: "capo_sustainability.types.time_period.TimePeriod"
    """<p> 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. </p>"""
    group_by: NotRequired["capo_sustainability.types.dimension_list.DimensionList"]
    """<p>The dimensions available for grouping estimated water allocation.</p>"""
    filter_by: NotRequired[
        "capo_sustainability.types.filter_expression.FilterExpression"
    ]
    """<p> The criteria for filtering estimated water allocation. To determine which dimensions are available to be filtered by, you can first call <a>GetEstimatedWaterAllocationDimensionValues</a> </p>"""
    allocation_types: NotRequired[
        "capo_sustainability.types.water_allocation_type_list.WaterAllocationTypeList"
    ]
    """<p>The allocation types to include in the results. If absent, returns <code>TOTAL_WATER_WITHDRAWALS</code> allocation types. </p>"""
    granularity: "capo_sustainability.types.time_granularity.TimeGranularity"
    """<p>The time granularity for the results. Only <code>YEARLY_CALENDAR</code> time granularity is currently supported for water allocation. Defaults to <code>YEARLY_CALENDAR</code> if absent.</p> <p> If requesting partial time periods, data will be returned based on the smallest supported granularity. For example, requesting <code>2025-04-01T00:00:00Z</code> to <code>2026-04-01T00:00:00Z</code> with <code>YEARLY_CALENDAR</code> will return all the data for 2026 only. </p>"""
    max_results: "capo_sustainability.types.max_results.MaxResults"
    """<p>The maximum number of results to return in a single call. Default is 1000.</p>"""
    next_token: NotRequired["capo_sustainability.types.next_token.NextToken"]
    """<p>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. </p>"""