Class: Aws::Sustainability::Types::GetEstimatedWaterAllocationDimensionValuesRequest

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

#dimensions ⇒ Array<String>

The dimensions available for grouping estimated water allocation.

Returns:

  • (Array<String>) 


320
321
322
323
324
325
326
327
 
# File 'gems/aws-sdk-sustainability/lib/aws-sdk-sustainability/types.rb', line 320

class GetEstimatedWaterAllocationDimensionValuesRequest < Struct.new(
  :time_period,
  :dimensions,
  :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) 


320
321
322
323
324
325
326
327
 
# File 'gems/aws-sdk-sustainability/lib/aws-sdk-sustainability/types.rb', line 320

class GetEstimatedWaterAllocationDimensionValuesRequest < Struct.new(
  :time_period,
  :dimensions,
  :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) 


320
321
322
323
324
325
326
327
 
# File 'gems/aws-sdk-sustainability/lib/aws-sdk-sustainability/types.rb', line 320

class GetEstimatedWaterAllocationDimensionValuesRequest < Struct.new(
  :time_period,
  :dimensions,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#time_period ⇒ Types::TimePeriod

The date range for fetching the dimension values. The range must include the start date of a year for that year's data to be included in the response.

Returns:



320
321
322
323
324
325
326
327
 
# File 'gems/aws-sdk-sustainability/lib/aws-sdk-sustainability/types.rb', line 320

class GetEstimatedWaterAllocationDimensionValuesRequest < Struct.new(
  :time_period,
  :dimensions,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end