Interface EntityRecognizerProperties

Describes information about an entity recognizer.

interface EntityRecognizerProperties {
    DataAccessRoleArn?: string;
    EndTime?: Date;
    EntityRecognizerArn?: string;
    FlywheelArn?: string;
    InputDataConfig?: EntityRecognizerInputDataConfig;
    LanguageCode?: LanguageCode;
    Message?: string;
    ModelKmsKeyId?: string;
    OutputDataConfig?: EntityRecognizerOutputDataConfig;
    RecognizerMetadata?: EntityRecognizerMetadata;
    SourceModelArn?: string;
    Status?: ModelStatus;
    SubmitTime?: Date;
    TrainingEndTime?: Date;
    TrainingStartTime?: Date;
    VersionName?: string;
    VolumeKmsKeyId?: string;
    VpcConfig?: VpcConfig;
}

Properties

DataAccessRoleArn? EndTime? EntityRecognizerArn? FlywheelArn? InputDataConfig? LanguageCode? Message? ModelKmsKeyId? OutputDataConfig? RecognizerMetadata? SourceModelArn? Status? SubmitTime? TrainingEndTime? TrainingStartTime? VersionName? VolumeKmsKeyId? VpcConfig?

Properties

Optional DataAccessRoleArn

DataAccessRoleArn?: string

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

Optional EndTime

EndTime?: Date

The time that the recognizer creation completed.

Optional EntityRecognizerArn

EntityRecognizerArn?: string

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

Optional FlywheelArn

FlywheelArn?: string

The Amazon Resource Number (ARN) of the flywheel

Optional InputDataConfig

InputDataConfig?: EntityRecognizerInputDataConfig

The input data properties of an entity recognizer.

Optional LanguageCode

LanguageCode?: LanguageCode

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

Optional Message

Message?: string

A description of the status of the recognizer.

Optional ModelKmsKeyId

ModelKmsKeyId?: string

ID for the 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"

Optional OutputDataConfig

OutputDataConfig?: EntityRecognizerOutputDataConfig

Output data configuration.

Optional RecognizerMetadata

RecognizerMetadata?: EntityRecognizerMetadata

Provides information about an entity recognizer.

Optional SourceModelArn

SourceModelArn?: string

The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account.

Optional Status

Status?: ModelStatus

Provides the status of the entity recognizer.

Optional SubmitTime

SubmitTime?: Date

The time that the recognizer was submitted for processing.

Optional TrainingEndTime

TrainingEndTime?: Date

The time that training of the entity recognizer was completed.

Optional TrainingStartTime

TrainingStartTime?: Date

The time that training of the entity recognizer started.

Optional VersionName

VersionName?: string

The version name you assigned to the entity recognizer.

Optional VolumeKmsKeyId

VolumeKmsKeyId?: 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"

Optional VpcConfig

VpcConfig?: 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.

Settings

Member Visibility

Theme

On This Page