Skip to content

/AWS1/CL_TEXOUTPUTCONFIG

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.

CONSTRUCTOR

IMPORTING

Required arguments:

IV_S3BUCKET TYPE /AWS1/TEXS3BUCKET /AWS1/TEXS3BUCKET

The name of the bucket your output will go to.

Optional arguments:

IV_S3PREFIX TYPE /AWS1/TEXS3OBJECTNAME /AWS1/TEXS3OBJECTNAME

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

Queryable Attributes

S3Bucket

The name of the bucket your output will go to.

Accessible with the following methods

Method Description
GET_S3BUCKET() Getter for S3BUCKET, with configurable default
ASK_S3BUCKET() Getter for S3BUCKET w/ exceptions if field has no value
HAS_S3BUCKET() Determine if S3BUCKET has a value

S3Prefix

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

Accessible with the following methods

Method Description
GET_S3PREFIX() Getter for S3PREFIX, with configurable default
ASK_S3PREFIX() Getter for S3PREFIX w/ exceptions if field has no value
HAS_S3PREFIX() Determine if S3PREFIX has a value