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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-textract/types.rb

Overview

Note:

When making an API call, you may pass S3Object data as a 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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

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

Returns:

  • (String) 


1496
1497
1498
1499
1500
1501
1502
 
# File 'lib/aws-sdk-textract/types.rb', line 1496

class S3Object < Struct.new(
  :bucket,
  :name,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String) 


1496
1497
1498
1499
1500
1501
1502
 
# File 'lib/aws-sdk-textract/types.rb', line 1496

class S3Object < Struct.new(
  :bucket,
  :name,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

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

Returns:

  • (String) 


1496
1497
1498
1499
1500
1501
1502
 
# File 'lib/aws-sdk-textract/types.rb', line 1496

class S3Object < Struct.new(
  :bucket,
  :name,
  :version)
  SENSITIVE = []
  include Aws::Structure
end