Amazon Comprehend
Developer Guide

EntityRecognizerProperties

Describes information about an entity recognizer.

Contents

DataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

Required: No

EndTime

The time that the recognizer creation completed.

Type: Timestamp

Required: No

EntityRecognizerArn

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer/[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: No

InputDataConfig

The input data properties of an entity recognizer.

Type: EntityRecognizerInputDataConfig object

Required: No

LanguageCode

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

Type: String

Valid Values: en

Required: No

Message

A description of the status of the recognizer.

Type: String

Required: No

RecognizerMetadata

Provides information about an entity recognizer.

Type: EntityRecognizerMetadata object

Required: No

Status

Provides the status of the entity recognizer.

Type: String

Valid Values: SUBMITTED | TRAINING | DELETING | STOP_REQUESTED | STOPPED | IN_ERROR | TRAINED

Required: No

SubmitTime

The time that the recognizer was submitted for processing.

Type: Timestamp

Required: No

TrainingEndTime

The time that training of the entity recognizer was completed.

Type: Timestamp

Required: No

TrainingStartTime

The time that training of the entity recognizer started.

Type: Timestamp

Required: No

VolumeKmsKeyId

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"

Type: String

Length Constraints: Maximum length of 2048.

Required: No

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.

Type: VpcConfig object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: