Class: Aws::ForecastService::Types::WhatIfForecastExportSummary

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

Overview

Provides a summary of the what-if forecast export properties used in the ListWhatIfForecastExports operation. To get the complete set of properties, call the DescribeWhatIfForecastExport operation, and provide the WhatIfForecastExportArn that is listed in the summary.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time ⇒ Time

When the what-if forecast export was created.

Returns:

  • (Time) 


7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 7090

class WhatIfForecastExportSummary < Struct.new(
  :what_if_forecast_export_arn,
  :what_if_forecast_arns,
  :what_if_forecast_export_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#destination ⇒ Types::DataDestination

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

Returns:



7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 7090

class WhatIfForecastExportSummary < Struct.new(
  :what_if_forecast_export_arn,
  :what_if_forecast_arns,
  :what_if_forecast_export_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  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) 


7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 7090

class WhatIfForecastExportSummary < Struct.new(
  :what_if_forecast_export_arn,
  :what_if_forecast_arns,
  :what_if_forecast_export_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

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

Returns:

  • (String) 


7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 7090

class WhatIfForecastExportSummary < Struct.new(
  :what_if_forecast_export_arn,
  :what_if_forecast_arns,
  :what_if_forecast_export_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the what-if forecast export. 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) 


7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 7090

class WhatIfForecastExportSummary < Struct.new(
  :what_if_forecast_export_arn,
  :what_if_forecast_arns,
  :what_if_forecast_export_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#what_if_forecast_arns ⇒ Array<String>

An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.

Returns:

  • (Array<String>) 


7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 7090

class WhatIfForecastExportSummary < Struct.new(
  :what_if_forecast_export_arn,
  :what_if_forecast_arns,
  :what_if_forecast_export_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#what_if_forecast_export_arn ⇒ String

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

Returns:

  • (String) 


7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 7090

class WhatIfForecastExportSummary < Struct.new(
  :what_if_forecast_export_arn,
  :what_if_forecast_arns,
  :what_if_forecast_export_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#what_if_forecast_export_name ⇒ String

The what-if forecast export name.

Returns:

  • (String) 


7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 7090

class WhatIfForecastExportSummary < Struct.new(
  :what_if_forecast_export_arn,
  :what_if_forecast_arns,
  :what_if_forecast_export_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end