Class: Aws::ForecastService::Types::DescribeWhatIfForecastExportResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::ForecastService::Types::DescribeWhatIfForecastExportResponse
- Defined in:
- gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#creation_time ⇒ Time
When the what-if forecast export was created.
-
#destination ⇒ Types::DataDestination
The destination for an export job.
-
#estimated_time_remaining_in_minutes ⇒ Integer
The approximate time remaining to complete the what-if forecast export, in minutes.
-
#format ⇒ String
The format of the exported data, CSV or PARQUET.
-
#last_modification_time ⇒ Time
The last time the resource was modified.
-
#message ⇒ String
If an error occurred, an informational message about the error.
-
#status ⇒ String
The status of the what-if forecast.
-
#what_if_forecast_arns ⇒ Array<String>
An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.
-
#what_if_forecast_export_arn ⇒ String
The Amazon Resource Name (ARN) of the what-if forecast export.
-
#what_if_forecast_export_name ⇒ String
The name of the what-if forecast export.
Instance Attribute Details
#creation_time ⇒ Time
When the what-if forecast export was created.
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 |
#destination ⇒ Types::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_minutes ⇒ Integer
The approximate time remaining to complete the what-if forecast export, in minutes.
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 |
#format ⇒ String
The format of the exported data, CSV or PARQUET.
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_time ⇒ Time
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
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 |
#message ⇒ String
If an error occurred, an informational message about the error.
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 |
#status ⇒ String
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
Status
of the what-if forecast export must be ACTIVE
before
you can access the forecast export.
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_arns ⇒ Array<String>
An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.
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_arn ⇒ String
The Amazon Resource Name (ARN) of the what-if forecast export.
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_name ⇒ String
The name of the what-if forecast export.
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 |