You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Comprehend::Types::EntityRecognizerProperties

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes information about an entity recognizer.

Returned by:

See Also:

Instance Attribute Summary collapse

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.

Returns:

  • (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.

Returns:

  • (Time) —

    The time that the recognizer creation completed.

#entity_recognizer_arn ⇒ String

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) that identifies the entity recognizer.

#input_data_config ⇒ Types::EntityRecognizerInputDataConfig

The input data properties of an entity recognizer.

Returns:

#language_code ⇒ String

The language of the input documents. All documents must be in the same language. Only English (\"en\") is currently supported.

Possible values:

  • en
  • es
  • fr
  • de
  • it
  • pt
  • ar
  • hi
  • ja
  • ko
  • zh
  • zh-TW

Returns:

  • (String) —

    The language of the input documents.

#message ⇒ String

A description of the status of the recognizer.

Returns:

  • (String) —

    A description of the status of the recognizer.

#recognizer_metadata ⇒ Types::EntityRecognizerMetadata

Provides information about an entity recognizer.

Returns:

#status ⇒ String

Provides the status of the entity recognizer.

Possible values:

  • SUBMITTED
  • TRAINING
  • DELETING
  • STOP_REQUESTED
  • STOPPED
  • IN_ERROR
  • TRAINED

Returns:

  • (String) —

    Provides the status of the entity recognizer.

#submit_time ⇒ Time

The time that the recognizer was submitted for processing.

Returns:

  • (Time) —

    The time that the recognizer was submitted for processing.

#training_end_time ⇒ Time

The time that training of the entity recognizer was completed.

Returns:

  • (Time) —

    The time that training of the entity recognizer was completed.

#training_start_time ⇒ Time

The time that training of the entity recognizer started.

Returns:

  • (Time) —

    The time that training of the entity recognizer started.

#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"

Returns:

  • (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. For more information, see Amazon VPC.

Returns:

  • (Types::VpcConfig) —

    Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer.