Amazonka.Comprehend.Types.DocumentClassifierProperties

Documentation

data DocumentClassifierProperties

Provides information about a document classifier.

See: newDocumentClassifierProperties smart constructor.

Constructors

DocumentClassifierProperties'

Fields

• classifierMetadata :: Maybe (Sensitive ClassifierMetadata)

  Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

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

• documentClassifierArn :: Maybe Text

  The Amazon Resource Name (ARN) that identifies the document classifier.

• endTime :: Maybe POSIX

  The time that training the document classifier completed.

• inputDataConfig :: Maybe DocumentClassifierInputDataConfig

  The input data configuration that you supplied when you created the document classifier for training.

• languageCode :: Maybe LanguageCode

  The language code for the language of the documents that the classifier was trained on.

• message :: Maybe Text

  Additional information about the status of the classifier.

• mode :: Maybe DocumentClassifierMode

  Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

• 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"
• outputDataConfig :: Maybe DocumentClassifierOutputDataConfig

  Provides output results configuration parameters for custom classifier jobs.

• sourceModelArn :: Maybe Text

  The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the document classifier model in your AWS account.

• status :: Maybe ModelStatus

  The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

• submitTime :: Maybe POSIX

  The time that the document classifier was submitted for training.

• trainingEndTime :: Maybe POSIX

  The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

• trainingStartTime :: Maybe POSIX

  Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

• versionName :: Maybe Text

  The version name that you assigned to the document classifier.

• 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"
• vpcConfig :: Maybe VpcConfig

  Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.

Instances

FromJSON DocumentClassifierProperties

Defined in Amazonka.Comprehend.Types.DocumentClassifierProperties

Methods

parseJSON :: Value -> Parser DocumentClassifierProperties

parseJSONList :: Value -> Parser [DocumentClassifierProperties]

Generic DocumentClassifierProperties

Defined in Amazonka.Comprehend.Types.DocumentClassifierProperties

Associated Types

type Rep DocumentClassifierProperties :: Type -> Type

Methods

from :: DocumentClassifierProperties -> Rep DocumentClassifierProperties x

to :: Rep DocumentClassifierProperties x -> DocumentClassifierProperties

Show DocumentClassifierProperties

Defined in Amazonka.Comprehend.Types.DocumentClassifierProperties

Methods

showsPrec :: Int -> DocumentClassifierProperties -> ShowS

show :: DocumentClassifierProperties -> String

showList :: [DocumentClassifierProperties] -> ShowS

NFData DocumentClassifierProperties

Defined in Amazonka.Comprehend.Types.DocumentClassifierProperties

Methods

rnf :: DocumentClassifierProperties -> ()

Eq DocumentClassifierProperties

Defined in Amazonka.Comprehend.Types.DocumentClassifierProperties

Methods

(==) :: DocumentClassifierProperties -> DocumentClassifierProperties -> Bool

(/=) :: DocumentClassifierProperties -> DocumentClassifierProperties -> Bool

Hashable DocumentClassifierProperties

Defined in Amazonka.Comprehend.Types.DocumentClassifierProperties

Methods

hashWithSalt :: Int -> DocumentClassifierProperties -> Int

hash :: DocumentClassifierProperties -> Int

type Rep DocumentClassifierProperties

Defined in Amazonka.Comprehend.Types.DocumentClassifierProperties

type Rep DocumentClassifierProperties = D1 ('MetaData "DocumentClassifierProperties" "Amazonka.Comprehend.Types.DocumentClassifierProperties" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "DocumentClassifierProperties'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "classifierMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive ClassifierMetadata))) :*: S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "documentClassifierArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentClassifierInputDataConfig)) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode))) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentClassifierMode)) :*: S1 ('MetaSel ('Just "modelKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentClassifierOutputDataConfig)) :*: S1 ('MetaSel ('Just "sourceModelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelStatus)) :*: S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "trainingEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "trainingStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "versionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig))))))))

newDocumentClassifierProperties :: DocumentClassifierProperties

Create a value of DocumentClassifierProperties 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:classifierMetadata:DocumentClassifierProperties', documentClassifierProperties_classifierMetadata - Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

