Interface CfnDocumentClassifier.IDocumentClassifierOutputDataConfigProperty

Provide the location for output data from a custom classifier job.

Namespace: Amazon.CDK.AWS.Comprehend

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnDocumentClassifier.IDocumentClassifierOutputDataConfigProperty

Syntax (vb)

Public Interface CfnDocumentClassifier.IDocumentClassifierOutputDataConfigProperty

Remarks

This field is mandatory if you are training a native document model.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifieroutputdataconfig.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Comprehend;

             var documentClassifierOutputDataConfigProperty = new DocumentClassifierOutputDataConfigProperty {
                 KmsKeyId = "kmsKeyId",
                 S3Uri = "s3Uri"
             };

Synopsis

Properties

KmsKeyId	ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.
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 and other output files.

Properties

KmsKeyId

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

string? KmsKeyId { get; }

Property Value

string

Remarks

The KmsKeyId can be one of the following formats:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifieroutputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifieroutputdataconfig-kmskeyid

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 and other output files.

string? S3Uri { get; }

Property Value

string

Remarks

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.