Class: Aws::ForecastService::Types::DescribeWhatIfForecastExportResponse

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

Returns:

  • (Time)


3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3607

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

#destinationTypes::DataDestination

The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).



3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3607

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

#estimated_time_remaining_in_minutesInteger

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

Returns:

  • (Integer)


3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3607

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

#formatString

The format of the exported data, CSV or PARQUET.

Returns:

  • (String)


3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3607

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


3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3607

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

#messageString

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

Returns:

  • (String)


3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3607

class DescribeWhatIfForecastExportResponse < Struct.new(
  :what_if_forecast_export_arn,
  :what_if_forecast_export_name,
  :what_if_forecast_arns,
  :destination,
  :message,
  :status,
  :creation_time,
  :estimated_time_remaining_in_minutes,
  :last_modification_time,
  :format)
  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 export must be ACTIVE before you can access the forecast export.

Returns:

  • (String)


3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3607

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

#what_if_forecast_arnsArray<String>

An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.

Returns:

  • (Array<String>)


3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3607

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

#what_if_forecast_export_arnString

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

Returns:

  • (String)


3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3607

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

#what_if_forecast_export_nameString

The name of the what-if forecast export.

Returns:

  • (String)


3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3607

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