Class: Aws::ForecastService::Types::DescribeDatasetImportJobResponse

Inherits:

Struct

Object
Struct
Aws::ForecastService::Types::DescribeDatasetImportJobResponse

show all

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 dataset import job was created.
#data_size ⇒ Float
The size of the dataset in gigabytes (GB) after the import job has finished.
#data_source ⇒ Types::DataSource
The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.
#dataset_arn ⇒ String
The Amazon Resource Name (ARN) of the dataset that the training data was imported to.
#dataset_import_job_arn ⇒ String
The ARN of the dataset import job.
#dataset_import_job_name ⇒ String
The name of the dataset import job.
#estimated_time_remaining_in_minutes ⇒ Integer
The estimated time remaining in minutes for the dataset import job to complete.
#field_statistics ⇒ Hash<String,Types::Statistics>
Statistical information about each field in the input data.
#format ⇒ String
The format of the imported data, CSV or PARQUET.
#geolocation_format ⇒ String
The format of the geolocation attribute.
#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 dataset import job.
#time_zone ⇒ String
The single time zone applied to every item in the dataset.
#timestamp_format ⇒ String
The format of timestamps in the dataset.
#use_geolocation_for_time_zone ⇒ Boolean
Whether TimeZone is automatically derived from the geolocation attribute.

Instance Attribute Details

#creation_time ⇒ `Time`

When the dataset import job was created.

Returns:

(Time)

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :time_zone,
  :use_geolocation_for_time_zone,
  :geolocation_format,
  :data_source,
  :estimated_time_remaining_in_minutes,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :format)
  SENSITIVE = []
  include Aws::Structure
end

#data_size ⇒ `Float`

The size of the dataset in gigabytes (GB) after the import job has finished.

Returns:

(Float)

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :time_zone,
  :use_geolocation_for_time_zone,
  :geolocation_format,
  :data_source,
  :estimated_time_remaining_in_minutes,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :format)
  SENSITIVE = []
  include Aws::Structure
end

#data_source ⇒ `Types::DataSource`

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

Returns:

(Types::DataSource)

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :time_zone,
  :use_geolocation_for_time_zone,
  :geolocation_format,
  :data_source,
  :estimated_time_remaining_in_minutes,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :format)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_arn ⇒ `String`

The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

Returns:

(String)

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :time_zone,
  :use_geolocation_for_time_zone,
  :geolocation_format,
  :data_source,
  :estimated_time_remaining_in_minutes,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :format)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_import_job_arn ⇒ `String`

The ARN of the dataset import job.

Returns:

(String)

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :time_zone,
  :use_geolocation_for_time_zone,
  :geolocation_format,
  :data_source,
  :estimated_time_remaining_in_minutes,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :format)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_import_job_name ⇒ `String`

The name of the dataset import job.

Returns:

(String)

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :time_zone,
  :use_geolocation_for_time_zone,
  :geolocation_format,
  :data_source,
  :estimated_time_remaining_in_minutes,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :format)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_time_remaining_in_minutes ⇒ `Integer`

The estimated time remaining in minutes for the dataset import job to complete.

Returns:

(Integer)

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :time_zone,
  :use_geolocation_for_time_zone,
  :geolocation_format,
  :data_source,
  :estimated_time_remaining_in_minutes,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :format)
  SENSITIVE = []
  include Aws::Structure
end

#field_statistics ⇒ `Hash<String,Types::Statistics>`

Statistical information about each field in the input data.

Returns:

(Hash<String,Types::Statistics>)

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :time_zone,
  :use_geolocation_for_time_zone,
  :geolocation_format,
  :data_source,
  :estimated_time_remaining_in_minutes,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :format)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ `String`

The format of the imported data, CSV or PARQUET.

Returns:

(String)

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :time_zone,
  :use_geolocation_for_time_zone,
  :geolocation_format,
  :data_source,
  :estimated_time_remaining_in_minutes,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :format)
  SENSITIVE = []
  include Aws::Structure
end

#geolocation_format ⇒ `String`

The format of the geolocation attribute. Valid Values:"LAT_LONG" and "CC_POSTALCODE".

Returns:

(String)

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :time_zone,
  :use_geolocation_for_time_zone,
  :geolocation_format,
  :data_source,
  :estimated_time_remaining_in_minutes,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :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 - 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 3216

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :time_zone,
  :use_geolocation_for_time_zone,
  :geolocation_format,
  :data_source,
  :estimated_time_remaining_in_minutes,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :format)
  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 3216

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :time_zone,
  :use_geolocation_for_time_zone,
  :geolocation_format,
  :data_source,
  :estimated_time_remaining_in_minutes,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :format)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of the dataset import job. States include:

ACTIVE
CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
CREATE_STOPPING, CREATE_STOPPED

Returns:

(String)

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :time_zone,
  :use_geolocation_for_time_zone,
  :geolocation_format,
  :data_source,
  :estimated_time_remaining_in_minutes,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :format)
  SENSITIVE = []
  include Aws::Structure
end

#time_zone ⇒ `String`

The single time zone applied to every item in the dataset

Returns:

(String)

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :time_zone,
  :use_geolocation_for_time_zone,
  :geolocation_format,
  :data_source,
  :estimated_time_remaining_in_minutes,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :format)
  SENSITIVE = []
  include Aws::Structure
end

#timestamp_format ⇒ `String`

The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

"yyyy-MM-dd"

For the following data frequencies: Y, M, W, and D
"yyyy-MM-dd HH:mm:ss"

For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

Returns:

(String)

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :time_zone,
  :use_geolocation_for_time_zone,
  :geolocation_format,
  :data_source,
  :estimated_time_remaining_in_minutes,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :format)
  SENSITIVE = []
  include Aws::Structure
end

#use_geolocation_for_time_zone ⇒ `Boolean`

Whether TimeZone is automatically derived from the geolocation attribute.

Returns:

(Boolean)

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :time_zone,
  :use_geolocation_for_time_zone,
  :geolocation_format,
  :data_source,
  :estimated_time_remaining_in_minutes,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time,
  :format)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::ForecastService::Types::DescribeDatasetImportJobResponse

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time ⇒ Time

#data_size ⇒ Float

#data_source ⇒ Types::DataSource

#dataset_arn ⇒ String

#dataset_import_job_arn ⇒ String

#dataset_import_job_name ⇒ String

#estimated_time_remaining_in_minutes ⇒ Integer

#field_statistics ⇒ Hash<String,Types::Statistics>

#format ⇒ String

#geolocation_format ⇒ String

#last_modification_time ⇒ Time

#message ⇒ String

#status ⇒ String

#time_zone ⇒ String

#timestamp_format ⇒ String

#use_geolocation_for_time_zone ⇒ Boolean

#creation_time ⇒ `Time`

#data_size ⇒ `Float`

#data_source ⇒ `Types::DataSource`

#dataset_arn ⇒ `String`

#dataset_import_job_arn ⇒ `String`

#dataset_import_job_name ⇒ `String`

#estimated_time_remaining_in_minutes ⇒ `Integer`

#field_statistics ⇒ `Hash<String,Types::Statistics>`

#format ⇒ `String`

#geolocation_format ⇒ `String`

#last_modification_time ⇒ `Time`

#message ⇒ `String`

#status ⇒ `String`

#time_zone ⇒ `String`

#timestamp_format ⇒ `String`

#use_geolocation_for_time_zone ⇒ `Boolean`