You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Comprehend::Types::OutputDataConfig

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 OutputDataConfig data as a hash:

{
  s3_uri: "S3Uri", # required
}

Provides configuration parameters for the output of topic detection jobs.

Instance Attribute Summary collapse

Instance Attribute Details

#s3_uriString

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.

Returns:

  • (String)


1514
1515
1516
1517
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1514

class OutputDataConfig < Struct.new(
  :s3_uri)
  include Aws::Structure
end