Class: Aws::ForecastService::Types::DescribeForecastResponse

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

Returns:

  • (Time)


3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3052

class DescribeForecastResponse < Struct.new(
  :forecast_arn,
  :forecast_name,
  :forecast_types,
  :predictor_arn,
  :dataset_group_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_selector)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_group_arnString

The ARN of the dataset group that provided the data used to train the predictor.

Returns:

  • (String)


3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3052

class DescribeForecastResponse < Struct.new(
  :forecast_arn,
  :forecast_name,
  :forecast_types,
  :predictor_arn,
  :dataset_group_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 estimated time remaining in minutes for the forecast job to complete.

Returns:

  • (Integer)


3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3052

class DescribeForecastResponse < Struct.new(
  :forecast_arn,
  :forecast_name,
  :forecast_types,
  :predictor_arn,
  :dataset_group_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_selector)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_arnString

The forecast ARN as specified in the request.

Returns:

  • (String)


3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3052

class DescribeForecastResponse < Struct.new(
  :forecast_arn,
  :forecast_name,
  :forecast_types,
  :predictor_arn,
  :dataset_group_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_selector)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_nameString

The name of the forecast.

Returns:

  • (String)


3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3052

class DescribeForecastResponse < Struct.new(
  :forecast_arn,
  :forecast_name,
  :forecast_types,
  :predictor_arn,
  :dataset_group_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_selector)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_typesArray<String>

The quantiles at which probabilistic forecasts were generated.

Returns:

  • (Array<String>)


3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3052

class DescribeForecastResponse < Struct.new(
  :forecast_arn,
  :forecast_name,
  :forecast_types,
  :predictor_arn,
  :dataset_group_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)


3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3052

class DescribeForecastResponse < Struct.new(
  :forecast_arn,
  :forecast_name,
  :forecast_types,
  :predictor_arn,
  :dataset_group_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)


3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3052

class DescribeForecastResponse < Struct.new(
  :forecast_arn,
  :forecast_name,
  :forecast_types,
  :predictor_arn,
  :dataset_group_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_selector)
  SENSITIVE = []
  include Aws::Structure
end

#predictor_arnString

The ARN of the predictor used to generate the forecast.

Returns:

  • (String)


3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3052

class DescribeForecastResponse < Struct.new(
  :forecast_arn,
  :forecast_name,
  :forecast_types,
  :predictor_arn,
  :dataset_group_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 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 forecast must be ACTIVE before you can query or export the forecast.

Returns:

  • (String)


3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3052

class DescribeForecastResponse < Struct.new(
  :forecast_arn,
  :forecast_name,
  :forecast_types,
  :predictor_arn,
  :dataset_group_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

The time series to include in the forecast.



3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3052

class DescribeForecastResponse < Struct.new(
  :forecast_arn,
  :forecast_name,
  :forecast_types,
  :predictor_arn,
  :dataset_group_arn,
  :estimated_time_remaining_in_minutes,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :time_series_selector)
  SENSITIVE = []
  include Aws::Structure
end