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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

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) 


7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
 
# File 'lib/aws-sdk-comprehend/types.rb', line 7799

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#data_access_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see [Role-based permissions].

[1]: docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions

Returns:

  • (String) 


7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
 
# File 'lib/aws-sdk-comprehend/types.rb', line 7799

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_config ⇒ Types::InputDataConfig

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

Returns:



7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
 
# File 'lib/aws-sdk-comprehend/types.rb', line 7799

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The identifier of the job.

Returns:

  • (String) 


7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
 
# File 'lib/aws-sdk-comprehend/types.rb', line 7799

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_topics ⇒ Integer

The number of topics to detect.

Returns:

  • (Integer) 


7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
 
# File 'lib/aws-sdk-comprehend/types.rb', line 7799

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#output_data_config ⇒ Types::OutputDataConfig

Specifies where to send the output files. The output is a compressed archive with two files, ‘topic-terms.csv` that lists the terms associated with each topic, and `doc-topics.csv` that lists the documents associated with each topic

Returns:



7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
 
# File 'lib/aws-sdk-comprehend/types.rb', line 7799

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Tags to associate with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department.

Returns:



7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
 
# File 'lib/aws-sdk-comprehend/types.rb', line 7799

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#volume_kms_key_id ⇒ String

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either 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”`

Returns:

  • (String) 


7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
 
# File 'lib/aws-sdk-comprehend/types.rb', line 7799

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ Types::VpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see [Amazon VPC].

[1]: docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html

Returns:



7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
 
# File 'lib/aws-sdk-comprehend/types.rb', line 7799

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end