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

Constant Summary

SENSITIVE =

[]

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

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

  Statistical information about each field in the input data.

• #last_modification_time ⇒ Time

  The last time that the dataset was modified.

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

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

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

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

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

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

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

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

#last_modification_time ⇒ Time

The last time that the dataset was modified. The time depends on the status of the job, as follows:

• CREATE_PENDING - The same time 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 1167

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

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)
  SENSITIVE = []
  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 1167

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

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