Interface S3Object

The S3 bucket name and file name that identifies the document.

The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations.

For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket and file. 

  </p>
interface S3Object {
    Bucket?: string;
    Name?: string;
    Version?: string;
}

Properties

Bucket? Name? Version?

Properties

Optional Bucket

Bucket?: string

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

Optional 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.

Optional Version

Version?: string

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

Settings

Member Visibility

Theme

On This Page