Class: Aws::Sustainability::Types::GetEstimatedCarbonEmissionsRequest

Inherits:

Struct

• Object
• Struct
• Aws::Sustainability::Types::GetEstimatedCarbonEmissionsRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sustainability/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #emissions_types ⇒ Array<String>

  The emission types to include in the results.

• #filter_by ⇒ Types::FilterExpression

  The criteria for filtering estimated carbon emissions.

• #granularity ⇒ String

  The time granularity for the results.

• #granularity_configuration ⇒ Types::GranularityConfiguration

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

• #group_by ⇒ Array<String>

  The dimensions available for grouping estimated carbon emissions.

• #max_results ⇒ Integer

  The maximum number of results to return in a single call.

• #next_token ⇒ String

  The pagination token specifying which page of results to return in the response.

• #time_period ⇒ Types::TimePeriod

  The date range for fetching estimated carbon emissions.

Instance Attribute Details

#emissions_types ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-sustainability/types.rb', line 265

class GetEstimatedCarbonEmissionsRequest < Struct.new(
  :time_period,
  :group_by,
  :filter_by,
  :emissions_types,
  :granularity,
  :granularity_configuration,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#filter_by ⇒ Types::FilterExpression

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

Returns:

• (Types::FilterExpression)

# File 'lib/aws-sdk-sustainability/types.rb', line 265

class GetEstimatedCarbonEmissionsRequest < Struct.new(
  :time_period,
  :group_by,
  :filter_by,
  :emissions_types,
  :granularity,
  :granularity_configuration,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-sustainability/types.rb', line 265

class GetEstimatedCarbonEmissionsRequest < Struct.new(
  :time_period,
  :group_by,
  :filter_by,
  :emissions_types,
  :granularity,
  :granularity_configuration,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#granularity_configuration ⇒ Types::GranularityConfiguration

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

Returns:

• (Types::GranularityConfiguration)

# File 'lib/aws-sdk-sustainability/types.rb', line 265

class GetEstimatedCarbonEmissionsRequest < Struct.new(
  :time_period,
  :group_by,
  :filter_by,
  :emissions_types,
  :granularity,
  :granularity_configuration,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#group_by ⇒ Array<String>

The dimensions available for grouping estimated carbon emissions.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-sustainability/types.rb', line 265

class GetEstimatedCarbonEmissionsRequest < Struct.new(
  :time_period,
  :group_by,
  :filter_by,
  :emissions_types,
  :granularity,
  :granularity_configuration,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return in a single call. Default is 1000.

Returns:

• (Integer)

# File 'lib/aws-sdk-sustainability/types.rb', line 265

class GetEstimatedCarbonEmissionsRequest < Struct.new(
  :time_period,
  :group_by,
  :filter_by,
  :emissions_types,
  :granularity,
  :granularity_configuration,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-sustainability/types.rb', line 265

class GetEstimatedCarbonEmissionsRequest < Struct.new(
  :time_period,
  :group_by,
  :filter_by,
  :emissions_types,
  :granularity,
  :granularity_configuration,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#time_period ⇒ Types::TimePeriod

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.

Returns:

• (Types::TimePeriod)

# File 'lib/aws-sdk-sustainability/types.rb', line 265

class GetEstimatedCarbonEmissionsRequest < Struct.new(
  :time_period,
  :group_by,
  :filter_by,
  :emissions_types,
  :granularity,
  :granularity_configuration,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end