Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Comprehend.Types.EntityRecognizerProperties

Description

Synopsis

Documentation

data EntityRecognizerProperties Source #

Describes information about an entity recognizer.

See: newEntityRecognizerProperties smart constructor.

Constructors

EntityRecognizerProperties'

Fields

status :: Maybe ModelStatus
Provides the status of the entity recognizer.
languageCode :: Maybe LanguageCode
The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
trainingEndTime :: Maybe POSIX
The time that training of the entity recognizer was completed.
versionName :: Maybe Text
The version name you assigned to the entity recognizer.
entityRecognizerArn :: Maybe Text
The Amazon Resource Name (ARN) that identifies the entity recognizer.
modelKmsKeyId :: Maybe Text
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"
inputDataConfig :: Maybe EntityRecognizerInputDataConfig
The input data properties of an entity recognizer.
vpcConfig :: Maybe 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.
volumeKmsKeyId :: Maybe Text
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"
endTime :: Maybe POSIX
The time that the recognizer creation completed.
trainingStartTime :: Maybe POSIX
The time that training of the entity recognizer started.
dataAccessRoleArn :: Maybe Text
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
recognizerMetadata :: Maybe (Sensitive EntityRecognizerMetadata)
Provides information about an entity recognizer.
message :: Maybe Text
A description of the status of the recognizer.
submitTime :: Maybe POSIX
The time that the recognizer was submitted for processing.

Instances

Instances details

Eq EntityRecognizerProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.EntityRecognizerProperties Methods (==) :: EntityRecognizerProperties -> EntityRecognizerProperties -> Bool # (/=) :: EntityRecognizerProperties -> EntityRecognizerProperties -> Bool #
Show EntityRecognizerProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.EntityRecognizerProperties Methods showsPrec :: Int -> EntityRecognizerProperties -> ShowS # show :: EntityRecognizerProperties -> String # showList :: [EntityRecognizerProperties] -> ShowS #
Generic EntityRecognizerProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.EntityRecognizerProperties Associated Types type Rep EntityRecognizerProperties :: Type -> Type # Methods from :: EntityRecognizerProperties -> Rep EntityRecognizerProperties x # to :: Rep EntityRecognizerProperties x -> EntityRecognizerProperties #
NFData EntityRecognizerProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.EntityRecognizerProperties Methods rnf :: EntityRecognizerProperties -> () #
Hashable EntityRecognizerProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.EntityRecognizerProperties Methods hashWithSalt :: Int -> EntityRecognizerProperties -> Int # hash :: EntityRecognizerProperties -> Int #
FromJSON EntityRecognizerProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.EntityRecognizerProperties Methods parseJSON :: Value -> Parser EntityRecognizerProperties # parseJSONList :: Value -> Parser [EntityRecognizerProperties] #
type Rep EntityRecognizerProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.EntityRecognizerProperties type Rep EntityRecognizerProperties = D1 ('MetaData "EntityRecognizerProperties" "Amazonka.Comprehend.Types.EntityRecognizerProperties" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "EntityRecognizerProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelStatus)) :: (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :: S1 ('MetaSel ('Just "trainingEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "versionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "entityRecognizerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "modelKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityRecognizerInputDataConfig))))) :: (((S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig)) :: S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "trainingStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "recognizerMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive EntityRecognizerMetadata)))) :: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newEntityRecognizerProperties :: EntityRecognizerProperties Source #

Create a value of EntityRecognizerProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:EntityRecognizerProperties', entityRecognizerProperties_status - Provides the status of the entity recognizer.

$sel:languageCode:EntityRecognizerProperties', entityRecognizerProperties_languageCode - The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

$sel:trainingEndTime:EntityRecognizerProperties', entityRecognizerProperties_trainingEndTime - The time that training of the entity recognizer was completed.

$sel:versionName:EntityRecognizerProperties', entityRecognizerProperties_versionName - The version name you assigned to the entity recognizer.

$sel:entityRecognizerArn:EntityRecognizerProperties', entityRecognizerProperties_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.

$sel:modelKmsKeyId:EntityRecognizerProperties', entityRecognizerProperties_modelKmsKeyId - 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"

$sel:inputDataConfig:EntityRecognizerProperties', entityRecognizerProperties_inputDataConfig - The input data properties of an entity recognizer.

$sel:vpcConfig:EntityRecognizerProperties', entityRecognizerProperties_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.

$sel:volumeKmsKeyId:EntityRecognizerProperties', entityRecognizerProperties_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"

$sel:endTime:EntityRecognizerProperties', entityRecognizerProperties_endTime - The time that the recognizer creation completed.

$sel:trainingStartTime:EntityRecognizerProperties', entityRecognizerProperties_trainingStartTime - The time that training of the entity recognizer started.

$sel:dataAccessRoleArn:EntityRecognizerProperties', entityRecognizerProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

$sel:recognizerMetadata:EntityRecognizerProperties', entityRecognizerProperties_recognizerMetadata - Provides information about an entity recognizer.

$sel:message:EntityRecognizerProperties', entityRecognizerProperties_message - A description of the status of the recognizer.

$sel:submitTime:EntityRecognizerProperties', entityRecognizerProperties_submitTime - The time that the recognizer was submitted for processing.

entityRecognizerProperties_status :: Lens' EntityRecognizerProperties (Maybe ModelStatus) Source #

Provides the status of the entity recognizer.

entityRecognizerProperties_languageCode :: Lens' EntityRecognizerProperties (Maybe LanguageCode) Source #

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

entityRecognizerProperties_trainingEndTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) Source #

The time that training of the entity recognizer was completed.

entityRecognizerProperties_versionName :: Lens' EntityRecognizerProperties (Maybe Text) Source #

The version name you assigned to the entity recognizer.

entityRecognizerProperties_entityRecognizerArn :: Lens' EntityRecognizerProperties (Maybe Text) Source #

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

entityRecognizerProperties_modelKmsKeyId :: Lens' EntityRecognizerProperties (Maybe Text) Source #

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"

entityRecognizerProperties_inputDataConfig :: Lens' EntityRecognizerProperties (Maybe EntityRecognizerInputDataConfig) Source #

The input data properties of an entity recognizer.

entityRecognizerProperties_vpcConfig :: Lens' EntityRecognizerProperties (Maybe VpcConfig) Source #

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.

entityRecognizerProperties_volumeKmsKeyId :: Lens' EntityRecognizerProperties (Maybe Text) Source #

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"

entityRecognizerProperties_endTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) Source #

The time that the recognizer creation completed.

entityRecognizerProperties_trainingStartTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) Source #

The time that training of the entity recognizer started.

entityRecognizerProperties_dataAccessRoleArn :: Lens' EntityRecognizerProperties (Maybe Text) Source #

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

entityRecognizerProperties_recognizerMetadata :: Lens' EntityRecognizerProperties (Maybe EntityRecognizerMetadata) Source #

Provides information about an entity recognizer.

entityRecognizerProperties_message :: Lens' EntityRecognizerProperties (Maybe Text) Source #

A description of the status of the recognizer.

entityRecognizerProperties_submitTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) Source #

The time that the recognizer was submitted for processing.