start_document_text_detection

Textract.Client.start_document_text_detection(**kwargs)

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 also: AWS API Documentation

Request Syntax

response = client.start_document_text_detection(
    DocumentLocation={
        'S3Object': {
            'Bucket': 'string',
            'Name': 'string',
            'Version': 'string'
        }
    },
    ClientRequestToken='string',
    JobTag='string',
    NotificationChannel={
        'SNSTopicArn': 'string',
        'RoleArn': 'string'
    },
    OutputConfig={
        'S3Bucket': 'string',
        'S3Prefix': 'string'
    },
    KMSKeyId='string'
)

Parameters

• DocumentLocation (dict) --

  [REQUIRED]

  The location of the document to be processed.

  • S3Object (dict) --

    The Amazon S3 bucket that contains the input document.

    • Bucket (string) --

      The name of the S3 bucket. Note that the # character is not valid in the file name.

    • Name (string) --

      The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.

    • Version (string) --

      If the bucket has versioning enabled, you can specify the object version.

• ClientRequestToken (string) -- The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection 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.
• JobTag (string) -- 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).
• NotificationChannel (dict) --

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

  • SNSTopicArn (string) -- [REQUIRED]

    The Amazon SNS topic that Amazon Textract posts the completion status to.

  • RoleArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

• OutputConfig (dict) --

  Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.

  • S3Bucket (string) -- [REQUIRED]

    The name of the bucket your output will go to.

  • S3Prefix (string) --

    The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".

• KMSKeyId (string) -- 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.

Return type

dict

Returns

Response Syntax

{
    'JobId': 'string'
}

Response Structure

• (dict) --

  • JobId (string) --

    The identifier of the text detection job for the document. Use JobId to identify the job in a subsequent call to GetDocumentTextDetection . A JobId value is only valid for 7 days.

Exceptions

• Textract.Client.exceptions.InvalidParameterException
• Textract.Client.exceptions.InvalidS3ObjectException
• Textract.Client.exceptions.InvalidKMSKeyException
• Textract.Client.exceptions.UnsupportedDocumentException
• Textract.Client.exceptions.DocumentTooLargeException
• Textract.Client.exceptions.BadDocumentException
• Textract.Client.exceptions.AccessDeniedException
• Textract.Client.exceptions.ProvisionedThroughputExceededException
• Textract.Client.exceptions.InternalServerError
• Textract.Client.exceptions.IdempotentParameterMismatchException
• Textract.Client.exceptions.ThrottlingException
• Textract.Client.exceptions.LimitExceededException