Class: Aws::ForecastService::Types::CreateForecastRequest

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 CreateForecastRequest data as a hash:

{
  forecast_name: "Name", # required
  predictor_arn: "Arn", # required
  forecast_types: ["ForecastType"],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#forecast_nameString

A name for the forecast.

Returns:

  • (String)


428
429
430
431
432
433
434
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 428

class CreateForecastRequest < Struct.new(
  :forecast_name,
  :predictor_arn,
  :forecast_types)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_typesArray<String>

The quantiles at which probabilistic forecasts are generated. You can specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast is different from the median (0.50) when the distribution is not symmetric (e.g. Beta, Negative Binomial). The default value is ["0.1", "0.5", "0.9"].

Returns:

  • (Array<String>)


428
429
430
431
432
433
434
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 428

class CreateForecastRequest < Struct.new(
  :forecast_name,
  :predictor_arn,
  :forecast_types)
  SENSITIVE = []
  include Aws::Structure
end

#predictor_arnString

The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.

Returns:

  • (String)


428
429
430
431
432
433
434
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 428

class CreateForecastRequest < Struct.new(
  :forecast_name,
  :predictor_arn,
  :forecast_types)
  SENSITIVE = []
  include Aws::Structure
end