Class: Aws::Personalize::Types::DatasetExportJob

Inherits:

Struct

• Object
• Struct
• Aws::Personalize::Types::DatasetExportJob

Includes:

Structure

Defined in:

lib/aws-sdk-personalize/types.rb

Overview

Describes a job that exports a dataset to an Amazon S3 bucket. For more information, see [CreateDatasetExportJob].

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

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

^

[1]: docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html

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

• #dataset_arn ⇒ String

  The Amazon Resource Name (ARN) of the dataset to export.

• #dataset_export_job_arn ⇒ String

  The Amazon Resource Name (ARN) of the dataset export job.

• #failure_reason ⇒ String

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

• #ingestion_mode ⇒ String

  The data to export, based on how you imported the data.

• #job_name ⇒ String

  The name of the export job.

• #job_output ⇒ Types::DatasetExportJobOutput

  The path to the Amazon S3 bucket where the job’s output is stored.

• #last_updated_date_time ⇒ Time

  The date and time (in Unix time) the status of the dataset export job was last updated.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

• #status ⇒ String

  The status of the dataset export job.

Instance Attribute Details

#creation_date_time ⇒ Time

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

Returns:

• (Time)

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

class DatasetExportJob < Struct.new(
  :job_name,
  :dataset_export_job_arn,
  :dataset_arn,
  :ingestion_mode,
  :role_arn,
  :status,
  :job_output,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_arn ⇒ String

The Amazon Resource Name (ARN) of the dataset to export.

Returns:

• (String)

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

class DatasetExportJob < Struct.new(
  :job_name,
  :dataset_export_job_arn,
  :dataset_arn,
  :ingestion_mode,
  :role_arn,
  :status,
  :job_output,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_export_job_arn ⇒ String

The Amazon Resource Name (ARN) of the dataset export job.

Returns:

• (String)

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

class DatasetExportJob < Struct.new(
  :job_name,
  :dataset_export_job_arn,
  :dataset_arn,
  :ingestion_mode,
  :role_arn,
  :status,
  :job_output,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

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

Returns:

• (String)

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

class DatasetExportJob < Struct.new(
  :job_name,
  :dataset_export_job_arn,
  :dataset_arn,
  :ingestion_mode,
  :role_arn,
  :status,
  :job_output,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#ingestion_mode ⇒ String

The data to export, based on how you imported the data. You can choose to export ‘BULK` data that you imported using a dataset import job, `PUT` data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or `ALL` for both types. The default value is `PUT`.

Returns:

• (String)

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

class DatasetExportJob < Struct.new(
  :job_name,
  :dataset_export_job_arn,
  :dataset_arn,
  :ingestion_mode,
  :role_arn,
  :status,
  :job_output,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The name of the export job.

Returns:

• (String)

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

class DatasetExportJob < Struct.new(
  :job_name,
  :dataset_export_job_arn,
  :dataset_arn,
  :ingestion_mode,
  :role_arn,
  :status,
  :job_output,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#job_output ⇒ Types::DatasetExportJobOutput

The path to the Amazon S3 bucket where the job’s output is stored. For example:

‘s3://bucket-name/folder-name/`

Returns:

• (Types::DatasetExportJobOutput)

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

class DatasetExportJob < Struct.new(
  :job_name,
  :dataset_export_job_arn,
  :dataset_arn,
  :ingestion_mode,
  :role_arn,
  :status,
  :job_output,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_date_time ⇒ Time

The date and time (in Unix time) the status of the dataset export job was last updated.

Returns:

• (Time)

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

class DatasetExportJob < Struct.new(
  :job_name,
  :dataset_export_job_arn,
  :dataset_arn,
  :ingestion_mode,
  :role_arn,
  :status,
  :job_output,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

Returns:

• (String)

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

class DatasetExportJob < Struct.new(
  :job_name,
  :dataset_export_job_arn,
  :dataset_arn,
  :ingestion_mode,
  :role_arn,
  :status,
  :job_output,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the dataset export job.

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

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

^

Returns:

• (String)

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

class DatasetExportJob < Struct.new(
  :job_name,
  :dataset_export_job_arn,
  :dataset_arn,
  :ingestion_mode,
  :role_arn,
  :status,
  :job_output,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end