Sustainability / Client / get_estimated_carbon_emissions_dimension_values

get_estimated_carbon_emissions_dimension_values

Sustainability.Client.get_estimated_carbon_emissions_dimension_values(**kwargs)

Returns the possible dimension values available for a customer’s account. 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_dimension_values(
    TimePeriod={
        'Start': datetime(2015, 1, 1),
        'End': datetime(2015, 1, 1)
    },
    Dimensions=[
        'USAGE_ACCOUNT_ID'|'REGION'|'SERVICE',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • TimePeriod (dict) –

    [REQUIRED]

    The date range for fetching the dimension values.

    • 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

  • Dimensions (list) –

    [REQUIRED]

    The dimensions available for grouping estimated carbon emissions.

    • (string) –

      Specifies the dimensions available for grouping and filtering emissions data.

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

  • 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': [
        {
            'Dimension': 'USAGE_ACCOUNT_ID'|'REGION'|'SERVICE',
            'Value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Results (list) –

      The list of possible dimensions over which the emissions data is aggregated.

      • (dict) –

        Represents a dimension and its corresponding value.

        • Dimension (string) –

          The dimension type that categorizes this entry.

        • Value (string) –

          The value for the specified dimension. Valid values vary based on the dimension type (e.g., us-east-1 for the REGION dimension, AmazonEC2 for the SERVICE dimension).

    • 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