Class: Aws::Sustainability::Types::GetEstimatedWaterAllocationRequest

Inherits:

Struct

• Object
• Struct
• Aws::Sustainability::Types::GetEstimatedWaterAllocationRequest

Defined in:

gems/aws-sdk-sustainability/lib/aws-sdk-sustainability/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allocation_types ⇒ Array<String>

  The allocation types to include in the results.

• #filter_by ⇒ Types::FilterExpression

  The criteria for filtering estimated water allocation.

• #granularity ⇒ String

  The time granularity for the results.

• #group_by ⇒ Array<String>

  The dimensions available for grouping estimated water allocation.

• #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 water allocation.

Instance Attribute Details

#allocation_types ⇒ Array<String>

The allocation types to include in the results. If absent, returns TOTAL_WATER_WITHDRAWALS allocation types.

Returns:

• (Array<String>)

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

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

#filter_by ⇒ Types::FilterExpression

The criteria for filtering estimated water allocation. To determine which dimensions are available to be filtered by, you can first call GetEstimatedWaterAllocationDimensionValues

Returns:

• (Types::FilterExpression)

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

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

#granularity ⇒ String

The time granularity for the results. Only YEARLY_CALENDAR time granularity is currently supported for water allocation. Defaults to YEARLY_CALENDAR if absent.

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 will return all the data for 2026 only.

Returns:

• (String)

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

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

#group_by ⇒ Array<String>

The dimensions available for grouping estimated water allocation.

Returns:

• (Array<String>)

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

class GetEstimatedWaterAllocationRequest < Struct.new(
  :time_period,
  :group_by,
  :filter_by,
  :allocation_types,
  :granularity,
  :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 'gems/aws-sdk-sustainability/lib/aws-sdk-sustainability/types.rb', line 394

class GetEstimatedWaterAllocationRequest < Struct.new(
  :time_period,
  :group_by,
  :filter_by,
  :allocation_types,
  :granularity,
  :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 'gems/aws-sdk-sustainability/lib/aws-sdk-sustainability/types.rb', line 394

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

#time_period ⇒ Types::TimePeriod

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

Returns:

• (Types::TimePeriod)

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

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