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

Description

Documentation

data DocumentClassifierOutputDataConfig Source #

Provides output results configuration parameters for custom classifier jobs.

See: newDocumentClassifierOutputDataConfig smart constructor.

Constructors

DocumentClassifierOutputDataConfig'

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 :: Maybe Text
When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. 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 this output file.
When the custom classifier job is finished, the service creates the 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 confusion matrix.

Instances

Instances details

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

newDocumentClassifierOutputDataConfig :: DocumentClassifierOutputDataConfig Source #

Create a value of DocumentClassifierOutputDataConfig 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:DocumentClassifierOutputDataConfig', documentClassifierOutputDataConfig_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:DocumentClassifierOutputDataConfig', documentClassifierOutputDataConfig_s3Uri - When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. 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 this output file.

When the custom classifier job is finished, the service creates the 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 confusion matrix.

documentClassifierOutputDataConfig_kmsKeyId :: Lens' DocumentClassifierOutputDataConfig (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"

documentClassifierOutputDataConfig_s3Uri :: Lens' DocumentClassifierOutputDataConfig (Maybe Text) Source #

When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. 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 this output file.

When the custom classifier job is finished, the service creates the 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 confusion matrix.