| 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
Contents
- Service Configuration
- Errors
- AugmentedManifestsDocumentTypeFormat
- DocumentClassifierDataFormat
- DocumentClassifierMode
- DocumentReadAction
- DocumentReadFeatureTypes
- DocumentReadMode
- EndpointStatus
- EntityRecognizerDataFormat
- EntityType
- InputFormat
- JobStatus
- LanguageCode
- ModelStatus
- PartOfSpeechTagType
- PiiEntitiesDetectionMaskMode
- PiiEntitiesDetectionMode
- PiiEntityType
- SentimentType
- Split
- SyntaxLanguageCode
- AugmentedManifestsListItem
- BatchDetectDominantLanguageItemResult
- BatchDetectEntitiesItemResult
- BatchDetectKeyPhrasesItemResult
- BatchDetectSentimentItemResult
- BatchDetectSyntaxItemResult
- BatchItemError
- ClassifierEvaluationMetrics
- ClassifierMetadata
- DocumentClass
- DocumentClassificationJobFilter
- DocumentClassificationJobProperties
- DocumentClassifierFilter
- DocumentClassifierInputDataConfig
- DocumentClassifierOutputDataConfig
- DocumentClassifierProperties
- DocumentClassifierSummary
- DocumentLabel
- DocumentReaderConfig
- DominantLanguage
- DominantLanguageDetectionJobFilter
- DominantLanguageDetectionJobProperties
- EndpointFilter
- EndpointProperties
- EntitiesDetectionJobFilter
- EntitiesDetectionJobProperties
- Entity
- EntityLabel
- EntityRecognizerAnnotations
- EntityRecognizerDocuments
- EntityRecognizerEntityList
- EntityRecognizerEvaluationMetrics
- EntityRecognizerFilter
- EntityRecognizerInputDataConfig
- EntityRecognizerMetadata
- EntityRecognizerMetadataEntityTypesListItem
- EntityRecognizerProperties
- EntityRecognizerSummary
- EntityTypesEvaluationMetrics
- EntityTypesListItem
- EventsDetectionJobFilter
- EventsDetectionJobProperties
- InputDataConfig
- KeyPhrase
- KeyPhrasesDetectionJobFilter
- KeyPhrasesDetectionJobProperties
- OutputDataConfig
- PartOfSpeechTag
- PiiEntitiesDetectionJobFilter
- PiiEntitiesDetectionJobProperties
- PiiEntity
- PiiOutputDataConfig
- RedactionConfig
- SentimentDetectionJobFilter
- SentimentDetectionJobProperties
- SentimentScore
- SyntaxToken
- Tag
- TopicsDetectionJobFilter
- TopicsDetectionJobProperties
- VpcConfig
Description
Synopsis
- defaultService :: Service
- _ResourceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _BatchSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedLanguageException :: AsError a => Getting (First ServiceError) a ServiceError
- _JobNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTagKeysException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidFilterException :: AsError a => Getting (First ServiceError) a ServiceError
- _KmsKeyValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TextSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype AugmentedManifestsDocumentTypeFormat where
- newtype DocumentClassifierDataFormat where
- newtype DocumentClassifierMode where
- newtype DocumentReadAction where
- newtype DocumentReadFeatureTypes where
- newtype DocumentReadMode where
- newtype EndpointStatus where
- EndpointStatus' { }
- pattern EndpointStatus_CREATING :: EndpointStatus
- pattern EndpointStatus_DELETING :: EndpointStatus
- pattern EndpointStatus_FAILED :: EndpointStatus
- pattern EndpointStatus_IN_SERVICE :: EndpointStatus
- pattern EndpointStatus_UPDATING :: EndpointStatus
- newtype EntityRecognizerDataFormat where
- newtype EntityType where
- EntityType' { }
- pattern EntityType_COMMERCIAL_ITEM :: EntityType
- pattern EntityType_DATE :: EntityType
- pattern EntityType_EVENT :: EntityType
- pattern EntityType_LOCATION :: EntityType
- pattern EntityType_ORGANIZATION :: EntityType
- pattern EntityType_OTHER :: EntityType
- pattern EntityType_PERSON :: EntityType
- pattern EntityType_QUANTITY :: EntityType
- pattern EntityType_TITLE :: EntityType
- newtype InputFormat where
- InputFormat' { }
- pattern InputFormat_ONE_DOC_PER_FILE :: InputFormat
- pattern InputFormat_ONE_DOC_PER_LINE :: InputFormat
- newtype JobStatus where
- JobStatus' { }
- pattern JobStatus_COMPLETED :: JobStatus
- pattern JobStatus_FAILED :: JobStatus
- pattern JobStatus_IN_PROGRESS :: JobStatus
- pattern JobStatus_STOPPED :: JobStatus
- pattern JobStatus_STOP_REQUESTED :: JobStatus
- pattern JobStatus_SUBMITTED :: JobStatus
- newtype LanguageCode where
- LanguageCode' { }
- pattern LanguageCode_Ar :: LanguageCode
- pattern LanguageCode_De :: LanguageCode
- pattern LanguageCode_En :: LanguageCode
- pattern LanguageCode_Es :: LanguageCode
- pattern LanguageCode_Fr :: LanguageCode
- pattern LanguageCode_Hi :: LanguageCode
- pattern LanguageCode_It :: LanguageCode
- pattern LanguageCode_Ja :: LanguageCode
- pattern LanguageCode_Ko :: LanguageCode
- pattern LanguageCode_Pt :: LanguageCode
- pattern LanguageCode_Zh :: LanguageCode
- pattern LanguageCode_Zh_TW :: LanguageCode
- newtype ModelStatus where
- ModelStatus' { }
- pattern ModelStatus_DELETING :: ModelStatus
- pattern ModelStatus_IN_ERROR :: ModelStatus
- pattern ModelStatus_STOPPED :: ModelStatus
- pattern ModelStatus_STOP_REQUESTED :: ModelStatus
- pattern ModelStatus_SUBMITTED :: ModelStatus
- pattern ModelStatus_TRAINED :: ModelStatus
- pattern ModelStatus_TRAINING :: ModelStatus
- newtype PartOfSpeechTagType where
- PartOfSpeechTagType' { }
- pattern PartOfSpeechTagType_ADJ :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_ADP :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_ADV :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_AUX :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_CCONJ :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_CONJ :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_DET :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_INTJ :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_NOUN :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_NUM :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_O :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_PART :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_PRON :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_PROPN :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_PUNCT :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_SCONJ :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_SYM :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_VERB :: PartOfSpeechTagType
- newtype PiiEntitiesDetectionMaskMode where
- newtype PiiEntitiesDetectionMode where
- newtype PiiEntityType where
- PiiEntityType' { }
- pattern PiiEntityType_ADDRESS :: PiiEntityType
- pattern PiiEntityType_AGE :: PiiEntityType
- pattern PiiEntityType_ALL :: PiiEntityType
- pattern PiiEntityType_AWS_ACCESS_KEY :: PiiEntityType
- pattern PiiEntityType_AWS_SECRET_KEY :: PiiEntityType
- pattern PiiEntityType_BANK_ACCOUNT_NUMBER :: PiiEntityType
- pattern PiiEntityType_BANK_ROUTING :: PiiEntityType
- pattern PiiEntityType_CREDIT_DEBIT_CVV :: PiiEntityType
- pattern PiiEntityType_CREDIT_DEBIT_EXPIRY :: PiiEntityType
- pattern PiiEntityType_CREDIT_DEBIT_NUMBER :: PiiEntityType
- pattern PiiEntityType_DATE_TIME :: PiiEntityType
- pattern PiiEntityType_DRIVER_ID :: PiiEntityType
- pattern PiiEntityType_EMAIL :: PiiEntityType
- pattern PiiEntityType_IP_ADDRESS :: PiiEntityType
- pattern PiiEntityType_MAC_ADDRESS :: PiiEntityType
- pattern PiiEntityType_NAME :: PiiEntityType
- pattern PiiEntityType_PASSPORT_NUMBER :: PiiEntityType
- pattern PiiEntityType_PASSWORD :: PiiEntityType
- pattern PiiEntityType_PHONE :: PiiEntityType
- pattern PiiEntityType_PIN :: PiiEntityType
- pattern PiiEntityType_SSN :: PiiEntityType
- pattern PiiEntityType_URL :: PiiEntityType
- pattern PiiEntityType_USERNAME :: PiiEntityType
- newtype SentimentType where
- SentimentType' { }
- pattern SentimentType_MIXED :: SentimentType
- pattern SentimentType_NEGATIVE :: SentimentType
- pattern SentimentType_NEUTRAL :: SentimentType
- pattern SentimentType_POSITIVE :: SentimentType
- newtype Split where
- Split' { }
- pattern Split_TEST :: Split
- pattern Split_TRAIN :: Split
- newtype SyntaxLanguageCode where
- SyntaxLanguageCode' { }
- pattern SyntaxLanguageCode_De :: SyntaxLanguageCode
- pattern SyntaxLanguageCode_En :: SyntaxLanguageCode
- pattern SyntaxLanguageCode_Es :: SyntaxLanguageCode
- pattern SyntaxLanguageCode_Fr :: SyntaxLanguageCode
- pattern SyntaxLanguageCode_It :: SyntaxLanguageCode
- pattern SyntaxLanguageCode_Pt :: SyntaxLanguageCode
- data AugmentedManifestsListItem = AugmentedManifestsListItem' {}
- newAugmentedManifestsListItem :: Text -> AugmentedManifestsListItem
- augmentedManifestsListItem_sourceDocumentsS3Uri :: Lens' AugmentedManifestsListItem (Maybe Text)
- augmentedManifestsListItem_documentType :: Lens' AugmentedManifestsListItem (Maybe AugmentedManifestsDocumentTypeFormat)
- augmentedManifestsListItem_split :: Lens' AugmentedManifestsListItem (Maybe Split)
- augmentedManifestsListItem_annotationDataS3Uri :: Lens' AugmentedManifestsListItem (Maybe Text)
- augmentedManifestsListItem_s3Uri :: Lens' AugmentedManifestsListItem Text
- augmentedManifestsListItem_attributeNames :: Lens' AugmentedManifestsListItem [Text]
- data BatchDetectDominantLanguageItemResult = BatchDetectDominantLanguageItemResult' {}
- newBatchDetectDominantLanguageItemResult :: BatchDetectDominantLanguageItemResult
- batchDetectDominantLanguageItemResult_languages :: Lens' BatchDetectDominantLanguageItemResult (Maybe [DominantLanguage])
- batchDetectDominantLanguageItemResult_index :: Lens' BatchDetectDominantLanguageItemResult (Maybe Int)
- data BatchDetectEntitiesItemResult = BatchDetectEntitiesItemResult' {}
- newBatchDetectEntitiesItemResult :: BatchDetectEntitiesItemResult
- batchDetectEntitiesItemResult_entities :: Lens' BatchDetectEntitiesItemResult (Maybe [Entity])
- batchDetectEntitiesItemResult_index :: Lens' BatchDetectEntitiesItemResult (Maybe Int)
- data BatchDetectKeyPhrasesItemResult = BatchDetectKeyPhrasesItemResult' {}
- newBatchDetectKeyPhrasesItemResult :: BatchDetectKeyPhrasesItemResult
- batchDetectKeyPhrasesItemResult_index :: Lens' BatchDetectKeyPhrasesItemResult (Maybe Int)
- batchDetectKeyPhrasesItemResult_keyPhrases :: Lens' BatchDetectKeyPhrasesItemResult (Maybe [KeyPhrase])
- data BatchDetectSentimentItemResult = BatchDetectSentimentItemResult' {}
- newBatchDetectSentimentItemResult :: BatchDetectSentimentItemResult
- batchDetectSentimentItemResult_sentiment :: Lens' BatchDetectSentimentItemResult (Maybe SentimentType)
- batchDetectSentimentItemResult_sentimentScore :: Lens' BatchDetectSentimentItemResult (Maybe SentimentScore)
- batchDetectSentimentItemResult_index :: Lens' BatchDetectSentimentItemResult (Maybe Int)
- data BatchDetectSyntaxItemResult = BatchDetectSyntaxItemResult' {
- index :: Maybe Int
- syntaxTokens :: Maybe [SyntaxToken]
- newBatchDetectSyntaxItemResult :: BatchDetectSyntaxItemResult
- batchDetectSyntaxItemResult_index :: Lens' BatchDetectSyntaxItemResult (Maybe Int)
- batchDetectSyntaxItemResult_syntaxTokens :: Lens' BatchDetectSyntaxItemResult (Maybe [SyntaxToken])
- data BatchItemError = BatchItemError' {}
- newBatchItemError :: BatchItemError
- batchItemError_errorCode :: Lens' BatchItemError (Maybe Text)
- batchItemError_errorMessage :: Lens' BatchItemError (Maybe Text)
- batchItemError_index :: Lens' BatchItemError (Maybe Int)
- data ClassifierEvaluationMetrics = ClassifierEvaluationMetrics' {}
- newClassifierEvaluationMetrics :: ClassifierEvaluationMetrics
- classifierEvaluationMetrics_microPrecision :: Lens' ClassifierEvaluationMetrics (Maybe Double)
- classifierEvaluationMetrics_microF1Score :: Lens' ClassifierEvaluationMetrics (Maybe Double)
- classifierEvaluationMetrics_recall :: Lens' ClassifierEvaluationMetrics (Maybe Double)
- classifierEvaluationMetrics_precision :: Lens' ClassifierEvaluationMetrics (Maybe Double)
- classifierEvaluationMetrics_microRecall :: Lens' ClassifierEvaluationMetrics (Maybe Double)
- classifierEvaluationMetrics_f1Score :: Lens' ClassifierEvaluationMetrics (Maybe Double)
- classifierEvaluationMetrics_hammingLoss :: Lens' ClassifierEvaluationMetrics (Maybe Double)
- classifierEvaluationMetrics_accuracy :: Lens' ClassifierEvaluationMetrics (Maybe Double)
- data ClassifierMetadata = ClassifierMetadata' {}
- newClassifierMetadata :: ClassifierMetadata
- classifierMetadata_numberOfLabels :: Lens' ClassifierMetadata (Maybe Int)
- classifierMetadata_evaluationMetrics :: Lens' ClassifierMetadata (Maybe ClassifierEvaluationMetrics)
- classifierMetadata_numberOfTrainedDocuments :: Lens' ClassifierMetadata (Maybe Int)
- classifierMetadata_numberOfTestDocuments :: Lens' ClassifierMetadata (Maybe Int)
- data DocumentClass = DocumentClass' {}
- newDocumentClass :: DocumentClass
- documentClass_score :: Lens' DocumentClass (Maybe Double)
- documentClass_name :: Lens' DocumentClass (Maybe Text)
- data DocumentClassificationJobFilter = DocumentClassificationJobFilter' {}
- newDocumentClassificationJobFilter :: DocumentClassificationJobFilter
- documentClassificationJobFilter_submitTimeAfter :: Lens' DocumentClassificationJobFilter (Maybe UTCTime)
- documentClassificationJobFilter_submitTimeBefore :: Lens' DocumentClassificationJobFilter (Maybe UTCTime)
- documentClassificationJobFilter_jobName :: Lens' DocumentClassificationJobFilter (Maybe Text)
- documentClassificationJobFilter_jobStatus :: Lens' DocumentClassificationJobFilter (Maybe JobStatus)
- data DocumentClassificationJobProperties = DocumentClassificationJobProperties' {
- jobId :: Maybe Text
- jobArn :: Maybe Text
- documentClassifierArn :: Maybe Text
- jobName :: Maybe Text
- inputDataConfig :: Maybe InputDataConfig
- vpcConfig :: Maybe VpcConfig
- volumeKmsKeyId :: Maybe Text
- endTime :: Maybe POSIX
- outputDataConfig :: Maybe OutputDataConfig
- dataAccessRoleArn :: Maybe Text
- jobStatus :: Maybe JobStatus
- message :: Maybe Text
- submitTime :: Maybe POSIX
- newDocumentClassificationJobProperties :: DocumentClassificationJobProperties
- documentClassificationJobProperties_jobId :: Lens' DocumentClassificationJobProperties (Maybe Text)
- documentClassificationJobProperties_jobArn :: Lens' DocumentClassificationJobProperties (Maybe Text)
- documentClassificationJobProperties_documentClassifierArn :: Lens' DocumentClassificationJobProperties (Maybe Text)
- documentClassificationJobProperties_jobName :: Lens' DocumentClassificationJobProperties (Maybe Text)
- documentClassificationJobProperties_inputDataConfig :: Lens' DocumentClassificationJobProperties (Maybe InputDataConfig)
- documentClassificationJobProperties_vpcConfig :: Lens' DocumentClassificationJobProperties (Maybe VpcConfig)
- documentClassificationJobProperties_volumeKmsKeyId :: Lens' DocumentClassificationJobProperties (Maybe Text)
- documentClassificationJobProperties_endTime :: Lens' DocumentClassificationJobProperties (Maybe UTCTime)
- documentClassificationJobProperties_outputDataConfig :: Lens' DocumentClassificationJobProperties (Maybe OutputDataConfig)
- documentClassificationJobProperties_dataAccessRoleArn :: Lens' DocumentClassificationJobProperties (Maybe Text)
- documentClassificationJobProperties_jobStatus :: Lens' DocumentClassificationJobProperties (Maybe JobStatus)
- documentClassificationJobProperties_message :: Lens' DocumentClassificationJobProperties (Maybe Text)
- documentClassificationJobProperties_submitTime :: Lens' DocumentClassificationJobProperties (Maybe UTCTime)
- data DocumentClassifierFilter = DocumentClassifierFilter' {}
- newDocumentClassifierFilter :: DocumentClassifierFilter
- documentClassifierFilter_status :: Lens' DocumentClassifierFilter (Maybe ModelStatus)
- documentClassifierFilter_submitTimeAfter :: Lens' DocumentClassifierFilter (Maybe UTCTime)
- documentClassifierFilter_submitTimeBefore :: Lens' DocumentClassifierFilter (Maybe UTCTime)
- documentClassifierFilter_documentClassifierName :: Lens' DocumentClassifierFilter (Maybe Text)
- data DocumentClassifierInputDataConfig = DocumentClassifierInputDataConfig' {}
- newDocumentClassifierInputDataConfig :: DocumentClassifierInputDataConfig
- documentClassifierInputDataConfig_augmentedManifests :: Lens' DocumentClassifierInputDataConfig (Maybe [AugmentedManifestsListItem])
- documentClassifierInputDataConfig_dataFormat :: Lens' DocumentClassifierInputDataConfig (Maybe DocumentClassifierDataFormat)
- documentClassifierInputDataConfig_labelDelimiter :: Lens' DocumentClassifierInputDataConfig (Maybe Text)
- documentClassifierInputDataConfig_testS3Uri :: Lens' DocumentClassifierInputDataConfig (Maybe Text)
- documentClassifierInputDataConfig_s3Uri :: Lens' DocumentClassifierInputDataConfig (Maybe Text)
- data DocumentClassifierOutputDataConfig = DocumentClassifierOutputDataConfig' {}
- newDocumentClassifierOutputDataConfig :: DocumentClassifierOutputDataConfig
- documentClassifierOutputDataConfig_kmsKeyId :: Lens' DocumentClassifierOutputDataConfig (Maybe Text)
- documentClassifierOutputDataConfig_s3Uri :: Lens' DocumentClassifierOutputDataConfig (Maybe Text)
- data DocumentClassifierProperties = DocumentClassifierProperties' {
- status :: Maybe ModelStatus
- languageCode :: Maybe LanguageCode
- classifierMetadata :: Maybe (Sensitive ClassifierMetadata)
- trainingEndTime :: Maybe POSIX
- documentClassifierArn :: Maybe Text
- versionName :: Maybe Text
- modelKmsKeyId :: Maybe Text
- mode :: Maybe DocumentClassifierMode
- inputDataConfig :: Maybe DocumentClassifierInputDataConfig
- vpcConfig :: Maybe VpcConfig
- volumeKmsKeyId :: Maybe Text
- endTime :: Maybe POSIX
- outputDataConfig :: Maybe DocumentClassifierOutputDataConfig
- trainingStartTime :: Maybe POSIX
- dataAccessRoleArn :: Maybe Text
- message :: Maybe Text
- submitTime :: Maybe POSIX
- newDocumentClassifierProperties :: DocumentClassifierProperties
- documentClassifierProperties_status :: Lens' DocumentClassifierProperties (Maybe ModelStatus)
- documentClassifierProperties_languageCode :: Lens' DocumentClassifierProperties (Maybe LanguageCode)
- documentClassifierProperties_classifierMetadata :: Lens' DocumentClassifierProperties (Maybe ClassifierMetadata)
- documentClassifierProperties_trainingEndTime :: Lens' DocumentClassifierProperties (Maybe UTCTime)
- documentClassifierProperties_documentClassifierArn :: Lens' DocumentClassifierProperties (Maybe Text)
- documentClassifierProperties_versionName :: Lens' DocumentClassifierProperties (Maybe Text)
- documentClassifierProperties_modelKmsKeyId :: Lens' DocumentClassifierProperties (Maybe Text)
- documentClassifierProperties_mode :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierMode)
- documentClassifierProperties_inputDataConfig :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierInputDataConfig)
- documentClassifierProperties_vpcConfig :: Lens' DocumentClassifierProperties (Maybe VpcConfig)
- documentClassifierProperties_volumeKmsKeyId :: Lens' DocumentClassifierProperties (Maybe Text)
- documentClassifierProperties_endTime :: Lens' DocumentClassifierProperties (Maybe UTCTime)
- documentClassifierProperties_outputDataConfig :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierOutputDataConfig)
- documentClassifierProperties_trainingStartTime :: Lens' DocumentClassifierProperties (Maybe UTCTime)
- documentClassifierProperties_dataAccessRoleArn :: Lens' DocumentClassifierProperties (Maybe Text)
- documentClassifierProperties_message :: Lens' DocumentClassifierProperties (Maybe Text)
- documentClassifierProperties_submitTime :: Lens' DocumentClassifierProperties (Maybe UTCTime)
- data DocumentClassifierSummary = DocumentClassifierSummary' {}
- newDocumentClassifierSummary :: DocumentClassifierSummary
- documentClassifierSummary_latestVersionCreatedAt :: Lens' DocumentClassifierSummary (Maybe UTCTime)
- documentClassifierSummary_documentClassifierName :: Lens' DocumentClassifierSummary (Maybe Text)
- documentClassifierSummary_latestVersionStatus :: Lens' DocumentClassifierSummary (Maybe ModelStatus)
- documentClassifierSummary_numberOfVersions :: Lens' DocumentClassifierSummary (Maybe Int)
- documentClassifierSummary_latestVersionName :: Lens' DocumentClassifierSummary (Maybe Text)
- data DocumentLabel = DocumentLabel' {}
- newDocumentLabel :: DocumentLabel
- documentLabel_score :: Lens' DocumentLabel (Maybe Double)
- documentLabel_name :: Lens' DocumentLabel (Maybe Text)
- data DocumentReaderConfig = DocumentReaderConfig' {}
- newDocumentReaderConfig :: DocumentReadAction -> DocumentReaderConfig
- documentReaderConfig_featureTypes :: Lens' DocumentReaderConfig (Maybe (NonEmpty DocumentReadFeatureTypes))
- documentReaderConfig_documentReadMode :: Lens' DocumentReaderConfig (Maybe DocumentReadMode)
- documentReaderConfig_documentReadAction :: Lens' DocumentReaderConfig DocumentReadAction
- data DominantLanguage = DominantLanguage' {}
- newDominantLanguage :: DominantLanguage
- dominantLanguage_languageCode :: Lens' DominantLanguage (Maybe Text)
- dominantLanguage_score :: Lens' DominantLanguage (Maybe Double)
- data DominantLanguageDetectionJobFilter = DominantLanguageDetectionJobFilter' {}
- newDominantLanguageDetectionJobFilter :: DominantLanguageDetectionJobFilter
- dominantLanguageDetectionJobFilter_submitTimeAfter :: Lens' DominantLanguageDetectionJobFilter (Maybe UTCTime)
- dominantLanguageDetectionJobFilter_submitTimeBefore :: Lens' DominantLanguageDetectionJobFilter (Maybe UTCTime)
- dominantLanguageDetectionJobFilter_jobName :: Lens' DominantLanguageDetectionJobFilter (Maybe Text)
- dominantLanguageDetectionJobFilter_jobStatus :: Lens' DominantLanguageDetectionJobFilter (Maybe JobStatus)
- data DominantLanguageDetectionJobProperties = DominantLanguageDetectionJobProperties' {
- jobId :: Maybe Text
- jobArn :: Maybe Text
- jobName :: Maybe Text
- inputDataConfig :: Maybe InputDataConfig
- vpcConfig :: Maybe VpcConfig
- volumeKmsKeyId :: Maybe Text
- endTime :: Maybe POSIX
- outputDataConfig :: Maybe OutputDataConfig
- dataAccessRoleArn :: Maybe Text
- jobStatus :: Maybe JobStatus
- message :: Maybe Text
- submitTime :: Maybe POSIX
- newDominantLanguageDetectionJobProperties :: DominantLanguageDetectionJobProperties
- dominantLanguageDetectionJobProperties_jobId :: Lens' DominantLanguageDetectionJobProperties (Maybe Text)
- dominantLanguageDetectionJobProperties_jobArn :: Lens' DominantLanguageDetectionJobProperties (Maybe Text)
- dominantLanguageDetectionJobProperties_jobName :: Lens' DominantLanguageDetectionJobProperties (Maybe Text)
- dominantLanguageDetectionJobProperties_inputDataConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe InputDataConfig)
- dominantLanguageDetectionJobProperties_vpcConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe VpcConfig)
- dominantLanguageDetectionJobProperties_volumeKmsKeyId :: Lens' DominantLanguageDetectionJobProperties (Maybe Text)
- dominantLanguageDetectionJobProperties_endTime :: Lens' DominantLanguageDetectionJobProperties (Maybe UTCTime)
- dominantLanguageDetectionJobProperties_outputDataConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe OutputDataConfig)
- dominantLanguageDetectionJobProperties_dataAccessRoleArn :: Lens' DominantLanguageDetectionJobProperties (Maybe Text)
- dominantLanguageDetectionJobProperties_jobStatus :: Lens' DominantLanguageDetectionJobProperties (Maybe JobStatus)
- dominantLanguageDetectionJobProperties_message :: Lens' DominantLanguageDetectionJobProperties (Maybe Text)
- dominantLanguageDetectionJobProperties_submitTime :: Lens' DominantLanguageDetectionJobProperties (Maybe UTCTime)
- data EndpointFilter = EndpointFilter' {}
- newEndpointFilter :: EndpointFilter
- endpointFilter_status :: Lens' EndpointFilter (Maybe EndpointStatus)
- endpointFilter_modelArn :: Lens' EndpointFilter (Maybe Text)
- endpointFilter_creationTimeAfter :: Lens' EndpointFilter (Maybe UTCTime)
- endpointFilter_creationTimeBefore :: Lens' EndpointFilter (Maybe UTCTime)
- data EndpointProperties = EndpointProperties' {
- creationTime :: Maybe POSIX
- status :: Maybe EndpointStatus
- modelArn :: Maybe Text
- desiredModelArn :: Maybe Text
- lastModifiedTime :: Maybe POSIX
- desiredInferenceUnits :: Maybe Natural
- currentInferenceUnits :: Maybe Natural
- dataAccessRoleArn :: Maybe Text
- desiredDataAccessRoleArn :: Maybe Text
- message :: Maybe Text
- endpointArn :: Maybe Text
- newEndpointProperties :: EndpointProperties
- endpointProperties_creationTime :: Lens' EndpointProperties (Maybe UTCTime)
- endpointProperties_status :: Lens' EndpointProperties (Maybe EndpointStatus)
- endpointProperties_modelArn :: Lens' EndpointProperties (Maybe Text)
- endpointProperties_desiredModelArn :: Lens' EndpointProperties (Maybe Text)
- endpointProperties_lastModifiedTime :: Lens' EndpointProperties (Maybe UTCTime)
- endpointProperties_desiredInferenceUnits :: Lens' EndpointProperties (Maybe Natural)
- endpointProperties_currentInferenceUnits :: Lens' EndpointProperties (Maybe Natural)
- endpointProperties_dataAccessRoleArn :: Lens' EndpointProperties (Maybe Text)
- endpointProperties_desiredDataAccessRoleArn :: Lens' EndpointProperties (Maybe Text)
- endpointProperties_message :: Lens' EndpointProperties (Maybe Text)
- endpointProperties_endpointArn :: Lens' EndpointProperties (Maybe Text)
- data EntitiesDetectionJobFilter = EntitiesDetectionJobFilter' {}
- newEntitiesDetectionJobFilter :: EntitiesDetectionJobFilter
- entitiesDetectionJobFilter_submitTimeAfter :: Lens' EntitiesDetectionJobFilter (Maybe UTCTime)
- entitiesDetectionJobFilter_submitTimeBefore :: Lens' EntitiesDetectionJobFilter (Maybe UTCTime)
- entitiesDetectionJobFilter_jobName :: Lens' EntitiesDetectionJobFilter (Maybe Text)
- entitiesDetectionJobFilter_jobStatus :: Lens' EntitiesDetectionJobFilter (Maybe JobStatus)
- data EntitiesDetectionJobProperties = EntitiesDetectionJobProperties' {
- languageCode :: Maybe LanguageCode
- jobId :: Maybe Text
- jobArn :: Maybe Text
- entityRecognizerArn :: Maybe Text
- jobName :: Maybe Text
- inputDataConfig :: Maybe InputDataConfig
- vpcConfig :: Maybe VpcConfig
- volumeKmsKeyId :: Maybe Text
- endTime :: Maybe POSIX
- outputDataConfig :: Maybe OutputDataConfig
- dataAccessRoleArn :: Maybe Text
- jobStatus :: Maybe JobStatus
- message :: Maybe Text
- submitTime :: Maybe POSIX
- newEntitiesDetectionJobProperties :: EntitiesDetectionJobProperties
- entitiesDetectionJobProperties_languageCode :: Lens' EntitiesDetectionJobProperties (Maybe LanguageCode)
- entitiesDetectionJobProperties_jobId :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_jobArn :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_entityRecognizerArn :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_jobName :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_inputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe InputDataConfig)
- entitiesDetectionJobProperties_vpcConfig :: Lens' EntitiesDetectionJobProperties (Maybe VpcConfig)
- entitiesDetectionJobProperties_volumeKmsKeyId :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_endTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime)
- entitiesDetectionJobProperties_outputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe OutputDataConfig)
- entitiesDetectionJobProperties_dataAccessRoleArn :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_jobStatus :: Lens' EntitiesDetectionJobProperties (Maybe JobStatus)
- entitiesDetectionJobProperties_message :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_submitTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime)
- data Entity = Entity' {}
- newEntity :: Entity
- entity_beginOffset :: Lens' Entity (Maybe Int)
- entity_text :: Lens' Entity (Maybe Text)
- entity_score :: Lens' Entity (Maybe Double)
- entity_endOffset :: Lens' Entity (Maybe Int)
- entity_type :: Lens' Entity (Maybe EntityType)
- data EntityLabel = EntityLabel' {}
- newEntityLabel :: EntityLabel
- entityLabel_score :: Lens' EntityLabel (Maybe Double)
- entityLabel_name :: Lens' EntityLabel (Maybe PiiEntityType)
- data EntityRecognizerAnnotations = EntityRecognizerAnnotations' {}
- newEntityRecognizerAnnotations :: Text -> EntityRecognizerAnnotations
- entityRecognizerAnnotations_testS3Uri :: Lens' EntityRecognizerAnnotations (Maybe Text)
- entityRecognizerAnnotations_s3Uri :: Lens' EntityRecognizerAnnotations Text
- data EntityRecognizerDocuments = EntityRecognizerDocuments' {
- inputFormat :: Maybe InputFormat
- testS3Uri :: Maybe Text
- s3Uri :: Text
- newEntityRecognizerDocuments :: Text -> EntityRecognizerDocuments
- entityRecognizerDocuments_inputFormat :: Lens' EntityRecognizerDocuments (Maybe InputFormat)
- entityRecognizerDocuments_testS3Uri :: Lens' EntityRecognizerDocuments (Maybe Text)
- entityRecognizerDocuments_s3Uri :: Lens' EntityRecognizerDocuments Text
- data EntityRecognizerEntityList = EntityRecognizerEntityList' {}
- newEntityRecognizerEntityList :: Text -> EntityRecognizerEntityList
- entityRecognizerEntityList_s3Uri :: Lens' EntityRecognizerEntityList Text
- data EntityRecognizerEvaluationMetrics = EntityRecognizerEvaluationMetrics' {}
- newEntityRecognizerEvaluationMetrics :: EntityRecognizerEvaluationMetrics
- entityRecognizerEvaluationMetrics_recall :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double)
- entityRecognizerEvaluationMetrics_precision :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double)
- entityRecognizerEvaluationMetrics_f1Score :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double)
- data EntityRecognizerFilter = EntityRecognizerFilter' {}
- newEntityRecognizerFilter :: EntityRecognizerFilter
- entityRecognizerFilter_status :: Lens' EntityRecognizerFilter (Maybe ModelStatus)
- entityRecognizerFilter_submitTimeAfter :: Lens' EntityRecognizerFilter (Maybe UTCTime)
- entityRecognizerFilter_submitTimeBefore :: Lens' EntityRecognizerFilter (Maybe UTCTime)
- entityRecognizerFilter_recognizerName :: Lens' EntityRecognizerFilter (Maybe Text)
- data EntityRecognizerInputDataConfig = EntityRecognizerInputDataConfig' {}
- newEntityRecognizerInputDataConfig :: EntityRecognizerInputDataConfig
- entityRecognizerInputDataConfig_augmentedManifests :: Lens' EntityRecognizerInputDataConfig (Maybe [AugmentedManifestsListItem])
- entityRecognizerInputDataConfig_annotations :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerAnnotations)
- entityRecognizerInputDataConfig_dataFormat :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerDataFormat)
- entityRecognizerInputDataConfig_documents :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerDocuments)
- entityRecognizerInputDataConfig_entityList :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerEntityList)
- entityRecognizerInputDataConfig_entityTypes :: Lens' EntityRecognizerInputDataConfig [EntityTypesListItem]
- data EntityRecognizerMetadata = EntityRecognizerMetadata' {}
- newEntityRecognizerMetadata :: EntityRecognizerMetadata
- entityRecognizerMetadata_entityTypes :: Lens' EntityRecognizerMetadata (Maybe [EntityRecognizerMetadataEntityTypesListItem])
- entityRecognizerMetadata_evaluationMetrics :: Lens' EntityRecognizerMetadata (Maybe EntityRecognizerEvaluationMetrics)
- entityRecognizerMetadata_numberOfTrainedDocuments :: Lens' EntityRecognizerMetadata (Maybe Int)
- entityRecognizerMetadata_numberOfTestDocuments :: Lens' EntityRecognizerMetadata (Maybe Int)
- data EntityRecognizerMetadataEntityTypesListItem = EntityRecognizerMetadataEntityTypesListItem' {}
- newEntityRecognizerMetadataEntityTypesListItem :: EntityRecognizerMetadataEntityTypesListItem
- entityRecognizerMetadataEntityTypesListItem_evaluationMetrics :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe EntityTypesEvaluationMetrics)
- entityRecognizerMetadataEntityTypesListItem_type :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe Text)
- entityRecognizerMetadataEntityTypesListItem_numberOfTrainMentions :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe Int)
- data EntityRecognizerProperties = EntityRecognizerProperties' {
- status :: Maybe ModelStatus
- languageCode :: Maybe LanguageCode
- trainingEndTime :: Maybe POSIX
- versionName :: Maybe Text
- entityRecognizerArn :: Maybe Text
- modelKmsKeyId :: Maybe Text
- inputDataConfig :: Maybe EntityRecognizerInputDataConfig
- vpcConfig :: Maybe VpcConfig
- volumeKmsKeyId :: Maybe Text
- endTime :: Maybe POSIX
- trainingStartTime :: Maybe POSIX
- dataAccessRoleArn :: Maybe Text
- recognizerMetadata :: Maybe (Sensitive EntityRecognizerMetadata)
- message :: Maybe Text
- submitTime :: Maybe POSIX
- newEntityRecognizerProperties :: EntityRecognizerProperties
- entityRecognizerProperties_status :: Lens' EntityRecognizerProperties (Maybe ModelStatus)
- entityRecognizerProperties_languageCode :: Lens' EntityRecognizerProperties (Maybe LanguageCode)
- entityRecognizerProperties_trainingEndTime :: Lens' EntityRecognizerProperties (Maybe UTCTime)
- entityRecognizerProperties_versionName :: Lens' EntityRecognizerProperties (Maybe Text)
- entityRecognizerProperties_entityRecognizerArn :: Lens' EntityRecognizerProperties (Maybe Text)
- entityRecognizerProperties_modelKmsKeyId :: Lens' EntityRecognizerProperties (Maybe Text)
- entityRecognizerProperties_inputDataConfig :: Lens' EntityRecognizerProperties (Maybe EntityRecognizerInputDataConfig)
- entityRecognizerProperties_vpcConfig :: Lens' EntityRecognizerProperties (Maybe VpcConfig)
- entityRecognizerProperties_volumeKmsKeyId :: Lens' EntityRecognizerProperties (Maybe Text)
- entityRecognizerProperties_endTime :: Lens' EntityRecognizerProperties (Maybe UTCTime)
- entityRecognizerProperties_trainingStartTime :: Lens' EntityRecognizerProperties (Maybe UTCTime)
- entityRecognizerProperties_dataAccessRoleArn :: Lens' EntityRecognizerProperties (Maybe Text)
- entityRecognizerProperties_recognizerMetadata :: Lens' EntityRecognizerProperties (Maybe EntityRecognizerMetadata)
- entityRecognizerProperties_message :: Lens' EntityRecognizerProperties (Maybe Text)
- entityRecognizerProperties_submitTime :: Lens' EntityRecognizerProperties (Maybe UTCTime)
- data EntityRecognizerSummary = EntityRecognizerSummary' {}
- newEntityRecognizerSummary :: EntityRecognizerSummary
- entityRecognizerSummary_latestVersionCreatedAt :: Lens' EntityRecognizerSummary (Maybe UTCTime)
- entityRecognizerSummary_latestVersionStatus :: Lens' EntityRecognizerSummary (Maybe ModelStatus)
- entityRecognizerSummary_numberOfVersions :: Lens' EntityRecognizerSummary (Maybe Int)
- entityRecognizerSummary_latestVersionName :: Lens' EntityRecognizerSummary (Maybe Text)
- entityRecognizerSummary_recognizerName :: Lens' EntityRecognizerSummary (Maybe Text)
- data EntityTypesEvaluationMetrics = EntityTypesEvaluationMetrics' {}
- newEntityTypesEvaluationMetrics :: EntityTypesEvaluationMetrics
- entityTypesEvaluationMetrics_recall :: Lens' EntityTypesEvaluationMetrics (Maybe Double)
- entityTypesEvaluationMetrics_precision :: Lens' EntityTypesEvaluationMetrics (Maybe Double)
- entityTypesEvaluationMetrics_f1Score :: Lens' EntityTypesEvaluationMetrics (Maybe Double)
- data EntityTypesListItem = EntityTypesListItem' {}
- newEntityTypesListItem :: Text -> EntityTypesListItem
- entityTypesListItem_type :: Lens' EntityTypesListItem Text
- data EventsDetectionJobFilter = EventsDetectionJobFilter' {}
- newEventsDetectionJobFilter :: EventsDetectionJobFilter
- eventsDetectionJobFilter_submitTimeAfter :: Lens' EventsDetectionJobFilter (Maybe UTCTime)
- eventsDetectionJobFilter_submitTimeBefore :: Lens' EventsDetectionJobFilter (Maybe UTCTime)
- eventsDetectionJobFilter_jobName :: Lens' EventsDetectionJobFilter (Maybe Text)
- eventsDetectionJobFilter_jobStatus :: Lens' EventsDetectionJobFilter (Maybe JobStatus)
- data EventsDetectionJobProperties = EventsDetectionJobProperties' {
- languageCode :: Maybe LanguageCode
- jobId :: Maybe Text
- jobArn :: Maybe Text
- jobName :: Maybe Text
- targetEventTypes :: Maybe (NonEmpty Text)
- inputDataConfig :: Maybe InputDataConfig
- endTime :: Maybe POSIX
- outputDataConfig :: Maybe OutputDataConfig
- dataAccessRoleArn :: Maybe Text
- jobStatus :: Maybe JobStatus
- message :: Maybe Text
- submitTime :: Maybe POSIX
- newEventsDetectionJobProperties :: EventsDetectionJobProperties
- eventsDetectionJobProperties_languageCode :: Lens' EventsDetectionJobProperties (Maybe LanguageCode)
- eventsDetectionJobProperties_jobId :: Lens' EventsDetectionJobProperties (Maybe Text)
- eventsDetectionJobProperties_jobArn :: Lens' EventsDetectionJobProperties (Maybe Text)
- eventsDetectionJobProperties_jobName :: Lens' EventsDetectionJobProperties (Maybe Text)
- eventsDetectionJobProperties_targetEventTypes :: Lens' EventsDetectionJobProperties (Maybe (NonEmpty Text))
- eventsDetectionJobProperties_inputDataConfig :: Lens' EventsDetectionJobProperties (Maybe InputDataConfig)
- eventsDetectionJobProperties_endTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime)
- eventsDetectionJobProperties_outputDataConfig :: Lens' EventsDetectionJobProperties (Maybe OutputDataConfig)
- eventsDetectionJobProperties_dataAccessRoleArn :: Lens' EventsDetectionJobProperties (Maybe Text)
- eventsDetectionJobProperties_jobStatus :: Lens' EventsDetectionJobProperties (Maybe JobStatus)
- eventsDetectionJobProperties_message :: Lens' EventsDetectionJobProperties (Maybe Text)
- eventsDetectionJobProperties_submitTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime)
- data InputDataConfig = InputDataConfig' {}
- newInputDataConfig :: Text -> InputDataConfig
- inputDataConfig_documentReaderConfig :: Lens' InputDataConfig (Maybe DocumentReaderConfig)
- inputDataConfig_inputFormat :: Lens' InputDataConfig (Maybe InputFormat)
- inputDataConfig_s3Uri :: Lens' InputDataConfig Text
- data KeyPhrase = KeyPhrase' {}
- newKeyPhrase :: KeyPhrase
- keyPhrase_beginOffset :: Lens' KeyPhrase (Maybe Int)
- keyPhrase_text :: Lens' KeyPhrase (Maybe Text)
- keyPhrase_score :: Lens' KeyPhrase (Maybe Double)
- keyPhrase_endOffset :: Lens' KeyPhrase (Maybe Int)
- data KeyPhrasesDetectionJobFilter = KeyPhrasesDetectionJobFilter' {}
- newKeyPhrasesDetectionJobFilter :: KeyPhrasesDetectionJobFilter
- keyPhrasesDetectionJobFilter_submitTimeAfter :: Lens' KeyPhrasesDetectionJobFilter (Maybe UTCTime)
- keyPhrasesDetectionJobFilter_submitTimeBefore :: Lens' KeyPhrasesDetectionJobFilter (Maybe UTCTime)
- keyPhrasesDetectionJobFilter_jobName :: Lens' KeyPhrasesDetectionJobFilter (Maybe Text)
- keyPhrasesDetectionJobFilter_jobStatus :: Lens' KeyPhrasesDetectionJobFilter (Maybe JobStatus)
- data KeyPhrasesDetectionJobProperties = KeyPhrasesDetectionJobProperties' {
- languageCode :: Maybe LanguageCode
- jobId :: Maybe Text
- jobArn :: Maybe Text
- jobName :: Maybe Text
- inputDataConfig :: Maybe InputDataConfig
- vpcConfig :: Maybe VpcConfig
- volumeKmsKeyId :: Maybe Text
- endTime :: Maybe POSIX
- outputDataConfig :: Maybe OutputDataConfig
- dataAccessRoleArn :: Maybe Text
- jobStatus :: Maybe JobStatus
- message :: Maybe Text
- submitTime :: Maybe POSIX
- newKeyPhrasesDetectionJobProperties :: KeyPhrasesDetectionJobProperties
- keyPhrasesDetectionJobProperties_languageCode :: Lens' KeyPhrasesDetectionJobProperties (Maybe LanguageCode)
- keyPhrasesDetectionJobProperties_jobId :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text)
- keyPhrasesDetectionJobProperties_jobArn :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text)
- keyPhrasesDetectionJobProperties_jobName :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text)
- keyPhrasesDetectionJobProperties_inputDataConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe InputDataConfig)
- keyPhrasesDetectionJobProperties_vpcConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe VpcConfig)
- keyPhrasesDetectionJobProperties_volumeKmsKeyId :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text)
- keyPhrasesDetectionJobProperties_endTime :: Lens' KeyPhrasesDetectionJobProperties (Maybe UTCTime)
- keyPhrasesDetectionJobProperties_outputDataConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe OutputDataConfig)
- keyPhrasesDetectionJobProperties_dataAccessRoleArn :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text)
- keyPhrasesDetectionJobProperties_jobStatus :: Lens' KeyPhrasesDetectionJobProperties (Maybe JobStatus)
- keyPhrasesDetectionJobProperties_message :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text)
- keyPhrasesDetectionJobProperties_submitTime :: Lens' KeyPhrasesDetectionJobProperties (Maybe UTCTime)
- data OutputDataConfig = OutputDataConfig' {}
- newOutputDataConfig :: Text -> OutputDataConfig
- outputDataConfig_kmsKeyId :: Lens' OutputDataConfig (Maybe Text)
- outputDataConfig_s3Uri :: Lens' OutputDataConfig Text
- data PartOfSpeechTag = PartOfSpeechTag' {}
- newPartOfSpeechTag :: PartOfSpeechTag
- partOfSpeechTag_tag :: Lens' PartOfSpeechTag (Maybe PartOfSpeechTagType)
- partOfSpeechTag_score :: Lens' PartOfSpeechTag (Maybe Double)
- data PiiEntitiesDetectionJobFilter = PiiEntitiesDetectionJobFilter' {}
- newPiiEntitiesDetectionJobFilter :: PiiEntitiesDetectionJobFilter
- piiEntitiesDetectionJobFilter_submitTimeAfter :: Lens' PiiEntitiesDetectionJobFilter (Maybe UTCTime)
- piiEntitiesDetectionJobFilter_submitTimeBefore :: Lens' PiiEntitiesDetectionJobFilter (Maybe UTCTime)
- piiEntitiesDetectionJobFilter_jobName :: Lens' PiiEntitiesDetectionJobFilter (Maybe Text)
- piiEntitiesDetectionJobFilter_jobStatus :: Lens' PiiEntitiesDetectionJobFilter (Maybe JobStatus)
- data PiiEntitiesDetectionJobProperties = PiiEntitiesDetectionJobProperties' {
- languageCode :: Maybe LanguageCode
- jobId :: Maybe Text
- jobArn :: Maybe Text
- jobName :: Maybe Text
- mode :: Maybe PiiEntitiesDetectionMode
- inputDataConfig :: Maybe InputDataConfig
- redactionConfig :: Maybe RedactionConfig
- endTime :: Maybe POSIX
- outputDataConfig :: Maybe PiiOutputDataConfig
- dataAccessRoleArn :: Maybe Text
- jobStatus :: Maybe JobStatus
- message :: Maybe Text
- submitTime :: Maybe POSIX
- newPiiEntitiesDetectionJobProperties :: PiiEntitiesDetectionJobProperties
- piiEntitiesDetectionJobProperties_languageCode :: Lens' PiiEntitiesDetectionJobProperties (Maybe LanguageCode)
- piiEntitiesDetectionJobProperties_jobId :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text)
- piiEntitiesDetectionJobProperties_jobArn :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text)
- piiEntitiesDetectionJobProperties_jobName :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text)
- piiEntitiesDetectionJobProperties_mode :: Lens' PiiEntitiesDetectionJobProperties (Maybe PiiEntitiesDetectionMode)
- piiEntitiesDetectionJobProperties_inputDataConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe InputDataConfig)
- piiEntitiesDetectionJobProperties_redactionConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe RedactionConfig)
- piiEntitiesDetectionJobProperties_endTime :: Lens' PiiEntitiesDetectionJobProperties (Maybe UTCTime)
- piiEntitiesDetectionJobProperties_outputDataConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe PiiOutputDataConfig)
- piiEntitiesDetectionJobProperties_dataAccessRoleArn :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text)
- piiEntitiesDetectionJobProperties_jobStatus :: Lens' PiiEntitiesDetectionJobProperties (Maybe JobStatus)
- piiEntitiesDetectionJobProperties_message :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text)
- piiEntitiesDetectionJobProperties_submitTime :: Lens' PiiEntitiesDetectionJobProperties (Maybe UTCTime)
- data PiiEntity = PiiEntity' {}
- newPiiEntity :: PiiEntity
- piiEntity_beginOffset :: Lens' PiiEntity (Maybe Int)
- piiEntity_score :: Lens' PiiEntity (Maybe Double)
- piiEntity_endOffset :: Lens' PiiEntity (Maybe Int)
- piiEntity_type :: Lens' PiiEntity (Maybe PiiEntityType)
- data PiiOutputDataConfig = PiiOutputDataConfig' {}
- newPiiOutputDataConfig :: Text -> PiiOutputDataConfig
- piiOutputDataConfig_kmsKeyId :: Lens' PiiOutputDataConfig (Maybe Text)
- piiOutputDataConfig_s3Uri :: Lens' PiiOutputDataConfig Text
- data RedactionConfig = RedactionConfig' {}
- newRedactionConfig :: RedactionConfig
- redactionConfig_maskCharacter :: Lens' RedactionConfig (Maybe Text)
- redactionConfig_maskMode :: Lens' RedactionConfig (Maybe PiiEntitiesDetectionMaskMode)
- redactionConfig_piiEntityTypes :: Lens' RedactionConfig (Maybe [PiiEntityType])
- data SentimentDetectionJobFilter = SentimentDetectionJobFilter' {}
- newSentimentDetectionJobFilter :: SentimentDetectionJobFilter
- sentimentDetectionJobFilter_submitTimeAfter :: Lens' SentimentDetectionJobFilter (Maybe UTCTime)
- sentimentDetectionJobFilter_submitTimeBefore :: Lens' SentimentDetectionJobFilter (Maybe UTCTime)
- sentimentDetectionJobFilter_jobName :: Lens' SentimentDetectionJobFilter (Maybe Text)
- sentimentDetectionJobFilter_jobStatus :: Lens' SentimentDetectionJobFilter (Maybe JobStatus)
- data SentimentDetectionJobProperties = SentimentDetectionJobProperties' {
- languageCode :: Maybe LanguageCode
- jobId :: Maybe Text
- jobArn :: Maybe Text
- jobName :: Maybe Text
- inputDataConfig :: Maybe InputDataConfig
- vpcConfig :: Maybe VpcConfig
- volumeKmsKeyId :: Maybe Text
- endTime :: Maybe POSIX
- outputDataConfig :: Maybe OutputDataConfig
- dataAccessRoleArn :: Maybe Text
- jobStatus :: Maybe JobStatus
- message :: Maybe Text
- submitTime :: Maybe POSIX
- newSentimentDetectionJobProperties :: SentimentDetectionJobProperties
- sentimentDetectionJobProperties_languageCode :: Lens' SentimentDetectionJobProperties (Maybe LanguageCode)
- sentimentDetectionJobProperties_jobId :: Lens' SentimentDetectionJobProperties (Maybe Text)
- sentimentDetectionJobProperties_jobArn :: Lens' SentimentDetectionJobProperties (Maybe Text)
- sentimentDetectionJobProperties_jobName :: Lens' SentimentDetectionJobProperties (Maybe Text)
- sentimentDetectionJobProperties_inputDataConfig :: Lens' SentimentDetectionJobProperties (Maybe InputDataConfig)
- sentimentDetectionJobProperties_vpcConfig :: Lens' SentimentDetectionJobProperties (Maybe VpcConfig)
- sentimentDetectionJobProperties_volumeKmsKeyId :: Lens' SentimentDetectionJobProperties (Maybe Text)
- sentimentDetectionJobProperties_endTime :: Lens' SentimentDetectionJobProperties (Maybe UTCTime)
- sentimentDetectionJobProperties_outputDataConfig :: Lens' SentimentDetectionJobProperties (Maybe OutputDataConfig)
- sentimentDetectionJobProperties_dataAccessRoleArn :: Lens' SentimentDetectionJobProperties (Maybe Text)
- sentimentDetectionJobProperties_jobStatus :: Lens' SentimentDetectionJobProperties (Maybe JobStatus)
- sentimentDetectionJobProperties_message :: Lens' SentimentDetectionJobProperties (Maybe Text)
- sentimentDetectionJobProperties_submitTime :: Lens' SentimentDetectionJobProperties (Maybe UTCTime)
- data SentimentScore = SentimentScore' {}
- newSentimentScore :: SentimentScore
- sentimentScore_mixed :: Lens' SentimentScore (Maybe Double)
- sentimentScore_negative :: Lens' SentimentScore (Maybe Double)
- sentimentScore_neutral :: Lens' SentimentScore (Maybe Double)
- sentimentScore_positive :: Lens' SentimentScore (Maybe Double)
- data SyntaxToken = SyntaxToken' {
- beginOffset :: Maybe Int
- text :: Maybe Text
- tokenId :: Maybe Int
- endOffset :: Maybe Int
- partOfSpeech :: Maybe PartOfSpeechTag
- newSyntaxToken :: SyntaxToken
- syntaxToken_beginOffset :: Lens' SyntaxToken (Maybe Int)
- syntaxToken_text :: Lens' SyntaxToken (Maybe Text)
- syntaxToken_tokenId :: Lens' SyntaxToken (Maybe Int)
- syntaxToken_endOffset :: Lens' SyntaxToken (Maybe Int)
- syntaxToken_partOfSpeech :: Lens' SyntaxToken (Maybe PartOfSpeechTag)
- data Tag = Tag' {}
- newTag :: Text -> Tag
- tag_value :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag Text
- data TopicsDetectionJobFilter = TopicsDetectionJobFilter' {}
- newTopicsDetectionJobFilter :: TopicsDetectionJobFilter
- topicsDetectionJobFilter_submitTimeAfter :: Lens' TopicsDetectionJobFilter (Maybe UTCTime)
- topicsDetectionJobFilter_submitTimeBefore :: Lens' TopicsDetectionJobFilter (Maybe UTCTime)
- topicsDetectionJobFilter_jobName :: Lens' TopicsDetectionJobFilter (Maybe Text)
- topicsDetectionJobFilter_jobStatus :: Lens' TopicsDetectionJobFilter (Maybe JobStatus)
- data TopicsDetectionJobProperties = TopicsDetectionJobProperties' {
- jobId :: Maybe Text
- jobArn :: Maybe Text
- jobName :: Maybe Text
- inputDataConfig :: Maybe InputDataConfig
- vpcConfig :: Maybe VpcConfig
- volumeKmsKeyId :: Maybe Text
- endTime :: Maybe POSIX
- outputDataConfig :: Maybe OutputDataConfig
- dataAccessRoleArn :: Maybe Text
- numberOfTopics :: Maybe Int
- jobStatus :: Maybe JobStatus
- message :: Maybe Text
- submitTime :: Maybe POSIX
- newTopicsDetectionJobProperties :: TopicsDetectionJobProperties
- topicsDetectionJobProperties_jobId :: Lens' TopicsDetectionJobProperties (Maybe Text)
- topicsDetectionJobProperties_jobArn :: Lens' TopicsDetectionJobProperties (Maybe Text)
- topicsDetectionJobProperties_jobName :: Lens' TopicsDetectionJobProperties (Maybe Text)
- topicsDetectionJobProperties_inputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe InputDataConfig)
- topicsDetectionJobProperties_vpcConfig :: Lens' TopicsDetectionJobProperties (Maybe VpcConfig)
- topicsDetectionJobProperties_volumeKmsKeyId :: Lens' TopicsDetectionJobProperties (Maybe Text)
- topicsDetectionJobProperties_endTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime)
- topicsDetectionJobProperties_outputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe OutputDataConfig)
- topicsDetectionJobProperties_dataAccessRoleArn :: Lens' TopicsDetectionJobProperties (Maybe Text)
- topicsDetectionJobProperties_numberOfTopics :: Lens' TopicsDetectionJobProperties (Maybe Int)
- topicsDetectionJobProperties_jobStatus :: Lens' TopicsDetectionJobProperties (Maybe JobStatus)
- topicsDetectionJobProperties_message :: Lens' TopicsDetectionJobProperties (Maybe Text)
- topicsDetectionJobProperties_submitTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime)
- data VpcConfig = VpcConfig' {}
- newVpcConfig :: NonEmpty Text -> NonEmpty Text -> VpcConfig
- vpcConfig_securityGroupIds :: Lens' VpcConfig (NonEmpty Text)
- vpcConfig_subnets :: Lens' VpcConfig (NonEmpty Text)
Service Configuration
defaultService :: Service Source #
API version 2017-11-27 of the Amazon Comprehend SDK configuration.
Errors
_ResourceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource is not available. Check the resource and try your request again.
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request is invalid.
_ResourceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
_TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of requests exceeds the limit. Resubmit your request later.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal server error occurred. Retry your request.
_BatchSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
_UnsupportedLanguageException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.
_JobNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified job was not found. Check the job ID and try again.
_TooManyTagKeysException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request contains more tag keys than can be associated with a resource (50 tag keys per resource).
_InvalidFilterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The filter specified for the operation is invalid. Specify a different filter.
_KmsKeyValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource ARN was not found. Check the ARN and try your request again.
_TextSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The size of the input text exceeds the limit. Use a smaller document.
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource name is already in use. Use a different name and try your request again.
AugmentedManifestsDocumentTypeFormat
newtype AugmentedManifestsDocumentTypeFormat Source #
Constructors
| AugmentedManifestsDocumentTypeFormat' | |
Bundled Patterns
Instances
DocumentClassifierDataFormat
newtype DocumentClassifierDataFormat Source #
Constructors
| DocumentClassifierDataFormat' | |
Fields | |
Bundled Patterns
| pattern DocumentClassifierDataFormat_AUGMENTED_MANIFEST :: DocumentClassifierDataFormat | |
| pattern DocumentClassifierDataFormat_COMPREHEND_CSV :: DocumentClassifierDataFormat |
Instances
DocumentClassifierMode
newtype DocumentClassifierMode Source #
Constructors
| DocumentClassifierMode' | |
Fields | |
Bundled Patterns
| pattern DocumentClassifierMode_MULTI_CLASS :: DocumentClassifierMode | |
| pattern DocumentClassifierMode_MULTI_LABEL :: DocumentClassifierMode |
Instances
DocumentReadAction
newtype DocumentReadAction Source #
Constructors
| DocumentReadAction' | |
Fields | |
Bundled Patterns
| pattern DocumentReadAction_TEXTRACT_ANALYZE_DOCUMENT :: DocumentReadAction | |
| pattern DocumentReadAction_TEXTRACT_DETECT_DOCUMENT_TEXT :: DocumentReadAction |
Instances
DocumentReadFeatureTypes
newtype DocumentReadFeatureTypes Source #
A list of the types of analyses to perform. This field specifies what feature types need to be extracted from the document where entity recognition is expected.
TABLES- Add TABLES to the list to return information about the tables that are detected in the input document.FORMS- Add FORMS to return detected form data.
Constructors
| DocumentReadFeatureTypes' | |
Fields | |
Bundled Patterns
| pattern DocumentReadFeatureTypes_FORMS :: DocumentReadFeatureTypes | |
| pattern DocumentReadFeatureTypes_TABLES :: DocumentReadFeatureTypes |
Instances
DocumentReadMode
newtype DocumentReadMode Source #
Constructors
| DocumentReadMode' | |
Fields | |
Bundled Patterns
| pattern DocumentReadMode_FORCE_DOCUMENT_READ_ACTION :: DocumentReadMode | |
| pattern DocumentReadMode_SERVICE_DEFAULT :: DocumentReadMode |
Instances
EndpointStatus
newtype EndpointStatus Source #
Constructors
| EndpointStatus' | |
Fields | |
Bundled Patterns
| pattern EndpointStatus_CREATING :: EndpointStatus | |
| pattern EndpointStatus_DELETING :: EndpointStatus | |
| pattern EndpointStatus_FAILED :: EndpointStatus | |
| pattern EndpointStatus_IN_SERVICE :: EndpointStatus | |
| pattern EndpointStatus_UPDATING :: EndpointStatus |
Instances
EntityRecognizerDataFormat
newtype EntityRecognizerDataFormat Source #
Constructors
| EntityRecognizerDataFormat' | |
Fields | |
Bundled Patterns
| pattern EntityRecognizerDataFormat_AUGMENTED_MANIFEST :: EntityRecognizerDataFormat | |
| pattern EntityRecognizerDataFormat_COMPREHEND_CSV :: EntityRecognizerDataFormat |
Instances
EntityType
newtype EntityType Source #
Constructors
| EntityType' | |
Fields | |
Bundled Patterns
| pattern EntityType_COMMERCIAL_ITEM :: EntityType | |
| pattern EntityType_DATE :: EntityType | |
| pattern EntityType_EVENT :: EntityType | |
| pattern EntityType_LOCATION :: EntityType | |
| pattern EntityType_ORGANIZATION :: EntityType | |
| pattern EntityType_OTHER :: EntityType | |
| pattern EntityType_PERSON :: EntityType | |
| pattern EntityType_QUANTITY :: EntityType | |
| pattern EntityType_TITLE :: EntityType |
Instances
InputFormat
newtype InputFormat Source #
Constructors
| InputFormat' | |
Fields | |
Bundled Patterns
| pattern InputFormat_ONE_DOC_PER_FILE :: InputFormat | |
| pattern InputFormat_ONE_DOC_PER_LINE :: InputFormat |
Instances
JobStatus
Constructors
| JobStatus' | |
Fields | |
Bundled Patterns
| pattern JobStatus_COMPLETED :: JobStatus | |
| pattern JobStatus_FAILED :: JobStatus | |
| pattern JobStatus_IN_PROGRESS :: JobStatus | |
| pattern JobStatus_STOPPED :: JobStatus | |
| pattern JobStatus_STOP_REQUESTED :: JobStatus | |
| pattern JobStatus_SUBMITTED :: JobStatus |
Instances
LanguageCode
newtype LanguageCode Source #
Constructors
| LanguageCode' | |
Fields | |
Bundled Patterns
| pattern LanguageCode_Ar :: LanguageCode | |
| pattern LanguageCode_De :: LanguageCode | |
| pattern LanguageCode_En :: LanguageCode | |
| pattern LanguageCode_Es :: LanguageCode | |
| pattern LanguageCode_Fr :: LanguageCode | |
| pattern LanguageCode_Hi :: LanguageCode | |
| pattern LanguageCode_It :: LanguageCode | |
| pattern LanguageCode_Ja :: LanguageCode | |
| pattern LanguageCode_Ko :: LanguageCode | |
| pattern LanguageCode_Pt :: LanguageCode | |
| pattern LanguageCode_Zh :: LanguageCode | |
| pattern LanguageCode_Zh_TW :: LanguageCode |
Instances
ModelStatus
newtype ModelStatus Source #
Constructors
| ModelStatus' | |
Fields | |
Bundled Patterns
| pattern ModelStatus_DELETING :: ModelStatus | |
| pattern ModelStatus_IN_ERROR :: ModelStatus | |
| pattern ModelStatus_STOPPED :: ModelStatus | |
| pattern ModelStatus_STOP_REQUESTED :: ModelStatus | |
| pattern ModelStatus_SUBMITTED :: ModelStatus | |
| pattern ModelStatus_TRAINED :: ModelStatus | |
| pattern ModelStatus_TRAINING :: ModelStatus |
Instances
PartOfSpeechTagType
newtype PartOfSpeechTagType Source #
Constructors
| PartOfSpeechTagType' | |
Fields | |
Bundled Patterns
Instances
PiiEntitiesDetectionMaskMode
newtype PiiEntitiesDetectionMaskMode Source #
Constructors
| PiiEntitiesDetectionMaskMode' | |
Fields | |
Bundled Patterns
| pattern PiiEntitiesDetectionMaskMode_MASK :: PiiEntitiesDetectionMaskMode | |
| pattern PiiEntitiesDetectionMaskMode_REPLACE_WITH_PII_ENTITY_TYPE :: PiiEntitiesDetectionMaskMode |
Instances
PiiEntitiesDetectionMode
newtype PiiEntitiesDetectionMode Source #
Constructors
| PiiEntitiesDetectionMode' | |
Fields | |
Bundled Patterns
| pattern PiiEntitiesDetectionMode_ONLY_OFFSETS :: PiiEntitiesDetectionMode | |
| pattern PiiEntitiesDetectionMode_ONLY_REDACTION :: PiiEntitiesDetectionMode |
Instances
PiiEntityType
newtype PiiEntityType Source #
Constructors
| PiiEntityType' | |
Fields | |
Bundled Patterns
Instances
SentimentType
newtype SentimentType Source #
Constructors
| SentimentType' | |
Fields | |
Bundled Patterns
| pattern SentimentType_MIXED :: SentimentType | |
| pattern SentimentType_NEGATIVE :: SentimentType | |
| pattern SentimentType_NEUTRAL :: SentimentType | |
| pattern SentimentType_POSITIVE :: SentimentType |
Instances
Split
Bundled Patterns
| pattern Split_TEST :: Split | |
| pattern Split_TRAIN :: Split |
Instances
SyntaxLanguageCode
newtype SyntaxLanguageCode Source #
Constructors
| SyntaxLanguageCode' | |
Fields | |
Bundled Patterns
| pattern SyntaxLanguageCode_De :: SyntaxLanguageCode | |
| pattern SyntaxLanguageCode_En :: SyntaxLanguageCode | |
| pattern SyntaxLanguageCode_Es :: SyntaxLanguageCode | |
| pattern SyntaxLanguageCode_Fr :: SyntaxLanguageCode | |
| pattern SyntaxLanguageCode_It :: SyntaxLanguageCode | |
| pattern SyntaxLanguageCode_Pt :: SyntaxLanguageCode |
Instances
AugmentedManifestsListItem
data AugmentedManifestsListItem Source #
An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
See: newAugmentedManifestsListItem smart constructor.
Constructors
| AugmentedManifestsListItem' | |
Fields
| |
Instances
newAugmentedManifestsListItem Source #
Create a value of AugmentedManifestsListItem 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:sourceDocumentsS3Uri:AugmentedManifestsListItem', augmentedManifestsListItem_sourceDocumentsS3Uri - The S3 prefix to the source files (PDFs) that are referred to in the
augmented manifest file.
$sel:documentType:AugmentedManifestsListItem', augmentedManifestsListItem_documentType - The type of augmented manifest. PlainTextDocument or
SemiStructuredDocument. If you don't specify, the default is
PlainTextDocument.
PLAIN_TEXT_DOCUMENTA document type that represents any unicode text that is encoded in UTF-8.SEMI_STRUCTURED_DOCUMENTA document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.
$sel:split:AugmentedManifestsListItem', augmentedManifestsListItem_split - The purpose of the data you've provided in the augmented manifest. You
can either train or test this data. If you don't specify, the default
is train.
TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
TEST - all of the documents in the manifest will be used for testing.
$sel:annotationDataS3Uri:AugmentedManifestsListItem', augmentedManifestsListItem_annotationDataS3Uri - The S3 prefix to the annotation files that are referred in the augmented
manifest file.
$sel:s3Uri:AugmentedManifestsListItem', augmentedManifestsListItem_s3Uri - The Amazon S3 location of the augmented manifest file.
$sel:attributeNames:AugmentedManifestsListItem', augmentedManifestsListItem_attributeNames - The JSON attribute that contains the annotations for your training
documents. The number of attribute names that you specify depends on
whether your augmented manifest file is the output of a single labeling
job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
augmentedManifestsListItem_sourceDocumentsS3Uri :: Lens' AugmentedManifestsListItem (Maybe Text) Source #
The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
augmentedManifestsListItem_documentType :: Lens' AugmentedManifestsListItem (Maybe AugmentedManifestsDocumentTypeFormat) Source #
The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
PLAIN_TEXT_DOCUMENTA document type that represents any unicode text that is encoded in UTF-8.SEMI_STRUCTURED_DOCUMENTA document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.
augmentedManifestsListItem_split :: Lens' AugmentedManifestsListItem (Maybe Split) Source #
The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
TEST - all of the documents in the manifest will be used for testing.
augmentedManifestsListItem_annotationDataS3Uri :: Lens' AugmentedManifestsListItem (Maybe Text) Source #
The S3 prefix to the annotation files that are referred in the augmented manifest file.
augmentedManifestsListItem_s3Uri :: Lens' AugmentedManifestsListItem Text Source #
The Amazon S3 location of the augmented manifest file.
augmentedManifestsListItem_attributeNames :: Lens' AugmentedManifestsListItem [Text] Source #
The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
BatchDetectDominantLanguageItemResult
data BatchDetectDominantLanguageItemResult Source #
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
See: newBatchDetectDominantLanguageItemResult smart constructor.
Constructors
| BatchDetectDominantLanguageItemResult' | |
Instances
newBatchDetectDominantLanguageItemResult :: BatchDetectDominantLanguageItemResult Source #
Create a value of BatchDetectDominantLanguageItemResult 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:languages:BatchDetectDominantLanguageItemResult', batchDetectDominantLanguageItemResult_languages - One or more DominantLanguage objects describing the dominant languages
in the document.
$sel:index:BatchDetectDominantLanguageItemResult', batchDetectDominantLanguageItemResult_index - The zero-based index of the document in the input list.
batchDetectDominantLanguageItemResult_languages :: Lens' BatchDetectDominantLanguageItemResult (Maybe [DominantLanguage]) Source #
One or more DominantLanguage objects describing the dominant languages in the document.
batchDetectDominantLanguageItemResult_index :: Lens' BatchDetectDominantLanguageItemResult (Maybe Int) Source #
The zero-based index of the document in the input list.
BatchDetectEntitiesItemResult
data BatchDetectEntitiesItemResult Source #
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
See: newBatchDetectEntitiesItemResult smart constructor.
Constructors
| BatchDetectEntitiesItemResult' | |
Instances
newBatchDetectEntitiesItemResult :: BatchDetectEntitiesItemResult Source #
Create a value of BatchDetectEntitiesItemResult 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:entities:BatchDetectEntitiesItemResult', batchDetectEntitiesItemResult_entities - One or more Entity objects, one for each entity detected in the
document.
$sel:index:BatchDetectEntitiesItemResult', batchDetectEntitiesItemResult_index - The zero-based index of the document in the input list.
batchDetectEntitiesItemResult_entities :: Lens' BatchDetectEntitiesItemResult (Maybe [Entity]) Source #
One or more Entity objects, one for each entity detected in the document.
batchDetectEntitiesItemResult_index :: Lens' BatchDetectEntitiesItemResult (Maybe Int) Source #
The zero-based index of the document in the input list.
BatchDetectKeyPhrasesItemResult
data BatchDetectKeyPhrasesItemResult Source #
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
See: newBatchDetectKeyPhrasesItemResult smart constructor.
Constructors
| BatchDetectKeyPhrasesItemResult' | |
Instances
newBatchDetectKeyPhrasesItemResult :: BatchDetectKeyPhrasesItemResult Source #
Create a value of BatchDetectKeyPhrasesItemResult 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:index:BatchDetectKeyPhrasesItemResult', batchDetectKeyPhrasesItemResult_index - The zero-based index of the document in the input list.
$sel:keyPhrases:BatchDetectKeyPhrasesItemResult', batchDetectKeyPhrasesItemResult_keyPhrases - One or more KeyPhrase objects, one for each key phrase detected in the
document.
batchDetectKeyPhrasesItemResult_index :: Lens' BatchDetectKeyPhrasesItemResult (Maybe Int) Source #
The zero-based index of the document in the input list.
batchDetectKeyPhrasesItemResult_keyPhrases :: Lens' BatchDetectKeyPhrasesItemResult (Maybe [KeyPhrase]) Source #
One or more KeyPhrase objects, one for each key phrase detected in the document.
BatchDetectSentimentItemResult
data BatchDetectSentimentItemResult Source #
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
See: newBatchDetectSentimentItemResult smart constructor.
Constructors
| BatchDetectSentimentItemResult' | |
Fields
| |
Instances
newBatchDetectSentimentItemResult :: BatchDetectSentimentItemResult Source #
Create a value of BatchDetectSentimentItemResult 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:sentiment:BatchDetectSentimentItemResult', batchDetectSentimentItemResult_sentiment - The sentiment detected in the document.
$sel:sentimentScore:BatchDetectSentimentItemResult', batchDetectSentimentItemResult_sentimentScore - The level of confidence that Amazon Comprehend has in the accuracy of
its sentiment detection.
$sel:index:BatchDetectSentimentItemResult', batchDetectSentimentItemResult_index - The zero-based index of the document in the input list.
batchDetectSentimentItemResult_sentiment :: Lens' BatchDetectSentimentItemResult (Maybe SentimentType) Source #
The sentiment detected in the document.
batchDetectSentimentItemResult_sentimentScore :: Lens' BatchDetectSentimentItemResult (Maybe SentimentScore) Source #
The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.
batchDetectSentimentItemResult_index :: Lens' BatchDetectSentimentItemResult (Maybe Int) Source #
The zero-based index of the document in the input list.
BatchDetectSyntaxItemResult
data BatchDetectSyntaxItemResult Source #
The result of calling the operation. The operation returns one object that is successfully processed by the operation.
See: newBatchDetectSyntaxItemResult smart constructor.
Constructors
| BatchDetectSyntaxItemResult' | |
Fields
| |
Instances
newBatchDetectSyntaxItemResult :: BatchDetectSyntaxItemResult Source #
Create a value of BatchDetectSyntaxItemResult 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:index:BatchDetectSyntaxItemResult', batchDetectSyntaxItemResult_index - The zero-based index of the document in the input list.
$sel:syntaxTokens:BatchDetectSyntaxItemResult', batchDetectSyntaxItemResult_syntaxTokens - The syntax tokens for the words in the document, one token for each
word.
batchDetectSyntaxItemResult_index :: Lens' BatchDetectSyntaxItemResult (Maybe Int) Source #
The zero-based index of the document in the input list.
batchDetectSyntaxItemResult_syntaxTokens :: Lens' BatchDetectSyntaxItemResult (Maybe [SyntaxToken]) Source #
The syntax tokens for the words in the document, one token for each word.
BatchItemError
data BatchItemError Source #
Describes an error that occurred while processing a document in a batch.
The operation returns on BatchItemError object for each document that
contained an error.
See: newBatchItemError smart constructor.
Constructors
| BatchItemError' | |
Instances
newBatchItemError :: BatchItemError Source #
Create a value of BatchItemError 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:errorCode:BatchItemError', batchItemError_errorCode - The numeric error code of the error.
$sel:errorMessage:BatchItemError', batchItemError_errorMessage - A text description of the error.
$sel:index:BatchItemError', batchItemError_index - The zero-based index of the document in the input list.
batchItemError_errorCode :: Lens' BatchItemError (Maybe Text) Source #
The numeric error code of the error.
batchItemError_errorMessage :: Lens' BatchItemError (Maybe Text) Source #
A text description of the error.
batchItemError_index :: Lens' BatchItemError (Maybe Int) Source #
The zero-based index of the document in the input list.
ClassifierEvaluationMetrics
data ClassifierEvaluationMetrics Source #
Describes the result metrics for the test data associated with an documentation classifier.
See: newClassifierEvaluationMetrics smart constructor.
Constructors
| ClassifierEvaluationMetrics' | |
Fields
| |
Instances
newClassifierEvaluationMetrics :: ClassifierEvaluationMetrics Source #
Create a value of ClassifierEvaluationMetrics 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:microPrecision:ClassifierEvaluationMetrics', classifierEvaluationMetrics_microPrecision - A measure of the usefulness of the recognizer results in the test data.
High precision means that the recognizer returned substantially more
relevant results than irrelevant ones. Unlike the Precision metric which
comes from averaging the precision of all available labels, this is
based on the overall score of all precision scores added together.
$sel:microF1Score:ClassifierEvaluationMetrics', classifierEvaluationMetrics_microF1Score - A measure of how accurate the classifier results are for the test data.
It is a combination of the Micro Precision and Micro Recall values.
The Micro F1Score is the harmonic mean of the two scores. The highest
score is 1, and the worst score is 0.
$sel:recall:ClassifierEvaluationMetrics', classifierEvaluationMetrics_recall - A measure of how complete the classifier results are for the test data.
High recall means that the classifier returned most of the relevant
results.
$sel:precision:ClassifierEvaluationMetrics', classifierEvaluationMetrics_precision - A measure of the usefulness of the classifier results in the test data.
High precision means that the classifier returned substantially more
relevant results than irrelevant ones.
$sel:microRecall:ClassifierEvaluationMetrics', classifierEvaluationMetrics_microRecall - A measure of how complete the classifier results are for the test data.
High recall means that the classifier returned most of the relevant
results. Specifically, this indicates how many of the correct categories
in the text that the model can predict. It is a percentage of correct
categories in the text that can found. Instead of averaging the recall
scores of all labels (as with Recall), micro Recall is based on the
overall score of all recall scores added together.
$sel:f1Score:ClassifierEvaluationMetrics', classifierEvaluationMetrics_f1Score - A measure of how accurate the classifier results are for the test data.
It is derived from the Precision and Recall values. The F1Score is
the harmonic average of the two scores. The highest score is 1, and the
worst score is 0.
$sel:hammingLoss:ClassifierEvaluationMetrics', classifierEvaluationMetrics_hammingLoss - Indicates the fraction of labels that are incorrectly predicted. Also
seen as the fraction of wrong labels compared to the total number of
labels. Scores closer to zero are better.
$sel:accuracy:ClassifierEvaluationMetrics', classifierEvaluationMetrics_accuracy - The fraction of the labels that were correct recognized. It is computed
by dividing the number of labels in the test documents that were
correctly recognized by the total number of labels in the test
documents.
classifierEvaluationMetrics_microPrecision :: Lens' ClassifierEvaluationMetrics (Maybe Double) Source #
A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together.
classifierEvaluationMetrics_microF1Score :: Lens' ClassifierEvaluationMetrics (Maybe Double) Source #
A measure of how accurate the classifier results are for the test data.
It is a combination of the Micro Precision and Micro Recall values.
The Micro F1Score is the harmonic mean of the two scores. The highest
score is 1, and the worst score is 0.
classifierEvaluationMetrics_recall :: Lens' ClassifierEvaluationMetrics (Maybe Double) Source #
A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results.
classifierEvaluationMetrics_precision :: Lens' ClassifierEvaluationMetrics (Maybe Double) Source #
A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.
classifierEvaluationMetrics_microRecall :: Lens' ClassifierEvaluationMetrics (Maybe Double) Source #
A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.
classifierEvaluationMetrics_f1Score :: Lens' ClassifierEvaluationMetrics (Maybe Double) Source #
A measure of how accurate the classifier results are for the test data.
It is derived from the Precision and Recall values. The F1Score is
the harmonic average of the two scores. The highest score is 1, and the
worst score is 0.
classifierEvaluationMetrics_hammingLoss :: Lens' ClassifierEvaluationMetrics (Maybe Double) Source #
Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.
classifierEvaluationMetrics_accuracy :: Lens' ClassifierEvaluationMetrics (Maybe Double) Source #
The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.
ClassifierMetadata
data ClassifierMetadata Source #
Provides information about a document classifier.
See: newClassifierMetadata smart constructor.
Constructors
| ClassifierMetadata' | |
Fields
| |
Instances
newClassifierMetadata :: ClassifierMetadata Source #
Create a value of ClassifierMetadata 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:numberOfLabels:ClassifierMetadata', classifierMetadata_numberOfLabels - The number of labels in the input data.
$sel:evaluationMetrics:ClassifierMetadata', classifierMetadata_evaluationMetrics - Describes the result metrics for the test data associated with an
documentation classifier.
$sel:numberOfTrainedDocuments:ClassifierMetadata', classifierMetadata_numberOfTrainedDocuments - The number of documents in the input data that were used to train the
classifier. Typically this is 80 to 90 percent of the input documents.
$sel:numberOfTestDocuments:ClassifierMetadata', classifierMetadata_numberOfTestDocuments - The number of documents in the input data that were used to test the
classifier. Typically this is 10 to 20 percent of the input documents,
up to 10,000 documents.
classifierMetadata_numberOfLabels :: Lens' ClassifierMetadata (Maybe Int) Source #
The number of labels in the input data.
classifierMetadata_evaluationMetrics :: Lens' ClassifierMetadata (Maybe ClassifierEvaluationMetrics) Source #
Describes the result metrics for the test data associated with an documentation classifier.
classifierMetadata_numberOfTrainedDocuments :: Lens' ClassifierMetadata (Maybe Int) Source #
The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents.
classifierMetadata_numberOfTestDocuments :: Lens' ClassifierMetadata (Maybe Int) Source #
The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents, up to 10,000 documents.
DocumentClass
data DocumentClass Source #
Specifies the class that categorizes the document being analyzed
See: newDocumentClass smart constructor.
Constructors
| DocumentClass' | |
Instances
newDocumentClass :: DocumentClass Source #
Create a value of DocumentClass 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:score:DocumentClass', documentClass_score - The confidence score that Amazon Comprehend has this class correctly
attributed.
$sel:name:DocumentClass', documentClass_name - The name of the class.
documentClass_score :: Lens' DocumentClass (Maybe Double) Source #
The confidence score that Amazon Comprehend has this class correctly attributed.
documentClass_name :: Lens' DocumentClass (Maybe Text) Source #
The name of the class.
DocumentClassificationJobFilter
data DocumentClassificationJobFilter Source #
Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.
See: newDocumentClassificationJobFilter smart constructor.
Constructors
| DocumentClassificationJobFilter' | |
Fields
| |
Instances
newDocumentClassificationJobFilter :: DocumentClassificationJobFilter Source #
Create a value of DocumentClassificationJobFilter 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:submitTimeAfter:DocumentClassificationJobFilter', documentClassificationJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted after the specified time.
Jobs are returned in descending order, newest to oldest.
$sel:submitTimeBefore:DocumentClassificationJobFilter', documentClassificationJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted before the specified time.
Jobs are returned in ascending order, oldest to newest.
$sel:jobName:DocumentClassificationJobFilter', documentClassificationJobFilter_jobName - Filters on the name of the job.
$sel:jobStatus:DocumentClassificationJobFilter', documentClassificationJobFilter_jobStatus - Filters the list based on job status. Returns only jobs with the
specified status.
documentClassificationJobFilter_submitTimeAfter :: Lens' DocumentClassificationJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
documentClassificationJobFilter_submitTimeBefore :: Lens' DocumentClassificationJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
documentClassificationJobFilter_jobName :: Lens' DocumentClassificationJobFilter (Maybe Text) Source #
Filters on the name of the job.
documentClassificationJobFilter_jobStatus :: Lens' DocumentClassificationJobFilter (Maybe JobStatus) Source #
Filters the list based on job status. Returns only jobs with the specified status.
DocumentClassificationJobProperties
data DocumentClassificationJobProperties Source #
Provides information about a document classification job.
See: newDocumentClassificationJobProperties smart constructor.
Constructors
| DocumentClassificationJobProperties' | |
Fields
| |
Instances
newDocumentClassificationJobProperties :: DocumentClassificationJobProperties Source #
Create a value of DocumentClassificationJobProperties 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:jobId:DocumentClassificationJobProperties', documentClassificationJobProperties_jobId - The identifier assigned to the document classification job.
$sel:jobArn:DocumentClassificationJobProperties', documentClassificationJobProperties_jobArn - The Amazon Resource Name (ARN) of the document classification job. It is
a unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
$sel:documentClassifierArn:DocumentClassificationJobProperties', documentClassificationJobProperties_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.
$sel:jobName:DocumentClassificationJobProperties', documentClassificationJobProperties_jobName - The name that you assigned to the document classification job.
$sel:inputDataConfig:DocumentClassificationJobProperties', documentClassificationJobProperties_inputDataConfig - The input data configuration that you supplied when you created the
document classification job.
$sel:vpcConfig:DocumentClassificationJobProperties', documentClassificationJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your document classification
job. For more information, see
Amazon VPC.
$sel:volumeKmsKeyId:DocumentClassificationJobProperties', documentClassificationJobProperties_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:DocumentClassificationJobProperties', documentClassificationJobProperties_endTime - The time that the document classification job completed.
$sel:outputDataConfig:DocumentClassificationJobProperties', documentClassificationJobProperties_outputDataConfig - The output data configuration that you supplied when you created the
document classification job.
$sel:dataAccessRoleArn:DocumentClassificationJobProperties', documentClassificationJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS identity and Access Management
(IAM) role that grants Amazon Comprehend read access to your input data.
$sel:jobStatus:DocumentClassificationJobProperties', documentClassificationJobProperties_jobStatus - The current status of the document classification job. If the status is
FAILED, the Message field shows the reason for the failure.
$sel:message:DocumentClassificationJobProperties', documentClassificationJobProperties_message - A description of the status of the job.
$sel:submitTime:DocumentClassificationJobProperties', documentClassificationJobProperties_submitTime - The time that the document classification job was submitted for
processing.
documentClassificationJobProperties_jobId :: Lens' DocumentClassificationJobProperties (Maybe Text) Source #
The identifier assigned to the document classification job.
documentClassificationJobProperties_jobArn :: Lens' DocumentClassificationJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
documentClassificationJobProperties_documentClassifierArn :: Lens' DocumentClassificationJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the document classifier.
documentClassificationJobProperties_jobName :: Lens' DocumentClassificationJobProperties (Maybe Text) Source #
The name that you assigned to the document classification job.
documentClassificationJobProperties_inputDataConfig :: Lens' DocumentClassificationJobProperties (Maybe InputDataConfig) Source #
The input data configuration that you supplied when you created the document classification job.
documentClassificationJobProperties_vpcConfig :: Lens' DocumentClassificationJobProperties (Maybe VpcConfig) Source #
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
documentClassificationJobProperties_volumeKmsKeyId :: Lens' DocumentClassificationJobProperties (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"
documentClassificationJobProperties_endTime :: Lens' DocumentClassificationJobProperties (Maybe UTCTime) Source #
The time that the document classification job completed.
documentClassificationJobProperties_outputDataConfig :: Lens' DocumentClassificationJobProperties (Maybe OutputDataConfig) Source #
The output data configuration that you supplied when you created the document classification job.
documentClassificationJobProperties_dataAccessRoleArn :: Lens' DocumentClassificationJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
documentClassificationJobProperties_jobStatus :: Lens' DocumentClassificationJobProperties (Maybe JobStatus) Source #
The current status of the document classification job. If the status is
FAILED, the Message field shows the reason for the failure.
documentClassificationJobProperties_message :: Lens' DocumentClassificationJobProperties (Maybe Text) Source #
A description of the status of the job.
documentClassificationJobProperties_submitTime :: Lens' DocumentClassificationJobProperties (Maybe UTCTime) Source #
The time that the document classification job was submitted for processing.
DocumentClassifierFilter
data DocumentClassifierFilter Source #
Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the operation.
See: newDocumentClassifierFilter smart constructor.
Constructors
| DocumentClassifierFilter' | |
Fields
| |
Instances
newDocumentClassifierFilter :: DocumentClassifierFilter Source #
Create a value of DocumentClassifierFilter 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:DocumentClassifierFilter', documentClassifierFilter_status - Filters the list of classifiers based on status.
$sel:submitTimeAfter:DocumentClassifierFilter', documentClassifierFilter_submitTimeAfter - Filters the list of classifiers based on the time that the classifier
was submitted for processing. Returns only classifiers submitted after
the specified time. Classifiers are returned in descending order, newest
to oldest.
$sel:submitTimeBefore:DocumentClassifierFilter', documentClassifierFilter_submitTimeBefore - Filters the list of classifiers based on the time that the classifier
was submitted for processing. Returns only classifiers submitted before
the specified time. Classifiers are returned in ascending order, oldest
to newest.
$sel:documentClassifierName:DocumentClassifierFilter', documentClassifierFilter_documentClassifierName - The name that you assigned to the document classifier
documentClassifierFilter_status :: Lens' DocumentClassifierFilter (Maybe ModelStatus) Source #
Filters the list of classifiers based on status.
documentClassifierFilter_submitTimeAfter :: Lens' DocumentClassifierFilter (Maybe UTCTime) Source #
Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted after the specified time. Classifiers are returned in descending order, newest to oldest.
documentClassifierFilter_submitTimeBefore :: Lens' DocumentClassifierFilter (Maybe UTCTime) Source #
Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted before the specified time. Classifiers are returned in ascending order, oldest to newest.
documentClassifierFilter_documentClassifierName :: Lens' DocumentClassifierFilter (Maybe Text) Source #
The name that you assigned to the document classifier
DocumentClassifierInputDataConfig
data DocumentClassifierInputDataConfig Source #
The input properties for training a document classifier.
For more information on how the input file is formatted, see how-document-classification-training-data.
See: newDocumentClassifierInputDataConfig smart constructor.
Constructors
| DocumentClassifierInputDataConfig' | |
Fields
| |
Instances
newDocumentClassifierInputDataConfig :: DocumentClassifierInputDataConfig Source #
Create a value of DocumentClassifierInputDataConfig 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:augmentedManifests:DocumentClassifierInputDataConfig', documentClassifierInputDataConfig_augmentedManifests - A list of augmented manifest files that provide training data for your
custom model. An augmented manifest file is a labeled dataset that is
produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat to
AUGMENTED_MANIFEST.
$sel:dataFormat:DocumentClassifierInputDataConfig', documentClassifierInputDataConfig_dataFormat - The format of your training data:
COMPREHEND_CSV: A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide theS3Uriparameter in your request.AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels.If you use this value, you must provide the
AugmentedManifestsparameter in your request.
If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV
as the default.
$sel:labelDelimiter:DocumentClassifierInputDataConfig', documentClassifierInputDataConfig_labelDelimiter - Indicates the delimiter used to separate each label for training a
multi-label classifier. The default delimiter between labels is a pipe
(|). You can use a different character as a delimiter (if it's an
allowed character) by specifying it under Delimiter for labels. If the
training documents use a delimiter other than the default or the
delimiter you specify, the labels on that line will be combined to make
a single unique label, such as LABELLABELLABEL.
$sel:testS3Uri:DocumentClassifierInputDataConfig', documentClassifierInputDataConfig_testS3Uri - The Amazon S3 URI for the input data. The Amazon S3 bucket must be in
the same AWS Region as the API endpoint that you are calling. The URI
can point to a single input file or it can provide the prefix for a
collection of input files.
$sel:s3Uri:DocumentClassifierInputDataConfig', documentClassifierInputDataConfig_s3Uri - The Amazon S3 URI for the input data. The S3 bucket must be in the same
region as the API endpoint that you are calling. The URI can point to a
single input file or it can provide the prefix for a collection of input
files.
For example, if you use the URI S3://bucketName/prefix, if the
prefix is a single file, Amazon Comprehend uses that file as input. If
more than one file begins with the prefix, Amazon Comprehend uses all of
them as input.
This parameter is required if you set DataFormat to COMPREHEND_CSV.
documentClassifierInputDataConfig_augmentedManifests :: Lens' DocumentClassifierInputDataConfig (Maybe [AugmentedManifestsListItem]) Source #
A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat to
AUGMENTED_MANIFEST.
documentClassifierInputDataConfig_dataFormat :: Lens' DocumentClassifierInputDataConfig (Maybe DocumentClassifierDataFormat) Source #
The format of your training data:
COMPREHEND_CSV: A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide theS3Uriparameter in your request.AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels.If you use this value, you must provide the
AugmentedManifestsparameter in your request.
If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV
as the default.
documentClassifierInputDataConfig_labelDelimiter :: Lens' DocumentClassifierInputDataConfig (Maybe Text) Source #
Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.
documentClassifierInputDataConfig_testS3Uri :: Lens' DocumentClassifierInputDataConfig (Maybe Text) Source #
The Amazon S3 URI for the input data. The Amazon S3 bucket must be in the same AWS Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.
documentClassifierInputDataConfig_s3Uri :: Lens' DocumentClassifierInputDataConfig (Maybe Text) Source #
The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.
For example, if you use the URI S3://bucketName/prefix, if the
prefix is a single file, Amazon Comprehend uses that file as input. If
more than one file begins with the prefix, Amazon Comprehend uses all of
them as input.
This parameter is required if you set DataFormat to COMPREHEND_CSV.
DocumentClassifierOutputDataConfig
data DocumentClassifierOutputDataConfig Source #
Provides output results configuration parameters for custom classifier jobs.
See: newDocumentClassifierOutputDataConfig smart constructor.
Constructors
| DocumentClassifierOutputDataConfig' | |
Fields
| |
Instances
newDocumentClassifierOutputDataConfig :: DocumentClassifierOutputDataConfig Source #
Create a value of DocumentClassifierOutputDataConfig 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:kmsKeyId:DocumentClassifierOutputDataConfig', documentClassifierOutputDataConfig_kmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt the output results from an analysis job. The KmsKeyId
can be one 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" - KMS Key Alias:
"alias/ExampleAlias" - ARN of a KMS Key Alias:
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
$sel:s3Uri:DocumentClassifierOutputDataConfig', documentClassifierOutputDataConfig_s3Uri - When you use the OutputDataConfig object while creating a custom
classifier, you specify the Amazon S3 location where you want to write
the confusion matrix. The URI must be in the same region as the API
endpoint that you are calling. The location is used as the prefix for
the actual location of this output file.
When the custom classifier job is finished, the service creates the
output file in a directory specific to the job. The S3Uri field
contains the location of the output file, called output.tar.gz. It is
a compressed archive that contains the confusion matrix.
documentClassifierOutputDataConfig_kmsKeyId :: Lens' DocumentClassifierOutputDataConfig (Maybe Text) Source #
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one 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" - KMS Key Alias:
"alias/ExampleAlias" - ARN of a KMS Key Alias:
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
documentClassifierOutputDataConfig_s3Uri :: Lens' DocumentClassifierOutputDataConfig (Maybe Text) Source #
When you use the OutputDataConfig object while creating a custom
classifier, you specify the Amazon S3 location where you want to write
the confusion matrix. The URI must be in the same region as the API
endpoint that you are calling. The location is used as the prefix for
the actual location of this output file.
When the custom classifier job is finished, the service creates the
output file in a directory specific to the job. The S3Uri field
contains the location of the output file, called output.tar.gz. It is
a compressed archive that contains the confusion matrix.
DocumentClassifierProperties
data DocumentClassifierProperties Source #
Provides information about a document classifier.
See: newDocumentClassifierProperties smart constructor.
Constructors
| DocumentClassifierProperties' | |
Fields
| |
Instances
newDocumentClassifierProperties :: DocumentClassifierProperties Source #
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: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:languageCode:DocumentClassifierProperties', documentClassifierProperties_languageCode - The language code for the language of the documents that the classifier
was trained on.
$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: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:documentClassifierArn:DocumentClassifierProperties', documentClassifierProperties_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.
$sel:versionName:DocumentClassifierProperties', documentClassifierProperties_versionName - The version name that you assigned to the document classifier.
$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: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:inputDataConfig:DocumentClassifierProperties', documentClassifierProperties_inputDataConfig - The input data configuration that you supplied when you created the
document classifier for training.
$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.
$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:endTime:DocumentClassifierProperties', documentClassifierProperties_endTime - The time that training the document classifier completed.
$sel:outputDataConfig:DocumentClassifierProperties', documentClassifierProperties_outputDataConfig - Provides output results configuration parameters for custom classifier
jobs.
$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: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:message:DocumentClassifierProperties', documentClassifierProperties_message - Additional information about the status of the classifier.
$sel:submitTime:DocumentClassifierProperties', documentClassifierProperties_submitTime - The time that the document classifier was submitted for training.
documentClassifierProperties_status :: Lens' DocumentClassifierProperties (Maybe ModelStatus) Source #
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_languageCode :: Lens' DocumentClassifierProperties (Maybe LanguageCode) Source #
The language code for the language of the documents that the classifier was trained on.
documentClassifierProperties_classifierMetadata :: Lens' DocumentClassifierProperties (Maybe ClassifierMetadata) Source #
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_trainingEndTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) Source #
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_documentClassifierArn :: Lens' DocumentClassifierProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the document classifier.
documentClassifierProperties_versionName :: Lens' DocumentClassifierProperties (Maybe Text) Source #
The version name that you assigned to the document classifier.
documentClassifierProperties_modelKmsKeyId :: Lens' DocumentClassifierProperties (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"
documentClassifierProperties_mode :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierMode) Source #
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_inputDataConfig :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierInputDataConfig) Source #
The input data configuration that you supplied when you created the document classifier for training.
documentClassifierProperties_vpcConfig :: Lens' DocumentClassifierProperties (Maybe VpcConfig) Source #
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_volumeKmsKeyId :: Lens' DocumentClassifierProperties (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"
documentClassifierProperties_endTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) Source #
The time that training the document classifier completed.
documentClassifierProperties_outputDataConfig :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierOutputDataConfig) Source #
Provides output results configuration parameters for custom classifier jobs.
documentClassifierProperties_trainingStartTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) Source #
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_dataAccessRoleArn :: Lens' DocumentClassifierProperties (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.
documentClassifierProperties_message :: Lens' DocumentClassifierProperties (Maybe Text) Source #
Additional information about the status of the classifier.
documentClassifierProperties_submitTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) Source #
The time that the document classifier was submitted for training.
DocumentClassifierSummary
data DocumentClassifierSummary Source #
Describes information about a document classifier and its versions.
See: newDocumentClassifierSummary smart constructor.
Constructors
| DocumentClassifierSummary' | |
Fields
| |
Instances
newDocumentClassifierSummary :: DocumentClassifierSummary Source #
Create a value of DocumentClassifierSummary 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:latestVersionCreatedAt:DocumentClassifierSummary', documentClassifierSummary_latestVersionCreatedAt - The time that the latest document classifier version was submitted for
processing.
$sel:documentClassifierName:DocumentClassifierSummary', documentClassifierSummary_documentClassifierName - The name that you assigned the document classifier.
$sel:latestVersionStatus:DocumentClassifierSummary', documentClassifierSummary_latestVersionStatus - Provides the status of the latest document classifier version.
$sel:numberOfVersions:DocumentClassifierSummary', documentClassifierSummary_numberOfVersions - The number of versions you created.
$sel:latestVersionName:DocumentClassifierSummary', documentClassifierSummary_latestVersionName - The version name you assigned to the latest document classifier version.
documentClassifierSummary_latestVersionCreatedAt :: Lens' DocumentClassifierSummary (Maybe UTCTime) Source #
The time that the latest document classifier version was submitted for processing.
documentClassifierSummary_documentClassifierName :: Lens' DocumentClassifierSummary (Maybe Text) Source #
The name that you assigned the document classifier.
documentClassifierSummary_latestVersionStatus :: Lens' DocumentClassifierSummary (Maybe ModelStatus) Source #
Provides the status of the latest document classifier version.
documentClassifierSummary_numberOfVersions :: Lens' DocumentClassifierSummary (Maybe Int) Source #
The number of versions you created.
documentClassifierSummary_latestVersionName :: Lens' DocumentClassifierSummary (Maybe Text) Source #
The version name you assigned to the latest document classifier version.
DocumentLabel
data DocumentLabel Source #
Specifies one of the label or labels that categorize the document being analyzed.
See: newDocumentLabel smart constructor.
Constructors
| DocumentLabel' | |
Instances
newDocumentLabel :: DocumentLabel Source #
Create a value of DocumentLabel 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:score:DocumentLabel', documentLabel_score - The confidence score that Amazon Comprehend has this label correctly
attributed.
$sel:name:DocumentLabel', documentLabel_name - The name of the label.
documentLabel_score :: Lens' DocumentLabel (Maybe Double) Source #
The confidence score that Amazon Comprehend has this label correctly attributed.
documentLabel_name :: Lens' DocumentLabel (Maybe Text) Source #
The name of the label.
DocumentReaderConfig
data DocumentReaderConfig Source #
The input properties for a topic detection job.
See: newDocumentReaderConfig smart constructor.
Constructors
| DocumentReaderConfig' | |
Fields
| |
Instances
newDocumentReaderConfig Source #
Create a value of DocumentReaderConfig 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:featureTypes:DocumentReaderConfig', documentReaderConfig_featureTypes - Specifies how the text in an input file should be processed:
$sel:documentReadMode:DocumentReaderConfig', documentReaderConfig_documentReadMode - This enum field provides two values:
SERVICE_DEFAULT- use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIsFORCE_DOCUMENT_READ_ACTION- Always use specified action for DocumentReadAction, including Digital PDF.
$sel:documentReadAction:DocumentReaderConfig', documentReaderConfig_documentReadAction - This enum field will start with two values which will apply to PDFs:
TEXTRACT_DETECT_DOCUMENT_TEXT- The service calls DetectDocumentText for PDF documents per page.TEXTRACT_ANALYZE_DOCUMENT- The service calls AnalyzeDocument for PDF documents per page.
documentReaderConfig_featureTypes :: Lens' DocumentReaderConfig (Maybe (NonEmpty DocumentReadFeatureTypes)) Source #
Specifies how the text in an input file should be processed:
documentReaderConfig_documentReadMode :: Lens' DocumentReaderConfig (Maybe DocumentReadMode) Source #
This enum field provides two values:
SERVICE_DEFAULT- use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIsFORCE_DOCUMENT_READ_ACTION- Always use specified action for DocumentReadAction, including Digital PDF.
documentReaderConfig_documentReadAction :: Lens' DocumentReaderConfig DocumentReadAction Source #
This enum field will start with two values which will apply to PDFs:
TEXTRACT_DETECT_DOCUMENT_TEXT- The service calls DetectDocumentText for PDF documents per page.TEXTRACT_ANALYZE_DOCUMENT- The service calls AnalyzeDocument for PDF documents per page.
DominantLanguage
data DominantLanguage Source #
Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.
See: newDominantLanguage smart constructor.
Constructors
| DominantLanguage' | |
Fields
| |
Instances
newDominantLanguage :: DominantLanguage Source #
Create a value of DominantLanguage 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:languageCode:DominantLanguage', dominantLanguage_languageCode - The RFC 5646 language code for the dominant language. For more
information about RFC 5646, see
Tags for Identifying Languages on
the IETF Tools web site.
$sel:score:DominantLanguage', dominantLanguage_score - The level of confidence that Amazon Comprehend has in the accuracy of
the detection.
dominantLanguage_languageCode :: Lens' DominantLanguage (Maybe Text) Source #
The RFC 5646 language code for the dominant language. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.
dominantLanguage_score :: Lens' DominantLanguage (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
DominantLanguageDetectionJobFilter
data DominantLanguageDetectionJobFilter Source #
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
See: newDominantLanguageDetectionJobFilter smart constructor.
Constructors
| DominantLanguageDetectionJobFilter' | |
Fields
| |
Instances
newDominantLanguageDetectionJobFilter :: DominantLanguageDetectionJobFilter Source #
Create a value of DominantLanguageDetectionJobFilter 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:submitTimeAfter:DominantLanguageDetectionJobFilter', dominantLanguageDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted after the specified time.
Jobs are returned in descending order, newest to oldest.
$sel:submitTimeBefore:DominantLanguageDetectionJobFilter', dominantLanguageDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted before the specified time.
Jobs are returned in ascending order, oldest to newest.
$sel:jobName:DominantLanguageDetectionJobFilter', dominantLanguageDetectionJobFilter_jobName - Filters on the name of the job.
$sel:jobStatus:DominantLanguageDetectionJobFilter', dominantLanguageDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the
specified status.
dominantLanguageDetectionJobFilter_submitTimeAfter :: Lens' DominantLanguageDetectionJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
dominantLanguageDetectionJobFilter_submitTimeBefore :: Lens' DominantLanguageDetectionJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
dominantLanguageDetectionJobFilter_jobName :: Lens' DominantLanguageDetectionJobFilter (Maybe Text) Source #
Filters on the name of the job.
dominantLanguageDetectionJobFilter_jobStatus :: Lens' DominantLanguageDetectionJobFilter (Maybe JobStatus) Source #
Filters the list of jobs based on job status. Returns only jobs with the specified status.
DominantLanguageDetectionJobProperties
data DominantLanguageDetectionJobProperties Source #
Provides information about a dominant language detection job.
See: newDominantLanguageDetectionJobProperties smart constructor.
Constructors
| DominantLanguageDetectionJobProperties' | |
Fields
| |
Instances
newDominantLanguageDetectionJobProperties :: DominantLanguageDetectionJobProperties Source #
Create a value of DominantLanguageDetectionJobProperties 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:jobId:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_jobId - The identifier assigned to the dominant language detection job.
$sel:jobArn:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the dominant language detection job.
It is a unique, fully qualified identifier for the job. It includes the
AWS account, Region, and the job ID. The format of the ARN is as
follows:
arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobName:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_jobName - The name that you assigned to the dominant language detection job.
$sel:inputDataConfig:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the
dominant language detection job.
$sel:vpcConfig:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your dominant language
detection job. For more information, see
Amazon VPC.
$sel:volumeKmsKeyId:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_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:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_endTime - The time that the dominant language detection job completed.
$sel:outputDataConfig:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the
dominant language detection job.
$sel:dataAccessRoleArn:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access
to your input data.
$sel:jobStatus:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_jobStatus - The current status of the dominant language detection job. If the status
is FAILED, the Message field shows the reason for the failure.
$sel:message:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_message - A description for the status of a job.
$sel:submitTime:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_submitTime - The time that the dominant language detection job was submitted for
processing.
dominantLanguageDetectionJobProperties_jobId :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the dominant language detection job.
dominantLanguageDetectionJobProperties_jobArn :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
dominantLanguageDetectionJobProperties_jobName :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) Source #
The name that you assigned to the dominant language detection job.
dominantLanguageDetectionJobProperties_inputDataConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe InputDataConfig) Source #
The input data configuration that you supplied when you created the dominant language detection job.
dominantLanguageDetectionJobProperties_vpcConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe VpcConfig) Source #
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.
dominantLanguageDetectionJobProperties_volumeKmsKeyId :: Lens' DominantLanguageDetectionJobProperties (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"
dominantLanguageDetectionJobProperties_endTime :: Lens' DominantLanguageDetectionJobProperties (Maybe UTCTime) Source #
The time that the dominant language detection job completed.
dominantLanguageDetectionJobProperties_outputDataConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe OutputDataConfig) Source #
The output data configuration that you supplied when you created the dominant language detection job.
dominantLanguageDetectionJobProperties_dataAccessRoleArn :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
dominantLanguageDetectionJobProperties_jobStatus :: Lens' DominantLanguageDetectionJobProperties (Maybe JobStatus) Source #
The current status of the dominant language detection job. If the status
is FAILED, the Message field shows the reason for the failure.
dominantLanguageDetectionJobProperties_message :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) Source #
A description for the status of a job.
dominantLanguageDetectionJobProperties_submitTime :: Lens' DominantLanguageDetectionJobProperties (Maybe UTCTime) Source #
The time that the dominant language detection job was submitted for processing.
EndpointFilter
data EndpointFilter Source #
The filter used to determine which endpoints are returned. You can filter jobs on their name, model, status, or the date and time that they were created. You can only set one filter at a time.
See: newEndpointFilter smart constructor.
Constructors
| EndpointFilter' | |
Fields
| |
Instances
newEndpointFilter :: EndpointFilter Source #
Create a value of EndpointFilter 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:EndpointFilter', endpointFilter_status - Specifies the status of the endpoint being returned. Possible values
are: Creating, Ready, Updating, Deleting, Failed.
$sel:modelArn:EndpointFilter', endpointFilter_modelArn - The Amazon Resource Number (ARN) of the model to which the endpoint is
attached.
$sel:creationTimeAfter:EndpointFilter', endpointFilter_creationTimeAfter - Specifies a date after which the returned endpoint or endpoints were
created.
$sel:creationTimeBefore:EndpointFilter', endpointFilter_creationTimeBefore - Specifies a date before which the returned endpoint or endpoints were
created.
endpointFilter_status :: Lens' EndpointFilter (Maybe EndpointStatus) Source #
Specifies the status of the endpoint being returned. Possible values are: Creating, Ready, Updating, Deleting, Failed.
endpointFilter_modelArn :: Lens' EndpointFilter (Maybe Text) Source #
The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
endpointFilter_creationTimeAfter :: Lens' EndpointFilter (Maybe UTCTime) Source #
Specifies a date after which the returned endpoint or endpoints were created.
endpointFilter_creationTimeBefore :: Lens' EndpointFilter (Maybe UTCTime) Source #
Specifies a date before which the returned endpoint or endpoints were created.
EndpointProperties
data EndpointProperties Source #
Specifies information about the specified endpoint.
See: newEndpointProperties smart constructor.
Constructors
| EndpointProperties' | |
Fields
| |
Instances
newEndpointProperties :: EndpointProperties Source #
Create a value of EndpointProperties 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:creationTime:EndpointProperties', endpointProperties_creationTime - The creation date and time of the endpoint.
$sel:status:EndpointProperties', endpointProperties_status - Specifies the status of the endpoint. Because the endpoint updates and
creation are asynchronous, so customers will need to wait for the
endpoint to be Ready status before making inference requests.
$sel:modelArn:EndpointProperties', endpointProperties_modelArn - The Amazon Resource Number (ARN) of the model to which the endpoint is
attached.
$sel:desiredModelArn:EndpointProperties', endpointProperties_desiredModelArn - ARN of the new model to use for updating an existing endpoint. This ARN
is going to be different from the model ARN when the update is in
progress
$sel:lastModifiedTime:EndpointProperties', endpointProperties_lastModifiedTime - The date and time that the endpoint was last modified.
$sel:desiredInferenceUnits:EndpointProperties', endpointProperties_desiredInferenceUnits - The desired number of inference units to be used by the model using this
endpoint. Each inference unit represents of a throughput of 100
characters per second.
$sel:currentInferenceUnits:EndpointProperties', endpointProperties_currentInferenceUnits - The number of inference units currently used by the model using this
endpoint.
$sel:dataAccessRoleArn:EndpointProperties', endpointProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS identity and Access Management
(IAM) role that grants Amazon Comprehend read access to trained custom
models encrypted with a customer managed key (ModelKmsKeyId).
$sel:desiredDataAccessRoleArn:EndpointProperties', endpointProperties_desiredDataAccessRoleArn - Data access role ARN to use in case the new model is encrypted with a
customer KMS key.
$sel:message:EndpointProperties', endpointProperties_message - Specifies a reason for failure in cases of Failed status.
$sel:endpointArn:EndpointProperties', endpointProperties_endpointArn - The Amazon Resource Number (ARN) of the endpoint.
endpointProperties_creationTime :: Lens' EndpointProperties (Maybe UTCTime) Source #
The creation date and time of the endpoint.
endpointProperties_status :: Lens' EndpointProperties (Maybe EndpointStatus) Source #
Specifies the status of the endpoint. Because the endpoint updates and
creation are asynchronous, so customers will need to wait for the
endpoint to be Ready status before making inference requests.
endpointProperties_modelArn :: Lens' EndpointProperties (Maybe Text) Source #
The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
endpointProperties_desiredModelArn :: Lens' EndpointProperties (Maybe Text) Source #
ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress
endpointProperties_lastModifiedTime :: Lens' EndpointProperties (Maybe UTCTime) Source #
The date and time that the endpoint was last modified.
endpointProperties_desiredInferenceUnits :: Lens' EndpointProperties (Maybe Natural) Source #
The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
endpointProperties_currentInferenceUnits :: Lens' EndpointProperties (Maybe Natural) Source #
The number of inference units currently used by the model using this endpoint.
endpointProperties_dataAccessRoleArn :: Lens' EndpointProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
endpointProperties_desiredDataAccessRoleArn :: Lens' EndpointProperties (Maybe Text) Source #
Data access role ARN to use in case the new model is encrypted with a customer KMS key.
endpointProperties_message :: Lens' EndpointProperties (Maybe Text) Source #
Specifies a reason for failure in cases of Failed status.
endpointProperties_endpointArn :: Lens' EndpointProperties (Maybe Text) Source #
The Amazon Resource Number (ARN) of the endpoint.
EntitiesDetectionJobFilter
data EntitiesDetectionJobFilter Source #
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
See: newEntitiesDetectionJobFilter smart constructor.
Constructors
| EntitiesDetectionJobFilter' | |
Fields
| |
Instances
newEntitiesDetectionJobFilter :: EntitiesDetectionJobFilter Source #
Create a value of EntitiesDetectionJobFilter 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:submitTimeAfter:EntitiesDetectionJobFilter', entitiesDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted after the specified time.
Jobs are returned in descending order, newest to oldest.
$sel:submitTimeBefore:EntitiesDetectionJobFilter', entitiesDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted before the specified time.
Jobs are returned in ascending order, oldest to newest.
$sel:jobName:EntitiesDetectionJobFilter', entitiesDetectionJobFilter_jobName - Filters on the name of the job.
$sel:jobStatus:EntitiesDetectionJobFilter', entitiesDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the
specified status.
entitiesDetectionJobFilter_submitTimeAfter :: Lens' EntitiesDetectionJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
entitiesDetectionJobFilter_submitTimeBefore :: Lens' EntitiesDetectionJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
entitiesDetectionJobFilter_jobName :: Lens' EntitiesDetectionJobFilter (Maybe Text) Source #
Filters on the name of the job.
entitiesDetectionJobFilter_jobStatus :: Lens' EntitiesDetectionJobFilter (Maybe JobStatus) Source #
Filters the list of jobs based on job status. Returns only jobs with the specified status.
EntitiesDetectionJobProperties
data EntitiesDetectionJobProperties Source #
Provides information about an entities detection job.
See: newEntitiesDetectionJobProperties smart constructor.
Constructors
| EntitiesDetectionJobProperties' | |
Fields
| |
Instances
newEntitiesDetectionJobProperties :: EntitiesDetectionJobProperties Source #
Create a value of EntitiesDetectionJobProperties 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:languageCode:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_languageCode - The language code of the input documents.
$sel:jobId:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_jobId - The identifier assigned to the entities detection job.
$sel:jobArn:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the entities detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:entityRecognizerArn:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.
$sel:jobName:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_jobName - The name that you assigned the entities detection job.
$sel:inputDataConfig:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the
entities detection job.
$sel:vpcConfig:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your entity detection job.
For more information, see
Amazon VPC.
$sel:volumeKmsKeyId:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_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:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_endTime - The time that the entities detection job completed
$sel:outputDataConfig:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the
entities detection job.
$sel:dataAccessRoleArn:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access
to your input data.
$sel:jobStatus:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_jobStatus - The current status of the entities detection job. If the status is
FAILED, the Message field shows the reason for the failure.
$sel:message:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_message - A description of the status of a job.
$sel:submitTime:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_submitTime - The time that the entities detection job was submitted for processing.
entitiesDetectionJobProperties_languageCode :: Lens' EntitiesDetectionJobProperties (Maybe LanguageCode) Source #
The language code of the input documents.
entitiesDetectionJobProperties_jobId :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the entities detection job.
entitiesDetectionJobProperties_jobArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
entitiesDetectionJobProperties_entityRecognizerArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the entity recognizer.
entitiesDetectionJobProperties_jobName :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #
The name that you assigned the entities detection job.
entitiesDetectionJobProperties_inputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe InputDataConfig) Source #
The input data configuration that you supplied when you created the entities detection job.
entitiesDetectionJobProperties_vpcConfig :: Lens' EntitiesDetectionJobProperties (Maybe VpcConfig) Source #
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
entitiesDetectionJobProperties_volumeKmsKeyId :: Lens' EntitiesDetectionJobProperties (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"
entitiesDetectionJobProperties_endTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime) Source #
The time that the entities detection job completed
entitiesDetectionJobProperties_outputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe OutputDataConfig) Source #
The output data configuration that you supplied when you created the entities detection job.
entitiesDetectionJobProperties_dataAccessRoleArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
entitiesDetectionJobProperties_jobStatus :: Lens' EntitiesDetectionJobProperties (Maybe JobStatus) Source #
The current status of the entities detection job. If the status is
FAILED, the Message field shows the reason for the failure.
entitiesDetectionJobProperties_message :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #
A description of the status of a job.
entitiesDetectionJobProperties_submitTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime) Source #
The time that the entities detection job was submitted for processing.
Entity
Provides information about an entity.
See: newEntity smart constructor.
Constructors
| Entity' | |
Fields
| |
Instances
Create a value of Entity 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:beginOffset:Entity', entity_beginOffset - A character offset in the input text that shows where the entity begins
(the first character is at position 0). The offset returns the position
of each UTF-8 code point in the string. A code point is the abstract
character from a particular graphical representation. For example, a
multi-byte UTF-8 character maps to a single code point.
$sel:text:Entity', entity_text - The text of the entity.
$sel:score:Entity', entity_score - The level of confidence that Amazon Comprehend has in the accuracy of
the detection.
$sel:endOffset:Entity', entity_endOffset - A character offset in the input text that shows where the entity ends.
The offset returns the position of each UTF-8 code point in the string.
A code point is the abstract character from a particular graphical
representation. For example, a multi-byte UTF-8 character maps to a
single code point.
$sel:type':Entity', entity_type - The entity's type.
entity_beginOffset :: Lens' Entity (Maybe Int) Source #
A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
entity_score :: Lens' Entity (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
entity_endOffset :: Lens' Entity (Maybe Int) Source #
A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
entity_type :: Lens' Entity (Maybe EntityType) Source #
The entity's type.
EntityLabel
data EntityLabel Source #
Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.
See: newEntityLabel smart constructor.
Constructors
| EntityLabel' | |
Instances
newEntityLabel :: EntityLabel Source #
Create a value of EntityLabel 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:score:EntityLabel', entityLabel_score - The level of confidence that Amazon Comprehend has in the accuracy of
the detection.
$sel:name:EntityLabel', entityLabel_name - The name of the label.
entityLabel_score :: Lens' EntityLabel (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
entityLabel_name :: Lens' EntityLabel (Maybe PiiEntityType) Source #
The name of the label.
EntityRecognizerAnnotations
data EntityRecognizerAnnotations Source #
Describes the annotations associated with a entity recognizer.
See: newEntityRecognizerAnnotations smart constructor.
Constructors
| EntityRecognizerAnnotations' | |
Fields
| |
Instances
newEntityRecognizerAnnotations Source #
Create a value of EntityRecognizerAnnotations 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:testS3Uri:EntityRecognizerAnnotations', entityRecognizerAnnotations_testS3Uri - This specifies the Amazon S3 location where the test annotations for an
entity recognizer are located. The URI must be in the same AWS Region as
the API endpoint that you are calling.
$sel:s3Uri:EntityRecognizerAnnotations', entityRecognizerAnnotations_s3Uri - Specifies the Amazon S3 location where the annotations for an entity
recognizer are located. The URI must be in the same region as the API
endpoint that you are calling.
entityRecognizerAnnotations_testS3Uri :: Lens' EntityRecognizerAnnotations (Maybe Text) Source #
This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
entityRecognizerAnnotations_s3Uri :: Lens' EntityRecognizerAnnotations Text Source #
Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
EntityRecognizerDocuments
data EntityRecognizerDocuments Source #
Describes the training documents submitted with an entity recognizer.
See: newEntityRecognizerDocuments smart constructor.
Constructors
| EntityRecognizerDocuments' | |
Fields
| |
Instances
newEntityRecognizerDocuments Source #
Create a value of EntityRecognizerDocuments 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:inputFormat:EntityRecognizerDocuments', entityRecognizerDocuments_inputFormat - Specifies how the text in an input file should be processed. This is
optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each
file is considered a separate document. Use this option when you are
processing large documents, such as newspaper articles or scientific
papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate
document. Use this option when you are processing many short documents,
such as text messages.
$sel:testS3Uri:EntityRecognizerDocuments', entityRecognizerDocuments_testS3Uri - Specifies the Amazon S3 location where the test documents for an entity
recognizer are located. The URI must be in the same AWS Region as the
API endpoint that you are calling.
$sel:s3Uri:EntityRecognizerDocuments', entityRecognizerDocuments_s3Uri - Specifies the Amazon S3 location where the training documents for an
entity recognizer are located. The URI must be in the same region as the
API endpoint that you are calling.
entityRecognizerDocuments_inputFormat :: Lens' EntityRecognizerDocuments (Maybe InputFormat) Source #
Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
entityRecognizerDocuments_testS3Uri :: Lens' EntityRecognizerDocuments (Maybe Text) Source #
Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
entityRecognizerDocuments_s3Uri :: Lens' EntityRecognizerDocuments Text Source #
Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
EntityRecognizerEntityList
data EntityRecognizerEntityList Source #
Describes the entity recognizer submitted with an entity recognizer.
See: newEntityRecognizerEntityList smart constructor.
Constructors
| EntityRecognizerEntityList' | |
Instances
newEntityRecognizerEntityList Source #
Create a value of EntityRecognizerEntityList 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:s3Uri:EntityRecognizerEntityList', entityRecognizerEntityList_s3Uri - Specifies the Amazon S3 location where the entity list is located. The
URI must be in the same region as the API endpoint that you are calling.
entityRecognizerEntityList_s3Uri :: Lens' EntityRecognizerEntityList Text Source #
Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling.
EntityRecognizerEvaluationMetrics
data EntityRecognizerEvaluationMetrics Source #
Detailed information about the accuracy of an entity recognizer.
See: newEntityRecognizerEvaluationMetrics smart constructor.
Constructors
| EntityRecognizerEvaluationMetrics' | |
Fields
| |
Instances
newEntityRecognizerEvaluationMetrics :: EntityRecognizerEvaluationMetrics Source #
Create a value of EntityRecognizerEvaluationMetrics 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:recall:EntityRecognizerEvaluationMetrics', entityRecognizerEvaluationMetrics_recall - A measure of how complete the recognizer results are for the test data.
High recall means that the recognizer returned most of the relevant
results.
$sel:precision:EntityRecognizerEvaluationMetrics', entityRecognizerEvaluationMetrics_precision - A measure of the usefulness of the recognizer results in the test data.
High precision means that the recognizer returned substantially more
relevant results than irrelevant ones.
$sel:f1Score:EntityRecognizerEvaluationMetrics', entityRecognizerEvaluationMetrics_f1Score - A measure of how accurate the recognizer results are for the test data.
It is derived from the Precision and Recall values. The F1Score is
the harmonic average of the two scores. The highest score is 1, and the
worst score is 0.
entityRecognizerEvaluationMetrics_recall :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double) Source #
A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.
entityRecognizerEvaluationMetrics_precision :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double) Source #
A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
entityRecognizerEvaluationMetrics_f1Score :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double) Source #
A measure of how accurate the recognizer results are for the test data.
It is derived from the Precision and Recall values. The F1Score is
the harmonic average of the two scores. The highest score is 1, and the
worst score is 0.
EntityRecognizerFilter
data EntityRecognizerFilter Source #
Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see the operation./>
See: newEntityRecognizerFilter smart constructor.
Constructors
| EntityRecognizerFilter' | |
Fields
| |
Instances
newEntityRecognizerFilter :: EntityRecognizerFilter Source #
Create a value of EntityRecognizerFilter 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:EntityRecognizerFilter', entityRecognizerFilter_status - The status of an entity recognizer.
$sel:submitTimeAfter:EntityRecognizerFilter', entityRecognizerFilter_submitTimeAfter - Filters the list of entities based on the time that the list was
submitted for processing. Returns only jobs submitted after the
specified time. Jobs are returned in ascending order, oldest to newest.
$sel:submitTimeBefore:EntityRecognizerFilter', entityRecognizerFilter_submitTimeBefore - Filters the list of entities based on the time that the list was
submitted for processing. Returns only jobs submitted before the
specified time. Jobs are returned in descending order, newest to oldest.
$sel:recognizerName:EntityRecognizerFilter', entityRecognizerFilter_recognizerName - The name that you assigned the entity recognizer.
entityRecognizerFilter_status :: Lens' EntityRecognizerFilter (Maybe ModelStatus) Source #
The status of an entity recognizer.
entityRecognizerFilter_submitTimeAfter :: Lens' EntityRecognizerFilter (Maybe UTCTime) Source #
Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.
entityRecognizerFilter_submitTimeBefore :: Lens' EntityRecognizerFilter (Maybe UTCTime) Source #
Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.
entityRecognizerFilter_recognizerName :: Lens' EntityRecognizerFilter (Maybe Text) Source #
The name that you assigned the entity recognizer.
EntityRecognizerInputDataConfig
data EntityRecognizerInputDataConfig Source #
Specifies the format and location of the input data.
See: newEntityRecognizerInputDataConfig smart constructor.
Constructors
| EntityRecognizerInputDataConfig' | |
Fields
| |
Instances
newEntityRecognizerInputDataConfig :: EntityRecognizerInputDataConfig Source #
Create a value of EntityRecognizerInputDataConfig 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:augmentedManifests:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_augmentedManifests - A list of augmented manifest files that provide training data for your
custom model. An augmented manifest file is a labeled dataset that is
produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat to
AUGMENTED_MANIFEST.
$sel:annotations:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_annotations - The S3 location of the CSV file that annotates your training documents.
$sel:dataFormat:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_dataFormat - The format of your training data:
COMPREHEND_CSV: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.If you use this value, you must provide your CSV file by using either the
AnnotationsorEntityListparameters. You must provide your training documents by using theDocumentsparameter.AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document.If you use this value, you must provide the
AugmentedManifestsparameter in your request.
If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV
as the default.
$sel:documents:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_documents - The S3 location of the folder that contains the training documents for
your custom entity recognizer.
This parameter is required if you set DataFormat to COMPREHEND_CSV.
$sel:entityList:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_entityList - The S3 location of the CSV file that has the entity list for your custom
entity recognizer.
$sel:entityTypes:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_entityTypes - The entity types in the labeled training data that Amazon Comprehend
uses to train the custom entity recognizer. Any entity types that you
don't specify are ignored.
A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break), \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).
entityRecognizerInputDataConfig_augmentedManifests :: Lens' EntityRecognizerInputDataConfig (Maybe [AugmentedManifestsListItem]) Source #
A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat to
AUGMENTED_MANIFEST.
entityRecognizerInputDataConfig_annotations :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerAnnotations) Source #
The S3 location of the CSV file that annotates your training documents.
entityRecognizerInputDataConfig_dataFormat :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerDataFormat) Source #
The format of your training data:
COMPREHEND_CSV: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.If you use this value, you must provide your CSV file by using either the
AnnotationsorEntityListparameters. You must provide your training documents by using theDocumentsparameter.AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document.If you use this value, you must provide the
AugmentedManifestsparameter in your request.
If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV
as the default.
entityRecognizerInputDataConfig_documents :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerDocuments) Source #
The S3 location of the folder that contains the training documents for your custom entity recognizer.
This parameter is required if you set DataFormat to COMPREHEND_CSV.
entityRecognizerInputDataConfig_entityList :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerEntityList) Source #
The S3 location of the CSV file that has the entity list for your custom entity recognizer.
entityRecognizerInputDataConfig_entityTypes :: Lens' EntityRecognizerInputDataConfig [EntityTypesListItem] Source #
The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don't specify are ignored.
A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break), \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).
EntityRecognizerMetadata
data EntityRecognizerMetadata Source #
Detailed information about an entity recognizer.
See: newEntityRecognizerMetadata smart constructor.
Constructors
| EntityRecognizerMetadata' | |
Fields
| |
Instances
newEntityRecognizerMetadata :: EntityRecognizerMetadata Source #
Create a value of EntityRecognizerMetadata 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:entityTypes:EntityRecognizerMetadata', entityRecognizerMetadata_entityTypes - Entity types from the metadata of an entity recognizer.
$sel:evaluationMetrics:EntityRecognizerMetadata', entityRecognizerMetadata_evaluationMetrics - Detailed information about the accuracy of an entity recognizer.
$sel:numberOfTrainedDocuments:EntityRecognizerMetadata', entityRecognizerMetadata_numberOfTrainedDocuments - The number of documents in the input data that were used to train the
entity recognizer. Typically this is 80 to 90 percent of the input
documents.
$sel:numberOfTestDocuments:EntityRecognizerMetadata', entityRecognizerMetadata_numberOfTestDocuments - The number of documents in the input data that were used to test the
entity recognizer. Typically this is 10 to 20 percent of the input
documents.
entityRecognizerMetadata_entityTypes :: Lens' EntityRecognizerMetadata (Maybe [EntityRecognizerMetadataEntityTypesListItem]) Source #
Entity types from the metadata of an entity recognizer.
entityRecognizerMetadata_evaluationMetrics :: Lens' EntityRecognizerMetadata (Maybe EntityRecognizerEvaluationMetrics) Source #
Detailed information about the accuracy of an entity recognizer.
entityRecognizerMetadata_numberOfTrainedDocuments :: Lens' EntityRecognizerMetadata (Maybe Int) Source #
The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.
entityRecognizerMetadata_numberOfTestDocuments :: Lens' EntityRecognizerMetadata (Maybe Int) Source #
The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.
EntityRecognizerMetadataEntityTypesListItem
data EntityRecognizerMetadataEntityTypesListItem Source #
Individual item from the list of entity types in the metadata of an entity recognizer.
See: newEntityRecognizerMetadataEntityTypesListItem smart constructor.
Constructors
| EntityRecognizerMetadataEntityTypesListItem' | |
Fields
| |
Instances
newEntityRecognizerMetadataEntityTypesListItem :: EntityRecognizerMetadataEntityTypesListItem Source #
Create a value of EntityRecognizerMetadataEntityTypesListItem 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:evaluationMetrics:EntityRecognizerMetadataEntityTypesListItem', entityRecognizerMetadataEntityTypesListItem_evaluationMetrics - Detailed information about the accuracy of the entity recognizer for a
specific item on the list of entity types.
$sel:type':EntityRecognizerMetadataEntityTypesListItem', entityRecognizerMetadataEntityTypesListItem_type - Type of entity from the list of entity types in the metadata of an
entity recognizer.
$sel:numberOfTrainMentions:EntityRecognizerMetadataEntityTypesListItem', entityRecognizerMetadataEntityTypesListItem_numberOfTrainMentions - Indicates the number of times the given entity type was seen in the
training data.
entityRecognizerMetadataEntityTypesListItem_evaluationMetrics :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe EntityTypesEvaluationMetrics) Source #
Detailed information about the accuracy of the entity recognizer for a specific item on the list of entity types.
entityRecognizerMetadataEntityTypesListItem_type :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe Text) Source #
Type of entity from the list of entity types in the metadata of an entity recognizer.
entityRecognizerMetadataEntityTypesListItem_numberOfTrainMentions :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe Int) Source #
Indicates the number of times the given entity type was seen in the training data.
EntityRecognizerProperties
data EntityRecognizerProperties Source #
Describes information about an entity recognizer.
See: newEntityRecognizerProperties smart constructor.
Constructors
| EntityRecognizerProperties' | |
Fields
| |
Instances
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.
EntityRecognizerSummary
data EntityRecognizerSummary Source #
Describes the information about an entity recognizer and its versions.
See: newEntityRecognizerSummary smart constructor.
Constructors
| EntityRecognizerSummary' | |
Fields
| |
Instances
newEntityRecognizerSummary :: EntityRecognizerSummary Source #
Create a value of EntityRecognizerSummary 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:latestVersionCreatedAt:EntityRecognizerSummary', entityRecognizerSummary_latestVersionCreatedAt - The time that the latest entity recognizer version was submitted for
processing.
$sel:latestVersionStatus:EntityRecognizerSummary', entityRecognizerSummary_latestVersionStatus - Provides the status of the latest entity recognizer version.
$sel:numberOfVersions:EntityRecognizerSummary', entityRecognizerSummary_numberOfVersions - The number of versions you created.
$sel:latestVersionName:EntityRecognizerSummary', entityRecognizerSummary_latestVersionName - The version name you assigned to the latest entity recognizer version.
$sel:recognizerName:EntityRecognizerSummary', entityRecognizerSummary_recognizerName - The name that you assigned the entity recognizer.
entityRecognizerSummary_latestVersionCreatedAt :: Lens' EntityRecognizerSummary (Maybe UTCTime) Source #
The time that the latest entity recognizer version was submitted for processing.
entityRecognizerSummary_latestVersionStatus :: Lens' EntityRecognizerSummary (Maybe ModelStatus) Source #
Provides the status of the latest entity recognizer version.
entityRecognizerSummary_numberOfVersions :: Lens' EntityRecognizerSummary (Maybe Int) Source #
The number of versions you created.
entityRecognizerSummary_latestVersionName :: Lens' EntityRecognizerSummary (Maybe Text) Source #
The version name you assigned to the latest entity recognizer version.
entityRecognizerSummary_recognizerName :: Lens' EntityRecognizerSummary (Maybe Text) Source #
The name that you assigned the entity recognizer.
EntityTypesEvaluationMetrics
data EntityTypesEvaluationMetrics Source #
Detailed information about the accuracy of an entity recognizer for a specific entity type.
See: newEntityTypesEvaluationMetrics smart constructor.
Constructors
| EntityTypesEvaluationMetrics' | |
Fields
| |
Instances
newEntityTypesEvaluationMetrics :: EntityTypesEvaluationMetrics Source #
Create a value of EntityTypesEvaluationMetrics 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:recall:EntityTypesEvaluationMetrics', entityTypesEvaluationMetrics_recall - A measure of how complete the recognizer results are for a specific
entity type in the test data. High recall means that the recognizer
returned most of the relevant results.
$sel:precision:EntityTypesEvaluationMetrics', entityTypesEvaluationMetrics_precision - A measure of the usefulness of the recognizer results for a specific
entity type in the test data. High precision means that the recognizer
returned substantially more relevant results than irrelevant ones.
$sel:f1Score:EntityTypesEvaluationMetrics', entityTypesEvaluationMetrics_f1Score - A measure of how accurate the recognizer results are for a specific
entity type in the test data. It is derived from the Precision and
Recall values. The F1Score is the harmonic average of the two
scores. The highest score is 1, and the worst score is 0.
entityTypesEvaluationMetrics_recall :: Lens' EntityTypesEvaluationMetrics (Maybe Double) Source #
A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.
entityTypesEvaluationMetrics_precision :: Lens' EntityTypesEvaluationMetrics (Maybe Double) Source #
A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
entityTypesEvaluationMetrics_f1Score :: Lens' EntityTypesEvaluationMetrics (Maybe Double) Source #
A measure of how accurate the recognizer results are for a specific
entity type in the test data. It is derived from the Precision and
Recall values. The F1Score is the harmonic average of the two
scores. The highest score is 1, and the worst score is 0.
EntityTypesListItem
data EntityTypesListItem Source #
An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
See: newEntityTypesListItem smart constructor.
Constructors
| EntityTypesListItem' | |
Fields
| |
Instances
newEntityTypesListItem Source #
Arguments
| :: Text | |
| -> EntityTypesListItem |
Create a value of EntityTypesListItem 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:type':EntityTypesListItem', entityTypesListItem_type - An entity type within a labeled training dataset that Amazon Comprehend
uses to train a custom entity recognizer.
Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break, \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).
entityTypesListItem_type :: Lens' EntityTypesListItem Text Source #
An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break, \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).
EventsDetectionJobFilter
data EventsDetectionJobFilter Source #
Provides information for filtering a list of event detection jobs.
See: newEventsDetectionJobFilter smart constructor.
Constructors
| EventsDetectionJobFilter' | |
Fields
| |
Instances
newEventsDetectionJobFilter :: EventsDetectionJobFilter Source #
Create a value of EventsDetectionJobFilter 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:submitTimeAfter:EventsDetectionJobFilter', eventsDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted after the specified time.
Jobs are returned in descending order, newest to oldest.
$sel:submitTimeBefore:EventsDetectionJobFilter', eventsDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted before the specified time.
Jobs are returned in ascending order, oldest to newest.
$sel:jobName:EventsDetectionJobFilter', eventsDetectionJobFilter_jobName - Filters on the name of the events detection job.
$sel:jobStatus:EventsDetectionJobFilter', eventsDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the
specified status.
eventsDetectionJobFilter_submitTimeAfter :: Lens' EventsDetectionJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
eventsDetectionJobFilter_submitTimeBefore :: Lens' EventsDetectionJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
eventsDetectionJobFilter_jobName :: Lens' EventsDetectionJobFilter (Maybe Text) Source #
Filters on the name of the events detection job.
eventsDetectionJobFilter_jobStatus :: Lens' EventsDetectionJobFilter (Maybe JobStatus) Source #
Filters the list of jobs based on job status. Returns only jobs with the specified status.
EventsDetectionJobProperties
data EventsDetectionJobProperties Source #
Provides information about an events detection job.
See: newEventsDetectionJobProperties smart constructor.
Constructors
| EventsDetectionJobProperties' | |
Fields
| |
Instances
newEventsDetectionJobProperties :: EventsDetectionJobProperties Source #
Create a value of EventsDetectionJobProperties 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:languageCode:EventsDetectionJobProperties', eventsDetectionJobProperties_languageCode - The language code of the input documents.
$sel:jobId:EventsDetectionJobProperties', eventsDetectionJobProperties_jobId - The identifier assigned to the events detection job.
$sel:jobArn:EventsDetectionJobProperties', eventsDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the events detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobName:EventsDetectionJobProperties', eventsDetectionJobProperties_jobName - The name you assigned the events detection job.
$sel:targetEventTypes:EventsDetectionJobProperties', eventsDetectionJobProperties_targetEventTypes - The types of events that are detected by the job.
$sel:inputDataConfig:EventsDetectionJobProperties', eventsDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the
events detection job.
$sel:endTime:EventsDetectionJobProperties', eventsDetectionJobProperties_endTime - The time that the events detection job completed.
$sel:outputDataConfig:EventsDetectionJobProperties', eventsDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the
events detection job.
$sel:dataAccessRoleArn:EventsDetectionJobProperties', eventsDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identify and Access Management
(IAM) role that grants Amazon Comprehend read access to your input data.
$sel:jobStatus:EventsDetectionJobProperties', eventsDetectionJobProperties_jobStatus - The current status of the events detection job.
$sel:message:EventsDetectionJobProperties', eventsDetectionJobProperties_message - A description of the status of the events detection job.
$sel:submitTime:EventsDetectionJobProperties', eventsDetectionJobProperties_submitTime - The time that the events detection job was submitted for processing.
eventsDetectionJobProperties_languageCode :: Lens' EventsDetectionJobProperties (Maybe LanguageCode) Source #
The language code of the input documents.
eventsDetectionJobProperties_jobId :: Lens' EventsDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the events detection job.
eventsDetectionJobProperties_jobArn :: Lens' EventsDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
eventsDetectionJobProperties_jobName :: Lens' EventsDetectionJobProperties (Maybe Text) Source #
The name you assigned the events detection job.
eventsDetectionJobProperties_targetEventTypes :: Lens' EventsDetectionJobProperties (Maybe (NonEmpty Text)) Source #
The types of events that are detected by the job.
eventsDetectionJobProperties_inputDataConfig :: Lens' EventsDetectionJobProperties (Maybe InputDataConfig) Source #
The input data configuration that you supplied when you created the events detection job.
eventsDetectionJobProperties_endTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime) Source #
The time that the events detection job completed.
eventsDetectionJobProperties_outputDataConfig :: Lens' EventsDetectionJobProperties (Maybe OutputDataConfig) Source #
The output data configuration that you supplied when you created the events detection job.
eventsDetectionJobProperties_dataAccessRoleArn :: Lens' EventsDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS Identify and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
eventsDetectionJobProperties_jobStatus :: Lens' EventsDetectionJobProperties (Maybe JobStatus) Source #
The current status of the events detection job.
eventsDetectionJobProperties_message :: Lens' EventsDetectionJobProperties (Maybe Text) Source #
A description of the status of the events detection job.
eventsDetectionJobProperties_submitTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime) Source #
The time that the events detection job was submitted for processing.
InputDataConfig
data InputDataConfig Source #
The input properties for an inference job.
See: newInputDataConfig smart constructor.
Constructors
| InputDataConfig' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> InputDataConfig |
Create a value of InputDataConfig 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:documentReaderConfig:InputDataConfig', inputDataConfig_documentReaderConfig - The document reader config field applies only for InputDataConfig of
StartEntitiesDetectionJob.
Use DocumentReaderConfig to provide specifications about how you want your inference documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.
$sel:inputFormat:InputDataConfig', inputDataConfig_inputFormat - Specifies how the text in an input file should be processed:
ONE_DOC_PER_FILE- Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.ONE_DOC_PER_LINE- Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
$sel:s3Uri:InputDataConfig', inputDataConfig_s3Uri - The Amazon S3 URI for the input data. The URI must be in same region as
the API endpoint that you are calling. The URI can point to a single
input file or it can provide the prefix for a collection of data files.
For example, if you use the URI S3://bucketName/prefix, if the
prefix is a single file, Amazon Comprehend uses that file as input. If
more than one file begins with the prefix, Amazon Comprehend uses all of
them as input.
inputDataConfig_documentReaderConfig :: Lens' InputDataConfig (Maybe DocumentReaderConfig) Source #
The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.
Use DocumentReaderConfig to provide specifications about how you want your inference documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.
inputDataConfig_inputFormat :: Lens' InputDataConfig (Maybe InputFormat) Source #
Specifies how the text in an input file should be processed:
ONE_DOC_PER_FILE- Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.ONE_DOC_PER_LINE- Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
inputDataConfig_s3Uri :: Lens' InputDataConfig Text Source #
The Amazon S3 URI for the input data. The URI must be in same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.
For example, if you use the URI S3://bucketName/prefix, if the
prefix is a single file, Amazon Comprehend uses that file as input. If
more than one file begins with the prefix, Amazon Comprehend uses all of
them as input.
KeyPhrase
Describes a key noun phrase.
See: newKeyPhrase smart constructor.
Constructors
| KeyPhrase' | |
Fields
| |
Instances
| Eq KeyPhrase Source # | |
| Read KeyPhrase Source # | |
| Show KeyPhrase Source # | |
| Generic KeyPhrase Source # | |
| NFData KeyPhrase Source # | |
Defined in Amazonka.Comprehend.Types.KeyPhrase | |
| Hashable KeyPhrase Source # | |
Defined in Amazonka.Comprehend.Types.KeyPhrase | |
| FromJSON KeyPhrase Source # | |
| type Rep KeyPhrase Source # | |
Defined in Amazonka.Comprehend.Types.KeyPhrase type Rep KeyPhrase = D1 ('MetaData "KeyPhrase" "Amazonka.Comprehend.Types.KeyPhrase" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "KeyPhrase'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) | |
newKeyPhrase :: KeyPhrase Source #
Create a value of KeyPhrase 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:beginOffset:KeyPhrase', keyPhrase_beginOffset - A character offset in the input text that shows where the key phrase
begins (the first character is at position 0). The offset returns the
position of each UTF-8 code point in the string. A code point is the
abstract character from a particular graphical representation. For
example, a multi-byte UTF-8 character maps to a single code point.
$sel:text:KeyPhrase', keyPhrase_text - The text of a key noun phrase.
$sel:score:KeyPhrase', keyPhrase_score - The level of confidence that Amazon Comprehend has in the accuracy of
the detection.
$sel:endOffset:KeyPhrase', keyPhrase_endOffset - A character offset in the input text where the key phrase ends. The
offset returns the position of each UTF-8 code point in the string. A
code point is the abstract character from a particular graphical
representation. For example, a multi-byte UTF-8 character maps to a
single code point.
keyPhrase_beginOffset :: Lens' KeyPhrase (Maybe Int) Source #
A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
keyPhrase_score :: Lens' KeyPhrase (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
keyPhrase_endOffset :: Lens' KeyPhrase (Maybe Int) Source #
A character offset in the input text where the key phrase ends. The
offset returns the position of each UTF-8 code point in the string. A
code point is the abstract character from a particular graphical
representation. For example, a multi-byte UTF-8 character maps to a
single code point.
KeyPhrasesDetectionJobFilter
data KeyPhrasesDetectionJobFilter Source #
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
See: newKeyPhrasesDetectionJobFilter smart constructor.
Constructors
| KeyPhrasesDetectionJobFilter' | |
Fields
| |
Instances
newKeyPhrasesDetectionJobFilter :: KeyPhrasesDetectionJobFilter Source #
Create a value of KeyPhrasesDetectionJobFilter 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:submitTimeAfter:KeyPhrasesDetectionJobFilter', keyPhrasesDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted after the specified time.
Jobs are returned in descending order, newest to oldest.
$sel:submitTimeBefore:KeyPhrasesDetectionJobFilter', keyPhrasesDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted before the specified time.
Jobs are returned in ascending order, oldest to newest.
$sel:jobName:KeyPhrasesDetectionJobFilter', keyPhrasesDetectionJobFilter_jobName - Filters on the name of the job.
$sel:jobStatus:KeyPhrasesDetectionJobFilter', keyPhrasesDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the
specified status.
keyPhrasesDetectionJobFilter_submitTimeAfter :: Lens' KeyPhrasesDetectionJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
keyPhrasesDetectionJobFilter_submitTimeBefore :: Lens' KeyPhrasesDetectionJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
keyPhrasesDetectionJobFilter_jobName :: Lens' KeyPhrasesDetectionJobFilter (Maybe Text) Source #
Filters on the name of the job.
keyPhrasesDetectionJobFilter_jobStatus :: Lens' KeyPhrasesDetectionJobFilter (Maybe JobStatus) Source #
Filters the list of jobs based on job status. Returns only jobs with the specified status.
KeyPhrasesDetectionJobProperties
data KeyPhrasesDetectionJobProperties Source #
Provides information about a key phrases detection job.
See: newKeyPhrasesDetectionJobProperties smart constructor.
Constructors
| KeyPhrasesDetectionJobProperties' | |
Fields
| |
Instances
newKeyPhrasesDetectionJobProperties :: KeyPhrasesDetectionJobProperties Source #
Create a value of KeyPhrasesDetectionJobProperties 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:languageCode:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_languageCode - The language code of the input documents.
$sel:jobId:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_jobId - The identifier assigned to the key phrases detection job.
$sel:jobArn:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the key phrases detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobName:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_jobName - The name that you assigned the key phrases detection job.
$sel:inputDataConfig:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the key
phrases detection job.
$sel:vpcConfig:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your key phrases detection
job. For more information, see
Amazon VPC.
$sel:volumeKmsKeyId:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_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:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_endTime - The time that the key phrases detection job completed.
$sel:outputDataConfig:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the key
phrases detection job.
$sel:dataAccessRoleArn:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access
to your input data.
$sel:jobStatus:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_jobStatus - The current status of the key phrases detection job. If the status is
FAILED, the Message field shows the reason for the failure.
$sel:message:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_message - A description of the status of a job.
$sel:submitTime:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_submitTime - The time that the key phrases detection job was submitted for
processing.
keyPhrasesDetectionJobProperties_languageCode :: Lens' KeyPhrasesDetectionJobProperties (Maybe LanguageCode) Source #
The language code of the input documents.
keyPhrasesDetectionJobProperties_jobId :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the key phrases detection job.
keyPhrasesDetectionJobProperties_jobArn :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
keyPhrasesDetectionJobProperties_jobName :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) Source #
The name that you assigned the key phrases detection job.
keyPhrasesDetectionJobProperties_inputDataConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe InputDataConfig) Source #
The input data configuration that you supplied when you created the key phrases detection job.
keyPhrasesDetectionJobProperties_vpcConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe VpcConfig) Source #
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.
keyPhrasesDetectionJobProperties_volumeKmsKeyId :: Lens' KeyPhrasesDetectionJobProperties (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"
keyPhrasesDetectionJobProperties_endTime :: Lens' KeyPhrasesDetectionJobProperties (Maybe UTCTime) Source #
The time that the key phrases detection job completed.
keyPhrasesDetectionJobProperties_outputDataConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe OutputDataConfig) Source #
The output data configuration that you supplied when you created the key phrases detection job.
keyPhrasesDetectionJobProperties_dataAccessRoleArn :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
keyPhrasesDetectionJobProperties_jobStatus :: Lens' KeyPhrasesDetectionJobProperties (Maybe JobStatus) Source #
The current status of the key phrases detection job. If the status is
FAILED, the Message field shows the reason for the failure.
keyPhrasesDetectionJobProperties_message :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) Source #
A description of the status of a job.
keyPhrasesDetectionJobProperties_submitTime :: Lens' KeyPhrasesDetectionJobProperties (Maybe UTCTime) Source #
The time that the key phrases detection job was submitted for processing.
OutputDataConfig
data OutputDataConfig Source #
Provides configuration parameters for the output of topic detection jobs.
See: newOutputDataConfig smart constructor.
Constructors
| OutputDataConfig' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> OutputDataConfig |
Create a value of OutputDataConfig 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:kmsKeyId:OutputDataConfig', outputDataConfig_kmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt the output results from an analysis job. The KmsKeyId
can be one 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" - KMS Key Alias:
"alias/ExampleAlias" - ARN of a KMS Key Alias:
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
$sel:s3Uri:OutputDataConfig', outputDataConfig_s3Uri - When you use the OutputDataConfig object with asynchronous operations,
you specify the Amazon S3 location where you want to write the output
data. The URI must be in the same region as the API endpoint that you
are calling. The location is used as the prefix for the actual location
of the output file.
When the topic detection job is finished, the service creates an output
file in a directory specific to the job. The S3Uri field contains the
location of the output file, called output.tar.gz. It is a compressed
archive that contains the ouput of the operation.
outputDataConfig_kmsKeyId :: Lens' OutputDataConfig (Maybe Text) Source #
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one 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" - KMS Key Alias:
"alias/ExampleAlias" - ARN of a KMS Key Alias:
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
outputDataConfig_s3Uri :: Lens' OutputDataConfig Text Source #
When you use the OutputDataConfig object with asynchronous operations,
you specify the Amazon S3 location where you want to write the output
data. The URI must be in the same region as the API endpoint that you
are calling. The location is used as the prefix for the actual location
of the output file.
When the topic detection job is finished, the service creates an output
file in a directory specific to the job. The S3Uri field contains the
location of the output file, called output.tar.gz. It is a compressed
archive that contains the ouput of the operation.
PartOfSpeechTag
data PartOfSpeechTag Source #
Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see how-syntax.
See: newPartOfSpeechTag smart constructor.
Constructors
| PartOfSpeechTag' | |
Instances
newPartOfSpeechTag :: PartOfSpeechTag Source #
Create a value of PartOfSpeechTag 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:tag:PartOfSpeechTag', partOfSpeechTag_tag - Identifies the part of speech that the token represents.
$sel:score:PartOfSpeechTag', partOfSpeechTag_score - The confidence that Amazon Comprehend has that the part of speech was
correctly identified.
partOfSpeechTag_tag :: Lens' PartOfSpeechTag (Maybe PartOfSpeechTagType) Source #
Identifies the part of speech that the token represents.
partOfSpeechTag_score :: Lens' PartOfSpeechTag (Maybe Double) Source #
The confidence that Amazon Comprehend has that the part of speech was correctly identified.
PiiEntitiesDetectionJobFilter
data PiiEntitiesDetectionJobFilter Source #
Provides information for filtering a list of PII entity detection jobs.
See: newPiiEntitiesDetectionJobFilter smart constructor.
Constructors
| PiiEntitiesDetectionJobFilter' | |
Fields
| |
Instances
newPiiEntitiesDetectionJobFilter :: PiiEntitiesDetectionJobFilter Source #
Create a value of PiiEntitiesDetectionJobFilter 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:submitTimeAfter:PiiEntitiesDetectionJobFilter', piiEntitiesDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted after the specified time.
Jobs are returned in descending order, newest to oldest.
$sel:submitTimeBefore:PiiEntitiesDetectionJobFilter', piiEntitiesDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted before the specified time.
Jobs are returned in ascending order, oldest to newest.
$sel:jobName:PiiEntitiesDetectionJobFilter', piiEntitiesDetectionJobFilter_jobName - Filters on the name of the job.
$sel:jobStatus:PiiEntitiesDetectionJobFilter', piiEntitiesDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the
specified status.
piiEntitiesDetectionJobFilter_submitTimeAfter :: Lens' PiiEntitiesDetectionJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
piiEntitiesDetectionJobFilter_submitTimeBefore :: Lens' PiiEntitiesDetectionJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
piiEntitiesDetectionJobFilter_jobName :: Lens' PiiEntitiesDetectionJobFilter (Maybe Text) Source #
Filters on the name of the job.
piiEntitiesDetectionJobFilter_jobStatus :: Lens' PiiEntitiesDetectionJobFilter (Maybe JobStatus) Source #
Filters the list of jobs based on job status. Returns only jobs with the specified status.
PiiEntitiesDetectionJobProperties
data PiiEntitiesDetectionJobProperties Source #
Provides information about a PII entities detection job.
See: newPiiEntitiesDetectionJobProperties smart constructor.
Constructors
| PiiEntitiesDetectionJobProperties' | |
Fields
| |
Instances
newPiiEntitiesDetectionJobProperties :: PiiEntitiesDetectionJobProperties Source #
Create a value of PiiEntitiesDetectionJobProperties 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:languageCode:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_languageCode - The language code of the input documents
$sel:jobId:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobId - The identifier assigned to the PII entities detection job.
$sel:jobArn:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the PII entities detection job. It is
a unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobName:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobName - The name that you assigned the PII entities detection job.
$sel:mode:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_mode - Specifies whether the output provides the locations (offsets) of PII
entities or a file in which PII entities are redacted.
$sel:inputDataConfig:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_inputDataConfig - The input properties for a PII entities detection job.
$sel:redactionConfig:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_redactionConfig - Provides configuration parameters for PII entity redaction.
This parameter is required if you set the Mode parameter to
ONLY_REDACTION. In that case, you must provide a RedactionConfig
definition that includes the PiiEntityTypes parameter.
$sel:endTime:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_endTime - The time that the PII entities detection job completed.
$sel:outputDataConfig:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the PII
entities detection job.
$sel:dataAccessRoleArn:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access
to your input data.
$sel:jobStatus:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobStatus - The current status of the PII entities detection job. If the status is
FAILED, the Message field shows the reason for the failure.
$sel:message:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_message - A description of the status of a job.
$sel:submitTime:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_submitTime - The time that the PII entities detection job was submitted for
processing.
piiEntitiesDetectionJobProperties_languageCode :: Lens' PiiEntitiesDetectionJobProperties (Maybe LanguageCode) Source #
The language code of the input documents
piiEntitiesDetectionJobProperties_jobId :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the PII entities detection job.
piiEntitiesDetectionJobProperties_jobArn :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
piiEntitiesDetectionJobProperties_jobName :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) Source #
The name that you assigned the PII entities detection job.
piiEntitiesDetectionJobProperties_mode :: Lens' PiiEntitiesDetectionJobProperties (Maybe PiiEntitiesDetectionMode) Source #
Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
piiEntitiesDetectionJobProperties_inputDataConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe InputDataConfig) Source #
The input properties for a PII entities detection job.
piiEntitiesDetectionJobProperties_redactionConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe RedactionConfig) Source #
Provides configuration parameters for PII entity redaction.
This parameter is required if you set the Mode parameter to
ONLY_REDACTION. In that case, you must provide a RedactionConfig
definition that includes the PiiEntityTypes parameter.
piiEntitiesDetectionJobProperties_endTime :: Lens' PiiEntitiesDetectionJobProperties (Maybe UTCTime) Source #
The time that the PII entities detection job completed.
piiEntitiesDetectionJobProperties_outputDataConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe PiiOutputDataConfig) Source #
The output data configuration that you supplied when you created the PII entities detection job.
piiEntitiesDetectionJobProperties_dataAccessRoleArn :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
piiEntitiesDetectionJobProperties_jobStatus :: Lens' PiiEntitiesDetectionJobProperties (Maybe JobStatus) Source #
The current status of the PII entities detection job. If the status is
FAILED, the Message field shows the reason for the failure.
piiEntitiesDetectionJobProperties_message :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) Source #
A description of the status of a job.
piiEntitiesDetectionJobProperties_submitTime :: Lens' PiiEntitiesDetectionJobProperties (Maybe UTCTime) Source #
The time that the PII entities detection job was submitted for processing.
PiiEntity
Provides information about a PII entity.
See: newPiiEntity smart constructor.
Constructors
| PiiEntity' | |
Fields
| |
Instances
newPiiEntity :: PiiEntity Source #
Create a value of PiiEntity 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:beginOffset:PiiEntity', piiEntity_beginOffset - A character offset in the input text that shows where the PII entity
begins (the first character is at position 0). The offset returns the
position of each UTF-8 code point in the string. A code point is the
abstract character from a particular graphical representation. For
example, a multi-byte UTF-8 character maps to a single code point.
$sel:score:PiiEntity', piiEntity_score - The level of confidence that Amazon Comprehend has in the accuracy of
the detection.
$sel:endOffset:PiiEntity', piiEntity_endOffset - A character offset in the input text that shows where the PII entity
ends. The offset returns the position of each UTF-8 code point in the
string. A code point is the abstract character from a particular
graphical representation. For example, a multi-byte UTF-8 character maps
to a single code point.
$sel:type':PiiEntity', piiEntity_type - The entity's type.
piiEntity_beginOffset :: Lens' PiiEntity (Maybe Int) Source #
A character offset in the input text that shows where the PII entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
piiEntity_score :: Lens' PiiEntity (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
piiEntity_endOffset :: Lens' PiiEntity (Maybe Int) Source #
A character offset in the input text that shows where the PII entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
piiEntity_type :: Lens' PiiEntity (Maybe PiiEntityType) Source #
The entity's type.
PiiOutputDataConfig
data PiiOutputDataConfig Source #
Provides configuration parameters for the output of PII entity detection jobs.
See: newPiiOutputDataConfig smart constructor.
Constructors
| PiiOutputDataConfig' | |
Fields
| |
Instances
newPiiOutputDataConfig Source #
Arguments
| :: Text | |
| -> PiiOutputDataConfig |
Create a value of PiiOutputDataConfig 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:kmsKeyId:PiiOutputDataConfig', piiOutputDataConfig_kmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt the output results from an analysis job.
$sel:s3Uri:PiiOutputDataConfig', piiOutputDataConfig_s3Uri - When you use the PiiOutputDataConfig object with asynchronous
operations, you specify the Amazon S3 location where you want to write
the output data.
piiOutputDataConfig_kmsKeyId :: Lens' PiiOutputDataConfig (Maybe Text) Source #
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.
piiOutputDataConfig_s3Uri :: Lens' PiiOutputDataConfig Text Source #
When you use the PiiOutputDataConfig object with asynchronous
operations, you specify the Amazon S3 location where you want to write
the output data.
RedactionConfig
data RedactionConfig Source #
Provides configuration parameters for PII entity redaction.
See: newRedactionConfig smart constructor.
Constructors
| RedactionConfig' | |
Fields
| |
Instances
newRedactionConfig :: RedactionConfig Source #
Create a value of RedactionConfig 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:maskCharacter:RedactionConfig', redactionConfig_maskCharacter - A character that replaces each character in the redacted PII entity.
$sel:maskMode:RedactionConfig', redactionConfig_maskMode - Specifies whether the PII entity is redacted with the mask character or
the entity type.
$sel:piiEntityTypes:RedactionConfig', redactionConfig_piiEntityTypes - An array of the types of PII entities that Amazon Comprehend detects in
the input text for your request.
redactionConfig_maskCharacter :: Lens' RedactionConfig (Maybe Text) Source #
A character that replaces each character in the redacted PII entity.
redactionConfig_maskMode :: Lens' RedactionConfig (Maybe PiiEntitiesDetectionMaskMode) Source #
Specifies whether the PII entity is redacted with the mask character or the entity type.
redactionConfig_piiEntityTypes :: Lens' RedactionConfig (Maybe [PiiEntityType]) Source #
An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
SentimentDetectionJobFilter
data SentimentDetectionJobFilter Source #
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
See: newSentimentDetectionJobFilter smart constructor.
Constructors
| SentimentDetectionJobFilter' | |
Fields
| |
Instances
newSentimentDetectionJobFilter :: SentimentDetectionJobFilter Source #
Create a value of SentimentDetectionJobFilter 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:submitTimeAfter:SentimentDetectionJobFilter', sentimentDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted after the specified time.
Jobs are returned in descending order, newest to oldest.
$sel:submitTimeBefore:SentimentDetectionJobFilter', sentimentDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted before the specified time.
Jobs are returned in ascending order, oldest to newest.
$sel:jobName:SentimentDetectionJobFilter', sentimentDetectionJobFilter_jobName - Filters on the name of the job.
$sel:jobStatus:SentimentDetectionJobFilter', sentimentDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the
specified status.
sentimentDetectionJobFilter_submitTimeAfter :: Lens' SentimentDetectionJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
sentimentDetectionJobFilter_submitTimeBefore :: Lens' SentimentDetectionJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
sentimentDetectionJobFilter_jobName :: Lens' SentimentDetectionJobFilter (Maybe Text) Source #
Filters on the name of the job.
sentimentDetectionJobFilter_jobStatus :: Lens' SentimentDetectionJobFilter (Maybe JobStatus) Source #
Filters the list of jobs based on job status. Returns only jobs with the specified status.
SentimentDetectionJobProperties
data SentimentDetectionJobProperties Source #
Provides information about a sentiment detection job.
See: newSentimentDetectionJobProperties smart constructor.
Constructors
| SentimentDetectionJobProperties' | |
Fields
| |
Instances
newSentimentDetectionJobProperties :: SentimentDetectionJobProperties Source #
Create a value of SentimentDetectionJobProperties 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:languageCode:SentimentDetectionJobProperties', sentimentDetectionJobProperties_languageCode - The language code of the input documents.
$sel:jobId:SentimentDetectionJobProperties', sentimentDetectionJobProperties_jobId - The identifier assigned to the sentiment detection job.
$sel:jobArn:SentimentDetectionJobProperties', sentimentDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the sentiment detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobName:SentimentDetectionJobProperties', sentimentDetectionJobProperties_jobName - The name that you assigned to the sentiment detection job
$sel:inputDataConfig:SentimentDetectionJobProperties', sentimentDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the
sentiment detection job.
$sel:vpcConfig:SentimentDetectionJobProperties', sentimentDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your sentiment detection job.
For more information, see
Amazon VPC.
$sel:volumeKmsKeyId:SentimentDetectionJobProperties', sentimentDetectionJobProperties_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:SentimentDetectionJobProperties', sentimentDetectionJobProperties_endTime - The time that the sentiment detection job ended.
$sel:outputDataConfig:SentimentDetectionJobProperties', sentimentDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the
sentiment detection job.
$sel:dataAccessRoleArn:SentimentDetectionJobProperties', sentimentDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access
to your input data.
$sel:jobStatus:SentimentDetectionJobProperties', sentimentDetectionJobProperties_jobStatus - The current status of the sentiment detection job. If the status is
FAILED, the Messages field shows the reason for the failure.
$sel:message:SentimentDetectionJobProperties', sentimentDetectionJobProperties_message - A description of the status of a job.
$sel:submitTime:SentimentDetectionJobProperties', sentimentDetectionJobProperties_submitTime - The time that the sentiment detection job was submitted for processing.
sentimentDetectionJobProperties_languageCode :: Lens' SentimentDetectionJobProperties (Maybe LanguageCode) Source #
The language code of the input documents.
sentimentDetectionJobProperties_jobId :: Lens' SentimentDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the sentiment detection job.
sentimentDetectionJobProperties_jobArn :: Lens' SentimentDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
sentimentDetectionJobProperties_jobName :: Lens' SentimentDetectionJobProperties (Maybe Text) Source #
The name that you assigned to the sentiment detection job
sentimentDetectionJobProperties_inputDataConfig :: Lens' SentimentDetectionJobProperties (Maybe InputDataConfig) Source #
The input data configuration that you supplied when you created the sentiment detection job.
sentimentDetectionJobProperties_vpcConfig :: Lens' SentimentDetectionJobProperties (Maybe VpcConfig) Source #
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.
sentimentDetectionJobProperties_volumeKmsKeyId :: Lens' SentimentDetectionJobProperties (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"
sentimentDetectionJobProperties_endTime :: Lens' SentimentDetectionJobProperties (Maybe UTCTime) Source #
The time that the sentiment detection job ended.
sentimentDetectionJobProperties_outputDataConfig :: Lens' SentimentDetectionJobProperties (Maybe OutputDataConfig) Source #
The output data configuration that you supplied when you created the sentiment detection job.
sentimentDetectionJobProperties_dataAccessRoleArn :: Lens' SentimentDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
sentimentDetectionJobProperties_jobStatus :: Lens' SentimentDetectionJobProperties (Maybe JobStatus) Source #
The current status of the sentiment detection job. If the status is
FAILED, the Messages field shows the reason for the failure.
sentimentDetectionJobProperties_message :: Lens' SentimentDetectionJobProperties (Maybe Text) Source #
A description of the status of a job.
sentimentDetectionJobProperties_submitTime :: Lens' SentimentDetectionJobProperties (Maybe UTCTime) Source #
The time that the sentiment detection job was submitted for processing.
SentimentScore
data SentimentScore Source #
Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.
See: newSentimentScore smart constructor.
Constructors
| SentimentScore' | |
Fields
| |
Instances
newSentimentScore :: SentimentScore Source #
Create a value of SentimentScore 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:mixed:SentimentScore', sentimentScore_mixed - The level of confidence that Amazon Comprehend has in the accuracy of
its detection of the MIXED sentiment.
$sel:negative:SentimentScore', sentimentScore_negative - The level of confidence that Amazon Comprehend has in the accuracy of
its detection of the NEGATIVE sentiment.
$sel:neutral:SentimentScore', sentimentScore_neutral - The level of confidence that Amazon Comprehend has in the accuracy of
its detection of the NEUTRAL sentiment.
$sel:positive:SentimentScore', sentimentScore_positive - The level of confidence that Amazon Comprehend has in the accuracy of
its detection of the POSITIVE sentiment.
sentimentScore_mixed :: Lens' SentimentScore (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of
its detection of the MIXED sentiment.
sentimentScore_negative :: Lens' SentimentScore (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of
its detection of the NEGATIVE sentiment.
sentimentScore_neutral :: Lens' SentimentScore (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of
its detection of the NEUTRAL sentiment.
sentimentScore_positive :: Lens' SentimentScore (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of
its detection of the POSITIVE sentiment.
SyntaxToken
data SyntaxToken Source #
Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.
See: newSyntaxToken smart constructor.
Constructors
| SyntaxToken' | |
Fields
| |
Instances
newSyntaxToken :: SyntaxToken Source #
Create a value of SyntaxToken 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:beginOffset:SyntaxToken', syntaxToken_beginOffset - The zero-based offset from the beginning of the source text to the first
character in the word.
$sel:text:SyntaxToken', syntaxToken_text - The word that was recognized in the source text.
$sel:tokenId:SyntaxToken', syntaxToken_tokenId - A unique identifier for a token.
$sel:endOffset:SyntaxToken', syntaxToken_endOffset - The zero-based offset from the beginning of the source text to the last
character in the word.
$sel:partOfSpeech:SyntaxToken', syntaxToken_partOfSpeech - Provides the part of speech label and the confidence level that Amazon
Comprehend has that the part of speech was correctly identified. For
more information, see how-syntax.
syntaxToken_beginOffset :: Lens' SyntaxToken (Maybe Int) Source #
The zero-based offset from the beginning of the source text to the first character in the word.
syntaxToken_text :: Lens' SyntaxToken (Maybe Text) Source #
The word that was recognized in the source text.
syntaxToken_tokenId :: Lens' SyntaxToken (Maybe Int) Source #
A unique identifier for a token.
syntaxToken_endOffset :: Lens' SyntaxToken (Maybe Int) Source #
The zero-based offset from the beginning of the source text to the last character in the word.
syntaxToken_partOfSpeech :: Lens' SyntaxToken (Maybe PartOfSpeechTag) Source #
Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see how-syntax.
Tag
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
See: newTag smart constructor.
Constructors
| Tag' | |
Fields
| |
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.Comprehend.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.Comprehend.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.Comprehend.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.Comprehend.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Comprehend.Types.Tag" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag 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:value:Tag', tag_value - The second part of a key-value pair that forms a tag associated with a
given resource. For instance, if you want to show which resources are
used by which departments, you might use “Department” as the initial
(key) portion of the pair, with a value of “sales” to indicate the sales
department.
$sel:key:Tag', tag_key - The initial part of a key-value pair that forms a tag associated with a
given resource. For instance, if you want to show which resources are
used by which departments, you might use “Department” as the key portion
of the pair, with multiple possible values such as “sales,” “legal,” and
“administration.”
tag_value :: Lens' Tag (Maybe Text) Source #
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
tag_key :: Lens' Tag Text Source #
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
TopicsDetectionJobFilter
data TopicsDetectionJobFilter Source #
Provides information for filtering topic detection jobs. For more information, see .
See: newTopicsDetectionJobFilter smart constructor.
Constructors
| TopicsDetectionJobFilter' | |
Fields
| |
Instances
newTopicsDetectionJobFilter :: TopicsDetectionJobFilter Source #
Create a value of TopicsDetectionJobFilter 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:submitTimeAfter:TopicsDetectionJobFilter', topicsDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted
for processing. Only returns jobs submitted after the specified time.
Jobs are returned in ascending order, oldest to newest.
$sel:submitTimeBefore:TopicsDetectionJobFilter', topicsDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted
for processing. Only returns jobs submitted before the specified time.
Jobs are returned in descending order, newest to oldest.
$sel:jobName:TopicsDetectionJobFilter', topicsDetectionJobFilter_jobName -
$sel:jobStatus:TopicsDetectionJobFilter', topicsDetectionJobFilter_jobStatus - Filters the list of topic detection jobs based on job status. Returns
only jobs with the specified status.
topicsDetectionJobFilter_submitTimeAfter :: Lens' TopicsDetectionJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.
topicsDetectionJobFilter_submitTimeBefore :: Lens' TopicsDetectionJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.
topicsDetectionJobFilter_jobStatus :: Lens' TopicsDetectionJobFilter (Maybe JobStatus) Source #
Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.
TopicsDetectionJobProperties
data TopicsDetectionJobProperties Source #
Provides information about a topic detection job.
See: newTopicsDetectionJobProperties smart constructor.
Constructors
| TopicsDetectionJobProperties' | |
Fields
| |
Instances
newTopicsDetectionJobProperties :: TopicsDetectionJobProperties Source #
Create a value of TopicsDetectionJobProperties 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:jobId:TopicsDetectionJobProperties', topicsDetectionJobProperties_jobId - The identifier assigned to the topic detection job.
$sel:jobArn:TopicsDetectionJobProperties', topicsDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the topics detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobName:TopicsDetectionJobProperties', topicsDetectionJobProperties_jobName - The name of the topic detection job.
$sel:inputDataConfig:TopicsDetectionJobProperties', topicsDetectionJobProperties_inputDataConfig - The input data configuration supplied when you created the topic
detection job.
$sel:vpcConfig:TopicsDetectionJobProperties', topicsDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your topic detection job. For
more information, see
Amazon VPC.
$sel:volumeKmsKeyId:TopicsDetectionJobProperties', topicsDetectionJobProperties_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:TopicsDetectionJobProperties', topicsDetectionJobProperties_endTime - The time that the topic detection job was completed.
$sel:outputDataConfig:TopicsDetectionJobProperties', topicsDetectionJobProperties_outputDataConfig - The output data configuration supplied when you created the topic
detection job.
$sel:dataAccessRoleArn:TopicsDetectionJobProperties', topicsDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM)
role that grants Amazon Comprehend read access to your job data.
$sel:numberOfTopics:TopicsDetectionJobProperties', topicsDetectionJobProperties_numberOfTopics - The number of topics to detect supplied when you created the topic
detection job. The default is 10.
$sel:jobStatus:TopicsDetectionJobProperties', topicsDetectionJobProperties_jobStatus - The current status of the topic detection job. If the status is
Failed, the reason for the failure is shown in the Message field.
$sel:message:TopicsDetectionJobProperties', topicsDetectionJobProperties_message - A description for the status of a job.
$sel:submitTime:TopicsDetectionJobProperties', topicsDetectionJobProperties_submitTime - The time that the topic detection job was submitted for processing.
topicsDetectionJobProperties_jobId :: Lens' TopicsDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the topic detection job.
topicsDetectionJobProperties_jobArn :: Lens' TopicsDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
topicsDetectionJobProperties_jobName :: Lens' TopicsDetectionJobProperties (Maybe Text) Source #
The name of the topic detection job.
topicsDetectionJobProperties_inputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe InputDataConfig) Source #
The input data configuration supplied when you created the topic detection job.
topicsDetectionJobProperties_vpcConfig :: Lens' TopicsDetectionJobProperties (Maybe VpcConfig) Source #
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
topicsDetectionJobProperties_volumeKmsKeyId :: Lens' TopicsDetectionJobProperties (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"
topicsDetectionJobProperties_endTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime) Source #
The time that the topic detection job was completed.
topicsDetectionJobProperties_outputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe OutputDataConfig) Source #
The output data configuration supplied when you created the topic detection job.
topicsDetectionJobProperties_dataAccessRoleArn :: Lens' TopicsDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
topicsDetectionJobProperties_numberOfTopics :: Lens' TopicsDetectionJobProperties (Maybe Int) Source #
The number of topics to detect supplied when you created the topic detection job. The default is 10.
topicsDetectionJobProperties_jobStatus :: Lens' TopicsDetectionJobProperties (Maybe JobStatus) Source #
The current status of the topic detection job. If the status is
Failed, the reason for the failure is shown in the Message field.
topicsDetectionJobProperties_message :: Lens' TopicsDetectionJobProperties (Maybe Text) Source #
A description for the status of a job.
topicsDetectionJobProperties_submitTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime) Source #
The time that the topic detection job was submitted for processing.
VpcConfig
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.
See: newVpcConfig smart constructor.
Constructors
| VpcConfig' | |
Fields
| |
Instances
| Eq VpcConfig Source # | |
| Read VpcConfig Source # | |
| Show VpcConfig Source # | |
| Generic VpcConfig Source # | |
| NFData VpcConfig Source # | |
Defined in Amazonka.Comprehend.Types.VpcConfig | |
| Hashable VpcConfig Source # | |
Defined in Amazonka.Comprehend.Types.VpcConfig | |
| ToJSON VpcConfig Source # | |
Defined in Amazonka.Comprehend.Types.VpcConfig | |
| FromJSON VpcConfig Source # | |
| type Rep VpcConfig Source # | |
Defined in Amazonka.Comprehend.Types.VpcConfig type Rep VpcConfig = D1 ('MetaData "VpcConfig" "Amazonka.Comprehend.Types.VpcConfig" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "VpcConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: S1 ('MetaSel ('Just "subnets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))) | |
Create a value of VpcConfig 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:securityGroupIds:VpcConfig', vpcConfig_securityGroupIds - The ID number for a security group on an instance of your private VPC.
Security groups on your VPC function serve as a virtual firewall to
control inbound and outbound traffic and provides security for the
resources that you’ll be accessing on the VPC. This ID number is
preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more
information, see
Security Groups for your VPC.
$sel:subnets:VpcConfig', vpcConfig_subnets - The ID for each subnet being used in your private VPC. This subnet is a
subset of the a range of IPv4 addresses used by the VPC and is specific
to a given availability zone in the VPC’s region. This ID number is
preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For
more information, see
VPCs and Subnets.
vpcConfig_securityGroupIds :: Lens' VpcConfig (NonEmpty Text) Source #
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
vpcConfig_subnets :: Lens' VpcConfig (NonEmpty Text) Source #
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.