Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Textract.Types.OutputConfig

Description

Synopsis

data OutputConfig = OutputConfig' {
- s3Prefix :: Maybe Text
- s3Bucket :: Text
}
newOutputConfig :: Text -> OutputConfig
outputConfig_s3Prefix :: Lens' OutputConfig (Maybe Text)
outputConfig_s3Bucket :: Lens' OutputConfig Text

Documentation

data OutputConfig Source #

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

See: newOutputConfig smart constructor.

Constructors

OutputConfig'
Fields s3Prefix :: Maybe Text The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output". s3Bucket :: Text The name of the bucket your output will go to.

Instances

Instances details

Eq OutputConfig Source #
Instance details Defined in Amazonka.Textract.Types.OutputConfig Methods (==) :: OutputConfig -> OutputConfig -> Bool # (/=) :: OutputConfig -> OutputConfig -> Bool #
Read OutputConfig Source #
Instance details Defined in Amazonka.Textract.Types.OutputConfig Methods readsPrec :: Int -> ReadS OutputConfig # readList :: ReadS [OutputConfig] # readPrec :: ReadPrec OutputConfig # readListPrec :: ReadPrec [OutputConfig] #
Show OutputConfig Source #
Instance details Defined in Amazonka.Textract.Types.OutputConfig Methods showsPrec :: Int -> OutputConfig -> ShowS # show :: OutputConfig -> String # showList :: [OutputConfig] -> ShowS #
Generic OutputConfig Source #
Instance details Defined in Amazonka.Textract.Types.OutputConfig Associated Types type Rep OutputConfig :: Type -> Type # Methods from :: OutputConfig -> Rep OutputConfig x # to :: Rep OutputConfig x -> OutputConfig #
NFData OutputConfig Source #
Instance details Defined in Amazonka.Textract.Types.OutputConfig Methods rnf :: OutputConfig -> () #
Hashable OutputConfig Source #
Instance details Defined in Amazonka.Textract.Types.OutputConfig Methods hashWithSalt :: Int -> OutputConfig -> Int # hash :: OutputConfig -> Int #
ToJSON OutputConfig Source #
Instance details Defined in Amazonka.Textract.Types.OutputConfig Methods toJSON :: OutputConfig -> Value # toEncoding :: OutputConfig -> Encoding # toJSONList :: [OutputConfig] -> Value # toEncodingList :: [OutputConfig] -> Encoding #
type Rep OutputConfig Source #
Instance details Defined in Amazonka.Textract.Types.OutputConfig type Rep OutputConfig = D1 ('MetaData "OutputConfig" "Amazonka.Textract.Types.OutputConfig" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "OutputConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3Prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newOutputConfig Source #

Arguments

:: Text	`$sel:s3Bucket:OutputConfig'`
-> OutputConfig

Create a value of OutputConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:s3Prefix:OutputConfig', outputConfig_s3Prefix - The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".

$sel:s3Bucket:OutputConfig', outputConfig_s3Bucket - The name of the bucket your output will go to.

outputConfig_s3Prefix :: Lens' OutputConfig (Maybe Text) Source #

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

outputConfig_s3Bucket :: Lens' OutputConfig Text Source #

The name of the bucket your output will go to.