AWSComprehend Class Reference

Inherits from AWSService : NSObject
Declared in AWSComprehendService.h
AWSComprehendService.m

Overview

Amazon Comprehend is an AWS service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.

  configuration

The service configuration used to instantiate this service client.

@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

Discussion

Warning: Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

Declared In

AWSComprehendService.h

+ defaultComprehend

Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

+ (instancetype)defaultComprehend

Return Value

The default service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
    AWSServiceManager.default().defaultServiceConfiguration = configuration

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
      AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                      identityPoolId:@"YourIdentityPoolId"];
      AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                           credentialsProvider:credentialsProvider];
      [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;

      return YES;
  }

Then call the following to get the default service client:

Swift

 let Comprehend = AWSComprehend.default()

Objective-C

 AWSComprehend *Comprehend = [AWSComprehend defaultComprehend];

Declared In

AWSComprehendService.h

+ registerComprehendWithConfiguration:forKey:

Creates a service client with the given service configuration and registers it for the key.

+ (void)registerComprehendWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key

Parameters

configuration

A service configuration object.

key

A string to identify the service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
    AWSComprehend.register(with: configuration!, forKey: "USWest2Comprehend")

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                          credentialsProvider:credentialsProvider];

     [AWSComprehend registerComprehendWithConfiguration:configuration forKey:@"USWest2Comprehend"];

     return YES;
 }

Then call the following to get the service client:

Swift

 let Comprehend = AWSComprehend(forKey: "USWest2Comprehend")

Objective-C

 AWSComprehend *Comprehend = [AWSComprehend ComprehendForKey:@"USWest2Comprehend"];

Warning: After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

Declared In

AWSComprehendService.h

+ ComprehendForKey:

Retrieves the service client associated with the key. You need to call + registerComprehendWithConfiguration:forKey: before invoking this method.

+ (instancetype)ComprehendForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Return Value

An instance of the service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
    AWSComprehend.register(with: configuration!, forKey: "USWest2Comprehend")

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                          credentialsProvider:credentialsProvider];

     [AWSComprehend registerComprehendWithConfiguration:configuration forKey:@"USWest2Comprehend"];

     return YES;
 }

Then call the following to get the service client:

Swift

 let Comprehend = AWSComprehend(forKey: "USWest2Comprehend")

Objective-C

 AWSComprehend *Comprehend = [AWSComprehend ComprehendForKey:@"USWest2Comprehend"];

Declared In

AWSComprehendService.h

+ removeComprehendForKey:

Removes the service client associated with the key and release it.

+ (void)removeComprehendForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Discussion

Warning: Before calling this method, make sure no method is running on this client.

Declared In

AWSComprehendService.h

– batchDetectDominantLanguage:

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.

- (AWSTask<AWSComprehendBatchDetectDominantLanguageResponse*> *)batchDetectDominantLanguage:(AWSComprehendBatchDetectDominantLanguageRequest *)request

Parameters

request

A container for the necessary parameters to execute the BatchDetectDominantLanguage service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendBatchDetectDominantLanguageResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorBatchSizeLimitExceeded, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– batchDetectDominantLanguage:completionHandler:

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.

