Class: Aws::ForecastService::Types::DescribeWhatIfForecastResponse

Inherits:

Struct

• Object
• Struct
• Aws::ForecastService::Types::DescribeWhatIfForecastResponse

Defined in:

gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_time ⇒ Time

  When the what-if forecast was created.

• #estimated_time_remaining_in_minutes ⇒ Integer

  The approximate time remaining to complete the what-if forecast, in minutes.

• #forecast_types ⇒ Array<String>

  The quantiles at which probabilistic forecasts are generated.

• #last_modification_time ⇒ Time

  The last time the resource was modified.

• #message ⇒ String

  If an error occurred, an informational message about the error.

• #status ⇒ String

  The status of the what-if forecast.

• #time_series_replacements_data_source ⇒ Types::TimeSeriesReplacementsDataSource

  An array of S3Config, Schema, and Format elements that describe the replacement time series.

• #time_series_transformations ⇒ Array<Types::TimeSeriesTransformation>

  An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.

• #what_if_analysis_arn ⇒ String

  The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.

• #what_if_forecast_arn ⇒ String

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

• #what_if_forecast_name ⇒ String

  The name of the what-if forecast.

Instance Attribute Details

#creation_time ⇒ Time

When the what-if forecast was created.

Returns:

• (Time)

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

class DescribeWhatIfForecastResponse < Struct.new(
  :what_if_forecast_name,
  :what_if_forecast_arn,
  :what_if_analysis_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_transformations,
  :time_series_replacements_data_source,
  :forecast_types)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_time_remaining_in_minutes ⇒ Integer

The approximate time remaining to complete the what-if forecast, in minutes.

Returns:

• (Integer)

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

class DescribeWhatIfForecastResponse < Struct.new(
  :what_if_forecast_name,
  :what_if_forecast_arn,
  :what_if_analysis_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_transformations,
  :time_series_replacements_data_source,
  :forecast_types)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_types ⇒ Array<String>

The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].

Returns:

• (Array<String>)

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

class DescribeWhatIfForecastResponse < Struct.new(
  :what_if_forecast_name,
  :what_if_forecast_arn,
  :what_if_analysis_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_transformations,
  :time_series_replacements_data_source,
  :forecast_types)
  SENSITIVE = []
  include Aws::Structure
end

#last_modification_time ⇒ Time

The last time the resource was modified. The timestamp depends on the status of the job:

• CREATE_PENDING - The CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• CREATE_STOPPING - The current timestamp.

• CREATE_STOPPED - When the job stopped.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

Returns:

• (Time)

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

class DescribeWhatIfForecastResponse < Struct.new(
  :what_if_forecast_name,
  :what_if_forecast_arn,
  :what_if_analysis_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_transformations,
  :time_series_replacements_data_source,
  :forecast_types)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

If an error occurred, an informational message about the error.

Returns:

• (String)

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

class DescribeWhatIfForecastResponse < Struct.new(
  :what_if_forecast_name,
  :what_if_forecast_arn,
  :what_if_analysis_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_transformations,
  :time_series_replacements_data_source,
  :forecast_types)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the what-if forecast. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• CREATE_STOPPING, CREATE_STOPPED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the what-if forecast must be ACTIVE before you can access the forecast.

Returns:

• (String)

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

class DescribeWhatIfForecastResponse < Struct.new(
  :what_if_forecast_name,
  :what_if_forecast_arn,
  :what_if_analysis_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_transformations,
  :time_series_replacements_data_source,
  :forecast_types)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_replacements_data_source ⇒ Types::TimeSeriesReplacementsDataSource

An array of S3Config, Schema, and Format elements that describe the replacement time series.

Returns:

• (Types::TimeSeriesReplacementsDataSource)

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

class DescribeWhatIfForecastResponse < Struct.new(
  :what_if_forecast_name,
  :what_if_forecast_arn,
  :what_if_analysis_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_transformations,
  :time_series_replacements_data_source,
  :forecast_types)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_transformations ⇒ Array<Types::TimeSeriesTransformation>

An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.

Returns:

• (Array<Types::TimeSeriesTransformation>)

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

class DescribeWhatIfForecastResponse < Struct.new(
  :what_if_forecast_name,
  :what_if_forecast_arn,
  :what_if_analysis_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_transformations,
  :time_series_replacements_data_source,
  :forecast_types)
  SENSITIVE = []
  include Aws::Structure
end

#what_if_analysis_arn ⇒ String

The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.

Returns:

• (String)

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

class DescribeWhatIfForecastResponse < Struct.new(
  :what_if_forecast_name,
  :what_if_forecast_arn,
  :what_if_analysis_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_transformations,
  :time_series_replacements_data_source,
  :forecast_types)
  SENSITIVE = []
  include Aws::Structure
end

#what_if_forecast_arn ⇒ String

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

Returns:

• (String)

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

class DescribeWhatIfForecastResponse < Struct.new(
  :what_if_forecast_name,
  :what_if_forecast_arn,
  :what_if_analysis_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_transformations,
  :time_series_replacements_data_source,
  :forecast_types)
  SENSITIVE = []
  include Aws::Structure
end

#what_if_forecast_name ⇒ String

The name of the what-if forecast.

Returns:

• (String)

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

class DescribeWhatIfForecastResponse < Struct.new(
  :what_if_forecast_name,
  :what_if_forecast_arn,
  :what_if_analysis_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_transformations,
  :time_series_replacements_data_source,
  :forecast_types)
  SENSITIVE = []
  include Aws::Structure
end