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

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 dataset import job was created.

Returns:

  • (Time)


2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2828

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_sizeFloat

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

Returns:

  • (Float)


2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2828

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_sourceTypes::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:



2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2828

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_arnString

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

Returns:

  • (String)


2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2828

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_arnString

The ARN of the dataset import job.

Returns:

  • (String)


2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2828

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_nameString

The name of the dataset import job.

Returns:

  • (String)


2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2828

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_minutesInteger

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

Returns:

  • (Integer)


2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2828

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_statisticsHash<String,Types::Statistics>

Statistical information about each field in the input data.

Returns:



2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2828

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

#formatString

The format of the imported data, CSV or PARQUET.

Returns:

  • (String)


2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2828

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_formatString

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

Returns:

  • (String)


2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2828

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_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)


2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2828

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

#messageString

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

Returns:

  • (String)


2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2828

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

#statusString

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)


2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2828

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_zoneString

The single time zone applied to every item in the dataset

Returns:

  • (String)


2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2828

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_formatString

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)


2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2828

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_zoneBoolean

Whether TimeZone is automatically derived from the geolocation attribute.

Returns:

  • (Boolean)


2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 2828

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