AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes information about an entity recognizer.

Inheritance Hierarchy

System.Object
  Amazon.Comprehend.Model.EntityRecognizerProperties

Namespace: Amazon.Comprehend.Model
Assembly: AWSSDK.Comprehend.dll
Version: 3.x.y.z

Syntax

C#
public class EntityRecognizerProperties

The EntityRecognizerProperties type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property DataAccessRoleArn System.String

Gets and sets the property DataAccessRoleArn.

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

Public Property EndTime System.DateTime

Gets and sets the property EndTime.

The time that the recognizer creation completed.

Public Property EntityRecognizerArn System.String

Gets and sets the property EntityRecognizerArn.

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

Public Property FlywheelArn System.String

Gets and sets the property FlywheelArn.

The Amazon Resource Number (ARN) of the flywheel

Public Property InputDataConfig Amazon.Comprehend.Model.EntityRecognizerInputDataConfig

Gets and sets the property InputDataConfig.

The input data properties of an entity recognizer.

Public Property LanguageCode Amazon.Comprehend.LanguageCode

Gets and sets the property LanguageCode.

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

Public Property Message System.String

Gets and sets the property Message.

A description of the status of the recognizer.

Public Property ModelKmsKeyId System.String

Gets and sets the property ModelKmsKeyId.

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"

Public Property OutputDataConfig Amazon.Comprehend.Model.EntityRecognizerOutputDataConfig

Gets and sets the property OutputDataConfig.

Output data configuration.

Public Property RecognizerMetadata Amazon.Comprehend.Model.EntityRecognizerMetadata

Gets and sets the property RecognizerMetadata.

Provides information about an entity recognizer.

Public Property SourceModelArn System.String

Gets and sets the property SourceModelArn.

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.

Public Property Status Amazon.Comprehend.ModelStatus

Gets and sets the property Status.

Provides the status of the entity recognizer.

Public Property SubmitTime System.DateTime

Gets and sets the property SubmitTime.

The time that the recognizer was submitted for processing.

Public Property TrainingEndTime System.DateTime

Gets and sets the property TrainingEndTime.

The time that training of the entity recognizer was completed.

Public Property TrainingStartTime System.DateTime

Gets and sets the property TrainingStartTime.

The time that training of the entity recognizer started.

Public Property VersionName System.String

Gets and sets the property VersionName.

The version name you assigned to the entity recognizer.

Public Property VolumeKmsKeyId System.String

Gets and sets the property VolumeKmsKeyId.

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"

Public Property VpcConfig Amazon.Comprehend.Model.VpcConfig

Gets and sets the property 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5