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

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 forecast was created.

Returns:

  • (Time)


4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4458

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_minutesInteger

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

Returns:

  • (Integer)


4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4458

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_typesArray<String>

The quantiles at which probabilistic forecasts are generated. You can specify up to 5 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>)


4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4458

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_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)


4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4458

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

#messageString

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

Returns:

  • (String)


4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4458

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

#statusString

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)


4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4458

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_sourceTypes::TimeSeriesReplacementsDataSource

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



4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4458

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_transformationsArray<Types::TimeSeriesTransformation>

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



4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4458

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_arnString

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

Returns:

  • (String)


4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4458

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_arnString

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

Returns:

  • (String)


4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4458

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_nameString

The name of the what-if forecast.

Returns:

  • (String)


4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4458

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