Class: Aws::Personalize::Types::DataDeletionJob
- Inherits:
-
Struct
- Object
- Struct
- Aws::Personalize::Types::DataDeletionJob
- Includes:
- Structure
- Defined in:
- 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].
[1]: docs.aws.amazon.com/personalize/latest/dg/delete-records.html
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#creation_date_time ⇒ Time
The creation date and time (in Unix time) of the data deletion job.
-
#data_deletion_job_arn ⇒ String
The Amazon Resource Name (ARN) of the data deletion job.
-
#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.
-
#dataset_group_arn ⇒ String
The Amazon Resource Name (ARN) of the dataset group the job deletes records from.
-
#failure_reason ⇒ String
If a data deletion job fails, provides the reason why.
-
#job_name ⇒ String
The name of the data deletion job.
-
#last_updated_date_time ⇒ Time
The date and time (in Unix time) the data deletion job was last updated.
-
#num_deleted ⇒ Integer
The number of records deleted by a COMPLETED job.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3 data source.
-
#status ⇒ String
The status of the data deletion job.
Instance Attribute Details
#creation_date_time ⇒ Time
The creation date and time (in Unix time) of the data deletion job.
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 |
# File '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.
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 |
# File '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.
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 |
# File '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.
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 |
# File '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.
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 |
# File '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.
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 |
# File '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.
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 |
# File '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.
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 |
# File '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.
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 |
# File '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
^
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 |
# File '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 |