Class: Aws::Comprehend::Types::EntitiesDetectionJobProperties
- Inherits:
-
Struct
- Object
- Struct
- Aws::Comprehend::Types::EntitiesDetectionJobProperties
- Defined in:
- gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb
Overview
Provides information about an entities detection job.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#data_access_role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
-
#end_time ⇒ Time
The time that the entities detection job completed.
-
#entity_recognizer_arn ⇒ String
The Amazon Resource Name (ARN) that identifies the entity recognizer.
-
#flywheel_arn ⇒ String
The Amazon Resource Name (ARN) of the flywheel associated with this job.
-
#input_data_config ⇒ Types::InputDataConfig
The input data configuration that you supplied when you created the entities detection job.
-
#job_arn ⇒ String
The Amazon Resource Name (ARN) of the entities detection job.
-
#job_id ⇒ String
The identifier assigned to the entities detection job.
-
#job_name ⇒ String
The name that you assigned the entities detection job.
-
#job_status ⇒ String
The current status of the entities detection job.
-
#language_code ⇒ String
The language code of the input documents.
-
#message ⇒ String
A description of the status of a job.
-
#output_data_config ⇒ Types::OutputDataConfig
The output data configuration that you supplied when you created the entities detection job.
-
#submit_time ⇒ Time
The time that the entities detection job was submitted for processing.
-
#volume_kms_key_id ⇒ String
ID for the Amazon Web Services 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 entity detection job.
Instance Attribute Details
#data_access_role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3867 class EntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :entity_recognizer_arn, :input_data_config, :output_data_config, :language_code, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :flywheel_arn) SENSITIVE = [] include Aws::Structure end |
#end_time ⇒ Time
The time that the entities detection job completed
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3867 class EntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :entity_recognizer_arn, :input_data_config, :output_data_config, :language_code, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :flywheel_arn) SENSITIVE = [] include Aws::Structure end |
#entity_recognizer_arn ⇒ String
The Amazon Resource Name (ARN) that identifies the entity recognizer.
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3867 class EntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :entity_recognizer_arn, :input_data_config, :output_data_config, :language_code, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :flywheel_arn) SENSITIVE = [] include Aws::Structure end |
#flywheel_arn ⇒ String
The Amazon Resource Name (ARN) of the flywheel associated with this job.
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3867 class EntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :entity_recognizer_arn, :input_data_config, :output_data_config, :language_code, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :flywheel_arn) SENSITIVE = [] include Aws::Structure end |
#input_data_config ⇒ Types::InputDataConfig
The input data configuration that you supplied when you created the entities detection job.
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3867 class EntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :entity_recognizer_arn, :input_data_config, :output_data_config, :language_code, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :flywheel_arn) SENSITIVE = [] include Aws::Structure end |
#job_arn ⇒ String
The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3867 class EntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :entity_recognizer_arn, :input_data_config, :output_data_config, :language_code, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :flywheel_arn) SENSITIVE = [] include Aws::Structure end |
#job_id ⇒ String
The identifier assigned to the entities detection job.
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3867 class EntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :entity_recognizer_arn, :input_data_config, :output_data_config, :language_code, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :flywheel_arn) SENSITIVE = [] include Aws::Structure end |
#job_name ⇒ String
The name that you assigned the entities detection job.
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3867 class EntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :entity_recognizer_arn, :input_data_config, :output_data_config, :language_code, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :flywheel_arn) SENSITIVE = [] include Aws::Structure end |
#job_status ⇒ String
The current status of the entities detection job. If the status is
FAILED
, the Message
field shows the reason for the failure.
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3867 class EntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :entity_recognizer_arn, :input_data_config, :output_data_config, :language_code, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :flywheel_arn) SENSITIVE = [] include Aws::Structure end |
#language_code ⇒ String
The language code of the input documents.
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3867 class EntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :entity_recognizer_arn, :input_data_config, :output_data_config, :language_code, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :flywheel_arn) SENSITIVE = [] include Aws::Structure end |
#message ⇒ String
A description of the status of a job.
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3867 class EntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :entity_recognizer_arn, :input_data_config, :output_data_config, :language_code, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :flywheel_arn) SENSITIVE = [] include Aws::Structure end |
#output_data_config ⇒ Types::OutputDataConfig
The output data configuration that you supplied when you created the entities detection job.
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3867 class EntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :entity_recognizer_arn, :input_data_config, :output_data_config, :language_code, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :flywheel_arn) SENSITIVE = [] include Aws::Structure end |
#submit_time ⇒ Time
The time that the entities detection job was submitted for processing.
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3867 class EntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :entity_recognizer_arn, :input_data_config, :output_data_config, :language_code, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :flywheel_arn) SENSITIVE = [] include Aws::Structure end |
#volume_kms_key_id ⇒ String
ID for the Amazon Web Services 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"
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3867 class EntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :entity_recognizer_arn, :input_data_config, :output_data_config, :language_code, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :flywheel_arn) 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 entity detection job. For more information, see Amazon VPC.
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3867 class EntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :entity_recognizer_arn, :input_data_config, :output_data_config, :language_code, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :flywheel_arn) SENSITIVE = [] include Aws::Structure end |