Struct S3Object

#[non_exhaustive]
pub struct S3Object {
    pub bucket: Option<String>,
    pub name: Option<String>,
    pub version: Option<String>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bucket: Option<String>

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

name: Option<String>

The file name of the input document. Image files may be in PDF, TIFF, JPEG, or PNG format.

version: Option<String>

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

Implementations

impl S3Object

pub fn bucket(&self) -> Option<&str>

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

pub fn name(&self) -> Option<&str>

The file name of the input document. Image files may be in PDF, TIFF, JPEG, or PNG format.

pub fn version(&self) -> Option<&str>

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

impl S3Object

pub fn builder() -> S3ObjectBuilder

Creates a new builder-style object to manufacture S3Object.

Trait Implementations

impl Clone for S3Object

fn clone(&self) -> S3Object

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for S3Object

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for S3Object

fn eq(&self, other: &S3Object) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for S3Object