| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Comprehend
Contents
- Service Configuration
- Errors
- ResourceUnavailableException
- InvalidRequestException
- ResourceLimitExceededException
- TooManyTagsException
- TooManyRequestsException
- ConcurrentModificationException
- InternalServerException
- BatchSizeLimitExceededException
- UnsupportedLanguageException
- JobNotFoundException
- TooManyTagKeysException
- InvalidFilterException
- KmsKeyValidationException
- ResourceNotFoundException
- TextSizeLimitExceededException
- ResourceInUseException
- Waiters
- Operations
- BatchDetectSentiment
- DeleteEntityRecognizer
- DescribeKeyPhrasesDetectionJob
- ListEntitiesDetectionJobs (Paginated)
- CreateEndpoint
- StopEventsDetectionJob
- StartSentimentDetectionJob
- BatchDetectSyntax
- StartTopicsDetectionJob
- DescribeEventsDetectionJob
- DeleteEndpoint
- UpdateEndpoint
- ListTagsForResource
- BatchDetectKeyPhrases
- DescribeSentimentDetectionJob
- StartEntitiesDetectionJob
- StopPiiEntitiesDetectionJob
- DescribeEntityRecognizer
- DetectSentiment
- StartDominantLanguageDetectionJob
- StopTrainingDocumentClassifier
- DescribeDocumentClassificationJob
- ContainsPiiEntities
- ListEventsDetectionJobs
- BatchDetectEntities
- CreateEntityRecognizer
- StopKeyPhrasesDetectionJob
- CreateDocumentClassifier
- ListPiiEntitiesDetectionJobs
- ListEntityRecognizers (Paginated)
- StopSentimentDetectionJob
- DetectDominantLanguage
- ClassifyDocument
- StartEventsDetectionJob
- DescribeTopicsDetectionJob
- ListDocumentClassificationJobs (Paginated)
- DetectPiiEntities
- ListEndpoints
- DetectEntities
- DescribeDocumentClassifier
- DescribeDominantLanguageDetectionJob
- ListEntityRecognizerSummaries
- StopEntitiesDetectionJob
- StopTrainingEntityRecognizer
- StartPiiEntitiesDetectionJob
- ListKeyPhrasesDetectionJobs (Paginated)
- DescribeEntitiesDetectionJob
- ListDocumentClassifierSummaries
- StopDominantLanguageDetectionJob
- TagResource
- DescribePiiEntitiesDetectionJob
- ListTopicsDetectionJobs (Paginated)
- UntagResource
- BatchDetectDominantLanguage
- StartDocumentClassificationJob
- DetectKeyPhrases
- DetectSyntax
- DescribeEndpoint
- ListSentimentDetectionJobs (Paginated)
- DeleteDocumentClassifier
- ListDominantLanguageDetectionJobs (Paginated)
- StartKeyPhrasesDetectionJob
- ListDocumentClassifiers (Paginated)
- Types
- AugmentedManifestsDocumentTypeFormat
- DocumentClassifierDataFormat
- DocumentClassifierMode
- DocumentReadAction
- DocumentReadFeatureTypes
- DocumentReadMode
- EndpointStatus
- EntityRecognizerDataFormat
- EntityType
- InputFormat
- JobStatus
- LanguageCode
- ModelStatus
- PartOfSpeechTagType
- PiiEntitiesDetectionMaskMode
- PiiEntitiesDetectionMode
- PiiEntityType
- SentimentType
- Split
- SyntaxLanguageCode
- AugmentedManifestsListItem
- BatchDetectDominantLanguageItemResult
- BatchDetectEntitiesItemResult
- BatchDetectKeyPhrasesItemResult
- BatchDetectSentimentItemResult
- BatchDetectSyntaxItemResult
- BatchItemError
- ClassifierEvaluationMetrics
- ClassifierMetadata
- DocumentClass
- DocumentClassificationJobFilter
- DocumentClassificationJobProperties
- DocumentClassifierFilter
- DocumentClassifierInputDataConfig
- DocumentClassifierOutputDataConfig
- DocumentClassifierProperties
- DocumentClassifierSummary
- DocumentLabel
- DocumentReaderConfig
- DominantLanguage
- DominantLanguageDetectionJobFilter
- DominantLanguageDetectionJobProperties
- EndpointFilter
- EndpointProperties
- EntitiesDetectionJobFilter
- EntitiesDetectionJobProperties
- Entity
- EntityLabel
- EntityRecognizerAnnotations
- EntityRecognizerDocuments
- EntityRecognizerEntityList
- EntityRecognizerEvaluationMetrics
- EntityRecognizerFilter
- EntityRecognizerInputDataConfig
- EntityRecognizerMetadata
- EntityRecognizerMetadataEntityTypesListItem
- EntityRecognizerProperties
- EntityRecognizerSummary
- EntityTypesEvaluationMetrics
- EntityTypesListItem
- EventsDetectionJobFilter
- EventsDetectionJobProperties
- InputDataConfig
- KeyPhrase
- KeyPhrasesDetectionJobFilter
- KeyPhrasesDetectionJobProperties
- OutputDataConfig
- PartOfSpeechTag
- PiiEntitiesDetectionJobFilter
- PiiEntitiesDetectionJobProperties
- PiiEntity
- PiiOutputDataConfig
- RedactionConfig
- SentimentDetectionJobFilter
- SentimentDetectionJobProperties
- SentimentScore
- SyntaxToken
- Tag
- TopicsDetectionJobFilter
- TopicsDetectionJobProperties
- VpcConfig
Description
Derived from API version 2017-11-27 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Comprehend is an AWS service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.
Synopsis
- defaultService :: Service
- _ResourceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _BatchSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedLanguageException :: AsError a => Getting (First ServiceError) a ServiceError
- _JobNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTagKeysException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidFilterException :: AsError a => Getting (First ServiceError) a ServiceError
- _KmsKeyValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TextSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- data BatchDetectSentiment = BatchDetectSentiment' (Sensitive [Sensitive Text]) LanguageCode
- newBatchDetectSentiment :: LanguageCode -> BatchDetectSentiment
- data BatchDetectSentimentResponse = BatchDetectSentimentResponse' Int [BatchDetectSentimentItemResult] [BatchItemError]
- newBatchDetectSentimentResponse :: Int -> BatchDetectSentimentResponse
- data DeleteEntityRecognizer = DeleteEntityRecognizer' Text
- newDeleteEntityRecognizer :: Text -> DeleteEntityRecognizer
- data DeleteEntityRecognizerResponse = DeleteEntityRecognizerResponse' Int
- newDeleteEntityRecognizerResponse :: Int -> DeleteEntityRecognizerResponse
- data DescribeKeyPhrasesDetectionJob = DescribeKeyPhrasesDetectionJob' Text
- newDescribeKeyPhrasesDetectionJob :: Text -> DescribeKeyPhrasesDetectionJob
- data DescribeKeyPhrasesDetectionJobResponse = DescribeKeyPhrasesDetectionJobResponse' (Maybe KeyPhrasesDetectionJobProperties) Int
- newDescribeKeyPhrasesDetectionJobResponse :: Int -> DescribeKeyPhrasesDetectionJobResponse
- data ListEntitiesDetectionJobs = ListEntitiesDetectionJobs' (Maybe Text) (Maybe EntitiesDetectionJobFilter) (Maybe Natural)
- newListEntitiesDetectionJobs :: ListEntitiesDetectionJobs
- data ListEntitiesDetectionJobsResponse = ListEntitiesDetectionJobsResponse' (Maybe [EntitiesDetectionJobProperties]) (Maybe Text) Int
- newListEntitiesDetectionJobsResponse :: Int -> ListEntitiesDetectionJobsResponse
- data CreateEndpoint = CreateEndpoint' (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text Natural
- newCreateEndpoint :: Text -> Text -> Natural -> CreateEndpoint
- data CreateEndpointResponse = CreateEndpointResponse' (Maybe Text) Int
- newCreateEndpointResponse :: Int -> CreateEndpointResponse
- data StopEventsDetectionJob = StopEventsDetectionJob' Text
- newStopEventsDetectionJob :: Text -> StopEventsDetectionJob
- data StopEventsDetectionJobResponse = StopEventsDetectionJobResponse' (Maybe Text) (Maybe JobStatus) Int
- newStopEventsDetectionJobResponse :: Int -> StopEventsDetectionJobResponse
- data StartSentimentDetectionJob = StartSentimentDetectionJob' (Maybe Text) (Maybe VpcConfig) (Maybe Text) (Maybe Text) (Maybe [Tag]) InputDataConfig OutputDataConfig Text LanguageCode
- newStartSentimentDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartSentimentDetectionJob
- data StartSentimentDetectionJobResponse = StartSentimentDetectionJobResponse' (Maybe Text) (Maybe Text) (Maybe JobStatus) Int
- newStartSentimentDetectionJobResponse :: Int -> StartSentimentDetectionJobResponse
- data BatchDetectSyntax = BatchDetectSyntax' (Sensitive [Sensitive Text]) SyntaxLanguageCode
- newBatchDetectSyntax :: SyntaxLanguageCode -> BatchDetectSyntax
- data BatchDetectSyntaxResponse = BatchDetectSyntaxResponse' Int [BatchDetectSyntaxItemResult] [BatchItemError]
- newBatchDetectSyntaxResponse :: Int -> BatchDetectSyntaxResponse
- data StartTopicsDetectionJob = StartTopicsDetectionJob' (Maybe Text) (Maybe VpcConfig) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe [Tag]) InputDataConfig OutputDataConfig Text
- newStartTopicsDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> StartTopicsDetectionJob
- data StartTopicsDetectionJobResponse = StartTopicsDetectionJobResponse' (Maybe Text) (Maybe Text) (Maybe JobStatus) Int
- newStartTopicsDetectionJobResponse :: Int -> StartTopicsDetectionJobResponse
- data DescribeEventsDetectionJob = DescribeEventsDetectionJob' Text
- newDescribeEventsDetectionJob :: Text -> DescribeEventsDetectionJob
- data DescribeEventsDetectionJobResponse = DescribeEventsDetectionJobResponse' (Maybe EventsDetectionJobProperties) Int
- newDescribeEventsDetectionJobResponse :: Int -> DescribeEventsDetectionJobResponse
- data DeleteEndpoint = DeleteEndpoint' Text
- newDeleteEndpoint :: Text -> DeleteEndpoint
- data DeleteEndpointResponse = DeleteEndpointResponse' Int
- newDeleteEndpointResponse :: Int -> DeleteEndpointResponse
- data UpdateEndpoint = UpdateEndpoint' (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newUpdateEndpoint :: Text -> UpdateEndpoint
- data UpdateEndpointResponse = UpdateEndpointResponse' Int
- newUpdateEndpointResponse :: Int -> UpdateEndpointResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data BatchDetectKeyPhrases = BatchDetectKeyPhrases' (Sensitive [Sensitive Text]) LanguageCode
- newBatchDetectKeyPhrases :: LanguageCode -> BatchDetectKeyPhrases
- data BatchDetectKeyPhrasesResponse = BatchDetectKeyPhrasesResponse' Int [BatchDetectKeyPhrasesItemResult] [BatchItemError]
- newBatchDetectKeyPhrasesResponse :: Int -> BatchDetectKeyPhrasesResponse
- data DescribeSentimentDetectionJob = DescribeSentimentDetectionJob' Text
- newDescribeSentimentDetectionJob :: Text -> DescribeSentimentDetectionJob
- data DescribeSentimentDetectionJobResponse = DescribeSentimentDetectionJobResponse' (Maybe SentimentDetectionJobProperties) Int
- newDescribeSentimentDetectionJobResponse :: Int -> DescribeSentimentDetectionJobResponse
- data StartEntitiesDetectionJob = StartEntitiesDetectionJob' (Maybe Text) (Maybe Text) (Maybe VpcConfig) (Maybe Text) (Maybe Text) (Maybe [Tag]) InputDataConfig OutputDataConfig Text LanguageCode
- newStartEntitiesDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartEntitiesDetectionJob
- data StartEntitiesDetectionJobResponse = StartEntitiesDetectionJobResponse' (Maybe Text) (Maybe Text) (Maybe JobStatus) Int
- newStartEntitiesDetectionJobResponse :: Int -> StartEntitiesDetectionJobResponse
- data StopPiiEntitiesDetectionJob = StopPiiEntitiesDetectionJob' Text
- newStopPiiEntitiesDetectionJob :: Text -> StopPiiEntitiesDetectionJob
- data StopPiiEntitiesDetectionJobResponse = StopPiiEntitiesDetectionJobResponse' (Maybe Text) (Maybe JobStatus) Int
- newStopPiiEntitiesDetectionJobResponse :: Int -> StopPiiEntitiesDetectionJobResponse
- data DescribeEntityRecognizer = DescribeEntityRecognizer' Text
- newDescribeEntityRecognizer :: Text -> DescribeEntityRecognizer
- data DescribeEntityRecognizerResponse = DescribeEntityRecognizerResponse' (Maybe EntityRecognizerProperties) Int
- newDescribeEntityRecognizerResponse :: Int -> DescribeEntityRecognizerResponse
- data DetectSentiment = DetectSentiment' (Sensitive Text) LanguageCode
- newDetectSentiment :: Text -> LanguageCode -> DetectSentiment
- data DetectSentimentResponse = DetectSentimentResponse' (Maybe SentimentType) (Maybe SentimentScore) Int
- newDetectSentimentResponse :: Int -> DetectSentimentResponse
- data StartDominantLanguageDetectionJob = StartDominantLanguageDetectionJob' (Maybe Text) (Maybe VpcConfig) (Maybe Text) (Maybe Text) (Maybe [Tag]) InputDataConfig OutputDataConfig Text
- newStartDominantLanguageDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> StartDominantLanguageDetectionJob
- data StartDominantLanguageDetectionJobResponse = StartDominantLanguageDetectionJobResponse' (Maybe Text) (Maybe Text) (Maybe JobStatus) Int
- newStartDominantLanguageDetectionJobResponse :: Int -> StartDominantLanguageDetectionJobResponse
- data StopTrainingDocumentClassifier = StopTrainingDocumentClassifier' Text
- newStopTrainingDocumentClassifier :: Text -> StopTrainingDocumentClassifier
- data StopTrainingDocumentClassifierResponse = StopTrainingDocumentClassifierResponse' Int
- newStopTrainingDocumentClassifierResponse :: Int -> StopTrainingDocumentClassifierResponse
- data DescribeDocumentClassificationJob = DescribeDocumentClassificationJob' Text
- newDescribeDocumentClassificationJob :: Text -> DescribeDocumentClassificationJob
- data DescribeDocumentClassificationJobResponse = DescribeDocumentClassificationJobResponse' (Maybe DocumentClassificationJobProperties) Int
- newDescribeDocumentClassificationJobResponse :: Int -> DescribeDocumentClassificationJobResponse
- data ContainsPiiEntities = ContainsPiiEntities' Text LanguageCode
- newContainsPiiEntities :: Text -> LanguageCode -> ContainsPiiEntities
- data ContainsPiiEntitiesResponse = ContainsPiiEntitiesResponse' (Maybe [EntityLabel]) Int
- newContainsPiiEntitiesResponse :: Int -> ContainsPiiEntitiesResponse
- data ListEventsDetectionJobs = ListEventsDetectionJobs' (Maybe Text) (Maybe EventsDetectionJobFilter) (Maybe Natural)
- newListEventsDetectionJobs :: ListEventsDetectionJobs
- data ListEventsDetectionJobsResponse = ListEventsDetectionJobsResponse' (Maybe [EventsDetectionJobProperties]) (Maybe Text) Int
- newListEventsDetectionJobsResponse :: Int -> ListEventsDetectionJobsResponse
- data BatchDetectEntities = BatchDetectEntities' (Sensitive [Sensitive Text]) LanguageCode
- newBatchDetectEntities :: LanguageCode -> BatchDetectEntities
- data BatchDetectEntitiesResponse = BatchDetectEntitiesResponse' Int [BatchDetectEntitiesItemResult] [BatchItemError]
- newBatchDetectEntitiesResponse :: Int -> BatchDetectEntitiesResponse
- data CreateEntityRecognizer = CreateEntityRecognizer' (Maybe Text) (Maybe Text) (Maybe VpcConfig) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text EntityRecognizerInputDataConfig LanguageCode
- newCreateEntityRecognizer :: Text -> Text -> EntityRecognizerInputDataConfig -> LanguageCode -> CreateEntityRecognizer
- data CreateEntityRecognizerResponse = CreateEntityRecognizerResponse' (Maybe Text) Int
- newCreateEntityRecognizerResponse :: Int -> CreateEntityRecognizerResponse
- data StopKeyPhrasesDetectionJob = StopKeyPhrasesDetectionJob' Text
- newStopKeyPhrasesDetectionJob :: Text -> StopKeyPhrasesDetectionJob
- data StopKeyPhrasesDetectionJobResponse = StopKeyPhrasesDetectionJobResponse' (Maybe Text) (Maybe JobStatus) Int
- newStopKeyPhrasesDetectionJobResponse :: Int -> StopKeyPhrasesDetectionJobResponse
- data CreateDocumentClassifier = CreateDocumentClassifier' (Maybe Text) (Maybe Text) (Maybe DocumentClassifierMode) (Maybe VpcConfig) (Maybe Text) (Maybe DocumentClassifierOutputDataConfig) (Maybe Text) (Maybe [Tag]) Text Text DocumentClassifierInputDataConfig LanguageCode
- newCreateDocumentClassifier :: Text -> Text -> DocumentClassifierInputDataConfig -> LanguageCode -> CreateDocumentClassifier
- data CreateDocumentClassifierResponse = CreateDocumentClassifierResponse' (Maybe Text) Int
- newCreateDocumentClassifierResponse :: Int -> CreateDocumentClassifierResponse
- data ListPiiEntitiesDetectionJobs = ListPiiEntitiesDetectionJobs' (Maybe Text) (Maybe PiiEntitiesDetectionJobFilter) (Maybe Natural)
- newListPiiEntitiesDetectionJobs :: ListPiiEntitiesDetectionJobs
- data ListPiiEntitiesDetectionJobsResponse = ListPiiEntitiesDetectionJobsResponse' (Maybe Text) (Maybe [PiiEntitiesDetectionJobProperties]) Int
- newListPiiEntitiesDetectionJobsResponse :: Int -> ListPiiEntitiesDetectionJobsResponse
- data ListEntityRecognizers = ListEntityRecognizers' (Maybe Text) (Maybe EntityRecognizerFilter) (Maybe Natural)
- newListEntityRecognizers :: ListEntityRecognizers
- data ListEntityRecognizersResponse = ListEntityRecognizersResponse' (Maybe Text) (Maybe [EntityRecognizerProperties]) Int
- newListEntityRecognizersResponse :: Int -> ListEntityRecognizersResponse
- data StopSentimentDetectionJob = StopSentimentDetectionJob' Text
- newStopSentimentDetectionJob :: Text -> StopSentimentDetectionJob
- data StopSentimentDetectionJobResponse = StopSentimentDetectionJobResponse' (Maybe Text) (Maybe JobStatus) Int
- newStopSentimentDetectionJobResponse :: Int -> StopSentimentDetectionJobResponse
- data DetectDominantLanguage = DetectDominantLanguage' (Sensitive Text)
- newDetectDominantLanguage :: Text -> DetectDominantLanguage
- data DetectDominantLanguageResponse = DetectDominantLanguageResponse' (Maybe [DominantLanguage]) Int
- newDetectDominantLanguageResponse :: Int -> DetectDominantLanguageResponse
- data ClassifyDocument = ClassifyDocument' (Sensitive Text) Text
- newClassifyDocument :: Text -> Text -> ClassifyDocument
- data ClassifyDocumentResponse = ClassifyDocumentResponse' (Maybe [DocumentLabel]) (Maybe [DocumentClass]) Int
- newClassifyDocumentResponse :: Int -> ClassifyDocumentResponse
- data StartEventsDetectionJob = StartEventsDetectionJob' (Maybe Text) (Maybe Text) (Maybe [Tag]) InputDataConfig OutputDataConfig Text LanguageCode (NonEmpty Text)
- newStartEventsDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> NonEmpty Text -> StartEventsDetectionJob
- data StartEventsDetectionJobResponse = StartEventsDetectionJobResponse' (Maybe Text) (Maybe Text) (Maybe JobStatus) Int
- newStartEventsDetectionJobResponse :: Int -> StartEventsDetectionJobResponse
- data DescribeTopicsDetectionJob = DescribeTopicsDetectionJob' Text
- newDescribeTopicsDetectionJob :: Text -> DescribeTopicsDetectionJob
- data DescribeTopicsDetectionJobResponse = DescribeTopicsDetectionJobResponse' (Maybe TopicsDetectionJobProperties) Int
- newDescribeTopicsDetectionJobResponse :: Int -> DescribeTopicsDetectionJobResponse
- data ListDocumentClassificationJobs = ListDocumentClassificationJobs' (Maybe Text) (Maybe DocumentClassificationJobFilter) (Maybe Natural)
- newListDocumentClassificationJobs :: ListDocumentClassificationJobs
- data ListDocumentClassificationJobsResponse = ListDocumentClassificationJobsResponse' (Maybe Text) (Maybe [DocumentClassificationJobProperties]) Int
- newListDocumentClassificationJobsResponse :: Int -> ListDocumentClassificationJobsResponse
- data DetectPiiEntities = DetectPiiEntities' Text LanguageCode
- newDetectPiiEntities :: Text -> LanguageCode -> DetectPiiEntities
- data DetectPiiEntitiesResponse = DetectPiiEntitiesResponse' (Maybe [PiiEntity]) Int
- newDetectPiiEntitiesResponse :: Int -> DetectPiiEntitiesResponse
- data ListEndpoints = ListEndpoints' (Maybe Text) (Maybe EndpointFilter) (Maybe Natural)
- newListEndpoints :: ListEndpoints
- data ListEndpointsResponse = ListEndpointsResponse' (Maybe [EndpointProperties]) (Maybe Text) Int
- newListEndpointsResponse :: Int -> ListEndpointsResponse
- data DetectEntities = DetectEntities' (Maybe LanguageCode) (Maybe Text) (Sensitive Text)
- newDetectEntities :: Text -> DetectEntities
- data DetectEntitiesResponse = DetectEntitiesResponse' (Maybe [Entity]) Int
- newDetectEntitiesResponse :: Int -> DetectEntitiesResponse
- data DescribeDocumentClassifier = DescribeDocumentClassifier' Text
- newDescribeDocumentClassifier :: Text -> DescribeDocumentClassifier
- data DescribeDocumentClassifierResponse = DescribeDocumentClassifierResponse' (Maybe DocumentClassifierProperties) Int
- newDescribeDocumentClassifierResponse :: Int -> DescribeDocumentClassifierResponse
- data DescribeDominantLanguageDetectionJob = DescribeDominantLanguageDetectionJob' Text
- newDescribeDominantLanguageDetectionJob :: Text -> DescribeDominantLanguageDetectionJob
- data DescribeDominantLanguageDetectionJobResponse = DescribeDominantLanguageDetectionJobResponse' (Maybe DominantLanguageDetectionJobProperties) Int
- newDescribeDominantLanguageDetectionJobResponse :: Int -> DescribeDominantLanguageDetectionJobResponse
- data ListEntityRecognizerSummaries = ListEntityRecognizerSummaries' (Maybe Text) (Maybe Natural)
- newListEntityRecognizerSummaries :: ListEntityRecognizerSummaries
- data ListEntityRecognizerSummariesResponse = ListEntityRecognizerSummariesResponse' (Maybe Text) (Maybe [EntityRecognizerSummary]) Int
- newListEntityRecognizerSummariesResponse :: Int -> ListEntityRecognizerSummariesResponse
- data StopEntitiesDetectionJob = StopEntitiesDetectionJob' Text
- newStopEntitiesDetectionJob :: Text -> StopEntitiesDetectionJob
- data StopEntitiesDetectionJobResponse = StopEntitiesDetectionJobResponse' (Maybe Text) (Maybe JobStatus) Int
- newStopEntitiesDetectionJobResponse :: Int -> StopEntitiesDetectionJobResponse
- data StopTrainingEntityRecognizer = StopTrainingEntityRecognizer' Text
- newStopTrainingEntityRecognizer :: Text -> StopTrainingEntityRecognizer
- data StopTrainingEntityRecognizerResponse = StopTrainingEntityRecognizerResponse' Int
- newStopTrainingEntityRecognizerResponse :: Int -> StopTrainingEntityRecognizerResponse
- data StartPiiEntitiesDetectionJob = StartPiiEntitiesDetectionJob' (Maybe Text) (Maybe RedactionConfig) (Maybe Text) (Maybe [Tag]) InputDataConfig OutputDataConfig PiiEntitiesDetectionMode Text LanguageCode
- newStartPiiEntitiesDetectionJob :: InputDataConfig -> OutputDataConfig -> PiiEntitiesDetectionMode -> Text -> LanguageCode -> StartPiiEntitiesDetectionJob
- data StartPiiEntitiesDetectionJobResponse = StartPiiEntitiesDetectionJobResponse' (Maybe Text) (Maybe Text) (Maybe JobStatus) Int
- newStartPiiEntitiesDetectionJobResponse :: Int -> StartPiiEntitiesDetectionJobResponse
- data ListKeyPhrasesDetectionJobs = ListKeyPhrasesDetectionJobs' (Maybe Text) (Maybe KeyPhrasesDetectionJobFilter) (Maybe Natural)
- newListKeyPhrasesDetectionJobs :: ListKeyPhrasesDetectionJobs
- data ListKeyPhrasesDetectionJobsResponse = ListKeyPhrasesDetectionJobsResponse' (Maybe [KeyPhrasesDetectionJobProperties]) (Maybe Text) Int
- newListKeyPhrasesDetectionJobsResponse :: Int -> ListKeyPhrasesDetectionJobsResponse
- data DescribeEntitiesDetectionJob = DescribeEntitiesDetectionJob' Text
- newDescribeEntitiesDetectionJob :: Text -> DescribeEntitiesDetectionJob
- data DescribeEntitiesDetectionJobResponse = DescribeEntitiesDetectionJobResponse' (Maybe EntitiesDetectionJobProperties) Int
- newDescribeEntitiesDetectionJobResponse :: Int -> DescribeEntitiesDetectionJobResponse
- data ListDocumentClassifierSummaries = ListDocumentClassifierSummaries' (Maybe Text) (Maybe Natural)
- newListDocumentClassifierSummaries :: ListDocumentClassifierSummaries
- data ListDocumentClassifierSummariesResponse = ListDocumentClassifierSummariesResponse' (Maybe Text) (Maybe [DocumentClassifierSummary]) Int
- newListDocumentClassifierSummariesResponse :: Int -> ListDocumentClassifierSummariesResponse
- data StopDominantLanguageDetectionJob = StopDominantLanguageDetectionJob' Text
- newStopDominantLanguageDetectionJob :: Text -> StopDominantLanguageDetectionJob
- data StopDominantLanguageDetectionJobResponse = StopDominantLanguageDetectionJobResponse' (Maybe Text) (Maybe JobStatus) Int
- newStopDominantLanguageDetectionJobResponse :: Int -> StopDominantLanguageDetectionJobResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data DescribePiiEntitiesDetectionJob = DescribePiiEntitiesDetectionJob' Text
- newDescribePiiEntitiesDetectionJob :: Text -> DescribePiiEntitiesDetectionJob
- data DescribePiiEntitiesDetectionJobResponse = DescribePiiEntitiesDetectionJobResponse' (Maybe PiiEntitiesDetectionJobProperties) Int
- newDescribePiiEntitiesDetectionJobResponse :: Int -> DescribePiiEntitiesDetectionJobResponse
- data ListTopicsDetectionJobs = ListTopicsDetectionJobs' (Maybe Text) (Maybe TopicsDetectionJobFilter) (Maybe Natural)
- newListTopicsDetectionJobs :: ListTopicsDetectionJobs
- data ListTopicsDetectionJobsResponse = ListTopicsDetectionJobsResponse' (Maybe Text) (Maybe [TopicsDetectionJobProperties]) Int
- newListTopicsDetectionJobsResponse :: Int -> ListTopicsDetectionJobsResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data BatchDetectDominantLanguage = BatchDetectDominantLanguage' (Sensitive [Sensitive Text])
- newBatchDetectDominantLanguage :: BatchDetectDominantLanguage
- data BatchDetectDominantLanguageResponse = BatchDetectDominantLanguageResponse' Int [BatchDetectDominantLanguageItemResult] [BatchItemError]
- newBatchDetectDominantLanguageResponse :: Int -> BatchDetectDominantLanguageResponse
- data StartDocumentClassificationJob = StartDocumentClassificationJob' (Maybe Text) (Maybe VpcConfig) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text InputDataConfig OutputDataConfig Text
- newStartDocumentClassificationJob :: Text -> InputDataConfig -> OutputDataConfig -> Text -> StartDocumentClassificationJob
- data StartDocumentClassificationJobResponse = StartDocumentClassificationJobResponse' (Maybe Text) (Maybe Text) (Maybe JobStatus) Int
- newStartDocumentClassificationJobResponse :: Int -> StartDocumentClassificationJobResponse
- data DetectKeyPhrases = DetectKeyPhrases' (Sensitive Text) LanguageCode
- newDetectKeyPhrases :: Text -> LanguageCode -> DetectKeyPhrases
- data DetectKeyPhrasesResponse = DetectKeyPhrasesResponse' (Maybe [KeyPhrase]) Int
- newDetectKeyPhrasesResponse :: Int -> DetectKeyPhrasesResponse
- data DetectSyntax = DetectSyntax' (Sensitive Text) SyntaxLanguageCode
- newDetectSyntax :: Text -> SyntaxLanguageCode -> DetectSyntax
- data DetectSyntaxResponse = DetectSyntaxResponse' (Maybe [SyntaxToken]) Int
- newDetectSyntaxResponse :: Int -> DetectSyntaxResponse
- data DescribeEndpoint = DescribeEndpoint' Text
- newDescribeEndpoint :: Text -> DescribeEndpoint
- data DescribeEndpointResponse = DescribeEndpointResponse' (Maybe EndpointProperties) Int
- newDescribeEndpointResponse :: Int -> DescribeEndpointResponse
- data ListSentimentDetectionJobs = ListSentimentDetectionJobs' (Maybe Text) (Maybe SentimentDetectionJobFilter) (Maybe Natural)
- newListSentimentDetectionJobs :: ListSentimentDetectionJobs
- data ListSentimentDetectionJobsResponse = ListSentimentDetectionJobsResponse' (Maybe Text) (Maybe [SentimentDetectionJobProperties]) Int
- newListSentimentDetectionJobsResponse :: Int -> ListSentimentDetectionJobsResponse
- data DeleteDocumentClassifier = DeleteDocumentClassifier' Text
- newDeleteDocumentClassifier :: Text -> DeleteDocumentClassifier
- data DeleteDocumentClassifierResponse = DeleteDocumentClassifierResponse' Int
- newDeleteDocumentClassifierResponse :: Int -> DeleteDocumentClassifierResponse
- data ListDominantLanguageDetectionJobs = ListDominantLanguageDetectionJobs' (Maybe Text) (Maybe DominantLanguageDetectionJobFilter) (Maybe Natural)
- newListDominantLanguageDetectionJobs :: ListDominantLanguageDetectionJobs
- data ListDominantLanguageDetectionJobsResponse = ListDominantLanguageDetectionJobsResponse' (Maybe Text) (Maybe [DominantLanguageDetectionJobProperties]) Int
- newListDominantLanguageDetectionJobsResponse :: Int -> ListDominantLanguageDetectionJobsResponse
- data StartKeyPhrasesDetectionJob = StartKeyPhrasesDetectionJob' (Maybe Text) (Maybe VpcConfig) (Maybe Text) (Maybe Text) (Maybe [Tag]) InputDataConfig OutputDataConfig Text LanguageCode
- newStartKeyPhrasesDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartKeyPhrasesDetectionJob
- data StartKeyPhrasesDetectionJobResponse = StartKeyPhrasesDetectionJobResponse' (Maybe Text) (Maybe Text) (Maybe JobStatus) Int
- newStartKeyPhrasesDetectionJobResponse :: Int -> StartKeyPhrasesDetectionJobResponse
- data ListDocumentClassifiers = ListDocumentClassifiers' (Maybe Text) (Maybe DocumentClassifierFilter) (Maybe Natural)
- newListDocumentClassifiers :: ListDocumentClassifiers
- data ListDocumentClassifiersResponse = ListDocumentClassifiersResponse' (Maybe Text) (Maybe [DocumentClassifierProperties]) Int
- newListDocumentClassifiersResponse :: Int -> ListDocumentClassifiersResponse
- newtype AugmentedManifestsDocumentTypeFormat where
- newtype DocumentClassifierDataFormat where
- newtype DocumentClassifierMode where
- newtype DocumentReadAction where
- newtype DocumentReadFeatureTypes where
- newtype DocumentReadMode where
- newtype EndpointStatus where
- EndpointStatus' { }
- pattern EndpointStatus_CREATING :: EndpointStatus
- pattern EndpointStatus_DELETING :: EndpointStatus
- pattern EndpointStatus_FAILED :: EndpointStatus
- pattern EndpointStatus_IN_SERVICE :: EndpointStatus
- pattern EndpointStatus_UPDATING :: EndpointStatus
- newtype EntityRecognizerDataFormat where
- newtype EntityType where
- EntityType' { }
- pattern EntityType_COMMERCIAL_ITEM :: EntityType
- pattern EntityType_DATE :: EntityType
- pattern EntityType_EVENT :: EntityType
- pattern EntityType_LOCATION :: EntityType
- pattern EntityType_ORGANIZATION :: EntityType
- pattern EntityType_OTHER :: EntityType
- pattern EntityType_PERSON :: EntityType
- pattern EntityType_QUANTITY :: EntityType
- pattern EntityType_TITLE :: EntityType
- newtype InputFormat where
- InputFormat' { }
- pattern InputFormat_ONE_DOC_PER_FILE :: InputFormat
- pattern InputFormat_ONE_DOC_PER_LINE :: InputFormat
- newtype JobStatus where
- JobStatus' { }
- pattern JobStatus_COMPLETED :: JobStatus
- pattern JobStatus_FAILED :: JobStatus
- pattern JobStatus_IN_PROGRESS :: JobStatus
- pattern JobStatus_STOPPED :: JobStatus
- pattern JobStatus_STOP_REQUESTED :: JobStatus
- pattern JobStatus_SUBMITTED :: JobStatus
- newtype LanguageCode where
- LanguageCode' { }
- pattern LanguageCode_Ar :: LanguageCode
- pattern LanguageCode_De :: LanguageCode
- pattern LanguageCode_En :: LanguageCode
- pattern LanguageCode_Es :: LanguageCode
- pattern LanguageCode_Fr :: LanguageCode
- pattern LanguageCode_Hi :: LanguageCode
- pattern LanguageCode_It :: LanguageCode
- pattern LanguageCode_Ja :: LanguageCode
- pattern LanguageCode_Ko :: LanguageCode
- pattern LanguageCode_Pt :: LanguageCode
- pattern LanguageCode_Zh :: LanguageCode
- pattern LanguageCode_Zh_TW :: LanguageCode
- newtype ModelStatus where
- ModelStatus' { }
- pattern ModelStatus_DELETING :: ModelStatus
- pattern ModelStatus_IN_ERROR :: ModelStatus
- pattern ModelStatus_STOPPED :: ModelStatus
- pattern ModelStatus_STOP_REQUESTED :: ModelStatus
- pattern ModelStatus_SUBMITTED :: ModelStatus
- pattern ModelStatus_TRAINED :: ModelStatus
- pattern ModelStatus_TRAINING :: ModelStatus
- newtype PartOfSpeechTagType where
- PartOfSpeechTagType' { }
- pattern PartOfSpeechTagType_ADJ :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_ADP :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_ADV :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_AUX :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_CCONJ :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_CONJ :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_DET :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_INTJ :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_NOUN :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_NUM :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_O :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_PART :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_PRON :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_PROPN :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_PUNCT :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_SCONJ :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_SYM :: PartOfSpeechTagType
- pattern PartOfSpeechTagType_VERB :: PartOfSpeechTagType
- newtype PiiEntitiesDetectionMaskMode where
- newtype PiiEntitiesDetectionMode where
- newtype PiiEntityType where
- PiiEntityType' { }
- pattern PiiEntityType_ADDRESS :: PiiEntityType
- pattern PiiEntityType_AGE :: PiiEntityType
- pattern PiiEntityType_ALL :: PiiEntityType
- pattern PiiEntityType_AWS_ACCESS_KEY :: PiiEntityType
- pattern PiiEntityType_AWS_SECRET_KEY :: PiiEntityType
- pattern PiiEntityType_BANK_ACCOUNT_NUMBER :: PiiEntityType
- pattern PiiEntityType_BANK_ROUTING :: PiiEntityType
- pattern PiiEntityType_CREDIT_DEBIT_CVV :: PiiEntityType
- pattern PiiEntityType_CREDIT_DEBIT_EXPIRY :: PiiEntityType
- pattern PiiEntityType_CREDIT_DEBIT_NUMBER :: PiiEntityType
- pattern PiiEntityType_DATE_TIME :: PiiEntityType
- pattern PiiEntityType_DRIVER_ID :: PiiEntityType
- pattern PiiEntityType_EMAIL :: PiiEntityType
- pattern PiiEntityType_IP_ADDRESS :: PiiEntityType
- pattern PiiEntityType_MAC_ADDRESS :: PiiEntityType
- pattern PiiEntityType_NAME :: PiiEntityType
- pattern PiiEntityType_PASSPORT_NUMBER :: PiiEntityType
- pattern PiiEntityType_PASSWORD :: PiiEntityType
- pattern PiiEntityType_PHONE :: PiiEntityType
- pattern PiiEntityType_PIN :: PiiEntityType
- pattern PiiEntityType_SSN :: PiiEntityType
- pattern PiiEntityType_URL :: PiiEntityType
- pattern PiiEntityType_USERNAME :: PiiEntityType
- newtype SentimentType where
- SentimentType' { }
- pattern SentimentType_MIXED :: SentimentType
- pattern SentimentType_NEGATIVE :: SentimentType
- pattern SentimentType_NEUTRAL :: SentimentType
- pattern SentimentType_POSITIVE :: SentimentType
- newtype Split where
- Split' { }
- pattern Split_TEST :: Split
- pattern Split_TRAIN :: Split
- newtype SyntaxLanguageCode where
- SyntaxLanguageCode' { }
- pattern SyntaxLanguageCode_De :: SyntaxLanguageCode
- pattern SyntaxLanguageCode_En :: SyntaxLanguageCode
- pattern SyntaxLanguageCode_Es :: SyntaxLanguageCode
- pattern SyntaxLanguageCode_Fr :: SyntaxLanguageCode
- pattern SyntaxLanguageCode_It :: SyntaxLanguageCode
- pattern SyntaxLanguageCode_Pt :: SyntaxLanguageCode
- data AugmentedManifestsListItem = AugmentedManifestsListItem' (Maybe Text) (Maybe AugmentedManifestsDocumentTypeFormat) (Maybe Split) (Maybe Text) Text [Text]
- newAugmentedManifestsListItem :: Text -> AugmentedManifestsListItem
- data BatchDetectDominantLanguageItemResult = BatchDetectDominantLanguageItemResult' (Maybe [DominantLanguage]) (Maybe Int)
- newBatchDetectDominantLanguageItemResult :: BatchDetectDominantLanguageItemResult
- data BatchDetectEntitiesItemResult = BatchDetectEntitiesItemResult' (Maybe [Entity]) (Maybe Int)
- newBatchDetectEntitiesItemResult :: BatchDetectEntitiesItemResult
- data BatchDetectKeyPhrasesItemResult = BatchDetectKeyPhrasesItemResult' (Maybe Int) (Maybe [KeyPhrase])
- newBatchDetectKeyPhrasesItemResult :: BatchDetectKeyPhrasesItemResult
- data BatchDetectSentimentItemResult = BatchDetectSentimentItemResult' (Maybe SentimentType) (Maybe SentimentScore) (Maybe Int)
- newBatchDetectSentimentItemResult :: BatchDetectSentimentItemResult
- data BatchDetectSyntaxItemResult = BatchDetectSyntaxItemResult' (Maybe Int) (Maybe [SyntaxToken])
- newBatchDetectSyntaxItemResult :: BatchDetectSyntaxItemResult
- data BatchItemError = BatchItemError' (Maybe Text) (Maybe Text) (Maybe Int)
- newBatchItemError :: BatchItemError
- data ClassifierEvaluationMetrics = ClassifierEvaluationMetrics' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double)
- newClassifierEvaluationMetrics :: ClassifierEvaluationMetrics
- data ClassifierMetadata = ClassifierMetadata' (Maybe Int) (Maybe ClassifierEvaluationMetrics) (Maybe Int) (Maybe Int)
- newClassifierMetadata :: ClassifierMetadata
- data DocumentClass = DocumentClass' (Maybe Double) (Maybe Text)
- newDocumentClass :: DocumentClass
- data DocumentClassificationJobFilter = DocumentClassificationJobFilter' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe JobStatus)
- newDocumentClassificationJobFilter :: DocumentClassificationJobFilter
- data DocumentClassificationJobProperties = DocumentClassificationJobProperties' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InputDataConfig) (Maybe VpcConfig) (Maybe Text) (Maybe POSIX) (Maybe OutputDataConfig) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe POSIX)
- newDocumentClassificationJobProperties :: DocumentClassificationJobProperties
- data DocumentClassifierFilter = DocumentClassifierFilter' (Maybe ModelStatus) (Maybe POSIX) (Maybe POSIX) (Maybe Text)
- newDocumentClassifierFilter :: DocumentClassifierFilter
- data DocumentClassifierInputDataConfig = DocumentClassifierInputDataConfig' (Maybe [AugmentedManifestsListItem]) (Maybe DocumentClassifierDataFormat) (Maybe Text) (Maybe Text) (Maybe Text)
- newDocumentClassifierInputDataConfig :: DocumentClassifierInputDataConfig
- data DocumentClassifierOutputDataConfig = DocumentClassifierOutputDataConfig' (Maybe Text) (Maybe Text)
- newDocumentClassifierOutputDataConfig :: DocumentClassifierOutputDataConfig
- data DocumentClassifierProperties = DocumentClassifierProperties' (Maybe ModelStatus) (Maybe LanguageCode) (Maybe (Sensitive ClassifierMetadata)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DocumentClassifierMode) (Maybe DocumentClassifierInputDataConfig) (Maybe VpcConfig) (Maybe Text) (Maybe POSIX) (Maybe DocumentClassifierOutputDataConfig) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newDocumentClassifierProperties :: DocumentClassifierProperties
- data DocumentClassifierSummary = DocumentClassifierSummary' (Maybe POSIX) (Maybe Text) (Maybe ModelStatus) (Maybe Int) (Maybe Text)
- newDocumentClassifierSummary :: DocumentClassifierSummary
- data DocumentLabel = DocumentLabel' (Maybe Double) (Maybe Text)
- newDocumentLabel :: DocumentLabel
- data DocumentReaderConfig = DocumentReaderConfig' (Maybe (NonEmpty DocumentReadFeatureTypes)) (Maybe DocumentReadMode) DocumentReadAction
- newDocumentReaderConfig :: DocumentReadAction -> DocumentReaderConfig
- data DominantLanguage = DominantLanguage' (Maybe Text) (Maybe Double)
- newDominantLanguage :: DominantLanguage
- data DominantLanguageDetectionJobFilter = DominantLanguageDetectionJobFilter' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe JobStatus)
- newDominantLanguageDetectionJobFilter :: DominantLanguageDetectionJobFilter
- data DominantLanguageDetectionJobProperties = DominantLanguageDetectionJobProperties' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InputDataConfig) (Maybe VpcConfig) (Maybe Text) (Maybe POSIX) (Maybe OutputDataConfig) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe POSIX)
- newDominantLanguageDetectionJobProperties :: DominantLanguageDetectionJobProperties
- data EndpointFilter = EndpointFilter' (Maybe EndpointStatus) (Maybe Text) (Maybe POSIX) (Maybe POSIX)
- newEndpointFilter :: EndpointFilter
- data EndpointProperties = EndpointProperties' (Maybe POSIX) (Maybe EndpointStatus) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newEndpointProperties :: EndpointProperties
- data EntitiesDetectionJobFilter = EntitiesDetectionJobFilter' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe JobStatus)
- newEntitiesDetectionJobFilter :: EntitiesDetectionJobFilter
- data EntitiesDetectionJobProperties = EntitiesDetectionJobProperties' (Maybe LanguageCode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InputDataConfig) (Maybe VpcConfig) (Maybe Text) (Maybe POSIX) (Maybe OutputDataConfig) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe POSIX)
- newEntitiesDetectionJobProperties :: EntitiesDetectionJobProperties
- data Entity = Entity' (Maybe Int) (Maybe Text) (Maybe Double) (Maybe Int) (Maybe EntityType)
- newEntity :: Entity
- data EntityLabel = EntityLabel' (Maybe Double) (Maybe PiiEntityType)
- newEntityLabel :: EntityLabel
- data EntityRecognizerAnnotations = EntityRecognizerAnnotations' (Maybe Text) Text
- newEntityRecognizerAnnotations :: Text -> EntityRecognizerAnnotations
- data EntityRecognizerDocuments = EntityRecognizerDocuments' (Maybe InputFormat) (Maybe Text) Text
- newEntityRecognizerDocuments :: Text -> EntityRecognizerDocuments
- data EntityRecognizerEntityList = EntityRecognizerEntityList' Text
- newEntityRecognizerEntityList :: Text -> EntityRecognizerEntityList
- data EntityRecognizerEvaluationMetrics = EntityRecognizerEvaluationMetrics' (Maybe Double) (Maybe Double) (Maybe Double)
- newEntityRecognizerEvaluationMetrics :: EntityRecognizerEvaluationMetrics
- data EntityRecognizerFilter = EntityRecognizerFilter' (Maybe ModelStatus) (Maybe POSIX) (Maybe POSIX) (Maybe Text)
- newEntityRecognizerFilter :: EntityRecognizerFilter
- data EntityRecognizerInputDataConfig = EntityRecognizerInputDataConfig' (Maybe [AugmentedManifestsListItem]) (Maybe EntityRecognizerAnnotations) (Maybe EntityRecognizerDataFormat) (Maybe EntityRecognizerDocuments) (Maybe EntityRecognizerEntityList) [EntityTypesListItem]
- newEntityRecognizerInputDataConfig :: EntityRecognizerInputDataConfig
- data EntityRecognizerMetadata = EntityRecognizerMetadata' (Maybe [EntityRecognizerMetadataEntityTypesListItem]) (Maybe EntityRecognizerEvaluationMetrics) (Maybe Int) (Maybe Int)
- newEntityRecognizerMetadata :: EntityRecognizerMetadata
- data EntityRecognizerMetadataEntityTypesListItem = EntityRecognizerMetadataEntityTypesListItem' (Maybe EntityTypesEvaluationMetrics) (Maybe Text) (Maybe Int)
- newEntityRecognizerMetadataEntityTypesListItem :: EntityRecognizerMetadataEntityTypesListItem
- data EntityRecognizerProperties = EntityRecognizerProperties' (Maybe ModelStatus) (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe EntityRecognizerInputDataConfig) (Maybe VpcConfig) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe (Sensitive EntityRecognizerMetadata)) (Maybe Text) (Maybe POSIX)
- newEntityRecognizerProperties :: EntityRecognizerProperties
- data EntityRecognizerSummary = EntityRecognizerSummary' (Maybe POSIX) (Maybe ModelStatus) (Maybe Int) (Maybe Text) (Maybe Text)
- newEntityRecognizerSummary :: EntityRecognizerSummary
- data EntityTypesEvaluationMetrics = EntityTypesEvaluationMetrics' (Maybe Double) (Maybe Double) (Maybe Double)
- newEntityTypesEvaluationMetrics :: EntityTypesEvaluationMetrics
- data EntityTypesListItem = EntityTypesListItem' Text
- newEntityTypesListItem :: Text -> EntityTypesListItem
- data EventsDetectionJobFilter = EventsDetectionJobFilter' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe JobStatus)
- newEventsDetectionJobFilter :: EventsDetectionJobFilter
- data EventsDetectionJobProperties = EventsDetectionJobProperties' (Maybe LanguageCode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe InputDataConfig) (Maybe POSIX) (Maybe OutputDataConfig) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe POSIX)
- newEventsDetectionJobProperties :: EventsDetectionJobProperties
- data InputDataConfig = InputDataConfig' (Maybe DocumentReaderConfig) (Maybe InputFormat) Text
- newInputDataConfig :: Text -> InputDataConfig
- data KeyPhrase = KeyPhrase' (Maybe Int) (Maybe Text) (Maybe Double) (Maybe Int)
- newKeyPhrase :: KeyPhrase
- data KeyPhrasesDetectionJobFilter = KeyPhrasesDetectionJobFilter' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe JobStatus)
- newKeyPhrasesDetectionJobFilter :: KeyPhrasesDetectionJobFilter
- data KeyPhrasesDetectionJobProperties = KeyPhrasesDetectionJobProperties' (Maybe LanguageCode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InputDataConfig) (Maybe VpcConfig) (Maybe Text) (Maybe POSIX) (Maybe OutputDataConfig) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe POSIX)
- newKeyPhrasesDetectionJobProperties :: KeyPhrasesDetectionJobProperties
- data OutputDataConfig = OutputDataConfig' (Maybe Text) Text
- newOutputDataConfig :: Text -> OutputDataConfig
- data PartOfSpeechTag = PartOfSpeechTag' (Maybe PartOfSpeechTagType) (Maybe Double)
- newPartOfSpeechTag :: PartOfSpeechTag
- data PiiEntitiesDetectionJobFilter = PiiEntitiesDetectionJobFilter' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe JobStatus)
- newPiiEntitiesDetectionJobFilter :: PiiEntitiesDetectionJobFilter
- data PiiEntitiesDetectionJobProperties = PiiEntitiesDetectionJobProperties' (Maybe LanguageCode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe PiiEntitiesDetectionMode) (Maybe InputDataConfig) (Maybe RedactionConfig) (Maybe POSIX) (Maybe PiiOutputDataConfig) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe POSIX)
- newPiiEntitiesDetectionJobProperties :: PiiEntitiesDetectionJobProperties
- data PiiEntity = PiiEntity' (Maybe Int) (Maybe Double) (Maybe Int) (Maybe PiiEntityType)
- newPiiEntity :: PiiEntity
- data PiiOutputDataConfig = PiiOutputDataConfig' (Maybe Text) Text
- newPiiOutputDataConfig :: Text -> PiiOutputDataConfig
- data RedactionConfig = RedactionConfig' (Maybe Text) (Maybe PiiEntitiesDetectionMaskMode) (Maybe [PiiEntityType])
- newRedactionConfig :: RedactionConfig
- data SentimentDetectionJobFilter = SentimentDetectionJobFilter' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe JobStatus)
- newSentimentDetectionJobFilter :: SentimentDetectionJobFilter
- data SentimentDetectionJobProperties = SentimentDetectionJobProperties' (Maybe LanguageCode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InputDataConfig) (Maybe VpcConfig) (Maybe Text) (Maybe POSIX) (Maybe OutputDataConfig) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe POSIX)
- newSentimentDetectionJobProperties :: SentimentDetectionJobProperties
- data SentimentScore = SentimentScore' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double)
- newSentimentScore :: SentimentScore
- data SyntaxToken = SyntaxToken' (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe PartOfSpeechTag)
- newSyntaxToken :: SyntaxToken
- data Tag = Tag' (Maybe Text) Text
- newTag :: Text -> Tag
- data TopicsDetectionJobFilter = TopicsDetectionJobFilter' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe JobStatus)
- newTopicsDetectionJobFilter :: TopicsDetectionJobFilter
- data TopicsDetectionJobProperties = TopicsDetectionJobProperties' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InputDataConfig) (Maybe VpcConfig) (Maybe Text) (Maybe POSIX) (Maybe OutputDataConfig) (Maybe Text) (Maybe Int) (Maybe JobStatus) (Maybe Text) (Maybe POSIX)
- newTopicsDetectionJobProperties :: TopicsDetectionJobProperties
- data VpcConfig = VpcConfig' (NonEmpty Text) (NonEmpty Text)
- newVpcConfig :: NonEmpty Text -> NonEmpty Text -> VpcConfig
Service Configuration
defaultService :: Service Source #
API version 2017-11-27 of the Amazon Comprehend SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Comprehend.
ResourceUnavailableException
_ResourceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource is not available. Check the resource and try your request again.
InvalidRequestException
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request is invalid.
ResourceLimitExceededException
_ResourceLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
TooManyTagsException
_TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of requests exceeds the limit. Resubmit your request later.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.
InternalServerException
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal server error occurred. Retry your request.
BatchSizeLimitExceededException
_BatchSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
UnsupportedLanguageException
_UnsupportedLanguageException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.
JobNotFoundException
_JobNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified job was not found. Check the job ID and try again.
TooManyTagKeysException
_TooManyTagKeysException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request contains more tag keys than can be associated with a resource (50 tag keys per resource).
InvalidFilterException
_InvalidFilterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The filter specified for the operation is invalid. Specify a different filter.
KmsKeyValidationException
_KmsKeyValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource ARN was not found. Check the ARN and try your request again.
TextSizeLimitExceededException
_TextSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The size of the input text exceeds the limit. Use a smaller document.
ResourceInUseException
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource name is already in use. Use a different name and try your request again.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchDetectSentiment
data BatchDetectSentiment Source #
See: newBatchDetectSentiment smart constructor.
Constructors
| BatchDetectSentiment' (Sensitive [Sensitive Text]) LanguageCode |
Instances
newBatchDetectSentiment Source #
Create a value of BatchDetectSentiment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:textList:BatchDetectSentiment', batchDetectSentiment_textList - A list containing the text of the input documents. The list can contain
a maximum of 25 documents. Each document must contain fewer that 5,000
bytes of UTF-8 encoded characters.
$sel:languageCode:BatchDetectSentiment', batchDetectSentiment_languageCode - 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.
data BatchDetectSentimentResponse Source #
See: newBatchDetectSentimentResponse smart constructor.
Constructors
| BatchDetectSentimentResponse' Int [BatchDetectSentimentItemResult] [BatchItemError] |
Instances
newBatchDetectSentimentResponse Source #
Create a value of BatchDetectSentimentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:BatchDetectSentimentResponse', batchDetectSentimentResponse_httpStatus - The response's http status code.
$sel:resultList:BatchDetectSentimentResponse', batchDetectSentimentResponse_resultList - 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.
$sel:errorList:BatchDetectSentimentResponse', batchDetectSentimentResponse_errorList - 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.
DeleteEntityRecognizer
data DeleteEntityRecognizer Source #
See: newDeleteEntityRecognizer smart constructor.
Constructors
| DeleteEntityRecognizer' Text |
Instances
newDeleteEntityRecognizer Source #
Create a value of DeleteEntityRecognizer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entityRecognizerArn:DeleteEntityRecognizer', deleteEntityRecognizer_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.
data DeleteEntityRecognizerResponse Source #
See: newDeleteEntityRecognizerResponse smart constructor.
Constructors
| DeleteEntityRecognizerResponse' Int |
Instances
newDeleteEntityRecognizerResponse Source #
Create a value of DeleteEntityRecognizerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteEntityRecognizerResponse', deleteEntityRecognizerResponse_httpStatus - The response's http status code.
DescribeKeyPhrasesDetectionJob
data DescribeKeyPhrasesDetectionJob Source #
See: newDescribeKeyPhrasesDetectionJob smart constructor.
Constructors
| DescribeKeyPhrasesDetectionJob' Text |
Instances
newDescribeKeyPhrasesDetectionJob Source #
Create a value of DescribeKeyPhrasesDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:DescribeKeyPhrasesDetectionJob', describeKeyPhrasesDetectionJob_jobId - The identifier that Amazon Comprehend generated for the job. The
operation returns this identifier in its response.
data DescribeKeyPhrasesDetectionJobResponse Source #
See: newDescribeKeyPhrasesDetectionJobResponse smart constructor.
Instances
newDescribeKeyPhrasesDetectionJobResponse Source #
Arguments
| :: Int | |
| -> DescribeKeyPhrasesDetectionJobResponse |
Create a value of DescribeKeyPhrasesDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyPhrasesDetectionJobProperties:DescribeKeyPhrasesDetectionJobResponse', describeKeyPhrasesDetectionJobResponse_keyPhrasesDetectionJobProperties - An object that contains the properties associated with a key phrases
detection job.
$sel:httpStatus:DescribeKeyPhrasesDetectionJobResponse', describeKeyPhrasesDetectionJobResponse_httpStatus - The response's http status code.
ListEntitiesDetectionJobs (Paginated)
data ListEntitiesDetectionJobs Source #
See: newListEntitiesDetectionJobs smart constructor.
Constructors
| ListEntitiesDetectionJobs' (Maybe Text) (Maybe EntitiesDetectionJobFilter) (Maybe Natural) |
Instances
newListEntitiesDetectionJobs :: ListEntitiesDetectionJobs Source #
Create a value of ListEntitiesDetectionJobs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListEntitiesDetectionJobs', listEntitiesDetectionJobs_nextToken - Identifies the next page of results to return.
$sel:filter':ListEntitiesDetectionJobs', listEntitiesDetectionJobs_filter - 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.
$sel:maxResults:ListEntitiesDetectionJobs', listEntitiesDetectionJobs_maxResults - The maximum number of results to return in each page. The default is
100.
data ListEntitiesDetectionJobsResponse Source #
See: newListEntitiesDetectionJobsResponse smart constructor.
Constructors
| ListEntitiesDetectionJobsResponse' (Maybe [EntitiesDetectionJobProperties]) (Maybe Text) Int |
Instances
newListEntitiesDetectionJobsResponse Source #
Arguments
| :: Int | |
| -> ListEntitiesDetectionJobsResponse |
Create a value of ListEntitiesDetectionJobsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entitiesDetectionJobPropertiesList:ListEntitiesDetectionJobsResponse', listEntitiesDetectionJobsResponse_entitiesDetectionJobPropertiesList - A list containing the properties of each job that is returned.
$sel:nextToken:ListEntitiesDetectionJobs', listEntitiesDetectionJobsResponse_nextToken - Identifies the next page of results to return.
$sel:httpStatus:ListEntitiesDetectionJobsResponse', listEntitiesDetectionJobsResponse_httpStatus - The response's http status code.
CreateEndpoint
data CreateEndpoint Source #
See: newCreateEndpoint smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Natural | |
| -> CreateEndpoint |
Create a value of CreateEndpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataAccessRoleArn:CreateEndpoint', createEndpoint_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS identity and Access Management
(IAM) role that grants Amazon Comprehend read access to trained custom
models encrypted with a customer managed key (ModelKmsKeyId).
$sel:clientRequestToken:CreateEndpoint', createEndpoint_clientRequestToken - An idempotency token provided by the customer. If this token matches a
previous endpoint creation request, Amazon Comprehend will not return a
ResourceInUseException.
$sel:tags:CreateEndpoint', createEndpoint_tags - 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.
$sel:endpointName:CreateEndpoint', createEndpoint_endpointName - This is the descriptive suffix that becomes part of the EndpointArn
used for all subsequent requests to this resource.
$sel:modelArn:CreateEndpoint', createEndpoint_modelArn - The Amazon Resource Number (ARN) of the model to which the endpoint will
be attached.
$sel:desiredInferenceUnits:CreateEndpoint', createEndpoint_desiredInferenceUnits - The desired number of inference units to be used by the model using this
endpoint. Each inference unit represents of a throughput of 100
characters per second.
data CreateEndpointResponse Source #
See: newCreateEndpointResponse smart constructor.
Constructors
| CreateEndpointResponse' (Maybe Text) Int |
Instances
newCreateEndpointResponse Source #
Create a value of CreateEndpointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointArn:CreateEndpointResponse', createEndpointResponse_endpointArn - The Amazon Resource Number (ARN) of the endpoint being created.
$sel:httpStatus:CreateEndpointResponse', createEndpointResponse_httpStatus - The response's http status code.
StopEventsDetectionJob
data StopEventsDetectionJob Source #
See: newStopEventsDetectionJob smart constructor.
Constructors
| StopEventsDetectionJob' Text |
Instances
newStopEventsDetectionJob Source #
Arguments
| :: Text | |
| -> StopEventsDetectionJob |
Create a value of StopEventsDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopEventsDetectionJob', stopEventsDetectionJob_jobId - The identifier of the events detection job to stop.
data StopEventsDetectionJobResponse Source #
See: newStopEventsDetectionJobResponse smart constructor.
Instances
newStopEventsDetectionJobResponse Source #
Create a value of StopEventsDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopEventsDetectionJob', stopEventsDetectionJobResponse_jobId - The identifier of the events detection job to stop.
$sel:jobStatus:StopEventsDetectionJobResponse', stopEventsDetectionJobResponse_jobStatus - The status of the events detection job.
$sel:httpStatus:StopEventsDetectionJobResponse', stopEventsDetectionJobResponse_httpStatus - The response's http status code.
StartSentimentDetectionJob
data StartSentimentDetectionJob Source #
See: newStartSentimentDetectionJob smart constructor.
Constructors
| StartSentimentDetectionJob' (Maybe Text) (Maybe VpcConfig) (Maybe Text) (Maybe Text) (Maybe [Tag]) InputDataConfig OutputDataConfig Text LanguageCode |
Instances
newStartSentimentDetectionJob Source #
Arguments
| :: InputDataConfig | |
| -> OutputDataConfig | |
| -> Text | |
| -> LanguageCode | |
| -> StartSentimentDetectionJob |
Create a value of StartSentimentDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobName:StartSentimentDetectionJob', startSentimentDetectionJob_jobName - The identifier of the job.
$sel:vpcConfig:StartSentimentDetectionJob', startSentimentDetectionJob_vpcConfig - 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.
$sel:volumeKmsKeyId:StartSentimentDetectionJob', startSentimentDetectionJob_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:clientRequestToken:StartSentimentDetectionJob', startSentimentDetectionJob_clientRequestToken - A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
$sel:tags:StartSentimentDetectionJob', startSentimentDetectionJob_tags - 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.
$sel:inputDataConfig:StartSentimentDetectionJob', startSentimentDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.
$sel:outputDataConfig:StartSentimentDetectionJob', startSentimentDetectionJob_outputDataConfig - Specifies where to send the output files.
$sel:dataAccessRoleArn:StartSentimentDetectionJob', startSentimentDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that grants Amazon Comprehend read access to your input data.
For more information, see
https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
$sel:languageCode:StartSentimentDetectionJob', startSentimentDetectionJob_languageCode - 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.
data StartSentimentDetectionJobResponse Source #
See: newStartSentimentDetectionJobResponse smart constructor.
Instances
newStartSentimentDetectionJobResponse Source #
Arguments
| :: Int | |
| -> StartSentimentDetectionJobResponse |
Create a value of StartSentimentDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartSentimentDetectionJobResponse', startSentimentDetectionJobResponse_jobId - The identifier generated for the job. To get the status of a job, use
this identifier with the operation.
$sel:jobArn:StartSentimentDetectionJobResponse', startSentimentDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the sentiment detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobStatus:StartSentimentDetectionJobResponse', startSentimentDetectionJobResponse_jobStatus - 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.
$sel:httpStatus:StartSentimentDetectionJobResponse', startSentimentDetectionJobResponse_httpStatus - The response's http status code.
BatchDetectSyntax
data BatchDetectSyntax Source #
See: newBatchDetectSyntax smart constructor.
Constructors
| BatchDetectSyntax' (Sensitive [Sensitive Text]) SyntaxLanguageCode |
Instances
Create a value of BatchDetectSyntax with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:textList:BatchDetectSyntax', batchDetectSyntax_textList - A list containing the text of the input documents. The list can contain
a maximum of 25 documents. Each document must contain fewer that 5,000
bytes of UTF-8 encoded characters.
$sel:languageCode:BatchDetectSyntax', batchDetectSyntax_languageCode - 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.
data BatchDetectSyntaxResponse Source #
See: newBatchDetectSyntaxResponse smart constructor.
Constructors
| BatchDetectSyntaxResponse' Int [BatchDetectSyntaxItemResult] [BatchItemError] |
Instances
newBatchDetectSyntaxResponse Source #
Create a value of BatchDetectSyntaxResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:BatchDetectSyntaxResponse', batchDetectSyntaxResponse_httpStatus - The response's http status code.
$sel:resultList:BatchDetectSyntaxResponse', batchDetectSyntaxResponse_resultList - 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.
$sel:errorList:BatchDetectSyntaxResponse', batchDetectSyntaxResponse_errorList - 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.
StartTopicsDetectionJob
data StartTopicsDetectionJob Source #
See: newStartTopicsDetectionJob smart constructor.
Constructors
| StartTopicsDetectionJob' (Maybe Text) (Maybe VpcConfig) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe [Tag]) InputDataConfig OutputDataConfig Text |
Instances
newStartTopicsDetectionJob Source #
Arguments
| :: InputDataConfig | |
| -> OutputDataConfig | |
| -> Text | |
| -> StartTopicsDetectionJob |
Create a value of StartTopicsDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobName:StartTopicsDetectionJob', startTopicsDetectionJob_jobName - The identifier of the job.
$sel:vpcConfig:StartTopicsDetectionJob', startTopicsDetectionJob_vpcConfig - 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.
$sel:volumeKmsKeyId:StartTopicsDetectionJob', startTopicsDetectionJob_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:numberOfTopics:StartTopicsDetectionJob', startTopicsDetectionJob_numberOfTopics - The number of topics to detect.
$sel:clientRequestToken:StartTopicsDetectionJob', startTopicsDetectionJob_clientRequestToken - A unique identifier for the request. If you do not set the client
request token, Amazon Comprehend generates one.
$sel:tags:StartTopicsDetectionJob', startTopicsDetectionJob_tags - 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.
$sel:inputDataConfig:StartTopicsDetectionJob', startTopicsDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.
$sel:outputDataConfig:StartTopicsDetectionJob', startTopicsDetectionJob_outputDataConfig - 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
$sel:dataAccessRoleArn:StartTopicsDetectionJob', startTopicsDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that grants Amazon Comprehend read access to your input data.
For more information, see
https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
data StartTopicsDetectionJobResponse Source #
See: newStartTopicsDetectionJobResponse smart constructor.
Instances
newStartTopicsDetectionJobResponse Source #
Create a value of StartTopicsDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartTopicsDetectionJobResponse', startTopicsDetectionJobResponse_jobId - The identifier generated for the job. To get the status of the job, use
this identifier with the DescribeTopicDetectionJob operation.
$sel:jobArn:StartTopicsDetectionJobResponse', startTopicsDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the topics detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobStatus:StartTopicsDetectionJobResponse', startTopicsDetectionJobResponse_jobStatus - 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
DescribeTopicDetectionJoboperation.
$sel:httpStatus:StartTopicsDetectionJobResponse', startTopicsDetectionJobResponse_httpStatus - The response's http status code.
DescribeEventsDetectionJob
data DescribeEventsDetectionJob Source #
See: newDescribeEventsDetectionJob smart constructor.
Constructors
| DescribeEventsDetectionJob' Text |
Instances
newDescribeEventsDetectionJob Source #
Create a value of DescribeEventsDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:DescribeEventsDetectionJob', describeEventsDetectionJob_jobId - The identifier of the events detection job.
data DescribeEventsDetectionJobResponse Source #
See: newDescribeEventsDetectionJobResponse smart constructor.
Instances
newDescribeEventsDetectionJobResponse Source #
Arguments
| :: Int | |
| -> DescribeEventsDetectionJobResponse |
Create a value of DescribeEventsDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventsDetectionJobProperties:DescribeEventsDetectionJobResponse', describeEventsDetectionJobResponse_eventsDetectionJobProperties - An object that contains the properties associated with an event
detection job.
$sel:httpStatus:DescribeEventsDetectionJobResponse', describeEventsDetectionJobResponse_httpStatus - The response's http status code.
DeleteEndpoint
data DeleteEndpoint Source #
See: newDeleteEndpoint smart constructor.
Constructors
| DeleteEndpoint' Text |
Instances
Arguments
| :: Text | |
| -> DeleteEndpoint |
Create a value of DeleteEndpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointArn:DeleteEndpoint', deleteEndpoint_endpointArn - The Amazon Resource Number (ARN) of the endpoint being deleted.
data DeleteEndpointResponse Source #
See: newDeleteEndpointResponse smart constructor.
Constructors
| DeleteEndpointResponse' Int |
Instances
newDeleteEndpointResponse Source #
Create a value of DeleteEndpointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteEndpointResponse', deleteEndpointResponse_httpStatus - The response's http status code.
UpdateEndpoint
data UpdateEndpoint Source #
See: newUpdateEndpoint smart constructor.
Instances
Arguments
| :: Text | |
| -> UpdateEndpoint |
Create a value of UpdateEndpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:desiredModelArn:UpdateEndpoint', updateEndpoint_desiredModelArn - The ARN of the new model to use when updating an existing endpoint.
$sel:desiredInferenceUnits:UpdateEndpoint', updateEndpoint_desiredInferenceUnits - The desired number of inference units to be used by the model using this
endpoint. Each inference unit represents of a throughput of 100
characters per second.
$sel:desiredDataAccessRoleArn:UpdateEndpoint', updateEndpoint_desiredDataAccessRoleArn - Data access role ARN to use in case the new model is encrypted with a
customer CMK.
$sel:endpointArn:UpdateEndpoint', updateEndpoint_endpointArn - The Amazon Resource Number (ARN) of the endpoint being updated.
data UpdateEndpointResponse Source #
See: newUpdateEndpointResponse smart constructor.
Constructors
| UpdateEndpointResponse' Int |
Instances
newUpdateEndpointResponse Source #
Create a value of UpdateEndpointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateEndpointResponse', updateEndpointResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the given Amazon Comprehend resource
you are querying.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource', listTagsForResourceResponse_resourceArn - The Amazon Resource Name (ARN) of the given Amazon Comprehend resource
you are querying.
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - 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.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
BatchDetectKeyPhrases
data BatchDetectKeyPhrases Source #
See: newBatchDetectKeyPhrases smart constructor.
Constructors
| BatchDetectKeyPhrases' (Sensitive [Sensitive Text]) LanguageCode |
Instances
newBatchDetectKeyPhrases Source #
Create a value of BatchDetectKeyPhrases with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:textList:BatchDetectKeyPhrases', batchDetectKeyPhrases_textList - A list containing the text of the input documents. The list can contain
a maximum of 25 documents. Each document must contain fewer that 5,000
bytes of UTF-8 encoded characters.
$sel:languageCode:BatchDetectKeyPhrases', batchDetectKeyPhrases_languageCode - 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.
data BatchDetectKeyPhrasesResponse Source #
See: newBatchDetectKeyPhrasesResponse smart constructor.
Instances
newBatchDetectKeyPhrasesResponse Source #
Create a value of BatchDetectKeyPhrasesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:BatchDetectKeyPhrasesResponse', batchDetectKeyPhrasesResponse_httpStatus - The response's http status code.
$sel:resultList:BatchDetectKeyPhrasesResponse', batchDetectKeyPhrasesResponse_resultList - 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.
$sel:errorList:BatchDetectKeyPhrasesResponse', batchDetectKeyPhrasesResponse_errorList - 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.
DescribeSentimentDetectionJob
data DescribeSentimentDetectionJob Source #
See: newDescribeSentimentDetectionJob smart constructor.
Constructors
| DescribeSentimentDetectionJob' Text |
Instances
newDescribeSentimentDetectionJob Source #
Create a value of DescribeSentimentDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:DescribeSentimentDetectionJob', describeSentimentDetectionJob_jobId - The identifier that Amazon Comprehend generated for the job. The
operation returns this identifier in its response.
data DescribeSentimentDetectionJobResponse Source #
See: newDescribeSentimentDetectionJobResponse smart constructor.
Instances
newDescribeSentimentDetectionJobResponse Source #
Arguments
| :: Int | |
| -> DescribeSentimentDetectionJobResponse |
Create a value of DescribeSentimentDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sentimentDetectionJobProperties:DescribeSentimentDetectionJobResponse', describeSentimentDetectionJobResponse_sentimentDetectionJobProperties - An object that contains the properties associated with a sentiment
detection job.
$sel:httpStatus:DescribeSentimentDetectionJobResponse', describeSentimentDetectionJobResponse_httpStatus - The response's http status code.
StartEntitiesDetectionJob
data StartEntitiesDetectionJob Source #
See: newStartEntitiesDetectionJob smart constructor.
Constructors
| StartEntitiesDetectionJob' (Maybe Text) (Maybe Text) (Maybe VpcConfig) (Maybe Text) (Maybe Text) (Maybe [Tag]) InputDataConfig OutputDataConfig Text LanguageCode |
Instances
newStartEntitiesDetectionJob Source #
Arguments
| :: InputDataConfig | |
| -> OutputDataConfig | |
| -> Text | |
| -> LanguageCode | |
| -> StartEntitiesDetectionJob |
Create a value of StartEntitiesDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entityRecognizerArn:StartEntitiesDetectionJob', startEntitiesDetectionJob_entityRecognizerArn - 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.
$sel:jobName:StartEntitiesDetectionJob', startEntitiesDetectionJob_jobName - The identifier of the job.
$sel:vpcConfig:StartEntitiesDetectionJob', startEntitiesDetectionJob_vpcConfig - 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.
$sel:volumeKmsKeyId:StartEntitiesDetectionJob', startEntitiesDetectionJob_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:clientRequestToken:StartEntitiesDetectionJob', startEntitiesDetectionJob_clientRequestToken - A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
$sel:tags:StartEntitiesDetectionJob', startEntitiesDetectionJob_tags - 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.
$sel:inputDataConfig:StartEntitiesDetectionJob', startEntitiesDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.
$sel:outputDataConfig:StartEntitiesDetectionJob', startEntitiesDetectionJob_outputDataConfig - Specifies where to send the output files.
$sel:dataAccessRoleArn:StartEntitiesDetectionJob', startEntitiesDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that grants Amazon Comprehend read access to your input data.
For more information, see
https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
$sel:languageCode:StartEntitiesDetectionJob', startEntitiesDetectionJob_languageCode - 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.
data StartEntitiesDetectionJobResponse Source #
See: newStartEntitiesDetectionJobResponse smart constructor.
Instances
newStartEntitiesDetectionJobResponse Source #
Arguments
| :: Int | |
| -> StartEntitiesDetectionJobResponse |
Create a value of StartEntitiesDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartEntitiesDetectionJobResponse', startEntitiesDetectionJobResponse_jobId - The identifier generated for the job. To get the status of job, use this
identifier with the operation.
$sel:jobArn:StartEntitiesDetectionJobResponse', startEntitiesDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the entities detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobStatus:StartEntitiesDetectionJobResponse', startEntitiesDetectionJobResponse_jobStatus - 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.
$sel:httpStatus:StartEntitiesDetectionJobResponse', startEntitiesDetectionJobResponse_httpStatus - The response's http status code.
StopPiiEntitiesDetectionJob
data StopPiiEntitiesDetectionJob Source #
See: newStopPiiEntitiesDetectionJob smart constructor.
Constructors
| StopPiiEntitiesDetectionJob' Text |
Instances
newStopPiiEntitiesDetectionJob Source #
Create a value of StopPiiEntitiesDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopPiiEntitiesDetectionJob', stopPiiEntitiesDetectionJob_jobId - The identifier of the PII entities detection job to stop.
data StopPiiEntitiesDetectionJobResponse Source #
See: newStopPiiEntitiesDetectionJobResponse smart constructor.
Instances
newStopPiiEntitiesDetectionJobResponse Source #
Arguments
| :: Int | |
| -> StopPiiEntitiesDetectionJobResponse |
Create a value of StopPiiEntitiesDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopPiiEntitiesDetectionJob', stopPiiEntitiesDetectionJobResponse_jobId - The identifier of the PII entities detection job to stop.
$sel:jobStatus:StopPiiEntitiesDetectionJobResponse', stopPiiEntitiesDetectionJobResponse_jobStatus - The status of the PII entities detection job.
$sel:httpStatus:StopPiiEntitiesDetectionJobResponse', stopPiiEntitiesDetectionJobResponse_httpStatus - The response's http status code.
DescribeEntityRecognizer
data DescribeEntityRecognizer Source #
See: newDescribeEntityRecognizer smart constructor.
Constructors
| DescribeEntityRecognizer' Text |
Instances
newDescribeEntityRecognizer Source #
Create a value of DescribeEntityRecognizer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entityRecognizerArn:DescribeEntityRecognizer', describeEntityRecognizer_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.
data DescribeEntityRecognizerResponse Source #
See: newDescribeEntityRecognizerResponse smart constructor.
Constructors
| DescribeEntityRecognizerResponse' (Maybe EntityRecognizerProperties) Int |
Instances
newDescribeEntityRecognizerResponse Source #
Create a value of DescribeEntityRecognizerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entityRecognizerProperties:DescribeEntityRecognizerResponse', describeEntityRecognizerResponse_entityRecognizerProperties - Describes information associated with an entity recognizer.
$sel:httpStatus:DescribeEntityRecognizerResponse', describeEntityRecognizerResponse_httpStatus - The response's http status code.
DetectSentiment
data DetectSentiment Source #
See: newDetectSentiment smart constructor.
Constructors
| DetectSentiment' (Sensitive Text) LanguageCode |
Instances
Arguments
| :: Text | |
| -> LanguageCode | |
| -> DetectSentiment |
Create a value of DetectSentiment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:DetectSentiment', detectSentiment_text - A UTF-8 text string. Each string must contain fewer that 5,000 bytes of
UTF-8 encoded characters.
$sel:languageCode:DetectSentiment', detectSentiment_languageCode - 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.
data DetectSentimentResponse Source #
See: newDetectSentimentResponse smart constructor.
Constructors
| DetectSentimentResponse' (Maybe SentimentType) (Maybe SentimentScore) Int |
Instances
newDetectSentimentResponse Source #
Create a value of DetectSentimentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sentiment:DetectSentimentResponse', detectSentimentResponse_sentiment - The inferred sentiment that Amazon Comprehend has the highest level of
confidence in.
$sel:sentimentScore:DetectSentimentResponse', detectSentimentResponse_sentimentScore - An object that lists the sentiments, and their corresponding confidence
levels.
$sel:httpStatus:DetectSentimentResponse', detectSentimentResponse_httpStatus - The response's http status code.
StartDominantLanguageDetectionJob
data StartDominantLanguageDetectionJob Source #
See: newStartDominantLanguageDetectionJob smart constructor.
Constructors
| StartDominantLanguageDetectionJob' (Maybe Text) (Maybe VpcConfig) (Maybe Text) (Maybe Text) (Maybe [Tag]) InputDataConfig OutputDataConfig Text |
Instances
newStartDominantLanguageDetectionJob Source #
Arguments
| :: InputDataConfig | |
| -> OutputDataConfig | |
| -> Text | |
| -> StartDominantLanguageDetectionJob |
Create a value of StartDominantLanguageDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobName:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_jobName - An identifier for the job.
$sel:vpcConfig:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_vpcConfig - 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.
$sel:volumeKmsKeyId:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:clientRequestToken:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_clientRequestToken - A unique identifier for the request. If you do not set the client
request token, Amazon Comprehend generates one.
$sel:tags:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_tags - 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.
$sel:inputDataConfig:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.
$sel:outputDataConfig:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_outputDataConfig - Specifies where to send the output files.
$sel:dataAccessRoleArn:StartDominantLanguageDetectionJob', startDominantLanguageDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that grants Amazon Comprehend read access to your input data.
For more information, see
https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
data StartDominantLanguageDetectionJobResponse Source #
See: newStartDominantLanguageDetectionJobResponse smart constructor.
Constructors
| StartDominantLanguageDetectionJobResponse' (Maybe Text) (Maybe Text) (Maybe JobStatus) Int |
Instances
newStartDominantLanguageDetectionJobResponse Source #
Arguments
| :: Int | |
| -> StartDominantLanguageDetectionJobResponse |
Create a value of StartDominantLanguageDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartDominantLanguageDetectionJobResponse', startDominantLanguageDetectionJobResponse_jobId - The identifier generated for the job. To get the status of a job, use
this identifier with the operation.
$sel:jobArn:StartDominantLanguageDetectionJobResponse', startDominantLanguageDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the dominant language detection job.
It is a unique, fully qualified identifier for the job. It includes the
AWS account, Region, and the job ID. The format of the ARN is as
follows:
arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobStatus:StartDominantLanguageDetectionJobResponse', startDominantLanguageDetectionJobResponse_jobStatus - 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.
$sel:httpStatus:StartDominantLanguageDetectionJobResponse', startDominantLanguageDetectionJobResponse_httpStatus - The response's http status code.
StopTrainingDocumentClassifier
data StopTrainingDocumentClassifier Source #
See: newStopTrainingDocumentClassifier smart constructor.
Constructors
| StopTrainingDocumentClassifier' Text |
Instances
newStopTrainingDocumentClassifier Source #
Arguments
| :: Text | |
| -> StopTrainingDocumentClassifier |
Create a value of StopTrainingDocumentClassifier with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:documentClassifierArn:StopTrainingDocumentClassifier', stopTrainingDocumentClassifier_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier
currently being trained.
data StopTrainingDocumentClassifierResponse Source #
See: newStopTrainingDocumentClassifierResponse smart constructor.
Constructors
| StopTrainingDocumentClassifierResponse' Int |
Instances
newStopTrainingDocumentClassifierResponse Source #
Arguments
| :: Int | |
| -> StopTrainingDocumentClassifierResponse |
Create a value of StopTrainingDocumentClassifierResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StopTrainingDocumentClassifierResponse', stopTrainingDocumentClassifierResponse_httpStatus - The response's http status code.
DescribeDocumentClassificationJob
data DescribeDocumentClassificationJob Source #
See: newDescribeDocumentClassificationJob smart constructor.
Constructors
| DescribeDocumentClassificationJob' Text |
Instances
newDescribeDocumentClassificationJob Source #
Create a value of DescribeDocumentClassificationJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:DescribeDocumentClassificationJob', describeDocumentClassificationJob_jobId - The identifier that Amazon Comprehend generated for the job. The
operation returns this identifier in its response.
data DescribeDocumentClassificationJobResponse Source #
See: newDescribeDocumentClassificationJobResponse smart constructor.
Constructors
| DescribeDocumentClassificationJobResponse' (Maybe DocumentClassificationJobProperties) Int |
Instances
newDescribeDocumentClassificationJobResponse Source #
Arguments
| :: Int | |
| -> DescribeDocumentClassificationJobResponse |
Create a value of DescribeDocumentClassificationJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:documentClassificationJobProperties:DescribeDocumentClassificationJobResponse', describeDocumentClassificationJobResponse_documentClassificationJobProperties - An object that describes the properties associated with the document
classification job.
$sel:httpStatus:DescribeDocumentClassificationJobResponse', describeDocumentClassificationJobResponse_httpStatus - The response's http status code.
ContainsPiiEntities
data ContainsPiiEntities Source #
See: newContainsPiiEntities smart constructor.
Constructors
| ContainsPiiEntities' Text LanguageCode |
Instances
newContainsPiiEntities Source #
Arguments
| :: Text | |
| -> LanguageCode | |
| -> ContainsPiiEntities |
Create a value of ContainsPiiEntities with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:ContainsPiiEntities', containsPiiEntities_text - Creates a new document classification request to analyze a single
document in real-time, returning personally identifiable information
(PII) entity labels.
$sel:languageCode:ContainsPiiEntities', containsPiiEntities_languageCode - The language of the input documents.
data ContainsPiiEntitiesResponse Source #
See: newContainsPiiEntitiesResponse smart constructor.
Constructors
| ContainsPiiEntitiesResponse' (Maybe [EntityLabel]) Int |
Instances
newContainsPiiEntitiesResponse Source #
Create a value of ContainsPiiEntitiesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:labels:ContainsPiiEntitiesResponse', containsPiiEntitiesResponse_labels - The labels used in the document being analyzed. Individual labels
represent personally identifiable information (PII) entity types.
$sel:httpStatus:ContainsPiiEntitiesResponse', containsPiiEntitiesResponse_httpStatus - The response's http status code.
ListEventsDetectionJobs
data ListEventsDetectionJobs Source #
See: newListEventsDetectionJobs smart constructor.
Constructors
| ListEventsDetectionJobs' (Maybe Text) (Maybe EventsDetectionJobFilter) (Maybe Natural) |
Instances
newListEventsDetectionJobs :: ListEventsDetectionJobs Source #
Create a value of ListEventsDetectionJobs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListEventsDetectionJobs', listEventsDetectionJobs_nextToken - Identifies the next page of results to return.
$sel:filter':ListEventsDetectionJobs', listEventsDetectionJobs_filter - 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.
$sel:maxResults:ListEventsDetectionJobs', listEventsDetectionJobs_maxResults - The maximum number of results to return in each page.
data ListEventsDetectionJobsResponse Source #
See: newListEventsDetectionJobsResponse smart constructor.
Constructors
| ListEventsDetectionJobsResponse' (Maybe [EventsDetectionJobProperties]) (Maybe Text) Int |
Instances
newListEventsDetectionJobsResponse Source #
Create a value of ListEventsDetectionJobsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventsDetectionJobPropertiesList:ListEventsDetectionJobsResponse', listEventsDetectionJobsResponse_eventsDetectionJobPropertiesList - A list containing the properties of each job that is returned.
$sel:nextToken:ListEventsDetectionJobs', listEventsDetectionJobsResponse_nextToken - Identifies the next page of results to return.
$sel:httpStatus:ListEventsDetectionJobsResponse', listEventsDetectionJobsResponse_httpStatus - The response's http status code.
BatchDetectEntities
data BatchDetectEntities Source #
See: newBatchDetectEntities smart constructor.
Constructors
| BatchDetectEntities' (Sensitive [Sensitive Text]) LanguageCode |
Instances
newBatchDetectEntities Source #
Create a value of BatchDetectEntities with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:textList:BatchDetectEntities', batchDetectEntities_textList - A list containing the text of the input documents. The list can contain
a maximum of 25 documents. Each document must contain fewer than 5,000
bytes of UTF-8 encoded characters.
$sel:languageCode:BatchDetectEntities', batchDetectEntities_languageCode - 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.
data BatchDetectEntitiesResponse Source #
See: newBatchDetectEntitiesResponse smart constructor.
Constructors
| BatchDetectEntitiesResponse' Int [BatchDetectEntitiesItemResult] [BatchItemError] |
Instances
newBatchDetectEntitiesResponse Source #
Create a value of BatchDetectEntitiesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:BatchDetectEntitiesResponse', batchDetectEntitiesResponse_httpStatus - The response's http status code.
$sel:resultList:BatchDetectEntitiesResponse', batchDetectEntitiesResponse_resultList - 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.
$sel:errorList:BatchDetectEntitiesResponse', batchDetectEntitiesResponse_errorList - 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.
CreateEntityRecognizer
data CreateEntityRecognizer Source #
See: newCreateEntityRecognizer smart constructor.
Constructors
| CreateEntityRecognizer' (Maybe Text) (Maybe Text) (Maybe VpcConfig) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text EntityRecognizerInputDataConfig LanguageCode |
Instances
newCreateEntityRecognizer Source #
Arguments
| :: Text | |
| -> Text | |
| -> EntityRecognizerInputDataConfig | |
| -> LanguageCode | |
| -> CreateEntityRecognizer |
Create a value of CreateEntityRecognizer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:versionName:CreateEntityRecognizer', createEntityRecognizer_versionName - 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.
$sel:modelKmsKeyId:CreateEntityRecognizer', createEntityRecognizer_modelKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt trained custom models. The ModelKmsKeyId can be either
of the following formats
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:vpcConfig:CreateEntityRecognizer', createEntityRecognizer_vpcConfig - 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.
$sel:volumeKmsKeyId:CreateEntityRecognizer', createEntityRecognizer_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:clientRequestToken:CreateEntityRecognizer', createEntityRecognizer_clientRequestToken - A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
$sel:tags:CreateEntityRecognizer', createEntityRecognizer_tags - 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.
$sel:recognizerName:CreateEntityRecognizer', createEntityRecognizer_recognizerName - 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.
$sel:dataAccessRoleArn:CreateEntityRecognizer', createEntityRecognizer_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM)
role that grants Amazon Comprehend read access to your input data.
$sel:inputDataConfig:CreateEntityRecognizer', createEntityRecognizer_inputDataConfig - 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.
$sel:languageCode:CreateEntityRecognizer', createEntityRecognizer_languageCode - You can specify any of the following languages supported by Amazon
Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian
("it"), German ("de"), or Portuguese ("pt"). All documents must be
in the same language.
data CreateEntityRecognizerResponse Source #
See: newCreateEntityRecognizerResponse smart constructor.
Constructors
| CreateEntityRecognizerResponse' (Maybe Text) Int |
Instances
newCreateEntityRecognizerResponse Source #
Create a value of CreateEntityRecognizerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entityRecognizerArn:CreateEntityRecognizerResponse', createEntityRecognizerResponse_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.
$sel:httpStatus:CreateEntityRecognizerResponse', createEntityRecognizerResponse_httpStatus - The response's http status code.
StopKeyPhrasesDetectionJob
data StopKeyPhrasesDetectionJob Source #
See: newStopKeyPhrasesDetectionJob smart constructor.
Constructors
| StopKeyPhrasesDetectionJob' Text |
Instances
newStopKeyPhrasesDetectionJob Source #
Create a value of StopKeyPhrasesDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopKeyPhrasesDetectionJob', stopKeyPhrasesDetectionJob_jobId - The identifier of the key phrases detection job to stop.
data StopKeyPhrasesDetectionJobResponse Source #
See: newStopKeyPhrasesDetectionJobResponse smart constructor.
Instances
newStopKeyPhrasesDetectionJobResponse Source #
Arguments
| :: Int | |
| -> StopKeyPhrasesDetectionJobResponse |
Create a value of StopKeyPhrasesDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopKeyPhrasesDetectionJob', stopKeyPhrasesDetectionJobResponse_jobId - The identifier of the key phrases detection job to stop.
$sel:jobStatus:StopKeyPhrasesDetectionJobResponse', stopKeyPhrasesDetectionJobResponse_jobStatus - Either STOP_REQUESTED if the job is currently running, or STOPPED if
the job was previously stopped with the StopKeyPhrasesDetectionJob
operation.
$sel:httpStatus:StopKeyPhrasesDetectionJobResponse', stopKeyPhrasesDetectionJobResponse_httpStatus - The response's http status code.
CreateDocumentClassifier
data CreateDocumentClassifier Source #
See: newCreateDocumentClassifier smart constructor.
Constructors
Instances
newCreateDocumentClassifier Source #
Arguments
| :: Text | |
| -> Text | |
| -> DocumentClassifierInputDataConfig | |
| -> LanguageCode | |
| -> CreateDocumentClassifier |
Create a value of CreateDocumentClassifier with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:versionName:CreateDocumentClassifier', createDocumentClassifier_versionName - 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.
$sel:modelKmsKeyId:CreateDocumentClassifier', createDocumentClassifier_modelKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt trained custom models. The ModelKmsKeyId can be either
of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:mode:CreateDocumentClassifier', createDocumentClassifier_mode - 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 (|).
$sel:vpcConfig:CreateDocumentClassifier', createDocumentClassifier_vpcConfig - 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.
$sel:volumeKmsKeyId:CreateDocumentClassifier', createDocumentClassifier_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:outputDataConfig:CreateDocumentClassifier', createDocumentClassifier_outputDataConfig - Enables the addition of output results configuration parameters for
custom classifier jobs.
$sel:clientRequestToken:CreateDocumentClassifier', createDocumentClassifier_clientRequestToken - A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
$sel:tags:CreateDocumentClassifier', createDocumentClassifier_tags - 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.
$sel:documentClassifierName:CreateDocumentClassifier', createDocumentClassifier_documentClassifierName - The name of the document classifier.
$sel:dataAccessRoleArn:CreateDocumentClassifier', createDocumentClassifier_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM)
role that grants Amazon Comprehend read access to your input data.
$sel:inputDataConfig:CreateDocumentClassifier', createDocumentClassifier_inputDataConfig - Specifies the format and location of the input data for the job.
$sel:languageCode:CreateDocumentClassifier', createDocumentClassifier_languageCode - 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.
data CreateDocumentClassifierResponse Source #
See: newCreateDocumentClassifierResponse smart constructor.
Constructors
| CreateDocumentClassifierResponse' (Maybe Text) Int |
Instances
newCreateDocumentClassifierResponse Source #
Create a value of CreateDocumentClassifierResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:documentClassifierArn:CreateDocumentClassifierResponse', createDocumentClassifierResponse_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.
$sel:httpStatus:CreateDocumentClassifierResponse', createDocumentClassifierResponse_httpStatus - The response's http status code.
ListPiiEntitiesDetectionJobs
data ListPiiEntitiesDetectionJobs Source #
See: newListPiiEntitiesDetectionJobs smart constructor.
Constructors
| ListPiiEntitiesDetectionJobs' (Maybe Text) (Maybe PiiEntitiesDetectionJobFilter) (Maybe Natural) |
Instances
newListPiiEntitiesDetectionJobs :: ListPiiEntitiesDetectionJobs Source #
Create a value of ListPiiEntitiesDetectionJobs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListPiiEntitiesDetectionJobs', listPiiEntitiesDetectionJobs_nextToken - Identifies the next page of results to return.
$sel:filter':ListPiiEntitiesDetectionJobs', listPiiEntitiesDetectionJobs_filter - 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.
$sel:maxResults:ListPiiEntitiesDetectionJobs', listPiiEntitiesDetectionJobs_maxResults - The maximum number of results to return in each page.
data ListPiiEntitiesDetectionJobsResponse Source #
See: newListPiiEntitiesDetectionJobsResponse smart constructor.
Constructors
| ListPiiEntitiesDetectionJobsResponse' (Maybe Text) (Maybe [PiiEntitiesDetectionJobProperties]) Int |
Instances
newListPiiEntitiesDetectionJobsResponse Source #
Arguments
| :: Int | |
| -> ListPiiEntitiesDetectionJobsResponse |
Create a value of ListPiiEntitiesDetectionJobsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListPiiEntitiesDetectionJobs', listPiiEntitiesDetectionJobsResponse_nextToken - Identifies the next page of results to return.
$sel:piiEntitiesDetectionJobPropertiesList:ListPiiEntitiesDetectionJobsResponse', listPiiEntitiesDetectionJobsResponse_piiEntitiesDetectionJobPropertiesList - A list containing the properties of each job that is returned.
$sel:httpStatus:ListPiiEntitiesDetectionJobsResponse', listPiiEntitiesDetectionJobsResponse_httpStatus - The response's http status code.
ListEntityRecognizers (Paginated)
data ListEntityRecognizers Source #
See: newListEntityRecognizers smart constructor.
Constructors
| ListEntityRecognizers' (Maybe Text) (Maybe EntityRecognizerFilter) (Maybe Natural) |
Instances
newListEntityRecognizers :: ListEntityRecognizers Source #
Create a value of ListEntityRecognizers with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListEntityRecognizers', listEntityRecognizers_nextToken - Identifies the next page of results to return.
$sel:filter':ListEntityRecognizers', listEntityRecognizers_filter - Filters the list of entities returned. You can filter on Status,
SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at
a time.
$sel:maxResults:ListEntityRecognizers', listEntityRecognizers_maxResults - The maximum number of results to return on each page. The default is
100.
data ListEntityRecognizersResponse Source #
See: newListEntityRecognizersResponse smart constructor.
Constructors
| ListEntityRecognizersResponse' (Maybe Text) (Maybe [EntityRecognizerProperties]) Int |
Instances
newListEntityRecognizersResponse Source #
Create a value of ListEntityRecognizersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListEntityRecognizers', listEntityRecognizersResponse_nextToken - Identifies the next page of results to return.
$sel:entityRecognizerPropertiesList:ListEntityRecognizersResponse', listEntityRecognizersResponse_entityRecognizerPropertiesList - The list of properties of an entity recognizer.
$sel:httpStatus:ListEntityRecognizersResponse', listEntityRecognizersResponse_httpStatus - The response's http status code.
StopSentimentDetectionJob
data StopSentimentDetectionJob Source #
See: newStopSentimentDetectionJob smart constructor.
Constructors
| StopSentimentDetectionJob' Text |
Instances
newStopSentimentDetectionJob Source #
Create a value of StopSentimentDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopSentimentDetectionJob', stopSentimentDetectionJob_jobId - The identifier of the sentiment detection job to stop.
data StopSentimentDetectionJobResponse Source #
See: newStopSentimentDetectionJobResponse smart constructor.
Instances
newStopSentimentDetectionJobResponse Source #
Arguments
| :: Int | |
| -> StopSentimentDetectionJobResponse |
Create a value of StopSentimentDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopSentimentDetectionJob', stopSentimentDetectionJobResponse_jobId - The identifier of the sentiment detection job to stop.
$sel:jobStatus:StopSentimentDetectionJobResponse', stopSentimentDetectionJobResponse_jobStatus - Either STOP_REQUESTED if the job is currently running, or STOPPED if
the job was previously stopped with the StopSentimentDetectionJob
operation.
$sel:httpStatus:StopSentimentDetectionJobResponse', stopSentimentDetectionJobResponse_httpStatus - The response's http status code.
DetectDominantLanguage
data DetectDominantLanguage Source #
See: newDetectDominantLanguage smart constructor.
Constructors
| DetectDominantLanguage' (Sensitive Text) |
Instances
newDetectDominantLanguage Source #
Arguments
| :: Text | |
| -> DetectDominantLanguage |
Create a value of DetectDominantLanguage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:DetectDominantLanguage', detectDominantLanguage_text - A UTF-8 text string. Each string should contain at least 20 characters
and must contain fewer that 5,000 bytes of UTF-8 encoded characters.
data DetectDominantLanguageResponse Source #
See: newDetectDominantLanguageResponse smart constructor.
Constructors
| DetectDominantLanguageResponse' (Maybe [DominantLanguage]) Int |
Instances
newDetectDominantLanguageResponse Source #
Create a value of DetectDominantLanguageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:languages:DetectDominantLanguageResponse', detectDominantLanguageResponse_languages - 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.
$sel:httpStatus:DetectDominantLanguageResponse', detectDominantLanguageResponse_httpStatus - The response's http status code.
ClassifyDocument
data ClassifyDocument Source #
See: newClassifyDocument smart constructor.
Constructors
| ClassifyDocument' (Sensitive Text) Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ClassifyDocument |
Create a value of ClassifyDocument with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:ClassifyDocument', classifyDocument_text - The document text to be analyzed.
$sel:endpointArn:ClassifyDocument', classifyDocument_endpointArn - The Amazon Resource Number (ARN) of the endpoint.
data ClassifyDocumentResponse Source #
See: newClassifyDocumentResponse smart constructor.
Constructors
| ClassifyDocumentResponse' (Maybe [DocumentLabel]) (Maybe [DocumentClass]) Int |
Instances
newClassifyDocumentResponse Source #
Create a value of ClassifyDocumentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:labels:ClassifyDocumentResponse', classifyDocumentResponse_labels - 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.
$sel:classes:ClassifyDocumentResponse', classifyDocumentResponse_classes - 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.
$sel:httpStatus:ClassifyDocumentResponse', classifyDocumentResponse_httpStatus - The response's http status code.
StartEventsDetectionJob
data StartEventsDetectionJob Source #
See: newStartEventsDetectionJob smart constructor.
Constructors
| StartEventsDetectionJob' (Maybe Text) (Maybe Text) (Maybe [Tag]) InputDataConfig OutputDataConfig Text LanguageCode (NonEmpty Text) |
Instances
newStartEventsDetectionJob Source #
Arguments
| :: InputDataConfig | |
| -> OutputDataConfig | |
| -> Text | |
| -> LanguageCode | |
| -> NonEmpty Text | |
| -> StartEventsDetectionJob |
Create a value of StartEventsDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobName:StartEventsDetectionJob', startEventsDetectionJob_jobName - The identifier of the events detection job.
$sel:clientRequestToken:StartEventsDetectionJob', startEventsDetectionJob_clientRequestToken - An unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
$sel:tags:StartEventsDetectionJob', startEventsDetectionJob_tags - 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.
$sel:inputDataConfig:StartEventsDetectionJob', startEventsDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.
$sel:outputDataConfig:StartEventsDetectionJob', startEventsDetectionJob_outputDataConfig - Specifies where to send the output files.
$sel:dataAccessRoleArn:StartEventsDetectionJob', startEventsDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that grants Amazon Comprehend read access to your input data.
$sel:languageCode:StartEventsDetectionJob', startEventsDetectionJob_languageCode - The language code of the input documents.
$sel:targetEventTypes:StartEventsDetectionJob', startEventsDetectionJob_targetEventTypes - The types of events to detect in the input documents.
data StartEventsDetectionJobResponse Source #
See: newStartEventsDetectionJobResponse smart constructor.
Instances
newStartEventsDetectionJobResponse Source #
Create a value of StartEventsDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartEventsDetectionJobResponse', startEventsDetectionJobResponse_jobId - An unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
$sel:jobArn:StartEventsDetectionJobResponse', startEventsDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the events detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobStatus:StartEventsDetectionJobResponse', startEventsDetectionJobResponse_jobStatus - The status of the events detection job.
$sel:httpStatus:StartEventsDetectionJobResponse', startEventsDetectionJobResponse_httpStatus - The response's http status code.
DescribeTopicsDetectionJob
data DescribeTopicsDetectionJob Source #
See: newDescribeTopicsDetectionJob smart constructor.
Constructors
| DescribeTopicsDetectionJob' Text |
Instances
newDescribeTopicsDetectionJob Source #
Create a value of DescribeTopicsDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:DescribeTopicsDetectionJob', describeTopicsDetectionJob_jobId - The identifier assigned by the user to the detection job.
data DescribeTopicsDetectionJobResponse Source #
See: newDescribeTopicsDetectionJobResponse smart constructor.
Instances
newDescribeTopicsDetectionJobResponse Source #
Arguments
| :: Int | |
| -> DescribeTopicsDetectionJobResponse |
Create a value of DescribeTopicsDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:topicsDetectionJobProperties:DescribeTopicsDetectionJobResponse', describeTopicsDetectionJobResponse_topicsDetectionJobProperties - The list of properties for the requested job.
$sel:httpStatus:DescribeTopicsDetectionJobResponse', describeTopicsDetectionJobResponse_httpStatus - The response's http status code.
ListDocumentClassificationJobs (Paginated)
data ListDocumentClassificationJobs Source #
See: newListDocumentClassificationJobs smart constructor.
Constructors
| ListDocumentClassificationJobs' (Maybe Text) (Maybe DocumentClassificationJobFilter) (Maybe Natural) |
Instances
newListDocumentClassificationJobs :: ListDocumentClassificationJobs Source #
Create a value of ListDocumentClassificationJobs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDocumentClassificationJobs', listDocumentClassificationJobs_nextToken - Identifies the next page of results to return.
$sel:filter':ListDocumentClassificationJobs', listDocumentClassificationJobs_filter - 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.
$sel:maxResults:ListDocumentClassificationJobs', listDocumentClassificationJobs_maxResults - The maximum number of results to return in each page. The default is
100.
data ListDocumentClassificationJobsResponse Source #
See: newListDocumentClassificationJobsResponse smart constructor.
Constructors
| ListDocumentClassificationJobsResponse' (Maybe Text) (Maybe [DocumentClassificationJobProperties]) Int |
Instances
newListDocumentClassificationJobsResponse Source #
Arguments
| :: Int | |
| -> ListDocumentClassificationJobsResponse |
Create a value of ListDocumentClassificationJobsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDocumentClassificationJobs', listDocumentClassificationJobsResponse_nextToken - Identifies the next page of results to return.
$sel:documentClassificationJobPropertiesList:ListDocumentClassificationJobsResponse', listDocumentClassificationJobsResponse_documentClassificationJobPropertiesList - A list containing the properties of each job returned.
$sel:httpStatus:ListDocumentClassificationJobsResponse', listDocumentClassificationJobsResponse_httpStatus - The response's http status code.
DetectPiiEntities
data DetectPiiEntities Source #
See: newDetectPiiEntities smart constructor.
Constructors
| DetectPiiEntities' Text LanguageCode |
Instances
Arguments
| :: Text | |
| -> LanguageCode | |
| -> DetectPiiEntities |
Create a value of DetectPiiEntities with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:DetectPiiEntities', detectPiiEntities_text - A UTF-8 text string. Each string must contain fewer that 5,000 bytes of
UTF-8 encoded characters.
$sel:languageCode:DetectPiiEntities', detectPiiEntities_languageCode - The language of the input documents.
data DetectPiiEntitiesResponse Source #
See: newDetectPiiEntitiesResponse smart constructor.
Constructors
| DetectPiiEntitiesResponse' (Maybe [PiiEntity]) Int |
Instances
newDetectPiiEntitiesResponse Source #
Create a value of DetectPiiEntitiesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entities:DetectPiiEntitiesResponse', detectPiiEntitiesResponse_entities - 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.
$sel:httpStatus:DetectPiiEntitiesResponse', detectPiiEntitiesResponse_httpStatus - The response's http status code.
ListEndpoints
data ListEndpoints Source #
See: newListEndpoints smart constructor.
Constructors
| ListEndpoints' (Maybe Text) (Maybe EndpointFilter) (Maybe Natural) |
Instances
newListEndpoints :: ListEndpoints Source #
Create a value of ListEndpoints with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListEndpoints', listEndpoints_nextToken - Identifies the next page of results to return.
$sel:filter':ListEndpoints', listEndpoints_filter - 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.
$sel:maxResults:ListEndpoints', listEndpoints_maxResults - The maximum number of results to return in each page. The default is
100.
data ListEndpointsResponse Source #
See: newListEndpointsResponse smart constructor.
Constructors
| ListEndpointsResponse' (Maybe [EndpointProperties]) (Maybe Text) Int |
Instances
newListEndpointsResponse Source #
Create a value of ListEndpointsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointPropertiesList:ListEndpointsResponse', listEndpointsResponse_endpointPropertiesList - Displays a list of endpoint properties being retrieved by the service in
response to the request.
$sel:nextToken:ListEndpoints', listEndpointsResponse_nextToken - Identifies the next page of results to return.
$sel:httpStatus:ListEndpointsResponse', listEndpointsResponse_httpStatus - The response's http status code.
DetectEntities
data DetectEntities Source #
See: newDetectEntities smart constructor.
Constructors
| DetectEntities' (Maybe LanguageCode) (Maybe Text) (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> DetectEntities |
Create a value of DetectEntities with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:languageCode:DetectEntities', detectEntities_languageCode - 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.
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.
$sel:endpointArn:DetectEntities', detectEntities_endpointArn - 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.
$sel:text:DetectEntities', detectEntities_text - A UTF-8 text string. Each string must contain fewer that 5,000 bytes of
UTF-8 encoded characters.
data DetectEntitiesResponse Source #
See: newDetectEntitiesResponse smart constructor.
Constructors
| DetectEntitiesResponse' (Maybe [Entity]) Int |
Instances
newDetectEntitiesResponse Source #
Create a value of DetectEntitiesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entities:DetectEntitiesResponse', detectEntitiesResponse_entities - 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 how-entities.
$sel:httpStatus:DetectEntitiesResponse', detectEntitiesResponse_httpStatus - The response's http status code.
DescribeDocumentClassifier
data DescribeDocumentClassifier Source #
See: newDescribeDocumentClassifier smart constructor.
Constructors
| DescribeDocumentClassifier' Text |
Instances
newDescribeDocumentClassifier Source #
Create a value of DescribeDocumentClassifier with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:documentClassifierArn:DescribeDocumentClassifier', describeDocumentClassifier_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.
The operation returns this identifier in its response.
data DescribeDocumentClassifierResponse Source #
See: newDescribeDocumentClassifierResponse smart constructor.
Instances
newDescribeDocumentClassifierResponse Source #
Arguments
| :: Int | |
| -> DescribeDocumentClassifierResponse |
Create a value of DescribeDocumentClassifierResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:documentClassifierProperties:DescribeDocumentClassifierResponse', describeDocumentClassifierResponse_documentClassifierProperties - An object that contains the properties associated with a document
classifier.
$sel:httpStatus:DescribeDocumentClassifierResponse', describeDocumentClassifierResponse_httpStatus - The response's http status code.
DescribeDominantLanguageDetectionJob
data DescribeDominantLanguageDetectionJob Source #
See: newDescribeDominantLanguageDetectionJob smart constructor.
Constructors
| DescribeDominantLanguageDetectionJob' Text |
Instances
newDescribeDominantLanguageDetectionJob Source #
Arguments
| :: Text | |
| -> DescribeDominantLanguageDetectionJob |
Create a value of DescribeDominantLanguageDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:DescribeDominantLanguageDetectionJob', describeDominantLanguageDetectionJob_jobId - The identifier that Amazon Comprehend generated for the job. The
operation returns this identifier in its response.
data DescribeDominantLanguageDetectionJobResponse Source #
See: newDescribeDominantLanguageDetectionJobResponse smart constructor.
Constructors
| DescribeDominantLanguageDetectionJobResponse' (Maybe DominantLanguageDetectionJobProperties) Int |
Instances
newDescribeDominantLanguageDetectionJobResponse Source #
Arguments
| :: Int |
|
| -> DescribeDominantLanguageDetectionJobResponse |
Create a value of DescribeDominantLanguageDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dominantLanguageDetectionJobProperties:DescribeDominantLanguageDetectionJobResponse', describeDominantLanguageDetectionJobResponse_dominantLanguageDetectionJobProperties - An object that contains the properties associated with a dominant
language detection job.
$sel:httpStatus:DescribeDominantLanguageDetectionJobResponse', describeDominantLanguageDetectionJobResponse_httpStatus - The response's http status code.
ListEntityRecognizerSummaries
data ListEntityRecognizerSummaries Source #
See: newListEntityRecognizerSummaries smart constructor.
Constructors
| ListEntityRecognizerSummaries' (Maybe Text) (Maybe Natural) |
Instances
newListEntityRecognizerSummaries :: ListEntityRecognizerSummaries Source #
Create a value of ListEntityRecognizerSummaries with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListEntityRecognizerSummaries', listEntityRecognizerSummaries_nextToken - Identifies the next page of results to return.
$sel:maxResults:ListEntityRecognizerSummaries', listEntityRecognizerSummaries_maxResults - The maximum number of results to return on each page. The default is
100.
data ListEntityRecognizerSummariesResponse Source #
See: newListEntityRecognizerSummariesResponse smart constructor.
Constructors
| ListEntityRecognizerSummariesResponse' (Maybe Text) (Maybe [EntityRecognizerSummary]) Int |
Instances
newListEntityRecognizerSummariesResponse Source #
Arguments
| :: Int | |
| -> ListEntityRecognizerSummariesResponse |
Create a value of ListEntityRecognizerSummariesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListEntityRecognizerSummaries', listEntityRecognizerSummariesResponse_nextToken - The list entity recognizer summaries.
$sel:entityRecognizerSummariesList:ListEntityRecognizerSummariesResponse', listEntityRecognizerSummariesResponse_entityRecognizerSummariesList - The list entity recognizer summaries.
$sel:httpStatus:ListEntityRecognizerSummariesResponse', listEntityRecognizerSummariesResponse_httpStatus - The response's http status code.
StopEntitiesDetectionJob
data StopEntitiesDetectionJob Source #
See: newStopEntitiesDetectionJob smart constructor.
Constructors
| StopEntitiesDetectionJob' Text |
Instances
newStopEntitiesDetectionJob Source #
Create a value of StopEntitiesDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopEntitiesDetectionJob', stopEntitiesDetectionJob_jobId - The identifier of the entities detection job to stop.
data StopEntitiesDetectionJobResponse Source #
See: newStopEntitiesDetectionJobResponse smart constructor.
Instances
newStopEntitiesDetectionJobResponse Source #
Create a value of StopEntitiesDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopEntitiesDetectionJob', stopEntitiesDetectionJobResponse_jobId - The identifier of the entities detection job to stop.
$sel:jobStatus:StopEntitiesDetectionJobResponse', stopEntitiesDetectionJobResponse_jobStatus - Either STOP_REQUESTED if the job is currently running, or STOPPED if
the job was previously stopped with the StopEntitiesDetectionJob
operation.
$sel:httpStatus:StopEntitiesDetectionJobResponse', stopEntitiesDetectionJobResponse_httpStatus - The response's http status code.
StopTrainingEntityRecognizer
data StopTrainingEntityRecognizer Source #
See: newStopTrainingEntityRecognizer smart constructor.
Constructors
| StopTrainingEntityRecognizer' Text |
Instances
newStopTrainingEntityRecognizer Source #
Arguments
| :: Text | |
| -> StopTrainingEntityRecognizer |
Create a value of StopTrainingEntityRecognizer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entityRecognizerArn:StopTrainingEntityRecognizer', stopTrainingEntityRecognizer_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer
currently being trained.
data StopTrainingEntityRecognizerResponse Source #
See: newStopTrainingEntityRecognizerResponse smart constructor.
Constructors
| StopTrainingEntityRecognizerResponse' Int |
Instances
newStopTrainingEntityRecognizerResponse Source #
Arguments
| :: Int | |
| -> StopTrainingEntityRecognizerResponse |
Create a value of StopTrainingEntityRecognizerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StopTrainingEntityRecognizerResponse', stopTrainingEntityRecognizerResponse_httpStatus - The response's http status code.
StartPiiEntitiesDetectionJob
data StartPiiEntitiesDetectionJob Source #
See: newStartPiiEntitiesDetectionJob smart constructor.
Constructors
| StartPiiEntitiesDetectionJob' (Maybe Text) (Maybe RedactionConfig) (Maybe Text) (Maybe [Tag]) InputDataConfig OutputDataConfig PiiEntitiesDetectionMode Text LanguageCode |
Instances
newStartPiiEntitiesDetectionJob Source #
Arguments
| :: InputDataConfig | |
| -> OutputDataConfig | |
| -> PiiEntitiesDetectionMode | |
| -> Text | |
| -> LanguageCode | |
| -> StartPiiEntitiesDetectionJob |
Create a value of StartPiiEntitiesDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobName:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_jobName - The identifier of the job.
$sel:redactionConfig:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_redactionConfig - Provides configuration parameters for PII entity redaction.
This parameter is required if you set the Mode parameter to
ONLY_REDACTION. In that case, you must provide a RedactionConfig
definition that includes the PiiEntityTypes parameter.
$sel:clientRequestToken:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_clientRequestToken - A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
$sel:tags:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_tags - 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.
$sel:inputDataConfig:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_inputDataConfig - The input properties for a PII entities detection job.
$sel:outputDataConfig:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_outputDataConfig - Provides configuration parameters for the output of PII entity detection
jobs.
$sel:mode:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_mode - Specifies whether the output provides the locations (offsets) of PII
entities or a file in which PII entities are redacted.
$sel:dataAccessRoleArn:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that grants Amazon Comprehend read access to your input data.
$sel:languageCode:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_languageCode - The language of the input documents.
data StartPiiEntitiesDetectionJobResponse Source #
See: newStartPiiEntitiesDetectionJobResponse smart constructor.
Instances
newStartPiiEntitiesDetectionJobResponse Source #
Arguments
| :: Int | |
| -> StartPiiEntitiesDetectionJobResponse |
Create a value of StartPiiEntitiesDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartPiiEntitiesDetectionJobResponse', startPiiEntitiesDetectionJobResponse_jobId - The identifier generated for the job.
$sel:jobArn:StartPiiEntitiesDetectionJobResponse', startPiiEntitiesDetectionJobResponse_jobArn - 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
$sel:jobStatus:StartPiiEntitiesDetectionJobResponse', startPiiEntitiesDetectionJobResponse_jobStatus - The status of the job.
$sel:httpStatus:StartPiiEntitiesDetectionJobResponse', startPiiEntitiesDetectionJobResponse_httpStatus - The response's http status code.
ListKeyPhrasesDetectionJobs (Paginated)
data ListKeyPhrasesDetectionJobs Source #
See: newListKeyPhrasesDetectionJobs smart constructor.
Constructors
| ListKeyPhrasesDetectionJobs' (Maybe Text) (Maybe KeyPhrasesDetectionJobFilter) (Maybe Natural) |
Instances
newListKeyPhrasesDetectionJobs :: ListKeyPhrasesDetectionJobs Source #
Create a value of ListKeyPhrasesDetectionJobs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListKeyPhrasesDetectionJobs', listKeyPhrasesDetectionJobs_nextToken - Identifies the next page of results to return.
$sel:filter':ListKeyPhrasesDetectionJobs', listKeyPhrasesDetectionJobs_filter - 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.
$sel:maxResults:ListKeyPhrasesDetectionJobs', listKeyPhrasesDetectionJobs_maxResults - The maximum number of results to return in each page. The default is
100.
data ListKeyPhrasesDetectionJobsResponse Source #
See: newListKeyPhrasesDetectionJobsResponse smart constructor.
Constructors
| ListKeyPhrasesDetectionJobsResponse' (Maybe [KeyPhrasesDetectionJobProperties]) (Maybe Text) Int |
Instances
newListKeyPhrasesDetectionJobsResponse Source #
Arguments
| :: Int | |
| -> ListKeyPhrasesDetectionJobsResponse |
Create a value of ListKeyPhrasesDetectionJobsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyPhrasesDetectionJobPropertiesList:ListKeyPhrasesDetectionJobsResponse', listKeyPhrasesDetectionJobsResponse_keyPhrasesDetectionJobPropertiesList - A list containing the properties of each job that is returned.
$sel:nextToken:ListKeyPhrasesDetectionJobs', listKeyPhrasesDetectionJobsResponse_nextToken - Identifies the next page of results to return.
$sel:httpStatus:ListKeyPhrasesDetectionJobsResponse', listKeyPhrasesDetectionJobsResponse_httpStatus - The response's http status code.
DescribeEntitiesDetectionJob
data DescribeEntitiesDetectionJob Source #
See: newDescribeEntitiesDetectionJob smart constructor.
Constructors
| DescribeEntitiesDetectionJob' Text |
Instances
newDescribeEntitiesDetectionJob Source #
Create a value of DescribeEntitiesDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:DescribeEntitiesDetectionJob', describeEntitiesDetectionJob_jobId - The identifier that Amazon Comprehend generated for the job. The
operation returns this identifier in its response.
data DescribeEntitiesDetectionJobResponse Source #
See: newDescribeEntitiesDetectionJobResponse smart constructor.
Instances
newDescribeEntitiesDetectionJobResponse Source #
Arguments
| :: Int | |
| -> DescribeEntitiesDetectionJobResponse |
Create a value of DescribeEntitiesDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entitiesDetectionJobProperties:DescribeEntitiesDetectionJobResponse', describeEntitiesDetectionJobResponse_entitiesDetectionJobProperties - An object that contains the properties associated with an entities
detection job.
$sel:httpStatus:DescribeEntitiesDetectionJobResponse', describeEntitiesDetectionJobResponse_httpStatus - The response's http status code.
ListDocumentClassifierSummaries
data ListDocumentClassifierSummaries Source #
See: newListDocumentClassifierSummaries smart constructor.
Constructors
| ListDocumentClassifierSummaries' (Maybe Text) (Maybe Natural) |
Instances
newListDocumentClassifierSummaries :: ListDocumentClassifierSummaries Source #
Create a value of ListDocumentClassifierSummaries with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDocumentClassifierSummaries', listDocumentClassifierSummaries_nextToken - Identifies the next page of results to return.
$sel:maxResults:ListDocumentClassifierSummaries', listDocumentClassifierSummaries_maxResults - The maximum number of results to return on each page. The default is
100.
data ListDocumentClassifierSummariesResponse Source #
See: newListDocumentClassifierSummariesResponse smart constructor.
Constructors
| ListDocumentClassifierSummariesResponse' (Maybe Text) (Maybe [DocumentClassifierSummary]) Int |
Instances
newListDocumentClassifierSummariesResponse Source #
Arguments
| :: Int | |
| -> ListDocumentClassifierSummariesResponse |
Create a value of ListDocumentClassifierSummariesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDocumentClassifierSummaries', listDocumentClassifierSummariesResponse_nextToken - Identifies the next page of results to return.
$sel:documentClassifierSummariesList:ListDocumentClassifierSummariesResponse', listDocumentClassifierSummariesResponse_documentClassifierSummariesList - The list of summaries of document classifiers.
$sel:httpStatus:ListDocumentClassifierSummariesResponse', listDocumentClassifierSummariesResponse_httpStatus - The response's http status code.
StopDominantLanguageDetectionJob
data StopDominantLanguageDetectionJob Source #
See: newStopDominantLanguageDetectionJob smart constructor.
Constructors
| StopDominantLanguageDetectionJob' Text |
Instances
newStopDominantLanguageDetectionJob Source #
Create a value of StopDominantLanguageDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopDominantLanguageDetectionJob', stopDominantLanguageDetectionJob_jobId - The identifier of the dominant language detection job to stop.
data StopDominantLanguageDetectionJobResponse Source #
See: newStopDominantLanguageDetectionJobResponse smart constructor.
Instances
newStopDominantLanguageDetectionJobResponse Source #
Arguments
| :: Int | |
| -> StopDominantLanguageDetectionJobResponse |
Create a value of StopDominantLanguageDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopDominantLanguageDetectionJob', stopDominantLanguageDetectionJobResponse_jobId - The identifier of the dominant language detection job to stop.
$sel:jobStatus:StopDominantLanguageDetectionJobResponse', stopDominantLanguageDetectionJobResponse_jobStatus - Either STOP_REQUESTED if the job is currently running, or STOPPED if
the job was previously stopped with the
StopDominantLanguageDetectionJob operation.
$sel:httpStatus:StopDominantLanguageDetectionJobResponse', stopDominantLanguageDetectionJobResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the given Amazon Comprehend resource
to which you want to associate the tags.
$sel:tags:TagResource', tagResource_tags - 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.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
DescribePiiEntitiesDetectionJob
data DescribePiiEntitiesDetectionJob Source #
See: newDescribePiiEntitiesDetectionJob smart constructor.
Constructors
| DescribePiiEntitiesDetectionJob' Text |
Instances
newDescribePiiEntitiesDetectionJob Source #
Create a value of DescribePiiEntitiesDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:DescribePiiEntitiesDetectionJob', describePiiEntitiesDetectionJob_jobId - The identifier that Amazon Comprehend generated for the job. The
operation returns this identifier in its response.
data DescribePiiEntitiesDetectionJobResponse Source #
See: newDescribePiiEntitiesDetectionJobResponse smart constructor.
Instances
newDescribePiiEntitiesDetectionJobResponse Source #
Arguments
| :: Int | |
| -> DescribePiiEntitiesDetectionJobResponse |
Create a value of DescribePiiEntitiesDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:piiEntitiesDetectionJobProperties:DescribePiiEntitiesDetectionJobResponse', describePiiEntitiesDetectionJobResponse_piiEntitiesDetectionJobProperties - Undocumented member.
$sel:httpStatus:DescribePiiEntitiesDetectionJobResponse', describePiiEntitiesDetectionJobResponse_httpStatus - The response's http status code.
ListTopicsDetectionJobs (Paginated)
data ListTopicsDetectionJobs Source #
See: newListTopicsDetectionJobs smart constructor.
Constructors
| ListTopicsDetectionJobs' (Maybe Text) (Maybe TopicsDetectionJobFilter) (Maybe Natural) |
Instances
newListTopicsDetectionJobs :: ListTopicsDetectionJobs Source #
Create a value of ListTopicsDetectionJobs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListTopicsDetectionJobs', listTopicsDetectionJobs_nextToken - Identifies the next page of results to return.
$sel:filter':ListTopicsDetectionJobs', listTopicsDetectionJobs_filter - 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.
$sel:maxResults:ListTopicsDetectionJobs', listTopicsDetectionJobs_maxResults - The maximum number of results to return in each page. The default is
100.
data ListTopicsDetectionJobsResponse Source #
See: newListTopicsDetectionJobsResponse smart constructor.
Constructors
| ListTopicsDetectionJobsResponse' (Maybe Text) (Maybe [TopicsDetectionJobProperties]) Int |
Instances
newListTopicsDetectionJobsResponse Source #
Create a value of ListTopicsDetectionJobsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListTopicsDetectionJobs', listTopicsDetectionJobsResponse_nextToken - Identifies the next page of results to return.
$sel:topicsDetectionJobPropertiesList:ListTopicsDetectionJobsResponse', listTopicsDetectionJobsResponse_topicsDetectionJobPropertiesList - A list containing the properties of each job that is returned.
$sel:httpStatus:ListTopicsDetectionJobsResponse', listTopicsDetectionJobsResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the given Amazon Comprehend resource
from which you want to remove the tags.
$sel:tagKeys:UntagResource', untagResource_tagKeys - 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.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
BatchDetectDominantLanguage
data BatchDetectDominantLanguage Source #
See: newBatchDetectDominantLanguage smart constructor.
Constructors
| BatchDetectDominantLanguage' (Sensitive [Sensitive Text]) |
Instances
newBatchDetectDominantLanguage :: BatchDetectDominantLanguage Source #
Create a value of BatchDetectDominantLanguage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:textList:BatchDetectDominantLanguage', batchDetectDominantLanguage_textList - A list containing the text of the input documents. The list can contain
a maximum of 25 documents. Each document should contain at least 20
characters and must contain fewer than 5,000 bytes of UTF-8 encoded
characters.
data BatchDetectDominantLanguageResponse Source #
See: newBatchDetectDominantLanguageResponse smart constructor.
Constructors
| BatchDetectDominantLanguageResponse' Int [BatchDetectDominantLanguageItemResult] [BatchItemError] |
Instances
newBatchDetectDominantLanguageResponse Source #
Arguments
| :: Int | |
| -> BatchDetectDominantLanguageResponse |
Create a value of BatchDetectDominantLanguageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:BatchDetectDominantLanguageResponse', batchDetectDominantLanguageResponse_httpStatus - The response's http status code.
$sel:resultList:BatchDetectDominantLanguageResponse', batchDetectDominantLanguageResponse_resultList - 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.
$sel:errorList:BatchDetectDominantLanguageResponse', batchDetectDominantLanguageResponse_errorList - 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.
StartDocumentClassificationJob
data StartDocumentClassificationJob Source #
See: newStartDocumentClassificationJob smart constructor.
Constructors
| StartDocumentClassificationJob' (Maybe Text) (Maybe VpcConfig) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text InputDataConfig OutputDataConfig Text |
Instances
newStartDocumentClassificationJob Source #
Arguments
| :: Text | |
| -> InputDataConfig | |
| -> OutputDataConfig | |
| -> Text | |
| -> StartDocumentClassificationJob |
Create a value of StartDocumentClassificationJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobName:StartDocumentClassificationJob', startDocumentClassificationJob_jobName - The identifier of the job.
$sel:vpcConfig:StartDocumentClassificationJob', startDocumentClassificationJob_vpcConfig - 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.
$sel:volumeKmsKeyId:StartDocumentClassificationJob', startDocumentClassificationJob_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:clientRequestToken:StartDocumentClassificationJob', startDocumentClassificationJob_clientRequestToken - A unique identifier for the request. If you do not set the client
request token, Amazon Comprehend generates one.
$sel:tags:StartDocumentClassificationJob', startDocumentClassificationJob_tags - 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.
$sel:documentClassifierArn:StartDocumentClassificationJob', startDocumentClassificationJob_documentClassifierArn - The Amazon Resource Name (ARN) of the document classifier to use to
process the job.
$sel:inputDataConfig:StartDocumentClassificationJob', startDocumentClassificationJob_inputDataConfig - Specifies the format and location of the input data for the job.
$sel:outputDataConfig:StartDocumentClassificationJob', startDocumentClassificationJob_outputDataConfig - Specifies where to send the output files.
$sel:dataAccessRoleArn:StartDocumentClassificationJob', startDocumentClassificationJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that grants Amazon Comprehend read access to your input data.
data StartDocumentClassificationJobResponse Source #
See: newStartDocumentClassificationJobResponse smart constructor.
Instances
newStartDocumentClassificationJobResponse Source #
Arguments
| :: Int | |
| -> StartDocumentClassificationJobResponse |
Create a value of StartDocumentClassificationJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartDocumentClassificationJobResponse', startDocumentClassificationJobResponse_jobId - The identifier generated for the job. To get the status of the job, use
this identifier with the operation.
$sel:jobArn:StartDocumentClassificationJobResponse', startDocumentClassificationJobResponse_jobArn - The Amazon Resource Name (ARN) of the document classification job. It is
a unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobStatus:StartDocumentClassificationJobResponse', startDocumentClassificationJobResponse_jobStatus - 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.
$sel:httpStatus:StartDocumentClassificationJobResponse', startDocumentClassificationJobResponse_httpStatus - The response's http status code.
DetectKeyPhrases
data DetectKeyPhrases Source #
See: newDetectKeyPhrases smart constructor.
Constructors
| DetectKeyPhrases' (Sensitive Text) LanguageCode |
Instances
Arguments
| :: Text | |
| -> LanguageCode | |
| -> DetectKeyPhrases |
Create a value of DetectKeyPhrases with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:DetectKeyPhrases', detectKeyPhrases_text - A UTF-8 text string. Each string must contain fewer that 5,000 bytes of
UTF-8 encoded characters.
$sel:languageCode:DetectKeyPhrases', detectKeyPhrases_languageCode - 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.
data DetectKeyPhrasesResponse Source #
See: newDetectKeyPhrasesResponse smart constructor.
Constructors
| DetectKeyPhrasesResponse' (Maybe [KeyPhrase]) Int |
Instances
newDetectKeyPhrasesResponse Source #
Create a value of DetectKeyPhrasesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyPhrases:DetectKeyPhrasesResponse', detectKeyPhrasesResponse_keyPhrases - 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.
$sel:httpStatus:DetectKeyPhrasesResponse', detectKeyPhrasesResponse_httpStatus - The response's http status code.
DetectSyntax
data DetectSyntax Source #
See: newDetectSyntax smart constructor.
Constructors
| DetectSyntax' (Sensitive Text) SyntaxLanguageCode |
Instances
Arguments
| :: Text | |
| -> SyntaxLanguageCode | |
| -> DetectSyntax |
Create a value of DetectSyntax with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:DetectSyntax', detectSyntax_text - A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF
encoded characters.
$sel:languageCode:DetectSyntax', detectSyntax_languageCode - 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").
data DetectSyntaxResponse Source #
See: newDetectSyntaxResponse smart constructor.
Constructors
| DetectSyntaxResponse' (Maybe [SyntaxToken]) Int |
Instances
newDetectSyntaxResponse Source #
Arguments
| :: Int | |
| -> DetectSyntaxResponse |
Create a value of DetectSyntaxResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:syntaxTokens:DetectSyntaxResponse', detectSyntaxResponse_syntaxTokens - 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 how-syntax.
$sel:httpStatus:DetectSyntaxResponse', detectSyntaxResponse_httpStatus - The response's http status code.
DescribeEndpoint
data DescribeEndpoint Source #
See: newDescribeEndpoint smart constructor.
Constructors
| DescribeEndpoint' Text |
Instances
Arguments
| :: Text | |
| -> DescribeEndpoint |
Create a value of DescribeEndpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointArn:DescribeEndpoint', describeEndpoint_endpointArn - The Amazon Resource Number (ARN) of the endpoint being described.
data DescribeEndpointResponse Source #
See: newDescribeEndpointResponse smart constructor.
Constructors
| DescribeEndpointResponse' (Maybe EndpointProperties) Int |
Instances
newDescribeEndpointResponse Source #
Create a value of DescribeEndpointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointProperties:DescribeEndpointResponse', describeEndpointResponse_endpointProperties - Describes information associated with the specific endpoint.
$sel:httpStatus:DescribeEndpointResponse', describeEndpointResponse_httpStatus - The response's http status code.
ListSentimentDetectionJobs (Paginated)
data ListSentimentDetectionJobs Source #
See: newListSentimentDetectionJobs smart constructor.
Constructors
| ListSentimentDetectionJobs' (Maybe Text) (Maybe SentimentDetectionJobFilter) (Maybe Natural) |
Instances
newListSentimentDetectionJobs :: ListSentimentDetectionJobs Source #
Create a value of ListSentimentDetectionJobs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListSentimentDetectionJobs', listSentimentDetectionJobs_nextToken - Identifies the next page of results to return.
$sel:filter':ListSentimentDetectionJobs', listSentimentDetectionJobs_filter - 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.
$sel:maxResults:ListSentimentDetectionJobs', listSentimentDetectionJobs_maxResults - The maximum number of results to return in each page. The default is
100.
data ListSentimentDetectionJobsResponse Source #
See: newListSentimentDetectionJobsResponse smart constructor.
Constructors
| ListSentimentDetectionJobsResponse' (Maybe Text) (Maybe [SentimentDetectionJobProperties]) Int |
Instances
newListSentimentDetectionJobsResponse Source #
Arguments
| :: Int | |
| -> ListSentimentDetectionJobsResponse |
Create a value of ListSentimentDetectionJobsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListSentimentDetectionJobs', listSentimentDetectionJobsResponse_nextToken - Identifies the next page of results to return.
$sel:sentimentDetectionJobPropertiesList:ListSentimentDetectionJobsResponse', listSentimentDetectionJobsResponse_sentimentDetectionJobPropertiesList - A list containing the properties of each job that is returned.
$sel:httpStatus:ListSentimentDetectionJobsResponse', listSentimentDetectionJobsResponse_httpStatus - The response's http status code.
DeleteDocumentClassifier
data DeleteDocumentClassifier Source #
See: newDeleteDocumentClassifier smart constructor.
Constructors
| DeleteDocumentClassifier' Text |
Instances
newDeleteDocumentClassifier Source #
Create a value of DeleteDocumentClassifier with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:documentClassifierArn:DeleteDocumentClassifier', deleteDocumentClassifier_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.
data DeleteDocumentClassifierResponse Source #
See: newDeleteDocumentClassifierResponse smart constructor.
Constructors
| DeleteDocumentClassifierResponse' Int |
Instances
newDeleteDocumentClassifierResponse Source #
Create a value of DeleteDocumentClassifierResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteDocumentClassifierResponse', deleteDocumentClassifierResponse_httpStatus - The response's http status code.
ListDominantLanguageDetectionJobs (Paginated)
data ListDominantLanguageDetectionJobs Source #
See: newListDominantLanguageDetectionJobs smart constructor.
Constructors
| ListDominantLanguageDetectionJobs' (Maybe Text) (Maybe DominantLanguageDetectionJobFilter) (Maybe Natural) |
Instances
newListDominantLanguageDetectionJobs :: ListDominantLanguageDetectionJobs Source #
Create a value of ListDominantLanguageDetectionJobs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDominantLanguageDetectionJobs', listDominantLanguageDetectionJobs_nextToken - Identifies the next page of results to return.
$sel:filter':ListDominantLanguageDetectionJobs', listDominantLanguageDetectionJobs_filter - 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.
$sel:maxResults:ListDominantLanguageDetectionJobs', listDominantLanguageDetectionJobs_maxResults - The maximum number of results to return in each page. The default is
100.
data ListDominantLanguageDetectionJobsResponse Source #
See: newListDominantLanguageDetectionJobsResponse smart constructor.
Constructors
| ListDominantLanguageDetectionJobsResponse' (Maybe Text) (Maybe [DominantLanguageDetectionJobProperties]) Int |
Instances
newListDominantLanguageDetectionJobsResponse Source #
Arguments
| :: Int | |
| -> ListDominantLanguageDetectionJobsResponse |
Create a value of ListDominantLanguageDetectionJobsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDominantLanguageDetectionJobs', listDominantLanguageDetectionJobsResponse_nextToken - Identifies the next page of results to return.
$sel:dominantLanguageDetectionJobPropertiesList:ListDominantLanguageDetectionJobsResponse', listDominantLanguageDetectionJobsResponse_dominantLanguageDetectionJobPropertiesList - A list containing the properties of each job that is returned.
$sel:httpStatus:ListDominantLanguageDetectionJobsResponse', listDominantLanguageDetectionJobsResponse_httpStatus - The response's http status code.
StartKeyPhrasesDetectionJob
data StartKeyPhrasesDetectionJob Source #
See: newStartKeyPhrasesDetectionJob smart constructor.
Constructors
| StartKeyPhrasesDetectionJob' (Maybe Text) (Maybe VpcConfig) (Maybe Text) (Maybe Text) (Maybe [Tag]) InputDataConfig OutputDataConfig Text LanguageCode |
Instances
newStartKeyPhrasesDetectionJob Source #
Arguments
| :: InputDataConfig | |
| -> OutputDataConfig | |
| -> Text | |
| -> LanguageCode | |
| -> StartKeyPhrasesDetectionJob |
Create a value of StartKeyPhrasesDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobName:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_jobName - The identifier of the job.
$sel:vpcConfig:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_vpcConfig - 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.
$sel:volumeKmsKeyId:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:clientRequestToken:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_clientRequestToken - A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
$sel:tags:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_tags - 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.
$sel:inputDataConfig:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.
$sel:outputDataConfig:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_outputDataConfig - Specifies where to send the output files.
$sel:dataAccessRoleArn:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that grants Amazon Comprehend read access to your input data.
For more information, see
https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
$sel:languageCode:StartKeyPhrasesDetectionJob', startKeyPhrasesDetectionJob_languageCode - 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.
data StartKeyPhrasesDetectionJobResponse Source #
See: newStartKeyPhrasesDetectionJobResponse smart constructor.
Instances
newStartKeyPhrasesDetectionJobResponse Source #
Arguments
| :: Int | |
| -> StartKeyPhrasesDetectionJobResponse |
Create a value of StartKeyPhrasesDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartKeyPhrasesDetectionJobResponse', startKeyPhrasesDetectionJobResponse_jobId - The identifier generated for the job. To get the status of a job, use
this identifier with the operation.
$sel:jobArn:StartKeyPhrasesDetectionJobResponse', startKeyPhrasesDetectionJobResponse_jobArn - 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
$sel:jobStatus:StartKeyPhrasesDetectionJobResponse', startKeyPhrasesDetectionJobResponse_jobStatus - 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.
$sel:httpStatus:StartKeyPhrasesDetectionJobResponse', startKeyPhrasesDetectionJobResponse_httpStatus - The response's http status code.
ListDocumentClassifiers (Paginated)
data ListDocumentClassifiers Source #
See: newListDocumentClassifiers smart constructor.
Constructors
| ListDocumentClassifiers' (Maybe Text) (Maybe DocumentClassifierFilter) (Maybe Natural) |
Instances
newListDocumentClassifiers :: ListDocumentClassifiers Source #
Create a value of ListDocumentClassifiers with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDocumentClassifiers', listDocumentClassifiers_nextToken - Identifies the next page of results to return.
$sel:filter':ListDocumentClassifiers', listDocumentClassifiers_filter - 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.
$sel:maxResults:ListDocumentClassifiers', listDocumentClassifiers_maxResults - The maximum number of results to return in each page. The default is
100.
data ListDocumentClassifiersResponse Source #
See: newListDocumentClassifiersResponse smart constructor.
Constructors
| ListDocumentClassifiersResponse' (Maybe Text) (Maybe [DocumentClassifierProperties]) Int |
Instances
newListDocumentClassifiersResponse Source #
Create a value of ListDocumentClassifiersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDocumentClassifiers', listDocumentClassifiersResponse_nextToken - Identifies the next page of results to return.
$sel:documentClassifierPropertiesList:ListDocumentClassifiersResponse', listDocumentClassifiersResponse_documentClassifierPropertiesList - A list containing the properties of each job returned.
$sel:httpStatus:ListDocumentClassifiersResponse', listDocumentClassifiersResponse_httpStatus - The response's http status code.
Types
AugmentedManifestsDocumentTypeFormat
newtype AugmentedManifestsDocumentTypeFormat Source #
Constructors
| AugmentedManifestsDocumentTypeFormat' | |
Bundled Patterns
Instances
DocumentClassifierDataFormat
newtype DocumentClassifierDataFormat Source #
Constructors
| DocumentClassifierDataFormat' | |
Fields | |
Bundled Patterns
| pattern DocumentClassifierDataFormat_AUGMENTED_MANIFEST :: DocumentClassifierDataFormat | |
| pattern DocumentClassifierDataFormat_COMPREHEND_CSV :: DocumentClassifierDataFormat |
Instances
DocumentClassifierMode
newtype DocumentClassifierMode Source #
Constructors
| DocumentClassifierMode' | |
Fields | |
Bundled Patterns
| pattern DocumentClassifierMode_MULTI_CLASS :: DocumentClassifierMode | |
| pattern DocumentClassifierMode_MULTI_LABEL :: DocumentClassifierMode |
Instances
DocumentReadAction
newtype DocumentReadAction Source #
Constructors
| DocumentReadAction' | |
Fields | |
Bundled Patterns
| pattern DocumentReadAction_TEXTRACT_ANALYZE_DOCUMENT :: DocumentReadAction | |
| pattern DocumentReadAction_TEXTRACT_DETECT_DOCUMENT_TEXT :: DocumentReadAction |
Instances
DocumentReadFeatureTypes
newtype DocumentReadFeatureTypes Source #
A list of the types of analyses to perform. This field specifies what feature types need to be extracted from the document where entity recognition is expected.
TABLES- Add TABLES to the list to return information about the tables that are detected in the input document.FORMS- Add FORMS to return detected form data.
Constructors
| DocumentReadFeatureTypes' | |
Fields | |
Bundled Patterns
| pattern DocumentReadFeatureTypes_FORMS :: DocumentReadFeatureTypes | |
| pattern DocumentReadFeatureTypes_TABLES :: DocumentReadFeatureTypes |
Instances
DocumentReadMode
newtype DocumentReadMode Source #
Constructors
| DocumentReadMode' | |
Fields | |
Bundled Patterns
| pattern DocumentReadMode_FORCE_DOCUMENT_READ_ACTION :: DocumentReadMode | |
| pattern DocumentReadMode_SERVICE_DEFAULT :: DocumentReadMode |
Instances
EndpointStatus
newtype EndpointStatus Source #
Constructors
| EndpointStatus' | |
Fields | |
Bundled Patterns
| pattern EndpointStatus_CREATING :: EndpointStatus | |
| pattern EndpointStatus_DELETING :: EndpointStatus | |
| pattern EndpointStatus_FAILED :: EndpointStatus | |
| pattern EndpointStatus_IN_SERVICE :: EndpointStatus | |
| pattern EndpointStatus_UPDATING :: EndpointStatus |
Instances
EntityRecognizerDataFormat
newtype EntityRecognizerDataFormat Source #
Constructors
| EntityRecognizerDataFormat' | |
Fields | |
Bundled Patterns
| pattern EntityRecognizerDataFormat_AUGMENTED_MANIFEST :: EntityRecognizerDataFormat | |
| pattern EntityRecognizerDataFormat_COMPREHEND_CSV :: EntityRecognizerDataFormat |
Instances
EntityType
newtype EntityType Source #
Constructors
| EntityType' | |
Fields | |
Bundled Patterns
| pattern EntityType_COMMERCIAL_ITEM :: EntityType | |
| pattern EntityType_DATE :: EntityType | |
| pattern EntityType_EVENT :: EntityType | |
| pattern EntityType_LOCATION :: EntityType | |
| pattern EntityType_ORGANIZATION :: EntityType | |
| pattern EntityType_OTHER :: EntityType | |
| pattern EntityType_PERSON :: EntityType | |
| pattern EntityType_QUANTITY :: EntityType | |
| pattern EntityType_TITLE :: EntityType |
Instances
InputFormat
newtype InputFormat Source #
Constructors
| InputFormat' | |
Fields | |
Bundled Patterns
| pattern InputFormat_ONE_DOC_PER_FILE :: InputFormat | |
| pattern InputFormat_ONE_DOC_PER_LINE :: InputFormat |
Instances
JobStatus
Constructors
| JobStatus' | |
Fields | |
Bundled Patterns
| pattern JobStatus_COMPLETED :: JobStatus | |
| pattern JobStatus_FAILED :: JobStatus | |
| pattern JobStatus_IN_PROGRESS :: JobStatus | |
| pattern JobStatus_STOPPED :: JobStatus | |
| pattern JobStatus_STOP_REQUESTED :: JobStatus | |
| pattern JobStatus_SUBMITTED :: JobStatus |
Instances
LanguageCode
newtype LanguageCode Source #
Constructors
| LanguageCode' | |
Fields | |
Bundled Patterns
| pattern LanguageCode_Ar :: LanguageCode | |
| pattern LanguageCode_De :: LanguageCode | |
| pattern LanguageCode_En :: LanguageCode | |
| pattern LanguageCode_Es :: LanguageCode | |
| pattern LanguageCode_Fr :: LanguageCode | |
| pattern LanguageCode_Hi :: LanguageCode | |
| pattern LanguageCode_It :: LanguageCode | |
| pattern LanguageCode_Ja :: LanguageCode | |
| pattern LanguageCode_Ko :: LanguageCode | |
| pattern LanguageCode_Pt :: LanguageCode | |
| pattern LanguageCode_Zh :: LanguageCode | |
| pattern LanguageCode_Zh_TW :: LanguageCode |
Instances
ModelStatus
newtype ModelStatus Source #
Constructors
| ModelStatus' | |
Fields | |
Bundled Patterns
| pattern ModelStatus_DELETING :: ModelStatus | |
| pattern ModelStatus_IN_ERROR :: ModelStatus | |
| pattern ModelStatus_STOPPED :: ModelStatus | |
| pattern ModelStatus_STOP_REQUESTED :: ModelStatus | |
| pattern ModelStatus_SUBMITTED :: ModelStatus | |
| pattern ModelStatus_TRAINED :: ModelStatus | |
| pattern ModelStatus_TRAINING :: ModelStatus |
Instances
PartOfSpeechTagType
newtype PartOfSpeechTagType Source #
Constructors
| PartOfSpeechTagType' | |
Fields | |
Bundled Patterns
Instances
PiiEntitiesDetectionMaskMode
newtype PiiEntitiesDetectionMaskMode Source #
Constructors
| PiiEntitiesDetectionMaskMode' | |
Fields | |
Bundled Patterns
| pattern PiiEntitiesDetectionMaskMode_MASK :: PiiEntitiesDetectionMaskMode | |
| pattern PiiEntitiesDetectionMaskMode_REPLACE_WITH_PII_ENTITY_TYPE :: PiiEntitiesDetectionMaskMode |
Instances
PiiEntitiesDetectionMode
newtype PiiEntitiesDetectionMode Source #
Constructors
| PiiEntitiesDetectionMode' | |
Fields | |
Bundled Patterns
| pattern PiiEntitiesDetectionMode_ONLY_OFFSETS :: PiiEntitiesDetectionMode | |
| pattern PiiEntitiesDetectionMode_ONLY_REDACTION :: PiiEntitiesDetectionMode |
Instances
PiiEntityType
newtype PiiEntityType Source #
Constructors
| PiiEntityType' | |
Fields | |
Bundled Patterns
Instances
SentimentType
newtype SentimentType Source #
Constructors
| SentimentType' | |
Fields | |
Bundled Patterns
| pattern SentimentType_MIXED :: SentimentType | |
| pattern SentimentType_NEGATIVE :: SentimentType | |
| pattern SentimentType_NEUTRAL :: SentimentType | |
| pattern SentimentType_POSITIVE :: SentimentType |
Instances
Split
Bundled Patterns
| pattern Split_TEST :: Split | |
| pattern Split_TRAIN :: Split |
Instances
SyntaxLanguageCode
newtype SyntaxLanguageCode Source #
Constructors
| SyntaxLanguageCode' | |
Fields | |
Bundled Patterns
| pattern SyntaxLanguageCode_De :: SyntaxLanguageCode | |
| pattern SyntaxLanguageCode_En :: SyntaxLanguageCode | |
| pattern SyntaxLanguageCode_Es :: SyntaxLanguageCode | |
| pattern SyntaxLanguageCode_Fr :: SyntaxLanguageCode | |
| pattern SyntaxLanguageCode_It :: SyntaxLanguageCode | |
| pattern SyntaxLanguageCode_Pt :: SyntaxLanguageCode |
Instances
AugmentedManifestsListItem
data AugmentedManifestsListItem Source #
An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
See: newAugmentedManifestsListItem smart constructor.
Constructors
| AugmentedManifestsListItem' (Maybe Text) (Maybe AugmentedManifestsDocumentTypeFormat) (Maybe Split) (Maybe Text) Text [Text] |
Instances
newAugmentedManifestsListItem Source #
Create a value of AugmentedManifestsListItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceDocumentsS3Uri:AugmentedManifestsListItem', augmentedManifestsListItem_sourceDocumentsS3Uri - The S3 prefix to the source files (PDFs) that are referred to in the
augmented manifest file.
$sel:documentType:AugmentedManifestsListItem', augmentedManifestsListItem_documentType - The type of augmented manifest. PlainTextDocument or
SemiStructuredDocument. If you don't specify, the default is
PlainTextDocument.
PLAIN_TEXT_DOCUMENTA document type that represents any unicode text that is encoded in UTF-8.SEMI_STRUCTURED_DOCUMENTA document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.
$sel:split:AugmentedManifestsListItem', augmentedManifestsListItem_split - The purpose of the data you've provided in the augmented manifest. You
can either train or test this data. If you don't specify, the default
is train.
TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
TEST - all of the documents in the manifest will be used for testing.
$sel:annotationDataS3Uri:AugmentedManifestsListItem', augmentedManifestsListItem_annotationDataS3Uri - The S3 prefix to the annotation files that are referred in the augmented
manifest file.
$sel:s3Uri:AugmentedManifestsListItem', augmentedManifestsListItem_s3Uri - The Amazon S3 location of the augmented manifest file.
$sel:attributeNames:AugmentedManifestsListItem', augmentedManifestsListItem_attributeNames - The JSON attribute that contains the annotations for your training
documents. The number of attribute names that you specify depends on
whether your augmented manifest file is the output of a single labeling
job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
BatchDetectDominantLanguageItemResult
data BatchDetectDominantLanguageItemResult Source #
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
See: newBatchDetectDominantLanguageItemResult smart constructor.
Constructors
| BatchDetectDominantLanguageItemResult' (Maybe [DominantLanguage]) (Maybe Int) |
Instances
newBatchDetectDominantLanguageItemResult :: BatchDetectDominantLanguageItemResult Source #
Create a value of BatchDetectDominantLanguageItemResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:languages:BatchDetectDominantLanguageItemResult', batchDetectDominantLanguageItemResult_languages - One or more DominantLanguage objects describing the dominant languages
in the document.
$sel:index:BatchDetectDominantLanguageItemResult', batchDetectDominantLanguageItemResult_index - The zero-based index of the document in the input list.
BatchDetectEntitiesItemResult
data BatchDetectEntitiesItemResult Source #
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
See: newBatchDetectEntitiesItemResult smart constructor.
Constructors
| BatchDetectEntitiesItemResult' (Maybe [Entity]) (Maybe Int) |
Instances
newBatchDetectEntitiesItemResult :: BatchDetectEntitiesItemResult Source #
Create a value of BatchDetectEntitiesItemResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entities:BatchDetectEntitiesItemResult', batchDetectEntitiesItemResult_entities - One or more Entity objects, one for each entity detected in the
document.
$sel:index:BatchDetectEntitiesItemResult', batchDetectEntitiesItemResult_index - The zero-based index of the document in the input list.
BatchDetectKeyPhrasesItemResult
data BatchDetectKeyPhrasesItemResult Source #
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
See: newBatchDetectKeyPhrasesItemResult smart constructor.
Constructors
| BatchDetectKeyPhrasesItemResult' (Maybe Int) (Maybe [KeyPhrase]) |
Instances
newBatchDetectKeyPhrasesItemResult :: BatchDetectKeyPhrasesItemResult Source #
Create a value of BatchDetectKeyPhrasesItemResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:index:BatchDetectKeyPhrasesItemResult', batchDetectKeyPhrasesItemResult_index - The zero-based index of the document in the input list.
$sel:keyPhrases:BatchDetectKeyPhrasesItemResult', batchDetectKeyPhrasesItemResult_keyPhrases - One or more KeyPhrase objects, one for each key phrase detected in the
document.
BatchDetectSentimentItemResult
data BatchDetectSentimentItemResult Source #
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
See: newBatchDetectSentimentItemResult smart constructor.
Constructors
| BatchDetectSentimentItemResult' (Maybe SentimentType) (Maybe SentimentScore) (Maybe Int) |
Instances
newBatchDetectSentimentItemResult :: BatchDetectSentimentItemResult Source #
Create a value of BatchDetectSentimentItemResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sentiment:BatchDetectSentimentItemResult', batchDetectSentimentItemResult_sentiment - The sentiment detected in the document.
$sel:sentimentScore:BatchDetectSentimentItemResult', batchDetectSentimentItemResult_sentimentScore - The level of confidence that Amazon Comprehend has in the accuracy of
its sentiment detection.
$sel:index:BatchDetectSentimentItemResult', batchDetectSentimentItemResult_index - The zero-based index of the document in the input list.
BatchDetectSyntaxItemResult
data BatchDetectSyntaxItemResult Source #
The result of calling the operation. The operation returns one object that is successfully processed by the operation.
See: newBatchDetectSyntaxItemResult smart constructor.
Constructors
| BatchDetectSyntaxItemResult' (Maybe Int) (Maybe [SyntaxToken]) |
Instances
newBatchDetectSyntaxItemResult :: BatchDetectSyntaxItemResult Source #
Create a value of BatchDetectSyntaxItemResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:index:BatchDetectSyntaxItemResult', batchDetectSyntaxItemResult_index - The zero-based index of the document in the input list.
$sel:syntaxTokens:BatchDetectSyntaxItemResult', batchDetectSyntaxItemResult_syntaxTokens - The syntax tokens for the words in the document, one token for each
word.
BatchItemError
data BatchItemError Source #
Describes an error that occurred while processing a document in a batch.
The operation returns on BatchItemError object for each document that
contained an error.
See: newBatchItemError smart constructor.
Instances
newBatchItemError :: BatchItemError Source #
Create a value of BatchItemError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:BatchItemError', batchItemError_errorCode - The numeric error code of the error.
$sel:errorMessage:BatchItemError', batchItemError_errorMessage - A text description of the error.
$sel:index:BatchItemError', batchItemError_index - The zero-based index of the document in the input list.
ClassifierEvaluationMetrics
data ClassifierEvaluationMetrics Source #
Describes the result metrics for the test data associated with an documentation classifier.
See: newClassifierEvaluationMetrics smart constructor.
Constructors
| ClassifierEvaluationMetrics' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) |
Instances
newClassifierEvaluationMetrics :: ClassifierEvaluationMetrics Source #
Create a value of ClassifierEvaluationMetrics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:microPrecision:ClassifierEvaluationMetrics', classifierEvaluationMetrics_microPrecision - A measure of the usefulness of the recognizer results in the test data.
High precision means that the recognizer returned substantially more
relevant results than irrelevant ones. Unlike the Precision metric which
comes from averaging the precision of all available labels, this is
based on the overall score of all precision scores added together.
$sel:microF1Score:ClassifierEvaluationMetrics', classifierEvaluationMetrics_microF1Score - A measure of how accurate the classifier results are for the test data.
It is a combination of the Micro Precision and Micro Recall values.
The Micro F1Score is the harmonic mean of the two scores. The highest
score is 1, and the worst score is 0.
$sel:recall:ClassifierEvaluationMetrics', classifierEvaluationMetrics_recall - A measure of how complete the classifier results are for the test data.
High recall means that the classifier returned most of the relevant
results.
$sel:precision:ClassifierEvaluationMetrics', classifierEvaluationMetrics_precision - A measure of the usefulness of the classifier results in the test data.
High precision means that the classifier returned substantially more
relevant results than irrelevant ones.
$sel:microRecall:ClassifierEvaluationMetrics', classifierEvaluationMetrics_microRecall - A measure of how complete the classifier results are for the test data.
High recall means that the classifier returned most of the relevant
results. Specifically, this indicates how many of the correct categories
in the text that the model can predict. It is a percentage of correct
categories in the text that can found. Instead of averaging the recall
scores of all labels (as with Recall), micro Recall is based on the
overall score of all recall scores added together.
$sel:f1Score:ClassifierEvaluationMetrics', classifierEvaluationMetrics_f1Score - A measure of how accurate the classifier results are for the test data.
It is derived from the Precision and Recall values. The F1Score is
the harmonic average of the two scores. The highest score is 1, and the
worst score is 0.
$sel:hammingLoss:ClassifierEvaluationMetrics', classifierEvaluationMetrics_hammingLoss - Indicates the fraction of labels that are incorrectly predicted. Also
seen as the fraction of wrong labels compared to the total number of
labels. Scores closer to zero are better.
$sel:accuracy:ClassifierEvaluationMetrics', classifierEvaluationMetrics_accuracy - The fraction of the labels that were correct recognized. It is computed
by dividing the number of labels in the test documents that were
correctly recognized by the total number of labels in the test
documents.
ClassifierMetadata
data ClassifierMetadata Source #
Provides information about a document classifier.
See: newClassifierMetadata smart constructor.
Constructors
| ClassifierMetadata' (Maybe Int) (Maybe ClassifierEvaluationMetrics) (Maybe Int) (Maybe Int) |
Instances
newClassifierMetadata :: ClassifierMetadata Source #
Create a value of ClassifierMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:numberOfLabels:ClassifierMetadata', classifierMetadata_numberOfLabels - The number of labels in the input data.
$sel:evaluationMetrics:ClassifierMetadata', classifierMetadata_evaluationMetrics - Describes the result metrics for the test data associated with an
documentation classifier.
$sel:numberOfTrainedDocuments:ClassifierMetadata', classifierMetadata_numberOfTrainedDocuments - The number of documents in the input data that were used to train the
classifier. Typically this is 80 to 90 percent of the input documents.
$sel:numberOfTestDocuments:ClassifierMetadata', classifierMetadata_numberOfTestDocuments - The number of documents in the input data that were used to test the
classifier. Typically this is 10 to 20 percent of the input documents,
up to 10,000 documents.
DocumentClass
data DocumentClass Source #
Specifies the class that categorizes the document being analyzed
See: newDocumentClass smart constructor.
Constructors
| DocumentClass' (Maybe Double) (Maybe Text) |
Instances
newDocumentClass :: DocumentClass Source #
Create a value of DocumentClass with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:score:DocumentClass', documentClass_score - The confidence score that Amazon Comprehend has this class correctly
attributed.
$sel:name:DocumentClass', documentClass_name - The name of the class.
DocumentClassificationJobFilter
data DocumentClassificationJobFilter Source #
Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.
See: newDocumentClassificationJobFilter smart constructor.
Constructors
| DocumentClassificationJobFilter' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe JobStatus) |
Instances
newDocumentClassificationJobFilter :: DocumentClassificationJobFilter Source #
Create a value of DocumentClassificationJobFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:submitTimeAfter:DocumentClassificationJobFilter', documentClassificationJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted after the specified time.
Jobs are returned in descending order, newest to oldest.
$sel:submitTimeBefore:DocumentClassificationJobFilter', documentClassificationJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted before the specified time.
Jobs are returned in ascending order, oldest to newest.
$sel:jobName:DocumentClassificationJobFilter', documentClassificationJobFilter_jobName - Filters on the name of the job.
$sel:jobStatus:DocumentClassificationJobFilter', documentClassificationJobFilter_jobStatus - Filters the list based on job status. Returns only jobs with the
specified status.
DocumentClassificationJobProperties
data DocumentClassificationJobProperties Source #
Provides information about a document classification job.
See: newDocumentClassificationJobProperties smart constructor.
Constructors
| DocumentClassificationJobProperties' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InputDataConfig) (Maybe VpcConfig) (Maybe Text) (Maybe POSIX) (Maybe OutputDataConfig) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe POSIX) |
Instances
newDocumentClassificationJobProperties :: DocumentClassificationJobProperties Source #
Create a value of DocumentClassificationJobProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:DocumentClassificationJobProperties', documentClassificationJobProperties_jobId - The identifier assigned to the document classification job.
$sel:jobArn:DocumentClassificationJobProperties', documentClassificationJobProperties_jobArn - The Amazon Resource Name (ARN) of the document classification job. It is
a unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
$sel:documentClassifierArn:DocumentClassificationJobProperties', documentClassificationJobProperties_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.
$sel:jobName:DocumentClassificationJobProperties', documentClassificationJobProperties_jobName - The name that you assigned to the document classification job.
$sel:inputDataConfig:DocumentClassificationJobProperties', documentClassificationJobProperties_inputDataConfig - The input data configuration that you supplied when you created the
document classification job.
$sel:vpcConfig:DocumentClassificationJobProperties', documentClassificationJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your document classification
job. For more information, see
Amazon VPC.
$sel:volumeKmsKeyId:DocumentClassificationJobProperties', documentClassificationJobProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:endTime:DocumentClassificationJobProperties', documentClassificationJobProperties_endTime - The time that the document classification job completed.
$sel:outputDataConfig:DocumentClassificationJobProperties', documentClassificationJobProperties_outputDataConfig - The output data configuration that you supplied when you created the
document classification job.
$sel:dataAccessRoleArn:DocumentClassificationJobProperties', documentClassificationJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS identity and Access Management
(IAM) role that grants Amazon Comprehend read access to your input data.
$sel:jobStatus:DocumentClassificationJobProperties', documentClassificationJobProperties_jobStatus - The current status of the document classification job. If the status is
FAILED, the Message field shows the reason for the failure.
$sel:message:DocumentClassificationJobProperties', documentClassificationJobProperties_message - A description of the status of the job.
$sel:submitTime:DocumentClassificationJobProperties', documentClassificationJobProperties_submitTime - The time that the document classification job was submitted for
processing.
DocumentClassifierFilter
data DocumentClassifierFilter Source #
Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the operation.
See: newDocumentClassifierFilter smart constructor.
Constructors
| DocumentClassifierFilter' (Maybe ModelStatus) (Maybe POSIX) (Maybe POSIX) (Maybe Text) |
Instances
newDocumentClassifierFilter :: DocumentClassifierFilter Source #
Create a value of DocumentClassifierFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DocumentClassifierFilter', documentClassifierFilter_status - Filters the list of classifiers based on status.
$sel:submitTimeAfter:DocumentClassifierFilter', documentClassifierFilter_submitTimeAfter - Filters the list of classifiers based on the time that the classifier
was submitted for processing. Returns only classifiers submitted after
the specified time. Classifiers are returned in descending order, newest
to oldest.
$sel:submitTimeBefore:DocumentClassifierFilter', documentClassifierFilter_submitTimeBefore - Filters the list of classifiers based on the time that the classifier
was submitted for processing. Returns only classifiers submitted before
the specified time. Classifiers are returned in ascending order, oldest
to newest.
$sel:documentClassifierName:DocumentClassifierFilter', documentClassifierFilter_documentClassifierName - The name that you assigned to the document classifier
DocumentClassifierInputDataConfig
data DocumentClassifierInputDataConfig Source #
The input properties for training a document classifier.
For more information on how the input file is formatted, see how-document-classification-training-data.
See: newDocumentClassifierInputDataConfig smart constructor.
Constructors
| DocumentClassifierInputDataConfig' (Maybe [AugmentedManifestsListItem]) (Maybe DocumentClassifierDataFormat) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newDocumentClassifierInputDataConfig :: DocumentClassifierInputDataConfig Source #
Create a value of DocumentClassifierInputDataConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:augmentedManifests:DocumentClassifierInputDataConfig', documentClassifierInputDataConfig_augmentedManifests - A list of augmented manifest files that provide training data for your
custom model. An augmented manifest file is a labeled dataset that is
produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat to
AUGMENTED_MANIFEST.
$sel:dataFormat:DocumentClassifierInputDataConfig', documentClassifierInputDataConfig_dataFormat - The format of your training data:
COMPREHEND_CSV: A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide theS3Uriparameter in your request.AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels.If you use this value, you must provide the
AugmentedManifestsparameter in your request.
If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV
as the default.
$sel:labelDelimiter:DocumentClassifierInputDataConfig', documentClassifierInputDataConfig_labelDelimiter - Indicates the delimiter used to separate each label for training a
multi-label classifier. The default delimiter between labels is a pipe
(|). You can use a different character as a delimiter (if it's an
allowed character) by specifying it under Delimiter for labels. If the
training documents use a delimiter other than the default or the
delimiter you specify, the labels on that line will be combined to make
a single unique label, such as LABELLABELLABEL.
$sel:testS3Uri:DocumentClassifierInputDataConfig', documentClassifierInputDataConfig_testS3Uri - The Amazon S3 URI for the input data. The Amazon S3 bucket must be in
the same AWS Region as the API endpoint that you are calling. The URI
can point to a single input file or it can provide the prefix for a
collection of input files.
$sel:s3Uri:DocumentClassifierInputDataConfig', documentClassifierInputDataConfig_s3Uri - The Amazon S3 URI for the input data. The S3 bucket must be in the same
region as the API endpoint that you are calling. The URI can point to a
single input file or it can provide the prefix for a collection of input
files.
For example, if you use the URI S3://bucketName/prefix, if the
prefix is a single file, Amazon Comprehend uses that file as input. If
more than one file begins with the prefix, Amazon Comprehend uses all of
them as input.
This parameter is required if you set DataFormat to COMPREHEND_CSV.
DocumentClassifierOutputDataConfig
data DocumentClassifierOutputDataConfig Source #
Provides output results configuration parameters for custom classifier jobs.
See: newDocumentClassifierOutputDataConfig smart constructor.
Constructors
| DocumentClassifierOutputDataConfig' (Maybe Text) (Maybe Text) |
Instances
newDocumentClassifierOutputDataConfig :: DocumentClassifierOutputDataConfig Source #
Create a value of DocumentClassifierOutputDataConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKeyId:DocumentClassifierOutputDataConfig', documentClassifierOutputDataConfig_kmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt the output results from an analysis job. The KmsKeyId
can be one of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" - KMS Key Alias:
"alias/ExampleAlias" - ARN of a KMS Key Alias:
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
$sel:s3Uri:DocumentClassifierOutputDataConfig', documentClassifierOutputDataConfig_s3Uri - When you use the OutputDataConfig object while creating a custom
classifier, you specify the Amazon S3 location where you want to write
the confusion matrix. The URI must be in the same region as the API
endpoint that you are calling. The location is used as the prefix for
the actual location of this output file.
When the custom classifier job is finished, the service creates the
output file in a directory specific to the job. The S3Uri field
contains the location of the output file, called output.tar.gz. It is
a compressed archive that contains the confusion matrix.
DocumentClassifierProperties
data DocumentClassifierProperties Source #
Provides information about a document classifier.
See: newDocumentClassifierProperties smart constructor.
Constructors
Instances
newDocumentClassifierProperties :: DocumentClassifierProperties Source #
Create a value of DocumentClassifierProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DocumentClassifierProperties', documentClassifierProperties_status - The status of the document classifier. If the status is TRAINED the
classifier is ready to use. If the status is FAILED you can see
additional information about why the classifier wasn't trained in the
Message field.
$sel:languageCode:DocumentClassifierProperties', documentClassifierProperties_languageCode - The language code for the language of the documents that the classifier
was trained on.
$sel:classifierMetadata:DocumentClassifierProperties', documentClassifierProperties_classifierMetadata - Information about the document classifier, including the number of
documents used for training the classifier, the number of documents used
for test the classifier, and an accuracy rating.
$sel:trainingEndTime:DocumentClassifierProperties', documentClassifierProperties_trainingEndTime - The time that training of the document classifier was completed.
Indicates the time when the training completes on documentation
classifiers. You are billed for the time interval between this time and
the value of TrainingStartTime.
$sel:documentClassifierArn:DocumentClassifierProperties', documentClassifierProperties_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.
$sel:versionName:DocumentClassifierProperties', documentClassifierProperties_versionName - The version name that you assigned to the document classifier.
$sel:modelKmsKeyId:DocumentClassifierProperties', documentClassifierProperties_modelKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt trained custom models. The ModelKmsKeyId can be either
of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:mode:DocumentClassifierProperties', documentClassifierProperties_mode - Indicates the mode in which the specific classifier was trained. This
also indicates the format of input documents and the format of the
confusion matrix. Each classifier can only be trained in one mode and
this cannot be changed once the classifier is trained.
$sel:inputDataConfig:DocumentClassifierProperties', documentClassifierProperties_inputDataConfig - The input data configuration that you supplied when you created the
document classifier for training.
$sel:vpcConfig:DocumentClassifierProperties', documentClassifierProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your custom classifier. For
more information, see
Amazon VPC.
$sel:volumeKmsKeyId:DocumentClassifierProperties', documentClassifierProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:endTime:DocumentClassifierProperties', documentClassifierProperties_endTime - The time that training the document classifier completed.
$sel:outputDataConfig:DocumentClassifierProperties', documentClassifierProperties_outputDataConfig - Provides output results configuration parameters for custom classifier
jobs.
$sel:trainingStartTime:DocumentClassifierProperties', documentClassifierProperties_trainingStartTime - Indicates the time when the training starts on documentation
classifiers. You are billed for the time interval between this time and
the value of TrainingEndTime.
$sel:dataAccessRoleArn:DocumentClassifierProperties', documentClassifierProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM)
role that grants Amazon Comprehend read access to your input data.
$sel:message:DocumentClassifierProperties', documentClassifierProperties_message - Additional information about the status of the classifier.
$sel:submitTime:DocumentClassifierProperties', documentClassifierProperties_submitTime - The time that the document classifier was submitted for training.
DocumentClassifierSummary
data DocumentClassifierSummary Source #
Describes information about a document classifier and its versions.
See: newDocumentClassifierSummary smart constructor.
Constructors
| DocumentClassifierSummary' (Maybe POSIX) (Maybe Text) (Maybe ModelStatus) (Maybe Int) (Maybe Text) |
Instances
newDocumentClassifierSummary :: DocumentClassifierSummary Source #
Create a value of DocumentClassifierSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:latestVersionCreatedAt:DocumentClassifierSummary', documentClassifierSummary_latestVersionCreatedAt - The time that the latest document classifier version was submitted for
processing.
$sel:documentClassifierName:DocumentClassifierSummary', documentClassifierSummary_documentClassifierName - The name that you assigned the document classifier.
$sel:latestVersionStatus:DocumentClassifierSummary', documentClassifierSummary_latestVersionStatus - Provides the status of the latest document classifier version.
$sel:numberOfVersions:DocumentClassifierSummary', documentClassifierSummary_numberOfVersions - The number of versions you created.
$sel:latestVersionName:DocumentClassifierSummary', documentClassifierSummary_latestVersionName - The version name you assigned to the latest document classifier version.
DocumentLabel
data DocumentLabel Source #
Specifies one of the label or labels that categorize the document being analyzed.
See: newDocumentLabel smart constructor.
Constructors
| DocumentLabel' (Maybe Double) (Maybe Text) |
Instances
newDocumentLabel :: DocumentLabel Source #
Create a value of DocumentLabel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:score:DocumentLabel', documentLabel_score - The confidence score that Amazon Comprehend has this label correctly
attributed.
$sel:name:DocumentLabel', documentLabel_name - The name of the label.
DocumentReaderConfig
data DocumentReaderConfig Source #
The input properties for a topic detection job.
See: newDocumentReaderConfig smart constructor.
Constructors
| DocumentReaderConfig' (Maybe (NonEmpty DocumentReadFeatureTypes)) (Maybe DocumentReadMode) DocumentReadAction |
Instances
newDocumentReaderConfig Source #
Create a value of DocumentReaderConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:featureTypes:DocumentReaderConfig', documentReaderConfig_featureTypes - Specifies how the text in an input file should be processed:
$sel:documentReadMode:DocumentReaderConfig', documentReaderConfig_documentReadMode - This enum field provides two values:
SERVICE_DEFAULT- use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIsFORCE_DOCUMENT_READ_ACTION- Always use specified action for DocumentReadAction, including Digital PDF.
$sel:documentReadAction:DocumentReaderConfig', documentReaderConfig_documentReadAction - This enum field will start with two values which will apply to PDFs:
TEXTRACT_DETECT_DOCUMENT_TEXT- The service calls DetectDocumentText for PDF documents per page.TEXTRACT_ANALYZE_DOCUMENT- The service calls AnalyzeDocument for PDF documents per page.
DominantLanguage
data DominantLanguage Source #
Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.
See: newDominantLanguage smart constructor.
Constructors
| DominantLanguage' (Maybe Text) (Maybe Double) |
Instances
newDominantLanguage :: DominantLanguage Source #
Create a value of DominantLanguage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:languageCode:DominantLanguage', dominantLanguage_languageCode - The RFC 5646 language code for the dominant language. For more
information about RFC 5646, see
Tags for Identifying Languages on
the IETF Tools web site.
$sel:score:DominantLanguage', dominantLanguage_score - The level of confidence that Amazon Comprehend has in the accuracy of
the detection.
DominantLanguageDetectionJobFilter
data DominantLanguageDetectionJobFilter Source #
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
See: newDominantLanguageDetectionJobFilter smart constructor.
Constructors
| DominantLanguageDetectionJobFilter' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe JobStatus) |
Instances
newDominantLanguageDetectionJobFilter :: DominantLanguageDetectionJobFilter Source #
Create a value of DominantLanguageDetectionJobFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:submitTimeAfter:DominantLanguageDetectionJobFilter', dominantLanguageDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted after the specified time.
Jobs are returned in descending order, newest to oldest.
$sel:submitTimeBefore:DominantLanguageDetectionJobFilter', dominantLanguageDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted before the specified time.
Jobs are returned in ascending order, oldest to newest.
$sel:jobName:DominantLanguageDetectionJobFilter', dominantLanguageDetectionJobFilter_jobName - Filters on the name of the job.
$sel:jobStatus:DominantLanguageDetectionJobFilter', dominantLanguageDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the
specified status.
DominantLanguageDetectionJobProperties
data DominantLanguageDetectionJobProperties Source #
Provides information about a dominant language detection job.
See: newDominantLanguageDetectionJobProperties smart constructor.
Constructors
| DominantLanguageDetectionJobProperties' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InputDataConfig) (Maybe VpcConfig) (Maybe Text) (Maybe POSIX) (Maybe OutputDataConfig) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe POSIX) |
Instances
newDominantLanguageDetectionJobProperties :: DominantLanguageDetectionJobProperties Source #
Create a value of DominantLanguageDetectionJobProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_jobId - The identifier assigned to the dominant language detection job.
$sel:jobArn:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the dominant language detection job.
It is a unique, fully qualified identifier for the job. It includes the
AWS account, Region, and the job ID. The format of the ARN is as
follows:
arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobName:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_jobName - The name that you assigned to the dominant language detection job.
$sel:inputDataConfig:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the
dominant language detection job.
$sel:vpcConfig:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your dominant language
detection job. For more information, see
Amazon VPC.
$sel:volumeKmsKeyId:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:endTime:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_endTime - The time that the dominant language detection job completed.
$sel:outputDataConfig:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the
dominant language detection job.
$sel:dataAccessRoleArn:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access
to your input data.
$sel:jobStatus:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_jobStatus - The current status of the dominant language detection job. If the status
is FAILED, the Message field shows the reason for the failure.
$sel:message:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_message - A description for the status of a job.
$sel:submitTime:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_submitTime - The time that the dominant language detection job was submitted for
processing.
EndpointFilter
data EndpointFilter Source #
The filter used to determine which endpoints are returned. You can filter jobs on their name, model, status, or the date and time that they were created. You can only set one filter at a time.
See: newEndpointFilter smart constructor.
Constructors
| EndpointFilter' (Maybe EndpointStatus) (Maybe Text) (Maybe POSIX) (Maybe POSIX) |
Instances
newEndpointFilter :: EndpointFilter Source #
Create a value of EndpointFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:EndpointFilter', endpointFilter_status - Specifies the status of the endpoint being returned. Possible values
are: Creating, Ready, Updating, Deleting, Failed.
$sel:modelArn:EndpointFilter', endpointFilter_modelArn - The Amazon Resource Number (ARN) of the model to which the endpoint is
attached.
$sel:creationTimeAfter:EndpointFilter', endpointFilter_creationTimeAfter - Specifies a date after which the returned endpoint or endpoints were
created.
$sel:creationTimeBefore:EndpointFilter', endpointFilter_creationTimeBefore - Specifies a date before which the returned endpoint or endpoints were
created.
EndpointProperties
data EndpointProperties Source #
Specifies information about the specified endpoint.
See: newEndpointProperties smart constructor.
Constructors
| EndpointProperties' (Maybe POSIX) (Maybe EndpointStatus) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newEndpointProperties :: EndpointProperties Source #
Create a value of EndpointProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:EndpointProperties', endpointProperties_creationTime - The creation date and time of the endpoint.
$sel:status:EndpointProperties', endpointProperties_status - Specifies the status of the endpoint. Because the endpoint updates and
creation are asynchronous, so customers will need to wait for the
endpoint to be Ready status before making inference requests.
$sel:modelArn:EndpointProperties', endpointProperties_modelArn - The Amazon Resource Number (ARN) of the model to which the endpoint is
attached.
$sel:desiredModelArn:EndpointProperties', endpointProperties_desiredModelArn - ARN of the new model to use for updating an existing endpoint. This ARN
is going to be different from the model ARN when the update is in
progress
$sel:lastModifiedTime:EndpointProperties', endpointProperties_lastModifiedTime - The date and time that the endpoint was last modified.
$sel:desiredInferenceUnits:EndpointProperties', endpointProperties_desiredInferenceUnits - The desired number of inference units to be used by the model using this
endpoint. Each inference unit represents of a throughput of 100
characters per second.
$sel:currentInferenceUnits:EndpointProperties', endpointProperties_currentInferenceUnits - The number of inference units currently used by the model using this
endpoint.
$sel:dataAccessRoleArn:EndpointProperties', endpointProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS identity and Access Management
(IAM) role that grants Amazon Comprehend read access to trained custom
models encrypted with a customer managed key (ModelKmsKeyId).
$sel:desiredDataAccessRoleArn:EndpointProperties', endpointProperties_desiredDataAccessRoleArn - Data access role ARN to use in case the new model is encrypted with a
customer KMS key.
$sel:message:EndpointProperties', endpointProperties_message - Specifies a reason for failure in cases of Failed status.
$sel:endpointArn:EndpointProperties', endpointProperties_endpointArn - The Amazon Resource Number (ARN) of the endpoint.
EntitiesDetectionJobFilter
data EntitiesDetectionJobFilter Source #
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
See: newEntitiesDetectionJobFilter smart constructor.
Instances
newEntitiesDetectionJobFilter :: EntitiesDetectionJobFilter Source #
Create a value of EntitiesDetectionJobFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:submitTimeAfter:EntitiesDetectionJobFilter', entitiesDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted after the specified time.
Jobs are returned in descending order, newest to oldest.
$sel:submitTimeBefore:EntitiesDetectionJobFilter', entitiesDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted before the specified time.
Jobs are returned in ascending order, oldest to newest.
$sel:jobName:EntitiesDetectionJobFilter', entitiesDetectionJobFilter_jobName - Filters on the name of the job.
$sel:jobStatus:EntitiesDetectionJobFilter', entitiesDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the
specified status.
EntitiesDetectionJobProperties
data EntitiesDetectionJobProperties Source #
Provides information about an entities detection job.
See: newEntitiesDetectionJobProperties smart constructor.
Constructors
| EntitiesDetectionJobProperties' (Maybe LanguageCode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InputDataConfig) (Maybe VpcConfig) (Maybe Text) (Maybe POSIX) (Maybe OutputDataConfig) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe POSIX) |
Instances
newEntitiesDetectionJobProperties :: EntitiesDetectionJobProperties Source #
Create a value of EntitiesDetectionJobProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:languageCode:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_languageCode - The language code of the input documents.
$sel:jobId:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_jobId - The identifier assigned to the entities detection job.
$sel:jobArn:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the entities detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:entityRecognizerArn:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.
$sel:jobName:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_jobName - The name that you assigned the entities detection job.
$sel:inputDataConfig:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the
entities detection job.
$sel:vpcConfig:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your entity detection job.
For more information, see
Amazon VPC.
$sel:volumeKmsKeyId:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:endTime:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_endTime - The time that the entities detection job completed
$sel:outputDataConfig:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the
entities detection job.
$sel:dataAccessRoleArn:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access
to your input data.
$sel:jobStatus:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_jobStatus - The current status of the entities detection job. If the status is
FAILED, the Message field shows the reason for the failure.
$sel:message:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_message - A description of the status of a job.
$sel:submitTime:EntitiesDetectionJobProperties', entitiesDetectionJobProperties_submitTime - The time that the entities detection job was submitted for processing.
Entity
Provides information about an entity.
See: newEntity smart constructor.
Instances
Create a value of Entity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:beginOffset:Entity', entity_beginOffset - A character offset in the input text that shows where the entity begins
(the first character is at position 0). The offset returns the position
of each UTF-8 code point in the string. A code point is the abstract
character from a particular graphical representation. For example, a
multi-byte UTF-8 character maps to a single code point.
$sel:text:Entity', entity_text - The text of the entity.
$sel:score:Entity', entity_score - The level of confidence that Amazon Comprehend has in the accuracy of
the detection.
$sel:endOffset:Entity', entity_endOffset - A character offset in the input text that shows where the entity ends.
The offset returns the position of each UTF-8 code point in the string.
A code point is the abstract character from a particular graphical
representation. For example, a multi-byte UTF-8 character maps to a
single code point.
$sel:type':Entity', entity_type - The entity's type.
EntityLabel
data EntityLabel Source #
Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.
See: newEntityLabel smart constructor.
Constructors
| EntityLabel' (Maybe Double) (Maybe PiiEntityType) |
Instances
newEntityLabel :: EntityLabel Source #
Create a value of EntityLabel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:score:EntityLabel', entityLabel_score - The level of confidence that Amazon Comprehend has in the accuracy of
the detection.
$sel:name:EntityLabel', entityLabel_name - The name of the label.
EntityRecognizerAnnotations
data EntityRecognizerAnnotations Source #
Describes the annotations associated with a entity recognizer.
See: newEntityRecognizerAnnotations smart constructor.
Constructors
| EntityRecognizerAnnotations' (Maybe Text) Text |
Instances
newEntityRecognizerAnnotations Source #
Create a value of EntityRecognizerAnnotations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:testS3Uri:EntityRecognizerAnnotations', entityRecognizerAnnotations_testS3Uri - This specifies the Amazon S3 location where the test annotations for an
entity recognizer are located. The URI must be in the same AWS Region as
the API endpoint that you are calling.
$sel:s3Uri:EntityRecognizerAnnotations', entityRecognizerAnnotations_s3Uri - Specifies the Amazon S3 location where the annotations for an entity
recognizer are located. The URI must be in the same region as the API
endpoint that you are calling.
EntityRecognizerDocuments
data EntityRecognizerDocuments Source #
Describes the training documents submitted with an entity recognizer.
See: newEntityRecognizerDocuments smart constructor.
Constructors
| EntityRecognizerDocuments' (Maybe InputFormat) (Maybe Text) Text |
Instances
newEntityRecognizerDocuments Source #
Create a value of EntityRecognizerDocuments with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputFormat:EntityRecognizerDocuments', entityRecognizerDocuments_inputFormat - Specifies how the text in an input file should be processed. This is
optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each
file is considered a separate document. Use this option when you are
processing large documents, such as newspaper articles or scientific
papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate
document. Use this option when you are processing many short documents,
such as text messages.
$sel:testS3Uri:EntityRecognizerDocuments', entityRecognizerDocuments_testS3Uri - Specifies the Amazon S3 location where the test documents for an entity
recognizer are located. The URI must be in the same AWS Region as the
API endpoint that you are calling.
$sel:s3Uri:EntityRecognizerDocuments', entityRecognizerDocuments_s3Uri - Specifies the Amazon S3 location where the training documents for an
entity recognizer are located. The URI must be in the same region as the
API endpoint that you are calling.
EntityRecognizerEntityList
data EntityRecognizerEntityList Source #
Describes the entity recognizer submitted with an entity recognizer.
See: newEntityRecognizerEntityList smart constructor.
Constructors
| EntityRecognizerEntityList' Text |
Instances
newEntityRecognizerEntityList Source #
Create a value of EntityRecognizerEntityList with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Uri:EntityRecognizerEntityList', entityRecognizerEntityList_s3Uri - Specifies the Amazon S3 location where the entity list is located. The
URI must be in the same region as the API endpoint that you are calling.
EntityRecognizerEvaluationMetrics
data EntityRecognizerEvaluationMetrics Source #
Detailed information about the accuracy of an entity recognizer.
See: newEntityRecognizerEvaluationMetrics smart constructor.
Instances
newEntityRecognizerEvaluationMetrics :: EntityRecognizerEvaluationMetrics Source #
Create a value of EntityRecognizerEvaluationMetrics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recall:EntityRecognizerEvaluationMetrics', entityRecognizerEvaluationMetrics_recall - A measure of how complete the recognizer results are for the test data.
High recall means that the recognizer returned most of the relevant
results.
$sel:precision:EntityRecognizerEvaluationMetrics', entityRecognizerEvaluationMetrics_precision - A measure of the usefulness of the recognizer results in the test data.
High precision means that the recognizer returned substantially more
relevant results than irrelevant ones.
$sel:f1Score:EntityRecognizerEvaluationMetrics', entityRecognizerEvaluationMetrics_f1Score - A measure of how accurate the recognizer results are for the test data.
It is derived from the Precision and Recall values. The F1Score is
the harmonic average of the two scores. The highest score is 1, and the
worst score is 0.
EntityRecognizerFilter
data EntityRecognizerFilter Source #
Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see the operation./>
See: newEntityRecognizerFilter smart constructor.
Constructors
| EntityRecognizerFilter' (Maybe ModelStatus) (Maybe POSIX) (Maybe POSIX) (Maybe Text) |
Instances
newEntityRecognizerFilter :: EntityRecognizerFilter Source #
Create a value of EntityRecognizerFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:EntityRecognizerFilter', entityRecognizerFilter_status - The status of an entity recognizer.
$sel:submitTimeAfter:EntityRecognizerFilter', entityRecognizerFilter_submitTimeAfter - Filters the list of entities based on the time that the list was
submitted for processing. Returns only jobs submitted after the
specified time. Jobs are returned in ascending order, oldest to newest.
$sel:submitTimeBefore:EntityRecognizerFilter', entityRecognizerFilter_submitTimeBefore - Filters the list of entities based on the time that the list was
submitted for processing. Returns only jobs submitted before the
specified time. Jobs are returned in descending order, newest to oldest.
$sel:recognizerName:EntityRecognizerFilter', entityRecognizerFilter_recognizerName - The name that you assigned the entity recognizer.
EntityRecognizerInputDataConfig
data EntityRecognizerInputDataConfig Source #
Specifies the format and location of the input data.
See: newEntityRecognizerInputDataConfig smart constructor.
Constructors
Instances
newEntityRecognizerInputDataConfig :: EntityRecognizerInputDataConfig Source #
Create a value of EntityRecognizerInputDataConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:augmentedManifests:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_augmentedManifests - A list of augmented manifest files that provide training data for your
custom model. An augmented manifest file is a labeled dataset that is
produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat to
AUGMENTED_MANIFEST.
$sel:annotations:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_annotations - The S3 location of the CSV file that annotates your training documents.
$sel:dataFormat:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_dataFormat - The format of your training data:
COMPREHEND_CSV: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.If you use this value, you must provide your CSV file by using either the
AnnotationsorEntityListparameters. You must provide your training documents by using theDocumentsparameter.AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document.If you use this value, you must provide the
AugmentedManifestsparameter in your request.
If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV
as the default.
$sel:documents:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_documents - The S3 location of the folder that contains the training documents for
your custom entity recognizer.
This parameter is required if you set DataFormat to COMPREHEND_CSV.
$sel:entityList:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_entityList - The S3 location of the CSV file that has the entity list for your custom
entity recognizer.
$sel:entityTypes:EntityRecognizerInputDataConfig', entityRecognizerInputDataConfig_entityTypes - The entity types in the labeled training data that Amazon Comprehend
uses to train the custom entity recognizer. Any entity types that you
don't specify are ignored.
A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break), \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).
EntityRecognizerMetadata
data EntityRecognizerMetadata Source #
Detailed information about an entity recognizer.
See: newEntityRecognizerMetadata smart constructor.
Constructors
| EntityRecognizerMetadata' (Maybe [EntityRecognizerMetadataEntityTypesListItem]) (Maybe EntityRecognizerEvaluationMetrics) (Maybe Int) (Maybe Int) |
Instances
newEntityRecognizerMetadata :: EntityRecognizerMetadata Source #
Create a value of EntityRecognizerMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entityTypes:EntityRecognizerMetadata', entityRecognizerMetadata_entityTypes - Entity types from the metadata of an entity recognizer.
$sel:evaluationMetrics:EntityRecognizerMetadata', entityRecognizerMetadata_evaluationMetrics - Detailed information about the accuracy of an entity recognizer.
$sel:numberOfTrainedDocuments:EntityRecognizerMetadata', entityRecognizerMetadata_numberOfTrainedDocuments - The number of documents in the input data that were used to train the
entity recognizer. Typically this is 80 to 90 percent of the input
documents.
$sel:numberOfTestDocuments:EntityRecognizerMetadata', entityRecognizerMetadata_numberOfTestDocuments - The number of documents in the input data that were used to test the
entity recognizer. Typically this is 10 to 20 percent of the input
documents.
EntityRecognizerMetadataEntityTypesListItem
data EntityRecognizerMetadataEntityTypesListItem Source #
Individual item from the list of entity types in the metadata of an entity recognizer.
See: newEntityRecognizerMetadataEntityTypesListItem smart constructor.
Constructors
| EntityRecognizerMetadataEntityTypesListItem' (Maybe EntityTypesEvaluationMetrics) (Maybe Text) (Maybe Int) |
Instances
newEntityRecognizerMetadataEntityTypesListItem :: EntityRecognizerMetadataEntityTypesListItem Source #
Create a value of EntityRecognizerMetadataEntityTypesListItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:evaluationMetrics:EntityRecognizerMetadataEntityTypesListItem', entityRecognizerMetadataEntityTypesListItem_evaluationMetrics - Detailed information about the accuracy of the entity recognizer for a
specific item on the list of entity types.
$sel:type':EntityRecognizerMetadataEntityTypesListItem', entityRecognizerMetadataEntityTypesListItem_type - Type of entity from the list of entity types in the metadata of an
entity recognizer.
$sel:numberOfTrainMentions:EntityRecognizerMetadataEntityTypesListItem', entityRecognizerMetadataEntityTypesListItem_numberOfTrainMentions - Indicates the number of times the given entity type was seen in the
training data.
EntityRecognizerProperties
data EntityRecognizerProperties Source #
Describes information about an entity recognizer.
See: newEntityRecognizerProperties smart constructor.
Constructors
| EntityRecognizerProperties' (Maybe ModelStatus) (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe EntityRecognizerInputDataConfig) (Maybe VpcConfig) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe (Sensitive EntityRecognizerMetadata)) (Maybe Text) (Maybe POSIX) |
Instances
newEntityRecognizerProperties :: EntityRecognizerProperties Source #
Create a value of EntityRecognizerProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:EntityRecognizerProperties', entityRecognizerProperties_status - Provides the status of the entity recognizer.
$sel:languageCode:EntityRecognizerProperties', entityRecognizerProperties_languageCode - The language of the input documents. All documents must be in the same
language. Only English ("en") is currently supported.
$sel:trainingEndTime:EntityRecognizerProperties', entityRecognizerProperties_trainingEndTime - The time that training of the entity recognizer was completed.
$sel:versionName:EntityRecognizerProperties', entityRecognizerProperties_versionName - The version name you assigned to the entity recognizer.
$sel:entityRecognizerArn:EntityRecognizerProperties', entityRecognizerProperties_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.
$sel:modelKmsKeyId:EntityRecognizerProperties', entityRecognizerProperties_modelKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt trained custom models. The ModelKmsKeyId can be either
of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:inputDataConfig:EntityRecognizerProperties', entityRecognizerProperties_inputDataConfig - The input data properties of an entity recognizer.
$sel:vpcConfig:EntityRecognizerProperties', entityRecognizerProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your custom entity
recognizer. For more information, see
Amazon VPC.
$sel:volumeKmsKeyId:EntityRecognizerProperties', entityRecognizerProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:endTime:EntityRecognizerProperties', entityRecognizerProperties_endTime - The time that the recognizer creation completed.
$sel:trainingStartTime:EntityRecognizerProperties', entityRecognizerProperties_trainingStartTime - The time that training of the entity recognizer started.
$sel:dataAccessRoleArn:EntityRecognizerProperties', entityRecognizerProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM)
role that grants Amazon Comprehend read access to your input data.
$sel:recognizerMetadata:EntityRecognizerProperties', entityRecognizerProperties_recognizerMetadata - Provides information about an entity recognizer.
$sel:message:EntityRecognizerProperties', entityRecognizerProperties_message - A description of the status of the recognizer.
$sel:submitTime:EntityRecognizerProperties', entityRecognizerProperties_submitTime - The time that the recognizer was submitted for processing.
EntityRecognizerSummary
data EntityRecognizerSummary Source #
Describes the information about an entity recognizer and its versions.
See: newEntityRecognizerSummary smart constructor.
Constructors
| EntityRecognizerSummary' (Maybe POSIX) (Maybe ModelStatus) (Maybe Int) (Maybe Text) (Maybe Text) |
Instances
newEntityRecognizerSummary :: EntityRecognizerSummary Source #
Create a value of EntityRecognizerSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:latestVersionCreatedAt:EntityRecognizerSummary', entityRecognizerSummary_latestVersionCreatedAt - The time that the latest entity recognizer version was submitted for
processing.
$sel:latestVersionStatus:EntityRecognizerSummary', entityRecognizerSummary_latestVersionStatus - Provides the status of the latest entity recognizer version.
$sel:numberOfVersions:EntityRecognizerSummary', entityRecognizerSummary_numberOfVersions - The number of versions you created.
$sel:latestVersionName:EntityRecognizerSummary', entityRecognizerSummary_latestVersionName - The version name you assigned to the latest entity recognizer version.
$sel:recognizerName:EntityRecognizerSummary', entityRecognizerSummary_recognizerName - The name that you assigned the entity recognizer.
EntityTypesEvaluationMetrics
data EntityTypesEvaluationMetrics Source #
Detailed information about the accuracy of an entity recognizer for a specific entity type.
See: newEntityTypesEvaluationMetrics smart constructor.
Instances
newEntityTypesEvaluationMetrics :: EntityTypesEvaluationMetrics Source #
Create a value of EntityTypesEvaluationMetrics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recall:EntityTypesEvaluationMetrics', entityTypesEvaluationMetrics_recall - A measure of how complete the recognizer results are for a specific
entity type in the test data. High recall means that the recognizer
returned most of the relevant results.
$sel:precision:EntityTypesEvaluationMetrics', entityTypesEvaluationMetrics_precision - A measure of the usefulness of the recognizer results for a specific
entity type in the test data. High precision means that the recognizer
returned substantially more relevant results than irrelevant ones.
$sel:f1Score:EntityTypesEvaluationMetrics', entityTypesEvaluationMetrics_f1Score - A measure of how accurate the recognizer results are for a specific
entity type in the test data. It is derived from the Precision and
Recall values. The F1Score is the harmonic average of the two
scores. The highest score is 1, and the worst score is 0.
EntityTypesListItem
data EntityTypesListItem Source #
An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
See: newEntityTypesListItem smart constructor.
Constructors
| EntityTypesListItem' Text |
Instances
newEntityTypesListItem Source #
Arguments
| :: Text | |
| -> EntityTypesListItem |
Create a value of EntityTypesListItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':EntityTypesListItem', entityTypesListItem_type - An entity type within a labeled training dataset that Amazon Comprehend
uses to train a custom entity recognizer.
Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break, \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).
EventsDetectionJobFilter
data EventsDetectionJobFilter Source #
Provides information for filtering a list of event detection jobs.
See: newEventsDetectionJobFilter smart constructor.
Instances
newEventsDetectionJobFilter :: EventsDetectionJobFilter Source #
Create a value of EventsDetectionJobFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:submitTimeAfter:EventsDetectionJobFilter', eventsDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted after the specified time.
Jobs are returned in descending order, newest to oldest.
$sel:submitTimeBefore:EventsDetectionJobFilter', eventsDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted before the specified time.
Jobs are returned in ascending order, oldest to newest.
$sel:jobName:EventsDetectionJobFilter', eventsDetectionJobFilter_jobName - Filters on the name of the events detection job.
$sel:jobStatus:EventsDetectionJobFilter', eventsDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the
specified status.
EventsDetectionJobProperties
data EventsDetectionJobProperties Source #
Provides information about an events detection job.
See: newEventsDetectionJobProperties smart constructor.
Constructors
| EventsDetectionJobProperties' (Maybe LanguageCode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe InputDataConfig) (Maybe POSIX) (Maybe OutputDataConfig) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe POSIX) |
Instances
newEventsDetectionJobProperties :: EventsDetectionJobProperties Source #
Create a value of EventsDetectionJobProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:languageCode:EventsDetectionJobProperties', eventsDetectionJobProperties_languageCode - The language code of the input documents.
$sel:jobId:EventsDetectionJobProperties', eventsDetectionJobProperties_jobId - The identifier assigned to the events detection job.
$sel:jobArn:EventsDetectionJobProperties', eventsDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the events detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobName:EventsDetectionJobProperties', eventsDetectionJobProperties_jobName - The name you assigned the events detection job.
$sel:targetEventTypes:EventsDetectionJobProperties', eventsDetectionJobProperties_targetEventTypes - The types of events that are detected by the job.
$sel:inputDataConfig:EventsDetectionJobProperties', eventsDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the
events detection job.
$sel:endTime:EventsDetectionJobProperties', eventsDetectionJobProperties_endTime - The time that the events detection job completed.
$sel:outputDataConfig:EventsDetectionJobProperties', eventsDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the
events detection job.
$sel:dataAccessRoleArn:EventsDetectionJobProperties', eventsDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identify and Access Management
(IAM) role that grants Amazon Comprehend read access to your input data.
$sel:jobStatus:EventsDetectionJobProperties', eventsDetectionJobProperties_jobStatus - The current status of the events detection job.
$sel:message:EventsDetectionJobProperties', eventsDetectionJobProperties_message - A description of the status of the events detection job.
$sel:submitTime:EventsDetectionJobProperties', eventsDetectionJobProperties_submitTime - The time that the events detection job was submitted for processing.
InputDataConfig
data InputDataConfig Source #
The input properties for an inference job.
See: newInputDataConfig smart constructor.
Constructors
| InputDataConfig' (Maybe DocumentReaderConfig) (Maybe InputFormat) Text |
Instances
Arguments
| :: Text | |
| -> InputDataConfig |
Create a value of InputDataConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:documentReaderConfig:InputDataConfig', inputDataConfig_documentReaderConfig - The document reader config field applies only for InputDataConfig of
StartEntitiesDetectionJob.
Use DocumentReaderConfig to provide specifications about how you want your inference documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.
$sel:inputFormat:InputDataConfig', inputDataConfig_inputFormat - Specifies how the text in an input file should be processed:
ONE_DOC_PER_FILE- Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.ONE_DOC_PER_LINE- Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
$sel:s3Uri:InputDataConfig', inputDataConfig_s3Uri - The Amazon S3 URI for the input data. The URI must be in same region as
the API endpoint that you are calling. The URI can point to a single
input file or it can provide the prefix for a collection of data files.
For example, if you use the URI S3://bucketName/prefix, if the
prefix is a single file, Amazon Comprehend uses that file as input. If
more than one file begins with the prefix, Amazon Comprehend uses all of
them as input.
KeyPhrase
Describes a key noun phrase.
See: newKeyPhrase smart constructor.
Instances
| Eq KeyPhrase Source # | |
| Read KeyPhrase Source # | |
| Show KeyPhrase Source # | |
| Generic KeyPhrase Source # | |
| NFData KeyPhrase Source # | |
Defined in Amazonka.Comprehend.Types.KeyPhrase | |
| Hashable KeyPhrase Source # | |
Defined in Amazonka.Comprehend.Types.KeyPhrase | |
| FromJSON KeyPhrase Source # | |
| type Rep KeyPhrase Source # | |
Defined in Amazonka.Comprehend.Types.KeyPhrase type Rep KeyPhrase = D1 ('MetaData "KeyPhrase" "Amazonka.Comprehend.Types.KeyPhrase" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "KeyPhrase'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) | |
newKeyPhrase :: KeyPhrase Source #
Create a value of KeyPhrase with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:beginOffset:KeyPhrase', keyPhrase_beginOffset - A character offset in the input text that shows where the key phrase
begins (the first character is at position 0). The offset returns the
position of each UTF-8 code point in the string. A code point is the
abstract character from a particular graphical representation. For
example, a multi-byte UTF-8 character maps to a single code point.
$sel:text:KeyPhrase', keyPhrase_text - The text of a key noun phrase.
$sel:score:KeyPhrase', keyPhrase_score - The level of confidence that Amazon Comprehend has in the accuracy of
the detection.
$sel:endOffset:KeyPhrase', keyPhrase_endOffset - A character offset in the input text where the key phrase ends. The
offset returns the position of each UTF-8 code point in the string. A
code point is the abstract character from a particular graphical
representation. For example, a multi-byte UTF-8 character maps to a
single code point.
KeyPhrasesDetectionJobFilter
data KeyPhrasesDetectionJobFilter Source #
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
See: newKeyPhrasesDetectionJobFilter smart constructor.
Constructors
| KeyPhrasesDetectionJobFilter' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe JobStatus) |
Instances
newKeyPhrasesDetectionJobFilter :: KeyPhrasesDetectionJobFilter Source #
Create a value of KeyPhrasesDetectionJobFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:submitTimeAfter:KeyPhrasesDetectionJobFilter', keyPhrasesDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted after the specified time.
Jobs are returned in descending order, newest to oldest.
$sel:submitTimeBefore:KeyPhrasesDetectionJobFilter', keyPhrasesDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted before the specified time.
Jobs are returned in ascending order, oldest to newest.
$sel:jobName:KeyPhrasesDetectionJobFilter', keyPhrasesDetectionJobFilter_jobName - Filters on the name of the job.
$sel:jobStatus:KeyPhrasesDetectionJobFilter', keyPhrasesDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the
specified status.
KeyPhrasesDetectionJobProperties
data KeyPhrasesDetectionJobProperties Source #
Provides information about a key phrases detection job.
See: newKeyPhrasesDetectionJobProperties smart constructor.
Constructors
| KeyPhrasesDetectionJobProperties' (Maybe LanguageCode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InputDataConfig) (Maybe VpcConfig) (Maybe Text) (Maybe POSIX) (Maybe OutputDataConfig) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe POSIX) |
Instances
newKeyPhrasesDetectionJobProperties :: KeyPhrasesDetectionJobProperties Source #
Create a value of KeyPhrasesDetectionJobProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:languageCode:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_languageCode - The language code of the input documents.
$sel:jobId:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_jobId - The identifier assigned to the key phrases detection job.
$sel:jobArn:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the key phrases detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobName:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_jobName - The name that you assigned the key phrases detection job.
$sel:inputDataConfig:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the key
phrases detection job.
$sel:vpcConfig:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your key phrases detection
job. For more information, see
Amazon VPC.
$sel:volumeKmsKeyId:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:endTime:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_endTime - The time that the key phrases detection job completed.
$sel:outputDataConfig:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the key
phrases detection job.
$sel:dataAccessRoleArn:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access
to your input data.
$sel:jobStatus:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_jobStatus - The current status of the key phrases detection job. If the status is
FAILED, the Message field shows the reason for the failure.
$sel:message:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_message - A description of the status of a job.
$sel:submitTime:KeyPhrasesDetectionJobProperties', keyPhrasesDetectionJobProperties_submitTime - The time that the key phrases detection job was submitted for
processing.
OutputDataConfig
data OutputDataConfig Source #
Provides configuration parameters for the output of topic detection jobs.
See: newOutputDataConfig smart constructor.
Constructors
| OutputDataConfig' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> OutputDataConfig |
Create a value of OutputDataConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKeyId:OutputDataConfig', outputDataConfig_kmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt the output results from an analysis job. The KmsKeyId
can be one of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" - KMS Key Alias:
"alias/ExampleAlias" - ARN of a KMS Key Alias:
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
$sel:s3Uri:OutputDataConfig', outputDataConfig_s3Uri - When you use the OutputDataConfig object with asynchronous operations,
you specify the Amazon S3 location where you want to write the output
data. The URI must be in the same region as the API endpoint that you
are calling. The location is used as the prefix for the actual location
of the output file.
When the topic detection job is finished, the service creates an output
file in a directory specific to the job. The S3Uri field contains the
location of the output file, called output.tar.gz. It is a compressed
archive that contains the ouput of the operation.
PartOfSpeechTag
data PartOfSpeechTag Source #
Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see how-syntax.
See: newPartOfSpeechTag smart constructor.
Constructors
| PartOfSpeechTag' (Maybe PartOfSpeechTagType) (Maybe Double) |
Instances
newPartOfSpeechTag :: PartOfSpeechTag Source #
Create a value of PartOfSpeechTag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tag:PartOfSpeechTag', partOfSpeechTag_tag - Identifies the part of speech that the token represents.
$sel:score:PartOfSpeechTag', partOfSpeechTag_score - The confidence that Amazon Comprehend has that the part of speech was
correctly identified.
PiiEntitiesDetectionJobFilter
data PiiEntitiesDetectionJobFilter Source #
Provides information for filtering a list of PII entity detection jobs.
See: newPiiEntitiesDetectionJobFilter smart constructor.
Constructors
| PiiEntitiesDetectionJobFilter' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe JobStatus) |
Instances
newPiiEntitiesDetectionJobFilter :: PiiEntitiesDetectionJobFilter Source #
Create a value of PiiEntitiesDetectionJobFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:submitTimeAfter:PiiEntitiesDetectionJobFilter', piiEntitiesDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted after the specified time.
Jobs are returned in descending order, newest to oldest.
$sel:submitTimeBefore:PiiEntitiesDetectionJobFilter', piiEntitiesDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted before the specified time.
Jobs are returned in ascending order, oldest to newest.
$sel:jobName:PiiEntitiesDetectionJobFilter', piiEntitiesDetectionJobFilter_jobName - Filters on the name of the job.
$sel:jobStatus:PiiEntitiesDetectionJobFilter', piiEntitiesDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the
specified status.
PiiEntitiesDetectionJobProperties
data PiiEntitiesDetectionJobProperties Source #
Provides information about a PII entities detection job.
See: newPiiEntitiesDetectionJobProperties smart constructor.
Constructors
Instances
newPiiEntitiesDetectionJobProperties :: PiiEntitiesDetectionJobProperties Source #
Create a value of PiiEntitiesDetectionJobProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:languageCode:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_languageCode - The language code of the input documents
$sel:jobId:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobId - The identifier assigned to the PII entities detection job.
$sel:jobArn:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the PII entities detection job. It is
a unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobName:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobName - The name that you assigned the PII entities detection job.
$sel:mode:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_mode - Specifies whether the output provides the locations (offsets) of PII
entities or a file in which PII entities are redacted.
$sel:inputDataConfig:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_inputDataConfig - The input properties for a PII entities detection job.
$sel:redactionConfig:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_redactionConfig - Provides configuration parameters for PII entity redaction.
This parameter is required if you set the Mode parameter to
ONLY_REDACTION. In that case, you must provide a RedactionConfig
definition that includes the PiiEntityTypes parameter.
$sel:endTime:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_endTime - The time that the PII entities detection job completed.
$sel:outputDataConfig:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the PII
entities detection job.
$sel:dataAccessRoleArn:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access
to your input data.
$sel:jobStatus:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobStatus - The current status of the PII entities detection job. If the status is
FAILED, the Message field shows the reason for the failure.
$sel:message:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_message - A description of the status of a job.
$sel:submitTime:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_submitTime - The time that the PII entities detection job was submitted for
processing.
PiiEntity
Provides information about a PII entity.
See: newPiiEntity smart constructor.
Constructors
| PiiEntity' (Maybe Int) (Maybe Double) (Maybe Int) (Maybe PiiEntityType) |
Instances
newPiiEntity :: PiiEntity Source #
Create a value of PiiEntity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:beginOffset:PiiEntity', piiEntity_beginOffset - A character offset in the input text that shows where the PII entity
begins (the first character is at position 0). The offset returns the
position of each UTF-8 code point in the string. A code point is the
abstract character from a particular graphical representation. For
example, a multi-byte UTF-8 character maps to a single code point.
$sel:score:PiiEntity', piiEntity_score - The level of confidence that Amazon Comprehend has in the accuracy of
the detection.
$sel:endOffset:PiiEntity', piiEntity_endOffset - A character offset in the input text that shows where the PII entity
ends. The offset returns the position of each UTF-8 code point in the
string. A code point is the abstract character from a particular
graphical representation. For example, a multi-byte UTF-8 character maps
to a single code point.
$sel:type':PiiEntity', piiEntity_type - The entity's type.
PiiOutputDataConfig
data PiiOutputDataConfig Source #
Provides configuration parameters for the output of PII entity detection jobs.
See: newPiiOutputDataConfig smart constructor.
Constructors
| PiiOutputDataConfig' (Maybe Text) Text |
Instances
newPiiOutputDataConfig Source #
Arguments
| :: Text | |
| -> PiiOutputDataConfig |
Create a value of PiiOutputDataConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKeyId:PiiOutputDataConfig', piiOutputDataConfig_kmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt the output results from an analysis job.
$sel:s3Uri:PiiOutputDataConfig', piiOutputDataConfig_s3Uri - When you use the PiiOutputDataConfig object with asynchronous
operations, you specify the Amazon S3 location where you want to write
the output data.
RedactionConfig
data RedactionConfig Source #
Provides configuration parameters for PII entity redaction.
See: newRedactionConfig smart constructor.
Constructors
| RedactionConfig' (Maybe Text) (Maybe PiiEntitiesDetectionMaskMode) (Maybe [PiiEntityType]) |
Instances
newRedactionConfig :: RedactionConfig Source #
Create a value of RedactionConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maskCharacter:RedactionConfig', redactionConfig_maskCharacter - A character that replaces each character in the redacted PII entity.
$sel:maskMode:RedactionConfig', redactionConfig_maskMode - Specifies whether the PII entity is redacted with the mask character or
the entity type.
$sel:piiEntityTypes:RedactionConfig', redactionConfig_piiEntityTypes - An array of the types of PII entities that Amazon Comprehend detects in
the input text for your request.
SentimentDetectionJobFilter
data SentimentDetectionJobFilter Source #
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
See: newSentimentDetectionJobFilter smart constructor.
Instances
newSentimentDetectionJobFilter :: SentimentDetectionJobFilter Source #
Create a value of SentimentDetectionJobFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:submitTimeAfter:SentimentDetectionJobFilter', sentimentDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted after the specified time.
Jobs are returned in descending order, newest to oldest.
$sel:submitTimeBefore:SentimentDetectionJobFilter', sentimentDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted
for processing. Returns only jobs submitted before the specified time.
Jobs are returned in ascending order, oldest to newest.
$sel:jobName:SentimentDetectionJobFilter', sentimentDetectionJobFilter_jobName - Filters on the name of the job.
$sel:jobStatus:SentimentDetectionJobFilter', sentimentDetectionJobFilter_jobStatus - Filters the list of jobs based on job status. Returns only jobs with the
specified status.
SentimentDetectionJobProperties
data SentimentDetectionJobProperties Source #
Provides information about a sentiment detection job.
See: newSentimentDetectionJobProperties smart constructor.
Constructors
| SentimentDetectionJobProperties' (Maybe LanguageCode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InputDataConfig) (Maybe VpcConfig) (Maybe Text) (Maybe POSIX) (Maybe OutputDataConfig) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe POSIX) |
Instances
newSentimentDetectionJobProperties :: SentimentDetectionJobProperties Source #
Create a value of SentimentDetectionJobProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:languageCode:SentimentDetectionJobProperties', sentimentDetectionJobProperties_languageCode - The language code of the input documents.
$sel:jobId:SentimentDetectionJobProperties', sentimentDetectionJobProperties_jobId - The identifier assigned to the sentiment detection job.
$sel:jobArn:SentimentDetectionJobProperties', sentimentDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the sentiment detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobName:SentimentDetectionJobProperties', sentimentDetectionJobProperties_jobName - The name that you assigned to the sentiment detection job
$sel:inputDataConfig:SentimentDetectionJobProperties', sentimentDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the
sentiment detection job.
$sel:vpcConfig:SentimentDetectionJobProperties', sentimentDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your sentiment detection job.
For more information, see
Amazon VPC.
$sel:volumeKmsKeyId:SentimentDetectionJobProperties', sentimentDetectionJobProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:endTime:SentimentDetectionJobProperties', sentimentDetectionJobProperties_endTime - The time that the sentiment detection job ended.
$sel:outputDataConfig:SentimentDetectionJobProperties', sentimentDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the
sentiment detection job.
$sel:dataAccessRoleArn:SentimentDetectionJobProperties', sentimentDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access
to your input data.
$sel:jobStatus:SentimentDetectionJobProperties', sentimentDetectionJobProperties_jobStatus - The current status of the sentiment detection job. If the status is
FAILED, the Messages field shows the reason for the failure.
$sel:message:SentimentDetectionJobProperties', sentimentDetectionJobProperties_message - A description of the status of a job.
$sel:submitTime:SentimentDetectionJobProperties', sentimentDetectionJobProperties_submitTime - The time that the sentiment detection job was submitted for processing.
SentimentScore
data SentimentScore Source #
Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.
See: newSentimentScore smart constructor.
Instances
newSentimentScore :: SentimentScore Source #
Create a value of SentimentScore with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mixed:SentimentScore', sentimentScore_mixed - The level of confidence that Amazon Comprehend has in the accuracy of
its detection of the MIXED sentiment.
$sel:negative:SentimentScore', sentimentScore_negative - The level of confidence that Amazon Comprehend has in the accuracy of
its detection of the NEGATIVE sentiment.
$sel:neutral:SentimentScore', sentimentScore_neutral - The level of confidence that Amazon Comprehend has in the accuracy of
its detection of the NEUTRAL sentiment.
$sel:positive:SentimentScore', sentimentScore_positive - The level of confidence that Amazon Comprehend has in the accuracy of
its detection of the POSITIVE sentiment.
SyntaxToken
data SyntaxToken Source #
Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.
See: newSyntaxToken smart constructor.
Instances
newSyntaxToken :: SyntaxToken Source #
Create a value of SyntaxToken with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:beginOffset:SyntaxToken', syntaxToken_beginOffset - The zero-based offset from the beginning of the source text to the first
character in the word.
$sel:text:SyntaxToken', syntaxToken_text - The word that was recognized in the source text.
$sel:tokenId:SyntaxToken', syntaxToken_tokenId - A unique identifier for a token.
$sel:endOffset:SyntaxToken', syntaxToken_endOffset - The zero-based offset from the beginning of the source text to the last
character in the word.
$sel:partOfSpeech:SyntaxToken', syntaxToken_partOfSpeech - Provides the part of speech label and the confidence level that Amazon
Comprehend has that the part of speech was correctly identified. For
more information, see how-syntax.
Tag
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
See: newTag smart constructor.
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.Comprehend.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.Comprehend.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.Comprehend.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.Comprehend.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Comprehend.Types.Tag" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Tag', tag_value - The second part of a key-value pair that forms a tag associated with a
given resource. For instance, if you want to show which resources are
used by which departments, you might use “Department” as the initial
(key) portion of the pair, with a value of “sales” to indicate the sales
department.
$sel:key:Tag', tag_key - The initial part of a key-value pair that forms a tag associated with a
given resource. For instance, if you want to show which resources are
used by which departments, you might use “Department” as the key portion
of the pair, with multiple possible values such as “sales,” “legal,” and
“administration.”
TopicsDetectionJobFilter
data TopicsDetectionJobFilter Source #
Provides information for filtering topic detection jobs. For more information, see .
See: newTopicsDetectionJobFilter smart constructor.
Instances
newTopicsDetectionJobFilter :: TopicsDetectionJobFilter Source #
Create a value of TopicsDetectionJobFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:submitTimeAfter:TopicsDetectionJobFilter', topicsDetectionJobFilter_submitTimeAfter - Filters the list of jobs based on the time that the job was submitted
for processing. Only returns jobs submitted after the specified time.
Jobs are returned in ascending order, oldest to newest.
$sel:submitTimeBefore:TopicsDetectionJobFilter', topicsDetectionJobFilter_submitTimeBefore - Filters the list of jobs based on the time that the job was submitted
for processing. Only returns jobs submitted before the specified time.
Jobs are returned in descending order, newest to oldest.
$sel:jobName:TopicsDetectionJobFilter', topicsDetectionJobFilter_jobName -
$sel:jobStatus:TopicsDetectionJobFilter', topicsDetectionJobFilter_jobStatus - Filters the list of topic detection jobs based on job status. Returns
only jobs with the specified status.
TopicsDetectionJobProperties
data TopicsDetectionJobProperties Source #
Provides information about a topic detection job.
See: newTopicsDetectionJobProperties smart constructor.
Constructors
| TopicsDetectionJobProperties' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InputDataConfig) (Maybe VpcConfig) (Maybe Text) (Maybe POSIX) (Maybe OutputDataConfig) (Maybe Text) (Maybe Int) (Maybe JobStatus) (Maybe Text) (Maybe POSIX) |
Instances
newTopicsDetectionJobProperties :: TopicsDetectionJobProperties Source #
Create a value of TopicsDetectionJobProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:TopicsDetectionJobProperties', topicsDetectionJobProperties_jobId - The identifier assigned to the topic detection job.
$sel:jobArn:TopicsDetectionJobProperties', topicsDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the topics detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobName:TopicsDetectionJobProperties', topicsDetectionJobProperties_jobName - The name of the topic detection job.
$sel:inputDataConfig:TopicsDetectionJobProperties', topicsDetectionJobProperties_inputDataConfig - The input data configuration supplied when you created the topic
detection job.
$sel:vpcConfig:TopicsDetectionJobProperties', topicsDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your topic detection job. For
more information, see
Amazon VPC.
$sel:volumeKmsKeyId:TopicsDetectionJobProperties', topicsDetectionJobProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be
either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
$sel:endTime:TopicsDetectionJobProperties', topicsDetectionJobProperties_endTime - The time that the topic detection job was completed.
$sel:outputDataConfig:TopicsDetectionJobProperties', topicsDetectionJobProperties_outputDataConfig - The output data configuration supplied when you created the topic
detection job.
$sel:dataAccessRoleArn:TopicsDetectionJobProperties', topicsDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM)
role that grants Amazon Comprehend read access to your job data.
$sel:numberOfTopics:TopicsDetectionJobProperties', topicsDetectionJobProperties_numberOfTopics - The number of topics to detect supplied when you created the topic
detection job. The default is 10.
$sel:jobStatus:TopicsDetectionJobProperties', topicsDetectionJobProperties_jobStatus - The current status of the topic detection job. If the status is
Failed, the reason for the failure is shown in the Message field.
$sel:message:TopicsDetectionJobProperties', topicsDetectionJobProperties_message - A description for the status of a job.
$sel:submitTime:TopicsDetectionJobProperties', topicsDetectionJobProperties_submitTime - The time that the topic detection job was submitted for processing.
VpcConfig
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.
See: newVpcConfig smart constructor.
Constructors
| VpcConfig' (NonEmpty Text) (NonEmpty Text) |
Instances
| Eq VpcConfig Source # | |
| Read VpcConfig Source # | |
| Show VpcConfig Source # | |
| Generic VpcConfig Source # | |
| NFData VpcConfig Source # | |
Defined in Amazonka.Comprehend.Types.VpcConfig | |
| Hashable VpcConfig Source # | |
Defined in Amazonka.Comprehend.Types.VpcConfig | |
| ToJSON VpcConfig Source # | |
Defined in Amazonka.Comprehend.Types.VpcConfig | |
| FromJSON VpcConfig Source # | |
| type Rep VpcConfig Source # | |
Defined in Amazonka.Comprehend.Types.VpcConfig type Rep VpcConfig = D1 ('MetaData "VpcConfig" "Amazonka.Comprehend.Types.VpcConfig" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "VpcConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: S1 ('MetaSel ('Just "subnets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))) | |
Create a value of VpcConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:securityGroupIds:VpcConfig', vpcConfig_securityGroupIds - The ID number for a security group on an instance of your private VPC.
Security groups on your VPC function serve as a virtual firewall to
control inbound and outbound traffic and provides security for the
resources that you’ll be accessing on the VPC. This ID number is
preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more
information, see
Security Groups for your VPC.
$sel:subnets:VpcConfig', vpcConfig_subnets - The ID for each subnet being used in your private VPC. This subnet is a
subset of the a range of IPv4 addresses used by the VPC and is specific
to a given availability zone in the VPC’s region. This ID number is
preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For
more information, see
VPCs and Subnets.