Class: Aws::Personalize::Types::DataDeletionJob

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb

Overview

Describes a job that deletes all references to specific users from an Amazon Personalize dataset group in batches. For information about creating a data deletion job, see Deleting users.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_date_time ⇒ Time

The creation date and time (in Unix time) of the data deletion job.

Returns:

  • (Time) 


1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1891

class DataDeletionJob < Struct.new(
  :job_name,
  :data_deletion_job_arn,
  :dataset_group_arn,
  :data_source,
  :role_arn,
  :status,
  :num_deleted,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#data_deletion_job_arn ⇒ String

The Amazon Resource Name (ARN) of the data deletion job.

Returns:

  • (String) 


1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1891

class DataDeletionJob < Struct.new(
  :job_name,
  :data_deletion_job_arn,
  :dataset_group_arn,
  :data_source,
  :role_arn,
  :status,
  :num_deleted,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#data_source ⇒ Types::DataSource

Describes the data source that contains the data to upload to a dataset, or the list of records to delete from Amazon Personalize.

Returns:



1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1891

class DataDeletionJob < Struct.new(
  :job_name,
  :data_deletion_job_arn,
  :dataset_group_arn,
  :data_source,
  :role_arn,
  :status,
  :num_deleted,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_group_arn ⇒ String

The Amazon Resource Name (ARN) of the dataset group the job deletes records from.

Returns:

  • (String) 


1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1891

class DataDeletionJob < Struct.new(
  :job_name,
  :data_deletion_job_arn,
  :dataset_group_arn,
  :data_source,
  :role_arn,
  :status,
  :num_deleted,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

If a data deletion job fails, provides the reason why.

Returns:

  • (String) 


1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1891

class DataDeletionJob < Struct.new(
  :job_name,
  :data_deletion_job_arn,
  :dataset_group_arn,
  :data_source,
  :role_arn,
  :status,
  :num_deleted,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The name of the data deletion job.

Returns:

  • (String) 


1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1891

class DataDeletionJob < Struct.new(
  :job_name,
  :data_deletion_job_arn,
  :dataset_group_arn,
  :data_source,
  :role_arn,
  :status,
  :num_deleted,
  :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 data deletion job was last updated.

Returns:

  • (Time) 


1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1891

class DataDeletionJob < Struct.new(
  :job_name,
  :data_deletion_job_arn,
  :dataset_group_arn,
  :data_source,
  :role_arn,
  :status,
  :num_deleted,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#num_deleted ⇒ Integer

The number of records deleted by a COMPLETED job.

Returns:

  • (Integer) 


1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1891

class DataDeletionJob < Struct.new(
  :job_name,
  :data_deletion_job_arn,
  :dataset_group_arn,
  :data_source,
  :role_arn,
  :status,
  :num_deleted,
  :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 role that has permissions to read from the Amazon S3 data source.

Returns:

  • (String) 


1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1891

class DataDeletionJob < Struct.new(
  :job_name,
  :data_deletion_job_arn,
  :dataset_group_arn,
  :data_source,
  :role_arn,
  :status,
  :num_deleted,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the data deletion job.

A data deletion job can have one of the following statuses:

  • PENDING > IN_PROGRESS > COMPLETED -or- FAILED

^

Returns:

  • (String) 


1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1891

class DataDeletionJob < Struct.new(
  :job_name,
  :data_deletion_job_arn,
  :dataset_group_arn,
  :data_source,
  :role_arn,
  :status,
  :num_deleted,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end