Class: Aws::ForecastService::Types::DescribeWhatIfAnalysisResponse

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

#creation_timeTime

When the what-if analysis was created.

Returns:

  • (Time)


3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3509

class DescribeWhatIfAnalysisResponse < Struct.new(
  :what_if_analysis_name,
  :what_if_analysis_arn,
  :forecast_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_selector)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_time_remaining_in_minutesInteger

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

Returns:

  • (Integer)


3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3509

class DescribeWhatIfAnalysisResponse < Struct.new(
  :what_if_analysis_name,
  :what_if_analysis_arn,
  :forecast_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_selector)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_arnString

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

Returns:

  • (String)


3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3509

class DescribeWhatIfAnalysisResponse < Struct.new(
  :what_if_analysis_name,
  :what_if_analysis_arn,
  :forecast_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_selector)
  SENSITIVE = []
  include Aws::Structure
end

#last_modification_timeTime

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)


3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3509

class DescribeWhatIfAnalysisResponse < Struct.new(
  :what_if_analysis_name,
  :what_if_analysis_arn,
  :forecast_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_selector)
  SENSITIVE = []
  include Aws::Structure
end

#messageString

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

Returns:

  • (String)


3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3509

class DescribeWhatIfAnalysisResponse < Struct.new(
  :what_if_analysis_name,
  :what_if_analysis_arn,
  :forecast_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_selector)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the what-if analysis. 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 analysis must be ACTIVE before you can access the analysis.

Returns:

  • (String)


3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3509

class DescribeWhatIfAnalysisResponse < Struct.new(
  :what_if_analysis_name,
  :what_if_analysis_arn,
  :forecast_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_selector)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_selectorTypes::TimeSeriesSelector

Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers object.

The TimeSeriesIdentifiers object needs the following information:

  • DataSource

  • Format

  • Schema



3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3509

class DescribeWhatIfAnalysisResponse < Struct.new(
  :what_if_analysis_name,
  :what_if_analysis_arn,
  :forecast_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_selector)
  SENSITIVE = []
  include Aws::Structure
end

#what_if_analysis_arnString

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

Returns:

  • (String)


3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3509

class DescribeWhatIfAnalysisResponse < Struct.new(
  :what_if_analysis_name,
  :what_if_analysis_arn,
  :forecast_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_selector)
  SENSITIVE = []
  include Aws::Structure
end

#what_if_analysis_nameString

The name of the what-if analysis.

Returns:

  • (String)


3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3509

class DescribeWhatIfAnalysisResponse < Struct.new(
  :what_if_analysis_name,
  :what_if_analysis_arn,
  :forecast_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_selector)
  SENSITIVE = []
  include Aws::Structure
end