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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-textract/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

The name of the S3 bucket.

Returns:

  • (String)


1032
1033
1034
1035
1036
1037
1038
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1032

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

#nameString

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)


1032
1033
1034
1035
1036
1037
1038
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1032

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

#versionString

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

Returns:

  • (String)


1032
1033
1034
1035
1036
1037
1038
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1032

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