Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Operations
- BatchDetectDominantLanguage
- BatchDetectEntities
- BatchDetectKeyPhrases
- BatchDetectSentiment
- BatchDetectSyntax
- BatchDetectTargetedSentiment
- ClassifyDocument
- ContainsPiiEntities
- CreateDocumentClassifier
- CreateEndpoint
- CreateEntityRecognizer
- DeleteDocumentClassifier
- DeleteEndpoint
- DeleteEntityRecognizer
- DeleteResourcePolicy
- DescribeDocumentClassificationJob
- DescribeDocumentClassifier
- DescribeDominantLanguageDetectionJob
- DescribeEndpoint
- DescribeEntitiesDetectionJob
- DescribeEntityRecognizer
- DescribeEventsDetectionJob
- DescribeKeyPhrasesDetectionJob
- DescribePiiEntitiesDetectionJob
- DescribeResourcePolicy
- DescribeSentimentDetectionJob
- DescribeTargetedSentimentDetectionJob
- DescribeTopicsDetectionJob
- DetectDominantLanguage
- DetectEntities
- DetectKeyPhrases
- DetectPiiEntities
- DetectSentiment
- DetectSyntax
- DetectTargetedSentiment
- ImportModel
- ListDocumentClassificationJobs
- ListDocumentClassifierSummaries
- ListDocumentClassifiers
- ListDominantLanguageDetectionJobs
- ListEndpoints
- ListEntitiesDetectionJobs
- ListEntityRecognizerSummaries
- ListEntityRecognizers
- ListEventsDetectionJobs
- ListKeyPhrasesDetectionJobs
- ListPiiEntitiesDetectionJobs
- ListSentimentDetectionJobs
- ListTagsForResource
- ListTargetedSentimentDetectionJobs
- ListTopicsDetectionJobs
- PutResourcePolicy
- StartDocumentClassificationJob
- StartDominantLanguageDetectionJob
- StartEntitiesDetectionJob
- StartEventsDetectionJob
- StartKeyPhrasesDetectionJob
- StartPiiEntitiesDetectionJob
- StartSentimentDetectionJob
- StartTargetedSentimentDetectionJob
- StartTopicsDetectionJob
- StopDominantLanguageDetectionJob
- StopEntitiesDetectionJob
- StopEventsDetectionJob
- StopKeyPhrasesDetectionJob
- StopPiiEntitiesDetectionJob
- StopSentimentDetectionJob
- StopTargetedSentimentDetectionJob
- StopTrainingDocumentClassifier
- StopTrainingEntityRecognizer
- TagResource
- UntagResource
- UpdateEndpoint
- Types
- AugmentedManifestsListItem
- BatchDetectDominantLanguageItemResult
- BatchDetectEntitiesItemResult
- BatchDetectKeyPhrasesItemResult
- BatchDetectSentimentItemResult
- BatchDetectSyntaxItemResult
- BatchDetectTargetedSentimentItemResult
- BatchItemError
- Block
- BlockReference
- BoundingBox
- ChildBlock
- ClassifierEvaluationMetrics
- ClassifierMetadata
- DocumentClass
- DocumentClassificationJobFilter
- DocumentClassificationJobProperties
- DocumentClassifierFilter
- DocumentClassifierInputDataConfig
- DocumentClassifierOutputDataConfig
- DocumentClassifierProperties
- DocumentClassifierSummary
- DocumentLabel
- DocumentMetadata
- DocumentReaderConfig
- DocumentTypeListItem
- DominantLanguage
- DominantLanguageDetectionJobFilter
- DominantLanguageDetectionJobProperties
- EndpointFilter
- EndpointProperties
- EntitiesDetectionJobFilter
- EntitiesDetectionJobProperties
- Entity
- EntityLabel
- EntityRecognizerAnnotations
- EntityRecognizerDocuments
- EntityRecognizerEntityList
- EntityRecognizerEvaluationMetrics
- EntityRecognizerFilter
- EntityRecognizerInputDataConfig
- EntityRecognizerMetadata
- EntityRecognizerMetadataEntityTypesListItem
- EntityRecognizerProperties
- EntityRecognizerSummary
- EntityTypesEvaluationMetrics
- EntityTypesListItem
- ErrorsListItem
- EventsDetectionJobFilter
- EventsDetectionJobProperties
- ExtractedCharactersListItem
- Geometry
- InputDataConfig
- KeyPhrase
- KeyPhrasesDetectionJobFilter
- KeyPhrasesDetectionJobProperties
- MentionSentiment
- OutputDataConfig
- PartOfSpeechTag
- PiiEntitiesDetectionJobFilter
- PiiEntitiesDetectionJobProperties
- PiiEntity
- PiiOutputDataConfig
- Point
- RedactionConfig
- RelationshipsListItem
- SentimentDetectionJobFilter
- SentimentDetectionJobProperties
- SentimentScore
- SyntaxToken
- Tag
- TargetedSentimentDetectionJobFilter
- TargetedSentimentDetectionJobProperties
- TargetedSentimentEntity
- TargetedSentimentMention
- TopicsDetectionJobFilter
- TopicsDetectionJobProperties
- VpcConfig
Synopsis
- batchDetectDominantLanguage_textList :: Lens' BatchDetectDominantLanguage (NonEmpty Text)
- batchDetectDominantLanguageResponse_httpStatus :: Lens' BatchDetectDominantLanguageResponse Int
- batchDetectDominantLanguageResponse_resultList :: Lens' BatchDetectDominantLanguageResponse [BatchDetectDominantLanguageItemResult]
- batchDetectDominantLanguageResponse_errorList :: Lens' BatchDetectDominantLanguageResponse [BatchItemError]
- batchDetectEntities_textList :: Lens' BatchDetectEntities (NonEmpty Text)
- batchDetectEntities_languageCode :: Lens' BatchDetectEntities LanguageCode
- batchDetectEntitiesResponse_httpStatus :: Lens' BatchDetectEntitiesResponse Int
- batchDetectEntitiesResponse_resultList :: Lens' BatchDetectEntitiesResponse [BatchDetectEntitiesItemResult]
- batchDetectEntitiesResponse_errorList :: Lens' BatchDetectEntitiesResponse [BatchItemError]
- batchDetectKeyPhrases_textList :: Lens' BatchDetectKeyPhrases (NonEmpty Text)
- batchDetectKeyPhrases_languageCode :: Lens' BatchDetectKeyPhrases LanguageCode
- batchDetectKeyPhrasesResponse_httpStatus :: Lens' BatchDetectKeyPhrasesResponse Int
- batchDetectKeyPhrasesResponse_resultList :: Lens' BatchDetectKeyPhrasesResponse [BatchDetectKeyPhrasesItemResult]
- batchDetectKeyPhrasesResponse_errorList :: Lens' BatchDetectKeyPhrasesResponse [BatchItemError]
- batchDetectSentiment_textList :: Lens' BatchDetectSentiment (NonEmpty Text)
- batchDetectSentiment_languageCode :: Lens' BatchDetectSentiment LanguageCode
- batchDetectSentimentResponse_httpStatus :: Lens' BatchDetectSentimentResponse Int
- batchDetectSentimentResponse_resultList :: Lens' BatchDetectSentimentResponse [BatchDetectSentimentItemResult]
- batchDetectSentimentResponse_errorList :: Lens' BatchDetectSentimentResponse [BatchItemError]
- batchDetectSyntax_textList :: Lens' BatchDetectSyntax (NonEmpty Text)
- batchDetectSyntax_languageCode :: Lens' BatchDetectSyntax SyntaxLanguageCode
- batchDetectSyntaxResponse_httpStatus :: Lens' BatchDetectSyntaxResponse Int
- batchDetectSyntaxResponse_resultList :: Lens' BatchDetectSyntaxResponse [BatchDetectSyntaxItemResult]
- batchDetectSyntaxResponse_errorList :: Lens' BatchDetectSyntaxResponse [BatchItemError]
- batchDetectTargetedSentiment_textList :: Lens' BatchDetectTargetedSentiment (NonEmpty Text)
- batchDetectTargetedSentiment_languageCode :: Lens' BatchDetectTargetedSentiment LanguageCode
- batchDetectTargetedSentimentResponse_httpStatus :: Lens' BatchDetectTargetedSentimentResponse Int
- batchDetectTargetedSentimentResponse_resultList :: Lens' BatchDetectTargetedSentimentResponse [BatchDetectTargetedSentimentItemResult]
- batchDetectTargetedSentimentResponse_errorList :: Lens' BatchDetectTargetedSentimentResponse [BatchItemError]
- classifyDocument_bytes :: Lens' ClassifyDocument (Maybe ByteString)
- classifyDocument_documentReaderConfig :: Lens' ClassifyDocument (Maybe DocumentReaderConfig)
- classifyDocument_text :: Lens' ClassifyDocument (Maybe Text)
- classifyDocument_endpointArn :: Lens' ClassifyDocument Text
- classifyDocumentResponse_classes :: Lens' ClassifyDocumentResponse (Maybe [DocumentClass])
- classifyDocumentResponse_documentMetadata :: Lens' ClassifyDocumentResponse (Maybe DocumentMetadata)
- classifyDocumentResponse_documentType :: Lens' ClassifyDocumentResponse (Maybe [DocumentTypeListItem])
- classifyDocumentResponse_errors :: Lens' ClassifyDocumentResponse (Maybe [ErrorsListItem])
- classifyDocumentResponse_labels :: Lens' ClassifyDocumentResponse (Maybe [DocumentLabel])
- classifyDocumentResponse_httpStatus :: Lens' ClassifyDocumentResponse Int
- containsPiiEntities_text :: Lens' ContainsPiiEntities Text
- containsPiiEntities_languageCode :: Lens' ContainsPiiEntities LanguageCode
- containsPiiEntitiesResponse_labels :: Lens' ContainsPiiEntitiesResponse (Maybe [EntityLabel])
- containsPiiEntitiesResponse_httpStatus :: Lens' ContainsPiiEntitiesResponse Int
- createDocumentClassifier_clientRequestToken :: Lens' CreateDocumentClassifier (Maybe Text)
- createDocumentClassifier_mode :: Lens' CreateDocumentClassifier (Maybe DocumentClassifierMode)
- createDocumentClassifier_modelKmsKeyId :: Lens' CreateDocumentClassifier (Maybe Text)
- createDocumentClassifier_modelPolicy :: Lens' CreateDocumentClassifier (Maybe Text)
- createDocumentClassifier_outputDataConfig :: Lens' CreateDocumentClassifier (Maybe DocumentClassifierOutputDataConfig)
- createDocumentClassifier_tags :: Lens' CreateDocumentClassifier (Maybe [Tag])
- createDocumentClassifier_versionName :: Lens' CreateDocumentClassifier (Maybe Text)
- createDocumentClassifier_volumeKmsKeyId :: Lens' CreateDocumentClassifier (Maybe Text)
- createDocumentClassifier_vpcConfig :: Lens' CreateDocumentClassifier (Maybe VpcConfig)
- createDocumentClassifier_documentClassifierName :: Lens' CreateDocumentClassifier Text
- createDocumentClassifier_dataAccessRoleArn :: Lens' CreateDocumentClassifier Text
- createDocumentClassifier_inputDataConfig :: Lens' CreateDocumentClassifier DocumentClassifierInputDataConfig
- createDocumentClassifier_languageCode :: Lens' CreateDocumentClassifier LanguageCode
- createDocumentClassifierResponse_documentClassifierArn :: Lens' CreateDocumentClassifierResponse (Maybe Text)
- createDocumentClassifierResponse_httpStatus :: Lens' CreateDocumentClassifierResponse Int
- createEndpoint_clientRequestToken :: Lens' CreateEndpoint (Maybe Text)
- createEndpoint_dataAccessRoleArn :: Lens' CreateEndpoint (Maybe Text)
- createEndpoint_tags :: Lens' CreateEndpoint (Maybe [Tag])
- createEndpoint_endpointName :: Lens' CreateEndpoint Text
- createEndpoint_modelArn :: Lens' CreateEndpoint Text
- createEndpoint_desiredInferenceUnits :: Lens' CreateEndpoint Natural
- createEndpointResponse_endpointArn :: Lens' CreateEndpointResponse (Maybe Text)
- createEndpointResponse_httpStatus :: Lens' CreateEndpointResponse Int
- createEntityRecognizer_clientRequestToken :: Lens' CreateEntityRecognizer (Maybe Text)
- createEntityRecognizer_modelKmsKeyId :: Lens' CreateEntityRecognizer (Maybe Text)
- createEntityRecognizer_modelPolicy :: Lens' CreateEntityRecognizer (Maybe Text)
- createEntityRecognizer_tags :: Lens' CreateEntityRecognizer (Maybe [Tag])
- createEntityRecognizer_versionName :: Lens' CreateEntityRecognizer (Maybe Text)
- createEntityRecognizer_volumeKmsKeyId :: Lens' CreateEntityRecognizer (Maybe Text)
- createEntityRecognizer_vpcConfig :: Lens' CreateEntityRecognizer (Maybe VpcConfig)
- createEntityRecognizer_recognizerName :: Lens' CreateEntityRecognizer Text
- createEntityRecognizer_dataAccessRoleArn :: Lens' CreateEntityRecognizer Text
- createEntityRecognizer_inputDataConfig :: Lens' CreateEntityRecognizer EntityRecognizerInputDataConfig
- createEntityRecognizer_languageCode :: Lens' CreateEntityRecognizer LanguageCode
- createEntityRecognizerResponse_entityRecognizerArn :: Lens' CreateEntityRecognizerResponse (Maybe Text)
- createEntityRecognizerResponse_httpStatus :: Lens' CreateEntityRecognizerResponse Int
- deleteDocumentClassifier_documentClassifierArn :: Lens' DeleteDocumentClassifier Text
- deleteDocumentClassifierResponse_httpStatus :: Lens' DeleteDocumentClassifierResponse Int
- deleteEndpoint_endpointArn :: Lens' DeleteEndpoint Text
- deleteEndpointResponse_httpStatus :: Lens' DeleteEndpointResponse Int
- deleteEntityRecognizer_entityRecognizerArn :: Lens' DeleteEntityRecognizer Text
- deleteEntityRecognizerResponse_httpStatus :: Lens' DeleteEntityRecognizerResponse Int
- deleteResourcePolicy_policyRevisionId :: Lens' DeleteResourcePolicy (Maybe Text)
- deleteResourcePolicy_resourceArn :: Lens' DeleteResourcePolicy Text
- deleteResourcePolicyResponse_httpStatus :: Lens' DeleteResourcePolicyResponse Int
- describeDocumentClassificationJob_jobId :: Lens' DescribeDocumentClassificationJob Text
- describeDocumentClassificationJobResponse_documentClassificationJobProperties :: Lens' DescribeDocumentClassificationJobResponse (Maybe DocumentClassificationJobProperties)
- describeDocumentClassificationJobResponse_httpStatus :: Lens' DescribeDocumentClassificationJobResponse Int
- describeDocumentClassifier_documentClassifierArn :: Lens' DescribeDocumentClassifier Text
- describeDocumentClassifierResponse_documentClassifierProperties :: Lens' DescribeDocumentClassifierResponse (Maybe DocumentClassifierProperties)
- describeDocumentClassifierResponse_httpStatus :: Lens' DescribeDocumentClassifierResponse Int
- describeDominantLanguageDetectionJob_jobId :: Lens' DescribeDominantLanguageDetectionJob Text
- describeDominantLanguageDetectionJobResponse_dominantLanguageDetectionJobProperties :: Lens' DescribeDominantLanguageDetectionJobResponse (Maybe DominantLanguageDetectionJobProperties)
- describeDominantLanguageDetectionJobResponse_httpStatus :: Lens' DescribeDominantLanguageDetectionJobResponse Int
- describeEndpoint_endpointArn :: Lens' DescribeEndpoint Text
- describeEndpointResponse_endpointProperties :: Lens' DescribeEndpointResponse (Maybe EndpointProperties)
- describeEndpointResponse_httpStatus :: Lens' DescribeEndpointResponse Int
- describeEntitiesDetectionJob_jobId :: Lens' DescribeEntitiesDetectionJob Text
- describeEntitiesDetectionJobResponse_entitiesDetectionJobProperties :: Lens' DescribeEntitiesDetectionJobResponse (Maybe EntitiesDetectionJobProperties)
- describeEntitiesDetectionJobResponse_httpStatus :: Lens' DescribeEntitiesDetectionJobResponse Int
- describeEntityRecognizer_entityRecognizerArn :: Lens' DescribeEntityRecognizer Text
- describeEntityRecognizerResponse_entityRecognizerProperties :: Lens' DescribeEntityRecognizerResponse (Maybe EntityRecognizerProperties)
- describeEntityRecognizerResponse_httpStatus :: Lens' DescribeEntityRecognizerResponse Int
- describeEventsDetectionJob_jobId :: Lens' DescribeEventsDetectionJob Text
- describeEventsDetectionJobResponse_eventsDetectionJobProperties :: Lens' DescribeEventsDetectionJobResponse (Maybe EventsDetectionJobProperties)
- describeEventsDetectionJobResponse_httpStatus :: Lens' DescribeEventsDetectionJobResponse Int
- describeKeyPhrasesDetectionJob_jobId :: Lens' DescribeKeyPhrasesDetectionJob Text
- describeKeyPhrasesDetectionJobResponse_keyPhrasesDetectionJobProperties :: Lens' DescribeKeyPhrasesDetectionJobResponse (Maybe KeyPhrasesDetectionJobProperties)
- describeKeyPhrasesDetectionJobResponse_httpStatus :: Lens' DescribeKeyPhrasesDetectionJobResponse Int
- describePiiEntitiesDetectionJob_jobId :: Lens' DescribePiiEntitiesDetectionJob Text
- describePiiEntitiesDetectionJobResponse_piiEntitiesDetectionJobProperties :: Lens' DescribePiiEntitiesDetectionJobResponse (Maybe PiiEntitiesDetectionJobProperties)
- describePiiEntitiesDetectionJobResponse_httpStatus :: Lens' DescribePiiEntitiesDetectionJobResponse Int
- describeResourcePolicy_resourceArn :: Lens' DescribeResourcePolicy Text
- describeResourcePolicyResponse_creationTime :: Lens' DescribeResourcePolicyResponse (Maybe UTCTime)
- describeResourcePolicyResponse_lastModifiedTime :: Lens' DescribeResourcePolicyResponse (Maybe UTCTime)
- describeResourcePolicyResponse_policyRevisionId :: Lens' DescribeResourcePolicyResponse (Maybe Text)
- describeResourcePolicyResponse_resourcePolicy :: Lens' DescribeResourcePolicyResponse (Maybe Text)
- describeResourcePolicyResponse_httpStatus :: Lens' DescribeResourcePolicyResponse Int
- describeSentimentDetectionJob_jobId :: Lens' DescribeSentimentDetectionJob Text
- describeSentimentDetectionJobResponse_sentimentDetectionJobProperties :: Lens' DescribeSentimentDetectionJobResponse (Maybe SentimentDetectionJobProperties)
- describeSentimentDetectionJobResponse_httpStatus :: Lens' DescribeSentimentDetectionJobResponse Int
- describeTargetedSentimentDetectionJob_jobId :: Lens' DescribeTargetedSentimentDetectionJob Text
- describeTargetedSentimentDetectionJobResponse_targetedSentimentDetectionJobProperties :: Lens' DescribeTargetedSentimentDetectionJobResponse (Maybe TargetedSentimentDetectionJobProperties)
- describeTargetedSentimentDetectionJobResponse_httpStatus :: Lens' DescribeTargetedSentimentDetectionJobResponse Int
- describeTopicsDetectionJob_jobId :: Lens' DescribeTopicsDetectionJob Text
- describeTopicsDetectionJobResponse_topicsDetectionJobProperties :: Lens' DescribeTopicsDetectionJobResponse (Maybe TopicsDetectionJobProperties)
- describeTopicsDetectionJobResponse_httpStatus :: Lens' DescribeTopicsDetectionJobResponse Int
- detectDominantLanguage_text :: Lens' DetectDominantLanguage Text
- detectDominantLanguageResponse_languages :: Lens' DetectDominantLanguageResponse (Maybe [DominantLanguage])
- detectDominantLanguageResponse_httpStatus :: Lens' DetectDominantLanguageResponse Int
- detectEntities_bytes :: Lens' DetectEntities (Maybe ByteString)
- detectEntities_documentReaderConfig :: Lens' DetectEntities (Maybe DocumentReaderConfig)
- detectEntities_endpointArn :: Lens' DetectEntities (Maybe Text)
- detectEntities_languageCode :: Lens' DetectEntities (Maybe LanguageCode)
- detectEntities_text :: Lens' DetectEntities (Maybe Text)
- detectEntitiesResponse_blocks :: Lens' DetectEntitiesResponse (Maybe [Block])
- detectEntitiesResponse_documentMetadata :: Lens' DetectEntitiesResponse (Maybe DocumentMetadata)
- detectEntitiesResponse_documentType :: Lens' DetectEntitiesResponse (Maybe [DocumentTypeListItem])
- detectEntitiesResponse_entities :: Lens' DetectEntitiesResponse (Maybe [Entity])
- detectEntitiesResponse_errors :: Lens' DetectEntitiesResponse (Maybe [ErrorsListItem])
- detectEntitiesResponse_httpStatus :: Lens' DetectEntitiesResponse Int
- detectKeyPhrases_text :: Lens' DetectKeyPhrases Text
- detectKeyPhrases_languageCode :: Lens' DetectKeyPhrases LanguageCode
- detectKeyPhrasesResponse_keyPhrases :: Lens' DetectKeyPhrasesResponse (Maybe [KeyPhrase])
- detectKeyPhrasesResponse_httpStatus :: Lens' DetectKeyPhrasesResponse Int
- detectPiiEntities_text :: Lens' DetectPiiEntities Text
- detectPiiEntities_languageCode :: Lens' DetectPiiEntities LanguageCode
- detectPiiEntitiesResponse_entities :: Lens' DetectPiiEntitiesResponse (Maybe [PiiEntity])
- detectPiiEntitiesResponse_httpStatus :: Lens' DetectPiiEntitiesResponse Int
- detectSentiment_text :: Lens' DetectSentiment Text
- detectSentiment_languageCode :: Lens' DetectSentiment LanguageCode
- detectSentimentResponse_sentiment :: Lens' DetectSentimentResponse (Maybe SentimentType)
- detectSentimentResponse_sentimentScore :: Lens' DetectSentimentResponse (Maybe SentimentScore)
- detectSentimentResponse_httpStatus :: Lens' DetectSentimentResponse Int
- detectSyntax_text :: Lens' DetectSyntax Text
- detectSyntax_languageCode :: Lens' DetectSyntax SyntaxLanguageCode
- detectSyntaxResponse_syntaxTokens :: Lens' DetectSyntaxResponse (Maybe [SyntaxToken])
- detectSyntaxResponse_httpStatus :: Lens' DetectSyntaxResponse Int
- detectTargetedSentiment_text :: Lens' DetectTargetedSentiment Text
- detectTargetedSentiment_languageCode :: Lens' DetectTargetedSentiment LanguageCode
- detectTargetedSentimentResponse_entities :: Lens' DetectTargetedSentimentResponse (Maybe [TargetedSentimentEntity])
- detectTargetedSentimentResponse_httpStatus :: Lens' DetectTargetedSentimentResponse Int
- importModel_dataAccessRoleArn :: Lens' ImportModel (Maybe Text)
- importModel_modelKmsKeyId :: Lens' ImportModel (Maybe Text)
- importModel_modelName :: Lens' ImportModel (Maybe Text)
- importModel_tags :: Lens' ImportModel (Maybe [Tag])
- importModel_versionName :: Lens' ImportModel (Maybe Text)
- importModel_sourceModelArn :: Lens' ImportModel Text
- importModelResponse_modelArn :: Lens' ImportModelResponse (Maybe Text)
- importModelResponse_httpStatus :: Lens' ImportModelResponse Int
- listDocumentClassificationJobs_filter :: Lens' ListDocumentClassificationJobs (Maybe DocumentClassificationJobFilter)
- listDocumentClassificationJobs_maxResults :: Lens' ListDocumentClassificationJobs (Maybe Natural)
- listDocumentClassificationJobs_nextToken :: Lens' ListDocumentClassificationJobs (Maybe Text)
- listDocumentClassificationJobsResponse_documentClassificationJobPropertiesList :: Lens' ListDocumentClassificationJobsResponse (Maybe [DocumentClassificationJobProperties])
- listDocumentClassificationJobsResponse_nextToken :: Lens' ListDocumentClassificationJobsResponse (Maybe Text)
- listDocumentClassificationJobsResponse_httpStatus :: Lens' ListDocumentClassificationJobsResponse Int
- listDocumentClassifierSummaries_maxResults :: Lens' ListDocumentClassifierSummaries (Maybe Natural)
- listDocumentClassifierSummaries_nextToken :: Lens' ListDocumentClassifierSummaries (Maybe Text)
- listDocumentClassifierSummariesResponse_documentClassifierSummariesList :: Lens' ListDocumentClassifierSummariesResponse (Maybe [DocumentClassifierSummary])
- listDocumentClassifierSummariesResponse_nextToken :: Lens' ListDocumentClassifierSummariesResponse (Maybe Text)
- listDocumentClassifierSummariesResponse_httpStatus :: Lens' ListDocumentClassifierSummariesResponse Int
- listDocumentClassifiers_filter :: Lens' ListDocumentClassifiers (Maybe DocumentClassifierFilter)
- listDocumentClassifiers_maxResults :: Lens' ListDocumentClassifiers (Maybe Natural)
- listDocumentClassifiers_nextToken :: Lens' ListDocumentClassifiers (Maybe Text)
- listDocumentClassifiersResponse_documentClassifierPropertiesList :: Lens' ListDocumentClassifiersResponse (Maybe [DocumentClassifierProperties])
- listDocumentClassifiersResponse_nextToken :: Lens' ListDocumentClassifiersResponse (Maybe Text)
- listDocumentClassifiersResponse_httpStatus :: Lens' ListDocumentClassifiersResponse Int
- listDominantLanguageDetectionJobs_filter :: Lens' ListDominantLanguageDetectionJobs (Maybe DominantLanguageDetectionJobFilter)
- listDominantLanguageDetectionJobs_maxResults :: Lens' ListDominantLanguageDetectionJobs (Maybe Natural)
- listDominantLanguageDetectionJobs_nextToken :: Lens' ListDominantLanguageDetectionJobs (Maybe Text)
- listDominantLanguageDetectionJobsResponse_dominantLanguageDetectionJobPropertiesList :: Lens' ListDominantLanguageDetectionJobsResponse (Maybe [DominantLanguageDetectionJobProperties])
- listDominantLanguageDetectionJobsResponse_nextToken :: Lens' ListDominantLanguageDetectionJobsResponse (Maybe Text)
- listDominantLanguageDetectionJobsResponse_httpStatus :: Lens' ListDominantLanguageDetectionJobsResponse Int
- listEndpoints_filter :: Lens' ListEndpoints (Maybe EndpointFilter)
- listEndpoints_maxResults :: Lens' ListEndpoints (Maybe Natural)
- listEndpoints_nextToken :: Lens' ListEndpoints (Maybe Text)
- listEndpointsResponse_endpointPropertiesList :: Lens' ListEndpointsResponse (Maybe [EndpointProperties])
- listEndpointsResponse_nextToken :: Lens' ListEndpointsResponse (Maybe Text)
- listEndpointsResponse_httpStatus :: Lens' ListEndpointsResponse Int
- listEntitiesDetectionJobs_filter :: Lens' ListEntitiesDetectionJobs (Maybe EntitiesDetectionJobFilter)
- listEntitiesDetectionJobs_maxResults :: Lens' ListEntitiesDetectionJobs (Maybe Natural)
- listEntitiesDetectionJobs_nextToken :: Lens' ListEntitiesDetectionJobs (Maybe Text)
- listEntitiesDetectionJobsResponse_entitiesDetectionJobPropertiesList :: Lens' ListEntitiesDetectionJobsResponse (Maybe [EntitiesDetectionJobProperties])
- listEntitiesDetectionJobsResponse_nextToken :: Lens' ListEntitiesDetectionJobsResponse (Maybe Text)
- listEntitiesDetectionJobsResponse_httpStatus :: Lens' ListEntitiesDetectionJobsResponse Int
- listEntityRecognizerSummaries_maxResults :: Lens' ListEntityRecognizerSummaries (Maybe Natural)
- listEntityRecognizerSummaries_nextToken :: Lens' ListEntityRecognizerSummaries (Maybe Text)
- listEntityRecognizerSummariesResponse_entityRecognizerSummariesList :: Lens' ListEntityRecognizerSummariesResponse (Maybe [EntityRecognizerSummary])
- listEntityRecognizerSummariesResponse_nextToken :: Lens' ListEntityRecognizerSummariesResponse (Maybe Text)
- listEntityRecognizerSummariesResponse_httpStatus :: Lens' ListEntityRecognizerSummariesResponse Int
- listEntityRecognizers_filter :: Lens' ListEntityRecognizers (Maybe EntityRecognizerFilter)
- listEntityRecognizers_maxResults :: Lens' ListEntityRecognizers (Maybe Natural)
- listEntityRecognizers_nextToken :: Lens' ListEntityRecognizers (Maybe Text)
- listEntityRecognizersResponse_entityRecognizerPropertiesList :: Lens' ListEntityRecognizersResponse (Maybe [EntityRecognizerProperties])
- listEntityRecognizersResponse_nextToken :: Lens' ListEntityRecognizersResponse (Maybe Text)
- listEntityRecognizersResponse_httpStatus :: Lens' ListEntityRecognizersResponse Int
- listEventsDetectionJobs_filter :: Lens' ListEventsDetectionJobs (Maybe EventsDetectionJobFilter)
- listEventsDetectionJobs_maxResults :: Lens' ListEventsDetectionJobs (Maybe Natural)
- listEventsDetectionJobs_nextToken :: Lens' ListEventsDetectionJobs (Maybe Text)
- listEventsDetectionJobsResponse_eventsDetectionJobPropertiesList :: Lens' ListEventsDetectionJobsResponse (Maybe [EventsDetectionJobProperties])
- listEventsDetectionJobsResponse_nextToken :: Lens' ListEventsDetectionJobsResponse (Maybe Text)
- listEventsDetectionJobsResponse_httpStatus :: Lens' ListEventsDetectionJobsResponse Int
- listKeyPhrasesDetectionJobs_filter :: Lens' ListKeyPhrasesDetectionJobs (Maybe KeyPhrasesDetectionJobFilter)
- listKeyPhrasesDetectionJobs_maxResults :: Lens' ListKeyPhrasesDetectionJobs (Maybe Natural)
- listKeyPhrasesDetectionJobs_nextToken :: Lens' ListKeyPhrasesDetectionJobs (Maybe Text)
- listKeyPhrasesDetectionJobsResponse_keyPhrasesDetectionJobPropertiesList :: Lens' ListKeyPhrasesDetectionJobsResponse (Maybe [KeyPhrasesDetectionJobProperties])
- listKeyPhrasesDetectionJobsResponse_nextToken :: Lens' ListKeyPhrasesDetectionJobsResponse (Maybe Text)
- listKeyPhrasesDetectionJobsResponse_httpStatus :: Lens' ListKeyPhrasesDetectionJobsResponse Int
- listPiiEntitiesDetectionJobs_filter :: Lens' ListPiiEntitiesDetectionJobs (Maybe PiiEntitiesDetectionJobFilter)
- listPiiEntitiesDetectionJobs_maxResults :: Lens' ListPiiEntitiesDetectionJobs (Maybe Natural)
- listPiiEntitiesDetectionJobs_nextToken :: Lens' ListPiiEntitiesDetectionJobs (Maybe Text)
- listPiiEntitiesDetectionJobsResponse_nextToken :: Lens' ListPiiEntitiesDetectionJobsResponse (Maybe Text)
- listPiiEntitiesDetectionJobsResponse_piiEntitiesDetectionJobPropertiesList :: Lens' ListPiiEntitiesDetectionJobsResponse (Maybe [PiiEntitiesDetectionJobProperties])
- listPiiEntitiesDetectionJobsResponse_httpStatus :: Lens' ListPiiEntitiesDetectionJobsResponse Int
- listSentimentDetectionJobs_filter :: Lens' ListSentimentDetectionJobs (Maybe SentimentDetectionJobFilter)
- listSentimentDetectionJobs_maxResults :: Lens' ListSentimentDetectionJobs (Maybe Natural)
- listSentimentDetectionJobs_nextToken :: Lens' ListSentimentDetectionJobs (Maybe Text)
- listSentimentDetectionJobsResponse_nextToken :: Lens' ListSentimentDetectionJobsResponse (Maybe Text)
- listSentimentDetectionJobsResponse_sentimentDetectionJobPropertiesList :: Lens' ListSentimentDetectionJobsResponse (Maybe [SentimentDetectionJobProperties])
- listSentimentDetectionJobsResponse_httpStatus :: Lens' ListSentimentDetectionJobsResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_resourceArn :: Lens' ListTagsForResourceResponse (Maybe Text)
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- listTargetedSentimentDetectionJobs_filter :: Lens' ListTargetedSentimentDetectionJobs (Maybe TargetedSentimentDetectionJobFilter)
- listTargetedSentimentDetectionJobs_maxResults :: Lens' ListTargetedSentimentDetectionJobs (Maybe Natural)
- listTargetedSentimentDetectionJobs_nextToken :: Lens' ListTargetedSentimentDetectionJobs (Maybe Text)
- listTargetedSentimentDetectionJobsResponse_nextToken :: Lens' ListTargetedSentimentDetectionJobsResponse (Maybe Text)
- listTargetedSentimentDetectionJobsResponse_targetedSentimentDetectionJobPropertiesList :: Lens' ListTargetedSentimentDetectionJobsResponse (Maybe [TargetedSentimentDetectionJobProperties])
- listTargetedSentimentDetectionJobsResponse_httpStatus :: Lens' ListTargetedSentimentDetectionJobsResponse Int
- listTopicsDetectionJobs_filter :: Lens' ListTopicsDetectionJobs (Maybe TopicsDetectionJobFilter)
- listTopicsDetectionJobs_maxResults :: Lens' ListTopicsDetectionJobs (Maybe Natural)
- listTopicsDetectionJobs_nextToken :: Lens' ListTopicsDetectionJobs (Maybe Text)
- listTopicsDetectionJobsResponse_nextToken :: Lens' ListTopicsDetectionJobsResponse (Maybe Text)
- listTopicsDetectionJobsResponse_topicsDetectionJobPropertiesList :: Lens' ListTopicsDetectionJobsResponse (Maybe [TopicsDetectionJobProperties])
- listTopicsDetectionJobsResponse_httpStatus :: Lens' ListTopicsDetectionJobsResponse Int
- putResourcePolicy_policyRevisionId :: Lens' PutResourcePolicy (Maybe Text)
- putResourcePolicy_resourceArn :: Lens' PutResourcePolicy Text
- putResourcePolicy_resourcePolicy :: Lens' PutResourcePolicy Text
- putResourcePolicyResponse_policyRevisionId :: Lens' PutResourcePolicyResponse (Maybe Text)
- putResourcePolicyResponse_httpStatus :: Lens' PutResourcePolicyResponse Int
- startDocumentClassificationJob_clientRequestToken :: Lens' StartDocumentClassificationJob (Maybe Text)
- startDocumentClassificationJob_jobName :: Lens' StartDocumentClassificationJob (Maybe Text)
- startDocumentClassificationJob_tags :: Lens' StartDocumentClassificationJob (Maybe [Tag])
- startDocumentClassificationJob_volumeKmsKeyId :: Lens' StartDocumentClassificationJob (Maybe Text)
- startDocumentClassificationJob_vpcConfig :: Lens' StartDocumentClassificationJob (Maybe VpcConfig)
- startDocumentClassificationJob_documentClassifierArn :: Lens' StartDocumentClassificationJob Text
- startDocumentClassificationJob_inputDataConfig :: Lens' StartDocumentClassificationJob InputDataConfig
- startDocumentClassificationJob_outputDataConfig :: Lens' StartDocumentClassificationJob OutputDataConfig
- startDocumentClassificationJob_dataAccessRoleArn :: Lens' StartDocumentClassificationJob Text
- startDocumentClassificationJobResponse_jobArn :: Lens' StartDocumentClassificationJobResponse (Maybe Text)
- startDocumentClassificationJobResponse_jobId :: Lens' StartDocumentClassificationJobResponse (Maybe Text)
- startDocumentClassificationJobResponse_jobStatus :: Lens' StartDocumentClassificationJobResponse (Maybe JobStatus)
- startDocumentClassificationJobResponse_httpStatus :: Lens' StartDocumentClassificationJobResponse Int
- startDominantLanguageDetectionJob_clientRequestToken :: Lens' StartDominantLanguageDetectionJob (Maybe Text)
- startDominantLanguageDetectionJob_jobName :: Lens' StartDominantLanguageDetectionJob (Maybe Text)
- startDominantLanguageDetectionJob_tags :: Lens' StartDominantLanguageDetectionJob (Maybe [Tag])
- startDominantLanguageDetectionJob_volumeKmsKeyId :: Lens' StartDominantLanguageDetectionJob (Maybe Text)
- startDominantLanguageDetectionJob_vpcConfig :: Lens' StartDominantLanguageDetectionJob (Maybe VpcConfig)
- startDominantLanguageDetectionJob_inputDataConfig :: Lens' StartDominantLanguageDetectionJob InputDataConfig
- startDominantLanguageDetectionJob_outputDataConfig :: Lens' StartDominantLanguageDetectionJob OutputDataConfig
- startDominantLanguageDetectionJob_dataAccessRoleArn :: Lens' StartDominantLanguageDetectionJob Text
- startDominantLanguageDetectionJobResponse_jobArn :: Lens' StartDominantLanguageDetectionJobResponse (Maybe Text)
- startDominantLanguageDetectionJobResponse_jobId :: Lens' StartDominantLanguageDetectionJobResponse (Maybe Text)
- startDominantLanguageDetectionJobResponse_jobStatus :: Lens' StartDominantLanguageDetectionJobResponse (Maybe JobStatus)
- startDominantLanguageDetectionJobResponse_httpStatus :: Lens' StartDominantLanguageDetectionJobResponse Int
- startEntitiesDetectionJob_clientRequestToken :: Lens' StartEntitiesDetectionJob (Maybe Text)
- startEntitiesDetectionJob_entityRecognizerArn :: Lens' StartEntitiesDetectionJob (Maybe Text)
- startEntitiesDetectionJob_jobName :: Lens' StartEntitiesDetectionJob (Maybe Text)
- startEntitiesDetectionJob_tags :: Lens' StartEntitiesDetectionJob (Maybe [Tag])
- startEntitiesDetectionJob_volumeKmsKeyId :: Lens' StartEntitiesDetectionJob (Maybe Text)
- startEntitiesDetectionJob_vpcConfig :: Lens' StartEntitiesDetectionJob (Maybe VpcConfig)
- startEntitiesDetectionJob_inputDataConfig :: Lens' StartEntitiesDetectionJob InputDataConfig
- startEntitiesDetectionJob_outputDataConfig :: Lens' StartEntitiesDetectionJob OutputDataConfig
- startEntitiesDetectionJob_dataAccessRoleArn :: Lens' StartEntitiesDetectionJob Text
- startEntitiesDetectionJob_languageCode :: Lens' StartEntitiesDetectionJob LanguageCode
- startEntitiesDetectionJobResponse_jobArn :: Lens' StartEntitiesDetectionJobResponse (Maybe Text)
- startEntitiesDetectionJobResponse_jobId :: Lens' StartEntitiesDetectionJobResponse (Maybe Text)
- startEntitiesDetectionJobResponse_jobStatus :: Lens' StartEntitiesDetectionJobResponse (Maybe JobStatus)
- startEntitiesDetectionJobResponse_httpStatus :: Lens' StartEntitiesDetectionJobResponse Int
- startEventsDetectionJob_clientRequestToken :: Lens' StartEventsDetectionJob (Maybe Text)
- startEventsDetectionJob_jobName :: Lens' StartEventsDetectionJob (Maybe Text)
- startEventsDetectionJob_tags :: Lens' StartEventsDetectionJob (Maybe [Tag])
- startEventsDetectionJob_inputDataConfig :: Lens' StartEventsDetectionJob InputDataConfig
- startEventsDetectionJob_outputDataConfig :: Lens' StartEventsDetectionJob OutputDataConfig
- startEventsDetectionJob_dataAccessRoleArn :: Lens' StartEventsDetectionJob Text
- startEventsDetectionJob_languageCode :: Lens' StartEventsDetectionJob LanguageCode
- startEventsDetectionJob_targetEventTypes :: Lens' StartEventsDetectionJob (NonEmpty Text)
- startEventsDetectionJobResponse_jobArn :: Lens' StartEventsDetectionJobResponse (Maybe Text)
- startEventsDetectionJobResponse_jobId :: Lens' StartEventsDetectionJobResponse (Maybe Text)
- startEventsDetectionJobResponse_jobStatus :: Lens' StartEventsDetectionJobResponse (Maybe JobStatus)
- startEventsDetectionJobResponse_httpStatus :: Lens' StartEventsDetectionJobResponse Int
- startKeyPhrasesDetectionJob_clientRequestToken :: Lens' StartKeyPhrasesDetectionJob (Maybe Text)
- startKeyPhrasesDetectionJob_jobName :: Lens' StartKeyPhrasesDetectionJob (Maybe Text)
- startKeyPhrasesDetectionJob_tags :: Lens' StartKeyPhrasesDetectionJob (Maybe [Tag])
- startKeyPhrasesDetectionJob_volumeKmsKeyId :: Lens' StartKeyPhrasesDetectionJob (Maybe Text)
- startKeyPhrasesDetectionJob_vpcConfig :: Lens' StartKeyPhrasesDetectionJob (Maybe VpcConfig)
- startKeyPhrasesDetectionJob_inputDataConfig :: Lens' StartKeyPhrasesDetectionJob InputDataConfig
- startKeyPhrasesDetectionJob_outputDataConfig :: Lens' StartKeyPhrasesDetectionJob OutputDataConfig
- startKeyPhrasesDetectionJob_dataAccessRoleArn :: Lens' StartKeyPhrasesDetectionJob Text
- startKeyPhrasesDetectionJob_languageCode :: Lens' StartKeyPhrasesDetectionJob LanguageCode
- startKeyPhrasesDetectionJobResponse_jobArn :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe Text)
- startKeyPhrasesDetectionJobResponse_jobId :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe Text)
- startKeyPhrasesDetectionJobResponse_jobStatus :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe JobStatus)
- startKeyPhrasesDetectionJobResponse_httpStatus :: Lens' StartKeyPhrasesDetectionJobResponse Int
- startPiiEntitiesDetectionJob_clientRequestToken :: Lens' StartPiiEntitiesDetectionJob (Maybe Text)
- startPiiEntitiesDetectionJob_jobName :: Lens' StartPiiEntitiesDetectionJob (Maybe Text)
- startPiiEntitiesDetectionJob_redactionConfig :: Lens' StartPiiEntitiesDetectionJob (Maybe RedactionConfig)
- startPiiEntitiesDetectionJob_tags :: Lens' StartPiiEntitiesDetectionJob (Maybe [Tag])
- startPiiEntitiesDetectionJob_inputDataConfig :: Lens' StartPiiEntitiesDetectionJob InputDataConfig
- startPiiEntitiesDetectionJob_outputDataConfig :: Lens' StartPiiEntitiesDetectionJob OutputDataConfig
- startPiiEntitiesDetectionJob_mode :: Lens' StartPiiEntitiesDetectionJob PiiEntitiesDetectionMode
- startPiiEntitiesDetectionJob_dataAccessRoleArn :: Lens' StartPiiEntitiesDetectionJob Text
- startPiiEntitiesDetectionJob_languageCode :: Lens' StartPiiEntitiesDetectionJob LanguageCode
- startPiiEntitiesDetectionJobResponse_jobArn :: Lens' StartPiiEntitiesDetectionJobResponse (Maybe Text)
- startPiiEntitiesDetectionJobResponse_jobId :: Lens' StartPiiEntitiesDetectionJobResponse (Maybe Text)
- startPiiEntitiesDetectionJobResponse_jobStatus :: Lens' StartPiiEntitiesDetectionJobResponse (Maybe JobStatus)
- startPiiEntitiesDetectionJobResponse_httpStatus :: Lens' StartPiiEntitiesDetectionJobResponse Int
- startSentimentDetectionJob_clientRequestToken :: Lens' StartSentimentDetectionJob (Maybe Text)
- startSentimentDetectionJob_jobName :: Lens' StartSentimentDetectionJob (Maybe Text)
- startSentimentDetectionJob_tags :: Lens' StartSentimentDetectionJob (Maybe [Tag])
- startSentimentDetectionJob_volumeKmsKeyId :: Lens' StartSentimentDetectionJob (Maybe Text)
- startSentimentDetectionJob_vpcConfig :: Lens' StartSentimentDetectionJob (Maybe VpcConfig)
- startSentimentDetectionJob_inputDataConfig :: Lens' StartSentimentDetectionJob InputDataConfig
- startSentimentDetectionJob_outputDataConfig :: Lens' StartSentimentDetectionJob OutputDataConfig
- startSentimentDetectionJob_dataAccessRoleArn :: Lens' StartSentimentDetectionJob Text
- startSentimentDetectionJob_languageCode :: Lens' StartSentimentDetectionJob LanguageCode
- startSentimentDetectionJobResponse_jobArn :: Lens' StartSentimentDetectionJobResponse (Maybe Text)
- startSentimentDetectionJobResponse_jobId :: Lens' StartSentimentDetectionJobResponse (Maybe Text)
- startSentimentDetectionJobResponse_jobStatus :: Lens' StartSentimentDetectionJobResponse (Maybe JobStatus)
- startSentimentDetectionJobResponse_httpStatus :: Lens' StartSentimentDetectionJobResponse Int
- startTargetedSentimentDetectionJob_clientRequestToken :: Lens' StartTargetedSentimentDetectionJob (Maybe Text)
- startTargetedSentimentDetectionJob_jobName :: Lens' StartTargetedSentimentDetectionJob (Maybe Text)
- startTargetedSentimentDetectionJob_tags :: Lens' StartTargetedSentimentDetectionJob (Maybe [Tag])
- startTargetedSentimentDetectionJob_volumeKmsKeyId :: Lens' StartTargetedSentimentDetectionJob (Maybe Text)
- startTargetedSentimentDetectionJob_vpcConfig :: Lens' StartTargetedSentimentDetectionJob (Maybe VpcConfig)
- startTargetedSentimentDetectionJob_inputDataConfig :: Lens' StartTargetedSentimentDetectionJob InputDataConfig
- startTargetedSentimentDetectionJob_outputDataConfig :: Lens' StartTargetedSentimentDetectionJob OutputDataConfig
- startTargetedSentimentDetectionJob_dataAccessRoleArn :: Lens' StartTargetedSentimentDetectionJob Text
- startTargetedSentimentDetectionJob_languageCode :: Lens' StartTargetedSentimentDetectionJob LanguageCode
- startTargetedSentimentDetectionJobResponse_jobArn :: Lens' StartTargetedSentimentDetectionJobResponse (Maybe Text)
- startTargetedSentimentDetectionJobResponse_jobId :: Lens' StartTargetedSentimentDetectionJobResponse (Maybe Text)
- startTargetedSentimentDetectionJobResponse_jobStatus :: Lens' StartTargetedSentimentDetectionJobResponse (Maybe JobStatus)
- startTargetedSentimentDetectionJobResponse_httpStatus :: Lens' StartTargetedSentimentDetectionJobResponse Int
- startTopicsDetectionJob_clientRequestToken :: Lens' StartTopicsDetectionJob (Maybe Text)
- startTopicsDetectionJob_jobName :: Lens' StartTopicsDetectionJob (Maybe Text)
- startTopicsDetectionJob_numberOfTopics :: Lens' StartTopicsDetectionJob (Maybe Natural)
- startTopicsDetectionJob_tags :: Lens' StartTopicsDetectionJob (Maybe [Tag])
- startTopicsDetectionJob_volumeKmsKeyId :: Lens' StartTopicsDetectionJob (Maybe Text)
- startTopicsDetectionJob_vpcConfig :: Lens' StartTopicsDetectionJob (Maybe VpcConfig)
- startTopicsDetectionJob_inputDataConfig :: Lens' StartTopicsDetectionJob InputDataConfig
- startTopicsDetectionJob_outputDataConfig :: Lens' StartTopicsDetectionJob OutputDataConfig
- startTopicsDetectionJob_dataAccessRoleArn :: Lens' StartTopicsDetectionJob Text
- startTopicsDetectionJobResponse_jobArn :: Lens' StartTopicsDetectionJobResponse (Maybe Text)
- startTopicsDetectionJobResponse_jobId :: Lens' StartTopicsDetectionJobResponse (Maybe Text)
- startTopicsDetectionJobResponse_jobStatus :: Lens' StartTopicsDetectionJobResponse (Maybe JobStatus)
- startTopicsDetectionJobResponse_httpStatus :: Lens' StartTopicsDetectionJobResponse Int
- stopDominantLanguageDetectionJob_jobId :: Lens' StopDominantLanguageDetectionJob Text
- stopDominantLanguageDetectionJobResponse_jobId :: Lens' StopDominantLanguageDetectionJobResponse (Maybe Text)
- stopDominantLanguageDetectionJobResponse_jobStatus :: Lens' StopDominantLanguageDetectionJobResponse (Maybe JobStatus)
- stopDominantLanguageDetectionJobResponse_httpStatus :: Lens' StopDominantLanguageDetectionJobResponse Int
- stopEntitiesDetectionJob_jobId :: Lens' StopEntitiesDetectionJob Text
- stopEntitiesDetectionJobResponse_jobId :: Lens' StopEntitiesDetectionJobResponse (Maybe Text)
- stopEntitiesDetectionJobResponse_jobStatus :: Lens' StopEntitiesDetectionJobResponse (Maybe JobStatus)
- stopEntitiesDetectionJobResponse_httpStatus :: Lens' StopEntitiesDetectionJobResponse Int
- stopEventsDetectionJob_jobId :: Lens' StopEventsDetectionJob Text
- stopEventsDetectionJobResponse_jobId :: Lens' StopEventsDetectionJobResponse (Maybe Text)
- stopEventsDetectionJobResponse_jobStatus :: Lens' StopEventsDetectionJobResponse (Maybe JobStatus)
- stopEventsDetectionJobResponse_httpStatus :: Lens' StopEventsDetectionJobResponse Int
- stopKeyPhrasesDetectionJob_jobId :: Lens' StopKeyPhrasesDetectionJob Text
- stopKeyPhrasesDetectionJobResponse_jobId :: Lens' StopKeyPhrasesDetectionJobResponse (Maybe Text)
- stopKeyPhrasesDetectionJobResponse_jobStatus :: Lens' StopKeyPhrasesDetectionJobResponse (Maybe JobStatus)
- stopKeyPhrasesDetectionJobResponse_httpStatus :: Lens' StopKeyPhrasesDetectionJobResponse Int
- stopPiiEntitiesDetectionJob_jobId :: Lens' StopPiiEntitiesDetectionJob Text
- stopPiiEntitiesDetectionJobResponse_jobId :: Lens' StopPiiEntitiesDetectionJobResponse (Maybe Text)
- stopPiiEntitiesDetectionJobResponse_jobStatus :: Lens' StopPiiEntitiesDetectionJobResponse (Maybe JobStatus)
- stopPiiEntitiesDetectionJobResponse_httpStatus :: Lens' StopPiiEntitiesDetectionJobResponse Int
- stopSentimentDetectionJob_jobId :: Lens' StopSentimentDetectionJob Text
- stopSentimentDetectionJobResponse_jobId :: Lens' StopSentimentDetectionJobResponse (Maybe Text)
- stopSentimentDetectionJobResponse_jobStatus :: Lens' StopSentimentDetectionJobResponse (Maybe JobStatus)
- stopSentimentDetectionJobResponse_httpStatus :: Lens' StopSentimentDetectionJobResponse Int
- stopTargetedSentimentDetectionJob_jobId :: Lens' StopTargetedSentimentDetectionJob Text
- stopTargetedSentimentDetectionJobResponse_jobId :: Lens' StopTargetedSentimentDetectionJobResponse (Maybe Text)
- stopTargetedSentimentDetectionJobResponse_jobStatus :: Lens' StopTargetedSentimentDetectionJobResponse (Maybe JobStatus)
- stopTargetedSentimentDetectionJobResponse_httpStatus :: Lens' StopTargetedSentimentDetectionJobResponse Int
- stopTrainingDocumentClassifier_documentClassifierArn :: Lens' StopTrainingDocumentClassifier Text
- stopTrainingDocumentClassifierResponse_httpStatus :: Lens' StopTrainingDocumentClassifierResponse Int
- stopTrainingEntityRecognizer_entityRecognizerArn :: Lens' StopTrainingEntityRecognizer Text
- stopTrainingEntityRecognizerResponse_httpStatus :: Lens' StopTrainingEntityRecognizerResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource [Tag]
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateEndpoint_desiredDataAccessRoleArn :: Lens' UpdateEndpoint (Maybe Text)
- updateEndpoint_desiredInferenceUnits :: Lens' UpdateEndpoint (Maybe Natural)
- updateEndpoint_desiredModelArn :: Lens' UpdateEndpoint (Maybe Text)
- updateEndpoint_endpointArn :: Lens' UpdateEndpoint Text
- updateEndpointResponse_httpStatus :: Lens' UpdateEndpointResponse Int
- augmentedManifestsListItem_annotationDataS3Uri :: Lens' AugmentedManifestsListItem (Maybe Text)
- augmentedManifestsListItem_documentType :: Lens' AugmentedManifestsListItem (Maybe AugmentedManifestsDocumentTypeFormat)
- augmentedManifestsListItem_sourceDocumentsS3Uri :: Lens' AugmentedManifestsListItem (Maybe Text)
- augmentedManifestsListItem_split :: Lens' AugmentedManifestsListItem (Maybe Split)
- augmentedManifestsListItem_s3Uri :: Lens' AugmentedManifestsListItem Text
- augmentedManifestsListItem_attributeNames :: Lens' AugmentedManifestsListItem [Text]
- batchDetectDominantLanguageItemResult_index :: Lens' BatchDetectDominantLanguageItemResult (Maybe Int)
- batchDetectDominantLanguageItemResult_languages :: Lens' BatchDetectDominantLanguageItemResult (Maybe [DominantLanguage])
- batchDetectEntitiesItemResult_entities :: Lens' BatchDetectEntitiesItemResult (Maybe [Entity])
- batchDetectEntitiesItemResult_index :: Lens' BatchDetectEntitiesItemResult (Maybe Int)
- batchDetectKeyPhrasesItemResult_index :: Lens' BatchDetectKeyPhrasesItemResult (Maybe Int)
- batchDetectKeyPhrasesItemResult_keyPhrases :: Lens' BatchDetectKeyPhrasesItemResult (Maybe [KeyPhrase])
- batchDetectSentimentItemResult_index :: Lens' BatchDetectSentimentItemResult (Maybe Int)
- batchDetectSentimentItemResult_sentiment :: Lens' BatchDetectSentimentItemResult (Maybe SentimentType)
- batchDetectSentimentItemResult_sentimentScore :: Lens' BatchDetectSentimentItemResult (Maybe SentimentScore)
- batchDetectSyntaxItemResult_index :: Lens' BatchDetectSyntaxItemResult (Maybe Int)
- batchDetectSyntaxItemResult_syntaxTokens :: Lens' BatchDetectSyntaxItemResult (Maybe [SyntaxToken])
- batchDetectTargetedSentimentItemResult_entities :: Lens' BatchDetectTargetedSentimentItemResult (Maybe [TargetedSentimentEntity])
- batchDetectTargetedSentimentItemResult_index :: Lens' BatchDetectTargetedSentimentItemResult (Maybe Int)
- batchItemError_errorCode :: Lens' BatchItemError (Maybe Text)
- batchItemError_errorMessage :: Lens' BatchItemError (Maybe Text)
- batchItemError_index :: Lens' BatchItemError (Maybe Int)
- block_blockType :: Lens' Block (Maybe BlockType)
- block_geometry :: Lens' Block (Maybe Geometry)
- block_id :: Lens' Block (Maybe Text)
- block_page :: Lens' Block (Maybe Int)
- block_relationships :: Lens' Block (Maybe [RelationshipsListItem])
- block_text :: Lens' Block (Maybe Text)
- blockReference_beginOffset :: Lens' BlockReference (Maybe Int)
- blockReference_blockId :: Lens' BlockReference (Maybe Text)
- blockReference_childBlocks :: Lens' BlockReference (Maybe [ChildBlock])
- blockReference_endOffset :: Lens' BlockReference (Maybe Int)
- boundingBox_height :: Lens' BoundingBox (Maybe Double)
- boundingBox_left :: Lens' BoundingBox (Maybe Double)
- boundingBox_top :: Lens' BoundingBox (Maybe Double)
- boundingBox_width :: Lens' BoundingBox (Maybe Double)
- childBlock_beginOffset :: Lens' ChildBlock (Maybe Int)
- childBlock_childBlockId :: Lens' ChildBlock (Maybe Text)
- childBlock_endOffset :: Lens' ChildBlock (Maybe Int)
- classifierEvaluationMetrics_accuracy :: Lens' ClassifierEvaluationMetrics (Maybe Double)
- classifierEvaluationMetrics_f1Score :: Lens' ClassifierEvaluationMetrics (Maybe Double)
- classifierEvaluationMetrics_hammingLoss :: Lens' ClassifierEvaluationMetrics (Maybe Double)
- classifierEvaluationMetrics_microF1Score :: Lens' ClassifierEvaluationMetrics (Maybe Double)
- classifierEvaluationMetrics_microPrecision :: Lens' ClassifierEvaluationMetrics (Maybe Double)
- classifierEvaluationMetrics_microRecall :: Lens' ClassifierEvaluationMetrics (Maybe Double)
- classifierEvaluationMetrics_precision :: Lens' ClassifierEvaluationMetrics (Maybe Double)
- classifierEvaluationMetrics_recall :: Lens' ClassifierEvaluationMetrics (Maybe Double)
- classifierMetadata_evaluationMetrics :: Lens' ClassifierMetadata (Maybe ClassifierEvaluationMetrics)
- classifierMetadata_numberOfLabels :: Lens' ClassifierMetadata (Maybe Int)
- classifierMetadata_numberOfTestDocuments :: Lens' ClassifierMetadata (Maybe Int)
- classifierMetadata_numberOfTrainedDocuments :: Lens' ClassifierMetadata (Maybe Int)
- documentClass_name :: Lens' DocumentClass (Maybe Text)
- documentClass_page :: Lens' DocumentClass (Maybe Int)
- documentClass_score :: Lens' DocumentClass (Maybe Double)
- documentClassificationJobFilter_jobName :: Lens' DocumentClassificationJobFilter (Maybe Text)
- documentClassificationJobFilter_jobStatus :: Lens' DocumentClassificationJobFilter (Maybe JobStatus)
- documentClassificationJobFilter_submitTimeAfter :: Lens' DocumentClassificationJobFilter (Maybe UTCTime)
- documentClassificationJobFilter_submitTimeBefore :: Lens' DocumentClassificationJobFilter (Maybe UTCTime)
- documentClassificationJobProperties_dataAccessRoleArn :: Lens' DocumentClassificationJobProperties (Maybe Text)
- documentClassificationJobProperties_documentClassifierArn :: Lens' DocumentClassificationJobProperties (Maybe Text)
- documentClassificationJobProperties_endTime :: Lens' DocumentClassificationJobProperties (Maybe UTCTime)
- documentClassificationJobProperties_inputDataConfig :: Lens' DocumentClassificationJobProperties (Maybe InputDataConfig)
- documentClassificationJobProperties_jobArn :: Lens' DocumentClassificationJobProperties (Maybe Text)
- documentClassificationJobProperties_jobId :: Lens' DocumentClassificationJobProperties (Maybe Text)
- documentClassificationJobProperties_jobName :: Lens' DocumentClassificationJobProperties (Maybe Text)
- documentClassificationJobProperties_jobStatus :: Lens' DocumentClassificationJobProperties (Maybe JobStatus)
- documentClassificationJobProperties_message :: Lens' DocumentClassificationJobProperties (Maybe Text)
- documentClassificationJobProperties_outputDataConfig :: Lens' DocumentClassificationJobProperties (Maybe OutputDataConfig)
- documentClassificationJobProperties_submitTime :: Lens' DocumentClassificationJobProperties (Maybe UTCTime)
- documentClassificationJobProperties_volumeKmsKeyId :: Lens' DocumentClassificationJobProperties (Maybe Text)
- documentClassificationJobProperties_vpcConfig :: Lens' DocumentClassificationJobProperties (Maybe VpcConfig)
- documentClassifierFilter_documentClassifierName :: Lens' DocumentClassifierFilter (Maybe Text)
- documentClassifierFilter_status :: Lens' DocumentClassifierFilter (Maybe ModelStatus)
- documentClassifierFilter_submitTimeAfter :: Lens' DocumentClassifierFilter (Maybe UTCTime)
- documentClassifierFilter_submitTimeBefore :: Lens' DocumentClassifierFilter (Maybe UTCTime)
- documentClassifierInputDataConfig_augmentedManifests :: Lens' DocumentClassifierInputDataConfig (Maybe [AugmentedManifestsListItem])
- documentClassifierInputDataConfig_dataFormat :: Lens' DocumentClassifierInputDataConfig (Maybe DocumentClassifierDataFormat)
- documentClassifierInputDataConfig_labelDelimiter :: Lens' DocumentClassifierInputDataConfig (Maybe Text)
- documentClassifierInputDataConfig_s3Uri :: Lens' DocumentClassifierInputDataConfig (Maybe Text)
- documentClassifierInputDataConfig_testS3Uri :: Lens' DocumentClassifierInputDataConfig (Maybe Text)
- documentClassifierOutputDataConfig_kmsKeyId :: Lens' DocumentClassifierOutputDataConfig (Maybe Text)
- documentClassifierOutputDataConfig_s3Uri :: Lens' DocumentClassifierOutputDataConfig (Maybe Text)
- documentClassifierProperties_classifierMetadata :: Lens' DocumentClassifierProperties (Maybe ClassifierMetadata)
- documentClassifierProperties_dataAccessRoleArn :: Lens' DocumentClassifierProperties (Maybe Text)
- documentClassifierProperties_documentClassifierArn :: Lens' DocumentClassifierProperties (Maybe Text)
- documentClassifierProperties_endTime :: Lens' DocumentClassifierProperties (Maybe UTCTime)
- documentClassifierProperties_inputDataConfig :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierInputDataConfig)
- documentClassifierProperties_languageCode :: Lens' DocumentClassifierProperties (Maybe LanguageCode)
- documentClassifierProperties_message :: Lens' DocumentClassifierProperties (Maybe Text)
- documentClassifierProperties_mode :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierMode)
- documentClassifierProperties_modelKmsKeyId :: Lens' DocumentClassifierProperties (Maybe Text)
- documentClassifierProperties_outputDataConfig :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierOutputDataConfig)
- documentClassifierProperties_sourceModelArn :: Lens' DocumentClassifierProperties (Maybe Text)
- documentClassifierProperties_status :: Lens' DocumentClassifierProperties (Maybe ModelStatus)
- documentClassifierProperties_submitTime :: Lens' DocumentClassifierProperties (Maybe UTCTime)
- documentClassifierProperties_trainingEndTime :: Lens' DocumentClassifierProperties (Maybe UTCTime)
- documentClassifierProperties_trainingStartTime :: Lens' DocumentClassifierProperties (Maybe UTCTime)
- documentClassifierProperties_versionName :: Lens' DocumentClassifierProperties (Maybe Text)
- documentClassifierProperties_volumeKmsKeyId :: Lens' DocumentClassifierProperties (Maybe Text)
- documentClassifierProperties_vpcConfig :: Lens' DocumentClassifierProperties (Maybe VpcConfig)
- documentClassifierSummary_documentClassifierName :: Lens' DocumentClassifierSummary (Maybe Text)
- documentClassifierSummary_latestVersionCreatedAt :: Lens' DocumentClassifierSummary (Maybe UTCTime)
- documentClassifierSummary_latestVersionName :: Lens' DocumentClassifierSummary (Maybe Text)
- documentClassifierSummary_latestVersionStatus :: Lens' DocumentClassifierSummary (Maybe ModelStatus)
- documentClassifierSummary_numberOfVersions :: Lens' DocumentClassifierSummary (Maybe Int)
- documentLabel_name :: Lens' DocumentLabel (Maybe Text)
- documentLabel_page :: Lens' DocumentLabel (Maybe Int)
- documentLabel_score :: Lens' DocumentLabel (Maybe Double)
- documentMetadata_extractedCharacters :: Lens' DocumentMetadata (Maybe [ExtractedCharactersListItem])
- documentMetadata_pages :: Lens' DocumentMetadata (Maybe Int)
- documentReaderConfig_documentReadMode :: Lens' DocumentReaderConfig (Maybe DocumentReadMode)
- documentReaderConfig_featureTypes :: Lens' DocumentReaderConfig (Maybe (NonEmpty DocumentReadFeatureTypes))
- documentReaderConfig_documentReadAction :: Lens' DocumentReaderConfig DocumentReadAction
- documentTypeListItem_page :: Lens' DocumentTypeListItem (Maybe Int)
- documentTypeListItem_type :: Lens' DocumentTypeListItem (Maybe DocumentType)
- dominantLanguage_languageCode :: Lens' DominantLanguage (Maybe Text)
- dominantLanguage_score :: Lens' DominantLanguage (Maybe Double)
- dominantLanguageDetectionJobFilter_jobName :: Lens' DominantLanguageDetectionJobFilter (Maybe Text)
- dominantLanguageDetectionJobFilter_jobStatus :: Lens' DominantLanguageDetectionJobFilter (Maybe JobStatus)
- dominantLanguageDetectionJobFilter_submitTimeAfter :: Lens' DominantLanguageDetectionJobFilter (Maybe UTCTime)
- dominantLanguageDetectionJobFilter_submitTimeBefore :: Lens' DominantLanguageDetectionJobFilter (Maybe UTCTime)
- dominantLanguageDetectionJobProperties_dataAccessRoleArn :: Lens' DominantLanguageDetectionJobProperties (Maybe Text)
- dominantLanguageDetectionJobProperties_endTime :: Lens' DominantLanguageDetectionJobProperties (Maybe UTCTime)
- dominantLanguageDetectionJobProperties_inputDataConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe InputDataConfig)
- dominantLanguageDetectionJobProperties_jobArn :: Lens' DominantLanguageDetectionJobProperties (Maybe Text)
- dominantLanguageDetectionJobProperties_jobId :: Lens' DominantLanguageDetectionJobProperties (Maybe Text)
- dominantLanguageDetectionJobProperties_jobName :: Lens' DominantLanguageDetectionJobProperties (Maybe Text)
- dominantLanguageDetectionJobProperties_jobStatus :: Lens' DominantLanguageDetectionJobProperties (Maybe JobStatus)
- dominantLanguageDetectionJobProperties_message :: Lens' DominantLanguageDetectionJobProperties (Maybe Text)
- dominantLanguageDetectionJobProperties_outputDataConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe OutputDataConfig)
- dominantLanguageDetectionJobProperties_submitTime :: Lens' DominantLanguageDetectionJobProperties (Maybe UTCTime)
- dominantLanguageDetectionJobProperties_volumeKmsKeyId :: Lens' DominantLanguageDetectionJobProperties (Maybe Text)
- dominantLanguageDetectionJobProperties_vpcConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe VpcConfig)
- endpointFilter_creationTimeAfter :: Lens' EndpointFilter (Maybe UTCTime)
- endpointFilter_creationTimeBefore :: Lens' EndpointFilter (Maybe UTCTime)
- endpointFilter_modelArn :: Lens' EndpointFilter (Maybe Text)
- endpointFilter_status :: Lens' EndpointFilter (Maybe EndpointStatus)
- endpointProperties_creationTime :: Lens' EndpointProperties (Maybe UTCTime)
- endpointProperties_currentInferenceUnits :: Lens' EndpointProperties (Maybe Natural)
- endpointProperties_dataAccessRoleArn :: Lens' EndpointProperties (Maybe Text)
- endpointProperties_desiredDataAccessRoleArn :: Lens' EndpointProperties (Maybe Text)
- endpointProperties_desiredInferenceUnits :: Lens' EndpointProperties (Maybe Natural)
- endpointProperties_desiredModelArn :: Lens' EndpointProperties (Maybe Text)
- endpointProperties_endpointArn :: Lens' EndpointProperties (Maybe Text)
- endpointProperties_lastModifiedTime :: Lens' EndpointProperties (Maybe UTCTime)
- endpointProperties_message :: Lens' EndpointProperties (Maybe Text)
- endpointProperties_modelArn :: Lens' EndpointProperties (Maybe Text)
- endpointProperties_status :: Lens' EndpointProperties (Maybe EndpointStatus)
- entitiesDetectionJobFilter_jobName :: Lens' EntitiesDetectionJobFilter (Maybe Text)
- entitiesDetectionJobFilter_jobStatus :: Lens' EntitiesDetectionJobFilter (Maybe JobStatus)
- entitiesDetectionJobFilter_submitTimeAfter :: Lens' EntitiesDetectionJobFilter (Maybe UTCTime)
- entitiesDetectionJobFilter_submitTimeBefore :: Lens' EntitiesDetectionJobFilter (Maybe UTCTime)
- entitiesDetectionJobProperties_dataAccessRoleArn :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_endTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime)
- entitiesDetectionJobProperties_entityRecognizerArn :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_inputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe InputDataConfig)
- entitiesDetectionJobProperties_jobArn :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_jobId :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_jobName :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_jobStatus :: Lens' EntitiesDetectionJobProperties (Maybe JobStatus)
- entitiesDetectionJobProperties_languageCode :: Lens' EntitiesDetectionJobProperties (Maybe LanguageCode)
- entitiesDetectionJobProperties_message :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_outputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe OutputDataConfig)
- entitiesDetectionJobProperties_submitTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime)
- entitiesDetectionJobProperties_volumeKmsKeyId :: Lens' EntitiesDetectionJobProperties (Maybe Text)
- entitiesDetectionJobProperties_vpcConfig :: Lens' EntitiesDetectionJobProperties (Maybe VpcConfig)
- entity_beginOffset :: Lens' Entity (Maybe Int)
- entity_blockReferences :: Lens' Entity (Maybe [BlockReference])
- entity_endOffset :: Lens' Entity (Maybe Int)
- entity_score :: Lens' Entity (Maybe Double)
- entity_text :: Lens' Entity (Maybe Text)
- entity_type :: Lens' Entity (Maybe EntityType)
- entityLabel_name :: Lens' EntityLabel (Maybe PiiEntityType)
- entityLabel_score :: Lens' EntityLabel (Maybe Double)
- entityRecognizerAnnotations_testS3Uri :: Lens' EntityRecognizerAnnotations (Maybe Text)
- entityRecognizerAnnotations_s3Uri :: Lens' EntityRecognizerAnnotations Text
- entityRecognizerDocuments_inputFormat :: Lens' EntityRecognizerDocuments (Maybe InputFormat)
- entityRecognizerDocuments_testS3Uri :: Lens' EntityRecognizerDocuments (Maybe Text)
- entityRecognizerDocuments_s3Uri :: Lens' EntityRecognizerDocuments Text
- entityRecognizerEntityList_s3Uri :: Lens' EntityRecognizerEntityList Text
- entityRecognizerEvaluationMetrics_f1Score :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double)
- entityRecognizerEvaluationMetrics_precision :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double)
- entityRecognizerEvaluationMetrics_recall :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double)
- entityRecognizerFilter_recognizerName :: Lens' EntityRecognizerFilter (Maybe Text)
- entityRecognizerFilter_status :: Lens' EntityRecognizerFilter (Maybe ModelStatus)
- entityRecognizerFilter_submitTimeAfter :: Lens' EntityRecognizerFilter (Maybe UTCTime)
- entityRecognizerFilter_submitTimeBefore :: Lens' EntityRecognizerFilter (Maybe UTCTime)
- entityRecognizerInputDataConfig_annotations :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerAnnotations)
- entityRecognizerInputDataConfig_augmentedManifests :: Lens' EntityRecognizerInputDataConfig (Maybe [AugmentedManifestsListItem])
- entityRecognizerInputDataConfig_dataFormat :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerDataFormat)
- entityRecognizerInputDataConfig_documents :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerDocuments)
- entityRecognizerInputDataConfig_entityList :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerEntityList)
- entityRecognizerInputDataConfig_entityTypes :: Lens' EntityRecognizerInputDataConfig [EntityTypesListItem]
- entityRecognizerMetadata_entityTypes :: Lens' EntityRecognizerMetadata (Maybe [EntityRecognizerMetadataEntityTypesListItem])
- entityRecognizerMetadata_evaluationMetrics :: Lens' EntityRecognizerMetadata (Maybe EntityRecognizerEvaluationMetrics)
- entityRecognizerMetadata_numberOfTestDocuments :: Lens' EntityRecognizerMetadata (Maybe Int)
- entityRecognizerMetadata_numberOfTrainedDocuments :: Lens' EntityRecognizerMetadata (Maybe Int)
- entityRecognizerMetadataEntityTypesListItem_evaluationMetrics :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe EntityTypesEvaluationMetrics)
- entityRecognizerMetadataEntityTypesListItem_numberOfTrainMentions :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe Int)
- entityRecognizerMetadataEntityTypesListItem_type :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe Text)
- entityRecognizerProperties_dataAccessRoleArn :: Lens' EntityRecognizerProperties (Maybe Text)
- entityRecognizerProperties_endTime :: Lens' EntityRecognizerProperties (Maybe UTCTime)
- entityRecognizerProperties_entityRecognizerArn :: Lens' EntityRecognizerProperties (Maybe Text)
- entityRecognizerProperties_inputDataConfig :: Lens' EntityRecognizerProperties (Maybe EntityRecognizerInputDataConfig)
- entityRecognizerProperties_languageCode :: Lens' EntityRecognizerProperties (Maybe LanguageCode)
- entityRecognizerProperties_message :: Lens' EntityRecognizerProperties (Maybe Text)
- entityRecognizerProperties_modelKmsKeyId :: Lens' EntityRecognizerProperties (Maybe Text)
- entityRecognizerProperties_recognizerMetadata :: Lens' EntityRecognizerProperties (Maybe EntityRecognizerMetadata)
- entityRecognizerProperties_sourceModelArn :: Lens' EntityRecognizerProperties (Maybe Text)
- entityRecognizerProperties_status :: Lens' EntityRecognizerProperties (Maybe ModelStatus)
- entityRecognizerProperties_submitTime :: Lens' EntityRecognizerProperties (Maybe UTCTime)
- entityRecognizerProperties_trainingEndTime :: Lens' EntityRecognizerProperties (Maybe UTCTime)
- entityRecognizerProperties_trainingStartTime :: Lens' EntityRecognizerProperties (Maybe UTCTime)
- entityRecognizerProperties_versionName :: Lens' EntityRecognizerProperties (Maybe Text)
- entityRecognizerProperties_volumeKmsKeyId :: Lens' EntityRecognizerProperties (Maybe Text)
- entityRecognizerProperties_vpcConfig :: Lens' EntityRecognizerProperties (Maybe VpcConfig)
- entityRecognizerSummary_latestVersionCreatedAt :: Lens' EntityRecognizerSummary (Maybe UTCTime)
- entityRecognizerSummary_latestVersionName :: Lens' EntityRecognizerSummary (Maybe Text)
- entityRecognizerSummary_latestVersionStatus :: Lens' EntityRecognizerSummary (Maybe ModelStatus)
- entityRecognizerSummary_numberOfVersions :: Lens' EntityRecognizerSummary (Maybe Int)
- entityRecognizerSummary_recognizerName :: Lens' EntityRecognizerSummary (Maybe Text)
- entityTypesEvaluationMetrics_f1Score :: Lens' EntityTypesEvaluationMetrics (Maybe Double)
- entityTypesEvaluationMetrics_precision :: Lens' EntityTypesEvaluationMetrics (Maybe Double)
- entityTypesEvaluationMetrics_recall :: Lens' EntityTypesEvaluationMetrics (Maybe Double)
- entityTypesListItem_type :: Lens' EntityTypesListItem Text
- errorsListItem_errorCode :: Lens' ErrorsListItem (Maybe PageBasedErrorCode)
- errorsListItem_errorMessage :: Lens' ErrorsListItem (Maybe Text)
- errorsListItem_page :: Lens' ErrorsListItem (Maybe Int)
- eventsDetectionJobFilter_jobName :: Lens' EventsDetectionJobFilter (Maybe Text)
- eventsDetectionJobFilter_jobStatus :: Lens' EventsDetectionJobFilter (Maybe JobStatus)
- eventsDetectionJobFilter_submitTimeAfter :: Lens' EventsDetectionJobFilter (Maybe UTCTime)
- eventsDetectionJobFilter_submitTimeBefore :: Lens' EventsDetectionJobFilter (Maybe UTCTime)
- eventsDetectionJobProperties_dataAccessRoleArn :: Lens' EventsDetectionJobProperties (Maybe Text)
- eventsDetectionJobProperties_endTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime)
- eventsDetectionJobProperties_inputDataConfig :: Lens' EventsDetectionJobProperties (Maybe InputDataConfig)
- eventsDetectionJobProperties_jobArn :: Lens' EventsDetectionJobProperties (Maybe Text)
- eventsDetectionJobProperties_jobId :: Lens' EventsDetectionJobProperties (Maybe Text)
- eventsDetectionJobProperties_jobName :: Lens' EventsDetectionJobProperties (Maybe Text)
- eventsDetectionJobProperties_jobStatus :: Lens' EventsDetectionJobProperties (Maybe JobStatus)
- eventsDetectionJobProperties_languageCode :: Lens' EventsDetectionJobProperties (Maybe LanguageCode)
- eventsDetectionJobProperties_message :: Lens' EventsDetectionJobProperties (Maybe Text)
- eventsDetectionJobProperties_outputDataConfig :: Lens' EventsDetectionJobProperties (Maybe OutputDataConfig)
- eventsDetectionJobProperties_submitTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime)
- eventsDetectionJobProperties_targetEventTypes :: Lens' EventsDetectionJobProperties (Maybe (NonEmpty Text))
- extractedCharactersListItem_count :: Lens' ExtractedCharactersListItem (Maybe Int)
- extractedCharactersListItem_page :: Lens' ExtractedCharactersListItem (Maybe Int)
- geometry_boundingBox :: Lens' Geometry (Maybe BoundingBox)
- geometry_polygon :: Lens' Geometry (Maybe [Point])
- inputDataConfig_documentReaderConfig :: Lens' InputDataConfig (Maybe DocumentReaderConfig)
- inputDataConfig_inputFormat :: Lens' InputDataConfig (Maybe InputFormat)
- inputDataConfig_s3Uri :: Lens' InputDataConfig Text
- keyPhrase_beginOffset :: Lens' KeyPhrase (Maybe Int)
- keyPhrase_endOffset :: Lens' KeyPhrase (Maybe Int)
- keyPhrase_score :: Lens' KeyPhrase (Maybe Double)
- keyPhrase_text :: Lens' KeyPhrase (Maybe Text)
- keyPhrasesDetectionJobFilter_jobName :: Lens' KeyPhrasesDetectionJobFilter (Maybe Text)
- keyPhrasesDetectionJobFilter_jobStatus :: Lens' KeyPhrasesDetectionJobFilter (Maybe JobStatus)
- keyPhrasesDetectionJobFilter_submitTimeAfter :: Lens' KeyPhrasesDetectionJobFilter (Maybe UTCTime)
- keyPhrasesDetectionJobFilter_submitTimeBefore :: Lens' KeyPhrasesDetectionJobFilter (Maybe UTCTime)
- keyPhrasesDetectionJobProperties_dataAccessRoleArn :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text)
- keyPhrasesDetectionJobProperties_endTime :: Lens' KeyPhrasesDetectionJobProperties (Maybe UTCTime)
- keyPhrasesDetectionJobProperties_inputDataConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe InputDataConfig)
- keyPhrasesDetectionJobProperties_jobArn :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text)
- keyPhrasesDetectionJobProperties_jobId :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text)
- keyPhrasesDetectionJobProperties_jobName :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text)
- keyPhrasesDetectionJobProperties_jobStatus :: Lens' KeyPhrasesDetectionJobProperties (Maybe JobStatus)
- keyPhrasesDetectionJobProperties_languageCode :: Lens' KeyPhrasesDetectionJobProperties (Maybe LanguageCode)
- keyPhrasesDetectionJobProperties_message :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text)
- keyPhrasesDetectionJobProperties_outputDataConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe OutputDataConfig)
- keyPhrasesDetectionJobProperties_submitTime :: Lens' KeyPhrasesDetectionJobProperties (Maybe UTCTime)
- keyPhrasesDetectionJobProperties_volumeKmsKeyId :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text)
- keyPhrasesDetectionJobProperties_vpcConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe VpcConfig)
- mentionSentiment_sentiment :: Lens' MentionSentiment (Maybe SentimentType)
- mentionSentiment_sentimentScore :: Lens' MentionSentiment (Maybe SentimentScore)
- outputDataConfig_kmsKeyId :: Lens' OutputDataConfig (Maybe Text)
- outputDataConfig_s3Uri :: Lens' OutputDataConfig Text
- partOfSpeechTag_score :: Lens' PartOfSpeechTag (Maybe Double)
- partOfSpeechTag_tag :: Lens' PartOfSpeechTag (Maybe PartOfSpeechTagType)
- piiEntitiesDetectionJobFilter_jobName :: Lens' PiiEntitiesDetectionJobFilter (Maybe Text)
- piiEntitiesDetectionJobFilter_jobStatus :: Lens' PiiEntitiesDetectionJobFilter (Maybe JobStatus)
- piiEntitiesDetectionJobFilter_submitTimeAfter :: Lens' PiiEntitiesDetectionJobFilter (Maybe UTCTime)
- piiEntitiesDetectionJobFilter_submitTimeBefore :: Lens' PiiEntitiesDetectionJobFilter (Maybe UTCTime)
- piiEntitiesDetectionJobProperties_dataAccessRoleArn :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text)
- piiEntitiesDetectionJobProperties_endTime :: Lens' PiiEntitiesDetectionJobProperties (Maybe UTCTime)
- piiEntitiesDetectionJobProperties_inputDataConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe InputDataConfig)
- piiEntitiesDetectionJobProperties_jobArn :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text)
- piiEntitiesDetectionJobProperties_jobId :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text)
- piiEntitiesDetectionJobProperties_jobName :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text)
- piiEntitiesDetectionJobProperties_jobStatus :: Lens' PiiEntitiesDetectionJobProperties (Maybe JobStatus)
- piiEntitiesDetectionJobProperties_languageCode :: Lens' PiiEntitiesDetectionJobProperties (Maybe LanguageCode)
- piiEntitiesDetectionJobProperties_message :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text)
- piiEntitiesDetectionJobProperties_mode :: Lens' PiiEntitiesDetectionJobProperties (Maybe PiiEntitiesDetectionMode)
- piiEntitiesDetectionJobProperties_outputDataConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe PiiOutputDataConfig)
- piiEntitiesDetectionJobProperties_redactionConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe RedactionConfig)
- piiEntitiesDetectionJobProperties_submitTime :: Lens' PiiEntitiesDetectionJobProperties (Maybe UTCTime)
- piiEntity_beginOffset :: Lens' PiiEntity (Maybe Int)
- piiEntity_endOffset :: Lens' PiiEntity (Maybe Int)
- piiEntity_score :: Lens' PiiEntity (Maybe Double)
- piiEntity_type :: Lens' PiiEntity (Maybe PiiEntityType)
- piiOutputDataConfig_kmsKeyId :: Lens' PiiOutputDataConfig (Maybe Text)
- piiOutputDataConfig_s3Uri :: Lens' PiiOutputDataConfig Text
- point_x :: Lens' Point (Maybe Double)
- point_y :: Lens' Point (Maybe Double)
- redactionConfig_maskCharacter :: Lens' RedactionConfig (Maybe Text)
- redactionConfig_maskMode :: Lens' RedactionConfig (Maybe PiiEntitiesDetectionMaskMode)
- redactionConfig_piiEntityTypes :: Lens' RedactionConfig (Maybe [PiiEntityType])
- relationshipsListItem_ids :: Lens' RelationshipsListItem (Maybe [Text])
- relationshipsListItem_type :: Lens' RelationshipsListItem (Maybe RelationshipType)
- sentimentDetectionJobFilter_jobName :: Lens' SentimentDetectionJobFilter (Maybe Text)
- sentimentDetectionJobFilter_jobStatus :: Lens' SentimentDetectionJobFilter (Maybe JobStatus)
- sentimentDetectionJobFilter_submitTimeAfter :: Lens' SentimentDetectionJobFilter (Maybe UTCTime)
- sentimentDetectionJobFilter_submitTimeBefore :: Lens' SentimentDetectionJobFilter (Maybe UTCTime)
- sentimentDetectionJobProperties_dataAccessRoleArn :: Lens' SentimentDetectionJobProperties (Maybe Text)
- sentimentDetectionJobProperties_endTime :: Lens' SentimentDetectionJobProperties (Maybe UTCTime)
- sentimentDetectionJobProperties_inputDataConfig :: Lens' SentimentDetectionJobProperties (Maybe InputDataConfig)
- sentimentDetectionJobProperties_jobArn :: Lens' SentimentDetectionJobProperties (Maybe Text)
- sentimentDetectionJobProperties_jobId :: Lens' SentimentDetectionJobProperties (Maybe Text)
- sentimentDetectionJobProperties_jobName :: Lens' SentimentDetectionJobProperties (Maybe Text)
- sentimentDetectionJobProperties_jobStatus :: Lens' SentimentDetectionJobProperties (Maybe JobStatus)
- sentimentDetectionJobProperties_languageCode :: Lens' SentimentDetectionJobProperties (Maybe LanguageCode)
- sentimentDetectionJobProperties_message :: Lens' SentimentDetectionJobProperties (Maybe Text)
- sentimentDetectionJobProperties_outputDataConfig :: Lens' SentimentDetectionJobProperties (Maybe OutputDataConfig)
- sentimentDetectionJobProperties_submitTime :: Lens' SentimentDetectionJobProperties (Maybe UTCTime)
- sentimentDetectionJobProperties_volumeKmsKeyId :: Lens' SentimentDetectionJobProperties (Maybe Text)
- sentimentDetectionJobProperties_vpcConfig :: Lens' SentimentDetectionJobProperties (Maybe VpcConfig)
- sentimentScore_mixed :: Lens' SentimentScore (Maybe Double)
- sentimentScore_negative :: Lens' SentimentScore (Maybe Double)
- sentimentScore_neutral :: Lens' SentimentScore (Maybe Double)
- sentimentScore_positive :: Lens' SentimentScore (Maybe Double)
- syntaxToken_beginOffset :: Lens' SyntaxToken (Maybe Int)
- syntaxToken_endOffset :: Lens' SyntaxToken (Maybe Int)
- syntaxToken_partOfSpeech :: Lens' SyntaxToken (Maybe PartOfSpeechTag)
- syntaxToken_text :: Lens' SyntaxToken (Maybe Text)
- syntaxToken_tokenId :: Lens' SyntaxToken (Maybe Int)
- tag_value :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag Text
- targetedSentimentDetectionJobFilter_jobName :: Lens' TargetedSentimentDetectionJobFilter (Maybe Text)
- targetedSentimentDetectionJobFilter_jobStatus :: Lens' TargetedSentimentDetectionJobFilter (Maybe JobStatus)
- targetedSentimentDetectionJobFilter_submitTimeAfter :: Lens' TargetedSentimentDetectionJobFilter (Maybe UTCTime)
- targetedSentimentDetectionJobFilter_submitTimeBefore :: Lens' TargetedSentimentDetectionJobFilter (Maybe UTCTime)
- targetedSentimentDetectionJobProperties_dataAccessRoleArn :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text)
- targetedSentimentDetectionJobProperties_endTime :: Lens' TargetedSentimentDetectionJobProperties (Maybe UTCTime)
- targetedSentimentDetectionJobProperties_inputDataConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe InputDataConfig)
- targetedSentimentDetectionJobProperties_jobArn :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text)
- targetedSentimentDetectionJobProperties_jobId :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text)
- targetedSentimentDetectionJobProperties_jobName :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text)
- targetedSentimentDetectionJobProperties_jobStatus :: Lens' TargetedSentimentDetectionJobProperties (Maybe JobStatus)
- targetedSentimentDetectionJobProperties_languageCode :: Lens' TargetedSentimentDetectionJobProperties (Maybe LanguageCode)
- targetedSentimentDetectionJobProperties_message :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text)
- targetedSentimentDetectionJobProperties_outputDataConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe OutputDataConfig)
- targetedSentimentDetectionJobProperties_submitTime :: Lens' TargetedSentimentDetectionJobProperties (Maybe UTCTime)
- targetedSentimentDetectionJobProperties_volumeKmsKeyId :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text)
- targetedSentimentDetectionJobProperties_vpcConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe VpcConfig)
- targetedSentimentEntity_descriptiveMentionIndex :: Lens' TargetedSentimentEntity (Maybe [Int])
- targetedSentimentEntity_mentions :: Lens' TargetedSentimentEntity (Maybe [TargetedSentimentMention])
- targetedSentimentMention_beginOffset :: Lens' TargetedSentimentMention (Maybe Int)
- targetedSentimentMention_endOffset :: Lens' TargetedSentimentMention (Maybe Int)
- targetedSentimentMention_groupScore :: Lens' TargetedSentimentMention (Maybe Double)
- targetedSentimentMention_mentionSentiment :: Lens' TargetedSentimentMention (Maybe MentionSentiment)
- targetedSentimentMention_score :: Lens' TargetedSentimentMention (Maybe Double)
- targetedSentimentMention_text :: Lens' TargetedSentimentMention (Maybe Text)
- targetedSentimentMention_type :: Lens' TargetedSentimentMention (Maybe TargetedSentimentEntityType)
- topicsDetectionJobFilter_jobName :: Lens' TopicsDetectionJobFilter (Maybe Text)
- topicsDetectionJobFilter_jobStatus :: Lens' TopicsDetectionJobFilter (Maybe JobStatus)
- topicsDetectionJobFilter_submitTimeAfter :: Lens' TopicsDetectionJobFilter (Maybe UTCTime)
- topicsDetectionJobFilter_submitTimeBefore :: Lens' TopicsDetectionJobFilter (Maybe UTCTime)
- topicsDetectionJobProperties_dataAccessRoleArn :: Lens' TopicsDetectionJobProperties (Maybe Text)
- topicsDetectionJobProperties_endTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime)
- topicsDetectionJobProperties_inputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe InputDataConfig)
- topicsDetectionJobProperties_jobArn :: Lens' TopicsDetectionJobProperties (Maybe Text)
- topicsDetectionJobProperties_jobId :: Lens' TopicsDetectionJobProperties (Maybe Text)
- topicsDetectionJobProperties_jobName :: Lens' TopicsDetectionJobProperties (Maybe Text)
- topicsDetectionJobProperties_jobStatus :: Lens' TopicsDetectionJobProperties (Maybe JobStatus)
- topicsDetectionJobProperties_message :: Lens' TopicsDetectionJobProperties (Maybe Text)
- topicsDetectionJobProperties_numberOfTopics :: Lens' TopicsDetectionJobProperties (Maybe Int)
- topicsDetectionJobProperties_outputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe OutputDataConfig)
- topicsDetectionJobProperties_submitTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime)
- topicsDetectionJobProperties_volumeKmsKeyId :: Lens' TopicsDetectionJobProperties (Maybe Text)
- topicsDetectionJobProperties_vpcConfig :: Lens' TopicsDetectionJobProperties (Maybe VpcConfig)
- vpcConfig_securityGroupIds :: Lens' VpcConfig (NonEmpty Text)
- vpcConfig_subnets :: Lens' VpcConfig (NonEmpty Text)
Operations
BatchDetectDominantLanguage
batchDetectDominantLanguage_textList :: Lens' BatchDetectDominantLanguage (NonEmpty Text) Source #
A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters. The maximum size of each document is 5 KB.
batchDetectDominantLanguageResponse_httpStatus :: Lens' BatchDetectDominantLanguageResponse Int Source #
The response's http status code.
batchDetectDominantLanguageResponse_resultList :: Lens' BatchDetectDominantLanguageResponse [BatchDetectDominantLanguageItemResult] Source #
A list of objects containing the results of the operation. The results
are sorted in ascending order by the Index
field and match the order
of the documents in the input list. If all of the documents contain an
error, the ResultList
is empty.
batchDetectDominantLanguageResponse_errorList :: Lens' BatchDetectDominantLanguageResponse [BatchItemError] Source #
A list containing one object for each document that contained an error.
The results are sorted in ascending order by the Index
field and match
the order of the documents in the input list. If there are no errors in
the batch, the ErrorList
is empty.
BatchDetectEntities
batchDetectEntities_textList :: Lens' BatchDetectEntities (NonEmpty Text) Source #
A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
batchDetectEntities_languageCode :: Lens' BatchDetectEntities LanguageCode Source #
The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
batchDetectEntitiesResponse_httpStatus :: Lens' BatchDetectEntitiesResponse Int Source #
The response's http status code.
batchDetectEntitiesResponse_resultList :: Lens' BatchDetectEntitiesResponse [BatchDetectEntitiesItemResult] Source #
A list of objects containing the results of the operation. The results
are sorted in ascending order by the Index
field and match the order
of the documents in the input list. If all of the documents contain an
error, the ResultList
is empty.
batchDetectEntitiesResponse_errorList :: Lens' BatchDetectEntitiesResponse [BatchItemError] Source #
A list containing one object for each document that contained an error.
The results are sorted in ascending order by the Index
field and match
the order of the documents in the input list. If there are no errors in
the batch, the ErrorList
is empty.
BatchDetectKeyPhrases
batchDetectKeyPhrases_textList :: Lens' BatchDetectKeyPhrases (NonEmpty Text) Source #
A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
batchDetectKeyPhrases_languageCode :: Lens' BatchDetectKeyPhrases LanguageCode Source #
The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
batchDetectKeyPhrasesResponse_httpStatus :: Lens' BatchDetectKeyPhrasesResponse Int Source #
The response's http status code.
batchDetectKeyPhrasesResponse_resultList :: Lens' BatchDetectKeyPhrasesResponse [BatchDetectKeyPhrasesItemResult] Source #
A list of objects containing the results of the operation. The results
are sorted in ascending order by the Index
field and match the order
of the documents in the input list. If all of the documents contain an
error, the ResultList
is empty.
batchDetectKeyPhrasesResponse_errorList :: Lens' BatchDetectKeyPhrasesResponse [BatchItemError] Source #
A list containing one object for each document that contained an error.
The results are sorted in ascending order by the Index
field and match
the order of the documents in the input list. If there are no errors in
the batch, the ErrorList
is empty.
BatchDetectSentiment
batchDetectSentiment_textList :: Lens' BatchDetectSentiment (NonEmpty Text) Source #
A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
Amazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text and ignores any additional text in the input.
batchDetectSentiment_languageCode :: Lens' BatchDetectSentiment LanguageCode Source #
The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
batchDetectSentimentResponse_httpStatus :: Lens' BatchDetectSentimentResponse Int Source #
The response's http status code.
batchDetectSentimentResponse_resultList :: Lens' BatchDetectSentimentResponse [BatchDetectSentimentItemResult] Source #
A list of objects containing the results of the operation. The results
are sorted in ascending order by the Index
field and match the order
of the documents in the input list. If all of the documents contain an
error, the ResultList
is empty.
batchDetectSentimentResponse_errorList :: Lens' BatchDetectSentimentResponse [BatchItemError] Source #
A list containing one object for each document that contained an error.
The results are sorted in ascending order by the Index
field and match
the order of the documents in the input list. If there are no errors in
the batch, the ErrorList
is empty.
BatchDetectSyntax
batchDetectSyntax_textList :: Lens' BatchDetectSyntax (NonEmpty Text) Source #
A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size for each document is 5 KB.
batchDetectSyntax_languageCode :: Lens' BatchDetectSyntax SyntaxLanguageCode Source #
The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.
batchDetectSyntaxResponse_httpStatus :: Lens' BatchDetectSyntaxResponse Int Source #
The response's http status code.
batchDetectSyntaxResponse_resultList :: Lens' BatchDetectSyntaxResponse [BatchDetectSyntaxItemResult] Source #
A list of objects containing the results of the operation. The results
are sorted in ascending order by the Index
field and match the order
of the documents in the input list. If all of the documents contain an
error, the ResultList
is empty.
batchDetectSyntaxResponse_errorList :: Lens' BatchDetectSyntaxResponse [BatchItemError] Source #
A list containing one object for each document that contained an error.
The results are sorted in ascending order by the Index
field and match
the order of the documents in the input list. If there are no errors in
the batch, the ErrorList
is empty.
BatchDetectTargetedSentiment
batchDetectTargetedSentiment_textList :: Lens' BatchDetectTargetedSentiment (NonEmpty Text) Source #
A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
batchDetectTargetedSentiment_languageCode :: Lens' BatchDetectTargetedSentiment LanguageCode Source #
The language of the input documents. Currently, English is the only supported language.
batchDetectTargetedSentimentResponse_httpStatus :: Lens' BatchDetectTargetedSentimentResponse Int Source #
The response's http status code.
batchDetectTargetedSentimentResponse_resultList :: Lens' BatchDetectTargetedSentimentResponse [BatchDetectTargetedSentimentItemResult] Source #
A list of objects containing the results of the operation. The results
are sorted in ascending order by the Index
field and match the order
of the documents in the input list. If all of the documents contain an
error, the ResultList
is empty.
batchDetectTargetedSentimentResponse_errorList :: Lens' BatchDetectTargetedSentimentResponse [BatchItemError] Source #
List of errors that the operation can return.
ClassifyDocument
classifyDocument_bytes :: Lens' ClassifyDocument (Maybe ByteString) Source #
Use the Bytes
parameter to input a text, PDF, Word or image file. You
can also use the Bytes
parameter to input an Amazon Textract
DetectDocumentText
or AnalyzeDocument
output file.
Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to classify documents, the SDK may encode the document file bytes for you.
The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.
If you use the Bytes
parameter, do not use the Text
parameter.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
classifyDocument_documentReaderConfig :: Lens' ClassifyDocument (Maybe DocumentReaderConfig) Source #
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
classifyDocument_text :: Lens' ClassifyDocument (Maybe Text) Source #
The document text to be analyzed. If you enter text using this
parameter, do not use the Bytes
parameter.
classifyDocument_endpointArn :: Lens' ClassifyDocument Text Source #
The Amazon Resource Number (ARN) of the endpoint. For information about endpoints, see Managing endpoints.
classifyDocumentResponse_classes :: Lens' ClassifyDocumentResponse (Maybe [DocumentClass]) Source #
The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.
classifyDocumentResponse_documentMetadata :: Lens' ClassifyDocumentResponse (Maybe DocumentMetadata) Source #
Extraction information about the document. This field is present in the
response only if your request includes the Byte
parameter.
classifyDocumentResponse_documentType :: Lens' ClassifyDocumentResponse (Maybe [DocumentTypeListItem]) Source #
The document type for each page in the input document. This field is
present in the response only if your request includes the Byte
parameter.
classifyDocumentResponse_errors :: Lens' ClassifyDocumentResponse (Maybe [ErrorsListItem]) Source #
Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
classifyDocumentResponse_labels :: Lens' ClassifyDocumentResponse (Maybe [DocumentLabel]) Source #
The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.
classifyDocumentResponse_httpStatus :: Lens' ClassifyDocumentResponse Int Source #
The response's http status code.
ContainsPiiEntities
containsPiiEntities_text :: Lens' ContainsPiiEntities Text Source #
A UTF-8 text string. The maximum string size is 100 KB.
containsPiiEntities_languageCode :: Lens' ContainsPiiEntities LanguageCode Source #
The language of the input documents. Currently, English is the only valid language.
containsPiiEntitiesResponse_labels :: Lens' ContainsPiiEntitiesResponse (Maybe [EntityLabel]) Source #
The labels used in the document being analyzed. Individual labels represent personally identifiable information (PII) entity types.
containsPiiEntitiesResponse_httpStatus :: Lens' ContainsPiiEntitiesResponse Int Source #
The response's http status code.
CreateDocumentClassifier
createDocumentClassifier_clientRequestToken :: Lens' CreateDocumentClassifier (Maybe Text) Source #
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
createDocumentClassifier_mode :: Lens' CreateDocumentClassifier (Maybe DocumentClassifierMode) Source #
Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
createDocumentClassifier_modelKmsKeyId :: Lens' CreateDocumentClassifier (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"
createDocumentClassifier_modelPolicy :: Lens' CreateDocumentClassifier (Maybe Text) Source #
The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model.
Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
'{"attribute": "value", "attribute": ["value"]}'
createDocumentClassifier_outputDataConfig :: Lens' CreateDocumentClassifier (Maybe DocumentClassifierOutputDataConfig) Source #
Enables the addition of output results configuration parameters for custom classifier jobs.
createDocumentClassifier_tags :: Lens' CreateDocumentClassifier (Maybe [Tag]) Source #
Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
createDocumentClassifier_versionName :: Lens' CreateDocumentClassifier (Maybe Text) Source #
The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/AWS Region.
createDocumentClassifier_volumeKmsKeyId :: Lens' CreateDocumentClassifier (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"
createDocumentClassifier_vpcConfig :: Lens' CreateDocumentClassifier (Maybe VpcConfig) Source #
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
createDocumentClassifier_documentClassifierName :: Lens' CreateDocumentClassifier Text Source #
The name of the document classifier.
createDocumentClassifier_dataAccessRoleArn :: Lens' CreateDocumentClassifier 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.
createDocumentClassifier_inputDataConfig :: Lens' CreateDocumentClassifier DocumentClassifierInputDataConfig Source #
Specifies the format and location of the input data for the job.
createDocumentClassifier_languageCode :: Lens' CreateDocumentClassifier LanguageCode Source #
The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.
createDocumentClassifierResponse_documentClassifierArn :: Lens' CreateDocumentClassifierResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the document classifier.
createDocumentClassifierResponse_httpStatus :: Lens' CreateDocumentClassifierResponse Int Source #
The response's http status code.
CreateEndpoint
createEndpoint_clientRequestToken :: Lens' CreateEndpoint (Maybe Text) Source #
An idempotency token provided by the customer. If this token matches a
previous endpoint creation request, Amazon Comprehend will not return a
ResourceInUseException
.
createEndpoint_dataAccessRoleArn :: Lens' CreateEndpoint (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).
createEndpoint_tags :: Lens' CreateEndpoint (Maybe [Tag]) Source #
Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
createEndpoint_endpointName :: Lens' CreateEndpoint Text Source #
This is the descriptive suffix that becomes part of the EndpointArn
used for all subsequent requests to this resource.
createEndpoint_modelArn :: Lens' CreateEndpoint Text Source #
The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
createEndpoint_desiredInferenceUnits :: Lens' CreateEndpoint 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.
createEndpointResponse_endpointArn :: Lens' CreateEndpointResponse (Maybe Text) Source #
The Amazon Resource Number (ARN) of the endpoint being created.
createEndpointResponse_httpStatus :: Lens' CreateEndpointResponse Int Source #
The response's http status code.
CreateEntityRecognizer
createEntityRecognizer_clientRequestToken :: Lens' CreateEntityRecognizer (Maybe Text) Source #
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
createEntityRecognizer_modelKmsKeyId :: Lens' CreateEntityRecognizer (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"
createEntityRecognizer_modelPolicy :: Lens' CreateEntityRecognizer (Maybe Text) Source #
The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another AWS account to import your custom model.
Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
'{"attribute": "value", "attribute": ["value"]}'
createEntityRecognizer_tags :: Lens' CreateEntityRecognizer (Maybe [Tag]) Source #
Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
createEntityRecognizer_versionName :: Lens' CreateEntityRecognizer (Maybe Text) Source #
The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/ AWS Region.
createEntityRecognizer_volumeKmsKeyId :: Lens' CreateEntityRecognizer (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"
createEntityRecognizer_vpcConfig :: Lens' CreateEntityRecognizer (Maybe VpcConfig) Source #
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.
createEntityRecognizer_recognizerName :: Lens' CreateEntityRecognizer Text Source #
The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.
createEntityRecognizer_dataAccessRoleArn :: Lens' CreateEntityRecognizer 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.
createEntityRecognizer_inputDataConfig :: Lens' CreateEntityRecognizer EntityRecognizerInputDataConfig Source #
Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.
createEntityRecognizer_languageCode :: Lens' CreateEntityRecognizer LanguageCode Source #
You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.
createEntityRecognizerResponse_entityRecognizerArn :: Lens' CreateEntityRecognizerResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the entity recognizer.
createEntityRecognizerResponse_httpStatus :: Lens' CreateEntityRecognizerResponse Int Source #
The response's http status code.
DeleteDocumentClassifier
deleteDocumentClassifier_documentClassifierArn :: Lens' DeleteDocumentClassifier Text Source #
The Amazon Resource Name (ARN) that identifies the document classifier.
deleteDocumentClassifierResponse_httpStatus :: Lens' DeleteDocumentClassifierResponse Int Source #
The response's http status code.
DeleteEndpoint
deleteEndpoint_endpointArn :: Lens' DeleteEndpoint Text Source #
The Amazon Resource Number (ARN) of the endpoint being deleted.
deleteEndpointResponse_httpStatus :: Lens' DeleteEndpointResponse Int Source #
The response's http status code.
DeleteEntityRecognizer
deleteEntityRecognizer_entityRecognizerArn :: Lens' DeleteEntityRecognizer Text Source #
The Amazon Resource Name (ARN) that identifies the entity recognizer.
deleteEntityRecognizerResponse_httpStatus :: Lens' DeleteEntityRecognizerResponse Int Source #
The response's http status code.
DeleteResourcePolicy
deleteResourcePolicy_policyRevisionId :: Lens' DeleteResourcePolicy (Maybe Text) Source #
The revision ID of the policy to delete.
deleteResourcePolicy_resourceArn :: Lens' DeleteResourcePolicy Text Source #
The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.
deleteResourcePolicyResponse_httpStatus :: Lens' DeleteResourcePolicyResponse Int Source #
The response's http status code.
DescribeDocumentClassificationJob
describeDocumentClassificationJob_jobId :: Lens' DescribeDocumentClassificationJob Text Source #
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
describeDocumentClassificationJobResponse_documentClassificationJobProperties :: Lens' DescribeDocumentClassificationJobResponse (Maybe DocumentClassificationJobProperties) Source #
An object that describes the properties associated with the document classification job.
describeDocumentClassificationJobResponse_httpStatus :: Lens' DescribeDocumentClassificationJobResponse Int Source #
The response's http status code.
DescribeDocumentClassifier
describeDocumentClassifier_documentClassifierArn :: Lens' DescribeDocumentClassifier Text Source #
The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its response.
describeDocumentClassifierResponse_documentClassifierProperties :: Lens' DescribeDocumentClassifierResponse (Maybe DocumentClassifierProperties) Source #
An object that contains the properties associated with a document classifier.
describeDocumentClassifierResponse_httpStatus :: Lens' DescribeDocumentClassifierResponse Int Source #
The response's http status code.
DescribeDominantLanguageDetectionJob
describeDominantLanguageDetectionJob_jobId :: Lens' DescribeDominantLanguageDetectionJob Text Source #
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
describeDominantLanguageDetectionJobResponse_dominantLanguageDetectionJobProperties :: Lens' DescribeDominantLanguageDetectionJobResponse (Maybe DominantLanguageDetectionJobProperties) Source #
An object that contains the properties associated with a dominant language detection job.
describeDominantLanguageDetectionJobResponse_httpStatus :: Lens' DescribeDominantLanguageDetectionJobResponse Int Source #
The response's http status code.
DescribeEndpoint
describeEndpoint_endpointArn :: Lens' DescribeEndpoint Text Source #
The Amazon Resource Number (ARN) of the endpoint being described.
describeEndpointResponse_endpointProperties :: Lens' DescribeEndpointResponse (Maybe EndpointProperties) Source #
Describes information associated with the specific endpoint.
describeEndpointResponse_httpStatus :: Lens' DescribeEndpointResponse Int Source #
The response's http status code.
DescribeEntitiesDetectionJob
describeEntitiesDetectionJob_jobId :: Lens' DescribeEntitiesDetectionJob Text Source #
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
describeEntitiesDetectionJobResponse_entitiesDetectionJobProperties :: Lens' DescribeEntitiesDetectionJobResponse (Maybe EntitiesDetectionJobProperties) Source #
An object that contains the properties associated with an entities detection job.
describeEntitiesDetectionJobResponse_httpStatus :: Lens' DescribeEntitiesDetectionJobResponse Int Source #
The response's http status code.
DescribeEntityRecognizer
describeEntityRecognizer_entityRecognizerArn :: Lens' DescribeEntityRecognizer Text Source #
The Amazon Resource Name (ARN) that identifies the entity recognizer.
describeEntityRecognizerResponse_entityRecognizerProperties :: Lens' DescribeEntityRecognizerResponse (Maybe EntityRecognizerProperties) Source #
Describes information associated with an entity recognizer.
describeEntityRecognizerResponse_httpStatus :: Lens' DescribeEntityRecognizerResponse Int Source #
The response's http status code.
DescribeEventsDetectionJob
describeEventsDetectionJob_jobId :: Lens' DescribeEventsDetectionJob Text Source #
The identifier of the events detection job.
describeEventsDetectionJobResponse_eventsDetectionJobProperties :: Lens' DescribeEventsDetectionJobResponse (Maybe EventsDetectionJobProperties) Source #
An object that contains the properties associated with an event detection job.
describeEventsDetectionJobResponse_httpStatus :: Lens' DescribeEventsDetectionJobResponse Int Source #
The response's http status code.
DescribeKeyPhrasesDetectionJob
describeKeyPhrasesDetectionJob_jobId :: Lens' DescribeKeyPhrasesDetectionJob Text Source #
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
describeKeyPhrasesDetectionJobResponse_keyPhrasesDetectionJobProperties :: Lens' DescribeKeyPhrasesDetectionJobResponse (Maybe KeyPhrasesDetectionJobProperties) Source #
An object that contains the properties associated with a key phrases detection job.
describeKeyPhrasesDetectionJobResponse_httpStatus :: Lens' DescribeKeyPhrasesDetectionJobResponse Int Source #
The response's http status code.
DescribePiiEntitiesDetectionJob
describePiiEntitiesDetectionJob_jobId :: Lens' DescribePiiEntitiesDetectionJob Text Source #
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
describePiiEntitiesDetectionJobResponse_piiEntitiesDetectionJobProperties :: Lens' DescribePiiEntitiesDetectionJobResponse (Maybe PiiEntitiesDetectionJobProperties) Source #
Undocumented member.
describePiiEntitiesDetectionJobResponse_httpStatus :: Lens' DescribePiiEntitiesDetectionJobResponse Int Source #
The response's http status code.
DescribeResourcePolicy
describeResourcePolicy_resourceArn :: Lens' DescribeResourcePolicy Text Source #
The Amazon Resource Name (ARN) of the custom model version that has the resource policy.
describeResourcePolicyResponse_creationTime :: Lens' DescribeResourcePolicyResponse (Maybe UTCTime) Source #
The time at which the policy was created.
describeResourcePolicyResponse_lastModifiedTime :: Lens' DescribeResourcePolicyResponse (Maybe UTCTime) Source #
The time at which the policy was last modified.
describeResourcePolicyResponse_policyRevisionId :: Lens' DescribeResourcePolicyResponse (Maybe Text) Source #
The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a new revision ID, and it deletes the prior version of the policy.
describeResourcePolicyResponse_resourcePolicy :: Lens' DescribeResourcePolicyResponse (Maybe Text) Source #
The JSON body of the resource-based policy.
describeResourcePolicyResponse_httpStatus :: Lens' DescribeResourcePolicyResponse Int Source #
The response's http status code.
DescribeSentimentDetectionJob
describeSentimentDetectionJob_jobId :: Lens' DescribeSentimentDetectionJob Text Source #
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
describeSentimentDetectionJobResponse_sentimentDetectionJobProperties :: Lens' DescribeSentimentDetectionJobResponse (Maybe SentimentDetectionJobProperties) Source #
An object that contains the properties associated with a sentiment detection job.
describeSentimentDetectionJobResponse_httpStatus :: Lens' DescribeSentimentDetectionJobResponse Int Source #
The response's http status code.
DescribeTargetedSentimentDetectionJob
describeTargetedSentimentDetectionJob_jobId :: Lens' DescribeTargetedSentimentDetectionJob Text Source #
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
describeTargetedSentimentDetectionJobResponse_targetedSentimentDetectionJobProperties :: Lens' DescribeTargetedSentimentDetectionJobResponse (Maybe TargetedSentimentDetectionJobProperties) Source #
An object that contains the properties associated with a targeted sentiment detection job.
describeTargetedSentimentDetectionJobResponse_httpStatus :: Lens' DescribeTargetedSentimentDetectionJobResponse Int Source #
The response's http status code.
DescribeTopicsDetectionJob
describeTopicsDetectionJob_jobId :: Lens' DescribeTopicsDetectionJob Text Source #
The identifier assigned by the user to the detection job.
describeTopicsDetectionJobResponse_topicsDetectionJobProperties :: Lens' DescribeTopicsDetectionJobResponse (Maybe TopicsDetectionJobProperties) Source #
The list of properties for the requested job.
describeTopicsDetectionJobResponse_httpStatus :: Lens' DescribeTopicsDetectionJobResponse Int Source #
The response's http status code.
DetectDominantLanguage
detectDominantLanguage_text :: Lens' DetectDominantLanguage Text Source #
A UTF-8 text string. The string must contain at least 20 characters. The maximum string size is 100 KB.
detectDominantLanguageResponse_languages :: Lens' DetectDominantLanguageResponse (Maybe [DominantLanguage]) Source #
The languages that Amazon Comprehend detected in the input text. For each language, the response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.
detectDominantLanguageResponse_httpStatus :: Lens' DetectDominantLanguageResponse Int Source #
The response's http status code.
DetectEntities
detectEntities_bytes :: Lens' DetectEntities (Maybe ByteString) Source #
This field applies only when you use a custom entity recognition model
that was trained with PDF annotations. For other cases, enter your text
input in the Text
field.
Use the Bytes
parameter to input a text, PDF, Word or image file.
Using a plain-text file in the Bytes
parameter is equivelent to using
the Text
parameter (the Entities
field in the response is
identical).
You can also use the Bytes
parameter to input an Amazon Textract
DetectDocumentText
or AnalyzeDocument
output file.
Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode the document file bytes for you.
The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.
If you use the Bytes
parameter, do not use the Text
parameter.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
detectEntities_documentReaderConfig :: Lens' DetectEntities (Maybe DocumentReaderConfig) Source #
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
detectEntities_endpointArn :: Lens' DetectEntities (Maybe Text) Source #
The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.
If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.
For information about endpoints, see Managing endpoints.
detectEntities_languageCode :: Lens' DetectEntities (Maybe LanguageCode) Source #
The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.
All input documents must be in the same language.
detectEntities_text :: Lens' DetectEntities (Maybe Text) Source #
A UTF-8 text string. The maximum string size is 100 KB. If you enter
text using this parameter, do not use the Bytes
parameter.
detectEntitiesResponse_blocks :: Lens' DetectEntitiesResponse (Maybe [Block]) Source #
Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.
The Block
content for a Word input document does not include a
Geometry
field.
The Block
field is not present in the response for plain-text inputs.
detectEntitiesResponse_documentMetadata :: Lens' DetectEntitiesResponse (Maybe DocumentMetadata) Source #
Information about the document, discovered during text extraction. This
field is present in the response only if your request used the Byte
parameter.
detectEntitiesResponse_documentType :: Lens' DetectEntitiesResponse (Maybe [DocumentTypeListItem]) Source #
The document type for each page in the input document. This field is
present in the response only if your request used the Byte
parameter.
detectEntitiesResponse_entities :: Lens' DetectEntitiesResponse (Maybe [Entity]) Source #
A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.
If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
detectEntitiesResponse_errors :: Lens' DetectEntitiesResponse (Maybe [ErrorsListItem]) Source #
Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
detectEntitiesResponse_httpStatus :: Lens' DetectEntitiesResponse Int Source #
The response's http status code.
DetectKeyPhrases
detectKeyPhrases_text :: Lens' DetectKeyPhrases Text Source #
A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded characters.
detectKeyPhrases_languageCode :: Lens' DetectKeyPhrases LanguageCode Source #
The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
detectKeyPhrasesResponse_keyPhrases :: Lens' DetectKeyPhrasesResponse (Maybe [KeyPhrase]) Source #
A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.
detectKeyPhrasesResponse_httpStatus :: Lens' DetectKeyPhrasesResponse Int Source #
The response's http status code.
DetectPiiEntities
detectPiiEntities_text :: Lens' DetectPiiEntities Text Source #
A UTF-8 text string. The maximum string size is 100 KB.
detectPiiEntities_languageCode :: Lens' DetectPiiEntities LanguageCode Source #
The language of the input documents. Currently, English is the only valid language.
detectPiiEntitiesResponse_entities :: Lens' DetectPiiEntitiesResponse (Maybe [PiiEntity]) Source #
A collection of PII entities identified in the input text. For each entity, the response provides the entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.
detectPiiEntitiesResponse_httpStatus :: Lens' DetectPiiEntitiesResponse Int Source #
The response's http status code.
DetectSentiment
detectSentiment_text :: Lens' DetectSentiment Text Source #
A UTF-8 text string. The maximum string size is 5 KB.
Amazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text and ignores any additional text in the input.
detectSentiment_languageCode :: Lens' DetectSentiment LanguageCode Source #
The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
detectSentimentResponse_sentiment :: Lens' DetectSentimentResponse (Maybe SentimentType) Source #
The inferred sentiment that Amazon Comprehend has the highest level of confidence in.
detectSentimentResponse_sentimentScore :: Lens' DetectSentimentResponse (Maybe SentimentScore) Source #
An object that lists the sentiments, and their corresponding confidence levels.
detectSentimentResponse_httpStatus :: Lens' DetectSentimentResponse Int Source #
The response's http status code.
DetectSyntax
detectSyntax_text :: Lens' DetectSyntax Text Source #
A UTF-8 string. The maximum string size is 5 KB.
detectSyntax_languageCode :: Lens' DetectSyntax SyntaxLanguageCode Source #
The language code of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt").
detectSyntaxResponse_syntaxTokens :: Lens' DetectSyntaxResponse (Maybe [SyntaxToken]) Source #
A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see Syntax in the Comprehend Developer Guide.
detectSyntaxResponse_httpStatus :: Lens' DetectSyntaxResponse Int Source #
The response's http status code.
DetectTargetedSentiment
detectTargetedSentiment_text :: Lens' DetectTargetedSentiment Text Source #
A UTF-8 text string. The maximum string length is 5 KB.
detectTargetedSentiment_languageCode :: Lens' DetectTargetedSentiment LanguageCode Source #
The language of the input documents. Currently, English is the only supported language.
detectTargetedSentimentResponse_entities :: Lens' DetectTargetedSentimentResponse (Maybe [TargetedSentimentEntity]) Source #
Targeted sentiment analysis for each of the entities identified in the input text.
detectTargetedSentimentResponse_httpStatus :: Lens' DetectTargetedSentimentResponse Int Source #
The response's http status code.
ImportModel
importModel_dataAccessRoleArn :: Lens' ImportModel (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that allows Amazon Comprehend to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.
importModel_modelKmsKeyId :: Lens' ImportModel (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"
importModel_modelName :: Lens' ImportModel (Maybe Text) Source #
The name to assign to the custom model that is created in Amazon Comprehend by this import.
importModel_tags :: Lens' ImportModel (Maybe [Tag]) Source #
Tags to be associated with the custom model that is created by this import. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
importModel_versionName :: Lens' ImportModel (Maybe Text) Source #
The version name given to the custom model that is created by this import. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/AWS Region.
importModel_sourceModelArn :: Lens' ImportModel Text Source #
The Amazon Resource Name (ARN) of the custom model to import.
importModelResponse_modelArn :: Lens' ImportModelResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the custom model being imported.
importModelResponse_httpStatus :: Lens' ImportModelResponse Int Source #
The response's http status code.
ListDocumentClassificationJobs
listDocumentClassificationJobs_filter :: Lens' ListDocumentClassificationJobs (Maybe DocumentClassificationJobFilter) Source #
Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time.
listDocumentClassificationJobs_maxResults :: Lens' ListDocumentClassificationJobs (Maybe Natural) Source #
The maximum number of results to return in each page. The default is 100.
listDocumentClassificationJobs_nextToken :: Lens' ListDocumentClassificationJobs (Maybe Text) Source #
Identifies the next page of results to return.
listDocumentClassificationJobsResponse_documentClassificationJobPropertiesList :: Lens' ListDocumentClassificationJobsResponse (Maybe [DocumentClassificationJobProperties]) Source #
A list containing the properties of each job returned.
listDocumentClassificationJobsResponse_nextToken :: Lens' ListDocumentClassificationJobsResponse (Maybe Text) Source #
Identifies the next page of results to return.
listDocumentClassificationJobsResponse_httpStatus :: Lens' ListDocumentClassificationJobsResponse Int Source #
The response's http status code.
ListDocumentClassifierSummaries
listDocumentClassifierSummaries_maxResults :: Lens' ListDocumentClassifierSummaries (Maybe Natural) Source #
The maximum number of results to return on each page. The default is 100.
listDocumentClassifierSummaries_nextToken :: Lens' ListDocumentClassifierSummaries (Maybe Text) Source #
Identifies the next page of results to return.
listDocumentClassifierSummariesResponse_documentClassifierSummariesList :: Lens' ListDocumentClassifierSummariesResponse (Maybe [DocumentClassifierSummary]) Source #
The list of summaries of document classifiers.
listDocumentClassifierSummariesResponse_nextToken :: Lens' ListDocumentClassifierSummariesResponse (Maybe Text) Source #
Identifies the next page of results to return.
listDocumentClassifierSummariesResponse_httpStatus :: Lens' ListDocumentClassifierSummariesResponse Int Source #
The response's http status code.
ListDocumentClassifiers
listDocumentClassifiers_filter :: Lens' ListDocumentClassifiers (Maybe DocumentClassifierFilter) Source #
Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
listDocumentClassifiers_maxResults :: Lens' ListDocumentClassifiers (Maybe Natural) Source #
The maximum number of results to return in each page. The default is 100.
listDocumentClassifiers_nextToken :: Lens' ListDocumentClassifiers (Maybe Text) Source #
Identifies the next page of results to return.
listDocumentClassifiersResponse_documentClassifierPropertiesList :: Lens' ListDocumentClassifiersResponse (Maybe [DocumentClassifierProperties]) Source #
A list containing the properties of each job returned.
listDocumentClassifiersResponse_nextToken :: Lens' ListDocumentClassifiersResponse (Maybe Text) Source #
Identifies the next page of results to return.
listDocumentClassifiersResponse_httpStatus :: Lens' ListDocumentClassifiersResponse Int Source #
The response's http status code.
ListDominantLanguageDetectionJobs
listDominantLanguageDetectionJobs_filter :: Lens' ListDominantLanguageDetectionJobs (Maybe DominantLanguageDetectionJobFilter) Source #
Filters that jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
listDominantLanguageDetectionJobs_maxResults :: Lens' ListDominantLanguageDetectionJobs (Maybe Natural) Source #
The maximum number of results to return in each page. The default is 100.
listDominantLanguageDetectionJobs_nextToken :: Lens' ListDominantLanguageDetectionJobs (Maybe Text) Source #
Identifies the next page of results to return.
listDominantLanguageDetectionJobsResponse_dominantLanguageDetectionJobPropertiesList :: Lens' ListDominantLanguageDetectionJobsResponse (Maybe [DominantLanguageDetectionJobProperties]) Source #
A list containing the properties of each job that is returned.
listDominantLanguageDetectionJobsResponse_nextToken :: Lens' ListDominantLanguageDetectionJobsResponse (Maybe Text) Source #
Identifies the next page of results to return.
listDominantLanguageDetectionJobsResponse_httpStatus :: Lens' ListDominantLanguageDetectionJobsResponse Int Source #
The response's http status code.
ListEndpoints
listEndpoints_filter :: Lens' ListEndpoints (Maybe EndpointFilter) Source #
Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. You can only set one filter at a time.
listEndpoints_maxResults :: Lens' ListEndpoints (Maybe Natural) Source #
The maximum number of results to return in each page. The default is 100.
listEndpoints_nextToken :: Lens' ListEndpoints (Maybe Text) Source #
Identifies the next page of results to return.
listEndpointsResponse_endpointPropertiesList :: Lens' ListEndpointsResponse (Maybe [EndpointProperties]) Source #
Displays a list of endpoint properties being retrieved by the service in response to the request.
listEndpointsResponse_nextToken :: Lens' ListEndpointsResponse (Maybe Text) Source #
Identifies the next page of results to return.
listEndpointsResponse_httpStatus :: Lens' ListEndpointsResponse Int Source #
The response's http status code.
ListEntitiesDetectionJobs
listEntitiesDetectionJobs_filter :: Lens' ListEntitiesDetectionJobs (Maybe EntitiesDetectionJobFilter) Source #
Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
listEntitiesDetectionJobs_maxResults :: Lens' ListEntitiesDetectionJobs (Maybe Natural) Source #
The maximum number of results to return in each page. The default is 100.
listEntitiesDetectionJobs_nextToken :: Lens' ListEntitiesDetectionJobs (Maybe Text) Source #
Identifies the next page of results to return.
listEntitiesDetectionJobsResponse_entitiesDetectionJobPropertiesList :: Lens' ListEntitiesDetectionJobsResponse (Maybe [EntitiesDetectionJobProperties]) Source #
A list containing the properties of each job that is returned.
listEntitiesDetectionJobsResponse_nextToken :: Lens' ListEntitiesDetectionJobsResponse (Maybe Text) Source #
Identifies the next page of results to return.
listEntitiesDetectionJobsResponse_httpStatus :: Lens' ListEntitiesDetectionJobsResponse Int Source #
The response's http status code.
ListEntityRecognizerSummaries
listEntityRecognizerSummaries_maxResults :: Lens' ListEntityRecognizerSummaries (Maybe Natural) Source #
The maximum number of results to return on each page. The default is 100.
listEntityRecognizerSummaries_nextToken :: Lens' ListEntityRecognizerSummaries (Maybe Text) Source #
Identifies the next page of results to return.
listEntityRecognizerSummariesResponse_entityRecognizerSummariesList :: Lens' ListEntityRecognizerSummariesResponse (Maybe [EntityRecognizerSummary]) Source #
The list entity recognizer summaries.
listEntityRecognizerSummariesResponse_nextToken :: Lens' ListEntityRecognizerSummariesResponse (Maybe Text) Source #
The list entity recognizer summaries.
listEntityRecognizerSummariesResponse_httpStatus :: Lens' ListEntityRecognizerSummariesResponse Int Source #
The response's http status code.
ListEntityRecognizers
listEntityRecognizers_filter :: Lens' ListEntityRecognizers (Maybe EntityRecognizerFilter) Source #
Filters the list of entities returned. You can filter on Status
,
SubmitTimeBefore
, or SubmitTimeAfter
. You can only set one filter at
a time.
listEntityRecognizers_maxResults :: Lens' ListEntityRecognizers (Maybe Natural) Source #
The maximum number of results to return on each page. The default is 100.
listEntityRecognizers_nextToken :: Lens' ListEntityRecognizers (Maybe Text) Source #
Identifies the next page of results to return.
listEntityRecognizersResponse_entityRecognizerPropertiesList :: Lens' ListEntityRecognizersResponse (Maybe [EntityRecognizerProperties]) Source #
The list of properties of an entity recognizer.
listEntityRecognizersResponse_nextToken :: Lens' ListEntityRecognizersResponse (Maybe Text) Source #
Identifies the next page of results to return.
listEntityRecognizersResponse_httpStatus :: Lens' ListEntityRecognizersResponse Int Source #
The response's http status code.
ListEventsDetectionJobs
listEventsDetectionJobs_filter :: Lens' ListEventsDetectionJobs (Maybe EventsDetectionJobFilter) Source #
Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
listEventsDetectionJobs_maxResults :: Lens' ListEventsDetectionJobs (Maybe Natural) Source #
The maximum number of results to return in each page.
listEventsDetectionJobs_nextToken :: Lens' ListEventsDetectionJobs (Maybe Text) Source #
Identifies the next page of results to return.
listEventsDetectionJobsResponse_eventsDetectionJobPropertiesList :: Lens' ListEventsDetectionJobsResponse (Maybe [EventsDetectionJobProperties]) Source #
A list containing the properties of each job that is returned.
listEventsDetectionJobsResponse_nextToken :: Lens' ListEventsDetectionJobsResponse (Maybe Text) Source #
Identifies the next page of results to return.
listEventsDetectionJobsResponse_httpStatus :: Lens' ListEventsDetectionJobsResponse Int Source #
The response's http status code.
ListKeyPhrasesDetectionJobs
listKeyPhrasesDetectionJobs_filter :: Lens' ListKeyPhrasesDetectionJobs (Maybe KeyPhrasesDetectionJobFilter) Source #
Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
listKeyPhrasesDetectionJobs_maxResults :: Lens' ListKeyPhrasesDetectionJobs (Maybe Natural) Source #
The maximum number of results to return in each page. The default is 100.
listKeyPhrasesDetectionJobs_nextToken :: Lens' ListKeyPhrasesDetectionJobs (Maybe Text) Source #
Identifies the next page of results to return.
listKeyPhrasesDetectionJobsResponse_keyPhrasesDetectionJobPropertiesList :: Lens' ListKeyPhrasesDetectionJobsResponse (Maybe [KeyPhrasesDetectionJobProperties]) Source #
A list containing the properties of each job that is returned.
listKeyPhrasesDetectionJobsResponse_nextToken :: Lens' ListKeyPhrasesDetectionJobsResponse (Maybe Text) Source #
Identifies the next page of results to return.
listKeyPhrasesDetectionJobsResponse_httpStatus :: Lens' ListKeyPhrasesDetectionJobsResponse Int Source #
The response's http status code.
ListPiiEntitiesDetectionJobs
listPiiEntitiesDetectionJobs_filter :: Lens' ListPiiEntitiesDetectionJobs (Maybe PiiEntitiesDetectionJobFilter) Source #
Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
listPiiEntitiesDetectionJobs_maxResults :: Lens' ListPiiEntitiesDetectionJobs (Maybe Natural) Source #
The maximum number of results to return in each page.
listPiiEntitiesDetectionJobs_nextToken :: Lens' ListPiiEntitiesDetectionJobs (Maybe Text) Source #
Identifies the next page of results to return.
listPiiEntitiesDetectionJobsResponse_nextToken :: Lens' ListPiiEntitiesDetectionJobsResponse (Maybe Text) Source #
Identifies the next page of results to return.
listPiiEntitiesDetectionJobsResponse_piiEntitiesDetectionJobPropertiesList :: Lens' ListPiiEntitiesDetectionJobsResponse (Maybe [PiiEntitiesDetectionJobProperties]) Source #
A list containing the properties of each job that is returned.
listPiiEntitiesDetectionJobsResponse_httpStatus :: Lens' ListPiiEntitiesDetectionJobsResponse Int Source #
The response's http status code.
ListSentimentDetectionJobs
listSentimentDetectionJobs_filter :: Lens' ListSentimentDetectionJobs (Maybe SentimentDetectionJobFilter) Source #
Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
listSentimentDetectionJobs_maxResults :: Lens' ListSentimentDetectionJobs (Maybe Natural) Source #
The maximum number of results to return in each page. The default is 100.
listSentimentDetectionJobs_nextToken :: Lens' ListSentimentDetectionJobs (Maybe Text) Source #
Identifies the next page of results to return.
listSentimentDetectionJobsResponse_nextToken :: Lens' ListSentimentDetectionJobsResponse (Maybe Text) Source #
Identifies the next page of results to return.
listSentimentDetectionJobsResponse_sentimentDetectionJobPropertiesList :: Lens' ListSentimentDetectionJobsResponse (Maybe [SentimentDetectionJobProperties]) Source #
A list containing the properties of each job that is returned.
listSentimentDetectionJobsResponse_httpStatus :: Lens' ListSentimentDetectionJobsResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.
listTagsForResourceResponse_resourceArn :: Lens' ListTagsForResourceResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #
Tags associated with the Amazon Comprehend resource being queried. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
ListTargetedSentimentDetectionJobs
listTargetedSentimentDetectionJobs_filter :: Lens' ListTargetedSentimentDetectionJobs (Maybe TargetedSentimentDetectionJobFilter) Source #
Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
listTargetedSentimentDetectionJobs_maxResults :: Lens' ListTargetedSentimentDetectionJobs (Maybe Natural) Source #
The maximum number of results to return in each page. The default is 100.
listTargetedSentimentDetectionJobs_nextToken :: Lens' ListTargetedSentimentDetectionJobs (Maybe Text) Source #
Identifies the next page of results to return.
listTargetedSentimentDetectionJobsResponse_nextToken :: Lens' ListTargetedSentimentDetectionJobsResponse (Maybe Text) Source #
Identifies the next page of results to return.
listTargetedSentimentDetectionJobsResponse_targetedSentimentDetectionJobPropertiesList :: Lens' ListTargetedSentimentDetectionJobsResponse (Maybe [TargetedSentimentDetectionJobProperties]) Source #
A list containing the properties of each job that is returned.
listTargetedSentimentDetectionJobsResponse_httpStatus :: Lens' ListTargetedSentimentDetectionJobsResponse Int Source #
The response's http status code.
ListTopicsDetectionJobs
listTopicsDetectionJobs_filter :: Lens' ListTopicsDetectionJobs (Maybe TopicsDetectionJobFilter) Source #
Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time.
listTopicsDetectionJobs_maxResults :: Lens' ListTopicsDetectionJobs (Maybe Natural) Source #
The maximum number of results to return in each page. The default is 100.
listTopicsDetectionJobs_nextToken :: Lens' ListTopicsDetectionJobs (Maybe Text) Source #
Identifies the next page of results to return.
listTopicsDetectionJobsResponse_nextToken :: Lens' ListTopicsDetectionJobsResponse (Maybe Text) Source #
Identifies the next page of results to return.
listTopicsDetectionJobsResponse_topicsDetectionJobPropertiesList :: Lens' ListTopicsDetectionJobsResponse (Maybe [TopicsDetectionJobProperties]) Source #
A list containing the properties of each job that is returned.
listTopicsDetectionJobsResponse_httpStatus :: Lens' ListTopicsDetectionJobsResponse Int Source #
The response's http status code.
PutResourcePolicy
putResourcePolicy_policyRevisionId :: Lens' PutResourcePolicy (Maybe Text) Source #
The revision ID that Amazon Comprehend assigned to the policy that you are updating. If you are creating a new policy that has no prior version, don't use this parameter. Amazon Comprehend creates the revision ID for you.
putResourcePolicy_resourceArn :: Lens' PutResourcePolicy Text Source #
The Amazon Resource Name (ARN) of the custom model to attach the policy to.
putResourcePolicy_resourcePolicy :: Lens' PutResourcePolicy Text Source #
The JSON resource-based policy to attach to your custom model. Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
'{"attribute": "value", "attribute": ["value"]}'
putResourcePolicyResponse_policyRevisionId :: Lens' PutResourcePolicyResponse (Maybe Text) Source #
The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a new revision ID, and it deletes the prior version of the policy.
putResourcePolicyResponse_httpStatus :: Lens' PutResourcePolicyResponse Int Source #
The response's http status code.
StartDocumentClassificationJob
startDocumentClassificationJob_clientRequestToken :: Lens' StartDocumentClassificationJob (Maybe Text) Source #
A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
startDocumentClassificationJob_jobName :: Lens' StartDocumentClassificationJob (Maybe Text) Source #
The identifier of the job.
startDocumentClassificationJob_tags :: Lens' StartDocumentClassificationJob (Maybe [Tag]) Source #
Tags to be associated with the document classification job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
startDocumentClassificationJob_volumeKmsKeyId :: Lens' StartDocumentClassificationJob (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"
startDocumentClassificationJob_vpcConfig :: Lens' StartDocumentClassificationJob (Maybe VpcConfig) Source #
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
startDocumentClassificationJob_documentClassifierArn :: Lens' StartDocumentClassificationJob Text Source #
The Amazon Resource Name (ARN) of the document classifier to use to process the job.
startDocumentClassificationJob_inputDataConfig :: Lens' StartDocumentClassificationJob InputDataConfig Source #
Specifies the format and location of the input data for the job.
startDocumentClassificationJob_outputDataConfig :: Lens' StartDocumentClassificationJob OutputDataConfig Source #
Specifies where to send the output files.
startDocumentClassificationJob_dataAccessRoleArn :: Lens' StartDocumentClassificationJob 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.
startDocumentClassificationJobResponse_jobArn :: Lens' StartDocumentClassificationJobResponse (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
startDocumentClassificationJobResponse_jobId :: Lens' StartDocumentClassificationJobResponse (Maybe Text) Source #
The identifier generated for the job. To get the status of the job, use this identifier with the operation.
startDocumentClassificationJobResponse_jobStatus :: Lens' StartDocumentClassificationJobResponse (Maybe JobStatus) Source #
The status of the job:
- SUBMITTED - The job has been received and queued for processing.
- IN_PROGRESS - Amazon Comprehend is processing the job.
- COMPLETED - The job was successfully completed and the output is available.
- FAILED - The job did not complete. For details, use the operation.
- STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
- STOPPED - The job was successfully stopped without completing.
startDocumentClassificationJobResponse_httpStatus :: Lens' StartDocumentClassificationJobResponse Int Source #
The response's http status code.
StartDominantLanguageDetectionJob
startDominantLanguageDetectionJob_clientRequestToken :: Lens' StartDominantLanguageDetectionJob (Maybe Text) Source #
A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
startDominantLanguageDetectionJob_jobName :: Lens' StartDominantLanguageDetectionJob (Maybe Text) Source #
An identifier for the job.
startDominantLanguageDetectionJob_tags :: Lens' StartDominantLanguageDetectionJob (Maybe [Tag]) Source #
Tags to be associated with the dominant language detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
startDominantLanguageDetectionJob_volumeKmsKeyId :: Lens' StartDominantLanguageDetectionJob (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"
startDominantLanguageDetectionJob_vpcConfig :: Lens' StartDominantLanguageDetectionJob (Maybe VpcConfig) Source #
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.
startDominantLanguageDetectionJob_inputDataConfig :: Lens' StartDominantLanguageDetectionJob InputDataConfig Source #
Specifies the format and location of the input data for the job.
startDominantLanguageDetectionJob_outputDataConfig :: Lens' StartDominantLanguageDetectionJob OutputDataConfig Source #
Specifies where to send the output files.
startDominantLanguageDetectionJob_dataAccessRoleArn :: Lens' StartDominantLanguageDetectionJob 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. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
startDominantLanguageDetectionJobResponse_jobArn :: Lens' StartDominantLanguageDetectionJobResponse (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
startDominantLanguageDetectionJobResponse_jobId :: Lens' StartDominantLanguageDetectionJobResponse (Maybe Text) Source #
The identifier generated for the job. To get the status of a job, use this identifier with the operation.
startDominantLanguageDetectionJobResponse_jobStatus :: Lens' StartDominantLanguageDetectionJobResponse (Maybe JobStatus) Source #
The status of the job.
- SUBMITTED - The job has been received and is queued for processing.
- IN_PROGRESS - Amazon Comprehend is processing the job.
- COMPLETED - The job was successfully completed and the output is available.
- FAILED - The job did not complete. To get details, use the operation.
startDominantLanguageDetectionJobResponse_httpStatus :: Lens' StartDominantLanguageDetectionJobResponse Int Source #
The response's http status code.
StartEntitiesDetectionJob
startEntitiesDetectionJob_clientRequestToken :: Lens' StartEntitiesDetectionJob (Maybe Text) Source #
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
startEntitiesDetectionJob_entityRecognizerArn :: Lens' StartEntitiesDetectionJob (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the specific entity
recognizer to be used by the StartEntitiesDetectionJob
. This ARN is
optional and is only used for a custom entity recognition job.
startEntitiesDetectionJob_jobName :: Lens' StartEntitiesDetectionJob (Maybe Text) Source #
The identifier of the job.
startEntitiesDetectionJob_tags :: Lens' StartEntitiesDetectionJob (Maybe [Tag]) Source #
Tags to be associated with the entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
startEntitiesDetectionJob_volumeKmsKeyId :: Lens' StartEntitiesDetectionJob (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"
startEntitiesDetectionJob_vpcConfig :: Lens' StartEntitiesDetectionJob (Maybe VpcConfig) Source #
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
startEntitiesDetectionJob_inputDataConfig :: Lens' StartEntitiesDetectionJob InputDataConfig Source #
Specifies the format and location of the input data for the job.
startEntitiesDetectionJob_outputDataConfig :: Lens' StartEntitiesDetectionJob OutputDataConfig Source #
Specifies where to send the output files.
startEntitiesDetectionJob_dataAccessRoleArn :: Lens' StartEntitiesDetectionJob 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. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
startEntitiesDetectionJob_languageCode :: Lens' StartEntitiesDetectionJob LanguageCode Source #
The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
startEntitiesDetectionJobResponse_jobArn :: Lens' StartEntitiesDetectionJobResponse (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
startEntitiesDetectionJobResponse_jobId :: Lens' StartEntitiesDetectionJobResponse (Maybe Text) Source #
The identifier generated for the job. To get the status of job, use this identifier with the operation.
startEntitiesDetectionJobResponse_jobStatus :: Lens' StartEntitiesDetectionJobResponse (Maybe JobStatus) Source #
The status of the job.
- SUBMITTED - The job has been received and is queued for processing.
- IN_PROGRESS - Amazon Comprehend is processing the job.
- COMPLETED - The job was successfully completed and the output is available.
- FAILED - The job did not complete. To get details, use the operation.
- STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
- STOPPED - The job was successfully stopped without completing.
startEntitiesDetectionJobResponse_httpStatus :: Lens' StartEntitiesDetectionJobResponse Int Source #
The response's http status code.
StartEventsDetectionJob
startEventsDetectionJob_clientRequestToken :: Lens' StartEventsDetectionJob (Maybe Text) Source #
An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
startEventsDetectionJob_jobName :: Lens' StartEventsDetectionJob (Maybe Text) Source #
The identifier of the events detection job.
startEventsDetectionJob_tags :: Lens' StartEventsDetectionJob (Maybe [Tag]) Source #
Tags to be associated with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
startEventsDetectionJob_inputDataConfig :: Lens' StartEventsDetectionJob InputDataConfig Source #
Specifies the format and location of the input data for the job.
startEventsDetectionJob_outputDataConfig :: Lens' StartEventsDetectionJob OutputDataConfig Source #
Specifies where to send the output files.
startEventsDetectionJob_dataAccessRoleArn :: Lens' StartEventsDetectionJob 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.
startEventsDetectionJob_languageCode :: Lens' StartEventsDetectionJob LanguageCode Source #
The language code of the input documents.
startEventsDetectionJob_targetEventTypes :: Lens' StartEventsDetectionJob (NonEmpty Text) Source #
The types of events to detect in the input documents.
startEventsDetectionJobResponse_jobArn :: Lens' StartEventsDetectionJobResponse (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
startEventsDetectionJobResponse_jobId :: Lens' StartEventsDetectionJobResponse (Maybe Text) Source #
An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
startEventsDetectionJobResponse_jobStatus :: Lens' StartEventsDetectionJobResponse (Maybe JobStatus) Source #
The status of the events detection job.
startEventsDetectionJobResponse_httpStatus :: Lens' StartEventsDetectionJobResponse Int Source #
The response's http status code.
StartKeyPhrasesDetectionJob
startKeyPhrasesDetectionJob_clientRequestToken :: Lens' StartKeyPhrasesDetectionJob (Maybe Text) Source #
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
startKeyPhrasesDetectionJob_jobName :: Lens' StartKeyPhrasesDetectionJob (Maybe Text) Source #
The identifier of the job.
startKeyPhrasesDetectionJob_tags :: Lens' StartKeyPhrasesDetectionJob (Maybe [Tag]) Source #
Tags to be associated with the key phrases detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
startKeyPhrasesDetectionJob_volumeKmsKeyId :: Lens' StartKeyPhrasesDetectionJob (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"
startKeyPhrasesDetectionJob_vpcConfig :: Lens' StartKeyPhrasesDetectionJob (Maybe VpcConfig) Source #
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.
startKeyPhrasesDetectionJob_inputDataConfig :: Lens' StartKeyPhrasesDetectionJob InputDataConfig Source #
Specifies the format and location of the input data for the job.
startKeyPhrasesDetectionJob_outputDataConfig :: Lens' StartKeyPhrasesDetectionJob OutputDataConfig Source #
Specifies where to send the output files.
startKeyPhrasesDetectionJob_dataAccessRoleArn :: Lens' StartKeyPhrasesDetectionJob 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. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
startKeyPhrasesDetectionJob_languageCode :: Lens' StartKeyPhrasesDetectionJob LanguageCode Source #
The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
startKeyPhrasesDetectionJobResponse_jobArn :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the key phrase 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
startKeyPhrasesDetectionJobResponse_jobId :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe Text) Source #
The identifier generated for the job. To get the status of a job, use this identifier with the operation.
startKeyPhrasesDetectionJobResponse_jobStatus :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe JobStatus) Source #
The status of the job.
- SUBMITTED - The job has been received and is queued for processing.
- IN_PROGRESS - Amazon Comprehend is processing the job.
- COMPLETED - The job was successfully completed and the output is available.
- FAILED - The job did not complete. To get details, use the operation.
startKeyPhrasesDetectionJobResponse_httpStatus :: Lens' StartKeyPhrasesDetectionJobResponse Int Source #
The response's http status code.
StartPiiEntitiesDetectionJob
startPiiEntitiesDetectionJob_clientRequestToken :: Lens' StartPiiEntitiesDetectionJob (Maybe Text) Source #
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
startPiiEntitiesDetectionJob_jobName :: Lens' StartPiiEntitiesDetectionJob (Maybe Text) Source #
The identifier of the job.
startPiiEntitiesDetectionJob_redactionConfig :: Lens' StartPiiEntitiesDetectionJob (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.
startPiiEntitiesDetectionJob_tags :: Lens' StartPiiEntitiesDetectionJob (Maybe [Tag]) Source #
Tags to be associated with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
startPiiEntitiesDetectionJob_inputDataConfig :: Lens' StartPiiEntitiesDetectionJob InputDataConfig Source #
The input properties for a PII entities detection job.
startPiiEntitiesDetectionJob_outputDataConfig :: Lens' StartPiiEntitiesDetectionJob OutputDataConfig Source #
Provides configuration parameters for the output of PII entity detection jobs.
startPiiEntitiesDetectionJob_mode :: Lens' StartPiiEntitiesDetectionJob PiiEntitiesDetectionMode Source #
Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
startPiiEntitiesDetectionJob_dataAccessRoleArn :: Lens' StartPiiEntitiesDetectionJob 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.
startPiiEntitiesDetectionJob_languageCode :: Lens' StartPiiEntitiesDetectionJob LanguageCode Source #
The language of the input documents. Currently, English is the only valid language.
startPiiEntitiesDetectionJobResponse_jobArn :: Lens' StartPiiEntitiesDetectionJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the PII entity 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
startPiiEntitiesDetectionJobResponse_jobId :: Lens' StartPiiEntitiesDetectionJobResponse (Maybe Text) Source #
The identifier generated for the job.
startPiiEntitiesDetectionJobResponse_jobStatus :: Lens' StartPiiEntitiesDetectionJobResponse (Maybe JobStatus) Source #
The status of the job.
startPiiEntitiesDetectionJobResponse_httpStatus :: Lens' StartPiiEntitiesDetectionJobResponse Int Source #
The response's http status code.
StartSentimentDetectionJob
startSentimentDetectionJob_clientRequestToken :: Lens' StartSentimentDetectionJob (Maybe Text) Source #
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
startSentimentDetectionJob_jobName :: Lens' StartSentimentDetectionJob (Maybe Text) Source #
The identifier of the job.
startSentimentDetectionJob_tags :: Lens' StartSentimentDetectionJob (Maybe [Tag]) Source #
Tags to be associated with the sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
startSentimentDetectionJob_volumeKmsKeyId :: Lens' StartSentimentDetectionJob (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"
startSentimentDetectionJob_vpcConfig :: Lens' StartSentimentDetectionJob (Maybe VpcConfig) Source #
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.
startSentimentDetectionJob_inputDataConfig :: Lens' StartSentimentDetectionJob InputDataConfig Source #
Specifies the format and location of the input data for the job.
startSentimentDetectionJob_outputDataConfig :: Lens' StartSentimentDetectionJob OutputDataConfig Source #
Specifies where to send the output files.
startSentimentDetectionJob_dataAccessRoleArn :: Lens' StartSentimentDetectionJob 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. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
startSentimentDetectionJob_languageCode :: Lens' StartSentimentDetectionJob LanguageCode Source #
The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
startSentimentDetectionJobResponse_jobArn :: Lens' StartSentimentDetectionJobResponse (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
startSentimentDetectionJobResponse_jobId :: Lens' StartSentimentDetectionJobResponse (Maybe Text) Source #
The identifier generated for the job. To get the status of a job, use this identifier with the operation.
startSentimentDetectionJobResponse_jobStatus :: Lens' StartSentimentDetectionJobResponse (Maybe JobStatus) Source #
The status of the job.
- SUBMITTED - The job has been received and is queued for processing.
- IN_PROGRESS - Amazon Comprehend is processing the job.
- COMPLETED - The job was successfully completed and the output is available.
- FAILED - The job did not complete. To get details, use the operation.
startSentimentDetectionJobResponse_httpStatus :: Lens' StartSentimentDetectionJobResponse Int Source #
The response's http status code.
StartTargetedSentimentDetectionJob
startTargetedSentimentDetectionJob_clientRequestToken :: Lens' StartTargetedSentimentDetectionJob (Maybe Text) Source #
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
startTargetedSentimentDetectionJob_jobName :: Lens' StartTargetedSentimentDetectionJob (Maybe Text) Source #
The identifier of the job.
startTargetedSentimentDetectionJob_tags :: Lens' StartTargetedSentimentDetectionJob (Maybe [Tag]) Source #
Tags to be associated with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
startTargetedSentimentDetectionJob_volumeKmsKeyId :: Lens' StartTargetedSentimentDetectionJob (Maybe Text) Source #
ID for the 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"
startTargetedSentimentDetectionJob_vpcConfig :: Lens' StartTargetedSentimentDetectionJob (Maybe VpcConfig) Source #
Undocumented member.
startTargetedSentimentDetectionJob_inputDataConfig :: Lens' StartTargetedSentimentDetectionJob InputDataConfig Source #
Undocumented member.
startTargetedSentimentDetectionJob_outputDataConfig :: Lens' StartTargetedSentimentDetectionJob OutputDataConfig Source #
Specifies where to send the output files.
startTargetedSentimentDetectionJob_dataAccessRoleArn :: Lens' StartTargetedSentimentDetectionJob 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. For more information, see Role-based permissions.
startTargetedSentimentDetectionJob_languageCode :: Lens' StartTargetedSentimentDetectionJob LanguageCode Source #
The language of the input documents. Currently, English is the only supported language.
startTargetedSentimentDetectionJobResponse_jobArn :: Lens' StartTargetedSentimentDetectionJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the targeted 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>:targeted-sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
startTargetedSentimentDetectionJobResponse_jobId :: Lens' StartTargetedSentimentDetectionJobResponse (Maybe Text) Source #
The identifier generated for the job. To get the status of a job, use this identifier with the operation.
startTargetedSentimentDetectionJobResponse_jobStatus :: Lens' StartTargetedSentimentDetectionJobResponse (Maybe JobStatus) Source #
The status of the job.
- SUBMITTED - The job has been received and is queued for processing.
- IN_PROGRESS - Amazon Comprehend is processing the job.
- COMPLETED - The job was successfully completed and the output is available.
- FAILED - The job did not complete. To get details, use the operation.
startTargetedSentimentDetectionJobResponse_httpStatus :: Lens' StartTargetedSentimentDetectionJobResponse Int Source #
The response's http status code.
StartTopicsDetectionJob
startTopicsDetectionJob_clientRequestToken :: Lens' StartTopicsDetectionJob (Maybe Text) Source #
A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
startTopicsDetectionJob_jobName :: Lens' StartTopicsDetectionJob (Maybe Text) Source #
The identifier of the job.
startTopicsDetectionJob_numberOfTopics :: Lens' StartTopicsDetectionJob (Maybe Natural) Source #
The number of topics to detect.
startTopicsDetectionJob_tags :: Lens' StartTopicsDetectionJob (Maybe [Tag]) Source #
Tags to be associated with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
startTopicsDetectionJob_volumeKmsKeyId :: Lens' StartTopicsDetectionJob (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"
startTopicsDetectionJob_vpcConfig :: Lens' StartTopicsDetectionJob (Maybe VpcConfig) Source #
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
startTopicsDetectionJob_inputDataConfig :: Lens' StartTopicsDetectionJob InputDataConfig Source #
Specifies the format and location of the input data for the job.
startTopicsDetectionJob_outputDataConfig :: Lens' StartTopicsDetectionJob OutputDataConfig Source #
Specifies where to send the output files. The output is a compressed
archive with two files, topic-terms.csv
that lists the terms
associated with each topic, and doc-topics.csv
that lists the
documents associated with each topic
startTopicsDetectionJob_dataAccessRoleArn :: Lens' StartTopicsDetectionJob 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. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
startTopicsDetectionJobResponse_jobArn :: Lens' StartTopicsDetectionJobResponse (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:document-classification-job/1234abcd12ab34cd56ef1234567890ab
startTopicsDetectionJobResponse_jobId :: Lens' StartTopicsDetectionJobResponse (Maybe Text) Source #
The identifier generated for the job. To get the status of the job, use
this identifier with the DescribeTopicDetectionJob
operation.
startTopicsDetectionJobResponse_jobStatus :: Lens' StartTopicsDetectionJobResponse (Maybe JobStatus) Source #
The status of the job:
- SUBMITTED - The job has been received and is queued for processing.
- IN_PROGRESS - Amazon Comprehend is processing the job.
- COMPLETED - The job was successfully completed and the output is available.
- FAILED - The job did not complete. To get details, use the
DescribeTopicDetectionJob
operation.
startTopicsDetectionJobResponse_httpStatus :: Lens' StartTopicsDetectionJobResponse Int Source #
The response's http status code.
StopDominantLanguageDetectionJob
stopDominantLanguageDetectionJob_jobId :: Lens' StopDominantLanguageDetectionJob Text Source #
The identifier of the dominant language detection job to stop.
stopDominantLanguageDetectionJobResponse_jobId :: Lens' StopDominantLanguageDetectionJobResponse (Maybe Text) Source #
The identifier of the dominant language detection job to stop.
stopDominantLanguageDetectionJobResponse_jobStatus :: Lens' StopDominantLanguageDetectionJobResponse (Maybe JobStatus) Source #
Either STOP_REQUESTED
if the job is currently running, or STOPPED
if
the job was previously stopped with the
StopDominantLanguageDetectionJob
operation.
stopDominantLanguageDetectionJobResponse_httpStatus :: Lens' StopDominantLanguageDetectionJobResponse Int Source #
The response's http status code.
StopEntitiesDetectionJob
stopEntitiesDetectionJob_jobId :: Lens' StopEntitiesDetectionJob Text Source #
The identifier of the entities detection job to stop.
stopEntitiesDetectionJobResponse_jobId :: Lens' StopEntitiesDetectionJobResponse (Maybe Text) Source #
The identifier of the entities detection job to stop.
stopEntitiesDetectionJobResponse_jobStatus :: Lens' StopEntitiesDetectionJobResponse (Maybe JobStatus) Source #
Either STOP_REQUESTED
if the job is currently running, or STOPPED
if
the job was previously stopped with the StopEntitiesDetectionJob
operation.
stopEntitiesDetectionJobResponse_httpStatus :: Lens' StopEntitiesDetectionJobResponse Int Source #
The response's http status code.
StopEventsDetectionJob
stopEventsDetectionJob_jobId :: Lens' StopEventsDetectionJob Text Source #
The identifier of the events detection job to stop.
stopEventsDetectionJobResponse_jobId :: Lens' StopEventsDetectionJobResponse (Maybe Text) Source #
The identifier of the events detection job to stop.
stopEventsDetectionJobResponse_jobStatus :: Lens' StopEventsDetectionJobResponse (Maybe JobStatus) Source #
The status of the events detection job.
stopEventsDetectionJobResponse_httpStatus :: Lens' StopEventsDetectionJobResponse Int Source #
The response's http status code.
StopKeyPhrasesDetectionJob
stopKeyPhrasesDetectionJob_jobId :: Lens' StopKeyPhrasesDetectionJob Text Source #
The identifier of the key phrases detection job to stop.
stopKeyPhrasesDetectionJobResponse_jobId :: Lens' StopKeyPhrasesDetectionJobResponse (Maybe Text) Source #
The identifier of the key phrases detection job to stop.
stopKeyPhrasesDetectionJobResponse_jobStatus :: Lens' StopKeyPhrasesDetectionJobResponse (Maybe JobStatus) Source #
Either STOP_REQUESTED
if the job is currently running, or STOPPED
if
the job was previously stopped with the StopKeyPhrasesDetectionJob
operation.
stopKeyPhrasesDetectionJobResponse_httpStatus :: Lens' StopKeyPhrasesDetectionJobResponse Int Source #
The response's http status code.
StopPiiEntitiesDetectionJob
stopPiiEntitiesDetectionJob_jobId :: Lens' StopPiiEntitiesDetectionJob Text Source #
The identifier of the PII entities detection job to stop.
stopPiiEntitiesDetectionJobResponse_jobId :: Lens' StopPiiEntitiesDetectionJobResponse (Maybe Text) Source #
The identifier of the PII entities detection job to stop.
stopPiiEntitiesDetectionJobResponse_jobStatus :: Lens' StopPiiEntitiesDetectionJobResponse (Maybe JobStatus) Source #
The status of the PII entities detection job.
stopPiiEntitiesDetectionJobResponse_httpStatus :: Lens' StopPiiEntitiesDetectionJobResponse Int Source #
The response's http status code.
StopSentimentDetectionJob
stopSentimentDetectionJob_jobId :: Lens' StopSentimentDetectionJob Text Source #
The identifier of the sentiment detection job to stop.
stopSentimentDetectionJobResponse_jobId :: Lens' StopSentimentDetectionJobResponse (Maybe Text) Source #
The identifier of the sentiment detection job to stop.
stopSentimentDetectionJobResponse_jobStatus :: Lens' StopSentimentDetectionJobResponse (Maybe JobStatus) Source #
Either STOP_REQUESTED
if the job is currently running, or STOPPED
if
the job was previously stopped with the StopSentimentDetectionJob
operation.
stopSentimentDetectionJobResponse_httpStatus :: Lens' StopSentimentDetectionJobResponse Int Source #
The response's http status code.
StopTargetedSentimentDetectionJob
stopTargetedSentimentDetectionJob_jobId :: Lens' StopTargetedSentimentDetectionJob Text Source #
The identifier of the targeted sentiment detection job to stop.
stopTargetedSentimentDetectionJobResponse_jobId :: Lens' StopTargetedSentimentDetectionJobResponse (Maybe Text) Source #
The identifier of the targeted sentiment detection job to stop.
stopTargetedSentimentDetectionJobResponse_jobStatus :: Lens' StopTargetedSentimentDetectionJobResponse (Maybe JobStatus) Source #
Either STOP_REQUESTED
if the job is currently running, or STOPPED
if
the job was previously stopped with the StopSentimentDetectionJob
operation.
stopTargetedSentimentDetectionJobResponse_httpStatus :: Lens' StopTargetedSentimentDetectionJobResponse Int Source #
The response's http status code.
StopTrainingDocumentClassifier
stopTrainingDocumentClassifier_documentClassifierArn :: Lens' StopTrainingDocumentClassifier Text Source #
The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.
stopTrainingDocumentClassifierResponse_httpStatus :: Lens' StopTrainingDocumentClassifierResponse Int Source #
The response's http status code.
StopTrainingEntityRecognizer
stopTrainingEntityRecognizer_entityRecognizerArn :: Lens' StopTrainingEntityRecognizer Text Source #
The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.
stopTrainingEntityRecognizerResponse_httpStatus :: Lens' StopTrainingEntityRecognizerResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags.
tagResource_tags :: Lens' TagResource [Tag] Source #
Tags being associated with a specific Amazon Comprehend resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
The initial part of a key-value pair that forms a tag being removed from a given resource. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. Keys must be unique and cannot be duplicated for a particular resource.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateEndpoint
updateEndpoint_desiredDataAccessRoleArn :: Lens' UpdateEndpoint (Maybe Text) Source #
Data access role ARN to use in case the new model is encrypted with a customer CMK.
updateEndpoint_desiredInferenceUnits :: Lens' UpdateEndpoint (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.
updateEndpoint_desiredModelArn :: Lens' UpdateEndpoint (Maybe Text) Source #
The ARN of the new model to use when updating an existing endpoint.
updateEndpoint_endpointArn :: Lens' UpdateEndpoint Text Source #
The Amazon Resource Number (ARN) of the endpoint being updated.
updateEndpointResponse_httpStatus :: Lens' UpdateEndpointResponse Int Source #
The response's http status code.
Types
AugmentedManifestsListItem
augmentedManifestsListItem_annotationDataS3Uri :: Lens' AugmentedManifestsListItem (Maybe Text) Source #
The S3 prefix to the annotation files that are referred 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_DOCUMENT
A document type that represents any unicode text that is encoded in UTF-8.SEMI_STRUCTURED_DOCUMENT
A 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_sourceDocumentsS3Uri :: Lens' AugmentedManifestsListItem (Maybe Text) Source #
The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
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_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
batchDetectDominantLanguageItemResult_index :: Lens' BatchDetectDominantLanguageItemResult (Maybe Int) Source #
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.
BatchDetectEntitiesItemResult
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
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
batchDetectSentimentItemResult_index :: Lens' BatchDetectSentimentItemResult (Maybe Int) Source #
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.
BatchDetectSyntaxItemResult
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.
BatchDetectTargetedSentimentItemResult
batchDetectTargetedSentimentItemResult_entities :: Lens' BatchDetectTargetedSentimentItemResult (Maybe [TargetedSentimentEntity]) Source #
An array of targeted sentiment entities.
batchDetectTargetedSentimentItemResult_index :: Lens' BatchDetectTargetedSentimentItemResult (Maybe Int) Source #
The zero-based index of this result in the input list.
BatchItemError
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.
Block
block_blockType :: Lens' Block (Maybe BlockType) Source #
The block represents a line of text or one word of text.
- WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
- LINE - A string of tab-delimited, contiguous words that are detected on a document page
block_geometry :: Lens' Block (Maybe Geometry) Source #
Co-ordinates of the rectangle or polygon that contains the text.
block_relationships :: Lens' Block (Maybe [RelationshipsListItem]) Source #
A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text.
BlockReference
blockReference_beginOffset :: Lens' BlockReference (Maybe Int) Source #
Offset of the start of the block within its parent block.
blockReference_blockId :: Lens' BlockReference (Maybe Text) Source #
Unique identifier for the block.
blockReference_childBlocks :: Lens' BlockReference (Maybe [ChildBlock]) Source #
List of child blocks within this block.
blockReference_endOffset :: Lens' BlockReference (Maybe Int) Source #
Offset of the end of the block within its parent block.
BoundingBox
boundingBox_height :: Lens' BoundingBox (Maybe Double) Source #
The height of the bounding box as a ratio of the overall document page height.
boundingBox_left :: Lens' BoundingBox (Maybe Double) Source #
The left coordinate of the bounding box as a ratio of overall document page width.
boundingBox_top :: Lens' BoundingBox (Maybe Double) Source #
The top coordinate of the bounding box as a ratio of overall document page height.
boundingBox_width :: Lens' BoundingBox (Maybe Double) Source #
The width of the bounding box as a ratio of the overall document page width.
ChildBlock
childBlock_beginOffset :: Lens' ChildBlock (Maybe Int) Source #
Offset of the start of the child block within its parent block.
childBlock_childBlockId :: Lens' ChildBlock (Maybe Text) Source #
Unique identifier for the child block.
childBlock_endOffset :: Lens' ChildBlock (Maybe Int) Source #
Offset of the end of the child block within its parent block.
ClassifierEvaluationMetrics
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.
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_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_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_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_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_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.
ClassifierMetadata
classifierMetadata_evaluationMetrics :: Lens' ClassifierMetadata (Maybe ClassifierEvaluationMetrics) Source #
Describes the result metrics for the test data associated with an documentation classifier.
classifierMetadata_numberOfLabels :: Lens' ClassifierMetadata (Maybe Int) Source #
The number of labels in the input data.
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.
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.
DocumentClass
documentClass_name :: Lens' DocumentClass (Maybe Text) Source #
The name of the class.
documentClass_page :: Lens' DocumentClass (Maybe Int) Source #
Page number in the input document. This field is present in the response
only if your request includes the Byte
parameter.
documentClass_score :: Lens' DocumentClass (Maybe Double) Source #
The confidence score that Amazon Comprehend has this class correctly attributed.
DocumentClassificationJobFilter
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.
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.
DocumentClassificationJobProperties
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_documentClassifierArn :: Lens' DocumentClassificationJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the document classifier.
documentClassificationJobProperties_endTime :: Lens' DocumentClassificationJobProperties (Maybe UTCTime) Source #
The time that the document classification job completed.
documentClassificationJobProperties_inputDataConfig :: Lens' DocumentClassificationJobProperties (Maybe InputDataConfig) Source #
The input data configuration that you supplied when you created 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_jobId :: Lens' DocumentClassificationJobProperties (Maybe Text) Source #
The identifier assigned to the document classification job.
documentClassificationJobProperties_jobName :: Lens' DocumentClassificationJobProperties (Maybe Text) Source #
The name that you assigned to the document classification job.
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_outputDataConfig :: Lens' DocumentClassificationJobProperties (Maybe OutputDataConfig) Source #
The output data configuration that you supplied when you created the document classification job.
documentClassificationJobProperties_submitTime :: Lens' DocumentClassificationJobProperties (Maybe UTCTime) Source #
The time that the document classification job was submitted for processing.
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_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.
DocumentClassifierFilter
documentClassifierFilter_documentClassifierName :: Lens' DocumentClassifierFilter (Maybe Text) Source #
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.
DocumentClassifierInputDataConfig
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 theS3Uri
parameter 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
AugmentedManifests
parameter 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_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
.
documentClassifierInputDataConfig_testS3Uri :: Lens' DocumentClassifierInputDataConfig (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.
DocumentClassifierOutputDataConfig
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
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_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_documentClassifierArn :: Lens' DocumentClassifierProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the document classifier.
documentClassifierProperties_endTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) Source #
The time that training the document classifier completed.
documentClassifierProperties_inputDataConfig :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierInputDataConfig) Source #
The input data configuration that you supplied when you created the document classifier for training.
documentClassifierProperties_languageCode :: Lens' DocumentClassifierProperties (Maybe LanguageCode) Source #
The language code for the language of the documents that the classifier was trained on.
documentClassifierProperties_message :: Lens' DocumentClassifierProperties (Maybe Text) Source #
Additional information about the status of the classifier.
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_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_outputDataConfig :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierOutputDataConfig) Source #
Provides output results configuration parameters for custom classifier jobs.
documentClassifierProperties_sourceModelArn :: Lens' DocumentClassifierProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the document classifier model in your AWS account.
documentClassifierProperties_status :: Lens' DocumentClassifierProperties (Maybe ModelStatus) 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_submitTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) Source #
The time that the document classifier was submitted for training.
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_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_versionName :: Lens' DocumentClassifierProperties (Maybe Text) Source #
The version name that you assigned to the document classifier.
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_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.
DocumentClassifierSummary
documentClassifierSummary_documentClassifierName :: Lens' DocumentClassifierSummary (Maybe Text) Source #
The name that you assigned the document classifier.
documentClassifierSummary_latestVersionCreatedAt :: Lens' DocumentClassifierSummary (Maybe UTCTime) Source #
The time that the latest document classifier version was submitted for processing.
documentClassifierSummary_latestVersionName :: Lens' DocumentClassifierSummary (Maybe Text) Source #
The version name you assigned to the latest document classifier version.
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.
DocumentLabel
documentLabel_name :: Lens' DocumentLabel (Maybe Text) Source #
The name of the label.
documentLabel_page :: Lens' DocumentLabel (Maybe Int) Source #
Page number where the label occurs. This field is present in the
response only if your request includes the Byte
parameter.
documentLabel_score :: Lens' DocumentLabel (Maybe Double) Source #
The confidence score that Amazon Comprehend has this label correctly attributed.
DocumentMetadata
documentMetadata_extractedCharacters :: Lens' DocumentMetadata (Maybe [ExtractedCharactersListItem]) Source #
List of pages in the document, with the number of characters extracted from each page.
documentMetadata_pages :: Lens' DocumentMetadata (Maybe Int) Source #
Number of pages in the document.
DocumentReaderConfig
documentReaderConfig_documentReadMode :: Lens' DocumentReaderConfig (Maybe DocumentReadMode) Source #
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT
- use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION
- Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.
documentReaderConfig_featureTypes :: Lens' DocumentReaderConfig (Maybe (NonEmpty DocumentReadFeatureTypes)) Source #
Specifies the type of Amazon Textract features to apply. If you chose
TEXTRACT_ANALYZE_DOCUMENT
as the read action, you must specify one or
both of the following values:
TABLES
- Returns information about any tables that are detected in the input document.FORMS
- Returns information and the data from any forms that are detected in the input document.
documentReaderConfig_documentReadAction :: Lens' DocumentReaderConfig DocumentReadAction Source #
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT
- The Amazon Comprehend service uses theDetectDocumentText
API operation.TEXTRACT_ANALYZE_DOCUMENT
- The Amazon Comprehend service uses theAnalyzeDocument
API operation.
DocumentTypeListItem
documentTypeListItem_page :: Lens' DocumentTypeListItem (Maybe Int) Source #
Page number.
documentTypeListItem_type :: Lens' DocumentTypeListItem (Maybe DocumentType) Source #
Document type.
DominantLanguage
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
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.
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.
DominantLanguageDetectionJobProperties
dominantLanguageDetectionJobProperties_dataAccessRoleArn :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
dominantLanguageDetectionJobProperties_endTime :: Lens' DominantLanguageDetectionJobProperties (Maybe UTCTime) Source #
The time that the dominant language detection job completed.
dominantLanguageDetectionJobProperties_inputDataConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe InputDataConfig) Source #
The input data configuration that you supplied when you created 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_jobId :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the dominant language detection job.
dominantLanguageDetectionJobProperties_jobName :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) Source #
The name that you assigned to the dominant language detection job.
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_outputDataConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe OutputDataConfig) Source #
The output data configuration that you supplied when you created the dominant language detection job.
dominantLanguageDetectionJobProperties_submitTime :: Lens' DominantLanguageDetectionJobProperties (Maybe UTCTime) Source #
The time that the dominant language detection job was submitted for processing.
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_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.
EndpointFilter
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.
endpointFilter_modelArn :: Lens' EndpointFilter (Maybe Text) Source #
The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
endpointFilter_status :: Lens' EndpointFilter (Maybe EndpointStatus) Source #
Specifies the status of the endpoint being returned. Possible values are: Creating, Ready, Updating, Deleting, Failed.
EndpointProperties
endpointProperties_creationTime :: Lens' EndpointProperties (Maybe UTCTime) Source #
The creation date and time of the endpoint.
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_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_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_endpointArn :: Lens' EndpointProperties (Maybe Text) Source #
The Amazon Resource Number (ARN) of the endpoint.
endpointProperties_lastModifiedTime :: Lens' EndpointProperties (Maybe UTCTime) Source #
The date and time that the endpoint was last modified.
endpointProperties_message :: Lens' EndpointProperties (Maybe Text) Source #
Specifies a reason for failure in cases of Failed
status.
endpointProperties_modelArn :: Lens' EndpointProperties (Maybe Text) Source #
The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
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.
EntitiesDetectionJobFilter
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.
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.
EntitiesDetectionJobProperties
entitiesDetectionJobProperties_dataAccessRoleArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
entitiesDetectionJobProperties_endTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime) Source #
The time that the entities detection job completed
entitiesDetectionJobProperties_entityRecognizerArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the entity recognizer.
entitiesDetectionJobProperties_inputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe InputDataConfig) Source #
The input data configuration that you supplied when you created 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_jobId :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the entities detection job.
entitiesDetectionJobProperties_jobName :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #
The name that you assigned the entities detection job.
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_languageCode :: Lens' EntitiesDetectionJobProperties (Maybe LanguageCode) Source #
The language code of the input documents.
entitiesDetectionJobProperties_message :: Lens' EntitiesDetectionJobProperties (Maybe Text) Source #
A description of the status of a job.
entitiesDetectionJobProperties_outputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe OutputDataConfig) Source #
The output data configuration that you supplied when you created the entities detection job.
entitiesDetectionJobProperties_submitTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime) Source #
The time that the entities detection job was submitted for processing.
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_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.
Entity
entity_beginOffset :: Lens' Entity (Maybe Int) Source #
The zero-based offset from the beginning of the source text to the first character in the entity.
This field is empty for non-text input.
entity_blockReferences :: Lens' Entity (Maybe [BlockReference]) Source #
A reference to each block for this entity. This field is empty for plain-text input.
entity_endOffset :: Lens' Entity (Maybe Int) Source #
The zero-based offset from the beginning of the source text to the last character in the entity.
This field is empty for non-text input.
entity_score :: Lens' Entity (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
entity_type :: Lens' Entity (Maybe EntityType) Source #
The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
EntityLabel
entityLabel_name :: Lens' EntityLabel (Maybe PiiEntityType) Source #
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.
EntityRecognizerAnnotations
entityRecognizerAnnotations_testS3Uri :: Lens' EntityRecognizerAnnotations (Maybe Text) Source #
Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same 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
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
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
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. For plain text entity recognizer
models, the range is 0 to 100, where 100 is the best score. For
PDF/Word entity recognizer models, the range is 0 to 1, where 1 is the
best score.
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_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.
EntityRecognizerFilter
entityRecognizerFilter_recognizerName :: Lens' EntityRecognizerFilter (Maybe Text) Source #
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.
EntityRecognizerInputDataConfig
entityRecognizerInputDataConfig_annotations :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerAnnotations) Source #
The S3 location of the CSV file that annotates your training documents.
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_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
Annotations
orEntityList
parameters. You must provide your training documents by using theDocuments
parameter.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
AugmentedManifests
parameter 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
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_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.
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.
EntityRecognizerMetadataEntityTypesListItem
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_numberOfTrainMentions :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe Int) Source #
Indicates the number of times the given entity type was seen in the training data.
entityRecognizerMetadataEntityTypesListItem_type :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe Text) Source #
Type of entity from the list of entity types in the metadata of an entity recognizer.
EntityRecognizerProperties
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_endTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) Source #
The time that the recognizer creation completed.
entityRecognizerProperties_entityRecognizerArn :: Lens' EntityRecognizerProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the entity recognizer.
entityRecognizerProperties_inputDataConfig :: Lens' EntityRecognizerProperties (Maybe EntityRecognizerInputDataConfig) Source #
The input data properties of an 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_message :: Lens' EntityRecognizerProperties (Maybe Text) Source #
A description of the status of the 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_recognizerMetadata :: Lens' EntityRecognizerProperties (Maybe EntityRecognizerMetadata) Source #
Provides information about an entity recognizer.
entityRecognizerProperties_sourceModelArn :: Lens' EntityRecognizerProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the entity recognizer model in your AWS account.
entityRecognizerProperties_status :: Lens' EntityRecognizerProperties (Maybe ModelStatus) Source #
Provides the status of the entity recognizer.
entityRecognizerProperties_submitTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) Source #
The time that the recognizer was submitted for processing.
entityRecognizerProperties_trainingEndTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) Source #
The time that training of the entity recognizer was completed.
entityRecognizerProperties_trainingStartTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) Source #
The time that training of the entity recognizer started.
entityRecognizerProperties_versionName :: Lens' EntityRecognizerProperties (Maybe Text) Source #
The version name you assigned to the entity recognizer.
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_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.
EntityRecognizerSummary
entityRecognizerSummary_latestVersionCreatedAt :: Lens' EntityRecognizerSummary (Maybe UTCTime) Source #
The time that the latest entity recognizer version was submitted for processing.
entityRecognizerSummary_latestVersionName :: Lens' EntityRecognizerSummary (Maybe Text) Source #
The version name you assigned to the latest entity recognizer version.
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_recognizerName :: Lens' EntityRecognizerSummary (Maybe Text) Source #
The name that you assigned the entity recognizer.
EntityTypesEvaluationMetrics
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.
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_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.
EntityTypesListItem
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).
ErrorsListItem
errorsListItem_errorCode :: Lens' ErrorsListItem (Maybe PageBasedErrorCode) Source #
Error code for the cause of the error.
errorsListItem_errorMessage :: Lens' ErrorsListItem (Maybe Text) Source #
Text message explaining the reason for the error.
errorsListItem_page :: Lens' ErrorsListItem (Maybe Int) Source #
Page number where the error occurred.
EventsDetectionJobFilter
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.
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.
EventsDetectionJobProperties
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_endTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime) Source #
The time that the events detection job completed.
eventsDetectionJobProperties_inputDataConfig :: Lens' EventsDetectionJobProperties (Maybe InputDataConfig) Source #
The input data configuration that you supplied when you created 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_jobId :: Lens' EventsDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the events detection job.
eventsDetectionJobProperties_jobName :: Lens' EventsDetectionJobProperties (Maybe Text) Source #
The name you assigned the events detection job.
eventsDetectionJobProperties_jobStatus :: Lens' EventsDetectionJobProperties (Maybe JobStatus) Source #
The current status of the events detection job.
eventsDetectionJobProperties_languageCode :: Lens' EventsDetectionJobProperties (Maybe LanguageCode) Source #
The language code of the input documents.
eventsDetectionJobProperties_message :: Lens' EventsDetectionJobProperties (Maybe Text) Source #
A description of the status of the events detection job.
eventsDetectionJobProperties_outputDataConfig :: Lens' EventsDetectionJobProperties (Maybe OutputDataConfig) Source #
The output data configuration that you supplied when you created the events detection job.
eventsDetectionJobProperties_submitTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime) Source #
The time that the events detection job was submitted for processing.
eventsDetectionJobProperties_targetEventTypes :: Lens' EventsDetectionJobProperties (Maybe (NonEmpty Text)) Source #
The types of events that are detected by the job.
ExtractedCharactersListItem
extractedCharactersListItem_count :: Lens' ExtractedCharactersListItem (Maybe Int) Source #
Number of characters extracted from each page.
extractedCharactersListItem_page :: Lens' ExtractedCharactersListItem (Maybe Int) Source #
Page number.
Geometry
geometry_boundingBox :: Lens' Geometry (Maybe BoundingBox) Source #
An axis-aligned coarse representation of the location of the recognized item on the document page.
geometry_polygon :: Lens' Geometry (Maybe [Point]) Source #
Within the bounding box, a fine-grained polygon around the recognized item.
InputDataConfig
inputDataConfig_documentReaderConfig :: Lens' InputDataConfig (Maybe DocumentReaderConfig) Source #
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
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
keyPhrase_beginOffset :: Lens' KeyPhrase (Maybe Int) Source #
The zero-based offset from the beginning of the source text to the first character in the key phrase.
keyPhrase_endOffset :: Lens' KeyPhrase (Maybe Int) Source #
The zero-based offset from the beginning of the source text to the last character in the key phrase.
keyPhrase_score :: Lens' KeyPhrase (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
KeyPhrasesDetectionJobFilter
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.
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.
KeyPhrasesDetectionJobProperties
keyPhrasesDetectionJobProperties_dataAccessRoleArn :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
keyPhrasesDetectionJobProperties_endTime :: Lens' KeyPhrasesDetectionJobProperties (Maybe UTCTime) Source #
The time that the key phrases detection job completed.
keyPhrasesDetectionJobProperties_inputDataConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe InputDataConfig) Source #
The input data configuration that you supplied when you created 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_jobId :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the key phrases detection job.
keyPhrasesDetectionJobProperties_jobName :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) Source #
The name that you assigned the key phrases detection job.
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_languageCode :: Lens' KeyPhrasesDetectionJobProperties (Maybe LanguageCode) Source #
The language code of the input documents.
keyPhrasesDetectionJobProperties_message :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) Source #
A description of the status of a job.
keyPhrasesDetectionJobProperties_outputDataConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe OutputDataConfig) Source #
The output data configuration that you supplied when you created the key phrases detection job.
keyPhrasesDetectionJobProperties_submitTime :: Lens' KeyPhrasesDetectionJobProperties (Maybe UTCTime) Source #
The time that the key phrases detection job was submitted for processing.
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_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.
MentionSentiment
mentionSentiment_sentiment :: Lens' MentionSentiment (Maybe SentimentType) Source #
The sentiment of the mention.
mentionSentiment_sentimentScore :: Lens' MentionSentiment (Maybe SentimentScore) Source #
Undocumented member.
OutputDataConfig
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.
For a PII entity detection job, the output file is plain text, not a
compressed archive. The output file name is the same as the input file,
with .out
appended at the end.
PartOfSpeechTag
partOfSpeechTag_score :: Lens' PartOfSpeechTag (Maybe Double) Source #
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.
PiiEntitiesDetectionJobFilter
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.
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.
PiiEntitiesDetectionJobProperties
piiEntitiesDetectionJobProperties_dataAccessRoleArn :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
piiEntitiesDetectionJobProperties_endTime :: Lens' PiiEntitiesDetectionJobProperties (Maybe UTCTime) Source #
The time that the PII entities detection job completed.
piiEntitiesDetectionJobProperties_inputDataConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe InputDataConfig) Source #
The input properties for a 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_jobId :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the PII entities detection job.
piiEntitiesDetectionJobProperties_jobName :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) Source #
The name that you assigned the PII entities detection job.
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_languageCode :: Lens' PiiEntitiesDetectionJobProperties (Maybe LanguageCode) Source #
The language code of the input documents
piiEntitiesDetectionJobProperties_message :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) Source #
A description of the status of a 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_outputDataConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe PiiOutputDataConfig) Source #
The output data configuration that you supplied when you created the 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_submitTime :: Lens' PiiEntitiesDetectionJobProperties (Maybe UTCTime) Source #
The time that the PII entities detection job was submitted for processing.
PiiEntity
piiEntity_beginOffset :: Lens' PiiEntity (Maybe Int) Source #
The zero-based offset from the beginning of the source text to the first character in the entity.
piiEntity_endOffset :: Lens' PiiEntity (Maybe Int) Source #
The zero-based offset from the beginning of the source text to the last character in the entity.
piiEntity_score :: Lens' PiiEntity (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
piiEntity_type :: Lens' PiiEntity (Maybe PiiEntityType) Source #
The entity's type.
PiiOutputDataConfig
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.
For a PII entity detection job, the output file is plain text, not a
compressed archive. The output file name is the same as the input file,
with .out
appended at the end.
Point
point_x :: Lens' Point (Maybe Double) Source #
The value of the X coordinate for a point on a polygon
point_y :: Lens' Point (Maybe Double) Source #
The value of the Y coordinate for a point on a polygon
RedactionConfig
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.
RelationshipsListItem
relationshipsListItem_ids :: Lens' RelationshipsListItem (Maybe [Text]) Source #
Identifers of the child blocks.
relationshipsListItem_type :: Lens' RelationshipsListItem (Maybe RelationshipType) Source #
Only supported relationship is a child relationship.
SentimentDetectionJobFilter
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.
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.
SentimentDetectionJobProperties
sentimentDetectionJobProperties_dataAccessRoleArn :: Lens' SentimentDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
sentimentDetectionJobProperties_endTime :: Lens' SentimentDetectionJobProperties (Maybe UTCTime) Source #
The time that the sentiment detection job ended.
sentimentDetectionJobProperties_inputDataConfig :: Lens' SentimentDetectionJobProperties (Maybe InputDataConfig) Source #
The input data configuration that you supplied when you created 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_jobId :: Lens' SentimentDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the sentiment detection job.
sentimentDetectionJobProperties_jobName :: Lens' SentimentDetectionJobProperties (Maybe Text) Source #
The name that you assigned to the sentiment detection job
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_languageCode :: Lens' SentimentDetectionJobProperties (Maybe LanguageCode) Source #
The language code of the input documents.
sentimentDetectionJobProperties_message :: Lens' SentimentDetectionJobProperties (Maybe Text) Source #
A description of the status of a job.
sentimentDetectionJobProperties_outputDataConfig :: Lens' SentimentDetectionJobProperties (Maybe OutputDataConfig) Source #
The output data configuration that you supplied when you created the sentiment detection job.
sentimentDetectionJobProperties_submitTime :: Lens' SentimentDetectionJobProperties (Maybe UTCTime) Source #
The time that the sentiment detection job was submitted for processing.
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_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.
SentimentScore
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
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_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 Syntax in the Comprehend Developer Guide.
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.
Tag
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.”
TargetedSentimentDetectionJobFilter
targetedSentimentDetectionJobFilter_jobName :: Lens' TargetedSentimentDetectionJobFilter (Maybe Text) Source #
Filters on the name of the job.
targetedSentimentDetectionJobFilter_jobStatus :: Lens' TargetedSentimentDetectionJobFilter (Maybe JobStatus) Source #
Filters the list of jobs based on job status. Returns only jobs with the specified status.
targetedSentimentDetectionJobFilter_submitTimeAfter :: Lens' TargetedSentimentDetectionJobFilter (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.
targetedSentimentDetectionJobFilter_submitTimeBefore :: Lens' TargetedSentimentDetectionJobFilter (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.
TargetedSentimentDetectionJobProperties
targetedSentimentDetectionJobProperties_dataAccessRoleArn :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
targetedSentimentDetectionJobProperties_endTime :: Lens' TargetedSentimentDetectionJobProperties (Maybe UTCTime) Source #
The time that the targeted sentiment detection job ended.
targetedSentimentDetectionJobProperties_inputDataConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe InputDataConfig) Source #
Undocumented member.
targetedSentimentDetectionJobProperties_jobArn :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the targeted 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>:targeted-sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
targetedSentimentDetectionJobProperties_jobId :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the targeted sentiment detection job.
targetedSentimentDetectionJobProperties_jobName :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) Source #
The name that you assigned to the targeted sentiment detection job.
targetedSentimentDetectionJobProperties_jobStatus :: Lens' TargetedSentimentDetectionJobProperties (Maybe JobStatus) Source #
The current status of the targeted sentiment detection job. If the
status is FAILED
, the Messages
field shows the reason for the
failure.
targetedSentimentDetectionJobProperties_languageCode :: Lens' TargetedSentimentDetectionJobProperties (Maybe LanguageCode) Source #
The language code of the input documents.
targetedSentimentDetectionJobProperties_message :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) Source #
A description of the status of a job.
targetedSentimentDetectionJobProperties_outputDataConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe OutputDataConfig) Source #
Undocumented member.
targetedSentimentDetectionJobProperties_submitTime :: Lens' TargetedSentimentDetectionJobProperties (Maybe UTCTime) Source #
The time that the targeted sentiment detection job was submitted for processing.
targetedSentimentDetectionJobProperties_volumeKmsKeyId :: Lens' TargetedSentimentDetectionJobProperties (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 targeted sentiment detection 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"
targetedSentimentDetectionJobProperties_vpcConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe VpcConfig) Source #
Undocumented member.
TargetedSentimentEntity
targetedSentimentEntity_descriptiveMentionIndex :: Lens' TargetedSentimentEntity (Maybe [Int]) Source #
One or more index into the Mentions array that provides the best name for the entity group.
targetedSentimentEntity_mentions :: Lens' TargetedSentimentEntity (Maybe [TargetedSentimentMention]) Source #
An array of mentions of the entity in the document. The array represents a co-reference group. See Co-reference group for an example.
TargetedSentimentMention
targetedSentimentMention_beginOffset :: Lens' TargetedSentimentMention (Maybe Int) Source #
The offset into the document text where the mention begins.
targetedSentimentMention_endOffset :: Lens' TargetedSentimentMention (Maybe Int) Source #
The offset into the document text where the mention ends.
targetedSentimentMention_groupScore :: Lens' TargetedSentimentMention (Maybe Double) Source #
The confidence that all the entities mentioned in the group relate to the same entity.
targetedSentimentMention_mentionSentiment :: Lens' TargetedSentimentMention (Maybe MentionSentiment) Source #
Contains the sentiment and sentiment score for the mention.
targetedSentimentMention_score :: Lens' TargetedSentimentMention (Maybe Double) Source #
Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.
targetedSentimentMention_text :: Lens' TargetedSentimentMention (Maybe Text) Source #
The text in the document that identifies the entity.
targetedSentimentMention_type :: Lens' TargetedSentimentMention (Maybe TargetedSentimentEntityType) Source #
The type of the entity. Amazon Comprehend supports a variety of entity types.
TopicsDetectionJobFilter
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.
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.
TopicsDetectionJobProperties
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_endTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime) Source #
The time that the topic detection job was completed.
topicsDetectionJobProperties_inputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe InputDataConfig) Source #
The input data configuration supplied when you created 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_jobId :: Lens' TopicsDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the topic detection job.
topicsDetectionJobProperties_jobName :: Lens' TopicsDetectionJobProperties (Maybe Text) Source #
The name of the topic detection job.
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_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_outputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe OutputDataConfig) Source #
The output data configuration supplied when you created the topic detection job.
topicsDetectionJobProperties_submitTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime) Source #
The time that the topic detection job was submitted for processing.
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_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.
VpcConfig
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.