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

Class: Aws::Comprehend::Types::StartTopicsDetectionJobRequest

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

{
  input_data_config: { # required
    s3_uri: "S3Uri", # required
    input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  number_of_topics: 1,
  client_request_token: "ClientRequestTokenString",
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


836
837
838
839
840
841
842
843
844
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 836

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token)
  include Aws::Structure
end

#data_access_role_arnString

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Returns:

  • (String)


836
837
838
839
840
841
842
843
844
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 836

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token)
  include Aws::Structure
end

#input_data_configTypes::InputDataConfig

Specifies the format and location of the input data for the job.



836
837
838
839
840
841
842
843
844
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 836

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token)
  include Aws::Structure
end

#job_nameString

The identifier of the job.

Returns:

  • (String)


836
837
838
839
840
841
842
843
844
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 836

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token)
  include Aws::Structure
end

#number_of_topicsInteger

The number of topics to detect.

Returns:

  • (Integer)


836
837
838
839
840
841
842
843
844
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 836

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token)
  include Aws::Structure
end

#output_data_configTypes::OutputDataConfig

Specifies where to send the output files.



836
837
838
839
840
841
842
843
844
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 836

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token)
  include Aws::Structure
end