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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sustainability/lib/aws-sdk-sustainability/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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


215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'gems/aws-sdk-sustainability/lib/aws-sdk-sustainability/types.rb', line 215

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.

Returns:



215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'gems/aws-sdk-sustainability/lib/aws-sdk-sustainability/types.rb', line 215

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.

Returns:

  • (String) 


215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'gems/aws-sdk-sustainability/lib/aws-sdk-sustainability/types.rb', line 215

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:



215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'gems/aws-sdk-sustainability/lib/aws-sdk-sustainability/types.rb', line 215

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


215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'gems/aws-sdk-sustainability/lib/aws-sdk-sustainability/types.rb', line 215

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

Returns:

  • (Integer) 


215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'gems/aws-sdk-sustainability/lib/aws-sdk-sustainability/types.rb', line 215

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) 


215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'gems/aws-sdk-sustainability/lib/aws-sdk-sustainability/types.rb', line 215

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.

Returns:



215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'gems/aws-sdk-sustainability/lib/aws-sdk-sustainability/types.rb', line 215

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