AWSComprehendEntityRecognizerProperties

Objective-C

@interface AWSComprehendEntityRecognizerProperties

Swift

class AWSComprehendEntityRecognizerProperties

Describes information about an entity recognizer.

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable dataAccessRoleArn;

    Swift

    var dataAccessRoleArn: String? { get set }

  • The time that the recognizer creation completed.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable endTime;

    Swift

    var endTime: Date? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable entityRecognizerArn;

    Swift

    var entityRecognizerArn: String? { get set }

  • The input data properties of an entity recognizer.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSComprehendEntityRecognizerInputDataConfig *_Nullable inputDataConfig;

    Swift

    var inputDataConfig: AWSComprehendEntityRecognizerInputDataConfig? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSComprehendLanguageCode languageCode;

    Swift

    var languageCode: AWSComprehendLanguageCode { get set }

  • A description of the status of the recognizer.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable message;

    Swift

    var message: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable modelKmsKeyId;

    Swift

    var modelKmsKeyId: String? { get set }

  • Provides information about an entity recognizer.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSComprehendEntityRecognizerMetadata *_Nullable recognizerMetadata;

    Swift

    var recognizerMetadata: AWSComprehendEntityRecognizerMetadata? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable sourceModelArn;

    Swift

    var sourceModelArn: String? { get set }

  • Provides the status of the entity recognizer.

    Declaration

    Objective-C

    @property (nonatomic) AWSComprehendModelStatus status;

    Swift

    var status: AWSComprehendModelStatus { get set }

  • The time that the recognizer was submitted for processing.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable submitTime;

    Swift

    var submitTime: Date? { get set }

  • The time that training of the entity recognizer was completed.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable trainingEndTime;

    Swift

    var trainingEndTime: Date? { get set }

  • The time that training of the entity recognizer started.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable trainingStartTime;

    Swift

    var trainingStartTime: Date? { get set }

  • The version name you assigned to the entity recognizer.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable versionName;

    Swift

    var versionName: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable volumeKmsKeyId;

    Swift

    var volumeKmsKeyId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSComprehendVpcConfig *_Nullable vpcConfig;

    Swift

    var vpcConfig: AWSComprehendVpcConfig? { get set }