Class: Aws::Comprehend::Types::DocumentClassifierOutputDataConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

Note:

When making an API call, you may pass DocumentClassifierOutputDataConfig data as a hash:

{
  s3_uri: "S3Uri",
  kms_key_id: "KmsKeyId",
}

Provides output results configuration parameters for custom classifier jobs.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#kms_key_idString

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"

Returns:

  • (String)


1893
1894
1895
1896
1897
1898
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1893

class DocumentClassifierOutputDataConfig < Struct.new(
  :s3_uri,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#s3_uriString

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.

Returns:

  • (String)


1893
1894
1895
1896
1897
1898
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1893

class DocumentClassifierOutputDataConfig < Struct.new(
  :s3_uri,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end