Sustainability / Client / get_estimated_water_allocation

get_estimated_water_allocation

Sustainability.Client.get_estimated_water_allocation(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_estimated_water_allocation(
    TimePeriod={
        'Start': datetime(2015, 1, 1),
        'End': datetime(2015, 1, 1)
    },
    GroupBy=[
        'USAGE_ACCOUNT_ID'|'REGION'|'SERVICE',
    ],
    FilterBy={
        'Dimensions': {
            'string': [
                'string',
            ]
        }
    },
    AllocationTypes=[
        'TOTAL_WATER_WITHDRAWALS',
    ],
    Granularity='YEARLY_CALENDAR'|'YEARLY_FISCAL'|'QUARTERLY_CALENDAR'|'QUARTERLY_FISCAL'|'MONTHLY',
    MaxResults=123,
    NextToken='string'
)

Parameters:

• TimePeriod (dict) –

  [REQUIRED]

  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.

  • Start (datetime) – [REQUIRED]

    The start (inclusive) of the time period. ISO-8601 formatted timestamp, for example: YYYY-MM-DDThh:mm:ss.sssZ

  • End (datetime) – [REQUIRED]

    The end (exclusive) of the time period. ISO-8601 formatted timestamp, for example: YYYY-MM-DDThh:mm:ss.sssZ

• GroupBy (list) –

  The dimensions available for grouping estimated water allocation.

  • (string) –

    Specifies the dimensions available for grouping and filtering environmental impact data.

• FilterBy (dict) –

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

  • Dimensions (dict) –

    Filters environmental impact values by specific dimension values.

    • (string) –

      Specifies the dimensions available for grouping and filtering environmental impact data.

      • (list) –

        • (string) –

• AllocationTypes (list) –

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

  • (string) –

    Specifies the types of water allocation calculations available.

• Granularity (string) –

  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.

• MaxResults (integer) – The maximum number of results to return in a single call. Default is 1000.

• NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Results': [
        {
            'TimePeriod': {
                'Start': datetime(2015, 1, 1),
                'End': datetime(2015, 1, 1)
            },
            'DimensionsValues': {
                'string': 'string'
            },
            'ModelVersion': 'string',
            'AllocationValues': {
                'string': {
                    'Value': 123.0,
                    'Unit': 'm3'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Results (list) –

    The result of the requested inputs.

    • (dict) –

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

      • TimePeriod (dict) –

        The reporting period for water allocation values.

        • Start (datetime) –

          The start (inclusive) of the time period. ISO-8601 formatted timestamp, for example: YYYY-MM-DDThh:mm:ss.sssZ

        • End (datetime) –

          The end (exclusive) of the time period. ISO-8601 formatted timestamp, for example: YYYY-MM-DDThh:mm:ss.sssZ

      • DimensionsValues (dict) –

        The dimensions used to group water allocation values.

        • (string) –

          Specifies the dimensions available for grouping and filtering environmental impact data.

          • (string) –

      • ModelVersion (string) –

        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.

      • AllocationValues (dict) –

        The allocation values for the requested water allocation types.

        • (string) –

          Specifies the types of water allocation calculations available.

          • (dict) –

            Represents a water allocation quantity with its value and unit of measurement.

            • Value (float) –

              The numeric value of the allocation quantity.

            • Unit (string) –

              The unit of measurement for the allocation value.

  • NextToken (string) –

    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.

Exceptions

• Sustainability.Client.exceptions.ValidationException

• Sustainability.Client.exceptions.InternalServerException

• Sustainability.Client.exceptions.AccessDeniedException

• Sustainability.Client.exceptions.ThrottlingException