AWSTextract

Objective-C

@interface AWSTextract

Swift

class AWSTextract

Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.

  • 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 Textract = AWSTextract.default()

    Objective-C

    AWSTextract *Textract = [AWSTextract defaultTextract];

    Declaration

    Objective-C

    + (nonnull instancetype)defaultTextract;

    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)
   AWSTextract.register(with: configuration!, forKey: "USWest2Textract")

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

    [AWSTextract registerTextractWithConfiguration:configuration forKey:@"USWest2Textract"];

    return YES;
}

    Then call the following to get the service client:

    Swift

    let Textract = AWSTextract(forKey: "USWest2Textract")

    Objective-C

    AWSTextract *Textract = [AWSTextract TextractForKey:@"USWest2Textract"];

    Warning

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

    Declaration

    Objective-C

    + (void)registerTextractWithConfiguration:(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 + registerTextractWithConfiguration: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)
   AWSTextract.register(with: configuration!, forKey: "USWest2Textract")

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

    [AWSTextract registerTextractWithConfiguration:configuration forKey:@"USWest2Textract"];

    return YES;
}

    Then call the following to get the service client:

    Swift

    let Textract = AWSTextract(forKey: "USWest2Textract")

    Objective-C

    AWSTextract *Textract = [AWSTextract TextractForKey:@"USWest2Textract"];

    Declaration

    Objective-C

    + (nonnull instancetype)TextractForKey:(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)removeTextractForKey:(nonnull NSString *)key;

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

  • Analyzes an input document for relationships between detected items.

    The types of information returned are as follows:

    • Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.

    • Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.

    • Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn’t have a relationship with the value of FeatureTypes).

    • Signatures. A SIGNATURE Block object contains the location information of a signature in a document. If used in conjunction with forms or tables, a signature can be given a Key-Value pairing or be detected in the cell of a table.

    • Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.

    • Query Result. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.

    Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.

    You can choose which type of analysis to perform by specifying the FeatureTypes list.

    The output is returned in a list of Block objects.

    AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.

    For more information, see Document Text Analysis.

    See

    AWSTextractAnalyzeDocumentRequest

    See

    AWSTextractAnalyzeDocumentResponse

    Declaration

    Objective-C

    - (id)analyzeDocument:(nonnull AWSTextractAnalyzeDocumentRequest *)request;

    Swift

    func analyzeDocument(_ request: AWSTextractAnalyzeDocumentRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractAnalyzeDocumentResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorUnsupportedDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorBadDocument, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorHumanLoopQuotaExceeded.

  • Analyzes an input document for relationships between detected items.

    The types of information returned are as follows:

    • Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.

    • Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.

    • Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn’t have a relationship with the value of FeatureTypes).

    • Signatures. A SIGNATURE Block object contains the location information of a signature in a document. If used in conjunction with forms or tables, a signature can be given a Key-Value pairing or be detected in the cell of a table.

    • Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.

    • Query Result. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.

    Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.

    You can choose which type of analysis to perform by specifying the FeatureTypes list.

    The output is returned in a list of Block objects.

    AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.

    For more information, see Document Text Analysis.

    See

    AWSTextractAnalyzeDocumentRequest

    See

    AWSTextractAnalyzeDocumentResponse

    Declaration

    Objective-C

    - (void)analyzeDocument:(nonnull AWSTextractAnalyzeDocumentRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSTextractAnalyzeDocumentResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func analyzeDocument(_ request: AWSTextractAnalyzeDocumentRequest) async throws -> AWSTextractAnalyzeDocumentResponse

    Parameters

    request

    A container for the necessary parameters to execute the AnalyzeDocument 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorUnsupportedDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorBadDocument, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorHumanLoopQuotaExceeded.

  • AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.

    Information is returned as ExpenseDocuments and seperated as follows:

    • LineItemGroups- A data set containing LineItems which store information about the lines of text, such as an item purchased and its price on a receipt.

    • SummaryFields- Contains all other information a receipt, such as header information or the vendors name.

    See

    AWSTextractAnalyzeExpenseRequest

    See

    AWSTextractAnalyzeExpenseResponse

    Declaration

    Objective-C

    - (id)analyzeExpense:(nonnull AWSTextractAnalyzeExpenseRequest *)request;

    Swift

    func analyzeExpense(_ request: AWSTextractAnalyzeExpenseRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractAnalyzeExpenseResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorUnsupportedDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorBadDocument, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling.

  • AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.

    Information is returned as ExpenseDocuments and seperated as follows:

    • LineItemGroups- A data set containing LineItems which store information about the lines of text, such as an item purchased and its price on a receipt.

    • SummaryFields- Contains all other information a receipt, such as header information or the vendors name.

    See

    AWSTextractAnalyzeExpenseRequest

    See

    AWSTextractAnalyzeExpenseResponse

    Declaration

    Objective-C

    - (void)analyzeExpense:(nonnull AWSTextractAnalyzeExpenseRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSTextractAnalyzeExpenseResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func analyzeExpense(_ request: AWSTextractAnalyzeExpenseRequest) async throws -> AWSTextractAnalyzeExpenseResponse

    Parameters

    request

    A container for the necessary parameters to execute the AnalyzeExpense 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorUnsupportedDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorBadDocument, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling.

  • Analyzes identity documents for relevant information. This information is extracted and returned as IdentityDocumentFields, which records both the normalized field and value of the extracted text. Unlike other Amazon Textract operations, AnalyzeID doesn’t return any Geometry data.

    See

    AWSTextractAnalyzeIDRequest

    See

    AWSTextractAnalyzeIDResponse

    Declaration

    Objective-C

    - (id)analyzeID:(nonnull AWSTextractAnalyzeIDRequest *)request;

    Swift

    func analyzeID(_ request: AWSTextractAnalyzeIDRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractAnalyzeIDResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorUnsupportedDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorBadDocument, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling.

  • Analyzes identity documents for relevant information. This information is extracted and returned as IdentityDocumentFields, which records both the normalized field and value of the extracted text. Unlike other Amazon Textract operations, AnalyzeID doesn’t return any Geometry data.

    See

    AWSTextractAnalyzeIDRequest

    See

    AWSTextractAnalyzeIDResponse

    Declaration

    Objective-C

    - (void)analyzeID:(nonnull AWSTextractAnalyzeIDRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSTextractAnalyzeIDResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func analyzeID(_ request: AWSTextractAnalyzeIDRequest) async throws -> AWSTextractAnalyzeIDResponse

    Parameters

    request

    A container for the necessary parameters to execute the AnalyzeID 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorUnsupportedDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorBadDocument, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling.

  • Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is QUERIES. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED.

    See

    AWSTextractCreateAdapterRequest

    See

    AWSTextractCreateAdapterResponse

    Declaration

    Objective-C

    - (id)createAdapter:(nonnull AWSTextractCreateAdapterRequest *)request;

    Swift

    func createAdapter(_ request: AWSTextractCreateAdapterRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractCreateAdapterResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorConflict, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorIdempotentParameterMismatch, AWSTextractErrorThrottling, AWSTextractErrorLimitExceeded, AWSTextractErrorValidation, AWSTextractErrorServiceQuotaExceeded.

  • Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is QUERIES. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED.

    See

    AWSTextractCreateAdapterRequest

    See

    AWSTextractCreateAdapterResponse

    Declaration

    Objective-C

    - (void)createAdapter:(nonnull AWSTextractCreateAdapterRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSTextractCreateAdapterResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func createAdapter(_ request: AWSTextractCreateAdapterRequest) async throws -> AWSTextractCreateAdapterResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateAdapter 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorConflict, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorIdempotentParameterMismatch, AWSTextractErrorThrottling, AWSTextractErrorLimitExceeded, AWSTextractErrorValidation, AWSTextractErrorServiceQuotaExceeded.

  • Creates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags.

    See

    AWSTextractCreateAdapterVersionRequest

    See

    AWSTextractCreateAdapterVersionResponse

    Declaration

    Objective-C

    - (id)createAdapterVersion:
    (nonnull AWSTextractCreateAdapterVersionRequest *)request;

    Swift

    func createAdapterVersion(_ request: AWSTextractCreateAdapterVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractCreateAdapterVersionResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorIdempotentParameterMismatch, AWSTextractErrorThrottling, AWSTextractErrorLimitExceeded, AWSTextractErrorValidation, AWSTextractErrorServiceQuotaExceeded, AWSTextractErrorResourceNotFound, AWSTextractErrorConflict.

  • Creates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags.

    See

    AWSTextractCreateAdapterVersionRequest

    See

    AWSTextractCreateAdapterVersionResponse

    Declaration

    Objective-C

    - (void)createAdapterVersion:
            (nonnull AWSTextractCreateAdapterVersionRequest *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSTextractCreateAdapterVersionResponse *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func createAdapterVersion(_ request: AWSTextractCreateAdapterVersionRequest) async throws -> AWSTextractCreateAdapterVersionResponse

    Parameters

    request

    A container for the necessary parameters to execute the CreateAdapterVersion 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorIdempotentParameterMismatch, AWSTextractErrorThrottling, AWSTextractErrorLimitExceeded, AWSTextractErrorValidation, AWSTextractErrorServiceQuotaExceeded, AWSTextractErrorResourceNotFound, AWSTextractErrorConflict.

  • Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID.

    See

    AWSTextractDeleteAdapterRequest

    See

    AWSTextractDeleteAdapterResponse

    Declaration

    Objective-C

    - (id)deleteAdapter:(nonnull AWSTextractDeleteAdapterRequest *)request;

    Swift

    func deleteAdapter(_ request: AWSTextractDeleteAdapterRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractDeleteAdapterResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorConflict, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation, AWSTextractErrorResourceNotFound.

  • Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID.

    See

    AWSTextractDeleteAdapterRequest

    See

    AWSTextractDeleteAdapterResponse

    Declaration

    Objective-C

    - (void)deleteAdapter:(nonnull AWSTextractDeleteAdapterRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSTextractDeleteAdapterResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func deleteAdapter(_ request: AWSTextractDeleteAdapterRequest) async throws -> AWSTextractDeleteAdapterResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteAdapter 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorConflict, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation, AWSTextractErrorResourceNotFound.

  • Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion.

    See

    AWSTextractDeleteAdapterVersionRequest

    See

    AWSTextractDeleteAdapterVersionResponse

    Declaration

    Objective-C

    - (id)deleteAdapterVersion:
    (nonnull AWSTextractDeleteAdapterVersionRequest *)request;

    Swift

    func deleteAdapterVersion(_ request: AWSTextractDeleteAdapterVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractDeleteAdapterVersionResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorConflict, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation, AWSTextractErrorResourceNotFound.

  • Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion.

    See

    AWSTextractDeleteAdapterVersionRequest

    See

    AWSTextractDeleteAdapterVersionResponse

    Declaration

    Objective-C

    - (void)deleteAdapterVersion:
            (nonnull AWSTextractDeleteAdapterVersionRequest *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSTextractDeleteAdapterVersionResponse *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func deleteAdapterVersion(_ request: AWSTextractDeleteAdapterVersionRequest) async throws -> AWSTextractDeleteAdapterVersionResponse

    Parameters

    request

    A container for the necessary parameters to execute the DeleteAdapterVersion 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorConflict, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation, AWSTextractErrorResourceNotFound.

  • Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be in one of the following image formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the detected text in an array of Block objects.

    Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

    DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection.

    For more information, see Document Text Detection.

    See

    AWSTextractDetectDocumentTextRequest

    See

    AWSTextractDetectDocumentTextResponse

    Declaration

    Objective-C

    - (id)detectDocumentText:
    (nonnull AWSTextractDetectDocumentTextRequest *)request;

    Swift

    func detectDocumentText(_ request: AWSTextractDetectDocumentTextRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractDetectDocumentTextResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorUnsupportedDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorBadDocument, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling.

  • Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be in one of the following image formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the detected text in an array of Block objects.

    Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

    DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection.

    For more information, see Document Text Detection.

    See

    AWSTextractDetectDocumentTextRequest

    See

    AWSTextractDetectDocumentTextResponse

    Declaration

    Objective-C

    - (void)
    detectDocumentText:(nonnull AWSTextractDetectDocumentTextRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSTextractDetectDocumentTextResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func detectDocumentText(_ request: AWSTextractDetectDocumentTextRequest) async throws -> AWSTextractDetectDocumentTextResponse

    Parameters

    request

    A container for the necessary parameters to execute the DetectDocumentText 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorUnsupportedDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorBadDocument, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling.

  • Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.

    See

    AWSTextractGetAdapterRequest

    See

    AWSTextractGetAdapterResponse

    Declaration

    Objective-C

    - (id)getAdapter:(nonnull AWSTextractGetAdapterRequest *)request;

    Swift

    func getAdapter(_ request: AWSTextractGetAdapterRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractGetAdapterResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation, AWSTextractErrorResourceNotFound.

  • Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.

    See

    AWSTextractGetAdapterRequest

    See

    AWSTextractGetAdapterResponse

    Declaration

    Objective-C

    - (void)getAdapter:(nonnull AWSTextractGetAdapterRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSTextractGetAdapterResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func adapter(_ request: AWSTextractGetAdapterRequest) async throws -> AWSTextractGetAdapterResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetAdapter 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation, AWSTextractErrorResourceNotFound.

  • Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.

    See

    AWSTextractGetAdapterVersionRequest

    See

    AWSTextractGetAdapterVersionResponse

    Declaration

    Objective-C

    - (id)getAdapterVersion:(nonnull AWSTextractGetAdapterVersionRequest *)request;

    Swift

    func getAdapterVersion(_ request: AWSTextractGetAdapterVersionRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractGetAdapterVersionResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation, AWSTextractErrorResourceNotFound.

  • Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.

    See

    AWSTextractGetAdapterVersionRequest

    See

    AWSTextractGetAdapterVersionResponse

    Declaration

    Objective-C

    - (void)getAdapterVersion:(nonnull AWSTextractGetAdapterVersionRequest *)request
        completionHandler:
            (void (^_Nullable)(AWSTextractGetAdapterVersionResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func adapterVersion(_ request: AWSTextractGetAdapterVersionRequest) async throws -> AWSTextractGetAdapterVersionResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetAdapterVersion 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation, AWSTextractErrorResourceNotFound.

  • Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.

    You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that’s registered in the initial call to StartDocumentAnalysis. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

    GetDocumentAnalysis returns an array of Block objects. The following types of information are returned:

    • Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.

    • Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.

    • Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn’t have a relationship with the value of the StartDocumentAnalysisFeatureTypes input parameter).

    • Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.

    • Query Results. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.

    While processing a document with queries, look out for INVALID_REQUEST_PARAMETERS output. This indicates that either the per page query limit has been exceeded or that the operation is trying to query a page in the document which doesn’t exist.

    Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.

    Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentAnalysis, and populate the NextToken request parameter with the token value that’s returned from the previous call to GetDocumentAnalysis.

    For more information, see Document Text Analysis.

    See

    AWSTextractGetDocumentAnalysisRequest

    See

    AWSTextractGetDocumentAnalysisResponse

    Declaration

    Objective-C

    - (id)getDocumentAnalysis:
    (nonnull AWSTextractGetDocumentAnalysisRequest *)request;

    Swift

    func getDocumentAnalysis(_ request: AWSTextractGetDocumentAnalysisRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractGetDocumentAnalysisResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInvalidJobId, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey.

  • Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.

    You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that’s registered in the initial call to StartDocumentAnalysis. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

    GetDocumentAnalysis returns an array of Block objects. The following types of information are returned:

    • Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.

    • Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.

    • Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn’t have a relationship with the value of the StartDocumentAnalysisFeatureTypes input parameter).

    • Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.

    • Query Results. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.

    While processing a document with queries, look out for INVALID_REQUEST_PARAMETERS output. This indicates that either the per page query limit has been exceeded or that the operation is trying to query a page in the document which doesn’t exist.

    Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.

    Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentAnalysis, and populate the NextToken request parameter with the token value that’s returned from the previous call to GetDocumentAnalysis.

    For more information, see Document Text Analysis.

    See

    AWSTextractGetDocumentAnalysisRequest

    See

    AWSTextractGetDocumentAnalysisResponse

    Declaration

    Objective-C

    - (void)
    getDocumentAnalysis:(nonnull AWSTextractGetDocumentAnalysisRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSTextractGetDocumentAnalysisResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func documentAnalysis(_ request: AWSTextractGetDocumentAnalysisRequest) async throws -> AWSTextractGetDocumentAnalysisResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetDocumentAnalysis 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInvalidJobId, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey.

  • Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

    You start asynchronous text detection by calling StartDocumentTextDetection, which returns a job identifier (JobId). When the text detection operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that’s registered in the initial call to StartDocumentTextDetection. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

    GetDocumentTextDetection returns an array of Block objects.

    Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

    Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentTextDetection, and populate the NextToken request parameter with the token value that’s returned from the previous call to GetDocumentTextDetection.

    For more information, see Document Text Detection.

    See

    AWSTextractGetDocumentTextDetectionRequest

    See

    AWSTextractGetDocumentTextDetectionResponse

    Declaration

    Objective-C

    - (id)getDocumentTextDetection:
    (nonnull AWSTextractGetDocumentTextDetectionRequest *)request;

    Swift

    func getDocumentTextDetection(_ request: AWSTextractGetDocumentTextDetectionRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractGetDocumentTextDetectionResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInvalidJobId, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey.

  • Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

    You start asynchronous text detection by calling StartDocumentTextDetection, which returns a job identifier (JobId). When the text detection operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that’s registered in the initial call to StartDocumentTextDetection. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

    GetDocumentTextDetection returns an array of Block objects.

    Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

    Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentTextDetection, and populate the NextToken request parameter with the token value that’s returned from the previous call to GetDocumentTextDetection.

    For more information, see Document Text Detection.

    See

    AWSTextractGetDocumentTextDetectionRequest

    See

    AWSTextractGetDocumentTextDetectionResponse

    Declaration

    Objective-C

    - (void)getDocumentTextDetection:
            (nonnull AWSTextractGetDocumentTextDetectionRequest *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSTextractGetDocumentTextDetectionResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func documentTextDetection(_ request: AWSTextractGetDocumentTextDetectionRequest) async throws -> AWSTextractGetDocumentTextDetectionResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetDocumentTextDetection 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInvalidJobId, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey.

  • Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts.

    You start asynchronous invoice/receipt analysis by calling StartExpenseAnalysis, which returns a job identifier (JobId). Upon completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to StartExpenseAnalysis. To get the results of the invoice/receipt analysis operation, first ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) from the initial call to StartExpenseAnalysis.

    Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetExpenseAnalysis, and populate the NextToken request parameter with the token value that’s returned from the previous call to GetExpenseAnalysis.

    For more information, see Analyzing Invoices and Receipts.

    See

    AWSTextractGetExpenseAnalysisRequest

    See

    AWSTextractGetExpenseAnalysisResponse

    Declaration

    Objective-C

    - (id)getExpenseAnalysis:
    (nonnull AWSTextractGetExpenseAnalysisRequest *)request;

    Swift

    func getExpenseAnalysis(_ request: AWSTextractGetExpenseAnalysisRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractGetExpenseAnalysisResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInvalidJobId, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey.

  • Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts.

    You start asynchronous invoice/receipt analysis by calling StartExpenseAnalysis, which returns a job identifier (JobId). Upon completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to StartExpenseAnalysis. To get the results of the invoice/receipt analysis operation, first ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) from the initial call to StartExpenseAnalysis.

    Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetExpenseAnalysis, and populate the NextToken request parameter with the token value that’s returned from the previous call to GetExpenseAnalysis.

    For more information, see Analyzing Invoices and Receipts.

    See

    AWSTextractGetExpenseAnalysisRequest

    See

    AWSTextractGetExpenseAnalysisResponse

    Declaration

    Objective-C

    - (void)
    getExpenseAnalysis:(nonnull AWSTextractGetExpenseAnalysisRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSTextractGetExpenseAnalysisResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func expenseAnalysis(_ request: AWSTextractGetExpenseAnalysisRequest) async throws -> AWSTextractGetExpenseAnalysisResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetExpenseAnalysis 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInvalidJobId, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey.

  • Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.

    You start asynchronous text analysis by calling StartLendingAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that’s registered in the initial call to StartLendingAnalysis.

    To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysis, and pass the job identifier (JobId) from the initial call to StartLendingAnalysis.

    See

    AWSTextractGetLendingAnalysisRequest

    See

    AWSTextractGetLendingAnalysisResponse

    Declaration

    Objective-C

    - (id)getLendingAnalysis:
    (nonnull AWSTextractGetLendingAnalysisRequest *)request;

    Swift

    func getLendingAnalysis(_ request: AWSTextractGetLendingAnalysisRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractGetLendingAnalysisResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInvalidJobId, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey.

  • Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.

    You start asynchronous text analysis by calling StartLendingAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that’s registered in the initial call to StartLendingAnalysis.

    To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysis, and pass the job identifier (JobId) from the initial call to StartLendingAnalysis.

    See

    AWSTextractGetLendingAnalysisRequest

    See

    AWSTextractGetLendingAnalysisResponse

    Declaration

    Objective-C

    - (void)
    getLendingAnalysis:(nonnull AWSTextractGetLendingAnalysisRequest *)request
     completionHandler:
         (void (^_Nullable)(AWSTextractGetLendingAnalysisResponse *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func lendingAnalysis(_ request: AWSTextractGetLendingAnalysisRequest) async throws -> AWSTextractGetLendingAnalysisResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetLendingAnalysis 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInvalidJobId, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey.

  • Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with respect to the type of grouped document.

    You start asynchronous text analysis by calling StartLendingAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that’s registered in the initial call to StartLendingAnalysis.

    To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysisSummary, and pass the job identifier (JobId) from the initial call to StartLendingAnalysis.

    See

    AWSTextractGetLendingAnalysisSummaryRequest

    See

    AWSTextractGetLendingAnalysisSummaryResponse

    Declaration

    Objective-C

    - (id)getLendingAnalysisSummary:
    (nonnull AWSTextractGetLendingAnalysisSummaryRequest *)request;

    Swift

    func getLendingAnalysisSummary(_ request: AWSTextractGetLendingAnalysisSummaryRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractGetLendingAnalysisSummaryResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInvalidJobId, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey.

  • Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with respect to the type of grouped document.

    You start asynchronous text analysis by calling StartLendingAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that’s registered in the initial call to StartLendingAnalysis.

    To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysisSummary, and pass the job identifier (JobId) from the initial call to StartLendingAnalysis.

    See

    AWSTextractGetLendingAnalysisSummaryRequest

    See

    AWSTextractGetLendingAnalysisSummaryResponse

    Declaration

    Objective-C

    - (void)getLendingAnalysisSummary:
            (nonnull AWSTextractGetLendingAnalysisSummaryRequest *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSTextractGetLendingAnalysisSummaryResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func lendingAnalysisSummary(_ request: AWSTextractGetLendingAnalysisSummaryRequest) async throws -> AWSTextractGetLendingAnalysisSummaryResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetLendingAnalysisSummary 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInvalidJobId, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey.

  • List all version of an adapter that meet the specified filtration criteria.

    See

    AWSTextractListAdapterVersionsRequest

    See

    AWSTextractListAdapterVersionsResponse

    Declaration

    Objective-C

    - (id)listAdapterVersions:
    (nonnull AWSTextractListAdapterVersionsRequest *)request;

    Swift

    func listAdapterVersions(_ request: AWSTextractListAdapterVersionsRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractListAdapterVersionsResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation, AWSTextractErrorResourceNotFound.

  • List all version of an adapter that meet the specified filtration criteria.

    See

    AWSTextractListAdapterVersionsRequest

    See

    AWSTextractListAdapterVersionsResponse

    Declaration

    Objective-C

    - (void)
    listAdapterVersions:(nonnull AWSTextractListAdapterVersionsRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSTextractListAdapterVersionsResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func listAdapterVersions(_ request: AWSTextractListAdapterVersionsRequest) async throws -> AWSTextractListAdapterVersionsResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListAdapterVersions 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation, AWSTextractErrorResourceNotFound.

  • Lists all adapters that match the specified filtration criteria.

    See

    AWSTextractListAdaptersRequest

    See

    AWSTextractListAdaptersResponse

    Declaration

    Objective-C

    - (id)listAdapters:(nonnull AWSTextractListAdaptersRequest *)request;

    Swift

    func listAdapters(_ request: AWSTextractListAdaptersRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractListAdaptersResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation.

  • Lists all adapters that match the specified filtration criteria.

    See

    AWSTextractListAdaptersRequest

    See

    AWSTextractListAdaptersResponse

    Declaration

    Objective-C

    - (void)listAdapters:(nonnull AWSTextractListAdaptersRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSTextractListAdaptersResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func listAdapters(_ request: AWSTextractListAdaptersRequest) async throws -> AWSTextractListAdaptersResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListAdapters 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation.

  • Lists all tags for an Amazon Textract resource.

    See

    AWSTextractListTagsForResourceRequest

    See

    AWSTextractListTagsForResourceResponse

    Declaration

    Objective-C

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

    Swift

    func listTags(forResource request: AWSTextractListTagsForResourceRequest) -> 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 AWSTextractListTagsForResourceResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorResourceNotFound, AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation.

  • Lists all tags for an Amazon Textract resource.

    See

    AWSTextractListTagsForResourceRequest

    See

    AWSTextractListTagsForResourceResponse

    Declaration

    Objective-C

    - (void)
    listTagsForResource:(nonnull AWSTextractListTagsForResourceRequest *)request
      completionHandler:
          (void (^_Nullable)(AWSTextractListTagsForResourceResponse *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func listTags(forResource request: AWSTextractListTagsForResourceRequest) async throws -> AWSTextractListTagsForResourceResponse

    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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorResourceNotFound, AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation.

  • Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.

    StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

    StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

    For more information, see Document Text Analysis.

    See

    AWSTextractStartDocumentAnalysisRequest

    See

    AWSTextractStartDocumentAnalysisResponse

    Declaration

    Objective-C

    - (id)startDocumentAnalysis:
    (nonnull AWSTextractStartDocumentAnalysisRequest *)request;

    Swift

    func startDocumentAnalysis(_ request: AWSTextractStartDocumentAnalysisRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractStartDocumentAnalysisResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey, AWSTextractErrorUnsupportedDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorBadDocument, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorIdempotentParameterMismatch, AWSTextractErrorThrottling, AWSTextractErrorLimitExceeded.

  • Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.

    StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

    StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

    For more information, see Document Text Analysis.

    See

    AWSTextractStartDocumentAnalysisRequest

    See

    AWSTextractStartDocumentAnalysisResponse

    Declaration

    Objective-C

    - (void)startDocumentAnalysis:
            (nonnull AWSTextractStartDocumentAnalysisRequest *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSTextractStartDocumentAnalysisResponse *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func startDocumentAnalysis(_ request: AWSTextractStartDocumentAnalysisRequest) async throws -> AWSTextractStartDocumentAnalysisResponse

    Parameters

    request

    A container for the necessary parameters to execute the StartDocumentAnalysis 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey, AWSTextractErrorUnsupportedDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorBadDocument, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorIdempotentParameterMismatch, AWSTextractErrorThrottling, AWSTextractErrorLimitExceeded.

  • Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

    StartDocumentTextDetection can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

    StartTextDetection returns a job identifier (JobId) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

    For more information, see Document Text Detection.

    See

    AWSTextractStartDocumentTextDetectionRequest

    See

    AWSTextractStartDocumentTextDetectionResponse

    Declaration

    Objective-C

    - (id)startDocumentTextDetection:
    (nonnull AWSTextractStartDocumentTextDetectionRequest *)request;

    Swift

    func startDocumentTextDetection(_ request: AWSTextractStartDocumentTextDetectionRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractStartDocumentTextDetectionResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey, AWSTextractErrorUnsupportedDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorBadDocument, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorIdempotentParameterMismatch, AWSTextractErrorThrottling, AWSTextractErrorLimitExceeded.

  • Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

    StartDocumentTextDetection can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

    StartTextDetection returns a job identifier (JobId) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

    For more information, see Document Text Detection.

    See

    AWSTextractStartDocumentTextDetectionRequest

    See

    AWSTextractStartDocumentTextDetectionResponse

    Declaration

    Objective-C

    - (void)
    startDocumentTextDetection:
        (nonnull AWSTextractStartDocumentTextDetectionRequest *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSTextractStartDocumentTextDetectionResponse *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func startDocumentTextDetection(_ request: AWSTextractStartDocumentTextDetectionRequest) async throws -> AWSTextractStartDocumentTextDetectionResponse

    Parameters

    request

    A container for the necessary parameters to execute the StartDocumentTextDetection 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey, AWSTextractErrorUnsupportedDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorBadDocument, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorIdempotentParameterMismatch, AWSTextractErrorThrottling, AWSTextractErrorLimitExceeded.

  • Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.

    StartExpenseAnalysis can analyze text in documents that are in JPEG, PNG, and PDF format. The documents must be stored in an Amazon S3 bucket. Use the DocumentLocation parameter to specify the name of your S3 bucket and the name of the document in that bucket.

    StartExpenseAnalysis returns a job identifier (JobId) that you will provide to GetExpenseAnalysis to retrieve the results of the operation. When the analysis of the input invoices/receipts is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you provide to the NotificationChannel. To obtain the results of the invoice and receipt analysis operation, ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) that was returned by your call to StartExpenseAnalysis.

    For more information, see Analyzing Invoices and Receipts.

    See

    AWSTextractStartExpenseAnalysisRequest

    See

    AWSTextractStartExpenseAnalysisResponse

    Declaration

    Objective-C

    - (id)startExpenseAnalysis:
    (nonnull AWSTextractStartExpenseAnalysisRequest *)request;

    Swift

    func startExpenseAnalysis(_ request: AWSTextractStartExpenseAnalysisRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractStartExpenseAnalysisResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey, AWSTextractErrorUnsupportedDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorBadDocument, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorIdempotentParameterMismatch, AWSTextractErrorThrottling, AWSTextractErrorLimitExceeded.

  • Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.

    StartExpenseAnalysis can analyze text in documents that are in JPEG, PNG, and PDF format. The documents must be stored in an Amazon S3 bucket. Use the DocumentLocation parameter to specify the name of your S3 bucket and the name of the document in that bucket.

    StartExpenseAnalysis returns a job identifier (JobId) that you will provide to GetExpenseAnalysis to retrieve the results of the operation. When the analysis of the input invoices/receipts is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you provide to the NotificationChannel. To obtain the results of the invoice and receipt analysis operation, ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) that was returned by your call to StartExpenseAnalysis.

    For more information, see Analyzing Invoices and Receipts.

    See

    AWSTextractStartExpenseAnalysisRequest

    See

    AWSTextractStartExpenseAnalysisResponse

    Declaration

    Objective-C

    - (void)startExpenseAnalysis:
            (nonnull AWSTextractStartExpenseAnalysisRequest *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSTextractStartExpenseAnalysisResponse *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func startExpenseAnalysis(_ request: AWSTextractStartExpenseAnalysisRequest) async throws -> AWSTextractStartExpenseAnalysisResponse

    Parameters

    request

    A container for the necessary parameters to execute the StartExpenseAnalysis 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey, AWSTextractErrorUnsupportedDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorBadDocument, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorIdempotentParameterMismatch, AWSTextractErrorThrottling, AWSTextractErrorLimitExceeded.

  • Starts the classification and analysis of an input document. StartLendingAnalysis initiates the classification and analysis of a packet of lending documents. StartLendingAnalysis operates on a document file located in an Amazon S3 bucket.

    StartLendingAnalysis can analyze text in documents that are in one of the following formats: JPEG, PNG, TIFF, PDF. Use DocumentLocation to specify the bucket name and the file name of the document.

    StartLendingAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When the text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If the status is SUCCEEDED you can call either GetLendingAnalysis or GetLendingAnalysisSummary and provide the JobId to obtain the results of the analysis.

    If using OutputConfig to specify an Amazon S3 bucket, the output will be contained within the specified prefix in a directory labeled with the job-id. In the directory there are 3 sub-directories:

    • detailedResponse (contains the GetLendingAnalysis response)

    • summaryResponse (for the GetLendingAnalysisSummary response)

    • splitDocuments (documents split across logical boundaries)

    See

    AWSTextractStartLendingAnalysisRequest

    See

    AWSTextractStartLendingAnalysisResponse

    Declaration

    Objective-C

    - (id)startLendingAnalysis:
    (nonnull AWSTextractStartLendingAnalysisRequest *)request;

    Swift

    func startLendingAnalysis(_ request: AWSTextractStartLendingAnalysisRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractStartLendingAnalysisResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey, AWSTextractErrorUnsupportedDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorBadDocument, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorIdempotentParameterMismatch, AWSTextractErrorThrottling, AWSTextractErrorLimitExceeded.

  • Starts the classification and analysis of an input document. StartLendingAnalysis initiates the classification and analysis of a packet of lending documents. StartLendingAnalysis operates on a document file located in an Amazon S3 bucket.

    StartLendingAnalysis can analyze text in documents that are in one of the following formats: JPEG, PNG, TIFF, PDF. Use DocumentLocation to specify the bucket name and the file name of the document.

    StartLendingAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When the text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If the status is SUCCEEDED you can call either GetLendingAnalysis or GetLendingAnalysisSummary and provide the JobId to obtain the results of the analysis.

    If using OutputConfig to specify an Amazon S3 bucket, the output will be contained within the specified prefix in a directory labeled with the job-id. In the directory there are 3 sub-directories:

    • detailedResponse (contains the GetLendingAnalysis response)

    • summaryResponse (for the GetLendingAnalysisSummary response)

    • splitDocuments (documents split across logical boundaries)

    See

    AWSTextractStartLendingAnalysisRequest

    See

    AWSTextractStartLendingAnalysisResponse

    Declaration

    Objective-C

    - (void)startLendingAnalysis:
            (nonnull AWSTextractStartLendingAnalysisRequest *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSTextractStartLendingAnalysisResponse *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func startLendingAnalysis(_ request: AWSTextractStartLendingAnalysisRequest) async throws -> AWSTextractStartLendingAnalysisResponse

    Parameters

    request

    A container for the necessary parameters to execute the StartLendingAnalysis 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorInvalidKMSKey, AWSTextractErrorUnsupportedDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorBadDocument, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorIdempotentParameterMismatch, AWSTextractErrorThrottling, AWSTextractErrorLimitExceeded.

  • Adds one or more tags to the specified resource.

    See

    AWSTextractTagResourceRequest

    See

    AWSTextractTagResourceResponse

    Declaration

    Objective-C

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

    Swift

    func tagResource(_ request: AWSTextractTagResourceRequest) -> 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 AWSTextractTagResourceResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorResourceNotFound, AWSTextractErrorInvalidParameter, AWSTextractErrorServiceQuotaExceeded, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation.

  • Adds one or more tags to the specified resource.

    See

    AWSTextractTagResourceRequest

    See

    AWSTextractTagResourceResponse

    Declaration

    Objective-C

    - (void)tagResource:(nonnull AWSTextractTagResourceRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSTextractTagResourceResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func tagResource(_ request: AWSTextractTagResourceRequest) async throws -> AWSTextractTagResourceResponse

    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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorResourceNotFound, AWSTextractErrorInvalidParameter, AWSTextractErrorServiceQuotaExceeded, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation.

  • Removes any tags with the specified keys from the specified resource.

    See

    AWSTextractUntagResourceRequest

    See

    AWSTextractUntagResourceResponse

    Declaration

    Objective-C

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

    Swift

    func untagResource(_ request: AWSTextractUntagResourceRequest) -> 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 AWSTextractUntagResourceResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorResourceNotFound, AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation.

  • Removes any tags with the specified keys from the specified resource.

    See

    AWSTextractUntagResourceRequest

    See

    AWSTextractUntagResourceResponse

    Declaration

    Objective-C

    - (void)untagResource:(nonnull AWSTextractUntagResourceRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSTextractUntagResourceResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func untagResource(_ request: AWSTextractUntagResourceRequest) async throws -> AWSTextractUntagResourceResponse

    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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorResourceNotFound, AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation.

  • Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument.

    See

    AWSTextractUpdateAdapterRequest

    See

    AWSTextractUpdateAdapterResponse

    Declaration

    Objective-C

    - (id)updateAdapter:(nonnull AWSTextractUpdateAdapterRequest *)request;

    Swift

    func updateAdapter(_ request: AWSTextractUpdateAdapterRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSTextractUpdateAdapterResponse. On failed execution, task.error may contain an NSError with AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorConflict, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation, AWSTextractErrorResourceNotFound.

  • Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument.

    See

    AWSTextractUpdateAdapterRequest

    See

    AWSTextractUpdateAdapterResponse

    Declaration

    Objective-C

    - (void)updateAdapter:(nonnull AWSTextractUpdateAdapterRequest *)request
    completionHandler:
        (void (^_Nullable)(AWSTextractUpdateAdapterResponse *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func updateAdapter(_ request: AWSTextractUpdateAdapterRequest) async throws -> AWSTextractUpdateAdapterResponse

    Parameters

    request

    A container for the necessary parameters to execute the UpdateAdapter 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 AWSTextractErrorDomain domain and the following error code: AWSTextractErrorInvalidParameter, AWSTextractErrorAccessDenied, AWSTextractErrorConflict, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorInternalServer, AWSTextractErrorThrottling, AWSTextractErrorValidation, AWSTextractErrorResourceNotFound.