StartDocumentAnalysisRequest

public struct StartDocumentAnalysisRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis 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

    Swift

    public let clientRequestToken: String?

  • The location of the document to be processed.

    Declaration

    Swift

    public let documentLocation: DocumentLocation

  • A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn’t related to the value of FeatureTypes).

    Declaration

    Swift

    public let featureTypes: [FeatureType]

  • An identifier that you specify that’s 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

    Swift

    public let jobTag: String?

  • The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

    Declaration

    Swift

    public let notificationChannel: NotificationChannel?

  • Undocumented

    Declaration

    Swift

    public init(clientRequestToken: String? = nil, documentLocation: DocumentLocation, featureTypes: [FeatureType], jobTag: String? = nil, notificationChannel: NotificationChannel? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws