Class: Aws::Comprehend::Types::TopicsDetectionJobProperties
- Inherits:
-
Struct
- Object
- Struct
- Aws::Comprehend::Types::TopicsDetectionJobProperties
- Defined in:
- gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb
Overview
Provides information about a topic detection job.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#data_access_role_arn ⇒ String
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
-
#end_time ⇒ Time
The time that the topic detection job was completed.
-
#input_data_config ⇒ Types::InputDataConfig
The input data configuration supplied when you created the topic detection job.
-
#job_arn ⇒ String
The Amazon Resource Name (ARN) of the topics detection job.
-
#job_id ⇒ String
The identifier assigned to the topic detection job.
-
#job_name ⇒ String
The name of the topic detection job.
-
#job_status ⇒ String
The current status of the topic detection job.
-
#message ⇒ String
A description for the status of a job.
-
#number_of_topics ⇒ Integer
The number of topics to detect supplied when you created the topic detection job.
-
#output_data_config ⇒ Types::OutputDataConfig
The output data configuration supplied when you created the topic detection job.
-
#submit_time ⇒ Time
The time that the topic detection job was submitted for processing.
-
#volume_kms_key_id ⇒ String
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.
-
#vpc_config ⇒ Types::VpcConfig
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job.
Instance Attribute Details
#data_access_role_arn ⇒ String
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7780 class TopicsDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :number_of_topics, :data_access_role_arn, :volume_kms_key_id, :vpc_config) SENSITIVE = [] include Aws::Structure end |
#end_time ⇒ Time
The time that the topic detection job was completed.
7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7780 class TopicsDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :number_of_topics, :data_access_role_arn, :volume_kms_key_id, :vpc_config) SENSITIVE = [] include Aws::Structure end |
#input_data_config ⇒ Types::InputDataConfig
The input data configuration supplied when you created the topic detection job.
7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7780 class TopicsDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :number_of_topics, :data_access_role_arn, :volume_kms_key_id, :vpc_config) SENSITIVE = [] include Aws::Structure end |
#job_arn ⇒ String
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7780 class TopicsDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :number_of_topics, :data_access_role_arn, :volume_kms_key_id, :vpc_config) SENSITIVE = [] include Aws::Structure end |
#job_id ⇒ String
The identifier assigned to the topic detection job.
7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7780 class TopicsDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :number_of_topics, :data_access_role_arn, :volume_kms_key_id, :vpc_config) SENSITIVE = [] include Aws::Structure end |
#job_name ⇒ String
The name of the topic detection job.
7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7780 class TopicsDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :number_of_topics, :data_access_role_arn, :volume_kms_key_id, :vpc_config) SENSITIVE = [] include Aws::Structure end |
#job_status ⇒ String
The current status of the topic detection job. If the status is
Failed
, the reason for the failure is shown in the Message
field.
7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7780 class TopicsDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :number_of_topics, :data_access_role_arn, :volume_kms_key_id, :vpc_config) SENSITIVE = [] include Aws::Structure end |
#message ⇒ String
A description for the status of a job.
7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7780 class TopicsDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :number_of_topics, :data_access_role_arn, :volume_kms_key_id, :vpc_config) SENSITIVE = [] include Aws::Structure end |
#number_of_topics ⇒ Integer
The number of topics to detect supplied when you created the topic detection job. The default is 10.
7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7780 class TopicsDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :number_of_topics, :data_access_role_arn, :volume_kms_key_id, :vpc_config) SENSITIVE = [] include Aws::Structure end |
#output_data_config ⇒ Types::OutputDataConfig
The output data configuration supplied when you created the topic detection job.
7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7780 class TopicsDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :number_of_topics, :data_access_role_arn, :volume_kms_key_id, :vpc_config) SENSITIVE = [] include Aws::Structure end |
#submit_time ⇒ Time
The time that the topic detection job was submitted for processing.
7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7780 class TopicsDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :number_of_topics, :data_access_role_arn, :volume_kms_key_id, :vpc_config) SENSITIVE = [] include Aws::Structure end |
#volume_kms_key_id ⇒ String
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7780 class TopicsDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :number_of_topics, :data_access_role_arn, :volume_kms_key_id, :vpc_config) SENSITIVE = [] include Aws::Structure end |
#vpc_config ⇒ Types::VpcConfig
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7780 class TopicsDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :number_of_topics, :data_access_role_arn, :volume_kms_key_id, :vpc_config) SENSITIVE = [] include Aws::Structure end |