$sel:dataAccessRoleArn:DocumentClassifierProperties', documentClassifierProperties_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:documentClassifierArn:DocumentClassifierProperties', documentClassifierProperties_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.

$sel:endTime:DocumentClassifierProperties', documentClassifierProperties_endTime - The time that training the document classifier completed.

$sel:inputDataConfig:DocumentClassifierProperties', documentClassifierProperties_inputDataConfig - The input data configuration that you supplied when you created the document classifier for training.

$sel:languageCode:DocumentClassifierProperties', documentClassifierProperties_languageCode - The language code for the language of the documents that the classifier was trained on.

$sel:message:DocumentClassifierProperties', documentClassifierProperties_message - Additional information about the status of the classifier.

$sel:mode:DocumentClassifierProperties', documentClassifierProperties_mode - Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

$sel:modelKmsKeyId:DocumentClassifierProperties', documentClassifierProperties_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:outputDataConfig:DocumentClassifierProperties', documentClassifierProperties_outputDataConfig - Provides output results configuration parameters for custom classifier jobs.

$sel:sourceModelArn:DocumentClassifierProperties', documentClassifierProperties_sourceModelArn - The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the document classifier model in your AWS account.

$sel:status:DocumentClassifierProperties', documentClassifierProperties_status - The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

$sel:submitTime:DocumentClassifierProperties', documentClassifierProperties_submitTime - The time that the document classifier was submitted for training.

$sel:trainingEndTime:DocumentClassifierProperties', documentClassifierProperties_trainingEndTime - The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

$sel:trainingStartTime:DocumentClassifierProperties', documentClassifierProperties_trainingStartTime - Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

$sel:versionName:DocumentClassifierProperties', documentClassifierProperties_versionName - The version name that you assigned to the document classifier.

$sel:volumeKmsKeyId:DocumentClassifierProperties', documentClassifierProperties_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:vpcConfig:DocumentClassifierProperties', documentClassifierProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.

documentClassifierProperties_classifierMetadata :: Lens' DocumentClassifierProperties (Maybe ClassifierMetadata)

Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

documentClassifierProperties_dataAccessRoleArn :: Lens' DocumentClassifierProperties (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.

documentClassifierProperties_documentClassifierArn :: Lens' DocumentClassifierProperties (Maybe Text)

The Amazon Resource Name (ARN) that identifies the document classifier.

documentClassifierProperties_endTime :: Lens' DocumentClassifierProperties (Maybe UTCTime)

The time that training the document classifier completed.

documentClassifierProperties_inputDataConfig :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierInputDataConfig)

The input data configuration that you supplied when you created the document classifier for training.

documentClassifierProperties_languageCode :: Lens' DocumentClassifierProperties (Maybe LanguageCode)

The language code for the language of the documents that the classifier was trained on.

documentClassifierProperties_message :: Lens' DocumentClassifierProperties (Maybe Text)

Additional information about the status of the classifier.

documentClassifierProperties_mode :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierMode)

Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

documentClassifierProperties_modelKmsKeyId :: Lens' DocumentClassifierProperties (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"

documentClassifierProperties_outputDataConfig :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierOutputDataConfig)

Provides output results configuration parameters for custom classifier jobs.

documentClassifierProperties_sourceModelArn :: Lens' DocumentClassifierProperties (Maybe Text)

The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the document classifier model in your AWS account.

documentClassifierProperties_status :: Lens' DocumentClassifierProperties (Maybe ModelStatus)

The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

documentClassifierProperties_submitTime :: Lens' DocumentClassifierProperties (Maybe UTCTime)

The time that the document classifier was submitted for training.

documentClassifierProperties_trainingEndTime :: Lens' DocumentClassifierProperties (Maybe UTCTime)

The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

documentClassifierProperties_trainingStartTime :: Lens' DocumentClassifierProperties (Maybe UTCTime)

Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

documentClassifierProperties_versionName :: Lens' DocumentClassifierProperties (Maybe Text)

The version name that you assigned to the document classifier.

documentClassifierProperties_volumeKmsKeyId :: Lens' DocumentClassifierProperties (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"

documentClassifierProperties_vpcConfig :: Lens' DocumentClassifierProperties (Maybe VpcConfig)

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.