AWS SDK for C++AWS SDK for C++ Version 1.11.440 |
#include <ComprehendClient.h>
Amazon Comprehend is an Amazon Web Services 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.
Definition at line 24 of file ComprehendClient.h.
Definition at line 27 of file ComprehendClient.h.
Definition at line 31 of file ComprehendClient.h.
Definition at line 32 of file ComprehendClient.h.
Aws::Comprehend::ComprehendClientConfiguration()
,
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Comprehend::ComprehendClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Comprehend::ComprehendClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
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.
nullptr
An Async wrapper for BatchDetectDominantLanguage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 105 of file ComprehendClient.h.
A Callable wrapper for BatchDetectDominantLanguage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 96 of file ComprehendClient.h.
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.
nullptr
An Async wrapper for BatchDetectEntities that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 133 of file ComprehendClient.h.
A Callable wrapper for BatchDetectEntities that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 124 of file ComprehendClient.h.
nullptr
An Async wrapper for BatchDetectKeyPhrases that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 159 of file ComprehendClient.h.
A Callable wrapper for BatchDetectKeyPhrases that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 150 of file ComprehendClient.h.
Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE
, NEUTRAL
, MIXED
, or NEGATIVE
, in each one.
nullptr
An Async wrapper for BatchDetectSentiment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 186 of file ComprehendClient.h.
A Callable wrapper for BatchDetectSentiment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 177 of file ComprehendClient.h.
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.
nullptr
An Async wrapper for BatchDetectSyntax that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 215 of file ComprehendClient.h.
A Callable wrapper for BatchDetectSyntax that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 206 of file ComprehendClient.h.
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.
nullptr
An Async wrapper for BatchDetectTargetedSentiment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 245 of file ComprehendClient.h.
A Callable wrapper for BatchDetectTargetedSentiment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 236 of file ComprehendClient.h.
Creates a classification request to analyze a single document in real-time. ClassifyDocument
supports the following model types:
Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document (PDF, Word, or image), or Amazon Textract API output. For more information, see Custom classification in the Amazon Comprehend Developer Guide.
Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying input prompts for generative AI applications. For input, you provide English plain text input. For prompt safety classification, the response includes only the Classes
field. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide.
If the system detects errors while processing a page in the input document, the API response includes an Errors
field that describes the errors.
If the system detects a document-level error in your input document, the API returns an InvalidRequestException
error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.
nullptr
An Async wrapper for ClassifyDocument that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 291 of file ComprehendClient.h.
A Callable wrapper for ClassifyDocument that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 282 of file ComprehendClient.h.
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.
nullptr
An Async wrapper for ContainsPiiEntities that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 318 of file ComprehendClient.h.
A Callable wrapper for ContainsPiiEntities that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 309 of file ComprehendClient.h.
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.
nullptr
An Async wrapper for CreateDataset that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 347 of file ComprehendClient.h.
A Callable wrapper for CreateDataset that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 338 of file ComprehendClient.h.
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.
nullptr
An Async wrapper for CreateDocumentClassifier that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 377 of file ComprehendClient.h.
A Callable wrapper for CreateDocumentClassifier that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 368 of file ComprehendClient.h.
Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.
nullptr
An Async wrapper for CreateEndpoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 405 of file ComprehendClient.h.
A Callable wrapper for CreateEndpoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 396 of file ComprehendClient.h.
Creates an entity recognizer using submitted files. After your CreateEntityRecognizer
request is submitted, you can check job status using the DescribeEntityRecognizer
API.
nullptr
An Async wrapper for CreateEntityRecognizer that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 433 of file ComprehendClient.h.
A Callable wrapper for CreateEntityRecognizer that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 424 of file ComprehendClient.h.
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.
nullptr
An Async wrapper for CreateFlywheel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 471 of file ComprehendClient.h.
A Callable wrapper for CreateFlywheel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 462 of file ComprehendClient.h.
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 ResourceInUseException
will be returned.
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.
nullptr
An Async wrapper for DeleteDocumentClassifier that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 502 of file ComprehendClient.h.
A Callable wrapper for DeleteDocumentClassifier that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 493 of file ComprehendClient.h.
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.
nullptr
An Async wrapper for DeleteEndpoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 531 of file ComprehendClient.h.
A Callable wrapper for DeleteEndpoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 522 of file ComprehendClient.h.
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 ResourceInUseException
will be returned.
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.
nullptr
An Async wrapper for DeleteEntityRecognizer that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 562 of file ComprehendClient.h.
A Callable wrapper for DeleteEntityRecognizer that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 553 of file ComprehendClient.h.
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.
nullptr
An Async wrapper for DeleteFlywheel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 592 of file ComprehendClient.h.
A Callable wrapper for DeleteFlywheel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 583 of file ComprehendClient.h.
nullptr
An Async wrapper for DeleteResourcePolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 618 of file ComprehendClient.h.
A Callable wrapper for DeleteResourcePolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 609 of file ComprehendClient.h.
Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
nullptr
An Async wrapper for DescribeDataset that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 647 of file ComprehendClient.h.
A Callable wrapper for DescribeDataset that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 638 of file ComprehendClient.h.
Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
nullptr
An Async wrapper for DescribeDocumentClassificationJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 674 of file ComprehendClient.h.
A Callable wrapper for DescribeDocumentClassificationJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 665 of file ComprehendClient.h.
nullptr
An Async wrapper for DescribeDocumentClassifier that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 700 of file ComprehendClient.h.
A Callable wrapper for DescribeDocumentClassifier that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 691 of file ComprehendClient.h.
Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
nullptr
An Async wrapper for DescribeDominantLanguageDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 727 of file ComprehendClient.h.
A Callable wrapper for DescribeDominantLanguageDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 718 of file ComprehendClient.h.
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.
nullptr
An Async wrapper for DescribeEndpoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 755 of file ComprehendClient.h.
A Callable wrapper for DescribeEndpoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 746 of file ComprehendClient.h.
Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
nullptr
An Async wrapper for DescribeEntitiesDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 781 of file ComprehendClient.h.
A Callable wrapper for DescribeEntitiesDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 772 of file ComprehendClient.h.
Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
nullptr
An Async wrapper for DescribeEntityRecognizer that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 808 of file ComprehendClient.h.
A Callable wrapper for DescribeEntityRecognizer that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 799 of file ComprehendClient.h.
nullptr
An Async wrapper for DescribeEventsDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 834 of file ComprehendClient.h.
A Callable wrapper for DescribeEventsDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 825 of file ComprehendClient.h.
Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
nullptr
An Async wrapper for DescribeFlywheel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 863 of file ComprehendClient.h.
A Callable wrapper for DescribeFlywheel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 854 of file ComprehendClient.h.
Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
nullptr
An Async wrapper for DescribeFlywheelIteration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 892 of file ComprehendClient.h.
A Callable wrapper for DescribeFlywheelIteration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 883 of file ComprehendClient.h.
Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
nullptr
An Async wrapper for DescribeKeyPhrasesDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 918 of file ComprehendClient.h.
A Callable wrapper for DescribeKeyPhrasesDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 909 of file ComprehendClient.h.
Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
nullptr
An Async wrapper for DescribePiiEntitiesDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 945 of file ComprehendClient.h.
A Callable wrapper for DescribePiiEntitiesDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 936 of file ComprehendClient.h.
Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
nullptr
An Async wrapper for DescribeResourcePolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 971 of file ComprehendClient.h.
A Callable wrapper for DescribeResourcePolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 962 of file ComprehendClient.h.
Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
nullptr
An Async wrapper for DescribeSentimentDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 997 of file ComprehendClient.h.
A Callable wrapper for DescribeSentimentDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 988 of file ComprehendClient.h.
Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.
nullptr
An Async wrapper for DescribeTargetedSentimentDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1023 of file ComprehendClient.h.
A Callable wrapper for DescribeTargetedSentimentDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1014 of file ComprehendClient.h.
Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
nullptr
An Async wrapper for DescribeTopicsDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1049 of file ComprehendClient.h.
A Callable wrapper for DescribeTopicsDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1040 of file ComprehendClient.h.
Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
nullptr
An Async wrapper for DetectDominantLanguage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1077 of file ComprehendClient.h.
A Callable wrapper for DetectDominantLanguage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1068 of file ComprehendClient.h.
{}
)
const
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 Errors
for each error.
If the system detects a document-level error in your input document, the API returns an InvalidRequestException
error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.
nullptr
,
{}
An Async wrapper for DetectEntities that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1117 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for DetectEntities that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1108 of file ComprehendClient.h.
nullptr
An Async wrapper for DetectKeyPhrases that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1143 of file ComprehendClient.h.
A Callable wrapper for DetectKeyPhrases that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1134 of file ComprehendClient.h.
Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
nullptr
An Async wrapper for DetectPiiEntities that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1170 of file ComprehendClient.h.
A Callable wrapper for DetectPiiEntities that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1161 of file ComprehendClient.h.
Inspects text and returns an inference of the prevailing sentiment (POSITIVE
, NEUTRAL
, MIXED
, or NEGATIVE
).
nullptr
An Async wrapper for DetectSentiment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1197 of file ComprehendClient.h.
A Callable wrapper for DetectSentiment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1188 of file ComprehendClient.h.
Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.
nullptr
An Async wrapper for DetectSyntax that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1225 of file ComprehendClient.h.
A Callable wrapper for DetectSyntax that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1216 of file ComprehendClient.h.
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.
nullptr
An Async wrapper for DetectTargetedSentiment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1255 of file ComprehendClient.h.
A Callable wrapper for DetectTargetedSentiment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1246 of file ComprehendClient.h.
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.
nullptr
An Async wrapper for DetectToxicContent that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1285 of file ComprehendClient.h.
A Callable wrapper for DetectToxicContent that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1276 of file ComprehendClient.h.
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.
nullptr
An Async wrapper for ImportModel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1316 of file ComprehendClient.h.
A Callable wrapper for ImportModel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1307 of file ComprehendClient.h.
{}
)
const
List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
nullptr
,
{}
An Async wrapper for ListDatasets that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1345 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for ListDatasets that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1336 of file ComprehendClient.h.
{}
)
const
Gets a list of the documentation classification jobs that you have submitted.
nullptr
,
{}
An Async wrapper for ListDocumentClassificationJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1371 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for ListDocumentClassificationJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1362 of file ComprehendClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListDocumentClassifiers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1423 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for ListDocumentClassifiers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1414 of file ComprehendClient.h.
{}
)
const
Gets a list of summaries of the document classifiers that you have created
nullptr
,
{}
An Async wrapper for ListDocumentClassifierSummaries that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1397 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for ListDocumentClassifierSummaries that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1388 of file ComprehendClient.h.
{}
)
const
Gets a list of the dominant language detection jobs that you have submitted.
nullptr
,
{}
An Async wrapper for ListDominantLanguageDetectionJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1449 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for ListDominantLanguageDetectionJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1440 of file ComprehendClient.h.
{}
)
const
Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.
nullptr
,
{}
An Async wrapper for ListEndpoints that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1477 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for ListEndpoints that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1468 of file ComprehendClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListEntitiesDetectionJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1503 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for ListEntitiesDetectionJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1494 of file ComprehendClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListEntityRecognizers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1560 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for ListEntityRecognizers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1551 of file ComprehendClient.h.
{}
)
const
Gets a list of summaries for the entity recognizers that you have created.
nullptr
,
{}
An Async wrapper for ListEntityRecognizerSummaries that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1529 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for ListEntityRecognizerSummaries that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1520 of file ComprehendClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListEventsDetectionJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1586 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for ListEventsDetectionJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1577 of file ComprehendClient.h.
Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
nullptr
An Async wrapper for ListFlywheelIterationHistory that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1615 of file ComprehendClient.h.
A Callable wrapper for ListFlywheelIterationHistory that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1606 of file ComprehendClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListFlywheels that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1641 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for ListFlywheels that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1632 of file ComprehendClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListKeyPhrasesDetectionJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1667 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for ListKeyPhrasesDetectionJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1658 of file ComprehendClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListPiiEntitiesDetectionJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1693 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for ListPiiEntitiesDetectionJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1684 of file ComprehendClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListSentimentDetectionJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1719 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for ListSentimentDetectionJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1710 of file ComprehendClient.h.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1745 of file ComprehendClient.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1736 of file ComprehendClient.h.
{}
)
const
Gets a list of targeted sentiment detection jobs that you have submitted.
nullptr
,
{}
An Async wrapper for ListTargetedSentimentDetectionJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1771 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for ListTargetedSentimentDetectionJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1762 of file ComprehendClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListTopicsDetectionJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1797 of file ComprehendClient.h.
{}
)
const
A Callable wrapper for ListTopicsDetectionJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1788 of file ComprehendClient.h.
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.
nullptr
An Async wrapper for PutResourcePolicy that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1825 of file ComprehendClient.h.
A Callable wrapper for PutResourcePolicy that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1816 of file ComprehendClient.h.
Starts an asynchronous document classification job using a custom classification model. Use the DescribeDocumentClassificationJob
operation to track the progress of the job.
nullptr
An Async wrapper for StartDocumentClassificationJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1852 of file ComprehendClient.h.
A Callable wrapper for StartDocumentClassificationJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1843 of file ComprehendClient.h.
Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
nullptr
An Async wrapper for StartDominantLanguageDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1879 of file ComprehendClient.h.
A Callable wrapper for StartDominantLanguageDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1870 of file ComprehendClient.h.
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 EntityRecognizerArn
must be used in order to provide access to the recognizer being used to detect the custom entity.
nullptr
An Async wrapper for StartEntitiesDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1909 of file ComprehendClient.h.
A Callable wrapper for StartEntitiesDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1900 of file ComprehendClient.h.
Starts an asynchronous event detection job for a collection of documents.
nullptr
An Async wrapper for StartEventsDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1935 of file ComprehendClient.h.
A Callable wrapper for StartEventsDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1926 of file ComprehendClient.h.
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.
nullptr
An Async wrapper for StartFlywheelIteration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1964 of file ComprehendClient.h.
A Callable wrapper for StartFlywheelIteration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1955 of file ComprehendClient.h.
Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
nullptr
An Async wrapper for StartKeyPhrasesDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1991 of file ComprehendClient.h.
A Callable wrapper for StartKeyPhrasesDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1982 of file ComprehendClient.h.
Starts an asynchronous PII entity detection job for a collection of documents.
nullptr
An Async wrapper for StartPiiEntitiesDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2017 of file ComprehendClient.h.
A Callable wrapper for StartPiiEntitiesDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2008 of file ComprehendClient.h.
Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.
nullptr
An Async wrapper for StartSentimentDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2043 of file ComprehendClient.h.
A Callable wrapper for StartSentimentDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2034 of file ComprehendClient.h.
Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob
operation to track the status of a job.
nullptr
An Async wrapper for StartTargetedSentimentDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2070 of file ComprehendClient.h.
A Callable wrapper for StartTargetedSentimentDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2061 of file ComprehendClient.h.
Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob
operation to track the status of a job.
nullptr
An Async wrapper for StartTopicsDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2097 of file ComprehendClient.h.
A Callable wrapper for StartTopicsDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2088 of file ComprehendClient.h.
Stops a dominant language detection job in progress.
If the job state is IN_PROGRESS
the job is marked for termination and put into the STOP_REQUESTED
state. If the job completes before it can be stopped, it is put into the COMPLETED
state; otherwise the job is stopped and put into the STOPPED
state.
If the job is in the COMPLETED
or FAILED
state when you call the StopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
nullptr
An Async wrapper for StopDominantLanguageDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2131 of file ComprehendClient.h.
A Callable wrapper for StopDominantLanguageDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2122 of file ComprehendClient.h.
Stops an entities detection job in progress.
If the job state is IN_PROGRESS
the job is marked for termination and put into the STOP_REQUESTED
state. If the job completes before it can be stopped, it is put into the COMPLETED
state; otherwise the job is stopped and put into the STOPPED
state.
If the job is in the COMPLETED
or FAILED
state when you call the StopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
nullptr
An Async wrapper for StopEntitiesDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2165 of file ComprehendClient.h.
A Callable wrapper for StopEntitiesDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2156 of file ComprehendClient.h.
nullptr
An Async wrapper for StopEventsDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2190 of file ComprehendClient.h.
A Callable wrapper for StopEventsDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2181 of file ComprehendClient.h.
Stops a key phrases detection job in progress.
If the job state is IN_PROGRESS
the job is marked for termination and put into the STOP_REQUESTED
state. If the job completes before it can be stopped, it is put into the COMPLETED
state; otherwise the job is stopped and put into the STOPPED
state.
If the job is in the COMPLETED
or FAILED
state when you call the StopDominantLanguageDetectionJob
operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
nullptr
An Async wrapper for StopKeyPhrasesDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2224 of file ComprehendClient.h.
A Callable wrapper for StopKeyPhrasesDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2215 of file ComprehendClient.h.
nullptr
An Async wrapper for StopPiiEntitiesDetectionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2249 of file ComprehendClient.h.
A Callable wrapper for StopPiiEntitiesDetectionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2240 of file ComprehendClient.h.