AWSComprehend

Objective-C

@interface AWSComprehend

Swift

class AWSComprehend

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.

  • The service configuration used to instantiate this service client.

    Warning

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

    Declaration

    Objective-C

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

    Swift

    var configuration: UnsafeMutablePointer<Int32> { get }
  • 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.

    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];
    

    Declaration

    Objective-C

    + (nonnull instancetype)defaultComprehend;

    Swift

    class func `default`() -> Self

    Return Value

    The default service client.

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

    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.

    Declaration

    Objective-C

    + (void)registerComprehendWithConfiguration:(id)configuration
                                         forKey:(nonnull NSString *)key;

    Swift

    class func register(withConfiguration configuration: Any!, forKey key: String)

    Parameters

    configuration

    A service configuration object.

    key

    A string to identify the service client.

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

    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"];
    

    Declaration

    Objective-C

    + (nonnull instancetype)ComprehendForKey:(nonnull NSString *)key;

    Swift

    convenience init(forKey key: String)

    Parameters

    key

    A string to identify the service client.

    Return Value

    An instance of the service client.

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

    Warning

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

    Declaration

    Objective-C

    + (void)removeComprehendForKey:(nonnull NSString *)key;

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

  • 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.

    See

    AWSComprehendBatchDetectDominantLanguageRequest

    See

    AWSComprehendBatchDetectDominantLanguageResponse

    Declaration

    Objective-C

    - (id)batchDetectDominantLanguage:
        (nonnull AWSComprehendBatchDetectDominantLanguageRequest *)request;

    Swift

    func batchDetectDominantLanguage(_ request: AWSComprehendBatchDetectDominantLanguageRequest) -> Any!

    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.

  • 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.

    See

    AWSComprehendBatchDetectDominantLanguageRequest

    See

    AWSComprehendBatchDetectDominantLanguageResponse

    Declaration

    Objective-C

    - (void)batchDetectDominantLanguage:
                (nonnull AWSComprehendBatchDetectDominantLanguageRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSComprehendBatchDetectDominantLanguageResponse
                                  *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func batchDetectDominantLanguage(_ request: AWSComprehendBatchDetectDominantLanguageRequest, completionHandler: ((AWSComprehendBatchDetectDominantLanguageResponse?, Error?) -> Void)? = nil)

    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.

  • 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

    See

    AWSComprehendBatchDetectEntitiesRequest

    See

    AWSComprehendBatchDetectEntitiesResponse

    Declaration

    Objective-C

    - (id)batchDetectEntities:
        (nonnull AWSComprehendBatchDetectEntitiesRequest *)request;

    Swift

    func batchDetectEntities(_ request: AWSComprehendBatchDetectEntitiesRequest) -> Any!

    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.

  • 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

    See

    AWSComprehendBatchDetectEntitiesRequest

    See

    AWSComprehendBatchDetectEntitiesResponse

    Declaration

    Objective-C

    - (void)batchDetectEntities:
                (nonnull AWSComprehendBatchDetectEntitiesRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSComprehendBatchDetectEntitiesResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func batchDetectEntities(_ request: AWSComprehendBatchDetectEntitiesRequest, completionHandler: ((AWSComprehendBatchDetectEntitiesResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendBatchDetectKeyPhrasesRequest

    See

    AWSComprehendBatchDetectKeyPhrasesResponse

    Declaration

    Objective-C

    - (id)batchDetectKeyPhrases:
        (nonnull AWSComprehendBatchDetectKeyPhrasesRequest *)request;

    Swift

    func batchDetectKeyPhrases(_ request: AWSComprehendBatchDetectKeyPhrasesRequest) -> Any!

    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.

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

    See

    AWSComprehendBatchDetectKeyPhrasesRequest

    See

    AWSComprehendBatchDetectKeyPhrasesResponse

    Declaration

    Objective-C

    - (void)batchDetectKeyPhrases:
                (nonnull AWSComprehendBatchDetectKeyPhrasesRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSComprehendBatchDetectKeyPhrasesResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func batchDetectKeyPhrases(_ request: AWSComprehendBatchDetectKeyPhrasesRequest, completionHandler: ((AWSComprehendBatchDetectKeyPhrasesResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendBatchDetectSentimentRequest

    See

    AWSComprehendBatchDetectSentimentResponse

    Declaration

    Objective-C

    - (id)batchDetectSentiment:
        (nonnull AWSComprehendBatchDetectSentimentRequest *)request;

    Swift

    func batchDetectSentiment(_ request: AWSComprehendBatchDetectSentimentRequest) -> Any!

    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.

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

    See

    AWSComprehendBatchDetectSentimentRequest

    See

    AWSComprehendBatchDetectSentimentResponse

    Declaration

    Objective-C

    - (void)batchDetectSentiment:
                (nonnull AWSComprehendBatchDetectSentimentRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSComprehendBatchDetectSentimentResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func batchDetectSentiment(_ request: AWSComprehendBatchDetectSentimentRequest, completionHandler: ((AWSComprehendBatchDetectSentimentResponse?, Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSComprehendBatchDetectSyntaxRequest

    See

    AWSComprehendBatchDetectSyntaxResponse

    Declaration

    Objective-C

    - (id)batchDetectSyntax:
        (nonnull AWSComprehendBatchDetectSyntaxRequest *)request;

    Swift

    func batchDetectSyntax(_ request: AWSComprehendBatchDetectSyntaxRequest) -> Any!

    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.

  • 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.

    See

    AWSComprehendBatchDetectSyntaxRequest

    See

    AWSComprehendBatchDetectSyntaxResponse

    Declaration

    Objective-C

    - (void)
        batchDetectSyntax:(nonnull AWSComprehendBatchDetectSyntaxRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSComprehendBatchDetectSyntaxResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func batchDetectSyntax(_ request: AWSComprehendBatchDetectSyntaxRequest, completionHandler: ((AWSComprehendBatchDetectSyntaxResponse?, Error?) -> Void)? = nil)

    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.

  • Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.

    See

    AWSComprehendClassifyDocumentRequest

    See

    AWSComprehendClassifyDocumentResponse

    Declaration

    Objective-C

    - (id)classifyDocument:(nonnull AWSComprehendClassifyDocumentRequest *)request;

    Swift

    func classifyDocument(_ request: AWSComprehendClassifyDocumentRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.

    See

    AWSComprehendClassifyDocumentRequest

    See

    AWSComprehendClassifyDocumentResponse

    Declaration

    Objective-C

    - (void)classifyDocument:(nonnull AWSComprehendClassifyDocumentRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSComprehendClassifyDocumentResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func classifyDocument(_ request: AWSComprehendClassifyDocumentRequest, completionHandler: ((AWSComprehendClassifyDocumentResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ClassifyDocument 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, AWSComprehendErrorResourceUnavailable, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorInternalServer.

  • 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.

    See

    AWSComprehendCreateDocumentClassifierRequest

    See

    AWSComprehendCreateDocumentClassifierResponse

    Declaration

    Objective-C

    - (id)createDocumentClassifier:
        (nonnull AWSComprehendCreateDocumentClassifierRequest *)request;

    Swift

    func createDocumentClassifier(_ request: AWSComprehendCreateDocumentClassifierRequest) -> Any!

    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.

  • 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.

    See

    AWSComprehendCreateDocumentClassifierRequest

    See

    AWSComprehendCreateDocumentClassifierResponse

    Declaration

    Objective-C

    - (void)createDocumentClassifier:
                (nonnull AWSComprehendCreateDocumentClassifierRequest *)request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSComprehendCreateDocumentClassifierResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func createDocumentClassifier(_ request: AWSComprehendCreateDocumentClassifierRequest, completionHandler: ((AWSComprehendCreateDocumentClassifierResponse?, Error?) -> Void)? = nil)

    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.

  • Creates a model-specific endpoint for synchronous inference for a previously trained custom model

    See

    AWSComprehendCreateEndpointRequest

    See

    AWSComprehendCreateEndpointResponse

    Declaration

    Objective-C

    - (id)createEndpoint:(nonnull AWSComprehendCreateEndpointRequest *)request;

    Swift

    func createEndpoint(_ request: AWSComprehendCreateEndpointRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a model-specific endpoint for synchronous inference for a previously trained custom model

    See

    AWSComprehendCreateEndpointRequest

    See

    AWSComprehendCreateEndpointResponse

    Declaration

    Objective-C

    - (void)createEndpoint:(nonnull AWSComprehendCreateEndpointRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSComprehendCreateEndpointResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func createEndpoint(_ request: AWSComprehendCreateEndpointRequest, completionHandler: ((AWSComprehendCreateEndpointResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the CreateEndpoint 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, AWSComprehendErrorResourceLimitExceeded, AWSComprehendErrorResourceNotFound, AWSComprehendErrorResourceUnavailable, AWSComprehendErrorTooManyRequests, AWSComprehendErrorTooManyTags, AWSComprehendErrorInternalServer.

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

    See

    AWSComprehendCreateEntityRecognizerRequest

    See

    AWSComprehendCreateEntityRecognizerResponse

    Declaration

    Objective-C

    - (id)createEntityRecognizer:
        (nonnull AWSComprehendCreateEntityRecognizerRequest *)request;

    Swift

    func createEntityRecognizer(_ request: AWSComprehendCreateEntityRecognizerRequest) -> Any!

    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.

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

    See

    AWSComprehendCreateEntityRecognizerRequest

    See

    AWSComprehendCreateEntityRecognizerResponse

    Declaration

    Objective-C

    - (void)createEntityRecognizer:
                (nonnull AWSComprehendCreateEntityRecognizerRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSComprehendCreateEntityRecognizerResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func createEntityRecognizer(_ request: AWSComprehendCreateEntityRecognizerRequest, completionHandler: ((AWSComprehendCreateEntityRecognizerResponse?, Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSComprehendDeleteDocumentClassifierRequest

    See

    AWSComprehendDeleteDocumentClassifierResponse

    Declaration

    Objective-C

    - (id)deleteDocumentClassifier:
        (nonnull AWSComprehendDeleteDocumentClassifierRequest *)request;

    Swift

    func deleteDocumentClassifier(_ request: AWSComprehendDeleteDocumentClassifierRequest) -> Any!

    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.

  • 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.

    See

    AWSComprehendDeleteDocumentClassifierRequest

    See

    AWSComprehendDeleteDocumentClassifierResponse

    Declaration

    Objective-C

    - (void)deleteDocumentClassifier:
                (nonnull AWSComprehendDeleteDocumentClassifierRequest *)request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSComprehendDeleteDocumentClassifierResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func deleteDocumentClassifier(_ request: AWSComprehendDeleteDocumentClassifierRequest, completionHandler: ((AWSComprehendDeleteDocumentClassifierResponse?, Error?) -> Void)? = nil)

    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.

  • Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted.

    See

    AWSComprehendDeleteEndpointRequest

    See

    AWSComprehendDeleteEndpointResponse

    Declaration

    Objective-C

    - (id)deleteEndpoint:(nonnull AWSComprehendDeleteEndpointRequest *)request;

    Swift

    func deleteEndpoint(_ request: AWSComprehendDeleteEndpointRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted.

    See

    AWSComprehendDeleteEndpointRequest

    See

    AWSComprehendDeleteEndpointResponse

    Declaration

    Objective-C

    - (void)deleteEndpoint:(nonnull AWSComprehendDeleteEndpointRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSComprehendDeleteEndpointResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func deleteEndpoint(_ request: AWSComprehendDeleteEndpointRequest, completionHandler: ((AWSComprehendDeleteEndpointResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeleteEndpoint 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, AWSComprehendErrorResourceNotFound, AWSComprehendErrorTooManyRequests, AWSComprehendErrorInternalServer.

  • 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.

    See

    AWSComprehendDeleteEntityRecognizerRequest

    See

    AWSComprehendDeleteEntityRecognizerResponse

    Declaration

    Objective-C

    - (id)deleteEntityRecognizer:
        (nonnull AWSComprehendDeleteEntityRecognizerRequest *)request;

    Swift

    func deleteEntityRecognizer(_ request: AWSComprehendDeleteEntityRecognizerRequest) -> Any!

    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.

  • 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.

    See

    AWSComprehendDeleteEntityRecognizerRequest

    See

    AWSComprehendDeleteEntityRecognizerResponse

    Declaration

    Objective-C

    - (void)deleteEntityRecognizer:
                (nonnull AWSComprehendDeleteEntityRecognizerRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSComprehendDeleteEntityRecognizerResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func deleteEntityRecognizer(_ request: AWSComprehendDeleteEntityRecognizerRequest, completionHandler: ((AWSComprehendDeleteEntityRecognizerResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendDescribeDocumentClassificationJobRequest

    See

    AWSComprehendDescribeDocumentClassificationJobResponse

    Declaration

    Objective-C

    - (id)describeDocumentClassificationJob:
        (nonnull AWSComprehendDescribeDocumentClassificationJobRequest *)request;

    Swift

    func describeDocumentClassificationJob(_ request: AWSComprehendDescribeDocumentClassificationJobRequest) -> Any!

    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.

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

    See

    AWSComprehendDescribeDocumentClassificationJobRequest

    See

    AWSComprehendDescribeDocumentClassificationJobResponse

    Declaration

    Objective-C

    - (void)
        describeDocumentClassificationJob:
            (nonnull AWSComprehendDescribeDocumentClassificationJobRequest *)request
                        completionHandler:
                            (void (^_Nullable)(
                                AWSComprehendDescribeDocumentClassificationJobResponse
                                    *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func describeDocumentClassificationJob(_ request: AWSComprehendDescribeDocumentClassificationJobRequest, completionHandler: ((AWSComprehendDescribeDocumentClassificationJobResponse?, Error?) -> Void)? = nil)

    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.

  • Gets the properties associated with a document classifier.

    See

    AWSComprehendDescribeDocumentClassifierRequest

    See

    AWSComprehendDescribeDocumentClassifierResponse

    Declaration

    Objective-C

    - (id)describeDocumentClassifier:
        (nonnull AWSComprehendDescribeDocumentClassifierRequest *)request;

    Swift

    func describeDocumentClassifier(_ request: AWSComprehendDescribeDocumentClassifierRequest) -> Any!

    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.

  • Gets the properties associated with a document classifier.

    See

    AWSComprehendDescribeDocumentClassifierRequest

    See

    AWSComprehendDescribeDocumentClassifierResponse

    Declaration

    Objective-C

    - (void)
        describeDocumentClassifier:
            (nonnull AWSComprehendDescribeDocumentClassifierRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSComprehendDescribeDocumentClassifierResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func describeDocumentClassifier(_ request: AWSComprehendDescribeDocumentClassifierRequest, completionHandler: ((AWSComprehendDescribeDocumentClassifierResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendDescribeDominantLanguageDetectionJobRequest

    See

    AWSComprehendDescribeDominantLanguageDetectionJobResponse

    Declaration

    Objective-C

    - (id)describeDominantLanguageDetectionJob:
        (nonnull AWSComprehendDescribeDominantLanguageDetectionJobRequest *)request;

    Swift

    func describeDominantLanguageDetectionJob(_ request: AWSComprehendDescribeDominantLanguageDetectionJobRequest) -> Any!

    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.

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

    See

    AWSComprehendDescribeDominantLanguageDetectionJobRequest

    See

    AWSComprehendDescribeDominantLanguageDetectionJobResponse

    Declaration

    Objective-C

    - (void)
        describeDominantLanguageDetectionJob:
            (nonnull AWSComprehendDescribeDominantLanguageDetectionJobRequest *)
                request
                           completionHandler:
                               (void (^_Nullable)(
                                   AWSComprehendDescribeDominantLanguageDetectionJobResponse
                                       *_Nullable,
                                   NSError *_Nullable))completionHandler;

    Swift

    func describeDominantLanguageDetectionJob(_ request: AWSComprehendDescribeDominantLanguageDetectionJobRequest, completionHandler: ((AWSComprehendDescribeDominantLanguageDetectionJobResponse?, Error?) -> Void)? = nil)

    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.

  • Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint.

    See

    AWSComprehendDescribeEndpointRequest

    See

    AWSComprehendDescribeEndpointResponse

    Declaration

    Objective-C

    - (id)describeEndpoint:(nonnull AWSComprehendDescribeEndpointRequest *)request;

    Swift

    func describeEndpoint(_ request: AWSComprehendDescribeEndpointRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint.

    See

    AWSComprehendDescribeEndpointRequest

    See

    AWSComprehendDescribeEndpointResponse

    Declaration

    Objective-C

    - (void)describeEndpoint:(nonnull AWSComprehendDescribeEndpointRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSComprehendDescribeEndpointResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func describeEndpoint(_ request: AWSComprehendDescribeEndpointRequest, completionHandler: ((AWSComprehendDescribeEndpointResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeEndpoint 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.

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

    See

    AWSComprehendDescribeEntitiesDetectionJobRequest

    See

    AWSComprehendDescribeEntitiesDetectionJobResponse

    Declaration

    Objective-C

    - (id)describeEntitiesDetectionJob:
        (nonnull AWSComprehendDescribeEntitiesDetectionJobRequest *)request;

    Swift

    func describeEntitiesDetectionJob(_ request: AWSComprehendDescribeEntitiesDetectionJobRequest) -> Any!

    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.

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

    See

    AWSComprehendDescribeEntitiesDetectionJobRequest

    See

    AWSComprehendDescribeEntitiesDetectionJobResponse

    Declaration

    Objective-C

    - (void)describeEntitiesDetectionJob:
                (nonnull AWSComprehendDescribeEntitiesDetectionJobRequest *)request
                       completionHandler:
                           (void (^_Nullable)(
                               AWSComprehendDescribeEntitiesDetectionJobResponse
                                   *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func describeEntitiesDetectionJob(_ request: AWSComprehendDescribeEntitiesDetectionJobRequest, completionHandler: ((AWSComprehendDescribeEntitiesDetectionJobResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendDescribeEntityRecognizerRequest

    See

    AWSComprehendDescribeEntityRecognizerResponse

    Declaration

    Objective-C

    - (id)describeEntityRecognizer:
        (nonnull AWSComprehendDescribeEntityRecognizerRequest *)request;

    Swift

    func describeEntityRecognizer(_ request: AWSComprehendDescribeEntityRecognizerRequest) -> Any!

    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.

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

    See

    AWSComprehendDescribeEntityRecognizerRequest

    See

    AWSComprehendDescribeEntityRecognizerResponse

    Declaration

    Objective-C

    - (void)describeEntityRecognizer:
                (nonnull AWSComprehendDescribeEntityRecognizerRequest *)request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSComprehendDescribeEntityRecognizerResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func describeEntityRecognizer(_ request: AWSComprehendDescribeEntityRecognizerRequest, completionHandler: ((AWSComprehendDescribeEntityRecognizerResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendDescribeKeyPhrasesDetectionJobRequest

    See

    AWSComprehendDescribeKeyPhrasesDetectionJobResponse

    Declaration

    Objective-C

    - (id)describeKeyPhrasesDetectionJob:
        (nonnull AWSComprehendDescribeKeyPhrasesDetectionJobRequest *)request;

    Swift

    func describeKeyPhrasesDetectionJob(_ request: AWSComprehendDescribeKeyPhrasesDetectionJobRequest) -> Any!

    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.

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

    See

    AWSComprehendDescribeKeyPhrasesDetectionJobRequest

    See

    AWSComprehendDescribeKeyPhrasesDetectionJobResponse

    Declaration

    Objective-C

    - (void)describeKeyPhrasesDetectionJob:
                (nonnull AWSComprehendDescribeKeyPhrasesDetectionJobRequest *)
                    request
                         completionHandler:
                             (void (^_Nullable)(
                                 AWSComprehendDescribeKeyPhrasesDetectionJobResponse
                                     *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func describeKeyPhrasesDetectionJob(_ request: AWSComprehendDescribeKeyPhrasesDetectionJobRequest, completionHandler: ((AWSComprehendDescribeKeyPhrasesDetectionJobResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendDescribeSentimentDetectionJobRequest

    See

    AWSComprehendDescribeSentimentDetectionJobResponse

    Declaration

    Objective-C

    - (id)describeSentimentDetectionJob:
        (nonnull AWSComprehendDescribeSentimentDetectionJobRequest *)request;

    Swift

    func describeSentimentDetectionJob(_ request: AWSComprehendDescribeSentimentDetectionJobRequest) -> Any!

    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.

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

    See

    AWSComprehendDescribeSentimentDetectionJobRequest

    See

    AWSComprehendDescribeSentimentDetectionJobResponse

    Declaration

    Objective-C

    - (void)describeSentimentDetectionJob:
                (nonnull AWSComprehendDescribeSentimentDetectionJobRequest *)request
                        completionHandler:
                            (void (^_Nullable)(
                                AWSComprehendDescribeSentimentDetectionJobResponse
                                    *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func describeSentimentDetectionJob(_ request: AWSComprehendDescribeSentimentDetectionJobRequest, completionHandler: ((AWSComprehendDescribeSentimentDetectionJobResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendDescribeTopicsDetectionJobRequest

    See

    AWSComprehendDescribeTopicsDetectionJobResponse

    Declaration

    Objective-C

    - (id)describeTopicsDetectionJob:
        (nonnull AWSComprehendDescribeTopicsDetectionJobRequest *)request;

    Swift

    func describeTopicsDetectionJob(_ request: AWSComprehendDescribeTopicsDetectionJobRequest) -> Any!

    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.

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

    See

    AWSComprehendDescribeTopicsDetectionJobRequest

    See

    AWSComprehendDescribeTopicsDetectionJobResponse

    Declaration

    Objective-C

    - (void)
        describeTopicsDetectionJob:
            (nonnull AWSComprehendDescribeTopicsDetectionJobRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSComprehendDescribeTopicsDetectionJobResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func describeTopicsDetectionJob(_ request: AWSComprehendDescribeTopicsDetectionJobRequest, completionHandler: ((AWSComprehendDescribeTopicsDetectionJobResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendDetectDominantLanguageRequest

    See

    AWSComprehendDetectDominantLanguageResponse

    Declaration

    Objective-C

    - (id)detectDominantLanguage:
        (nonnull AWSComprehendDetectDominantLanguageRequest *)request;

    Swift

    func detectDominantLanguage(_ request: AWSComprehendDetectDominantLanguageRequest) -> Any!

    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.

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

    See

    AWSComprehendDetectDominantLanguageRequest

    See

    AWSComprehendDetectDominantLanguageResponse

    Declaration

    Objective-C

    - (void)detectDominantLanguage:
                (nonnull AWSComprehendDetectDominantLanguageRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSComprehendDetectDominantLanguageResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func detectDominantLanguage(_ request: AWSComprehendDetectDominantLanguageRequest, completionHandler: ((AWSComprehendDetectDominantLanguageResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendDetectEntitiesRequest

    See

    AWSComprehendDetectEntitiesResponse

    Declaration

    Objective-C

    - (id)detectEntities:(nonnull AWSComprehendDetectEntitiesRequest *)request;

    Swift

    func detectEntities(_ request: AWSComprehendDetectEntitiesRequest) -> Any!

    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, AWSComprehendErrorResourceUnavailable, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorInternalServer.

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

    See

    AWSComprehendDetectEntitiesRequest

    See

    AWSComprehendDetectEntitiesResponse

    Declaration

    Objective-C

    - (void)detectEntities:(nonnull AWSComprehendDetectEntitiesRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSComprehendDetectEntitiesResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func detectEntities(_ request: AWSComprehendDetectEntitiesRequest, completionHandler: ((AWSComprehendDetectEntitiesResponse?, Error?) -> Void)? = nil)

    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, AWSComprehendErrorResourceUnavailable, AWSComprehendErrorTextSizeLimitExceeded, AWSComprehendErrorUnsupportedLanguage, AWSComprehendErrorInternalServer.

  • Detects the key noun phrases found in the text.

    See

    AWSComprehendDetectKeyPhrasesRequest

    See

    AWSComprehendDetectKeyPhrasesResponse

    Declaration

    Objective-C

    - (id)detectKeyPhrases:(nonnull AWSComprehendDetectKeyPhrasesRequest *)request;

    Swift

    func detectKeyPhrases(_ request: AWSComprehendDetectKeyPhrasesRequest) -> Any!

    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.

  • Detects the key noun phrases found in the text.

    See

    AWSComprehendDetectKeyPhrasesRequest

    See

    AWSComprehendDetectKeyPhrasesResponse

    Declaration

    Objective-C

    - (void)detectKeyPhrases:(nonnull AWSComprehendDetectKeyPhrasesRequest *)request
           completionHandler:
               (void (^_Nullable)(AWSComprehendDetectKeyPhrasesResponse *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func detectKeyPhrases(_ request: AWSComprehendDetectKeyPhrasesRequest, completionHandler: ((AWSComprehendDetectKeyPhrasesResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendDetectSentimentRequest

    See

    AWSComprehendDetectSentimentResponse

    Declaration

    Objective-C

    - (id)detectSentiment:(nonnull AWSComprehendDetectSentimentRequest *)request;

    Swift

    func detectSentiment(_ request: AWSComprehendDetectSentimentRequest) -> Any!

    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.

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

    See

    AWSComprehendDetectSentimentRequest

    See

    AWSComprehendDetectSentimentResponse

    Declaration

    Objective-C

    - (void)detectSentiment:(nonnull AWSComprehendDetectSentimentRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSComprehendDetectSentimentResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func detectSentiment(_ request: AWSComprehendDetectSentimentRequest, completionHandler: ((AWSComprehendDetectSentimentResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendDetectSyntaxRequest

    See

    AWSComprehendDetectSyntaxResponse

    Declaration

    Objective-C

    - (id)detectSyntax:(nonnull AWSComprehendDetectSyntaxRequest *)request;

    Swift

    func detectSyntax(_ request: AWSComprehendDetectSyntaxRequest) -> Any!

    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.

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

    See

    AWSComprehendDetectSyntaxRequest

    See

    AWSComprehendDetectSyntaxResponse

    Declaration

    Objective-C

    - (void)detectSyntax:(nonnull AWSComprehendDetectSyntaxRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSComprehendDetectSyntaxResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func detectSyntax(_ request: AWSComprehendDetectSyntaxRequest, completionHandler: ((AWSComprehendDetectSyntaxResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendListDocumentClassificationJobsRequest

    See

    AWSComprehendListDocumentClassificationJobsResponse

    Declaration

    Objective-C

    - (id)listDocumentClassificationJobs:
        (nonnull AWSComprehendListDocumentClassificationJobsRequest *)request;

    Swift

    func listDocumentClassificationJobs(_ request: AWSComprehendListDocumentClassificationJobsRequest) -> Any!

    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.

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

    See

    AWSComprehendListDocumentClassificationJobsRequest

    See

    AWSComprehendListDocumentClassificationJobsResponse

    Declaration

    Objective-C

    - (void)listDocumentClassificationJobs:
                (nonnull AWSComprehendListDocumentClassificationJobsRequest *)
                    request
                         completionHandler:
                             (void (^_Nullable)(
                                 AWSComprehendListDocumentClassificationJobsResponse
                                     *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func listDocumentClassificationJobs(_ request: AWSComprehendListDocumentClassificationJobsRequest, completionHandler: ((AWSComprehendListDocumentClassificationJobsResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendListDocumentClassifiersRequest

    See

    AWSComprehendListDocumentClassifiersResponse

    Declaration

    Objective-C

    - (id)listDocumentClassifiers:
        (nonnull AWSComprehendListDocumentClassifiersRequest *)request;

    Swift

    func listDocumentClassifiers(_ request: AWSComprehendListDocumentClassifiersRequest) -> Any!

    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.

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

    See

    AWSComprehendListDocumentClassifiersRequest

    See

    AWSComprehendListDocumentClassifiersResponse

    Declaration

    Objective-C

    - (void)listDocumentClassifiers:
                (nonnull AWSComprehendListDocumentClassifiersRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSComprehendListDocumentClassifiersResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func listDocumentClassifiers(_ request: AWSComprehendListDocumentClassifiersRequest, completionHandler: ((AWSComprehendListDocumentClassifiersResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendListDominantLanguageDetectionJobsRequest

    See

    AWSComprehendListDominantLanguageDetectionJobsResponse

    Declaration

    Objective-C

    - (id)listDominantLanguageDetectionJobs:
        (nonnull AWSComprehendListDominantLanguageDetectionJobsRequest *)request;

    Swift

    func listDominantLanguageDetectionJobs(_ request: AWSComprehendListDominantLanguageDetectionJobsRequest) -> Any!

    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.

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

    See

    AWSComprehendListDominantLanguageDetectionJobsRequest

    See

    AWSComprehendListDominantLanguageDetectionJobsResponse

    Declaration

    Objective-C

    - (void)
        listDominantLanguageDetectionJobs:
            (nonnull AWSComprehendListDominantLanguageDetectionJobsRequest *)request
                        completionHandler:
                            (void (^_Nullable)(
                                AWSComprehendListDominantLanguageDetectionJobsResponse
                                    *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func listDominantLanguageDetectionJobs(_ request: AWSComprehendListDominantLanguageDetectionJobsRequest, completionHandler: ((AWSComprehendListDominantLanguageDetectionJobsResponse?, Error?) -> Void)? = nil)

    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.

  • Gets a list of all existing endpoints that you’ve created.

    See

    AWSComprehendListEndpointsRequest

    See

    AWSComprehendListEndpointsResponse

    Declaration

    Objective-C

    - (id)listEndpoints:(nonnull AWSComprehendListEndpointsRequest *)request;

    Swift

    func listEndpoints(_ request: AWSComprehendListEndpointsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets a list of all existing endpoints that you’ve created.

    See

    AWSComprehendListEndpointsRequest

    See

    AWSComprehendListEndpointsResponse

    Declaration

    Objective-C

    - (void)listEndpoints:(nonnull AWSComprehendListEndpointsRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSComprehendListEndpointsResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listEndpoints(_ request: AWSComprehendListEndpointsRequest, completionHandler: ((AWSComprehendListEndpointsResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListEndpoints 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, AWSComprehendErrorInternalServer.

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

    See

    AWSComprehendListEntitiesDetectionJobsRequest

    See

    AWSComprehendListEntitiesDetectionJobsResponse

    Declaration

    Objective-C

    - (id)listEntitiesDetectionJobs:
        (nonnull AWSComprehendListEntitiesDetectionJobsRequest *)request;

    Swift

    func listEntitiesDetectionJobs(_ request: AWSComprehendListEntitiesDetectionJobsRequest) -> Any!

    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.

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

    See

    AWSComprehendListEntitiesDetectionJobsRequest

    See

    AWSComprehendListEntitiesDetectionJobsResponse

    Declaration

    Objective-C

    - (void)
        listEntitiesDetectionJobs:
            (nonnull AWSComprehendListEntitiesDetectionJobsRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSComprehendListEntitiesDetectionJobsResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func listEntitiesDetectionJobs(_ request: AWSComprehendListEntitiesDetectionJobsRequest, completionHandler: ((AWSComprehendListEntitiesDetectionJobsResponse?, Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSComprehendListEntityRecognizersRequest

    See

    AWSComprehendListEntityRecognizersResponse

    Declaration

    Objective-C

    - (id)listEntityRecognizers:
        (nonnull AWSComprehendListEntityRecognizersRequest *)request;

    Swift

    func listEntityRecognizers(_ request: AWSComprehendListEntityRecognizersRequest) -> Any!

    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.

  • 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.

    See

    AWSComprehendListEntityRecognizersRequest

    See

    AWSComprehendListEntityRecognizersResponse

    Declaration

    Objective-C

    - (void)listEntityRecognizers:
                (nonnull AWSComprehendListEntityRecognizersRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSComprehendListEntityRecognizersResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func listEntityRecognizers(_ request: AWSComprehendListEntityRecognizersRequest, completionHandler: ((AWSComprehendListEntityRecognizersResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendListKeyPhrasesDetectionJobsRequest

    See

    AWSComprehendListKeyPhrasesDetectionJobsResponse

    Declaration

    Objective-C

    - (id)listKeyPhrasesDetectionJobs:
        (nonnull AWSComprehendListKeyPhrasesDetectionJobsRequest *)request;

    Swift

    func listKeyPhrasesDetectionJobs(_ request: AWSComprehendListKeyPhrasesDetectionJobsRequest) -> Any!

    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.

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

    See

    AWSComprehendListKeyPhrasesDetectionJobsRequest

    See

    AWSComprehendListKeyPhrasesDetectionJobsResponse

    Declaration

    Objective-C

    - (void)listKeyPhrasesDetectionJobs:
                (nonnull AWSComprehendListKeyPhrasesDetectionJobsRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSComprehendListKeyPhrasesDetectionJobsResponse
                                  *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func listKeyPhrasesDetectionJobs(_ request: AWSComprehendListKeyPhrasesDetectionJobsRequest, completionHandler: ((AWSComprehendListKeyPhrasesDetectionJobsResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendListSentimentDetectionJobsRequest

    See

    AWSComprehendListSentimentDetectionJobsResponse

    Declaration

    Objective-C

    - (id)listSentimentDetectionJobs:
        (nonnull AWSComprehendListSentimentDetectionJobsRequest *)request;

    Swift

    func listSentimentDetectionJobs(_ request: AWSComprehendListSentimentDetectionJobsRequest) -> Any!

    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.

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

    See

    AWSComprehendListSentimentDetectionJobsRequest

    See

    AWSComprehendListSentimentDetectionJobsResponse

    Declaration

    Objective-C

    - (void)
        listSentimentDetectionJobs:
            (nonnull AWSComprehendListSentimentDetectionJobsRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSComprehendListSentimentDetectionJobsResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func listSentimentDetectionJobs(_ request: AWSComprehendListSentimentDetectionJobsRequest, completionHandler: ((AWSComprehendListSentimentDetectionJobsResponse?, Error?) -> Void)? = nil)

    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.

  • Lists all tags associated with a given Amazon Comprehend resource.

    See

    AWSComprehendListTagsForResourceRequest

    See

    AWSComprehendListTagsForResourceResponse

    Declaration

    Objective-C

    - (id)listTagsForResource:
        (nonnull AWSComprehendListTagsForResourceRequest *)request;

    Swift

    func listTags(forResource request: AWSComprehendListTagsForResourceRequest) -> Any!

    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.

  • Lists all tags associated with a given Amazon Comprehend resource.

    See

    AWSComprehendListTagsForResourceRequest

    See

    AWSComprehendListTagsForResourceResponse

    Declaration

    Objective-C

    - (void)listTagsForResource:
                (nonnull AWSComprehendListTagsForResourceRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSComprehendListTagsForResourceResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func listTags(forResource request: AWSComprehendListTagsForResourceRequest, completionHandler: ((AWSComprehendListTagsForResourceResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendListTopicsDetectionJobsRequest

    See

    AWSComprehendListTopicsDetectionJobsResponse

    Declaration

    Objective-C

    - (id)listTopicsDetectionJobs:
        (nonnull AWSComprehendListTopicsDetectionJobsRequest *)request;

    Swift

    func listTopicsDetectionJobs(_ request: AWSComprehendListTopicsDetectionJobsRequest) -> Any!

    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.

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

    See

    AWSComprehendListTopicsDetectionJobsRequest

    See

    AWSComprehendListTopicsDetectionJobsResponse

    Declaration

    Objective-C

    - (void)listTopicsDetectionJobs:
                (nonnull AWSComprehendListTopicsDetectionJobsRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSComprehendListTopicsDetectionJobsResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func listTopicsDetectionJobs(_ request: AWSComprehendListTopicsDetectionJobsRequest, completionHandler: ((AWSComprehendListTopicsDetectionJobsResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendStartDocumentClassificationJobRequest

    See

    AWSComprehendStartDocumentClassificationJobResponse

    Declaration

    Objective-C

    - (id)startDocumentClassificationJob:
        (nonnull AWSComprehendStartDocumentClassificationJobRequest *)request;

    Swift

    func startDocumentClassificationJob(_ request: AWSComprehendStartDocumentClassificationJobRequest) -> Any!

    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.

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

    See

    AWSComprehendStartDocumentClassificationJobRequest

    See

    AWSComprehendStartDocumentClassificationJobResponse

    Declaration

    Objective-C

    - (void)startDocumentClassificationJob:
                (nonnull AWSComprehendStartDocumentClassificationJobRequest *)
                    request
                         completionHandler:
                             (void (^_Nullable)(
                                 AWSComprehendStartDocumentClassificationJobResponse
                                     *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func startDocumentClassificationJob(_ request: AWSComprehendStartDocumentClassificationJobRequest, completionHandler: ((AWSComprehendStartDocumentClassificationJobResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendStartDominantLanguageDetectionJobRequest

    See

    AWSComprehendStartDominantLanguageDetectionJobResponse

    Declaration

    Objective-C

    - (id)startDominantLanguageDetectionJob:
        (nonnull AWSComprehendStartDominantLanguageDetectionJobRequest *)request;

    Swift

    func startDominantLanguageDetectionJob(_ request: AWSComprehendStartDominantLanguageDetectionJobRequest) -> Any!

    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.

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

    See

    AWSComprehendStartDominantLanguageDetectionJobRequest

    See

    AWSComprehendStartDominantLanguageDetectionJobResponse

    Declaration

    Objective-C

    - (void)
        startDominantLanguageDetectionJob:
            (nonnull AWSComprehendStartDominantLanguageDetectionJobRequest *)request
                        completionHandler:
                            (void (^_Nullable)(
                                AWSComprehendStartDominantLanguageDetectionJobResponse
                                    *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func startDominantLanguageDetectionJob(_ request: AWSComprehendStartDominantLanguageDetectionJobRequest, completionHandler: ((AWSComprehendStartDominantLanguageDetectionJobResponse?, Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSComprehendStartEntitiesDetectionJobRequest

    See

    AWSComprehendStartEntitiesDetectionJobResponse

    Declaration

    Objective-C

    - (id)startEntitiesDetectionJob:
        (nonnull AWSComprehendStartEntitiesDetectionJobRequest *)request;

    Swift

    func startEntitiesDetectionJob(_ request: AWSComprehendStartEntitiesDetectionJobRequest) -> Any!

    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.

  • 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.

    See

    AWSComprehendStartEntitiesDetectionJobRequest

    See

    AWSComprehendStartEntitiesDetectionJobResponse

    Declaration

    Objective-C

    - (void)
        startEntitiesDetectionJob:
            (nonnull AWSComprehendStartEntitiesDetectionJobRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSComprehendStartEntitiesDetectionJobResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func startEntitiesDetectionJob(_ request: AWSComprehendStartEntitiesDetectionJobRequest, completionHandler: ((AWSComprehendStartEntitiesDetectionJobResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendStartKeyPhrasesDetectionJobRequest

    See

    AWSComprehendStartKeyPhrasesDetectionJobResponse

    Declaration

    Objective-C

    - (id)startKeyPhrasesDetectionJob:
        (nonnull AWSComprehendStartKeyPhrasesDetectionJobRequest *)request;

    Swift

    func startKeyPhrasesDetectionJob(_ request: AWSComprehendStartKeyPhrasesDetectionJobRequest) -> Any!

    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.

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

    See

    AWSComprehendStartKeyPhrasesDetectionJobRequest

    See

    AWSComprehendStartKeyPhrasesDetectionJobResponse

    Declaration

    Objective-C

    - (void)startKeyPhrasesDetectionJob:
                (nonnull AWSComprehendStartKeyPhrasesDetectionJobRequest *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSComprehendStartKeyPhrasesDetectionJobResponse
                                  *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func startKeyPhrasesDetectionJob(_ request: AWSComprehendStartKeyPhrasesDetectionJobRequest, completionHandler: ((AWSComprehendStartKeyPhrasesDetectionJobResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendStartSentimentDetectionJobRequest

    See

    AWSComprehendStartSentimentDetectionJobResponse

    Declaration

    Objective-C

    - (id)startSentimentDetectionJob:
        (nonnull AWSComprehendStartSentimentDetectionJobRequest *)request;

    Swift

    func startSentimentDetectionJob(_ request: AWSComprehendStartSentimentDetectionJobRequest) -> Any!

    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.

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

    See

    AWSComprehendStartSentimentDetectionJobRequest

    See

    AWSComprehendStartSentimentDetectionJobResponse

    Declaration

    Objective-C

    - (void)
        startSentimentDetectionJob:
            (nonnull AWSComprehendStartSentimentDetectionJobRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSComprehendStartSentimentDetectionJobResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func startSentimentDetectionJob(_ request: AWSComprehendStartSentimentDetectionJobRequest, completionHandler: ((AWSComprehendStartSentimentDetectionJobResponse?, Error?) -> Void)? = nil)

    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.

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

    See

    AWSComprehendStartTopicsDetectionJobRequest

    See

    AWSComprehendStartTopicsDetectionJobResponse

    Declaration

    Objective-C

    - (id)startTopicsDetectionJob:
        (nonnull AWSComprehendStartTopicsDetectionJobRequest *)request;

    Swift

    func startTopicsDetectionJob(_ request: AWSComprehendStartTopicsDetectionJobRequest) -> Any!

    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.

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

    See

    AWSComprehendStartTopicsDetectionJobRequest

    See

    AWSComprehendStartTopicsDetectionJobResponse

    Declaration

    Objective-C

    - (void)startTopicsDetectionJob:
                (nonnull AWSComprehendStartTopicsDetectionJobRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSComprehendStartTopicsDetectionJobResponse *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func startTopicsDetectionJob(_ request: AWSComprehendStartTopicsDetectionJobRequest, completionHandler: ((AWSComprehendStartTopicsDetectionJobResponse?, Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSComprehendStopDominantLanguageDetectionJobRequest

    See

    AWSComprehendStopDominantLanguageDetectionJobResponse

    Declaration

    Objective-C

    - (id)stopDominantLanguageDetectionJob:
        (nonnull AWSComprehendStopDominantLanguageDetectionJobRequest *)request;

    Swift

    func stopDominantLanguageDetectionJob(_ request: AWSComprehendStopDominantLanguageDetectionJobRequest) -> Any!

    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.

  • 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.

    See

    AWSComprehendStopDominantLanguageDetectionJobRequest

    See

    AWSComprehendStopDominantLanguageDetectionJobResponse

    Declaration

    Objective-C

    - (void)
        stopDominantLanguageDetectionJob:
            (nonnull AWSComprehendStopDominantLanguageDetectionJobRequest *)request
                       completionHandler:
                           (void (^_Nullable)(
                               AWSComprehendStopDominantLanguageDetectionJobResponse
                                   *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func stopDominantLanguageDetectionJob(_ request: AWSComprehendStopDominantLanguageDetectionJobRequest, completionHandler: ((AWSComprehendStopDominantLanguageDetectionJobResponse?, Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSComprehendStopEntitiesDetectionJobRequest

    See

    AWSComprehendStopEntitiesDetectionJobResponse

    Declaration

    Objective-C

    - (id)stopEntitiesDetectionJob:
        (nonnull AWSComprehendStopEntitiesDetectionJobRequest *)request;

    Swift

    func stopEntitiesDetectionJob(_ request: AWSComprehendStopEntitiesDetectionJobRequest) -> Any!

    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.

  • 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.

    See

    AWSComprehendStopEntitiesDetectionJobRequest

    See

    AWSComprehendStopEntitiesDetectionJobResponse

    Declaration

    Objective-C

    - (void)stopEntitiesDetectionJob:
                (nonnull AWSComprehendStopEntitiesDetectionJobRequest *)request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSComprehendStopEntitiesDetectionJobResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func stopEntitiesDetectionJob(_ request: AWSComprehendStopEntitiesDetectionJobRequest, completionHandler: ((AWSComprehendStopEntitiesDetectionJobResponse?, Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSComprehendStopKeyPhrasesDetectionJobRequest

    See

    AWSComprehendStopKeyPhrasesDetectionJobResponse

    Declaration

    Objective-C

    - (id)stopKeyPhrasesDetectionJob:
        (nonnull AWSComprehendStopKeyPhrasesDetectionJobRequest *)request;

    Swift

    func stopKeyPhrasesDetectionJob(_ request: AWSComprehendStopKeyPhrasesDetectionJobRequest) -> Any!

    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.

  • 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.

    See

    AWSComprehendStopKeyPhrasesDetectionJobRequest

    See

    AWSComprehendStopKeyPhrasesDetectionJobResponse

    Declaration

    Objective-C

    - (void)
        stopKeyPhrasesDetectionJob:
            (nonnull AWSComprehendStopKeyPhrasesDetectionJobRequest *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSComprehendStopKeyPhrasesDetectionJobResponse *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func stopKeyPhrasesDetectionJob(_ request: AWSComprehendStopKeyPhrasesDetectionJobRequest, completionHandler: ((AWSComprehendStopKeyPhrasesDetectionJobResponse?, Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSComprehendStopSentimentDetectionJobRequest

    See

    AWSComprehendStopSentimentDetectionJobResponse

    Declaration

    Objective-C

    - (id)stopSentimentDetectionJob:
        (nonnull AWSComprehendStopSentimentDetectionJobRequest *)request;

    Swift

    func stopSentimentDetectionJob(_ request: AWSComprehendStopSentimentDetectionJobRequest) -> Any!

    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.

  • 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.

    See

    AWSComprehendStopSentimentDetectionJobRequest

    See

    AWSComprehendStopSentimentDetectionJobResponse

    Declaration

    Objective-C

    - (void)
        stopSentimentDetectionJob:
            (nonnull AWSComprehendStopSentimentDetectionJobRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSComprehendStopSentimentDetectionJobResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func stopSentimentDetectionJob(_ request: AWSComprehendStopSentimentDetectionJobRequest, completionHandler: ((AWSComprehendStopSentimentDetectionJobResponse?, Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSComprehendStopTrainingDocumentClassifierRequest

    See

    AWSComprehendStopTrainingDocumentClassifierResponse

    Declaration

    Objective-C

    - (id)stopTrainingDocumentClassifier:
        (nonnull AWSComprehendStopTrainingDocumentClassifierRequest *)request;

    Swift

    func stopTrainingDocumentClassifier(_ request: AWSComprehendStopTrainingDocumentClassifierRequest) -> Any!

    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.

  • 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.

    See

    AWSComprehendStopTrainingDocumentClassifierRequest

    See

    AWSComprehendStopTrainingDocumentClassifierResponse

    Declaration

    Objective-C

    - (void)stopTrainingDocumentClassifier:
                (nonnull AWSComprehendStopTrainingDocumentClassifierRequest *)
                    request
                         completionHandler:
                             (void (^_Nullable)(
                                 AWSComprehendStopTrainingDocumentClassifierResponse
                                     *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func stopTrainingDocumentClassifier(_ request: AWSComprehendStopTrainingDocumentClassifierRequest, completionHandler: ((AWSComprehendStopTrainingDocumentClassifierResponse?, Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSComprehendStopTrainingEntityRecognizerRequest

    See

    AWSComprehendStopTrainingEntityRecognizerResponse

    Declaration

    Objective-C

    - (id)stopTrainingEntityRecognizer:
        (nonnull AWSComprehendStopTrainingEntityRecognizerRequest *)request;

    Swift

    func stopTrainingEntityRecognizer(_ request: AWSComprehendStopTrainingEntityRecognizerRequest) -> Any!

    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.

  • 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.

    See

    AWSComprehendStopTrainingEntityRecognizerRequest

    See

    AWSComprehendStopTrainingEntityRecognizerResponse

    Declaration

    Objective-C

    - (void)stopTrainingEntityRecognizer:
                (nonnull AWSComprehendStopTrainingEntityRecognizerRequest *)request
                       completionHandler:
                           (void (^_Nullable)(
                               AWSComprehendStopTrainingEntityRecognizerResponse
                                   *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func stopTrainingEntityRecognizer(_ request: AWSComprehendStopTrainingEntityRecognizerRequest, completionHandler: ((AWSComprehendStopTrainingEntityRecognizerResponse?, Error?) -> Void)? = nil)

    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.

  • 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.

    See

    AWSComprehendTagResourceRequest

    See

    AWSComprehendTagResourceResponse

    Declaration

    Objective-C

    - (id)tagResource:(nonnull AWSComprehendTagResourceRequest *)request;

    Swift

    func tagResource(_ request: AWSComprehendTagResourceRequest) -> Any!

    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.

  • 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.

    See

    AWSComprehendTagResourceRequest

    See

    AWSComprehendTagResourceResponse

    Declaration

    Objective-C

    - (void)tagResource:(nonnull AWSComprehendTagResourceRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSComprehendTagResourceResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func tagResource(_ request: AWSComprehendTagResourceRequest, completionHandler: ((AWSComprehendTagResourceResponse?, Error?) -> Void)? = nil)

    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.

  • Removes a specific tag associated with an Amazon Comprehend resource.

    See

    AWSComprehendUntagResourceRequest

    See

    AWSComprehendUntagResourceResponse

    Declaration

    Objective-C

    - (id)untagResource:(nonnull AWSComprehendUntagResourceRequest *)request;

    Swift

    func untagResource(_ request: AWSComprehendUntagResourceRequest) -> Any!

    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.

  • Removes a specific tag associated with an Amazon Comprehend resource.

    See

    AWSComprehendUntagResourceRequest

    See

    AWSComprehendUntagResourceResponse

    Declaration

    Objective-C

    - (void)untagResource:(nonnull AWSComprehendUntagResourceRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSComprehendUntagResourceResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func untagResource(_ request: AWSComprehendUntagResourceRequest, completionHandler: ((AWSComprehendUntagResourceResponse?, Error?) -> Void)? = nil)

    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.

  • Updates information about the specified endpoint.

    See

    AWSComprehendUpdateEndpointRequest

    See

    AWSComprehendUpdateEndpointResponse

    Declaration

    Objective-C

    - (id)updateEndpoint:(nonnull AWSComprehendUpdateEndpointRequest *)request;

    Swift

    func updateEndpoint(_ request: AWSComprehendUpdateEndpointRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Updates information about the specified endpoint.

    See

    AWSComprehendUpdateEndpointRequest

    See

    AWSComprehendUpdateEndpointResponse

    Declaration

    Objective-C

    - (void)updateEndpoint:(nonnull AWSComprehendUpdateEndpointRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSComprehendUpdateEndpointResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func updateEndpoint(_ request: AWSComprehendUpdateEndpointRequest, completionHandler: ((AWSComprehendUpdateEndpointResponse?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UpdateEndpoint 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, AWSComprehendErrorResourceInUse, AWSComprehendErrorResourceLimitExceeded, AWSComprehendErrorResourceNotFound, AWSComprehendErrorResourceUnavailable, AWSComprehendErrorInternalServer.