Sustainability / Paginator / GetEstimatedCarbonEmissionsDimensionValues

GetEstimatedCarbonEmissionsDimensionValues

class Sustainability.Paginator.GetEstimatedCarbonEmissionsDimensionValues

paginator = client.get_paginator('get_estimated_carbon_emissions_dimension_values')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Sustainability.Client.get_estimated_carbon_emissions_dimension_values().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TimePeriod={
        'Start': datetime(2015, 1, 1),
        'End': datetime(2015, 1, 1)
    },
    Dimensions=[
        'USAGE_ACCOUNT_ID'|'REGION'|'SERVICE',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Results': [
        {
            'Dimension': 'USAGE_ACCOUNT_ID'|'REGION'|'SERVICE',
            'Value': '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).