AWSTextractStartLendingAnalysisRequest

Objective-C

@interface AWSTextractStartLendingAnalysisRequest

Swift

class AWSTextractStartLendingAnalysisRequest

  • The idempotent token that you use to identify the start request. If you use the same token with multiple StartLendingAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable clientRequestToken;

    Swift

    var clientRequestToken: String? { get set }

  • The Amazon S3 bucket that contains the document to be processed. It’s used by asynchronous operations.

    The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTextractDocumentLocation *_Nullable documentLocation;

    Swift

    var documentLocation: AWSTextractDocumentLocation? { get set }

  • An identifier that you specify to be included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable jobTag;

    Swift

    var jobTag: String? { get set }

  • The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side, using SSE-S3.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable KMSKeyId;

    Swift

    var kmsKeyId: String? { get set }

  • The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTextractNotificationChannel *_Nullable notificationChannel;

    Swift

    var notificationChannel: AWSTextractNotificationChannel? { get set }

  • Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.

    OutputConfig is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the KMSKeyID parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.

    Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.

    For more information on data privacy, see the Data Privacy FAQ.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTextractOutputConfig *_Nullable outputConfig;

    Swift

    var outputConfig: AWSTextractOutputConfig? { get set }