AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sustainability ]

get-estimated-carbon-emissions

Description

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

get-estimated-carbon-emissions is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Results

Synopsis

  get-estimated-carbon-emissions
--time-period <value>
[--group-by <value>]
[--filter-by <value>]
[--emissions-types <value>]
[--granularity <value>]
[--granularity-configuration <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--time-period (structure)

The date range for fetching estimated carbon emissions.

Start -> (timestamp)

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

End -> (timestamp)

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

Shorthand Syntax:

Start=timestamp,End=timestamp

JSON Syntax:

{
  "Start": timestamp,
  "End": timestamp
}

--group-by (list)

The dimensions available for grouping estimated carbon emissions.

(string)

Specifies the dimensions available for grouping and filtering emissions data.

Syntax:

"string" "string" ...

Where valid values are:
  USAGE_ACCOUNT_ID
  REGION
  SERVICE

--filter-by (structure)

The criteria for filtering estimated carbon emissions.

Dimensions -> (map)

Filters emission values by specific dimension values.

key -> (string)

Specifies the dimensions available for grouping and filtering emissions data.

value -> (list)

(string)

Shorthand Syntax:

Dimensions={KeyName1=[string,string],KeyName2=[string,string]}

JSON Syntax:

{
  "Dimensions": {"USAGE_ACCOUNT_ID"|"REGION"|"SERVICE": ["string", ...]
    ...}
}

--emissions-types (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.

Syntax:

"string" "string" ...

Where valid values are:
  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 (string)

The time granularity for the results. If absent, uses MONTHLY time granularity.

Possible values:

  • YEARLY_CALENDAR
  • YEARLY_FISCAL
  • QUARTERLY_CALENDAR
  • QUARTERLY_FISCAL
  • MONTHLY

--granularity-configuration (structure)

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).

Shorthand Syntax:

FiscalYearStartMonth=integer

JSON Syntax:

{
  "FiscalYearStartMonth": integer
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

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

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

Results -> (list)

The result of the requested inputs.

(structure)

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

TimePeriod -> (structure)

The reporting period for emission values.

Start -> (timestamp)

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

End -> (timestamp)

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

DimensionsValues -> (map)

The dimensions used to group emissions values.

key -> (string)

Specifies the dimensions available for grouping and filtering emissions data.

value -> (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 -> (map)

The emissions values for the requested emissions types.

key -> (string)

Specifies the types of carbon emissions calculations available.

value -> (structure)

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

Value -> (double)

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.