DocumentClassifierOutputDataConfig Class | AWS SDK for .NET Version 4

Provide the location for output data from a custom classifier job. This field is mandatory if you are training a native document model.

In this article ▶

Inheritance Hierarchy

System.Object
Amazon.Comprehend.Model.DocumentClassifierOutputDataConfig

Namespace: Amazon.Comprehend.Model
Assembly: AWSSDK.Comprehend.dll
Version: 3.x.y.z

Syntax

public class DocumentClassifierOutputDataConfig

The DocumentClassifierOutputDataConfig type exposes the following members

Constructors

	Name	Description
	DocumentClassifierOutputDataConfig()

Properties

Name Type Description

Name	Type	Description
FlywheelStatsS3Prefix	System.String	Gets and sets the property FlywheelStatsS3Prefix. The Amazon S3 prefix for the data lake location of the flywheel statistics.
KmsKeyId	System.String	Gets and sets the property KmsKeyId. ID for the Amazon Web Services 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	System.String	Gets and sets the property 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. 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.

FlywheelStatsS3Prefix

System.String

Gets and sets the property FlywheelStatsS3Prefix.

The Amazon S3 prefix for the data lake location of the flywheel statistics.

KmsKeyId

System.String

Gets and sets the property KmsKeyId.

ID for the Amazon Web Services 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

System.String

Gets and sets the property 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. 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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer