AWS::Comprehend::DocumentClassifier DocumentClassifierOutputDataConfig

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "KmsKeyId" : String,
  "S3Uri" : String
}

YAML

  KmsKeyId: String
  S3Uri: String

Properties

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"

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: Replacement

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.

Required: No

Type: String

Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

Maximum: 1024

Update requires: Replacement