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

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

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#flywheel_stats_s3_prefix ⇒ String

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

Returns:

  • (String) 


3124
3125
3126
3127
3128
3129
3130
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3124

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

#kms_key_id ⇒ String

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"

Returns:

  • (String) 


3124
3125
3126
3127
3128
3129
3130
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3124

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

#s3_uri ⇒ String

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.

Returns:

  • (String) 


3124
3125
3126
3127
3128
3129
3130
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3124

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