Amazonka.Comprehend.Types.PiiOutputDataConfig

Documentation

data PiiOutputDataConfig

Provides configuration parameters for the output of PII entity detection jobs.

See: newPiiOutputDataConfig smart constructor.

Constructors

PiiOutputDataConfig'

Fields

• kmsKeyId :: Maybe Text

  ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.

• s3Uri :: Text

  When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.

  For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

Instances

FromJSON PiiOutputDataConfig

Defined in Amazonka.Comprehend.Types.PiiOutputDataConfig

Methods

parseJSON :: Value -> Parser PiiOutputDataConfig

parseJSONList :: Value -> Parser [PiiOutputDataConfig]

Generic PiiOutputDataConfig

Defined in Amazonka.Comprehend.Types.PiiOutputDataConfig

Associated Types

type Rep PiiOutputDataConfig :: Type -> Type

Methods

from :: PiiOutputDataConfig -> Rep PiiOutputDataConfig x

to :: Rep PiiOutputDataConfig x -> PiiOutputDataConfig

Read PiiOutputDataConfig

Defined in Amazonka.Comprehend.Types.PiiOutputDataConfig

Methods

readsPrec :: Int -> ReadS PiiOutputDataConfig

readList :: ReadS [PiiOutputDataConfig]

readPrec :: ReadPrec PiiOutputDataConfig

readListPrec :: ReadPrec [PiiOutputDataConfig]

Show PiiOutputDataConfig

Defined in Amazonka.Comprehend.Types.PiiOutputDataConfig

Methods

showsPrec :: Int -> PiiOutputDataConfig -> ShowS

show :: PiiOutputDataConfig -> String

showList :: [PiiOutputDataConfig] -> ShowS

NFData PiiOutputDataConfig

Defined in Amazonka.Comprehend.Types.PiiOutputDataConfig

Methods

rnf :: PiiOutputDataConfig -> ()

Eq PiiOutputDataConfig

Defined in Amazonka.Comprehend.Types.PiiOutputDataConfig

Methods

(==) :: PiiOutputDataConfig -> PiiOutputDataConfig -> Bool

(/=) :: PiiOutputDataConfig -> PiiOutputDataConfig -> Bool

Hashable PiiOutputDataConfig

Defined in Amazonka.Comprehend.Types.PiiOutputDataConfig

Methods

hashWithSalt :: Int -> PiiOutputDataConfig -> Int

hash :: PiiOutputDataConfig -> Int

type Rep PiiOutputDataConfig

Defined in Amazonka.Comprehend.Types.PiiOutputDataConfig

type Rep PiiOutputDataConfig = D1 ('MetaData "PiiOutputDataConfig" "Amazonka.Comprehend.Types.PiiOutputDataConfig" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "PiiOutputDataConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newPiiOutputDataConfig

Arguments

:: Text

$sel:s3Uri:PiiOutputDataConfig'

-> PiiOutputDataConfig

Create a value of PiiOutputDataConfig 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:kmsKeyId:PiiOutputDataConfig', piiOutputDataConfig_kmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.

$sel:s3Uri:PiiOutputDataConfig', piiOutputDataConfig_s3Uri - When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.

For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

piiOutputDataConfig_kmsKeyId :: Lens' PiiOutputDataConfig (Maybe Text)

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.

piiOutputDataConfig_s3Uri :: Lens' PiiOutputDataConfig Text

When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.

For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.