Class: Aws::Personalize::Types::DatasetImportJob

Inherits:

Struct

• Object
• Struct
• Aws::Personalize::Types::DatasetImportJob

Defined in:

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

Overview

Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. For more information, see CreateDatasetImportJob.

A dataset import job can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

^

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_date_time ⇒ Time

  The creation date and time (in Unix time) of the dataset import job.

• #data_source ⇒ Types::DataSource

  The Amazon S3 bucket that contains the training data to import.

• #dataset_arn ⇒ String

  The Amazon Resource Name (ARN) of the dataset that receives the imported data.

• #dataset_import_job_arn ⇒ String

  The ARN of the dataset import job.

• #failure_reason ⇒ String

  If a dataset import job fails, provides the reason why.

• #import_mode ⇒ String

  The import mode used by the dataset import job to import new records.

• #job_name ⇒ String

  The name of the import job.

• #last_updated_date_time ⇒ Time

  The date and time (in Unix time) the dataset was last updated.

• #publish_attribution_metrics_to_s3 ⇒ Boolean

  Whether the job publishes metrics to Amazon S3 for a metric attribution.

• #role_arn ⇒ String

  The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

• #status ⇒ String

  The status of the dataset import job.

Instance Attribute Details

#creation_date_time ⇒ Time

The creation date and time (in Unix time) of the dataset import job.

Returns:

• (Time)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2240

class DatasetImportJob < Struct.new(
  :job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :data_source,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason,
  :import_mode,
  :publish_attribution_metrics_to_s3)
  SENSITIVE = []
  include Aws::Structure
end

#data_source ⇒ Types::DataSource

The Amazon S3 bucket that contains the training data to import.

Returns:

• (Types::DataSource)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2240

class DatasetImportJob < Struct.new(
  :job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :data_source,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason,
  :import_mode,
  :publish_attribution_metrics_to_s3)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_arn ⇒ String

The Amazon Resource Name (ARN) of the dataset that receives the imported data.

Returns:

• (String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2240

class DatasetImportJob < Struct.new(
  :job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :data_source,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason,
  :import_mode,
  :publish_attribution_metrics_to_s3)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_import_job_arn ⇒ String

The ARN of the dataset import job.

Returns:

• (String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2240

class DatasetImportJob < Struct.new(
  :job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :data_source,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason,
  :import_mode,
  :publish_attribution_metrics_to_s3)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

If a dataset import job fails, provides the reason why.

Returns:

• (String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2240

class DatasetImportJob < Struct.new(
  :job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :data_source,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason,
  :import_mode,
  :publish_attribution_metrics_to_s3)
  SENSITIVE = []
  include Aws::Structure
end

#import_mode ⇒ String

The import mode used by the dataset import job to import new records.

Returns:

• (String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2240

class DatasetImportJob < Struct.new(
  :job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :data_source,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason,
  :import_mode,
  :publish_attribution_metrics_to_s3)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The name of the import job.

Returns:

• (String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2240

class DatasetImportJob < Struct.new(
  :job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :data_source,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason,
  :import_mode,
  :publish_attribution_metrics_to_s3)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_date_time ⇒ Time

The date and time (in Unix time) the dataset was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2240

class DatasetImportJob < Struct.new(
  :job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :data_source,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason,
  :import_mode,
  :publish_attribution_metrics_to_s3)
  SENSITIVE = []
  include Aws::Structure
end

#publish_attribution_metrics_to_s3 ⇒ Boolean

Whether the job publishes metrics to Amazon S3 for a metric attribution.

Returns:

• (Boolean)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2240

class DatasetImportJob < Struct.new(
  :job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :data_source,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason,
  :import_mode,
  :publish_attribution_metrics_to_s3)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

Returns:

• (String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2240

class DatasetImportJob < Struct.new(
  :job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :data_source,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason,
  :import_mode,
  :publish_attribution_metrics_to_s3)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the dataset import job.

A dataset import job can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

^

Returns:

• (String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2240

class DatasetImportJob < Struct.new(
  :job_name,
  :dataset_import_job_arn,
  :dataset_arn,
  :data_source,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason,
  :import_mode,
  :publish_attribution_metrics_to_s3)
  SENSITIVE = []
  include Aws::Structure
end