You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Textract::Types::S3Object

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing S3Object as input to an Aws::Client method, you can use a vanilla Hash:

{
  bucket: "S3Bucket",
  name: "S3ObjectName",
  version: "S3ObjectVersion",
}

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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

The name of the S3 bucket.

Returns:

  • (String) —

    The name of the S3 bucket.

#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 format files.

Returns:

  • (String) —

    The file name of the input document.

#version ⇒ String

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

Returns:

  • (String) —

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