You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ForecastService::Types::ListForecastsRequest

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

Overview

Note:

When making an API call, you may pass ListForecastsRequest data as a hash:

{
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      key: "String", # required
      value: "Arn", # required
      condition: "IS", # required, accepts IS, IS_NOT
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<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, respectively, from the list, the predictors that match the statement. The match statement consists of a key and a value. In this release, Name is the only valid key, which filters on the ForecastName property.

  • Condition - IS or IS_NOT

  • Key - Name

  • Value - the value to match

For example, to list all forecasts named my_forecast, you would specify:

"Filters": [ \{ "Condition": "IS", "Key": "Name", "Value": "my_forecast" \} ]

Returns:



2441
2442
2443
2444
2445
2446
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2441

class ListForecastsRequest < Struct.new(
  :next_token,
  :max_results,
  :filters)
  include Aws::Structure
end

#max_resultsInteger

The number of items to return in the response.

Returns:

  • (Integer)


2441
2442
2443
2444
2445
2446
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2441

class ListForecastsRequest < Struct.new(
  :next_token,
  :max_results,
  :filters)
  include Aws::Structure
end

#next_tokenString

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)


2441
2442
2443
2444
2445
2446
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2441

class ListForecastsRequest < Struct.new(
  :next_token,
  :max_results,
  :filters)
  include Aws::Structure
end