You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:

Struct

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

Defined in:

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

Overview

See Also:

• AWS API Documentation

Instance Attribute Summary

• #creation_time ⇒ Time

  When the dataset import job was created.

• #data_size ⇒ Float

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

• #data_source ⇒ Types::DataSource

  The location of the training data to import.

• #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.

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

  Statistical information about each field in the input data.

• #last_modification_time ⇒ Time

  Dependent on the status as follows:.

• #message ⇒ String

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

• #status ⇒ String

  The status of the dataset import job.

• #timestamp_format ⇒ String

  The format of timestamps in the dataset.

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 1080

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :data_source,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#data_size ⇒ Float

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

Returns:

• (Float)

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :data_source,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#data_source ⇒ Types::DataSource

The location of the training data to import. The training data must be stored in an Amazon S3 bucket.

Returns:

• (Types::DataSource)

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

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

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

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

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :data_source,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#last_modification_time ⇒ Time

Dependent on the status as follows:

• CREATE_PENDING - same as CreationTime

• CREATE_IN_PROGRESS - the current timestamp

• ACTIVE or CREATE_FAILED - when the job finished or failed

Returns:

• (Time)

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

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :data_source,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#status ⇒ String

The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Returns:

• (String)

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

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :data_source,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end

#timestamp_format ⇒ String

The format of timestamps in the dataset. Two formats are supported dependent on the DataFrequency specified when the dataset was created.

• "yyyy-MM-dd"

  For data frequencies: Y, M, W, and D

• "yyyy-MM-dd HH:mm:ss"

  For 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 1080

class DescribeDatasetImportJobResponse < Struct.new(
  :dataset_import_job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :timestamp_format,
  :data_source,
  :field_statistics,
  :data_size,
  :status,
  :message,
  :creation_time,
  :last_modification_time)
  include Aws::Structure
end