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.Comprehend.Types.OutputDataConfig

Description

Synopsis

data OutputDataConfig = OutputDataConfig' {
- kmsKeyId :: Maybe Text
- s3Uri :: Text
}
newOutputDataConfig :: Text -> OutputDataConfig
outputDataConfig_kmsKeyId :: Lens' OutputDataConfig (Maybe Text)
outputDataConfig_s3Uri :: Lens' OutputDataConfig Text

Documentation

data OutputDataConfig Source #

Provides configuration parameters for the output of topic detection jobs.

See: newOutputDataConfig smart constructor.

Constructors

OutputDataConfig'

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. The KmsKeyId can be one of the following formats:
- KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
- Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
- KMS Key Alias: "alias/ExampleAlias"
- ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
s3Uri :: Text
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.
When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

Instances

Instances details

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

newOutputDataConfig Source #

Arguments

:: Text	`$sel:s3Uri:OutputDataConfig'`
-> OutputDataConfig

Create a value of OutputDataConfig 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:OutputDataConfig', outputDataConfig_kmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:

KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
KMS Key Alias: "alias/ExampleAlias"
ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

$sel:s3Uri:OutputDataConfig', outputDataConfig_s3Uri - When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

outputDataConfig_kmsKeyId :: Lens' OutputDataConfig (Maybe Text) Source #

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:

KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
KMS Key Alias: "alias/ExampleAlias"
ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

outputDataConfig_s3Uri :: Lens' OutputDataConfig Text Source #

When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.