Skip to content

Latest commit

 

History

History

amazonaws_comprehend

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
index.js
index.js
 
 
openapi.json
openapi.json
 
 
package.json
package.json
 
 

README.md

@datafire/amazonaws_comprehend

Client library for Amazon Comprehend

Installation and Usage

npm install --save @datafire/amazonaws_comprehend
let amazonaws_comprehend = require('@datafire/amazonaws_comprehend').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

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.

Actions

BatchDetectDominantLanguage

amazonaws_comprehend.BatchDetectDominantLanguage({
  "TextList": null
}, context)

Input

Output

BatchDetectEntities

amazonaws_comprehend.BatchDetectEntities({
  "TextList": null,
  "LanguageCode": null
}, context)

Input

Output

BatchDetectKeyPhrases

amazonaws_comprehend.BatchDetectKeyPhrases({
  "TextList": null,
  "LanguageCode": null
}, context)

Input

Output

BatchDetectSentiment

amazonaws_comprehend.BatchDetectSentiment({
  "TextList": null,
  "LanguageCode": null
}, context)

Input

Output

BatchDetectSyntax

amazonaws_comprehend.BatchDetectSyntax({
  "TextList": null,
  "LanguageCode": null
}, context)

Input

Output

ClassifyDocument

amazonaws_comprehend.ClassifyDocument({
  "Text": null,
  "EndpointArn": null
}, context)

Input

  • input object
    • EndpointArn required
    • Text required

Output

CreateDocumentClassifier

amazonaws_comprehend.CreateDocumentClassifier({
  "DocumentClassifierName": null,
  "DataAccessRoleArn": null,
  "InputDataConfig": null,
  "LanguageCode": null
}, context)

Input

  • input object
    • ClientRequestToken
    • DataAccessRoleArn required
    • DocumentClassifierName required
    • InputDataConfig required
    • LanguageCode required
    • Mode
    • OutputDataConfig
      • KmsKeyId
      • S3Uri
    • Tags
    • VolumeKmsKeyId
    • VpcConfig

Output

CreateEndpoint

amazonaws_comprehend.CreateEndpoint({
  "EndpointName": null,
  "ModelArn": null,
  "DesiredInferenceUnits": null
}, context)

Input

  • input object
    • ClientRequestToken
    • DesiredInferenceUnits required
    • EndpointName required
    • ModelArn required
    • Tags

Output

CreateEntityRecognizer

amazonaws_comprehend.CreateEntityRecognizer({
  "RecognizerName": null,
  "DataAccessRoleArn": null,
  "InputDataConfig": null,
  "LanguageCode": null
}, context)

Input

  • input object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
    • LanguageCode required
    • RecognizerName required
    • Tags
    • VolumeKmsKeyId
    • VpcConfig

Output

DeleteDocumentClassifier

amazonaws_comprehend.DeleteDocumentClassifier({
  "DocumentClassifierArn": null
}, context)

Input

  • input object
    • DocumentClassifierArn required

Output

DeleteEndpoint

amazonaws_comprehend.DeleteEndpoint({
  "EndpointArn": null
}, context)

Input

  • input object
    • EndpointArn required

Output

DeleteEntityRecognizer

amazonaws_comprehend.DeleteEntityRecognizer({
  "EntityRecognizerArn": null
}, context)

Input

  • input object
    • EntityRecognizerArn required

Output

DescribeDocumentClassificationJob

amazonaws_comprehend.DescribeDocumentClassificationJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

DescribeDocumentClassifier

amazonaws_comprehend.DescribeDocumentClassifier({
  "DocumentClassifierArn": null
}, context)

Input

  • input object
    • DocumentClassifierArn required

Output

DescribeDominantLanguageDetectionJob

amazonaws_comprehend.DescribeDominantLanguageDetectionJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

DescribeEndpoint

amazonaws_comprehend.DescribeEndpoint({
  "EndpointArn": null
}, context)

Input

  • input object
    • EndpointArn required

Output

DescribeEntitiesDetectionJob

amazonaws_comprehend.DescribeEntitiesDetectionJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

DescribeEntityRecognizer

amazonaws_comprehend.DescribeEntityRecognizer({
  "EntityRecognizerArn": null
}, context)

Input

  • input object
    • EntityRecognizerArn required

Output

DescribeEventsDetectionJob

amazonaws_comprehend.DescribeEventsDetectionJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

DescribeKeyPhrasesDetectionJob

amazonaws_comprehend.DescribeKeyPhrasesDetectionJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

DescribePiiEntitiesDetectionJob

amazonaws_comprehend.DescribePiiEntitiesDetectionJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

DescribeSentimentDetectionJob

amazonaws_comprehend.DescribeSentimentDetectionJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

DescribeTopicsDetectionJob

amazonaws_comprehend.DescribeTopicsDetectionJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

DetectDominantLanguage

amazonaws_comprehend.DetectDominantLanguage({
  "Text": null
}, context)

Input

  • input object
    • Text required

Output

DetectEntities

amazonaws_comprehend.DetectEntities({
  "Text": null
}, context)

Input

  • input object
    • EndpointArn
    • LanguageCode
    • Text required

Output

DetectKeyPhrases

amazonaws_comprehend.DetectKeyPhrases({
  "Text": null,
  "LanguageCode": null
}, context)

Input

  • input object
    • LanguageCode required
    • Text required

Output

DetectPiiEntities

amazonaws_comprehend.DetectPiiEntities({
  "Text": null,
  "LanguageCode": null
}, context)

Input

  • input object
    • LanguageCode required
    • Text required

Output

DetectSentiment

amazonaws_comprehend.DetectSentiment({
  "Text": null,
  "LanguageCode": null
}, context)

Input

  • input object
    • LanguageCode required
    • Text required

Output

DetectSyntax

amazonaws_comprehend.DetectSyntax({
  "Text": null,
  "LanguageCode": null
}, context)

Input

  • input object
    • LanguageCode required
    • Text required

Output

ListDocumentClassificationJobs

