Class: Aws::Comprehend::Types::EntityRecognizerProperties
- Inherits:
-
Struct
- Object
- Struct
- Aws::Comprehend::Types::EntityRecognizerProperties
- Defined in:
- gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb
Overview
Describes information about an entity recognizer.
Constant Summary collapse
- SENSITIVE =
[:recognizer_metadata]
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 input data.
-
#end_time ⇒ Time
The time that the recognizer creation completed.
-
#entity_recognizer_arn ⇒ String
The Amazon Resource Name (ARN) that identifies the entity recognizer.
-
#input_data_config ⇒ Types::EntityRecognizerInputDataConfig
The input data properties of an entity recognizer.
-
#language_code ⇒ String
The language of the input documents.
-
#message ⇒ String
A description of the status of the recognizer.
-
#model_kms_key_id ⇒ String
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models.
-
#recognizer_metadata ⇒ Types::EntityRecognizerMetadata
Provides information about an entity recognizer.
-
#source_model_arn ⇒ String
The Amazon Resource Name (ARN) of the source model.
-
#status ⇒ String
Provides the status of the entity recognizer.
-
#submit_time ⇒ Time
The time that the recognizer was submitted for processing.
-
#training_end_time ⇒ Time
The time that training of the entity recognizer was completed.
-
#training_start_time ⇒ Time
The time that training of the entity recognizer started.
-
#version_name ⇒ String
The version name you assigned to the entity recognizer.
-
#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 custom entity recognizer.
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 input data.
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3573 class EntityRecognizerProperties < Struct.new( :entity_recognizer_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :recognizer_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:recognizer_metadata] include Aws::Structure end |
#end_time ⇒ Time
The time that the recognizer creation completed.
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3573 class EntityRecognizerProperties < Struct.new( :entity_recognizer_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :recognizer_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:recognizer_metadata] include Aws::Structure end |
#entity_recognizer_arn ⇒ String
The Amazon Resource Name (ARN) that identifies the entity recognizer.
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3573 class EntityRecognizerProperties < Struct.new( :entity_recognizer_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :recognizer_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:recognizer_metadata] include Aws::Structure end |
#input_data_config ⇒ Types::EntityRecognizerInputDataConfig
The input data properties of an entity recognizer.
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3573 class EntityRecognizerProperties < Struct.new( :entity_recognizer_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :recognizer_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:recognizer_metadata] include Aws::Structure end |
#language_code ⇒ String
The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3573 class EntityRecognizerProperties < Struct.new( :entity_recognizer_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :recognizer_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:recognizer_metadata] include Aws::Structure end |
#message ⇒ String
A description of the status of the recognizer.
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3573 class EntityRecognizerProperties < Struct.new( :entity_recognizer_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :recognizer_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:recognizer_metadata] include Aws::Structure end |
#model_kms_key_id ⇒ String
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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"
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3573 class EntityRecognizerProperties < Struct.new( :entity_recognizer_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :recognizer_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:recognizer_metadata] include Aws::Structure end |
#recognizer_metadata ⇒ Types::EntityRecognizerMetadata
Provides information about an entity recognizer.
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3573 class EntityRecognizerProperties < Struct.new( :entity_recognizer_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :recognizer_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:recognizer_metadata] include Aws::Structure end |
#source_model_arn ⇒ String
The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the entity recognizer model in your AWS account.
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3573 class EntityRecognizerProperties < Struct.new( :entity_recognizer_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :recognizer_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:recognizer_metadata] include Aws::Structure end |
#status ⇒ String
Provides the status of the entity recognizer.
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3573 class EntityRecognizerProperties < Struct.new( :entity_recognizer_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :recognizer_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:recognizer_metadata] include Aws::Structure end |
#submit_time ⇒ Time
The time that the recognizer was submitted for processing.
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3573 class EntityRecognizerProperties < Struct.new( :entity_recognizer_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :recognizer_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:recognizer_metadata] include Aws::Structure end |
#training_end_time ⇒ Time
The time that training of the entity recognizer was completed.
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3573 class EntityRecognizerProperties < Struct.new( :entity_recognizer_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :recognizer_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:recognizer_metadata] include Aws::Structure end |
#training_start_time ⇒ Time
The time that training of the entity recognizer started.
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3573 class EntityRecognizerProperties < Struct.new( :entity_recognizer_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :recognizer_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:recognizer_metadata] include Aws::Structure end |
#version_name ⇒ String
The version name you assigned to the entity recognizer.
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3573 class EntityRecognizerProperties < Struct.new( :entity_recognizer_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :recognizer_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:recognizer_metadata] 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"
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3573 class EntityRecognizerProperties < Struct.new( :entity_recognizer_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :recognizer_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:recognizer_metadata] 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 custom entity recognizer. For more information, see Amazon VPC.
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3573 class EntityRecognizerProperties < Struct.new( :entity_recognizer_arn, :language_code, :status, :message, :submit_time, :end_time, :training_start_time, :training_end_time, :input_data_config, :recognizer_metadata, :data_access_role_arn, :volume_kms_key_id, :vpc_config, :model_kms_key_id, :version_name, :source_model_arn) SENSITIVE = [:recognizer_metadata] include Aws::Structure end |