AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
AugmentedManifestsListItem |
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 |
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation. |
|
BatchDetectDominantLanguageRequest |
Container for the parameters to the BatchDetectDominantLanguage operation. Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages. |
|
BatchDetectDominantLanguageResponse |
This is the response object from the BatchDetectDominantLanguage operation. |
|
BatchDetectEntitiesItemResult |
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation. |
|
BatchDetectEntitiesRequest |
Container for the parameters to the BatchDetectEntities operation. Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide. |
|
BatchDetectEntitiesResponse |
This is the response object from the BatchDetectEntities operation. |
|
BatchDetectKeyPhrasesItemResult |
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation. |
|
BatchDetectKeyPhrasesRequest |
Container for the parameters to the BatchDetectKeyPhrases operation. Detects the key noun phrases found in a batch of documents. |
|
BatchDetectKeyPhrasesResponse |
This is the response object from the BatchDetectKeyPhrases operation. |
|
BatchDetectSentimentItemResult |
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation. |
|
BatchDetectSentimentRequest |
Container for the parameters to the BatchDetectSentiment operation.
Inspects a batch of documents and returns an inference of the prevailing sentiment,
|
|
BatchDetectSentimentResponse |
This is the response object from the BatchDetectSentiment operation. |
|
BatchDetectSyntaxItemResult |
The result of calling the operation. The operation returns one object that is successfully processed by the operation. |
|
BatchDetectSyntaxRequest |
Container for the parameters to the BatchDetectSyntax operation. Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see Syntax in the Comprehend Developer Guide. |
|
BatchDetectSyntaxResponse |
This is the response object from the BatchDetectSyntax operation. |
|
BatchDetectTargetedSentimentItemResult |
Analysis results for one of the documents in the batch. |
|
BatchDetectTargetedSentimentRequest |
Container for the parameters to the BatchDetectTargetedSentiment operation. Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents. For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide. |
|
BatchDetectTargetedSentimentResponse |
This is the response object from the BatchDetectTargetedSentiment operation. |
|
BatchItemError |
Describes an error that occurred while processing a document in a batch. The operation
returns on |
|
BatchSizeLimitExceededException |
The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents. |
|
Block |
Information about each word or line of text in the input document. For additional information, see Block in the Amazon Textract API reference. |
|
BlockReference |
A reference to a block. |
|
BoundingBox |
The bounding box around the detected page or around an element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0). For additional information, see BoundingBox in the Amazon Textract API reference. |
|
ChildBlock |
Nested block contained within a block. |
|
ClassifierEvaluationMetrics |
Describes the result metrics for the test data associated with an documentation classifier. |
|
ClassifierMetadata |
Provides information about a document classifier. |
|
ClassifyDocumentRequest |
Container for the parameters to the ClassifyDocument operation.
Creates a classification request to analyze a single document in real-time.
If the system detects errors while processing a page in the input document, the API
response includes an
If the system detects a document-level error in your input document, the API returns
an |
|
ClassifyDocumentResponse |
This is the response object from the ClassifyDocument operation. |
|
ComprehendPaginatorFactory |
Paginators for the Comprehend service |
|
ConcurrentModificationException |
Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported. |
|
ContainsPiiEntitiesRequest |
Container for the parameters to the ContainsPiiEntities operation. Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number. |
|
ContainsPiiEntitiesResponse |
This is the response object from the ContainsPiiEntities operation. |
|
CreateDatasetRequest |
Container for the parameters to the CreateDataset operation. Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide. |
|
CreateDatasetResponse |
This is the response object from the CreateDataset operation. |
|
CreateDocumentClassifierRequest |
Container for the parameters to the CreateDocumentClassifier operation. Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that are labeled with the categories that you want to use. For more information, see Training classifier models in the Comprehend Developer Guide. |
|
CreateDocumentClassifierResponse |
This is the response object from the CreateDocumentClassifier operation. |
|
CreateEndpointRequest |
Container for the parameters to the CreateEndpoint operation. Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints. |
|
CreateEndpointResponse |
This is the response object from the CreateEndpoint operation. |
|
CreateEntityRecognizerRequest |
Container for the parameters to the CreateEntityRecognizer operation.
Creates an entity recognizer using submitted files. After your |
|
CreateEntityRecognizerResponse |
This is the response object from the CreateEntityRecognizer operation. |
|
CreateFlywheelRequest |
Container for the parameters to the CreateFlywheel operation. A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model. When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model. To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake. To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide. |
|
CreateFlywheelResponse |
This is the response object from the CreateFlywheel operation. |
|
DataSecurityConfig |
Data security configuration. |
|
DatasetAugmentedManifestsListItem |
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. |
|
DatasetDocumentClassifierInputDataConfig |
Describes the dataset input data configuration for a document classifier model. For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide. |
|
DatasetEntityRecognizerAnnotations |
Describes the annotations associated with a entity recognizer. |
|
DatasetEntityRecognizerDocuments |
Describes the documents submitted with a dataset for an entity recognizer model. |
|
DatasetEntityRecognizerEntityList |
Describes the dataset entity list for an entity recognizer model. For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide. |
|
DatasetEntityRecognizerInputDataConfig |
Specifies the format and location of the input data. You must provide either the |
|
DatasetFilter |
Filter the datasets based on creation time or dataset status. |
|
DatasetInputDataConfig |
Specifies the format and location of the input data for the dataset. |
|
DatasetProperties |
Properties associated with the dataset. |
|
DeleteDocumentClassifierRequest |
Container for the parameters to the DeleteDocumentClassifier operation. Deletes a previously created document classifier
Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted.
If an active inference job is using the model, a This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use. |
|
DeleteDocumentClassifierResponse |
This is the response object from the DeleteDocumentClassifier operation. |
|
DeleteEndpointRequest |
Container for the parameters to the DeleteEndpoint operation. Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see Managing endpoints. |
|
DeleteEndpointResponse |
This is the response object from the DeleteEndpoint operation. |
|
DeleteEntityRecognizerRequest |
Container for the parameters to the DeleteEntityRecognizer operation. Deletes an entity recognizer.
Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted.
If an active inference job is using the model, a This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use. |
|
DeleteEntityRecognizerResponse |
This is the response object from the DeleteEntityRecognizer operation. |
|
DeleteFlywheelRequest |
Container for the parameters to the DeleteFlywheel operation. Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide. |
|
DeleteFlywheelResponse |
This is the response object from the DeleteFlywheel operation. |
|
DeleteResourcePolicyRequest |
Container for the parameters to the DeleteResourcePolicy operation. Deletes a resource-based policy that is attached to a custom model. |
|
DeleteResourcePolicyResponse |
This is the response object from the DeleteResourcePolicy operation. |
|
DescribeDatasetRequest |
Container for the parameters to the DescribeDataset operation. Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide. |
|
DescribeDatasetResponse |
This is the response object from the DescribeDataset operation. |
|
DescribeDocumentClassificationJobRequest |
Container for the parameters to the DescribeDocumentClassificationJob operation. Gets the properties associated with a document classification job. Use this operation to get the status of a classification job. |
|
DescribeDocumentClassificationJobResponse |
This is the response object from the DescribeDocumentClassificationJob operation. |
|
DescribeDocumentClassifierRequest |
Container for the parameters to the DescribeDocumentClassifier operation. Gets the properties associated with a document classifier. |
|
DescribeDocumentClassifierResponse |
This is the response object from the DescribeDocumentClassifier operation. |
|
DescribeDominantLanguageDetectionJobRequest |
Container for the parameters to the DescribeDominantLanguageDetectionJob operation. Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job. |
|
DescribeDominantLanguageDetectionJobResponse |
This is the response object from the DescribeDominantLanguageDetectionJob operation. |
|
DescribeEndpointRequest |
Container for the parameters to the DescribeEndpoint operation. Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints. |
|
DescribeEndpointResponse |
This is the response object from the DescribeEndpoint operation. |
|
DescribeEntitiesDetectionJobRequest |
Container for the parameters to the DescribeEntitiesDetectionJob operation. Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job. |
|
DescribeEntitiesDetectionJobResponse |
This is the response object from the DescribeEntitiesDetectionJob operation. |
|
DescribeEntityRecognizerRequest |
Container for the parameters to the DescribeEntityRecognizer operation. Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on. |
|
DescribeEntityRecognizerResponse |
This is the response object from the DescribeEntityRecognizer operation. |
|
DescribeEventsDetectionJobRequest |
Container for the parameters to the DescribeEventsDetectionJob operation. Gets the status and details of an events detection job. |
|
DescribeEventsDetectionJobResponse |
This is the response object from the DescribeEventsDetectionJob operation. |
|
DescribeFlywheelIterationRequest |
Container for the parameters to the DescribeFlywheelIteration operation. Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide. |
|
DescribeFlywheelIterationResponse |
This is the response object from the DescribeFlywheelIteration operation. |
|
DescribeFlywheelRequest |
Container for the parameters to the DescribeFlywheel operation. Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide. |
|
DescribeFlywheelResponse |
This is the response object from the DescribeFlywheel operation. |
|
DescribeKeyPhrasesDetectionJobRequest |
Container for the parameters to the DescribeKeyPhrasesDetectionJob operation. Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job. |
|
DescribeKeyPhrasesDetectionJobResponse |
This is the response object from the DescribeKeyPhrasesDetectionJob operation. |
|
DescribePiiEntitiesDetectionJobRequest |
Container for the parameters to the DescribePiiEntitiesDetectionJob operation. Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status. |
|
DescribePiiEntitiesDetectionJobResponse |
This is the response object from the DescribePiiEntitiesDetectionJob operation. |
|
DescribeResourcePolicyRequest |
Container for the parameters to the DescribeResourcePolicy operation. Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy. |
|
DescribeResourcePolicyResponse |
This is the response object from the DescribeResourcePolicy operation. |
|
DescribeSentimentDetectionJobRequest |
Container for the parameters to the DescribeSentimentDetectionJob operation. Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job. |
|
DescribeSentimentDetectionJobResponse |
This is the response object from the DescribeSentimentDetectionJob operation. |
|
DescribeTargetedSentimentDetectionJobRequest |
Container for the parameters to the DescribeTargetedSentimentDetectionJob operation. Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job. |
|
DescribeTargetedSentimentDetectionJobResponse |
This is the response object from the DescribeTargetedSentimentDetectionJob operation. |
|
DescribeTopicsDetectionJobRequest |
Container for the parameters to the DescribeTopicsDetectionJob operation. Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job. |
|
DescribeTopicsDetectionJobResponse |
This is the response object from the DescribeTopicsDetectionJob operation. |
|
DetectDominantLanguageRequest |
Container for the parameters to the DetectDominantLanguage operation. Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages. |
|
DetectDominantLanguageResponse |
This is the response object from the DetectDominantLanguage operation. |
|
DetectEntitiesRequest |
Container for the parameters to the DetectEntities operation. Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model. When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide. When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API
response includes an entry in
If the system detects a document-level error in your input document, the API returns
an |
|
DetectEntitiesResponse |
This is the response object from the DetectEntities operation. |
|
DetectKeyPhrasesRequest |
Container for the parameters to the DetectKeyPhrases operation. Detects the key noun phrases found in the text. |
|
DetectKeyPhrasesResponse |
This is the response object from the DetectKeyPhrases operation. |
|
DetectPiiEntitiesRequest |
Container for the parameters to the DetectPiiEntities operation. Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them. |
|
DetectPiiEntitiesResponse |
This is the response object from the DetectPiiEntities operation. |
|
DetectSentimentRequest |
Container for the parameters to the DetectSentiment operation.
Inspects text and returns an inference of the prevailing sentiment ( |
|
DetectSentimentResponse |
This is the response object from the DetectSentiment operation. |
|
DetectSyntaxRequest |
Container for the parameters to the DetectSyntax operation. Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide. |
|
DetectSyntaxResponse |
This is the response object from the DetectSyntax operation. |
|
DetectTargetedSentimentRequest |
Container for the parameters to the DetectTargetedSentiment operation. Inspects the input text and returns a sentiment analysis for each entity identified in the text. For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide. |
|
DetectTargetedSentimentResponse |
This is the response object from the DetectTargetedSentiment operation. |
|
DetectToxicContentRequest |
Container for the parameters to the DetectToxicContent operation. Performs toxicity analysis on the list of text strings that you provide as input. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide. |
|
DetectToxicContentResponse |
This is the response object from the DetectToxicContent operation. |
|
DocumentClass |
Specifies the class that categorizes the document being analyzed |
|
DocumentClassificationConfig |
Configuration required for a document classification model. |
|
DocumentClassificationJobFilter |
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. |
|
DocumentClassificationJobProperties |
Provides information about a document classification job. |
|
DocumentClassifierDocuments |
The location of the training documents. This parameter is required in a request to create a semi-structured document classification model. |
|
DocumentClassifierFilter |
Provides information for filtering a list of document classifiers. You can only specify
one filtering parameter in a request. For more information, see the |
|
DocumentClassifierInputDataConfig |
The input properties for training a document classifier. For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide. |
|
DocumentClassifierOutputDataConfig |
Provide the location for output data from a custom classifier job. This field is mandatory if you are training a native document model. |
|
DocumentClassifierProperties |
Provides information about a document classifier. |
|
DocumentClassifierSummary |
Describes information about a document classifier and its versions. |
|
DocumentLabel |
Specifies one of the label or labels that categorize the document being analyzed. |
|
DocumentMetadata |
Information about the document, discovered during text extraction. |
|
DocumentReaderConfig |
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files. By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:
For image files and PDF documents, you can override these default actions using the fields listed below. For more information, see Setting text extraction options in the Comprehend Developer Guide. |
|
DocumentTypeListItem |
Document type for each page in the document. |
|
DominantLanguage |
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. |
|
DominantLanguageDetectionJobFilter |
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation. |
|
DominantLanguageDetectionJobProperties |
Provides information about a dominant language detection job. |
|
EndpointFilter |
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. |
|
EndpointProperties |
Specifies information about the specified endpoint. For information about endpoints, see Managing endpoints. |
|
EntitiesDetectionJobFilter |
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation. |
|
EntitiesDetectionJobProperties |
Provides information about an entities detection job. |
|
Entity |
Provides information about an entity.
|
|
EntityLabel |
Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed. |
|
EntityRecognitionConfig |
Configuration required for an entity recognition model. |
|
EntityRecognizerAnnotations |
Describes the annotations associated with a entity recognizer. |
|
EntityRecognizerDocuments |
Describes the training documents submitted with an entity recognizer. |
|
EntityRecognizerEntityList |
Describes the entity list submitted with an entity recognizer. |
|
EntityRecognizerEvaluationMetrics |
Detailed information about the accuracy of an entity recognizer. |
|
EntityRecognizerFilter |
Provides information for filtering a list of entity recognizers. You can only specify
one filtering parameter in a request. For more information, see the |
|
EntityRecognizerInputDataConfig |
Specifies the format and location of the input data. |
|
EntityRecognizerMetadata |
Detailed information about an entity recognizer. |
|
EntityRecognizerMetadataEntityTypesListItem |
Individual item from the list of entity types in the metadata of an entity recognizer. |
|
EntityRecognizerOutputDataConfig |
Output data configuration. |
|
EntityRecognizerProperties |
Describes information about an entity recognizer. |
|
EntityRecognizerSummary |
Describes the information about an entity recognizer and its versions. |
|
EntityTypesEvaluationMetrics |
Detailed information about the accuracy of an entity recognizer for a specific entity type. |
|
EntityTypesListItem |
An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer. |
|
ErrorsListItem |
Text extraction encountered one or more page-level errors in the input document.
The
|
|
EventsDetectionJobFilter |
Provides information for filtering a list of event detection jobs. |
|
EventsDetectionJobProperties |
Provides information about an events detection job. |
|
ExtractedCharactersListItem |
Array of the number of characters extracted from each page. |
|
FlywheelFilter |
Filter the flywheels based on creation time or flywheel status. |
|
FlywheelIterationFilter |
Filter the flywheel iterations based on creation time. |
|
FlywheelIterationProperties |
The configuration properties of a flywheel iteration. |
|
FlywheelModelEvaluationMetrics |
The evaluation metrics associated with the evaluated model. |
|
FlywheelProperties |
The flywheel properties. |
|
FlywheelSummary |
Flywheel summary information. |
|
Geometry |
Information about the location of items on a document page. For additional information, see Geometry in the Amazon Textract API reference. |
|
ImportModelRequest |
Container for the parameters to the ImportModel operation. Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one. If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it. The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region. |
|
ImportModelResponse |
This is the response object from the ImportModel operation. |
|
InputDataConfig |
The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis. |
|
InternalServerException |
An internal server error occurred. Retry your request. |
|
InvalidFilterException |
The filter specified for the operation is invalid. Specify a different filter. |
|
InvalidRequestDetail |
Provides additional detail about why the request failed. |
|
InvalidRequestException |
The request is invalid. |
|
JobNotFoundException |
The specified job was not found. Check the job ID and try again. |
|
KeyPhrase |
Describes a key noun phrase. |
|
KeyPhrasesDetectionJobFilter |
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation. |
|
KeyPhrasesDetectionJobProperties |
Provides information about a key phrases detection job. |
|
KmsKeyValidationException |
The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it. |
|
ListDatasetsRequest |
Container for the parameters to the ListDatasets operation. List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide. |
|
ListDatasetsResponse |
This is the response object from the ListDatasets operation. |
|
ListDocumentClassificationJobsRequest |
Container for the parameters to the ListDocumentClassificationJobs operation. Gets a list of the documentation classification jobs that you have submitted. |
|
ListDocumentClassificationJobsResponse |
This is the response object from the ListDocumentClassificationJobs operation. |
|
ListDocumentClassifiersRequest |
Container for the parameters to the ListDocumentClassifiers operation. Gets a list of the document classifiers that you have created. |
|
ListDocumentClassifiersResponse |
This is the response object from the ListDocumentClassifiers operation. |
|
ListDocumentClassifierSummariesRequest |
Container for the parameters to the ListDocumentClassifierSummaries operation. Gets a list of summaries of the document classifiers that you have created |
|
ListDocumentClassifierSummariesResponse |
This is the response object from the ListDocumentClassifierSummaries operation. |
|
ListDominantLanguageDetectionJobsRequest |
Container for the parameters to the ListDominantLanguageDetectionJobs operation. Gets a list of the dominant language detection jobs that you have submitted. |
|
ListDominantLanguageDetectionJobsResponse |
This is the response object from the ListDominantLanguageDetectionJobs operation. |
|
ListEndpointsRequest |
Container for the parameters to the ListEndpoints operation. Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints. |
|
ListEndpointsResponse |
This is the response object from the ListEndpoints operation. |
|
ListEntitiesDetectionJobsRequest |
Container for the parameters to the ListEntitiesDetectionJobs operation. Gets a list of the entity detection jobs that you have submitted. |
|
ListEntitiesDetectionJobsResponse |
This is the response object from the ListEntitiesDetectionJobs operation. |
|
ListEntityRecognizersRequest |
Container for the parameters to the ListEntityRecognizers operation. Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list. The results of this list are not in any particular order. Please get the list and sort locally if needed. |
|
ListEntityRecognizersResponse |
This is the response object from the ListEntityRecognizers operation. |
|
ListEntityRecognizerSummariesRequest |
Container for the parameters to the ListEntityRecognizerSummaries operation. Gets a list of summaries for the entity recognizers that you have created. |
|
ListEntityRecognizerSummariesResponse |
This is the response object from the ListEntityRecognizerSummaries operation. |
|
ListEventsDetectionJobsRequest |
Container for the parameters to the ListEventsDetectionJobs operation. Gets a list of the events detection jobs that you have submitted. |
|
ListEventsDetectionJobsResponse |
This is the response object from the ListEventsDetectionJobs operation. |
|
ListFlywheelIterationHistoryRequest |
Container for the parameters to the ListFlywheelIterationHistory operation. Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide. |
|
ListFlywheelIterationHistoryResponse |
This is the response object from the ListFlywheelIterationHistory operation. |
|
ListFlywheelsRequest |
Container for the parameters to the ListFlywheels operation. Gets a list of the flywheels that you have created. |
|
ListFlywheelsResponse |
This is the response object from the ListFlywheels operation. |
|
ListKeyPhrasesDetectionJobsRequest |
Container for the parameters to the ListKeyPhrasesDetectionJobs operation. Get a list of key phrase detection jobs that you have submitted. |
|
ListKeyPhrasesDetectionJobsResponse |
This is the response object from the ListKeyPhrasesDetectionJobs operation. |
|
ListPiiEntitiesDetectionJobsRequest |
Container for the parameters to the ListPiiEntitiesDetectionJobs operation. Gets a list of the PII entity detection jobs that you have submitted. |
|
ListPiiEntitiesDetectionJobsResponse |
This is the response object from the ListPiiEntitiesDetectionJobs operation. |
|
ListSentimentDetectionJobsRequest |
Container for the parameters to the ListSentimentDetectionJobs operation. Gets a list of sentiment detection jobs that you have submitted. |
|
ListSentimentDetectionJobsResponse |
This is the response object from the ListSentimentDetectionJobs operation. |
|
ListTagsForResourceRequest |
Container for the parameters to the ListTagsForResource operation. Lists all tags associated with a given Amazon Comprehend resource. |
|
ListTagsForResourceResponse |
This is the response object from the ListTagsForResource operation. |
|
ListTargetedSentimentDetectionJobsRequest |
Container for the parameters to the ListTargetedSentimentDetectionJobs operation. Gets a list of targeted sentiment detection jobs that you have submitted. |
|
ListTargetedSentimentDetectionJobsResponse |
This is the response object from the ListTargetedSentimentDetectionJobs operation. |
|
ListTopicsDetectionJobsRequest |
Container for the parameters to the ListTopicsDetectionJobs operation. Gets a list of the topic detection jobs that you have submitted. |
|
ListTopicsDetectionJobsResponse |
This is the response object from the ListTopicsDetectionJobs operation. |
|
MentionSentiment |
Contains the sentiment and sentiment score for one mention of an entity. For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide. |
|
OutputDataConfig |
Provides configuration parameters for the output of inference jobs. |
|
PartOfSpeechTag |
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 Syntax in the Comprehend Developer Guide. |
|
PiiEntitiesDetectionJobFilter |
Provides information for filtering a list of PII entity detection jobs. |
|
PiiEntitiesDetectionJobProperties |
Provides information about a PII entities detection job. |
|
PiiEntity |
Provides information about a PII entity. |
|
PiiOutputDataConfig |
Provides configuration parameters for the output of PII entity detection jobs. |
|
Point |
The X and Y coordinates of a point on a document page. For additional information, see Point in the Amazon Textract API reference. |
|
PutResourcePolicyRequest |
Container for the parameters to the PutResourcePolicy operation. Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account. |
|
PutResourcePolicyResponse |
This is the response object from the PutResourcePolicy operation. |
|
RedactionConfig |
Provides configuration parameters for PII entity redaction. |
|
RelationshipsListItem |
List of child blocks for the current block. |
|
ResourceInUseException |
The specified resource name is already in use. Use a different name and try your request again. |
|
ResourceLimitExceededException |
The maximum number of resources per account has been exceeded. Review the resources, and then try your request again. |
|
ResourceNotFoundException |
The specified resource ARN was not found. Check the ARN and try your request again. |
|
ResourceUnavailableException |
The specified resource is not available. Check the resource and try your request again. |
|
SentimentDetectionJobFilter |
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation. |
|
SentimentDetectionJobProperties |
Provides information about a sentiment detection job. |
|
SentimentScore |
Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments. |
|
StartDocumentClassificationJobRequest |
Container for the parameters to the StartDocumentClassificationJob operation.
Starts an asynchronous document classification job using a custom classification model.
Use the |
|
StartDocumentClassificationJobResponse |
This is the response object from the StartDocumentClassificationJob operation. |
|
StartDominantLanguageDetectionJobRequest |
Container for the parameters to the StartDominantLanguageDetectionJob operation. Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job. |
|
StartDominantLanguageDetectionJobResponse |
This is the response object from the StartDominantLanguageDetectionJob operation. |
|
StartEntitiesDetectionJobRequest |
Container for the parameters to the StartEntitiesDetectionJob operation. Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.
This API can be used for either standard entity detection or custom entity recognition.
In order to be used for custom entity recognition, the optional |
|
StartEntitiesDetectionJobResponse |
This is the response object from the StartEntitiesDetectionJob operation. |
|
StartEventsDetectionJobRequest |
Container for the parameters to the StartEventsDetectionJob operation. Starts an asynchronous event detection job for a collection of documents. |
|
StartEventsDetectionJobResponse |
This is the response object from the StartEventsDetectionJob operation. |
|
StartFlywheelIterationRequest |
Container for the parameters to the StartFlywheelIteration operation. Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide. |
|
StartFlywheelIterationResponse |
This is the response object from the StartFlywheelIteration operation. |
|
StartKeyPhrasesDetectionJobRequest |
Container for the parameters to the StartKeyPhrasesDetectionJob operation. Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job. |
|
StartKeyPhrasesDetectionJobResponse |
This is the response object from the StartKeyPhrasesDetectionJob operation. |
|
StartPiiEntitiesDetectionJobRequest |
Container for the parameters to the StartPiiEntitiesDetectionJob operation. Starts an asynchronous PII entity detection job for a collection of documents. |
|
StartPiiEntitiesDetectionJobResponse |
This is the response object from the StartPiiEntitiesDetectionJob operation. |
|
StartSentimentDetectionJobRequest |
Container for the parameters to the StartSentimentDetectionJob operation. Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job. |
|
StartSentimentDetectionJobResponse |
This is the response object from the StartSentimentDetectionJob operation. |
|
StartTargetedSentimentDetectionJobRequest |
Container for the parameters to the StartTargetedSentimentDetectionJob operation.
Starts an asynchronous targeted sentiment detection job for a collection of documents.
Use the |
|
StartTargetedSentimentDetectionJobResponse |
This is the response object from the StartTargetedSentimentDetectionJob operation. |
|
StartTopicsDetectionJobRequest |
Container for the parameters to the StartTopicsDetectionJob operation.
Starts an asynchronous topic detection job. Use the |
|
StartTopicsDetectionJobResponse |
This is the response object from the StartTopicsDetectionJob operation. |
|
StopDominantLanguageDetectionJobRequest |
Container for the parameters to the StopDominantLanguageDetectionJob operation. Stops a dominant language detection job in progress.
If the job state is
If the job is in the When a job is stopped, any documents already processed are written to the output location. |
|
StopDominantLanguageDetectionJobResponse |
This is the response object from the StopDominantLanguageDetectionJob operation. |
|
StopEntitiesDetectionJobRequest |
Container for the parameters to the StopEntitiesDetectionJob operation. Stops an entities detection job in progress.
If the job state is
If the job is in the When a job is stopped, any documents already processed are written to the output location. |
|
StopEntitiesDetectionJobResponse |
This is the response object from the StopEntitiesDetectionJob operation. |
|
StopEventsDetectionJobRequest |
Container for the parameters to the StopEventsDetectionJob operation. Stops an events detection job in progress. |
|
StopEventsDetectionJobResponse |
This is the response object from the StopEventsDetectionJob operation. |
|
StopKeyPhrasesDetectionJobRequest |
Container for the parameters to the StopKeyPhrasesDetectionJob operation. Stops a key phrases detection job in progress.
If the job state is
If the job is in the When a job is stopped, any documents already processed are written to the output location. |
|
StopKeyPhrasesDetectionJobResponse |
This is the response object from the StopKeyPhrasesDetectionJob operation. |
|
StopPiiEntitiesDetectionJobRequest |
Container for the parameters to the StopPiiEntitiesDetectionJob operation. Stops a PII entities detection job in progress. |
|
StopPiiEntitiesDetectionJobResponse |
This is the response object from the StopPiiEntitiesDetectionJob operation. |
|
StopSentimentDetectionJobRequest |
Container for the parameters to the StopSentimentDetectionJob operation. Stops a sentiment detection job in progress.
If the job state is
If the job is in the When a job is stopped, any documents already processed are written to the output location. |
|
StopSentimentDetectionJobResponse |
This is the response object from the StopSentimentDetectionJob operation. |
|
StopTargetedSentimentDetectionJobRequest |
Container for the parameters to the StopTargetedSentimentDetectionJob operation. Stops a targeted sentiment detection job in progress.
If the job state is
If the job is in the When a job is stopped, any documents already processed are written to the output location. |
|
StopTargetedSentimentDetectionJobResponse |
This is the response object from the StopTargetedSentimentDetectionJob operation. |
|
StopTrainingDocumentClassifierRequest |
Container for the parameters to the StopTrainingDocumentClassifier operation. Stops a document classifier training job while in progress.
If the training job state is |
|
StopTrainingDocumentClassifierResponse |
This is the response object from the StopTrainingDocumentClassifier operation. |
|
StopTrainingEntityRecognizerRequest |
Container for the parameters to the StopTrainingEntityRecognizer operation. Stops an entity recognizer training job while in progress.
If the training job state is |
|
StopTrainingEntityRecognizerResponse |
This is the response object from the StopTrainingEntityRecognizer operation. |
|
SyntaxToken |
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. |
|
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. |
|
TagResourceRequest |
Container for the parameters to the TagResource operation. Associates a specific tag with an Amazon Comprehend resource. 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. |
|
TagResourceResponse |
This is the response object from the TagResource operation. |
|
TargetedSentimentDetectionJobFilter |
Provides information for filtering a list of dominant language detection jobs. For
more information, see the |
|
TargetedSentimentDetectionJobProperties |
Provides information about a targeted sentiment detection job. |
|
TargetedSentimentEntity |
Information about one of the entities found by targeted sentiment analysis. For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide. |
|
TargetedSentimentMention |
Information about one mention of an entity. The mention information includes the location of the mention in the text and the sentiment of the mention. For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide. |
|
TaskConfig |
Configuration about the model associated with a flywheel. |
|
TextSegment |
One of the of text strings. Each string has a size limit of 1KB. |
|
TextSizeLimitExceededException |
The size of the input text exceeds the limit. Use a smaller document. |
|
TooManyRequestsException |
The number of requests exceeds the limit. Resubmit your request later. |
|
TooManyTagKeysException |
The request contains more tag keys than can be associated with a resource (50 tag keys per resource). |
|
TooManyTagsException |
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. |
|
TopicsDetectionJobFilter |
Provides information for filtering topic detection jobs. For more information, see . |
|
TopicsDetectionJobProperties |
Provides information about a topic detection job. |
|
ToxicContent |
Toxic content analysis result for one string. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide |
|
ToxicLabels |
Toxicity analysis result for one string. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide. |
|
UnsupportedLanguageException |
Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide. |
|
UntagResourceRequest |
Container for the parameters to the UntagResource operation. Removes a specific tag associated with an Amazon Comprehend resource. |
|
UntagResourceResponse |
This is the response object from the UntagResource operation. |
|
UpdateDataSecurityConfig |
Data security configuration. |
|
UpdateEndpointRequest |
Container for the parameters to the UpdateEndpoint operation. Updates information about the specified endpoint. For information about endpoints, see Managing endpoints. |
|
UpdateEndpointResponse |
This is the response object from the UpdateEndpoint operation. |
|
UpdateFlywheelRequest |
Container for the parameters to the UpdateFlywheel operation. Update the configuration information for an existing flywheel. |
|
UpdateFlywheelResponse |
This is the response object from the UpdateFlywheel operation. |
|
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. |
|
WarningsListItem |
The system identified one of the following warnings while processing the input document:
|
Name | Description | |
---|---|---|
IComprehendPaginatorFactory |
Paginators for the Comprehend service |
|
IListDatasetsPaginator |
Paginator for the ListDatasets operation |
|
IListDocumentClassificationJobsPaginator |
Paginator for the ListDocumentClassificationJobs operation |
|
IListDocumentClassifiersPaginator |
Paginator for the ListDocumentClassifiers operation |
|
IListDocumentClassifierSummariesPaginator |
Paginator for the ListDocumentClassifierSummaries operation |
|
IListDominantLanguageDetectionJobsPaginator |
Paginator for the ListDominantLanguageDetectionJobs operation |
|
IListEndpointsPaginator |
Paginator for the ListEndpoints operation |
|
IListEntitiesDetectionJobsPaginator |
Paginator for the ListEntitiesDetectionJobs operation |
|
IListEntityRecognizersPaginator |
Paginator for the ListEntityRecognizers operation |
|
IListEntityRecognizerSummariesPaginator |
Paginator for the ListEntityRecognizerSummaries operation |
|
IListEventsDetectionJobsPaginator |
Paginator for the ListEventsDetectionJobs operation |
|
IListFlywheelIterationHistoryPaginator |
Paginator for the ListFlywheelIterationHistory operation |
|
IListFlywheelsPaginator |
Paginator for the ListFlywheels operation |
|
IListKeyPhrasesDetectionJobsPaginator |
Paginator for the ListKeyPhrasesDetectionJobs operation |
|
IListPiiEntitiesDetectionJobsPaginator |
Paginator for the ListPiiEntitiesDetectionJobs operation |
|
IListSentimentDetectionJobsPaginator |
Paginator for the ListSentimentDetectionJobs operation |
|
IListTargetedSentimentDetectionJobsPaginator |
Paginator for the ListTargetedSentimentDetectionJobs operation |
|
IListTopicsDetectionJobsPaginator |
Paginator for the ListTopicsDetectionJobs operation |