AWSComprehend

Objective-C

@interface AWSComprehend

Swift

class AWSComprehend

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

  • 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

  • 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) async throws -> AWSComprehendBatchDetectDominantLanguageResponse

    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 Entities in the Comprehend Developer Guide.

    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 Entities in the Comprehend Developer Guide.

    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) async throws -> AWSComprehendBatchDetectEntitiesResponse

    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) async throws -> AWSComprehendBatchDetectKeyPhrasesResponse

    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) async throws -> AWSComprehendBatchDetectSentimentResponse

    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 Syntax in the Comprehend Developer Guide.

    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 Syntax in the Comprehend Developer Guide.

    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) async throws -> AWSComprehendBatchDetectSyntaxResponse

    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.

  • Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.

    For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendBatchDetectTargetedSentimentRequest

    See

    AWSComprehendBatchDetectTargetedSentimentResponse

    Declaration

    Objective-C

    - (id)batchDetectTargetedSentiment:
    (nonnull AWSComprehendBatchDetectTargetedSentimentRequest *)request;

    Swift

    func batchDetectTargetedSentiment(_ request: AWSComprehendBatchDetectTargetedSentimentRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendBatchDetectTargetedSentimentResponse. 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 a sentiment analysis for each entity identified in the documents.

    For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendBatchDetectTargetedSentimentRequest

    See

    AWSComprehendBatchDetectTargetedSentimentResponse

    Declaration

    Objective-C

    - (void)batchDetectTargetedSentiment:
            (nonnull AWSComprehendBatchDetectTargetedSentimentRequest *)request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSComprehendBatchDetectTargetedSentimentResponse
                               *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func batchDetectTargetedSentiment(_ request: AWSComprehendBatchDetectTargetedSentimentRequest) async throws -> AWSComprehendBatchDetectTargetedSentimentResponse

    Parameters

    request

    A container for the necessary parameters to execute the BatchDetectTargetedSentiment 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 classification request to analyze a single document in real-time. ClassifyDocument supports the following model types:

    • Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document (PDF, Word, or image), or Amazon Textract API output. For more information, see Custom classification in the Amazon Comprehend Developer Guide.

    • Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying input prompts for generative AI applications. For input, you provide English plain text input. For prompt safety classification, the response includes only the Classes field. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide.

    If the system detects errors while processing a page in the input document, the API response includes an Errors field that describes the errors.

    If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.

    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 classification request to analyze a single document in real-time. ClassifyDocument supports the following model types:

    • Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document (PDF, Word, or image), or Amazon Textract API output. For more information, see Custom classification in the Amazon Comprehend Developer Guide.

    • Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying input prompts for generative AI applications. For input, you provide English plain text input. For prompt safety classification, the response includes only the Classes field. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide.

    If the system detects errors while processing a page in the input document, the API response includes an Errors field that describes the errors.

    If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.

    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) async throws -> AWSComprehendClassifyDocumentResponse

    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.

  • Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.

    See

    AWSComprehendContainsPiiEntitiesRequest

    See

    AWSComprehendContainsPiiEntitiesResponse

    Declaration

    Objective-C

    - (id)containsPiiEntities:
    (nonnull AWSComprehendContainsPiiEntitiesRequest *)request;

    Swift

    func containsPiiEntities(_ request: AWSComprehendContainsPiiEntitiesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.

    See

    AWSComprehendContainsPiiEntitiesRequest

    See

    AWSComprehendContainsPiiEntitiesResponse

    Declaration

    Objective-C

    - (void)containsPiiEntities:
            (nonnull AWSComprehendContainsPiiEntitiesRequest *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSComprehendContainsPiiEntitiesResponse *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func containsPiiEntities(_ request: AWSComprehendContainsPiiEntitiesRequest) async throws -> AWSComprehendContainsPiiEntitiesResponse

    Parameters

    request

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

  • Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendCreateDatasetRequest

    See

    AWSComprehendCreateDatasetResponse

    Declaration

    Objective-C

    - (id)createDataset:(nonnull AWSComprehendCreateDatasetRequest *)request;

    Swift

    func createDataset(_ request: AWSComprehendCreateDatasetRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendCreateDatasetRequest

    See

    AWSComprehendCreateDatasetResponse

    Declaration

    Objective-C

    - (void)createDataset:(nonnull AWSComprehendCreateDatasetRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSComprehendCreateDatasetResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func createDataset(_ request: AWSComprehendCreateDatasetRequest) async throws -> AWSComprehendCreateDatasetResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateDataset 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, AWSComprehendErrorResourceNotFound, 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 are labeled with the categories that you want to use. For more information, see Training classifier models in the Comprehend Developer Guide.

    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 are labeled with the categories that you want to use. For more information, see Training classifier models in the Comprehend Developer Guide.

    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) async throws -> AWSComprehendCreateDocumentClassifierResponse

    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 For information about endpoints, see Managing endpoints.

    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 For information about endpoints, see Managing endpoints.

    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) async throws -> AWSComprehendCreateEndpointResponse

    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 DescribeEntityRecognizer 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 DescribeEntityRecognizer 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) async throws -> AWSComprehendCreateEntityRecognizerResponse

    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.

  • A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.

    When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.

    To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model’s training data and test data into the flywheel’s data lake.

    To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.

    For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendCreateFlywheelRequest

    See

    AWSComprehendCreateFlywheelResponse

    Declaration

    Objective-C

    - (id)createFlywheel:(nonnull AWSComprehendCreateFlywheelRequest *)request;

    Swift

    func createFlywheel(_ request: AWSComprehendCreateFlywheelRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.

    When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.

    To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model’s training data and test data into the flywheel’s data lake.

    To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.

    For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendCreateFlywheelRequest

    See

    AWSComprehendCreateFlywheelResponse

    Declaration

    Objective-C

    - (void)createFlywheel:(nonnull AWSComprehendCreateFlywheelRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSComprehendCreateFlywheelResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func createFlywheel(_ request: AWSComprehendCreateFlywheelRequest) async throws -> AWSComprehendCreateFlywheelResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateFlywheel 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, AWSComprehendErrorResourceNotFound, AWSComprehendErrorResourceUnavailable, 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) async throws -> AWSComprehendDeleteDocumentClassifierResponse

    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. For information about endpoints, see Managing endpoints.

    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. For information about endpoints, see Managing endpoints.

    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) async throws -> AWSComprehendDeleteEndpointResponse

    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) async throws -> AWSComprehendDeleteEntityRecognizerResponse

    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.

  • Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel.

    For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendDeleteFlywheelRequest

    See

    AWSComprehendDeleteFlywheelResponse

    Declaration

    Objective-C

    - (id)deleteFlywheel:(nonnull AWSComprehendDeleteFlywheelRequest *)request;

    Swift

    func deleteFlywheel(_ request: AWSComprehendDeleteFlywheelRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDeleteFlywheelResponse. 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 flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel.

    For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendDeleteFlywheelRequest

    See

    AWSComprehendDeleteFlywheelResponse

    Declaration

    Objective-C

    - (void)deleteFlywheel:(nonnull AWSComprehendDeleteFlywheelRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSComprehendDeleteFlywheelResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func deleteFlywheel(_ request: AWSComprehendDeleteFlywheelRequest) async throws -> AWSComprehendDeleteFlywheelResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteFlywheel 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 resource-based policy that is attached to a custom model.

    See

    AWSComprehendDeleteResourcePolicyRequest

    See

    AWSComprehendDeleteResourcePolicyResponse

    Declaration

    Objective-C

    - (id)deleteResourcePolicy:
    (nonnull AWSComprehendDeleteResourcePolicyRequest *)request;

    Swift

    func deleteResourcePolicy(_ request: AWSComprehendDeleteResourcePolicyRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes a resource-based policy that is attached to a custom model.

    See

    AWSComprehendDeleteResourcePolicyRequest

    See

    AWSComprehendDeleteResourcePolicyResponse

    Declaration

    Objective-C

    - (void)deleteResourcePolicy:
            (nonnull AWSComprehendDeleteResourcePolicyRequest *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSComprehendDeleteResourcePolicyResponse *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func deleteResourcePolicy(_ request: AWSComprehendDeleteResourcePolicyRequest) async throws -> AWSComprehendDeleteResourcePolicyResponse

    Parameters

    request

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

  • Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendDescribeDatasetRequest

    See

    AWSComprehendDescribeDatasetResponse

    Declaration

    Objective-C

    - (id)describeDataset:(nonnull AWSComprehendDescribeDatasetRequest *)request;

    Swift

    func describeDataset(_ request: AWSComprehendDescribeDatasetRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendDescribeDatasetRequest

    See

    AWSComprehendDescribeDatasetResponse

    Declaration

    Objective-C

    - (void)describeDataset:(nonnull AWSComprehendDescribeDatasetRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSComprehendDescribeDatasetResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func describeDataset(_ request: AWSComprehendDescribeDatasetRequest) async throws -> AWSComprehendDescribeDatasetResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeDataset 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 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) async throws -> AWSComprehendDescribeDocumentClassificationJobResponse

    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) async throws -> AWSComprehendDescribeDocumentClassifierResponse

    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) async throws -> AWSComprehendDescribeDominantLanguageDetectionJobResponse

    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. For information about endpoints, see Managing endpoints.

    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. For information about endpoints, see Managing endpoints.

    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) async throws -> AWSComprehendDescribeEndpointResponse

    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) async throws -> AWSComprehendDescribeEntitiesDetectionJobResponse

    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) async throws -> AWSComprehendDescribeEntityRecognizerResponse

    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 status and details of an events detection job.

    See

    AWSComprehendDescribeEventsDetectionJobRequest

    See

    AWSComprehendDescribeEventsDetectionJobResponse

    Declaration

    Objective-C

    - (id)describeEventsDetectionJob:
    (nonnull AWSComprehendDescribeEventsDetectionJobRequest *)request;

    Swift

    func describeEventsDetectionJob(_ request: AWSComprehendDescribeEventsDetectionJobRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets the status and details of an events detection job.

    See

    AWSComprehendDescribeEventsDetectionJobRequest

    See

    AWSComprehendDescribeEventsDetectionJobResponse

    Declaration

    Objective-C

    - (void)
    describeEventsDetectionJob:
        (nonnull AWSComprehendDescribeEventsDetectionJobRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSComprehendDescribeEventsDetectionJobResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func describeEventsDetectionJob(_ request: AWSComprehendDescribeEventsDetectionJobRequest) async throws -> AWSComprehendDescribeEventsDetectionJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeEventsDetectionJob 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 configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendDescribeFlywheelRequest

    See

    AWSComprehendDescribeFlywheelResponse

    Declaration

    Objective-C

    - (id)describeFlywheel:(nonnull AWSComprehendDescribeFlywheelRequest *)request;

    Swift

    func describeFlywheel(_ request: AWSComprehendDescribeFlywheelRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendDescribeFlywheelRequest

    See

    AWSComprehendDescribeFlywheelResponse

    Declaration

    Objective-C

    - (void)describeFlywheel:(nonnull AWSComprehendDescribeFlywheelRequest *)request
       completionHandler:
           (void (^_Nullable)(AWSComprehendDescribeFlywheelResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func describeFlywheel(_ request: AWSComprehendDescribeFlywheelRequest) async throws -> AWSComprehendDescribeFlywheelResponse

    Parameters

    request

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

  • Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendDescribeFlywheelIterationRequest

    See

    AWSComprehendDescribeFlywheelIterationResponse

    Declaration

    Objective-C

    - (id)describeFlywheelIteration:
    (nonnull AWSComprehendDescribeFlywheelIterationRequest *)request;

    Swift

    func describeFlywheelIteration(_ request: AWSComprehendDescribeFlywheelIterationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendDescribeFlywheelIterationRequest

    See

    AWSComprehendDescribeFlywheelIterationResponse

    Declaration

    Objective-C

    - (void)
    describeFlywheelIteration:
        (nonnull AWSComprehendDescribeFlywheelIterationRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSComprehendDescribeFlywheelIterationResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func describeFlywheelIteration(_ request: AWSComprehendDescribeFlywheelIterationRequest) async throws -> AWSComprehendDescribeFlywheelIterationResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeFlywheelIteration 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) async throws -> AWSComprehendDescribeKeyPhrasesDetectionJobResponse

    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 PII entities detection job. For example, you can use this operation to get the job status.

    See

    AWSComprehendDescribePiiEntitiesDetectionJobRequest

    See

    AWSComprehendDescribePiiEntitiesDetectionJobResponse

    Declaration

    Objective-C

    - (id)describePiiEntitiesDetectionJob:
    (nonnull AWSComprehendDescribePiiEntitiesDetectionJobRequest *)request;

    Swift

    func describePiiEntitiesDetectionJob(_ request: AWSComprehendDescribePiiEntitiesDetectionJobRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDescribePiiEntitiesDetectionJobResponse. 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 PII entities detection job. For example, you can use this operation to get the job status.

    See

    AWSComprehendDescribePiiEntitiesDetectionJobRequest

    See

    AWSComprehendDescribePiiEntitiesDetectionJobResponse

    Declaration

    Objective-C

    - (void)
    describePiiEntitiesDetectionJob:
        (nonnull AWSComprehendDescribePiiEntitiesDetectionJobRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSComprehendDescribePiiEntitiesDetectionJobResponse
                              *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func describePiiEntitiesDetectionJob(_ request: AWSComprehendDescribePiiEntitiesDetectionJobRequest) async throws -> AWSComprehendDescribePiiEntitiesDetectionJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribePiiEntitiesDetectionJob 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 details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.

    See

    AWSComprehendDescribeResourcePolicyRequest

    See

    AWSComprehendDescribeResourcePolicyResponse

    Declaration

    Objective-C

    - (id)describeResourcePolicy:
    (nonnull AWSComprehendDescribeResourcePolicyRequest *)request;

    Swift

    func describeResourcePolicy(_ request: AWSComprehendDescribeResourcePolicyRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.

    See

    AWSComprehendDescribeResourcePolicyRequest

    See

    AWSComprehendDescribeResourcePolicyResponse

    Declaration

    Objective-C

    - (void)describeResourcePolicy:
            (nonnull AWSComprehendDescribeResourcePolicyRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSComprehendDescribeResourcePolicyResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func describeResourcePolicy(_ request: AWSComprehendDescribeResourcePolicyRequest) async throws -> AWSComprehendDescribeResourcePolicyResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeResourcePolicy 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 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) async throws -> AWSComprehendDescribeSentimentDetectionJobResponse

    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 targeted sentiment detection job. Use this operation to get the status of the job.

    See

    AWSComprehendDescribeTargetedSentimentDetectionJobRequest

    See

    AWSComprehendDescribeTargetedSentimentDetectionJobResponse

    Declaration

    Objective-C

    - (id)describeTargetedSentimentDetectionJob:
    (nonnull AWSComprehendDescribeTargetedSentimentDetectionJobRequest *)
        request;

    Swift

    func describeTargetedSentimentDetectionJob(_ request: AWSComprehendDescribeTargetedSentimentDetectionJobRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendDescribeTargetedSentimentDetectionJobResponse. 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 targeted sentiment detection job. Use this operation to get the status of the job.

    See

    AWSComprehendDescribeTargetedSentimentDetectionJobRequest

    See

    AWSComprehendDescribeTargetedSentimentDetectionJobResponse

    Declaration

    Objective-C

    - (void)
    describeTargetedSentimentDetectionJob:
        (nonnull AWSComprehendDescribeTargetedSentimentDetectionJobRequest *)
            request
                        completionHandler:
                            (void (^_Nullable)(
                                AWSComprehendDescribeTargetedSentimentDetectionJobResponse
                                    *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func describeTargetedSentimentDetectionJob(_ request: AWSComprehendDescribeTargetedSentimentDetectionJobRequest) async throws -> AWSComprehendDescribeTargetedSentimentDetectionJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the DescribeTargetedSentimentDetectionJob 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) async throws -> AWSComprehendDescribeTopicsDetectionJobResponse

    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) async throws -> AWSComprehendDetectDominantLanguageResponse

    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.

  • Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.

    When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide.

    When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).

    If the system detects errors while processing a page in the input document, the API response includes an entry in Errors for each error.

    If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.

    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.

  • Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.

    When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide.

    When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).

    If the system detects errors while processing a page in the input document, the API response includes an entry in Errors for each error.

    If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.

    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) async throws -> AWSComprehendDetectEntitiesResponse

    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) async throws -> AWSComprehendDetectKeyPhrasesResponse

    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 the input text for entities that contain personally identifiable information (PII) and returns information about them.

    See

    AWSComprehendDetectPiiEntitiesRequest

    See

    AWSComprehendDetectPiiEntitiesResponse

    Declaration

    Objective-C

    - (id)detectPiiEntities:
    (nonnull AWSComprehendDetectPiiEntitiesRequest *)request;

    Swift

    func detectPiiEntities(_ request: AWSComprehendDetectPiiEntitiesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.

    See

    AWSComprehendDetectPiiEntitiesRequest

    See

    AWSComprehendDetectPiiEntitiesResponse

    Declaration

    Objective-C

    - (void)
    detectPiiEntities:(nonnull AWSComprehendDetectPiiEntitiesRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSComprehendDetectPiiEntitiesResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func detectPiiEntities(_ request: AWSComprehendDetectPiiEntitiesRequest) async throws -> AWSComprehendDetectPiiEntitiesResponse

    Parameters

    request

    A container for the necessary parameters to execute the DetectPiiEntities 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) async throws -> AWSComprehendDetectSentimentResponse

    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, see Syntax in the Comprehend Developer Guide.

    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, see Syntax in the Comprehend Developer Guide.

    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) async throws -> AWSComprehendDetectSyntaxResponse

    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.

  • Inspects the input text and returns a sentiment analysis for each entity identified in the text.

    For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendDetectTargetedSentimentRequest

    See

    AWSComprehendDetectTargetedSentimentResponse

    Declaration

    Objective-C

    - (id)detectTargetedSentiment:
    (nonnull AWSComprehendDetectTargetedSentimentRequest *)request;

    Swift

    func detectTargetedSentiment(_ request: AWSComprehendDetectTargetedSentimentRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Inspects the input text and returns a sentiment analysis for each entity identified in the text.

    For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendDetectTargetedSentimentRequest

    See

    AWSComprehendDetectTargetedSentimentResponse

    Declaration

    Objective-C

    - (void)detectTargetedSentiment:
            (nonnull AWSComprehendDetectTargetedSentimentRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSComprehendDetectTargetedSentimentResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func detectTargetedSentiment(_ request: AWSComprehendDetectTargetedSentimentRequest) async throws -> AWSComprehendDetectTargetedSentimentResponse

    Parameters

    request

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

  • Performs toxicity analysis on the list of text strings that you provide as input. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendDetectToxicContentRequest

    See

    AWSComprehendDetectToxicContentResponse

    Declaration

    Objective-C

    - (id)detectToxicContent:
    (nonnull AWSComprehendDetectToxicContentRequest *)request;

    Swift

    func detectToxicContent(_ request: AWSComprehendDetectToxicContentRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Performs toxicity analysis on the list of text strings that you provide as input. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendDetectToxicContentRequest

    See

    AWSComprehendDetectToxicContentResponse

    Declaration

    Objective-C

    - (void)
    detectToxicContent:(nonnull AWSComprehendDetectToxicContentRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSComprehendDetectToxicContentResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func detectToxicContent(_ request: AWSComprehendDetectToxicContentRequest) async throws -> AWSComprehendDetectToxicContentResponse

    Parameters

    request

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

  • Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one.

    If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it.

    The source model must be in the same Amazon Web Services Region that you’re using when you import. You can’t import a model that’s in a different Region.

    See

    AWSComprehendImportModelRequest

    See

    AWSComprehendImportModelResponse

    Declaration

    Objective-C

    - (id)importModel:(nonnull AWSComprehendImportModelRequest *)request;

    Swift

    func importModel(_ request: AWSComprehendImportModelRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one.

    If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it.

    The source model must be in the same Amazon Web Services Region that you’re using when you import. You can’t import a model that’s in a different Region.

    See

    AWSComprehendImportModelRequest

    See

    AWSComprehendImportModelResponse

    Declaration

    Objective-C

    - (void)importModel:(nonnull AWSComprehendImportModelRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSComprehendImportModelResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func importModel(_ request: AWSComprehendImportModelRequest) async throws -> AWSComprehendImportModelResponse

    Parameters

    request

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

  • List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendListDatasetsRequest

    See

    AWSComprehendListDatasetsResponse

    Declaration

    Objective-C

    - (id)listDatasets:(nonnull AWSComprehendListDatasetsRequest *)request;

    Swift

    func listDatasets(_ request: AWSComprehendListDatasetsRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendListDatasetsRequest

    See

    AWSComprehendListDatasetsResponse

    Declaration

    Objective-C

    - (void)listDatasets:(nonnull AWSComprehendListDatasetsRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSComprehendListDatasetsResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func listDatasets(_ request: AWSComprehendListDatasetsRequest) async throws -> AWSComprehendListDatasetsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListDatasets 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, AWSComprehendErrorResourceNotFound, 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) async throws -> AWSComprehendListDocumentClassificationJobsResponse

    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 summaries of the document classifiers that you have created

    See

    AWSComprehendListDocumentClassifierSummariesRequest

    See

    AWSComprehendListDocumentClassifierSummariesResponse

    Declaration

    Objective-C

    - (id)listDocumentClassifierSummaries:
    (nonnull AWSComprehendListDocumentClassifierSummariesRequest *)request;

    Swift

    func listDocumentClassifierSummaries(_ request: AWSComprehendListDocumentClassifierSummariesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    See

    AWSComprehendListDocumentClassifierSummariesRequest

    See

    AWSComprehendListDocumentClassifierSummariesResponse

    Declaration

    Objective-C

    - (void)
    listDocumentClassifierSummaries:
        (nonnull AWSComprehendListDocumentClassifierSummariesRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSComprehendListDocumentClassifierSummariesResponse
                              *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func listDocumentClassifierSummaries(_ request: AWSComprehendListDocumentClassifierSummariesRequest) async throws -> AWSComprehendListDocumentClassifierSummariesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListDocumentClassifierSummaries 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 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) async throws -> AWSComprehendListDocumentClassifiersResponse

    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) async throws -> AWSComprehendListDominantLanguageDetectionJobsResponse

    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. For information about endpoints, see Managing endpoints.

    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. For information about endpoints, see Managing endpoints.

    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) async throws -> AWSComprehendListEndpointsResponse

    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) async throws -> AWSComprehendListEntitiesDetectionJobsResponse

    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 summaries for the entity recognizers that you have created.

    See

    AWSComprehendListEntityRecognizerSummariesRequest

    See

    AWSComprehendListEntityRecognizerSummariesResponse

    Declaration

    Objective-C

    - (id)listEntityRecognizerSummaries:
    (nonnull AWSComprehendListEntityRecognizerSummariesRequest *)request;

    Swift

    func listEntityRecognizerSummaries(_ request: AWSComprehendListEntityRecognizerSummariesRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Gets a list of summaries for the entity recognizers that you have created.

    See

    AWSComprehendListEntityRecognizerSummariesRequest

    See

    AWSComprehendListEntityRecognizerSummariesResponse

    Declaration

    Objective-C

    - (void)listEntityRecognizerSummaries:
            (nonnull AWSComprehendListEntityRecognizerSummariesRequest *)request
                    completionHandler:
                        (void (^_Nullable)(
                            AWSComprehendListEntityRecognizerSummariesResponse
                                *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func listEntityRecognizerSummaries(_ request: AWSComprehendListEntityRecognizerSummariesRequest) async throws -> AWSComprehendListEntityRecognizerSummariesResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListEntityRecognizerSummaries 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 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) async throws -> AWSComprehendListEntityRecognizersResponse

    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.

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

    See

    AWSComprehendListEventsDetectionJobsRequest

    See

    AWSComprehendListEventsDetectionJobsResponse

    Declaration

    Objective-C

    - (id)listEventsDetectionJobs:
    (nonnull AWSComprehendListEventsDetectionJobsRequest *)request;

    Swift

    func listEventsDetectionJobs(_ request: AWSComprehendListEventsDetectionJobsRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendListEventsDetectionJobsResponse. 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 events detection jobs that you have submitted.

    See

    AWSComprehendListEventsDetectionJobsRequest

    See

    AWSComprehendListEventsDetectionJobsResponse

    Declaration

    Objective-C

    - (void)listEventsDetectionJobs:
            (nonnull AWSComprehendListEventsDetectionJobsRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSComprehendListEventsDetectionJobsResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func listEventsDetectionJobs(_ request: AWSComprehendListEventsDetectionJobsRequest) async throws -> AWSComprehendListEventsDetectionJobsResponse

    Parameters

    request

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

  • Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendListFlywheelIterationHistoryRequest

    See

    AWSComprehendListFlywheelIterationHistoryResponse

    Declaration

    Objective-C

    - (id)listFlywheelIterationHistory:
    (nonnull AWSComprehendListFlywheelIterationHistoryRequest *)request;

    Swift

    func listFlywheelIterationHistory(_ request: AWSComprehendListFlywheelIterationHistoryRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendListFlywheelIterationHistoryRequest

    See

    AWSComprehendListFlywheelIterationHistoryResponse

    Declaration

    Objective-C

    - (void)listFlywheelIterationHistory:
            (nonnull AWSComprehendListFlywheelIterationHistoryRequest *)request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSComprehendListFlywheelIterationHistoryResponse
                               *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func listFlywheelIterationHistory(_ request: AWSComprehendListFlywheelIterationHistoryRequest) async throws -> AWSComprehendListFlywheelIterationHistoryResponse

    Parameters

    request

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

  • Gets a list of the flywheels that you have created.

    See

    AWSComprehendListFlywheelsRequest

    See

    AWSComprehendListFlywheelsResponse

    Declaration

    Objective-C

    - (id)listFlywheels:(nonnull AWSComprehendListFlywheelsRequest *)request;

    Swift

    func listFlywheels(_ request: AWSComprehendListFlywheelsRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendListFlywheelsResponse. 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 flywheels that you have created.

    See

    AWSComprehendListFlywheelsRequest

    See

    AWSComprehendListFlywheelsResponse

    Declaration

    Objective-C

    - (void)listFlywheels:(nonnull AWSComprehendListFlywheelsRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSComprehendListFlywheelsResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func listFlywheels(_ request: AWSComprehendListFlywheelsRequest) async throws -> AWSComprehendListFlywheelsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListFlywheels 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) async throws -> AWSComprehendListKeyPhrasesDetectionJobsResponse

    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 the PII entity detection jobs that you have submitted.

    See

    AWSComprehendListPiiEntitiesDetectionJobsRequest

    See

    AWSComprehendListPiiEntitiesDetectionJobsResponse

    Declaration

    Objective-C

    - (id)listPiiEntitiesDetectionJobs:
    (nonnull AWSComprehendListPiiEntitiesDetectionJobsRequest *)request;

    Swift

    func listPiiEntitiesDetectionJobs(_ request: AWSComprehendListPiiEntitiesDetectionJobsRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendListPiiEntitiesDetectionJobsResponse. 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 PII entity detection jobs that you have submitted.

    See

    AWSComprehendListPiiEntitiesDetectionJobsRequest

    See

    AWSComprehendListPiiEntitiesDetectionJobsResponse

    Declaration

    Objective-C

    - (void)listPiiEntitiesDetectionJobs:
            (nonnull AWSComprehendListPiiEntitiesDetectionJobsRequest *)request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSComprehendListPiiEntitiesDetectionJobsResponse
                               *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func listPiiEntitiesDetectionJobs(_ request: AWSComprehendListPiiEntitiesDetectionJobsRequest) async throws -> AWSComprehendListPiiEntitiesDetectionJobsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListPiiEntitiesDetectionJobs 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) async throws -> AWSComprehendListSentimentDetectionJobsResponse

    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) async throws -> AWSComprehendListTagsForResourceResponse

    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 targeted sentiment detection jobs that you have submitted.

    See

    AWSComprehendListTargetedSentimentDetectionJobsRequest

    See

    AWSComprehendListTargetedSentimentDetectionJobsResponse

    Declaration

    Objective-C

    - (id)listTargetedSentimentDetectionJobs:
    (nonnull AWSComprehendListTargetedSentimentDetectionJobsRequest *)request;

    Swift

    func listTargetedSentimentDetectionJobs(_ request: AWSComprehendListTargetedSentimentDetectionJobsRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSComprehendListTargetedSentimentDetectionJobsResponse. 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 targeted sentiment detection jobs that you have submitted.

    See

    AWSComprehendListTargetedSentimentDetectionJobsRequest

    See

    AWSComprehendListTargetedSentimentDetectionJobsResponse

    Declaration

    Objective-C

    - (void)
    listTargetedSentimentDetectionJobs:
        (nonnull AWSComprehendListTargetedSentimentDetectionJobsRequest *)
            request
                     completionHandler:
                         (void (^_Nullable)(
                             AWSComprehendListTargetedSentimentDetectionJobsResponse
                                 *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func listTargetedSentimentDetectionJobs(_ request: AWSComprehendListTargetedSentimentDetectionJobsRequest) async throws -> AWSComprehendListTargetedSentimentDetectionJobsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListTargetedSentimentDetectionJobs 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 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) async throws -> AWSComprehendListTopicsDetectionJobsResponse

    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.

  • Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account.

    See

    AWSComprehendPutResourcePolicyRequest

    See

    AWSComprehendPutResourcePolicyResponse

    Declaration

    Objective-C

    - (id)putResourcePolicy:
    (nonnull AWSComprehendPutResourcePolicyRequest *)request;

    Swift

    func putResourcePolicy(_ request: AWSComprehendPutResourcePolicyRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account.

    See

    AWSComprehendPutResourcePolicyRequest

    See

    AWSComprehendPutResourcePolicyResponse

    Declaration

    Objective-C

    - (void)
    putResourcePolicy:(nonnull AWSComprehendPutResourcePolicyRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSComprehendPutResourcePolicyResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func putResourcePolicy(_ request: AWSComprehendPutResourcePolicyRequest) async throws -> AWSComprehendPutResourcePolicyResponse

    Parameters

    request

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

  • Starts an asynchronous document classification job using a custom classification model. Use the DescribeDocumentClassificationJob 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, AWSComprehendErrorTooManyTags, AWSComprehendErrorResourceInUse, AWSComprehendErrorInternalServer.

  • Starts an asynchronous document classification job using a custom classification model. Use the DescribeDocumentClassificationJob 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) async throws -> AWSComprehendStartDocumentClassificationJobResponse

    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, AWSComprehendErrorTooManyTags, AWSComprehendErrorResourceInUse, 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, AWSComprehendErrorTooManyTags, AWSComprehendErrorResourceInUse, 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) async throws -> AWSComprehendStartDominantLanguageDetectionJobResponse

    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, AWSComprehendErrorTooManyTags, AWSComprehendErrorResourceInUse, 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, AWSComprehendErrorTooManyTags, AWSComprehendErrorResourceInUse, 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) async throws -> AWSComprehendStartEntitiesDetectionJobResponse

    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, AWSComprehendErrorTooManyTags, AWSComprehendErrorResourceInUse, AWSComprehendErrorInternalServer.

  • Starts an asynchronous event detection job for a collection of documents.

    See

    AWSComprehendStartEventsDetectionJobRequest

    See

    AWSComprehendStartEventsDetectionJobResponse

    Declaration

    Objective-C

    - (id)startEventsDetectionJob:
    (nonnull AWSComprehendStartEventsDetectionJobRequest *)request;

    Swift

    func startEventsDetectionJob(_ request: AWSComprehendStartEventsDetectionJobRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Starts an asynchronous event detection job for a collection of documents.

    See

    AWSComprehendStartEventsDetectionJobRequest

    See

    AWSComprehendStartEventsDetectionJobResponse

    Declaration

    Objective-C

    - (void)startEventsDetectionJob:
            (nonnull AWSComprehendStartEventsDetectionJobRequest *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSComprehendStartEventsDetectionJobResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func startEventsDetectionJob(_ request: AWSComprehendStartEventsDetectionJobRequest) async throws -> AWSComprehendStartEventsDetectionJobResponse

    Parameters

    request

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

  • Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendStartFlywheelIterationRequest

    See

    AWSComprehendStartFlywheelIterationResponse

    Declaration

    Objective-C

    - (id)startFlywheelIteration:
    (nonnull AWSComprehendStartFlywheelIterationRequest *)request;

    Swift

    func startFlywheelIteration(_ request: AWSComprehendStartFlywheelIterationRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

    See

    AWSComprehendStartFlywheelIterationRequest

    See

    AWSComprehendStartFlywheelIterationResponse

    Declaration

    Objective-C

    - (void)startFlywheelIteration:
            (nonnull AWSComprehendStartFlywheelIterationRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSComprehendStartFlywheelIterationResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func startFlywheelIteration(_ request: AWSComprehendStartFlywheelIterationRequest) async throws -> AWSComprehendStartFlywheelIterationResponse

    Parameters

    request

    A container for the necessary parameters to execute the StartFlywheelIteration 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, AWSComprehendErrorResourceNotFound, 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, AWSComprehendErrorTooManyTags, AWSComprehendErrorResourceInUse, 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) async throws -> AWSComprehendStartKeyPhrasesDetectionJobResponse

    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, AWSComprehendErrorTooManyTags, AWSComprehendErrorResourceInUse, AWSComprehendErrorInternalServer.

  • Starts an asynchronous PII entity detection job for a collection of documents.

    See

    AWSComprehendStartPiiEntitiesDetectionJobRequest

    See

    AWSComprehendStartPiiEntitiesDetectionJobResponse

    Declaration

    Objective-C

    - (id)startPiiEntitiesDetectionJob:
    (nonnull AWSComprehendStartPiiEntitiesDetectionJobRequest *)request;

    Swift

    func startPiiEntitiesDetectionJob(_ request: AWSComprehendStartPiiEntitiesDetectionJobRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Starts an asynchronous PII entity detection job for a collection of documents.

    See

    AWSComprehendStartPiiEntitiesDetectionJobRequest

    See

    AWSComprehendStartPiiEntitiesDetectionJobResponse

    Declaration

    Objective-C

    - (void)startPiiEntitiesDetectionJob:
            (nonnull AWSComprehendStartPiiEntitiesDetectionJobRequest *)request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSComprehendStartPiiEntitiesDetectionJobResponse
                               *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func startPiiEntitiesDetectionJob(_ request: AWSComprehendStartPiiEntitiesDetectionJobRequest) async throws -> AWSComprehendStartPiiEntitiesDetectionJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the StartPiiEntitiesDetectionJob 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, AWSComprehendErrorTooManyTags, AWSComprehendErrorResourceInUse, 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, AWSComprehendErrorTooManyTags, AWSComprehendErrorResourceInUse, 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) async throws -> AWSComprehendStartSentimentDetectionJobResponse

    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, AWSComprehendErrorTooManyTags, AWSComprehendErrorResourceInUse, AWSComprehendErrorInternalServer.

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

    See

    AWSComprehendStartTargetedSentimentDetectionJobRequest

    See

    AWSComprehendStartTargetedSentimentDetectionJobResponse

    Declaration

    Objective-C

    - (id)startTargetedSentimentDetectionJob:
    (nonnull AWSComprehendStartTargetedSentimentDetectionJobRequest *)request;

    Swift

    func startTargetedSentimentDetectionJob(_ request: AWSComprehendStartTargetedSentimentDetectionJobRequest) -> Any!

    Parameters

    request

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

    Return Value

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

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

    See

    AWSComprehendStartTargetedSentimentDetectionJobRequest

    See

    AWSComprehendStartTargetedSentimentDetectionJobResponse

    Declaration

    Objective-C

    - (void)
    startTargetedSentimentDetectionJob:
        (nonnull AWSComprehendStartTargetedSentimentDetectionJobRequest *)
            request
                     completionHandler:
                         (void (^_Nullable)(
                             AWSComprehendStartTargetedSentimentDetectionJobResponse
                                 *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func startTargetedSentimentDetectionJob(_ request: AWSComprehendStartTargetedSentimentDetectionJobRequest) async throws -> AWSComprehendStartTargetedSentimentDetectionJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the StartTargetedSentimentDetectionJob 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, AWSComprehendErrorTooManyTags, AWSComprehendErrorResourceInUse, 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, AWSComprehendErrorTooManyTags, AWSComprehendErrorResourceInUse, 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) async throws -> AWSComprehendStartTopicsDetectionJobResponse

    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, AWSComprehendErrorTooManyTags, AWSComprehendErrorResourceInUse, 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) async throws -> AWSComprehendStopDominantLanguageDetectionJobResponse

    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) async throws -> AWSComprehendStopEntitiesDetectionJobResponse

    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 an events detection job in progress.

    See

    AWSComprehendStopEventsDetectionJobRequest

    See

    AWSComprehendStopEventsDetectionJobResponse

    Declaration

    Objective-C

    - (id)stopEventsDetectionJob:
    (nonnull AWSComprehendStopEventsDetectionJobRequest *)request;

    Swift

    func stopEventsDetectionJob(_ request: AWSComprehendStopEventsDetectionJobRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Stops an events detection job in progress.

    See

    AWSComprehendStopEventsDetectionJobRequest

    See

    AWSComprehendStopEventsDetectionJobResponse

    Declaration

    Objective-C

    - (void)stopEventsDetectionJob:
            (nonnull AWSComprehendStopEventsDetectionJobRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSComprehendStopEventsDetectionJobResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func stopEventsDetectionJob(_ request: AWSComprehendStopEventsDetectionJobRequest) async throws -> AWSComprehendStopEventsDetectionJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the StopEventsDetectionJob 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) async throws -> AWSComprehendStopKeyPhrasesDetectionJobResponse

    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 PII entities detection job in progress.

    See

    AWSComprehendStopPiiEntitiesDetectionJobRequest

    See

    AWSComprehendStopPiiEntitiesDetectionJobResponse

    Declaration

    Objective-C

    - (id)stopPiiEntitiesDetectionJob:
    (nonnull AWSComprehendStopPiiEntitiesDetectionJobRequest *)request;

    Swift

    func stopPiiEntitiesDetectionJob(_ request: AWSComprehendStopPiiEntitiesDetectionJobRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Stops a PII entities detection job in progress.

    See

    AWSComprehendStopPiiEntitiesDetectionJobRequest

    See

    AWSComprehendStopPiiEntitiesDetectionJobResponse

    Declaration

    Objective-C

    - (void)stopPiiEntitiesDetectionJob:
            (nonnull AWSComprehendStopPiiEntitiesDetectionJobRequest *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSComprehendStopPiiEntitiesDetectionJobResponse
                              *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func stopPiiEntitiesDetectionJob(_ request: AWSComprehendStopPiiEntitiesDetectionJobRequest) async throws -> AWSComprehendStopPiiEntitiesDetectionJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the StopPiiEntitiesDetectionJob 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) async throws -> AWSComprehendStopSentimentDetectionJobResponse

    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 targeted 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

    AWSComprehendStopTargetedSentimentDetectionJobRequest

    See

    AWSComprehendStopTargetedSentimentDetectionJobResponse

    Declaration

    Objective-C

    - (id)stopTargetedSentimentDetectionJob:
    (nonnull AWSComprehendStopTargetedSentimentDetectionJobRequest *)request;

    Swift

    func stopTargetedSentimentDetectionJob(_ request: AWSComprehendStopTargetedSentimentDetectionJobRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Stops a targeted 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

    AWSComprehendStopTargetedSentimentDetectionJobRequest

    See

    AWSComprehendStopTargetedSentimentDetectionJobResponse

    Declaration

    Objective-C

    - (void)
    stopTargetedSentimentDetectionJob:
        (nonnull AWSComprehendStopTargetedSentimentDetectionJobRequest *)request
                    completionHandler:
                        (void (^_Nullable)(
                            AWSComprehendStopTargetedSentimentDetectionJobResponse
                                *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func stopTargetedSentimentDetectionJob(_ request: AWSComprehendStopTargetedSentimentDetectionJobRequest) async throws -> AWSComprehendStopTargetedSentimentDetectionJobResponse

    Parameters

    request

    A container for the necessary parameters to execute the StopTargetedSentimentDetectionJob 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) async throws -> AWSComprehendStopTrainingDocumentClassifierResponse

    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) async throws -> AWSComprehendStopTrainingEntityRecognizerResponse

    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) async throws -> AWSComprehendTagResourceResponse

    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) async throws -> AWSComprehendUntagResourceResponse

    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. For information about endpoints, see Managing endpoints.

    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. For information about endpoints, see Managing endpoints.

    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) async throws -> AWSComprehendUpdateEndpointResponse

    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.

  • Update the configuration information for an existing flywheel.

    See

    AWSComprehendUpdateFlywheelRequest

    See

    AWSComprehendUpdateFlywheelResponse

    Declaration

    Objective-C

    - (id)updateFlywheel:(nonnull AWSComprehendUpdateFlywheelRequest *)request;

    Swift

    func updateFlywheel(_ request: AWSComprehendUpdateFlywheelRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Update the configuration information for an existing flywheel.

    See

    AWSComprehendUpdateFlywheelRequest

    See

    AWSComprehendUpdateFlywheelResponse

    Declaration

    Objective-C

    - (void)updateFlywheel:(nonnull AWSComprehendUpdateFlywheelRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSComprehendUpdateFlywheelResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func updateFlywheel(_ request: AWSComprehendUpdateFlywheelRequest) async throws -> AWSComprehendUpdateFlywheelResponse

    Parameters

    request

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