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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time ⇒ Time

When the dataset import job was created.

Returns:

  • (Time) 


2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  SENSITIVE = []
  include Aws::Structure
end

#data_size ⇒ Float

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

Returns:

  • (Float) 


2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  SENSITIVE = []
  include Aws::Structure
end

#data_source ⇒ Types::DataSource

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

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

Returns:



2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  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) 


2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_import_job_arn ⇒ String

The ARN of the dataset import job.

Returns:

  • (String) 


2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_import_job_name ⇒ String

The name of the dataset import job.

Returns:

  • (String) 


2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  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) 


2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  SENSITIVE = []
  include Aws::Structure
end

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

Statistical information about each field in the input data.

Returns:



2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

The format of the imported data, CSV or PARQUET.

Returns:

  • (String) 


2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  SENSITIVE = []
  include Aws::Structure
end

#geolocation_format ⇒ String

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

Returns:

  • (String) 


2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  SENSITIVE = []
  include Aws::Structure
end

#import_mode ⇒ String

The import mode of the dataset import job, FULL or INCREMENTAL.

Returns:

  • (String) 


2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  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) 


2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

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

Returns:

  • (String) 


2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  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) 


2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  SENSITIVE = []
  include Aws::Structure
end

#time_zone ⇒ String

The single time zone applied to every item in the dataset

Returns:

  • (String) 


2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  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) 


2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  SENSITIVE = []
  include Aws::Structure
end

#use_geolocation_for_time_zone ⇒ Boolean

Whether TimeZone is automatically derived from the geolocation attribute.

Returns:

  • (Boolean) 


2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2607

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,
  :import_mode)
  SENSITIVE = []
  include Aws::Structure
end