Class: Aws::ForecastService::Types::CreateWhatIfForecastRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#tagsArray<Types::Tag>

A list of tags to apply to the what if forecast.

Returns:



1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1816

class CreateWhatIfForecastRequest < Struct.new(
  :what_if_forecast_name,
  :what_if_analysis_arn,
  :time_series_transformations,
  :time_series_replacements_data_source,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_replacements_data_sourceTypes::TimeSeriesReplacementsDataSource

The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast.

This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.

This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.

Timestamps and item_ids not included in this dataset are not included in the what-if analysis.



1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1816

class CreateWhatIfForecastRequest < Struct.new(
  :what_if_forecast_name,
  :what_if_analysis_arn,
  :time_series_transformations,
  :time_series_replacements_data_source,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_transformationsArray<Types::TimeSeriesTransformation>

The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.



1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1816

class CreateWhatIfForecastRequest < Struct.new(
  :what_if_forecast_name,
  :what_if_analysis_arn,
  :time_series_transformations,
  :time_series_replacements_data_source,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#what_if_analysis_arnString

The Amazon Resource Name (ARN) of the what-if analysis.

Returns:

  • (String)


1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1816

class CreateWhatIfForecastRequest < Struct.new(
  :what_if_forecast_name,
  :what_if_analysis_arn,
  :time_series_transformations,
  :time_series_replacements_data_source,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#what_if_forecast_nameString

The name of the what-if forecast. Names must be unique within each what-if analysis.

Returns:

  • (String)


1816
1817
1818
1819
1820
1821
1822
1823
1824
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1816

class CreateWhatIfForecastRequest < Struct.new(
  :what_if_forecast_name,
  :what_if_analysis_arn,
  :time_series_transformations,
  :time_series_replacements_data_source,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end