- (void)batchDetectDominantLanguage:(AWSComprehendBatchDetectDominantLanguageRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendBatchDetectDominantLanguageResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the BatchDetectDominantLanguage service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorBatchSizeLimitExceeded, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– batchDetectEntities:

Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see how-entities

- (AWSTask<AWSComprehendBatchDetectEntitiesResponse*> *)batchDetectEntities:(AWSComprehendBatchDetectEntitiesRequest *)request

Parameters

request

A container for the necessary parameters to execute the BatchDetectEntities service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendBatchDetectEntitiesResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorBatchSizeLimitExceeded, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– batchDetectEntities:completionHandler:

Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see how-entities

- (void)batchDetectEntities:(AWSComprehendBatchDetectEntitiesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendBatchDetectEntitiesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the BatchDetectEntities service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorBatchSizeLimitExceeded, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– batchDetectKeyPhrases:

Detects the key noun phrases found in a batch of documents.

- (AWSTask<AWSComprehendBatchDetectKeyPhrasesResponse*> *)batchDetectKeyPhrases:(AWSComprehendBatchDetectKeyPhrasesRequest *)request

Parameters

request

A container for the necessary parameters to execute the BatchDetectKeyPhrases service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendBatchDetectKeyPhrasesResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorBatchSizeLimitExceeded, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– batchDetectKeyPhrases:completionHandler:

Detects the key noun phrases found in a batch of documents.

- (void)batchDetectKeyPhrases:(AWSComprehendBatchDetectKeyPhrasesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendBatchDetectKeyPhrasesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the BatchDetectKeyPhrases service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorBatchSizeLimitExceeded, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– batchDetectSentiment:

Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.

- (AWSTask<AWSComprehendBatchDetectSentimentResponse*> *)batchDetectSentiment:(AWSComprehendBatchDetectSentimentRequest *)request

Parameters

request

A container for the necessary parameters to execute the BatchDetectSentiment service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendBatchDetectSentimentResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorBatchSizeLimitExceeded, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– batchDetectSentiment:completionHandler:

Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.

- (void)batchDetectSentiment:(AWSComprehendBatchDetectSentimentRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendBatchDetectSentimentResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the BatchDetectSentiment service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorBatchSizeLimitExceeded, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– batchDetectSyntax:

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 how-syntax.

- (AWSTask<AWSComprehendBatchDetectSyntaxResponse*> *)batchDetectSyntax:(AWSComprehendBatchDetectSyntaxRequest *)request

Parameters

request

A container for the necessary parameters to execute the BatchDetectSyntax service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendBatchDetectSyntaxResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorBatchSizeLimitExceeded, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– batchDetectSyntax:completionHandler:

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 how-syntax.

- (void)batchDetectSyntax:(AWSComprehendBatchDetectSyntaxRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendBatchDetectSyntaxResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the BatchDetectSyntax service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorBatchSizeLimitExceeded, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– createDocumentClassifier:

Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.

- (AWSTask<AWSComprehendCreateDocumentClassifierResponse*> *)createDocumentClassifier:(AWSComprehendCreateDocumentClassifierRequest *)request

Parameters

request

A container for the necessary parameters to execute the CreateDocumentClassifier service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendCreateDocumentClassifierResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorResourceInUse, AWSComprehendErrorTooManyTags, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorKmsKeyValidation, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– createDocumentClassifier:completionHandler:

Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.

- (void)createDocumentClassifier:(AWSComprehendCreateDocumentClassifierRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendCreateDocumentClassifierResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateDocumentClassifier service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorResourceInUse, AWSComprehendErrorTooManyTags, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorKmsKeyValidation, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– createEntityRecognizer:

Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.

- (AWSTask<AWSComprehendCreateEntityRecognizerResponse*> *)createEntityRecognizer:(AWSComprehendCreateEntityRecognizerRequest *)request

Parameters

request

A container for the necessary parameters to execute the CreateEntityRecognizer service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendCreateEntityRecognizerResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorResourceInUse, AWSComprehendErrorTooManyTags, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorKmsKeyValidation, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– createEntityRecognizer:completionHandler:

Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.

- (void)createEntityRecognizer:(AWSComprehendCreateEntityRecognizerRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendCreateEntityRecognizerResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateEntityRecognizer service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorResourceInUse, AWSComprehendErrorTooManyTags, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorKmsKeyValidation, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– deleteDocumentClassifier:

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.

- (AWSTask<AWSComprehendDeleteDocumentClassifierResponse*> *)deleteDocumentClassifier:(AWSComprehendDeleteDocumentClassifierRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeleteDocumentClassifier service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDeleteDocumentClassifierResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceNotFound, AWSComprehendErrorResourceUnavailable, AWSComprehendErrorResourceInUse, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– deleteDocumentClassifier:completionHandler:

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.

- (void)deleteDocumentClassifier:(AWSComprehendDeleteDocumentClassifierRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendDeleteDocumentClassifierResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteDocumentClassifier service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceNotFound, AWSComprehendErrorResourceUnavailable, AWSComprehendErrorResourceInUse, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– deleteEntityRecognizer:

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.

- (AWSTask<AWSComprehendDeleteEntityRecognizerResponse*> *)deleteEntityRecognizer:(AWSComprehendDeleteEntityRecognizerRequest *)request

Parameters

request

A container for the necessary parameters to execute the DeleteEntityRecognizer service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDeleteEntityRecognizerResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceNotFound, AWSComprehendErrorResourceUnavailable, AWSComprehendErrorResourceInUse, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– deleteEntityRecognizer:completionHandler:

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.

- (void)deleteEntityRecognizer:(AWSComprehendDeleteEntityRecognizerRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendDeleteEntityRecognizerResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteEntityRecognizer service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceNotFound, AWSComprehendErrorResourceUnavailable, AWSComprehendErrorResourceInUse, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– describeDocumentClassificationJob:

Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.

- (AWSTask<AWSComprehendDescribeDocumentClassificationJobResponse*> *)describeDocumentClassificationJob:(AWSComprehendDescribeDocumentClassificationJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the DescribeDocumentClassificationJob service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDescribeDocumentClassificationJobResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorJobNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– describeDocumentClassificationJob:completionHandler:

Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.

- (void)describeDocumentClassificationJob:(AWSComprehendDescribeDocumentClassificationJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendDescribeDocumentClassificationJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeDocumentClassificationJob service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorJobNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– describeDocumentClassifier:

Gets the properties associated with a document classifier.

- (AWSTask<AWSComprehendDescribeDocumentClassifierResponse*> *)describeDocumentClassifier:(AWSComprehendDescribeDocumentClassifierRequest *)request

Parameters

request

A container for the necessary parameters to execute the DescribeDocumentClassifier service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDescribeDocumentClassifierResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– describeDocumentClassifier:completionHandler:

Gets the properties associated with a document classifier.

- (void)describeDocumentClassifier:(AWSComprehendDescribeDocumentClassifierRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendDescribeDocumentClassifierResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeDocumentClassifier service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– describeDominantLanguageDetectionJob:

Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.

- (AWSTask<AWSComprehendDescribeDominantLanguageDetectionJobResponse*> *)describeDominantLanguageDetectionJob:(AWSComprehendDescribeDominantLanguageDetectionJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the DescribeDominantLanguageDetectionJob service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDescribeDominantLanguageDetectionJobResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– describeDominantLanguageDetectionJob:completionHandler:

Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.

- (void)describeDominantLanguageDetectionJob:(AWSComprehendDescribeDominantLanguageDetectionJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendDescribeDominantLanguageDetectionJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeDominantLanguageDetectionJob service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– describeEntitiesDetectionJob:

Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.

- (AWSTask<AWSComprehendDescribeEntitiesDetectionJobResponse*> *)describeEntitiesDetectionJob:(AWSComprehendDescribeEntitiesDetectionJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the DescribeEntitiesDetectionJob service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDescribeEntitiesDetectionJobResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– describeEntitiesDetectionJob:completionHandler:

Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.

- (void)describeEntitiesDetectionJob:(AWSComprehendDescribeEntitiesDetectionJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendDescribeEntitiesDetectionJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeEntitiesDetectionJob service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– describeEntityRecognizer:

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

- (AWSTask<AWSComprehendDescribeEntityRecognizerResponse*> *)describeEntityRecognizer:(AWSComprehendDescribeEntityRecognizerRequest *)request

Parameters

request

A container for the necessary parameters to execute the DescribeEntityRecognizer service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDescribeEntityRecognizerResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– describeEntityRecognizer:completionHandler:

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

- (void)describeEntityRecognizer:(AWSComprehendDescribeEntityRecognizerRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendDescribeEntityRecognizerResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeEntityRecognizer service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– describeKeyPhrasesDetectionJob:

Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.

- (AWSTask<AWSComprehendDescribeKeyPhrasesDetectionJobResponse*> *)describeKeyPhrasesDetectionJob:(AWSComprehendDescribeKeyPhrasesDetectionJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the DescribeKeyPhrasesDetectionJob service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDescribeKeyPhrasesDetectionJobResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– describeKeyPhrasesDetectionJob:completionHandler:

Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.

- (void)describeKeyPhrasesDetectionJob:(AWSComprehendDescribeKeyPhrasesDetectionJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendDescribeKeyPhrasesDetectionJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeKeyPhrasesDetectionJob service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– describeSentimentDetectionJob:

Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.

- (AWSTask<AWSComprehendDescribeSentimentDetectionJobResponse*> *)describeSentimentDetectionJob:(AWSComprehendDescribeSentimentDetectionJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the DescribeSentimentDetectionJob service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDescribeSentimentDetectionJobResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– describeSentimentDetectionJob:completionHandler:

Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.

- (void)describeSentimentDetectionJob:(AWSComprehendDescribeSentimentDetectionJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendDescribeSentimentDetectionJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeSentimentDetectionJob service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– describeTopicsDetectionJob:

Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.

- (AWSTask<AWSComprehendDescribeTopicsDetectionJobResponse*> *)describeTopicsDetectionJob:(AWSComprehendDescribeTopicsDetectionJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the DescribeTopicsDetectionJob service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDescribeTopicsDetectionJobResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– describeTopicsDetectionJob:completionHandler:

Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.

- (void)describeTopicsDetectionJob:(AWSComprehendDescribeTopicsDetectionJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendDescribeTopicsDetectionJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DescribeTopicsDetectionJob service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– detectDominantLanguage:

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

- (AWSTask<AWSComprehendDetectDominantLanguageResponse*> *)detectDominantLanguage:(AWSComprehendDetectDominantLanguageRequest *)request

Parameters

request

A container for the necessary parameters to execute the DetectDominantLanguage service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDetectDominantLanguageResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– detectDominantLanguage:completionHandler:

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

- (void)detectDominantLanguage:(AWSComprehendDetectDominantLanguageRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendDetectDominantLanguageResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DetectDominantLanguage service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– detectEntities:

Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.

- (AWSTask<AWSComprehendDetectEntitiesResponse*> *)detectEntities:(AWSComprehendDetectEntitiesRequest *)request

Parameters

request

A container for the necessary parameters to execute the DetectEntities service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDetectEntitiesResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– detectEntities:completionHandler:

Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.

- (void)detectEntities:(AWSComprehendDetectEntitiesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendDetectEntitiesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DetectEntities service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– detectKeyPhrases:

Detects the key noun phrases found in the text.

- (AWSTask<AWSComprehendDetectKeyPhrasesResponse*> *)detectKeyPhrases:(AWSComprehendDetectKeyPhrasesRequest *)request

Parameters

request

A container for the necessary parameters to execute the DetectKeyPhrases service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDetectKeyPhrasesResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– detectKeyPhrases:completionHandler:

Detects the key noun phrases found in the text.

- (void)detectKeyPhrases:(AWSComprehendDetectKeyPhrasesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendDetectKeyPhrasesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DetectKeyPhrases service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– detectSentiment:

Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

- (AWSTask<AWSComprehendDetectSentimentResponse*> *)detectSentiment:(AWSComprehendDetectSentimentRequest *)request

Parameters

request

A container for the necessary parameters to execute the DetectSentiment service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDetectSentimentResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– detectSentiment:completionHandler:

Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

- (void)detectSentiment:(AWSComprehendDetectSentimentRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendDetectSentimentResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DetectSentiment service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– detectSyntax:

Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.

- (AWSTask<AWSComprehendDetectSyntaxResponse*> *)detectSyntax:(AWSComprehendDetectSyntaxRequest *)request

Parameters

request

A container for the necessary parameters to execute the DetectSyntax service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDetectSyntaxResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– detectSyntax:completionHandler:

Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.

- (void)detectSyntax:(AWSComprehendDetectSyntaxRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendDetectSyntaxResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DetectSyntax service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listDocumentClassificationJobs:

Gets a list of the documentation classification jobs that you have submitted.

- (AWSTask<AWSComprehendListDocumentClassificationJobsResponse*> *)listDocumentClassificationJobs:(AWSComprehendListDocumentClassificationJobsRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListDocumentClassificationJobs service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendListDocumentClassificationJobsResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInvalidFilter, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listDocumentClassificationJobs:completionHandler:

Gets a list of the documentation classification jobs that you have submitted.

- (void)listDocumentClassificationJobs:(AWSComprehendListDocumentClassificationJobsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendListDocumentClassificationJobsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListDocumentClassificationJobs service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInvalidFilter, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listDocumentClassifiers:

Gets a list of the document classifiers that you have created.

- (AWSTask<AWSComprehendListDocumentClassifiersResponse*> *)listDocumentClassifiers:(AWSComprehendListDocumentClassifiersRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListDocumentClassifiers service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendListDocumentClassifiersResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInvalidFilter, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listDocumentClassifiers:completionHandler:

Gets a list of the document classifiers that you have created.

- (void)listDocumentClassifiers:(AWSComprehendListDocumentClassifiersRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendListDocumentClassifiersResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListDocumentClassifiers service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInvalidFilter, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listDominantLanguageDetectionJobs:

Gets a list of the dominant language detection jobs that you have submitted.

- (AWSTask<AWSComprehendListDominantLanguageDetectionJobsResponse*> *)listDominantLanguageDetectionJobs:(AWSComprehendListDominantLanguageDetectionJobsRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListDominantLanguageDetectionJobs service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendListDominantLanguageDetectionJobsResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInvalidFilter, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listDominantLanguageDetectionJobs:completionHandler:

Gets a list of the dominant language detection jobs that you have submitted.

- (void)listDominantLanguageDetectionJobs:(AWSComprehendListDominantLanguageDetectionJobsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendListDominantLanguageDetectionJobsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListDominantLanguageDetectionJobs service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInvalidFilter, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listEntitiesDetectionJobs:

Gets a list of the entity detection jobs that you have submitted.

- (AWSTask<AWSComprehendListEntitiesDetectionJobsResponse*> *)listEntitiesDetectionJobs:(AWSComprehendListEntitiesDetectionJobsRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListEntitiesDetectionJobs service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendListEntitiesDetectionJobsResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInvalidFilter, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listEntitiesDetectionJobs:completionHandler:

Gets a list of the entity detection jobs that you have submitted.

- (void)listEntitiesDetectionJobs:(AWSComprehendListEntitiesDetectionJobsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendListEntitiesDetectionJobsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListEntitiesDetectionJobs service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInvalidFilter, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listEntityRecognizers:

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.

- (AWSTask<AWSComprehendListEntityRecognizersResponse*> *)listEntityRecognizers:(AWSComprehendListEntityRecognizersRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListEntityRecognizers service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendListEntityRecognizersResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInvalidFilter, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listEntityRecognizers:completionHandler:

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.

- (void)listEntityRecognizers:(AWSComprehendListEntityRecognizersRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendListEntityRecognizersResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListEntityRecognizers service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInvalidFilter, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listKeyPhrasesDetectionJobs:

Get a list of key phrase detection jobs that you have submitted.

- (AWSTask<AWSComprehendListKeyPhrasesDetectionJobsResponse*> *)listKeyPhrasesDetectionJobs:(AWSComprehendListKeyPhrasesDetectionJobsRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListKeyPhrasesDetectionJobs service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendListKeyPhrasesDetectionJobsResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInvalidFilter, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listKeyPhrasesDetectionJobs:completionHandler:

Get a list of key phrase detection jobs that you have submitted.

- (void)listKeyPhrasesDetectionJobs:(AWSComprehendListKeyPhrasesDetectionJobsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendListKeyPhrasesDetectionJobsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListKeyPhrasesDetectionJobs service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInvalidFilter, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listSentimentDetectionJobs:

Gets a list of sentiment detection jobs that you have submitted.

- (AWSTask<AWSComprehendListSentimentDetectionJobsResponse*> *)listSentimentDetectionJobs:(AWSComprehendListSentimentDetectionJobsRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListSentimentDetectionJobs service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendListSentimentDetectionJobsResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInvalidFilter, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listSentimentDetectionJobs:completionHandler:

Gets a list of sentiment detection jobs that you have submitted.

- (void)listSentimentDetectionJobs:(AWSComprehendListSentimentDetectionJobsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendListSentimentDetectionJobsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListSentimentDetectionJobs service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInvalidFilter, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listTagsForResource:

Lists all tags associated with a given Amazon Comprehend resource.

- (AWSTask<AWSComprehendListTagsForResourceResponse*> *)listTagsForResource:(AWSComprehendListTagsForResourceRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListTagsForResource service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendListTagsForResourceResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorResourceNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listTagsForResource:completionHandler:

Lists all tags associated with a given Amazon Comprehend resource.

- (void)listTagsForResource:(AWSComprehendListTagsForResourceRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendListTagsForResourceResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListTagsForResource service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorResourceNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listTopicsDetectionJobs:

Gets a list of the topic detection jobs that you have submitted.

- (AWSTask<AWSComprehendListTopicsDetectionJobsResponse*> *)listTopicsDetectionJobs:(AWSComprehendListTopicsDetectionJobsRequest *)request

Parameters

request

A container for the necessary parameters to execute the ListTopicsDetectionJobs service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendListTopicsDetectionJobsResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInvalidFilter, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– listTopicsDetectionJobs:completionHandler:

Gets a list of the topic detection jobs that you have submitted.

- (void)listTopicsDetectionJobs:(AWSComprehendListTopicsDetectionJobsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendListTopicsDetectionJobsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListTopicsDetectionJobs service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInvalidFilter, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– startDocumentClassificationJob:

Starts an asynchronous document classification job. Use the operation to track the progress of the job.

- (AWSTask<AWSComprehendStartDocumentClassificationJobResponse*> *)startDocumentClassificationJob:(AWSComprehendStartDocumentClassificationJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the StartDocumentClassificationJob service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendStartDocumentClassificationJobResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceNotFound, AWSComprehendErrorResourceUnavailable, AWSComprehendErrorKmsKeyValidation, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– startDocumentClassificationJob:completionHandler:

Starts an asynchronous document classification job. Use the operation to track the progress of the job.

- (void)startDocumentClassificationJob:(AWSComprehendStartDocumentClassificationJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendStartDocumentClassificationJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StartDocumentClassificationJob service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceNotFound, AWSComprehendErrorResourceUnavailable, AWSComprehendErrorKmsKeyValidation, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– startDominantLanguageDetectionJob:

Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.

- (AWSTask<AWSComprehendStartDominantLanguageDetectionJobResponse*> *)startDominantLanguageDetectionJob:(AWSComprehendStartDominantLanguageDetectionJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the StartDominantLanguageDetectionJob service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendStartDominantLanguageDetectionJobResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorKmsKeyValidation, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– startDominantLanguageDetectionJob:completionHandler:

Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.

- (void)startDominantLanguageDetectionJob:(AWSComprehendStartDominantLanguageDetectionJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendStartDominantLanguageDetectionJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StartDominantLanguageDetectionJob service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorKmsKeyValidation, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– startEntitiesDetectionJob:

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.

- (AWSTask<AWSComprehendStartEntitiesDetectionJobResponse*> *)startEntitiesDetectionJob:(AWSComprehendStartEntitiesDetectionJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the StartEntitiesDetectionJob service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendStartEntitiesDetectionJobResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceNotFound, AWSComprehendErrorResourceUnavailable, AWSComprehendErrorKmsKeyValidation, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– startEntitiesDetectionJob:completionHandler:

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.

- (void)startEntitiesDetectionJob:(AWSComprehendStartEntitiesDetectionJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendStartEntitiesDetectionJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StartEntitiesDetectionJob service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceNotFound, AWSComprehendErrorResourceUnavailable, AWSComprehendErrorKmsKeyValidation, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– startKeyPhrasesDetectionJob:

Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.

- (AWSTask<AWSComprehendStartKeyPhrasesDetectionJobResponse*> *)startKeyPhrasesDetectionJob:(AWSComprehendStartKeyPhrasesDetectionJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the StartKeyPhrasesDetectionJob service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendStartKeyPhrasesDetectionJobResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorKmsKeyValidation, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– startKeyPhrasesDetectionJob:completionHandler:

Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.

- (void)startKeyPhrasesDetectionJob:(AWSComprehendStartKeyPhrasesDetectionJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendStartKeyPhrasesDetectionJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StartKeyPhrasesDetectionJob service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorKmsKeyValidation, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– startSentimentDetectionJob:

Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.

- (AWSTask<AWSComprehendStartSentimentDetectionJobResponse*> *)startSentimentDetectionJob:(AWSComprehendStartSentimentDetectionJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the StartSentimentDetectionJob service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendStartSentimentDetectionJobResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorKmsKeyValidation, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– startSentimentDetectionJob:completionHandler:

Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.

- (void)startSentimentDetectionJob:(AWSComprehendStartSentimentDetectionJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendStartSentimentDetectionJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StartSentimentDetectionJob service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorKmsKeyValidation, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– startTopicsDetectionJob:

Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.

- (AWSTask<AWSComprehendStartTopicsDetectionJobResponse*> *)startTopicsDetectionJob:(AWSComprehendStartTopicsDetectionJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the StartTopicsDetectionJob service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendStartTopicsDetectionJobResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorKmsKeyValidation, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– startTopicsDetectionJob:completionHandler:

Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.

- (void)startTopicsDetectionJob:(AWSComprehendStartTopicsDetectionJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendStartTopicsDetectionJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StartTopicsDetectionJob service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorKmsKeyValidation, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– stopDominantLanguageDetectionJob:

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.

- (AWSTask<AWSComprehendStopDominantLanguageDetectionJobResponse*> *)stopDominantLanguageDetectionJob:(AWSComprehendStopDominantLanguageDetectionJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the StopDominantLanguageDetectionJob service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendStopDominantLanguageDetectionJobResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– stopDominantLanguageDetectionJob:completionHandler:

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.

- (void)stopDominantLanguageDetectionJob:(AWSComprehendStopDominantLanguageDetectionJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendStopDominantLanguageDetectionJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StopDominantLanguageDetectionJob service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– stopEntitiesDetectionJob:

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.

- (AWSTask<AWSComprehendStopEntitiesDetectionJobResponse*> *)stopEntitiesDetectionJob:(AWSComprehendStopEntitiesDetectionJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the StopEntitiesDetectionJob service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendStopEntitiesDetectionJobResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– stopEntitiesDetectionJob:completionHandler:

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.

- (void)stopEntitiesDetectionJob:(AWSComprehendStopEntitiesDetectionJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendStopEntitiesDetectionJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StopEntitiesDetectionJob service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– stopKeyPhrasesDetectionJob:

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.

- (AWSTask<AWSComprehendStopKeyPhrasesDetectionJobResponse*> *)stopKeyPhrasesDetectionJob:(AWSComprehendStopKeyPhrasesDetectionJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the StopKeyPhrasesDetectionJob service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendStopKeyPhrasesDetectionJobResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– stopKeyPhrasesDetectionJob:completionHandler:

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.

- (void)stopKeyPhrasesDetectionJob:(AWSComprehendStopKeyPhrasesDetectionJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendStopKeyPhrasesDetectionJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StopKeyPhrasesDetectionJob service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– stopSentimentDetectionJob:

Stops a sentiment 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 be 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.

- (AWSTask<AWSComprehendStopSentimentDetectionJobResponse*> *)stopSentimentDetectionJob:(AWSComprehendStopSentimentDetectionJobRequest *)request

Parameters

request

A container for the necessary parameters to execute the StopSentimentDetectionJob service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendStopSentimentDetectionJobResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– stopSentimentDetectionJob:completionHandler:

Stops a sentiment 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 be 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.

- (void)stopSentimentDetectionJob:(AWSComprehendStopSentimentDetectionJobRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendStopSentimentDetectionJobResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StopSentimentDetectionJob service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorJobNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– stopTrainingDocumentClassifier:

Stops a document classifier training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

- (AWSTask<AWSComprehendStopTrainingDocumentClassifierResponse*> *)stopTrainingDocumentClassifier:(AWSComprehendStopTrainingDocumentClassifierRequest *)request

Parameters

request

A container for the necessary parameters to execute the StopTrainingDocumentClassifier service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendStopTrainingDocumentClassifierResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– stopTrainingDocumentClassifier:completionHandler:

Stops a document classifier training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

- (void)stopTrainingDocumentClassifier:(AWSComprehendStopTrainingDocumentClassifierRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendStopTrainingDocumentClassifierResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StopTrainingDocumentClassifier service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– stopTrainingEntityRecognizer:

Stops an entity recognizer training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

- (AWSTask<AWSComprehendStopTrainingEntityRecognizerResponse*> *)stopTrainingEntityRecognizer:(AWSComprehendStopTrainingEntityRecognizerRequest *)request

Parameters

request

A container for the necessary parameters to execute the StopTrainingEntityRecognizer service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendStopTrainingEntityRecognizerResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– stopTrainingEntityRecognizer:completionHandler:

Stops an entity recognizer training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

- (void)stopTrainingEntityRecognizer:(AWSComprehendStopTrainingEntityRecognizerRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendStopTrainingEntityRecognizerResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the StopTrainingEntityRecognizer service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorTooManyRequests, AWSComprehendErrorResourceNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– tagResource:

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.

- (AWSTask<AWSComprehendTagResourceResponse*> *)tagResource:(AWSComprehendTagResourceRequest *)request

Parameters

request

A container for the necessary parameters to execute the TagResource service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendTagResourceResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorConcurrentModification, AWSComprehendErrorResourceNotFound, AWSComprehendErrorTooManyTags, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– tagResource:completionHandler:

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.

- (void)tagResource:(AWSComprehendTagResourceRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendTagResourceResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the TagResource service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorInvalidRequest, AWSComprehendErrorConcurrentModification, AWSComprehendErrorResourceNotFound, AWSComprehendErrorTooManyTags, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– untagResource:

Removes a specific tag associated with an Amazon Comprehend resource.

- (AWSTask<AWSComprehendUntagResourceResponse*> *)untagResource:(AWSComprehendUntagResourceRequest *)request

Parameters

request

A container for the necessary parameters to execute the UntagResource service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendUntagResourceResponse. On failed execution, task.error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorTooManyTagKeys, AWSComprehendErrorInvalidRequest, AWSComprehendErrorConcurrentModification, AWSComprehendErrorResourceNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h

– untagResource:completionHandler:

Removes a specific tag associated with an Amazon Comprehend resource.

- (void)untagResource:(AWSComprehendUntagResourceRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSComprehendUntagResourceResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the UntagResource service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSComprehendErrorDomain domain and the following error code: AWSComprehendErrorTooManyTagKeys, AWSComprehendErrorInvalidRequest, AWSComprehendErrorConcurrentModification, AWSComprehendErrorResourceNotFound, AWSComprehendErrorInternalServer.

Declared In

AWSComprehendService.h