Class: Aws::ForecastService::Types::ForecastExportJobSummary

Inherits:

Struct

• Object
• Struct
• Aws::ForecastService::Types::ForecastExportJobSummary

Defined in:

gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

Overview

Provides a summary of the forecast export job properties used in the ListForecastExportJobs operation. To get the complete set of properties, call the DescribeForecastExportJob operation, and provide the listed ForecastExportJobArn.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_time ⇒ Time

  When the forecast export job was created.

• #destination ⇒ Types::DataDestination

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

• #forecast_export_job_arn ⇒ String

  The Amazon Resource Name (ARN) of the forecast export job.

• #forecast_export_job_name ⇒ String

  The name of the forecast export job.

• #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 forecast export job.

Instance Attribute Details

#creation_time ⇒ Time

When the forecast export job was created.

Returns:

• (Time)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4403

class ForecastExportJobSummary < Struct.new(
  :forecast_export_job_arn,
  :forecast_export_job_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:

• (Types::DataDestination)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4403

class ForecastExportJobSummary < Struct.new(
  :forecast_export_job_arn,
  :forecast_export_job_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_export_job_arn ⇒ String

The Amazon Resource Name (ARN) of the forecast export job.

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4403

class ForecastExportJobSummary < Struct.new(
  :forecast_export_job_arn,
  :forecast_export_job_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_export_job_name ⇒ String

The name of the forecast export job.

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4403

class ForecastExportJobSummary < Struct.new(
  :forecast_export_job_arn,
  :forecast_export_job_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)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4403

class ForecastExportJobSummary < Struct.new(
  :forecast_export_job_arn,
  :forecast_export_job_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)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4403

class ForecastExportJobSummary < Struct.new(
  :forecast_export_job_arn,
  :forecast_export_job_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 4403

class ForecastExportJobSummary < Struct.new(
  :forecast_export_job_arn,
  :forecast_export_job_name,
  :destination,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  SENSITIVE = []
  include Aws::Structure
end