Class: Aws::ForecastService::Types::CreateAutoPredictorRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ForecastService::Types::CreateAutoPredictorRequest
- Defined in:
- gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#data_config ⇒ Types::DataConfig
The data configuration for your dataset group and any additional datasets.
-
#encryption_config ⇒ Types::EncryptionConfig
An Key Management Service (KMS) key and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
-
#explain_predictor ⇒ Boolean
Create an Explainability resource for the predictor.
-
#forecast_dimensions ⇒ Array<String>
An array of dimension (field) names that specify how to group the generated forecast.
-
#forecast_frequency ⇒ String
The frequency of predictions in a forecast.
-
#forecast_horizon ⇒ Integer
The number of time-steps that the model predicts.
-
#forecast_types ⇒ Array<String>
The forecast types used to train a predictor.
-
#monitor_config ⇒ Types::MonitorConfig
The configuration details for predictor monitoring.
-
#optimization_metric ⇒ String
The accuracy metric used to optimize the predictor.
-
#predictor_name ⇒ String
A unique name for the predictor.
-
#reference_predictor_arn ⇒ String
The ARN of the predictor to retrain or upgrade.
-
#tags ⇒ Array<Types::Tag>
Optional metadata to help you categorize and organize your predictors.
-
#time_alignment_boundary ⇒ Types::TimeAlignmentBoundary
The time boundary Forecast uses to align and aggregate any data that doesn't align with your forecast frequency.
Instance Attribute Details
#data_config ⇒ Types::DataConfig
The data configuration for your dataset group and any additional datasets.
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 588 class CreateAutoPredictorRequest < Struct.new( :predictor_name, :forecast_horizon, :forecast_types, :forecast_dimensions, :forecast_frequency, :data_config, :encryption_config, :reference_predictor_arn, :optimization_metric, :explain_predictor, :tags, :monitor_config, :time_alignment_boundary) SENSITIVE = [] include Aws::Structure end |
#encryption_config ⇒ Types::EncryptionConfig
An Key Management Service (KMS) key and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the CreateDataset and CreatePredictor requests.
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 588 class CreateAutoPredictorRequest < Struct.new( :predictor_name, :forecast_horizon, :forecast_types, :forecast_dimensions, :forecast_frequency, :data_config, :encryption_config, :reference_predictor_arn, :optimization_metric, :explain_predictor, :tags, :monitor_config, :time_alignment_boundary) SENSITIVE = [] include Aws::Structure end |
#explain_predictor ⇒ Boolean
Create an Explainability resource for the predictor.
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 588 class CreateAutoPredictorRequest < Struct.new( :predictor_name, :forecast_horizon, :forecast_types, :forecast_dimensions, :forecast_frequency, :data_config, :encryption_config, :reference_predictor_arn, :optimization_metric, :explain_predictor, :tags, :monitor_config, :time_alignment_boundary) SENSITIVE = [] include Aws::Structure end |
#forecast_dimensions ⇒ Array<String>
An array of dimension (field) names that specify how to group the generated forecast.
For example, if you are generating forecasts for item sales across
all your stores, and your dataset contains a store_id
field, you
would specify store_id
as a dimension to group sales forecasts for
each store.
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 588 class CreateAutoPredictorRequest < Struct.new( :predictor_name, :forecast_horizon, :forecast_types, :forecast_dimensions, :forecast_frequency, :data_config, :encryption_config, :reference_predictor_arn, :optimization_metric, :explain_predictor, :tags, :monitor_config, :time_alignment_boundary) SENSITIVE = [] include Aws::Structure end |
#forecast_frequency ⇒ String
The frequency of predictions in a forecast.
Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, "1D" indicates every day and "15min" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:
Minute - 1-59
Hour - 1-23
Day - 1-6
Week - 1-4
Month - 1-11
Year - 1
Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you specify "3M".
The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.
When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset frequency.
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 588 class CreateAutoPredictorRequest < Struct.new( :predictor_name, :forecast_horizon, :forecast_types, :forecast_dimensions, :forecast_frequency, :data_config, :encryption_config, :reference_predictor_arn, :optimization_metric, :explain_predictor, :tags, :monitor_config, :time_alignment_boundary) SENSITIVE = [] include Aws::Structure end |
#forecast_horizon ⇒ Integer
The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.
The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the TARGET_TIME_SERIES dataset length. If you are retraining an existing AutoPredictor, then the maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length.
If you are upgrading to an AutoPredictor or retraining an existing AutoPredictor, you cannot update the forecast horizon parameter. You can meet this requirement by providing longer time-series in the dataset.
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 588 class CreateAutoPredictorRequest < Struct.new( :predictor_name, :forecast_horizon, :forecast_types, :forecast_dimensions, :forecast_frequency, :data_config, :encryption_config, :reference_predictor_arn, :optimization_metric, :explain_predictor, :tags, :monitor_config, :time_alignment_boundary) SENSITIVE = [] include Aws::Structure end |
#forecast_types ⇒ Array<String>
The forecast types used to train a predictor. You can specify up to
five forecast types. Forecast types can be quantiles from 0.01 to
0.99, by increments of 0.01 or higher. You can also specify the mean
forecast with mean
.
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 588 class CreateAutoPredictorRequest < Struct.new( :predictor_name, :forecast_horizon, :forecast_types, :forecast_dimensions, :forecast_frequency, :data_config, :encryption_config, :reference_predictor_arn, :optimization_metric, :explain_predictor, :tags, :monitor_config, :time_alignment_boundary) SENSITIVE = [] include Aws::Structure end |
#monitor_config ⇒ Types::MonitorConfig
The configuration details for predictor monitoring. Provide a name for the monitor resource to enable predictor monitoring.
Predictor monitoring allows you to see how your predictor's performance changes over time. For more information, see Predictor Monitoring.
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 588 class CreateAutoPredictorRequest < Struct.new( :predictor_name, :forecast_horizon, :forecast_types, :forecast_dimensions, :forecast_frequency, :data_config, :encryption_config, :reference_predictor_arn, :optimization_metric, :explain_predictor, :tags, :monitor_config, :time_alignment_boundary) SENSITIVE = [] include Aws::Structure end |
#optimization_metric ⇒ String
The accuracy metric used to optimize the predictor.
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 588 class CreateAutoPredictorRequest < Struct.new( :predictor_name, :forecast_horizon, :forecast_types, :forecast_dimensions, :forecast_frequency, :data_config, :encryption_config, :reference_predictor_arn, :optimization_metric, :explain_predictor, :tags, :monitor_config, :time_alignment_boundary) SENSITIVE = [] include Aws::Structure end |
#predictor_name ⇒ String
A unique name for the predictor
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 588 class CreateAutoPredictorRequest < Struct.new( :predictor_name, :forecast_horizon, :forecast_types, :forecast_dimensions, :forecast_frequency, :data_config, :encryption_config, :reference_predictor_arn, :optimization_metric, :explain_predictor, :tags, :monitor_config, :time_alignment_boundary) SENSITIVE = [] include Aws::Structure end |
#reference_predictor_arn ⇒ String
The ARN of the predictor to retrain or upgrade. This parameter is only used when retraining or upgrading a predictor. When creating a new predictor, do not specify a value for this parameter.
When upgrading or retraining a predictor, only specify values for
the ReferencePredictorArn
and PredictorName
. The value for
PredictorName
must be a unique predictor name.
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 588 class CreateAutoPredictorRequest < Struct.new( :predictor_name, :forecast_horizon, :forecast_types, :forecast_dimensions, :forecast_frequency, :data_config, :encryption_config, :reference_predictor_arn, :optimization_metric, :explain_predictor, :tags, :monitor_config, :time_alignment_boundary) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
Optional metadata to help you categorize and organize your predictors. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
For each resource, each tag key must be unique and each tag key must have one value.
Maximum number of tags per resource: 50.
Maximum key length: 128 Unicode characters in UTF-8.
Maximum value length: 256 Unicode characters in UTF-8.
Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
Key prefixes cannot include any upper or lowercase combination of
aws:
orAWS:
. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 588 class CreateAutoPredictorRequest < Struct.new( :predictor_name, :forecast_horizon, :forecast_types, :forecast_dimensions, :forecast_frequency, :data_config, :encryption_config, :reference_predictor_arn, :optimization_metric, :explain_predictor, :tags, :monitor_config, :time_alignment_boundary) SENSITIVE = [] include Aws::Structure end |
#time_alignment_boundary ⇒ Types::TimeAlignmentBoundary
The time boundary Forecast uses to align and aggregate any data that doesn't align with your forecast frequency. Provide the unit of time and the time boundary as a key value pair. For more information on specifying a time boundary, see Specifying a Time Boundary. If you don't provide a time boundary, Forecast uses a set of Default Time Boundaries.
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 588 class CreateAutoPredictorRequest < Struct.new( :predictor_name, :forecast_horizon, :forecast_types, :forecast_dimensions, :forecast_frequency, :data_config, :encryption_config, :reference_predictor_arn, :optimization_metric, :explain_predictor, :tags, :monitor_config, :time_alignment_boundary) SENSITIVE = [] include Aws::Structure end |