amazonaws_comprehend.ListDocumentClassificationJobs({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

Output

ListDocumentClassifiers

amazonaws_comprehend.ListDocumentClassifiers({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filter
      • Status
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

Output

ListDominantLanguageDetectionJobs

amazonaws_comprehend.ListDominantLanguageDetectionJobs({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

Output

ListEndpoints

amazonaws_comprehend.ListEndpoints({}, context)

Input

  • input object
    • Filter
      • CreationTimeAfter
      • CreationTimeBefore
      • ModelArn
      • Status
    • MaxResults
    • NextToken

Output

ListEntitiesDetectionJobs

amazonaws_comprehend.ListEntitiesDetectionJobs({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

Output

ListEntityRecognizers

amazonaws_comprehend.ListEntityRecognizers({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filter
      • Status
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

Output

ListEventsDetectionJobs

amazonaws_comprehend.ListEventsDetectionJobs({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

Output

ListKeyPhrasesDetectionJobs

amazonaws_comprehend.ListKeyPhrasesDetectionJobs({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

Output

ListPiiEntitiesDetectionJobs

amazonaws_comprehend.ListPiiEntitiesDetectionJobs({}, context)

Input

  • input object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

Output

ListSentimentDetectionJobs

amazonaws_comprehend.ListSentimentDetectionJobs({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

Output

ListTagsForResource

amazonaws_comprehend.ListTagsForResource({
  "ResourceArn": null
}, context)

Input

  • input object
    • ResourceArn required

Output

ListTopicsDetectionJobs

amazonaws_comprehend.ListTopicsDetectionJobs({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

Output

StartDocumentClassificationJob

amazonaws_comprehend.StartDocumentClassificationJob({
  "DocumentClassifierArn": null,
  "InputDataConfig": null,
  "OutputDataConfig": null,
  "DataAccessRoleArn": null
}, context)

Input

  • input object
    • ClientRequestToken
    • DataAccessRoleArn required
    • DocumentClassifierArn required
    • InputDataConfig required
      • InputFormat
      • S3Uri required
    • JobName
    • OutputDataConfig required
      • KmsKeyId
      • S3Uri required
    • VolumeKmsKeyId
    • VpcConfig

Output

StartDominantLanguageDetectionJob

amazonaws_comprehend.StartDominantLanguageDetectionJob({
  "InputDataConfig": null,
  "OutputDataConfig": null,
  "DataAccessRoleArn": null
}, context)

Input

  • input object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • InputFormat
      • S3Uri required
    • JobName
    • OutputDataConfig required
      • KmsKeyId
      • S3Uri required
    • VolumeKmsKeyId
    • VpcConfig

Output

StartEntitiesDetectionJob

amazonaws_comprehend.StartEntitiesDetectionJob({
  "InputDataConfig": null,
  "OutputDataConfig": null,
  "DataAccessRoleArn": null,
  "LanguageCode": null
}, context)

Input

  • input object
    • ClientRequestToken
    • DataAccessRoleArn required
    • EntityRecognizerArn
    • InputDataConfig required
      • InputFormat
      • S3Uri required
    • JobName
    • LanguageCode required
    • OutputDataConfig required
      • KmsKeyId
      • S3Uri required
    • VolumeKmsKeyId
    • VpcConfig

Output

StartEventsDetectionJob

amazonaws_comprehend.StartEventsDetectionJob({
  "InputDataConfig": null,
  "OutputDataConfig": null,
  "DataAccessRoleArn": null,
  "LanguageCode": null,
  "TargetEventTypes": null
}, context)

Input

  • input object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • InputFormat
      • S3Uri required
    • JobName
    • LanguageCode required
    • OutputDataConfig required
      • KmsKeyId
      • S3Uri required
    • TargetEventTypes required

Output

StartKeyPhrasesDetectionJob

amazonaws_comprehend.StartKeyPhrasesDetectionJob({
  "InputDataConfig": null,
  "OutputDataConfig": null,
  "DataAccessRoleArn": null,
  "LanguageCode": null
}, context)

Input

  • input object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • InputFormat
      • S3Uri required
    • JobName
    • LanguageCode required
    • OutputDataConfig required
      • KmsKeyId
      • S3Uri required
    • VolumeKmsKeyId
    • VpcConfig

Output

StartPiiEntitiesDetectionJob

amazonaws_comprehend.StartPiiEntitiesDetectionJob({
  "InputDataConfig": null,
  "OutputDataConfig": null,
  "Mode": null,
  "DataAccessRoleArn": null,
  "LanguageCode": null
}, context)

Input

  • input object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • InputFormat
      • S3Uri required
    • JobName
    • LanguageCode required
    • Mode required
    • OutputDataConfig required
      • KmsKeyId
      • S3Uri required
    • RedactionConfig

Output

StartSentimentDetectionJob

amazonaws_comprehend.StartSentimentDetectionJob({
  "InputDataConfig": null,
  "OutputDataConfig": null,
  "DataAccessRoleArn": null,
  "LanguageCode": null
}, context)

Input

  • input object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • InputFormat
      • S3Uri required
    • JobName
    • LanguageCode required
    • OutputDataConfig required
      • KmsKeyId
      • S3Uri required
    • VolumeKmsKeyId
    • VpcConfig

Output

StartTopicsDetectionJob

amazonaws_comprehend.StartTopicsDetectionJob({
  "InputDataConfig": null,
  "OutputDataConfig": null,
  "DataAccessRoleArn": null
}, context)

Input

  • input object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • InputFormat
      • S3Uri required
    • JobName
    • NumberOfTopics
    • OutputDataConfig required
      • KmsKeyId
      • S3Uri required
    • VolumeKmsKeyId
    • VpcConfig

Output

StopDominantLanguageDetectionJob

amazonaws_comprehend.StopDominantLanguageDetectionJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

StopEntitiesDetectionJob

amazonaws_comprehend.StopEntitiesDetectionJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

StopEventsDetectionJob

amazonaws_comprehend.StopEventsDetectionJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

StopKeyPhrasesDetectionJob

amazonaws_comprehend.StopKeyPhrasesDetectionJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

StopPiiEntitiesDetectionJob

amazonaws_comprehend.StopPiiEntitiesDetectionJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

StopSentimentDetectionJob

amazonaws_comprehend.StopSentimentDetectionJob({
  "JobId": null
}, context)

Input

  • input object
    • JobId required

Output

StopTrainingDocumentClassifier

amazonaws_comprehend.StopTrainingDocumentClassifier({
  "DocumentClassifierArn": null
}, context)

Input

  • input object
    • DocumentClassifierArn required

Output

StopTrainingEntityRecognizer

amazonaws_comprehend.StopTrainingEntityRecognizer({
  "EntityRecognizerArn": null
}, context)

Input

  • input object
    • EntityRecognizerArn required

Output

TagResource

amazonaws_comprehend.TagResource({
  "ResourceArn": null,
  "Tags": null
}, context)

Input

  • input object
    • ResourceArn required
    • Tags required

Output

UntagResource

amazonaws_comprehend.UntagResource({
  "ResourceArn": null,
  "TagKeys": null
}, context)

Input

  • input object
    • ResourceArn required
    • TagKeys required

Output

UpdateEndpoint

amazonaws_comprehend.UpdateEndpoint({
  "EndpointArn": null,
  "DesiredInferenceUnits": null
}, context)

Input

  • input object
    • DesiredInferenceUnits required
    • EndpointArn required

Output

Definitions

AnyLengthString

  • AnyLengthString string

AttributeNamesList

AttributeNamesListItem

  • AttributeNamesListItem string

AugmentedManifestsListItem

  • AugmentedManifestsListItem object: 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.

BatchDetectDominantLanguageItemResult

  • BatchDetectDominantLanguageItemResult object: The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

BatchDetectDominantLanguageRequest

BatchDetectDominantLanguageResponse

BatchDetectEntitiesItemResult

  • BatchDetectEntitiesItemResult object: The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

BatchDetectEntitiesRequest

  • BatchDetectEntitiesRequest object

BatchDetectEntitiesResponse

BatchDetectKeyPhrasesItemResult

  • BatchDetectKeyPhrasesItemResult object: The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

BatchDetectKeyPhrasesRequest

  • BatchDetectKeyPhrasesRequest object

BatchDetectKeyPhrasesResponse

BatchDetectSentimentItemResult

  • BatchDetectSentimentItemResult object: The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
    • Index
    • Sentiment
    • SentimentScore
      • Mixed
      • Negative
      • Neutral
      • Positive

BatchDetectSentimentRequest

  • BatchDetectSentimentRequest object

BatchDetectSentimentResponse

BatchDetectSyntaxItemResult

  • BatchDetectSyntaxItemResult object: The result of calling the operation. The operation returns one object that is successfully processed by the operation.

BatchDetectSyntaxRequest

  • BatchDetectSyntaxRequest object

BatchDetectSyntaxResponse

BatchItemError

  • BatchItemError object: 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.
    • ErrorCode
    • ErrorMessage
    • Index

BatchItemErrorList

BatchSizeLimitExceededException

ClassifierEvaluationMetrics

  • ClassifierEvaluationMetrics object: Describes the result metrics for the test data associated with an documentation classifier.
    • Accuracy
    • F1Score
    • HammingLoss
    • MicroF1Score
    • MicroPrecision
    • MicroRecall
    • Precision
    • Recall

ClassifierMetadata

  • ClassifierMetadata object: Provides information about a document classifier.
    • EvaluationMetrics
      • Accuracy
      • F1Score
      • HammingLoss
      • MicroF1Score
      • MicroPrecision
      • MicroRecall
      • Precision
      • Recall
    • NumberOfLabels
    • NumberOfTestDocuments
    • NumberOfTrainedDocuments

ClassifyDocumentRequest

  • ClassifyDocumentRequest object
    • EndpointArn required
    • Text required

ClassifyDocumentResponse

ClientRequestTokenString

  • ClientRequestTokenString string

ComprehendArn

  • ComprehendArn string

ComprehendArnName

  • ComprehendArnName string

ComprehendEndpointArn

  • ComprehendEndpointArn string

ComprehendEndpointName

  • ComprehendEndpointName string

ComprehendModelArn

  • ComprehendModelArn string

ConcurrentModificationException

CreateDocumentClassifierRequest

  • CreateDocumentClassifierRequest object
    • ClientRequestToken
    • DataAccessRoleArn required
    • DocumentClassifierName required
    • InputDataConfig required
    • LanguageCode required
    • Mode
    • OutputDataConfig
      • KmsKeyId
      • S3Uri
    • Tags
    • VolumeKmsKeyId
    • VpcConfig

CreateDocumentClassifierResponse

  • CreateDocumentClassifierResponse object
    • DocumentClassifierArn

CreateEndpointRequest

  • CreateEndpointRequest object
    • ClientRequestToken
    • DesiredInferenceUnits required
    • EndpointName required
    • ModelArn required
    • Tags

CreateEndpointResponse

  • CreateEndpointResponse object
    • EndpointArn

CreateEntityRecognizerRequest

  • CreateEntityRecognizerRequest object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
    • LanguageCode required
    • RecognizerName required
    • Tags
    • VolumeKmsKeyId
    • VpcConfig

CreateEntityRecognizerResponse

  • CreateEntityRecognizerResponse object
    • EntityRecognizerArn

CustomerInputString

  • CustomerInputString string

CustomerInputStringList

DeleteDocumentClassifierRequest

  • DeleteDocumentClassifierRequest object
    • DocumentClassifierArn required

DeleteDocumentClassifierResponse

  • DeleteDocumentClassifierResponse object

DeleteEndpointRequest

  • DeleteEndpointRequest object
    • EndpointArn required

DeleteEndpointResponse

  • DeleteEndpointResponse object

DeleteEntityRecognizerRequest

  • DeleteEntityRecognizerRequest object
    • EntityRecognizerArn required

DeleteEntityRecognizerResponse

  • DeleteEntityRecognizerResponse object

DescribeDocumentClassificationJobRequest

  • DescribeDocumentClassificationJobRequest object
    • JobId required

DescribeDocumentClassificationJobResponse

  • DescribeDocumentClassificationJobResponse object
    • DocumentClassificationJobProperties
      • DataAccessRoleArn
      • DocumentClassifierArn
      • EndTime
      • InputDataConfig
        • InputFormat
        • S3Uri required
      • JobId
      • JobName
      • JobStatus
      • Message
      • OutputDataConfig
        • KmsKeyId
        • S3Uri required
      • SubmitTime
      • VolumeKmsKeyId
      • VpcConfig

DescribeDocumentClassifierRequest

  • DescribeDocumentClassifierRequest object
    • DocumentClassifierArn required

DescribeDocumentClassifierResponse

  • DescribeDocumentClassifierResponse object
    • DocumentClassifierProperties
      • ClassifierMetadata
        • EvaluationMetrics
          • Accuracy
          • F1Score
          • HammingLoss
          • MicroF1Score
          • MicroPrecision
          • MicroRecall
          • Precision
          • Recall
        • NumberOfLabels
        • NumberOfTestDocuments
        • NumberOfTrainedDocuments
      • DataAccessRoleArn
      • DocumentClassifierArn
      • EndTime
      • InputDataConfig
      • LanguageCode
      • Message
      • Mode
      • OutputDataConfig
        • KmsKeyId
        • S3Uri
      • Status
      • SubmitTime
      • TrainingEndTime
      • TrainingStartTime
      • VolumeKmsKeyId
      • VpcConfig

DescribeDominantLanguageDetectionJobRequest

  • DescribeDominantLanguageDetectionJobRequest object
    • JobId required

DescribeDominantLanguageDetectionJobResponse

  • DescribeDominantLanguageDetectionJobResponse object
    • DominantLanguageDetectionJobProperties
      • DataAccessRoleArn
      • EndTime
      • InputDataConfig
        • InputFormat
        • S3Uri required
      • JobId
      • JobName
      • JobStatus
      • Message
      • OutputDataConfig
        • KmsKeyId
        • S3Uri required
      • SubmitTime
      • VolumeKmsKeyId
      • VpcConfig

DescribeEndpointRequest

  • DescribeEndpointRequest object
    • EndpointArn required

DescribeEndpointResponse

  • DescribeEndpointResponse object
    • EndpointProperties
      • CreationTime
      • CurrentInferenceUnits
      • DesiredInferenceUnits
      • EndpointArn
      • LastModifiedTime
      • Message
      • ModelArn
      • Status

DescribeEntitiesDetectionJobRequest

  • DescribeEntitiesDetectionJobRequest object
    • JobId required

DescribeEntitiesDetectionJobResponse

  • DescribeEntitiesDetectionJobResponse object
    • EntitiesDetectionJobProperties
      • DataAccessRoleArn
      • EndTime
      • EntityRecognizerArn
      • InputDataConfig
        • InputFormat
        • S3Uri required
      • JobId
      • JobName
      • JobStatus
      • LanguageCode
      • Message
      • OutputDataConfig
        • KmsKeyId
        • S3Uri required
      • SubmitTime
      • VolumeKmsKeyId
      • VpcConfig

DescribeEntityRecognizerRequest

  • DescribeEntityRecognizerRequest object
    • EntityRecognizerArn required

DescribeEntityRecognizerResponse

  • DescribeEntityRecognizerResponse object
    • EntityRecognizerProperties
      • DataAccessRoleArn
      • EndTime
      • EntityRecognizerArn
      • InputDataConfig
      • LanguageCode
      • Message
      • RecognizerMetadata
      • Status
      • SubmitTime
      • TrainingEndTime
      • TrainingStartTime
      • VolumeKmsKeyId
      • VpcConfig

DescribeEventsDetectionJobRequest

  • DescribeEventsDetectionJobRequest object
    • JobId required

DescribeEventsDetectionJobResponse

  • DescribeEventsDetectionJobResponse object
    • EventsDetectionJobProperties
      • DataAccessRoleArn
      • EndTime
      • InputDataConfig
        • InputFormat
        • S3Uri required
      • JobId
      • JobName
      • JobStatus
      • LanguageCode
      • Message
      • OutputDataConfig
        • KmsKeyId
        • S3Uri required
      • SubmitTime
      • TargetEventTypes

DescribeKeyPhrasesDetectionJobRequest

  • DescribeKeyPhrasesDetectionJobRequest object
    • JobId required

DescribeKeyPhrasesDetectionJobResponse

  • DescribeKeyPhrasesDetectionJobResponse object
    • KeyPhrasesDetectionJobProperties
      • DataAccessRoleArn
      • EndTime
      • InputDataConfig
        • InputFormat
        • S3Uri required
      • JobId
      • JobName
      • JobStatus
      • LanguageCode
      • Message
      • OutputDataConfig
        • KmsKeyId
        • S3Uri required
      • SubmitTime
      • VolumeKmsKeyId
      • VpcConfig

DescribePiiEntitiesDetectionJobRequest

  • DescribePiiEntitiesDetectionJobRequest object
    • JobId required

DescribePiiEntitiesDetectionJobResponse

DescribeSentimentDetectionJobRequest

  • DescribeSentimentDetectionJobRequest object
    • JobId required

DescribeSentimentDetectionJobResponse

  • DescribeSentimentDetectionJobResponse object
    • SentimentDetectionJobProperties
      • DataAccessRoleArn
      • EndTime
      • InputDataConfig
        • InputFormat
        • S3Uri required
      • JobId
      • JobName
      • JobStatus
      • LanguageCode
      • Message
      • OutputDataConfig
        • KmsKeyId
        • S3Uri required
      • SubmitTime
      • VolumeKmsKeyId
      • VpcConfig

DescribeTopicsDetectionJobRequest

  • DescribeTopicsDetectionJobRequest object
    • JobId required

DescribeTopicsDetectionJobResponse

  • DescribeTopicsDetectionJobResponse object
    • TopicsDetectionJobProperties
      • DataAccessRoleArn
      • EndTime
      • InputDataConfig
        • InputFormat
        • S3Uri required
      • JobId
      • JobName
      • JobStatus
      • Message
      • NumberOfTopics
      • OutputDataConfig
        • KmsKeyId
        • S3Uri required
      • SubmitTime
      • VolumeKmsKeyId
      • VpcConfig

DetectDominantLanguageRequest

  • DetectDominantLanguageRequest object
    • Text required

DetectDominantLanguageResponse

DetectEntitiesRequest

  • DetectEntitiesRequest object
    • EndpointArn
    • LanguageCode
    • Text required

DetectEntitiesResponse

  • DetectEntitiesResponse object

DetectKeyPhrasesRequest

  • DetectKeyPhrasesRequest object
    • LanguageCode required
    • Text required

DetectKeyPhrasesResponse

  • DetectKeyPhrasesResponse object

DetectPiiEntitiesRequest

  • DetectPiiEntitiesRequest object
    • LanguageCode required
    • Text required

DetectPiiEntitiesResponse

  • DetectPiiEntitiesResponse object

DetectSentimentRequest

  • DetectSentimentRequest object
    • LanguageCode required
    • Text required

DetectSentimentResponse

  • DetectSentimentResponse object
    • Sentiment
    • SentimentScore
      • Mixed
      • Negative
      • Neutral
      • Positive

DetectSyntaxRequest

  • DetectSyntaxRequest object
    • LanguageCode required
    • Text required

DetectSyntaxResponse

  • DetectSyntaxResponse object

DocumentClass

  • DocumentClass object: Specifies the class that categorizes the document being analyzed
    • Name
    • Score

DocumentClassificationJobFilter

  • DocumentClassificationJobFilter object: 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.
    • JobName
    • JobStatus
    • SubmitTimeAfter
    • SubmitTimeBefore

DocumentClassificationJobProperties

  • DocumentClassificationJobProperties object: Provides information about a document classification job.
    • DataAccessRoleArn
    • DocumentClassifierArn
    • EndTime
    • InputDataConfig
      • InputFormat
      • S3Uri required
    • JobId
    • JobName
    • JobStatus
    • Message
    • OutputDataConfig
      • KmsKeyId
      • S3Uri required
    • SubmitTime
    • VolumeKmsKeyId
    • VpcConfig

DocumentClassificationJobPropertiesList

DocumentClassifierArn

  • DocumentClassifierArn string

DocumentClassifierAugmentedManifestsList

DocumentClassifierDataFormat

  • DocumentClassifierDataFormat string (values: COMPREHEND_CSV, AUGMENTED_MANIFEST)

DocumentClassifierEndpointArn

  • DocumentClassifierEndpointArn string

DocumentClassifierFilter

  • DocumentClassifierFilter object: 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.
    • Status
    • SubmitTimeAfter
    • SubmitTimeBefore

DocumentClassifierInputDataConfig

  • DocumentClassifierInputDataConfig object:

    The input properties for training a document classifier.

    For more information on how the input file is formatted, see how-document-classification-training-data.

DocumentClassifierMode

  • DocumentClassifierMode string (values: MULTI_CLASS, MULTI_LABEL)

DocumentClassifierOutputDataConfig

  • DocumentClassifierOutputDataConfig object: Provides output results configuration parameters for custom classifier jobs.
    • KmsKeyId
    • S3Uri

DocumentClassifierProperties

  • DocumentClassifierProperties object: Provides information about a document classifier.
    • ClassifierMetadata
      • EvaluationMetrics
        • Accuracy
        • F1Score
        • HammingLoss
        • MicroF1Score
        • MicroPrecision
        • MicroRecall
        • Precision
        • Recall
      • NumberOfLabels
      • NumberOfTestDocuments
      • NumberOfTrainedDocuments
    • DataAccessRoleArn
    • DocumentClassifierArn
    • EndTime
    • InputDataConfig
    • LanguageCode
    • Message
    • Mode
    • OutputDataConfig
      • KmsKeyId
      • S3Uri
    • Status
    • SubmitTime
    • TrainingEndTime
    • TrainingStartTime
    • VolumeKmsKeyId
    • VpcConfig

DocumentClassifierPropertiesList

DocumentLabel

  • DocumentLabel object: Specifies one of the label or labels that categorize the document being analyzed.
    • Name
    • Score

DominantLanguage

  • DominantLanguage object: 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.
    • LanguageCode
    • Score

DominantLanguageDetectionJobFilter

  • DominantLanguageDetectionJobFilter object: Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
    • JobName
    • JobStatus
    • SubmitTimeAfter
    • SubmitTimeBefore

DominantLanguageDetectionJobProperties

  • DominantLanguageDetectionJobProperties object: Provides information about a dominant language detection job.
    • DataAccessRoleArn
    • EndTime
    • InputDataConfig
      • InputFormat
      • S3Uri required
    • JobId
    • JobName
    • JobStatus
    • Message
    • OutputDataConfig
      • KmsKeyId
      • S3Uri required
    • SubmitTime
    • VolumeKmsKeyId
    • VpcConfig

DominantLanguageDetectionJobPropertiesList

Double

  • Double number

EndpointFilter

  • EndpointFilter object: 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.
    • CreationTimeAfter
    • CreationTimeBefore
    • ModelArn
    • Status

EndpointProperties

  • EndpointProperties object: Specifies information about the specified endpoint.
    • CreationTime
    • CurrentInferenceUnits
    • DesiredInferenceUnits
    • EndpointArn
    • LastModifiedTime
    • Message
    • ModelArn
    • Status

EndpointPropertiesList

EndpointStatus

  • EndpointStatus string (values: CREATING, DELETING, FAILED, IN_SERVICE, UPDATING)

EntitiesDetectionJobFilter

  • EntitiesDetectionJobFilter object: Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
    • JobName
    • JobStatus
    • SubmitTimeAfter
    • SubmitTimeBefore

EntitiesDetectionJobProperties

  • EntitiesDetectionJobProperties object: Provides information about an entities detection job.
    • DataAccessRoleArn
    • EndTime
    • EntityRecognizerArn
    • InputDataConfig
      • InputFormat
      • S3Uri required
    • JobId
    • JobName
    • JobStatus
    • LanguageCode
    • Message
    • OutputDataConfig
      • KmsKeyId
      • S3Uri required
    • SubmitTime
    • VolumeKmsKeyId
    • VpcConfig

EntitiesDetectionJobPropertiesList

Entity

  • Entity object:

    Provides information about an entity.

    • BeginOffset
    • EndOffset
    • Score
    • Text
    • Type

EntityRecognizerAnnotations

  • EntityRecognizerAnnotations object: Describes the annotations associated with a entity recognizer.
    • S3Uri required

EntityRecognizerArn

  • EntityRecognizerArn string

EntityRecognizerAugmentedManifestsList

EntityRecognizerDataFormat

  • EntityRecognizerDataFormat string (values: COMPREHEND_CSV, AUGMENTED_MANIFEST)

EntityRecognizerDocuments

  • EntityRecognizerDocuments object: Describes the training documents submitted with an entity recognizer.
    • S3Uri required

EntityRecognizerEndpointArn

  • EntityRecognizerEndpointArn string

EntityRecognizerEntityList

  • EntityRecognizerEntityList object: Describes the entity recognizer submitted with an entity recognizer.
    • S3Uri required

EntityRecognizerEvaluationMetrics

  • EntityRecognizerEvaluationMetrics object: Detailed information about the accuracy of an entity recognizer.
    • F1Score
    • Precision
    • Recall

EntityRecognizerFilter

  • EntityRecognizerFilter object: 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./>
    • Status
    • SubmitTimeAfter
    • SubmitTimeBefore

EntityRecognizerInputDataConfig

  • EntityRecognizerInputDataConfig object: Specifies the format and location of the input data.

EntityRecognizerMetadata

  • EntityRecognizerMetadata object: Detailed information about an entity recognizer.

EntityRecognizerMetadataEntityTypesList

EntityRecognizerMetadataEntityTypesListItem

  • EntityRecognizerMetadataEntityTypesListItem object: Individual item from the list of entity types in the metadata of an entity recognizer.
    • EvaluationMetrics
      • F1Score
      • Precision
      • Recall
    • NumberOfTrainMentions
    • Type

EntityRecognizerProperties

  • EntityRecognizerProperties object: Describes information about an entity recognizer.
    • DataAccessRoleArn
    • EndTime
    • EntityRecognizerArn
    • InputDataConfig
    • LanguageCode
    • Message
    • RecognizerMetadata
    • Status
    • SubmitTime
    • TrainingEndTime
    • TrainingStartTime
    • VolumeKmsKeyId
    • VpcConfig

EntityRecognizerPropertiesList

EntityType

  • EntityType string (values: PERSON, LOCATION, ORGANIZATION, COMMERCIAL_ITEM, EVENT, DATE, QUANTITY, TITLE, OTHER)

EntityTypeName

  • EntityTypeName string

EntityTypesEvaluationMetrics

  • EntityTypesEvaluationMetrics object: Detailed information about the accuracy of an entity recognizer for a specific entity type.
    • F1Score
    • Precision
    • Recall

EntityTypesList

EntityTypesListItem

  • EntityTypesListItem object: An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
    • Type required

EventTypeString

  • EventTypeString string

EventsDetectionJobFilter

  • EventsDetectionJobFilter object: Provides information for filtering a list of event detection jobs.
    • JobName
    • JobStatus
    • SubmitTimeAfter
    • SubmitTimeBefore

EventsDetectionJobProperties

  • EventsDetectionJobProperties object: Provides information about an events detection job.
    • DataAccessRoleArn
    • EndTime
    • InputDataConfig
      • InputFormat
      • S3Uri required
    • JobId
    • JobName
    • JobStatus
    • LanguageCode
    • Message
    • OutputDataConfig
      • KmsKeyId
      • S3Uri required
    • SubmitTime
    • TargetEventTypes

EventsDetectionJobPropertiesList

Float

  • Float number

IamRoleArn

  • IamRoleArn string

InferenceUnitsInteger

  • InferenceUnitsInteger integer

InputDataConfig

  • InputDataConfig object: The input properties for a topic detection job.
    • InputFormat
    • S3Uri required

InputFormat

  • InputFormat string (values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE)

Integer

  • Integer integer

InternalServerException

InvalidFilterException

InvalidRequestException

JobId

  • JobId string

JobName

  • JobName string

JobNotFoundException

JobStatus

  • JobStatus string (values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED)

KeyPhrase

  • KeyPhrase object: Describes a key noun phrase.
    • BeginOffset
    • EndOffset
    • Score
    • Text

KeyPhrasesDetectionJobFilter

  • KeyPhrasesDetectionJobFilter object: Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
    • JobName
    • JobStatus
    • SubmitTimeAfter
    • SubmitTimeBefore

KeyPhrasesDetectionJobProperties

  • KeyPhrasesDetectionJobProperties object: Provides information about a key phrases detection job.
    • DataAccessRoleArn
    • EndTime
    • InputDataConfig
      • InputFormat
      • S3Uri required
    • JobId
    • JobName
    • JobStatus
    • LanguageCode
    • Message
    • OutputDataConfig
      • KmsKeyId
      • S3Uri required
    • SubmitTime
    • VolumeKmsKeyId
    • VpcConfig

KeyPhrasesDetectionJobPropertiesList

KmsKeyId

  • KmsKeyId string

KmsKeyValidationException

LabelDelimiter

  • LabelDelimiter string

LanguageCode

  • LanguageCode string (values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW)

ListDocumentClassificationJobsRequest

  • ListDocumentClassificationJobsRequest object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

ListDocumentClassificationJobsResponse

ListDocumentClassifiersRequest

  • ListDocumentClassifiersRequest object
    • Filter
      • Status
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

ListDocumentClassifiersResponse

ListDominantLanguageDetectionJobsRequest

  • ListDominantLanguageDetectionJobsRequest object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

ListDominantLanguageDetectionJobsResponse

ListEndpointsRequest

  • ListEndpointsRequest object
    • Filter
      • CreationTimeAfter
      • CreationTimeBefore
      • ModelArn
      • Status
    • MaxResults
    • NextToken

ListEndpointsResponse

ListEntitiesDetectionJobsRequest

  • ListEntitiesDetectionJobsRequest object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

ListEntitiesDetectionJobsResponse

ListEntityRecognizersRequest

  • ListEntityRecognizersRequest object
    • Filter
      • Status
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

ListEntityRecognizersResponse

ListEventsDetectionJobsRequest

  • ListEventsDetectionJobsRequest object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

ListEventsDetectionJobsResponse

ListKeyPhrasesDetectionJobsRequest

  • ListKeyPhrasesDetectionJobsRequest object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

ListKeyPhrasesDetectionJobsResponse

ListOfClasses

ListOfDetectDominantLanguageResult

ListOfDetectEntitiesResult

ListOfDetectKeyPhrasesResult

ListOfDetectSentimentResult

ListOfDetectSyntaxResult

ListOfDominantLanguages

ListOfEntities

  • ListOfEntities array

ListOfKeyPhrases

ListOfLabels

ListOfPiiEntities

ListOfPiiEntityTypes

ListOfSyntaxTokens

ListPiiEntitiesDetectionJobsRequest

  • ListPiiEntitiesDetectionJobsRequest object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

ListPiiEntitiesDetectionJobsResponse

ListSentimentDetectionJobsRequest

  • ListSentimentDetectionJobsRequest object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

ListSentimentDetectionJobsResponse

ListTagsForResourceRequest

  • ListTagsForResourceRequest object
    • ResourceArn required

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • ResourceArn
    • Tags

ListTopicsDetectionJobsRequest

  • ListTopicsDetectionJobsRequest object
    • Filter
      • JobName
      • JobStatus
      • SubmitTimeAfter
      • SubmitTimeBefore
    • MaxResults
    • NextToken

ListTopicsDetectionJobsResponse

MaskCharacter

  • MaskCharacter string

MaxResultsInteger

  • MaxResultsInteger integer

ModelStatus

  • ModelStatus string (values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED)

NumberOfTopicsInteger

  • NumberOfTopicsInteger integer

OutputDataConfig

  • OutputDataConfig object:

    Provides configuration parameters for the output of topic detection jobs.

    • KmsKeyId
    • S3Uri required

PartOfSpeechTag

  • PartOfSpeechTag object: 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.
    • Score
    • Tag

PartOfSpeechTagType

  • PartOfSpeechTagType string (values: ADJ, ADP, ADV, AUX, CONJ, CCONJ, DET, INTJ, NOUN, NUM, O, PART, PRON, PROPN, PUNCT, SCONJ, SYM, VERB)

PiiEntitiesDetectionJobFilter

  • PiiEntitiesDetectionJobFilter object: Provides information for filtering a list of PII entity detection jobs.
    • JobName
    • JobStatus
    • SubmitTimeAfter
    • SubmitTimeBefore

PiiEntitiesDetectionJobProperties

  • PiiEntitiesDetectionJobProperties object: Provides information about a PII entities detection job.
    • DataAccessRoleArn
    • EndTime
    • InputDataConfig
      • InputFormat
      • S3Uri required
    • JobId
    • JobName
    • JobStatus
    • LanguageCode
    • Message
    • Mode
    • OutputDataConfig
      • KmsKeyId
      • S3Uri required
    • RedactionConfig
    • SubmitTime

PiiEntitiesDetectionJobPropertiesList

PiiEntitiesDetectionMaskMode

  • PiiEntitiesDetectionMaskMode string (values: MASK, REPLACE_WITH_PII_ENTITY_TYPE)

PiiEntitiesDetectionMode

  • PiiEntitiesDetectionMode string (values: ONLY_REDACTION, ONLY_OFFSETS)

PiiEntity

  • PiiEntity object: Provides information about a PII entity.
    • BeginOffset
    • EndOffset
    • Score
    • Type

PiiEntityType

  • PiiEntityType string (values: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL)

PiiOutputDataConfig

  • PiiOutputDataConfig object: Provides configuration parameters for the output of PII entity detection jobs.
    • KmsKeyId
    • S3Uri required

RedactionConfig

  • RedactionConfig object: Provides configuration parameters for PII entity redaction.

ResourceInUseException

ResourceLimitExceededException

ResourceNotFoundException

ResourceUnavailableException

S3Uri

  • S3Uri string

SecurityGroupId

  • SecurityGroupId string

SecurityGroupIds

SentimentDetectionJobFilter

  • SentimentDetectionJobFilter object: Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
    • JobName
    • JobStatus
    • SubmitTimeAfter
    • SubmitTimeBefore

SentimentDetectionJobProperties

  • SentimentDetectionJobProperties object: Provides information about a sentiment detection job.
    • DataAccessRoleArn
    • EndTime
    • InputDataConfig
      • InputFormat
      • S3Uri required
    • JobId
    • JobName
    • JobStatus
    • LanguageCode
    • Message
    • OutputDataConfig
      • KmsKeyId
      • S3Uri required
    • SubmitTime
    • VolumeKmsKeyId
    • VpcConfig

SentimentDetectionJobPropertiesList

SentimentScore

  • SentimentScore object: Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.
    • Mixed
    • Negative
    • Neutral
    • Positive

SentimentType

  • SentimentType string (values: POSITIVE, NEGATIVE, NEUTRAL, MIXED)

StartDocumentClassificationJobRequest

  • StartDocumentClassificationJobRequest object
    • ClientRequestToken
    • DataAccessRoleArn required
    • DocumentClassifierArn required
    • InputDataConfig required
      • InputFormat
      • S3Uri required
    • JobName
    • OutputDataConfig required
      • KmsKeyId
      • S3Uri required
    • VolumeKmsKeyId
    • VpcConfig

StartDocumentClassificationJobResponse

  • StartDocumentClassificationJobResponse object
    • JobId
    • JobStatus

StartDominantLanguageDetectionJobRequest

  • StartDominantLanguageDetectionJobRequest object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • InputFormat
      • S3Uri required
    • JobName
    • OutputDataConfig required
      • KmsKeyId
      • S3Uri required
    • VolumeKmsKeyId
    • VpcConfig

StartDominantLanguageDetectionJobResponse

  • StartDominantLanguageDetectionJobResponse object
    • JobId
    • JobStatus

StartEntitiesDetectionJobRequest

  • StartEntitiesDetectionJobRequest object
    • ClientRequestToken
    • DataAccessRoleArn required
    • EntityRecognizerArn
    • InputDataConfig required
      • InputFormat
      • S3Uri required
    • JobName
    • LanguageCode required
    • OutputDataConfig required
      • KmsKeyId
      • S3Uri required
    • VolumeKmsKeyId
    • VpcConfig

StartEntitiesDetectionJobResponse

  • StartEntitiesDetectionJobResponse object
    • JobId
    • JobStatus

StartEventsDetectionJobRequest

  • StartEventsDetectionJobRequest object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • InputFormat
      • S3Uri required
    • JobName
    • LanguageCode required
    • OutputDataConfig required
      • KmsKeyId
      • S3Uri required
    • TargetEventTypes required

StartEventsDetectionJobResponse

  • StartEventsDetectionJobResponse object
    • JobId
    • JobStatus

StartKeyPhrasesDetectionJobRequest

  • StartKeyPhrasesDetectionJobRequest object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • InputFormat
      • S3Uri required
    • JobName
    • LanguageCode required
    • OutputDataConfig required
      • KmsKeyId
      • S3Uri required
    • VolumeKmsKeyId
    • VpcConfig

StartKeyPhrasesDetectionJobResponse

  • StartKeyPhrasesDetectionJobResponse object
    • JobId
    • JobStatus

StartPiiEntitiesDetectionJobRequest

  • StartPiiEntitiesDetectionJobRequest object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • InputFormat
      • S3Uri required
    • JobName
    • LanguageCode required
    • Mode required
    • OutputDataConfig required
      • KmsKeyId
      • S3Uri required
    • RedactionConfig

StartPiiEntitiesDetectionJobResponse

  • StartPiiEntitiesDetectionJobResponse object
    • JobId
    • JobStatus

StartSentimentDetectionJobRequest

  • StartSentimentDetectionJobRequest object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • InputFormat
      • S3Uri required
    • JobName
    • LanguageCode required
    • OutputDataConfig required
      • KmsKeyId
      • S3Uri required
    • VolumeKmsKeyId
    • VpcConfig

StartSentimentDetectionJobResponse

  • StartSentimentDetectionJobResponse object
    • JobId
    • JobStatus

StartTopicsDetectionJobRequest

  • StartTopicsDetectionJobRequest object
    • ClientRequestToken
    • DataAccessRoleArn required
    • InputDataConfig required
      • InputFormat
      • S3Uri required
    • JobName
    • NumberOfTopics
    • OutputDataConfig required
      • KmsKeyId
      • S3Uri required
    • VolumeKmsKeyId
    • VpcConfig

StartTopicsDetectionJobResponse

  • StartTopicsDetectionJobResponse object
    • JobId
    • JobStatus

StopDominantLanguageDetectionJobRequest

  • StopDominantLanguageDetectionJobRequest object
    • JobId required

StopDominantLanguageDetectionJobResponse

  • StopDominantLanguageDetectionJobResponse object
    • JobId
    • JobStatus

StopEntitiesDetectionJobRequest

  • StopEntitiesDetectionJobRequest object
    • JobId required

StopEntitiesDetectionJobResponse

  • StopEntitiesDetectionJobResponse object
    • JobId
    • JobStatus

StopEventsDetectionJobRequest

  • StopEventsDetectionJobRequest object
    • JobId required

StopEventsDetectionJobResponse

  • StopEventsDetectionJobResponse object
    • JobId
    • JobStatus

StopKeyPhrasesDetectionJobRequest

  • StopKeyPhrasesDetectionJobRequest object
    • JobId required

StopKeyPhrasesDetectionJobResponse

  • StopKeyPhrasesDetectionJobResponse object
    • JobId
    • JobStatus

StopPiiEntitiesDetectionJobRequest

  • StopPiiEntitiesDetectionJobRequest object
    • JobId required

StopPiiEntitiesDetectionJobResponse

  • StopPiiEntitiesDetectionJobResponse object
    • JobId
    • JobStatus

StopSentimentDetectionJobRequest

  • StopSentimentDetectionJobRequest object
    • JobId required

StopSentimentDetectionJobResponse

  • StopSentimentDetectionJobResponse object
    • JobId
    • JobStatus

StopTrainingDocumentClassifierRequest

  • StopTrainingDocumentClassifierRequest object
    • DocumentClassifierArn required

StopTrainingDocumentClassifierResponse

  • StopTrainingDocumentClassifierResponse object

StopTrainingEntityRecognizerRequest

  • StopTrainingEntityRecognizerRequest object
    • EntityRecognizerArn required

StopTrainingEntityRecognizerResponse

  • StopTrainingEntityRecognizerResponse object

String

  • String string

SubnetId

  • SubnetId string

Subnets

SyntaxLanguageCode

  • SyntaxLanguageCode string (values: en, es, fr, de, it, pt)

SyntaxToken

  • SyntaxToken object: 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.
    • BeginOffset
    • EndOffset
    • PartOfSpeech
      • Score
      • Tag
    • Text
    • TokenId

Tag

  • Tag object: 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.
    • Key required
    • Value

TagKey

  • TagKey string

TagKeyList

  • TagKeyList array

TagList

  • TagList array

TagResourceRequest

  • TagResourceRequest object
    • ResourceArn required
    • Tags required

TagResourceResponse

  • TagResourceResponse object

TagValue

  • TagValue string

TargetEventTypes

TextSizeLimitExceededException

Timestamp

  • Timestamp string

TooManyRequestsException

TooManyTagKeysException

TooManyTagsException

TopicsDetectionJobFilter

  • TopicsDetectionJobFilter object: Provides information for filtering topic detection jobs. For more information, see .
    • JobName
    • JobStatus
    • SubmitTimeAfter
    • SubmitTimeBefore

TopicsDetectionJobProperties

  • TopicsDetectionJobProperties object: Provides information about a topic detection job.
    • DataAccessRoleArn
    • EndTime
    • InputDataConfig
      • InputFormat
      • S3Uri required
    • JobId
    • JobName
    • JobStatus
    • Message
    • NumberOfTopics
    • OutputDataConfig
      • KmsKeyId
      • S3Uri required
    • SubmitTime
    • VolumeKmsKeyId
    • VpcConfig

TopicsDetectionJobPropertiesList

UnsupportedLanguageException

UntagResourceRequest

  • UntagResourceRequest object
    • ResourceArn required
    • TagKeys required

UntagResourceResponse

  • UntagResourceResponse object

UpdateEndpointRequest

  • UpdateEndpointRequest object
    • DesiredInferenceUnits required
    • EndpointArn required

UpdateEndpointResponse

  • UpdateEndpointResponse object

VpcConfig

  • VpcConfig object: 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.