Class: Aws::Comprehend::Types::OutputDataConfig
- Inherits:
-
Struct
- Object
- Struct
- Aws::Comprehend::Types::OutputDataConfig
- Defined in:
- gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb
Overview
When making an API call, you may pass OutputDataConfig data as a hash:
{
s3_uri: "S3Uri", # required
kms_key_id: "KmsKeyId",
}
Provides configuration parameters for the output of inference jobs.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#kms_key_id ⇒ String
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.
-
#s3_uri ⇒ String
When you use the
OutputDataConfig
object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.
Instance Attribute Details
#kms_key_id ⇒ String
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"
5078 5079 5080 5081 5082 5083 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5078 class OutputDataConfig < Struct.new( :s3_uri, :kms_key_id) SENSITIVE = [] include Aws::Structure end |
#s3_uri ⇒ String
When you use the OutputDataConfig
object with asynchronous
operations, you specify the Amazon S3 location where you want to
write the output data. 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 the output file.
When the topic detection job is finished, the service creates an
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 ouput of the operation.
For a PII entity detection job, the output file is plain text, not a
compressed archive. The output file name is the same as the input
file, with .out
appended at the end.
5078 5079 5080 5081 5082 5083 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5078 class OutputDataConfig < Struct.new( :s3_uri, :kms_key_id) SENSITIVE = [] include Aws::Structure end |