Class: Aws::ForecastService::Types::CreateWhatIfAnalysisRequest

Inherits:

Struct

• Object
• Struct
• Aws::ForecastService::Types::CreateWhatIfAnalysisRequest

Includes:

Structure

Defined in:

lib/aws-sdk-forecastservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #forecast_arn ⇒ String

  The Amazon Resource Name (ARN) of the baseline forecast.

• #tags ⇒ Array<Types::Tag>

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

• #time_series_selector ⇒ Types::TimeSeriesSelector

  Defines the set of time series that are used in the what-if analysis with a ‘TimeSeriesIdentifiers` object.

• #what_if_analysis_name ⇒ String

  The name of the what-if analysis.

Instance Attribute Details

#forecast_arn ⇒ String

The Amazon Resource Name (ARN) of the baseline forecast.

Returns:

• (String)

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

class CreateWhatIfAnalysisRequest < Struct.new(
  :what_if_analysis_name,
  :forecast_arn,
  :time_series_selector,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

[1]: docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html

Returns:

• (Array<Types::Tag>)

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

class CreateWhatIfAnalysisRequest < Struct.new(
  :what_if_analysis_name,
  :forecast_arn,
  :time_series_selector,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_selector ⇒ Types::TimeSeriesSelector

Defines the set of time series that are used in the what-if analysis with a ‘TimeSeriesIdentifiers` object. What-if analyses are performed only for the time series in this object.

The ‘TimeSeriesIdentifiers` object needs the following information:

• ‘DataSource`

• ‘Format`

• ‘Schema`

Returns:

• (Types::TimeSeriesSelector)

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

class CreateWhatIfAnalysisRequest < Struct.new(
  :what_if_analysis_name,
  :forecast_arn,
  :time_series_selector,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#what_if_analysis_name ⇒ String

The name of the what-if analysis. Each name must be unique.

Returns:

• (String)

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

class CreateWhatIfAnalysisRequest < Struct.new(
  :what_if_analysis_name,
  :forecast_arn,
  :time_series_selector,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end