Class: Aws::ForecastService::Types::ListWhatIfForecastsRequest

Inherits:

Struct

• Object
• Struct
• Aws::ForecastService::Types::ListWhatIfForecastsRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filters ⇒ Array<Types::Filter>

  An array of filters.

• #max_results ⇒ Integer

  The number of items to return in the response.

• #next_token ⇒ String

  If the result of the previous request was truncated, the response includes a NextToken.

Instance Attribute Details

#filters ⇒ Array<Types::Filter>

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the what-if forecast export jobs that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

• Condition - The condition to apply. Valid values are IS and IS_NOT. To include the forecast export jobs that match the statement, specify IS. To exclude matching forecast export jobs, specify IS_NOT.

• Key - The name of the parameter to filter on. Valid values are WhatIfForecastArn and Status.

• Value - The value to match.

For example, to list all jobs that export a forecast named electricityWhatIfForecast, specify the following filter:

"Filters": [ \{ "Condition": "IS", "Key": "WhatIfForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast" \} ]

Returns:

• (Array<Types::Filter>)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 5545

class ListWhatIfForecastsRequest < Struct.new(
  :next_token,
  :max_results,
  :filters)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The number of items to return in the response.

Returns:

• (Integer)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 5545

class ListWhatIfForecastsRequest < Struct.new(
  :next_token,
  :max_results,
  :filters)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next
 request. Tokens expire after 24 hours.

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 5545

class ListWhatIfForecastsRequest < Struct.new(
  :next_token,
  :max_results,
  :filters)
  SENSITIVE = []
  include Aws::Structure
end