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.
", "readonly":true }, "GetEstimatedCarbonEmissionsDimensionValues":{ "name":"GetEstimatedCarbonEmissionsDimensionValues", "http":{ "method":"POST", "requestUri":"/v1/estimated-carbon-emissions-dimension-values", "responseCode":200 }, "input":{"shape":"GetEstimatedCarbonEmissionsDimensionValuesRequest"}, "output":{"shape":"GetEstimatedCarbonEmissionsDimensionValuesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"Returns the possible dimension values available for a customer's account. We recommend using pagination to ensure that the operation returns quickly and successfully.
", "readonly":true } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"You do not have sufficient access to perform this action.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "Dimension":{ "type":"string", "documentation":"Specifies the dimensions available for grouping and filtering emissions data.
", "enum":[ "USAGE_ACCOUNT_ID", "REGION", "SERVICE" ] }, "DimensionEntry":{ "type":"structure", "required":[ "Dimension", "Value" ], "members":{ "Dimension":{ "shape":"Dimension", "documentation":"The dimension type that categorizes this entry.
" }, "Value":{ "shape":"String", "documentation":" 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).
Represents a dimension and its corresponding value.
" }, "DimensionEntryList":{ "type":"list", "member":{"shape":"DimensionEntry"} }, "DimensionList":{ "type":"list", "member":{"shape":"Dimension"} }, "DimensionListMap":{ "type":"map", "key":{"shape":"Dimension"}, "value":{"shape":"DimensionValueList"} }, "DimensionValueList":{ "type":"list", "member":{"shape":"String"} }, "DimensionsMap":{ "type":"map", "key":{"shape":"Dimension"}, "value":{"shape":"String"} }, "Double":{ "type":"double", "box":true }, "Emissions":{ "type":"structure", "required":[ "Value", "Unit" ], "members":{ "Value":{ "shape":"Double", "documentation":"The numeric value of the emissions quantity.
" }, "Unit":{ "shape":"EmissionsUnit", "documentation":"The unit of measurement for the emissions value.
" } }, "documentation":"Represents a carbon emissions quantity with its value and unit of measurement.
" }, "EmissionsMap":{ "type":"map", "key":{"shape":"EmissionsType"}, "value":{"shape":"Emissions"} }, "EmissionsType":{ "type":"string", "documentation":"Specifies the types of carbon emissions calculations available.
", "enum":[ "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" ] }, "EmissionsTypeList":{ "type":"list", "member":{"shape":"EmissionsType"} }, "EmissionsUnit":{ "type":"string", "documentation":"Specifies the unit of measurement for emissions.
", "enum":["MTCO2e"] }, "EstimatedCarbonEmissions":{ "type":"structure", "required":[ "TimePeriod", "DimensionsValues", "ModelVersion", "EmissionsValues" ], "members":{ "TimePeriod":{ "shape":"TimePeriod", "documentation":"The reporting period for emission values.
" }, "DimensionsValues":{ "shape":"DimensionsMap", "documentation":"The dimensions used to group emissions values.
" }, "ModelVersion":{ "shape":"ModelVersion", "documentation":"The semantic version-formatted string that indicates the methodology version used to calculate the emission values.
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.
The emissions values for the requested emissions types.
" } }, "documentation":"Contains estimated carbon emissions data for a specific time period and dimension grouping.
" }, "EstimatedCarbonEmissionsList":{ "type":"list", "member":{"shape":"EstimatedCarbonEmissions"} }, "FilterExpression":{ "type":"structure", "members":{ "Dimensions":{ "shape":"DimensionListMap", "documentation":"Filters emission values by specific dimension values.
" } }, "documentation":"Filters emission values by specific dimension values.
" }, "GetEstimatedCarbonEmissionsDimensionValuesRequest":{ "type":"structure", "required":[ "TimePeriod", "Dimensions" ], "members":{ "TimePeriod":{ "shape":"TimePeriod", "documentation":"The date range for fetching the dimension values.
" }, "Dimensions":{ "shape":"DimensionList", "documentation":"The dimensions available for grouping estimated carbon emissions.
" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return in a single call. Default is 40.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
" } } }, "GetEstimatedCarbonEmissionsDimensionValuesResponse":{ "type":"structure", "members":{ "Results":{ "shape":"DimensionEntryList", "documentation":"The list of possible dimensions over which the emissions data is aggregated.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
" } } }, "GetEstimatedCarbonEmissionsRequest":{ "type":"structure", "required":["TimePeriod"], "members":{ "TimePeriod":{ "shape":"TimePeriod", "documentation":"The date range for fetching estimated carbon emissions.
" }, "GroupBy":{ "shape":"DimensionList", "documentation":"The dimensions available for grouping estimated carbon emissions.
" }, "FilterBy":{ "shape":"FilterExpression", "documentation":"The criteria for filtering estimated carbon emissions.
" }, "EmissionsTypes":{ "shape":"EmissionsTypeList", "documentation":"The emission types to include in the results. If absent, returns TOTAL_LBM_CARBON_EMISSIONS and TOTAL_MBM_CARBON_EMISSIONS emissions types.
The time granularity for the results. If absent, uses MONTHLY time granularity.
Configuration for fiscal year calculations when using YEARLY_FISCAL or QUARTERLY_FISCAL granularity.
The maximum number of results to return in a single call. Default is 40.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
" } } }, "GetEstimatedCarbonEmissionsResponse":{ "type":"structure", "required":["Results"], "members":{ "Results":{ "shape":"EstimatedCarbonEmissionsList", "documentation":"The result of the requested inputs.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
" } } }, "GranularityConfiguration":{ "type":"structure", "members":{ "FiscalYearStartMonth":{ "shape":"Month", "documentation":" The month (1-12) when the fiscal year begins. Used for YEARLY_FISCAL and QUARTERLY_FISCAL granularity. Defaults to 1 (January).
Contains configuration for the fiscal year granularities (e.g., YEARLY_FISCAL, QUARTERLY_FISCAL.
The request processing has failed because of an unknown error, exception, or failure.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "MaxResults":{ "type":"integer", "box":true, "max":5000, "min":1 }, "ModelVersion":{ "type":"string", "pattern":"v(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?" }, "Month":{ "type":"integer", "box":true, "max":12, "min":1 }, "NextToken":{ "type":"string", "max":2000, "min":1 }, "String":{"type":"string"}, "ThrottlingException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"The request was denied due to request throttling.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "TimeGranularity":{ "type":"string", "documentation":"Specifies the time period over which emissions data is aggregated.
", "enum":[ "YEARLY_CALENDAR", "YEARLY_FISCAL", "QUARTERLY_CALENDAR", "QUARTERLY_FISCAL", "MONTHLY" ] }, "TimePeriod":{ "type":"structure", "required":[ "Start", "End" ], "members":{ "Start":{ "shape":"Timestamp", "documentation":"The start (inclusive) of the time period. ISO-8601 formatted timestamp, for example: YYYY-MM-DDThh:mm:ss.sssZ
The end (exclusive) of the time period. ISO-8601 formatted timestamp, for example: YYYY-MM-DDThh:mm:ss.sssZ
Represents a duration of time defined by start and end timestamps.
" }, "Timestamp":{ "type":"timestamp", "timestampFormat":"iso8601" }, "ValidationException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true } }, "documentation":"The AWS Sustainability service provides programmatic access to estimated carbon emissions data for your Amazon Web Services usage. Use the AWS Sustainability service to retrieve, analyze, and track the carbon footprint of your cloud infrastructure over time.
With the AWS Sustainability service, you can:
Retrieve estimated carbon emissions for your Amazon Web Services usage across different time periods
Group emissions data by dimensions such as account, region, and service
Filter emissions data to focus on specific accounts, regions, or services
Access multiple emissions calculation methodologies including Location-based Method (LBM) and Market-based Method (MBM)
Aggregate emissions data at various time granularities including monthly, quarterly, and yearly periods
The API supports pagination for efficient data retrieval and provides dimension values to help you understand the available grouping and filtering options for your account.
All emissions values are calculated using methodologies aligned with the Greenhouse Gas (GHG) Protocol and are provided in metric tons of carbon dioxide-equivalent (MTCO2e).
" }