Struct OutputConfig

#[non_exhaustive]
pub struct OutputConfig {
    pub s3_bucket: String,
    pub s3_prefix: Option<String>,
}

Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.

OutputConfig is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the KMSKeyID parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.

Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.

For more information on data privacy, see the Data Privacy FAQ.

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.

s3_bucket: String

The name of the bucket your output will go to.

s3_prefix: Option<String>

The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".

Implementations

impl OutputConfig

pub fn s3_bucket(&self) -> &str

The name of the bucket your output will go to.

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

The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".

impl OutputConfig

pub fn builder() -> OutputConfigBuilder

Creates a new builder-style object to manufacture OutputConfig.

Trait Implementations

impl Clone for OutputConfig

fn clone(&self) -> OutputConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputConfig

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

Formats the value using the given formatter.

impl PartialEq for OutputConfig

fn eq(&self, other: &OutputConfig) -> 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 OutputConfig