Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- EntityType
- InputFormat
- JobStatus
- LanguageCode
- SentimentType
- BatchDetectDominantLanguageItemResult
- BatchDetectEntitiesItemResult
- BatchDetectKeyPhrasesItemResult
- BatchDetectSentimentItemResult
- BatchItemError
- DominantLanguage
- Entity
- InputDataConfig
- KeyPhrase
- OutputDataConfig
- SentimentScore
- TopicsDetectionJobFilter
- TopicsDetectionJobProperties
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
- comprehend :: Service
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: 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
- _InvalidFilterException :: AsError a => Getting (First ServiceError) a ServiceError
- _TextSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.Comprehend.BatchDetectSentiment
- module Network.AWS.Comprehend.StartTopicsDetectionJob
- module Network.AWS.Comprehend.BatchDetectKeyPhrases
- module Network.AWS.Comprehend.DetectSentiment
- module Network.AWS.Comprehend.BatchDetectEntities
- module Network.AWS.Comprehend.DetectDominantLanguage
- module Network.AWS.Comprehend.DescribeTopicsDetectionJob
- module Network.AWS.Comprehend.DetectEntities
- module Network.AWS.Comprehend.ListTopicsDetectionJobs
- module Network.AWS.Comprehend.BatchDetectDominantLanguage
- module Network.AWS.Comprehend.DetectKeyPhrases
- data EntityType
- = CommercialItem
- | Date
- | Event
- | Location
- | Organization
- | Other
- | Person
- | Quantity
- | Title
- data InputFormat
- data JobStatus
- data LanguageCode
- data SentimentType
- data BatchDetectDominantLanguageItemResult
- batchDetectDominantLanguageItemResult :: BatchDetectDominantLanguageItemResult
- bddlirLanguages :: Lens' BatchDetectDominantLanguageItemResult [DominantLanguage]
- bddlirIndex :: Lens' BatchDetectDominantLanguageItemResult (Maybe Int)
- data BatchDetectEntitiesItemResult
- batchDetectEntitiesItemResult :: BatchDetectEntitiesItemResult
- bdeirEntities :: Lens' BatchDetectEntitiesItemResult [Entity]
- bdeirIndex :: Lens' BatchDetectEntitiesItemResult (Maybe Int)
- data BatchDetectKeyPhrasesItemResult
- batchDetectKeyPhrasesItemResult :: BatchDetectKeyPhrasesItemResult
- bdkpirIndex :: Lens' BatchDetectKeyPhrasesItemResult (Maybe Int)
- bdkpirKeyPhrases :: Lens' BatchDetectKeyPhrasesItemResult [KeyPhrase]
- data BatchDetectSentimentItemResult
- batchDetectSentimentItemResult :: BatchDetectSentimentItemResult
- bdsirSentiment :: Lens' BatchDetectSentimentItemResult (Maybe SentimentType)
- bdsirSentimentScore :: Lens' BatchDetectSentimentItemResult (Maybe SentimentScore)
- bdsirIndex :: Lens' BatchDetectSentimentItemResult (Maybe Int)
- data BatchItemError
- batchItemError :: BatchItemError
- bieErrorCode :: Lens' BatchItemError (Maybe Text)
- bieErrorMessage :: Lens' BatchItemError (Maybe Text)
- bieIndex :: Lens' BatchItemError (Maybe Int)
- data DominantLanguage
- dominantLanguage :: DominantLanguage
- dlLanguageCode :: Lens' DominantLanguage (Maybe Text)
- dlScore :: Lens' DominantLanguage (Maybe Double)
- data Entity
- entity :: Entity
- eBeginOffset :: Lens' Entity (Maybe Int)
- eText :: Lens' Entity (Maybe Text)
- eScore :: Lens' Entity (Maybe Double)
- eEndOffset :: Lens' Entity (Maybe Int)
- eType :: Lens' Entity (Maybe EntityType)
- data InputDataConfig
- inputDataConfig :: Text -> InputDataConfig
- idcInputFormat :: Lens' InputDataConfig (Maybe InputFormat)
- idcS3URI :: Lens' InputDataConfig Text
- data KeyPhrase
- keyPhrase :: KeyPhrase
- kpBeginOffset :: Lens' KeyPhrase (Maybe Int)
- kpText :: Lens' KeyPhrase (Maybe Text)
- kpScore :: Lens' KeyPhrase (Maybe Double)
- kpEndOffset :: Lens' KeyPhrase (Maybe Int)
- data OutputDataConfig
- outputDataConfig :: Text -> OutputDataConfig
- odcS3URI :: Lens' OutputDataConfig Text
- data SentimentScore
- sentimentScore :: SentimentScore
- ssMixed :: Lens' SentimentScore (Maybe Double)
- ssNegative :: Lens' SentimentScore (Maybe Double)
- ssNeutral :: Lens' SentimentScore (Maybe Double)
- ssPositive :: Lens' SentimentScore (Maybe Double)
- data TopicsDetectionJobFilter
- topicsDetectionJobFilter :: TopicsDetectionJobFilter
- tdjfSubmitTimeAfter :: Lens' TopicsDetectionJobFilter (Maybe UTCTime)
- tdjfSubmitTimeBefore :: Lens' TopicsDetectionJobFilter (Maybe UTCTime)
- tdjfJobName :: Lens' TopicsDetectionJobFilter (Maybe Text)
- tdjfJobStatus :: Lens' TopicsDetectionJobFilter (Maybe JobStatus)
- data TopicsDetectionJobProperties
- topicsDetectionJobProperties :: TopicsDetectionJobProperties
- tdjpJobId :: Lens' TopicsDetectionJobProperties (Maybe Text)
- tdjpJobName :: Lens' TopicsDetectionJobProperties (Maybe Text)
- tdjpInputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe InputDataConfig)
- tdjpEndTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime)
- tdjpOutputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe OutputDataConfig)
- tdjpNumberOfTopics :: Lens' TopicsDetectionJobProperties (Maybe Int)
- tdjpJobStatus :: Lens' TopicsDetectionJobProperties (Maybe JobStatus)
- tdjpMessage :: Lens' TopicsDetectionJobProperties (Maybe Text)
- tdjpSubmitTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime)
Service Configuration
comprehend :: 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
.
InvalidRequestException
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request is invalid.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of requests exceeds the limit. Resubmit your request later.
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 all APIs except DetectDominantLanguage
, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage
API, Amazon Comprehend detects 100 languages. For a list of languages, see 'how-languages'
JobNotFoundException
_JobNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified job was not found. Check the job ID and try again.
InvalidFilterException
_InvalidFilterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The filter specified for the ListTopicDetectionJobs
operation is invalid. Specify a different filter.
TextSizeLimitExceededException
_TextSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The size of the input text exceeds the limit. Use a smaller document.
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
StartTopicsDetectionJob
BatchDetectKeyPhrases
DetectSentiment
BatchDetectEntities
DetectDominantLanguage
DescribeTopicsDetectionJob
DetectEntities
ListTopicsDetectionJobs (Paginated)
BatchDetectDominantLanguage
DetectKeyPhrases
Types
EntityType
data EntityType Source #
Instances
InputFormat
data InputFormat Source #
Instances
JobStatus
Instances
LanguageCode
data LanguageCode Source #
Instances
SentimentType
data SentimentType Source #
Instances
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: batchDetectDominantLanguageItemResult
smart constructor.
Instances
batchDetectDominantLanguageItemResult :: BatchDetectDominantLanguageItemResult Source #
Creates a value of BatchDetectDominantLanguageItemResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bddlirLanguages
- One or moreDominantLanguage
objects describing the dominant languages in the document.bddlirIndex
- The zero-based index of the document in the input list.
bddlirLanguages :: Lens' BatchDetectDominantLanguageItemResult [DominantLanguage] Source #
One or more DominantLanguage
objects describing the dominant languages in the document.
bddlirIndex :: Lens' BatchDetectDominantLanguageItemResult (Maybe Int) Source #
The zero-based index of the document in the input list.
BatchDetectEntitiesItemResult
data BatchDetectEntitiesItemResult Source #
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
See: batchDetectEntitiesItemResult
smart constructor.
Instances
batchDetectEntitiesItemResult :: BatchDetectEntitiesItemResult Source #
Creates a value of BatchDetectEntitiesItemResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdeirEntities
- One or moreEntity
objects, one for each entity detected in the document.bdeirIndex
- The zero-based index of the document in the input list.
bdeirEntities :: Lens' BatchDetectEntitiesItemResult [Entity] Source #
One or more Entity
objects, one for each entity detected in the document.
bdeirIndex :: Lens' BatchDetectEntitiesItemResult (Maybe Int) Source #
The zero-based index of the document in the input list.
BatchDetectKeyPhrasesItemResult
data BatchDetectKeyPhrasesItemResult Source #
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
See: batchDetectKeyPhrasesItemResult
smart constructor.
Instances
batchDetectKeyPhrasesItemResult :: BatchDetectKeyPhrasesItemResult Source #
Creates a value of BatchDetectKeyPhrasesItemResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdkpirIndex
- The zero-based index of the document in the input list.bdkpirKeyPhrases
- One or moreKeyPhrase
objects, one for each key phrase detected in the document.
bdkpirIndex :: Lens' BatchDetectKeyPhrasesItemResult (Maybe Int) Source #
The zero-based index of the document in the input list.
bdkpirKeyPhrases :: Lens' BatchDetectKeyPhrasesItemResult [KeyPhrase] Source #
One or more KeyPhrase
objects, one for each key phrase detected in the document.
BatchDetectSentimentItemResult
data BatchDetectSentimentItemResult Source #
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
See: batchDetectSentimentItemResult
smart constructor.
Instances
batchDetectSentimentItemResult :: BatchDetectSentimentItemResult Source #
Creates a value of BatchDetectSentimentItemResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdsirSentiment
- The sentiment detected in the document.bdsirSentimentScore
- The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.bdsirIndex
- The zero-based index of the document in the input list.
bdsirSentiment :: Lens' BatchDetectSentimentItemResult (Maybe SentimentType) Source #
The sentiment detected in the document.
bdsirSentimentScore :: Lens' BatchDetectSentimentItemResult (Maybe SentimentScore) Source #
The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.
bdsirIndex :: Lens' BatchDetectSentimentItemResult (Maybe Int) Source #
The zero-based index of the document in the input list.
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: batchItemError
smart constructor.
Instances
batchItemError :: BatchItemError Source #
Creates a value of BatchItemError
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bieErrorCode
- The numeric error code of the error.bieErrorMessage
- A text description of the error.bieIndex
- The zero-based index of the document in the input list.
bieErrorCode :: Lens' BatchItemError (Maybe Text) Source #
The numeric error code of the error.
bieErrorMessage :: Lens' BatchItemError (Maybe Text) Source #
A text description of the error.
bieIndex :: Lens' BatchItemError (Maybe Int) Source #
The zero-based index of the document in the input list.
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: dominantLanguage
smart constructor.
Instances
dominantLanguage :: DominantLanguage Source #
Creates a value of DominantLanguage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dlLanguageCode
- The RFC 5646 language code for the dominant language.dlScore
- The level of confidence that Amazon Comprehend has in the accuracy of the detection.
dlLanguageCode :: Lens' DominantLanguage (Maybe Text) Source #
The RFC 5646 language code for the dominant language.
dlScore :: Lens' DominantLanguage (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
Entity
Provides information about an entity.
See: entity
smart constructor.
Instances
Creates a value of Entity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eBeginOffset
- 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.eText
- The text of the entity.eScore
- The level of confidence that Amazon Comprehend has in the accuracy of the detection.eEndOffset
- 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.eType
- The entity's type.
eBeginOffset :: Lens' Entity (Maybe Int) Source #
A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
eScore :: Lens' Entity (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
eEndOffset :: Lens' Entity (Maybe Int) Source #
A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
InputDataConfig
data InputDataConfig Source #
The input properties for a topic detection job.
See: inputDataConfig
smart constructor.
Instances
Creates a value of InputDataConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
idcInputFormat
- 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.idcS3URI
- 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 URIS3:/bucketNameprefix
, 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.
idcInputFormat :: Lens' InputDataConfig (Maybe InputFormat) Source #
Specifies how the text in an input file should be processed: * ONE_DOC_PER_FILE
- Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. * ONE_DOC_PER_LINE
- Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
idcS3URI :: Lens' InputDataConfig Text Source #
The Amazon S3 URI for the input data. The URI must be in same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files. For example, if you use the URI S3:/bucketNameprefix
, 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: keyPhrase
smart constructor.
Instances
keyPhrase :: KeyPhrase Source #
Creates a value of KeyPhrase
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
kpBeginOffset
- 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.kpText
- The text of a key noun phrase.kpScore
- The level of confidence that Amazon Comprehend has in the accuracy of the detection.kpEndOffset
- 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. Acode point
is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
kpBeginOffset :: Lens' KeyPhrase (Maybe Int) Source #
A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
kpScore :: Lens' KeyPhrase (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
kpEndOffset :: Lens' KeyPhrase (Maybe Int) Source #
A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point
is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
OutputDataConfig
data OutputDataConfig Source #
Provides configuration parameters for the output of topic detection jobs.
See: outputDataConfig
smart constructor.
Instances
Creates a value of OutputDataConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
odcS3URI
- The Amazon S3 URI 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 service creates an output file calledoutput.tar.gz
. It is a compressed archive that contains two files,topic-terms.csv
that lists the terms associated with each topic, anddoc-topics.csv
that lists the documents associated with each topic. For more information, see 'topic-modeling' .
odcS3URI :: Lens' OutputDataConfig Text Source #
The Amazon S3 URI 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 service creates an output file called output.tar.gz
. It is a compressed archive that contains 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. For more information, see 'topic-modeling' .
SentimentScore
data SentimentScore Source #
Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.
See: sentimentScore
smart constructor.
Instances
sentimentScore :: SentimentScore Source #
Creates a value of SentimentScore
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssMixed
- The level of confidence that Amazon Comprehend has in the accuracy of its detection of theMIXED
sentiment.ssNegative
- The level of confidence that Amazon Comprehend has in the accuracy of its detection of theNEGATIVE
sentiment.ssNeutral
- The level of confidence that Amazon Comprehend has in the accuracy of its detection of theNEUTRAL
sentiment.ssPositive
- The level of confidence that Amazon Comprehend has in the accuracy of its detection of thePOSITIVE
sentiment.
ssMixed :: Lens' SentimentScore (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED
sentiment.
ssNegative :: Lens' SentimentScore (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE
sentiment.
ssNeutral :: Lens' SentimentScore (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL
sentiment.
ssPositive :: Lens' SentimentScore (Maybe Double) Source #
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE
sentiment.
TopicsDetectionJobFilter
data TopicsDetectionJobFilter Source #
Provides information for filtering topic detection jobs. For more information, see .
See: topicsDetectionJobFilter
smart constructor.
Instances
topicsDetectionJobFilter :: TopicsDetectionJobFilter Source #
Creates a value of TopicsDetectionJobFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tdjfSubmitTimeAfter
- 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.tdjfSubmitTimeBefore
- 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.tdjfJobName
-tdjfJobStatus
- Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.
tdjfSubmitTimeAfter :: Lens' TopicsDetectionJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.
tdjfSubmitTimeBefore :: Lens' TopicsDetectionJobFilter (Maybe UTCTime) Source #
Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.
tdjfJobStatus :: Lens' TopicsDetectionJobFilter (Maybe JobStatus) Source #
Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.
TopicsDetectionJobProperties
data TopicsDetectionJobProperties Source #
Provides information about a topic detection job.
See: topicsDetectionJobProperties
smart constructor.
Instances
topicsDetectionJobProperties :: TopicsDetectionJobProperties Source #
Creates a value of TopicsDetectionJobProperties
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tdjpJobId
- The identifier assigned to the topic detection job.tdjpJobName
- The name of the topic detection job.tdjpInputDataConfig
- The input data configuration supplied when you created the topic detection job.tdjpEndTime
- The time that the topic detection job was completed.tdjpOutputDataConfig
- The output data configuration supplied when you created the topic detection job.tdjpNumberOfTopics
- The number of topics to detect supplied when you created the topic detection job. The default is 10.tdjpJobStatus
- The current status of the topic detection job. If the status isFailed
, the reason for the failure is shown in theMessage
field.tdjpMessage
- A description for the status of a job.tdjpSubmitTime
- The time that the topic detection job was submitted for processing.
tdjpJobId :: Lens' TopicsDetectionJobProperties (Maybe Text) Source #
The identifier assigned to the topic detection job.
tdjpJobName :: Lens' TopicsDetectionJobProperties (Maybe Text) Source #
The name of the topic detection job.
tdjpInputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe InputDataConfig) Source #
The input data configuration supplied when you created the topic detection job.
tdjpEndTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime) Source #
The time that the topic detection job was completed.
tdjpOutputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe OutputDataConfig) Source #
The output data configuration supplied when you created the topic detection job.
tdjpNumberOfTopics :: Lens' TopicsDetectionJobProperties (Maybe Int) Source #
The number of topics to detect supplied when you created the topic detection job. The default is 10.
tdjpJobStatus :: Lens' TopicsDetectionJobProperties (Maybe JobStatus) Source #
The current status of the topic detection job. If the status is Failed
, the reason for the failure is shown in the Message
field.
tdjpMessage :: Lens' TopicsDetectionJobProperties (Maybe Text) Source #
A description for the status of a job.
tdjpSubmitTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime) Source #
The time that the topic detection job was submitted for processing.