Sustainability / Client / get_estimated_carbon_emissions

get_estimated_carbon_emissions

Sustainability.Client.get_estimated_carbon_emissions(**kwargs)

Returns estimated carbon emission 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_carbon_emissions(
    TimePeriod={
        'Start': datetime(2015, 1, 1),
        'End': datetime(2015, 1, 1)
    },
    GroupBy=[
        'USAGE_ACCOUNT_ID'|'REGION'|'SERVICE',
    ],
    FilterBy={
        'Dimensions': {
            'string': [
                'string',
            ]
        }
    },
    EmissionsTypes=[
        'TOTAL_LBM_CARBON_EMISSIONS'|'TOTAL_MBM_CARBON_EMISSIONS'|'TOTAL_SCOPE_1_CARBON_EMISSIONS'|'TOTAL_SCOPE_2_LBM_CARBON_EMISSIONS'|'TOTAL_SCOPE_2_MBM_CARBON_EMISSIONS'|'TOTAL_SCOPE_3_LBM_CARBON_EMISSIONS'|'TOTAL_SCOPE_3_MBM_CARBON_EMISSIONS',
    ],
    Granularity='YEARLY_CALENDAR'|'YEARLY_FISCAL'|'QUARTERLY_CALENDAR'|'QUARTERLY_FISCAL'|'MONTHLY',
    GranularityConfiguration={
        'FiscalYearStartMonth': 123
    },
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • TimePeriod (dict) –

    [REQUIRED]

    The date range for fetching estimated carbon emissions. The range must include the start date of a month for that month’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 carbon emissions.

    • (string) –

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

  • FilterBy (dict) –

    The criteria for filtering estimated carbon emissions. To determine which dimensions are available to be filtered by, you can first call GetEstimatedCarbonEmissionsDimensionValues

    • Dimensions (dict) –

      Filters environmental impact values by specific dimension values.

      • (string) –

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

        • (list) –

          • (string) –

  • EmissionsTypes (list) –

    The emission types to include in the results. If absent, returns TOTAL_LBM_CARBON_EMISSIONS and TOTAL_MBM_CARBON_EMISSIONS emissions types.

    • (string) –

      Specifies the types of carbon emissions calculations available.

  • Granularity (string) –

    The time granularity for the results. If absent, uses MONTHLY time granularity. The smallest supported granularity for carbon emissions is MONTHLY.

    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 granularity will return the last 9 months for 2025 and the first 3 months of 2026.

  • GranularityConfiguration (dict) –

    Configuration for fiscal year calculations when using YEARLY_FISCAL or QUARTERLY_FISCAL granularity.

    • FiscalYearStartMonth (integer) –

      The month (1-12) when the fiscal year begins. Used for YEARLY_FISCAL and QUARTERLY_FISCAL granularity. Defaults to 1 (January).

  • 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',
            'EmissionsValues': {
                'string': {
                    'Value': 123.0,
                    'Unit': 'MTCO2e'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Results (list) –

      The result of the requested inputs.

      • (dict) –

        Contains estimated carbon emissions data for a specific time period and dimension grouping.

        • TimePeriod (dict) –

          The reporting period for emission 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 emissions 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 emission 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. To track the evolution of the methodology and compare emission values from previous versions, we recommend creating a Data Export.

        • EmissionsValues (dict) –

          The emissions values for the requested emissions types.

          • (string) –

            Specifies the types of carbon emissions calculations available.

            • (dict) –

              Represents a carbon emissions quantity with its value and unit of measurement.

              • Value (float) –

                The numeric value of the emissions quantity.

              • Unit (string) –

                The unit of measurement for the emissions 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