Class: Aws::Comprehend::Types::StartTargetedSentimentDetectionJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-comprehend/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 don't 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) 


7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7673

class StartTargetedSentimentDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :language_code,
  :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.

Returns:

  • (String) 


7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7673

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

#input_data_config ⇒ Types::InputDataConfig

The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.

Returns:



7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7673

class StartTargetedSentimentDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :language_code,
  :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) 


7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7673

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

#language_code ⇒ String

The language of the input documents. Currently, English is the only supported language.

Returns:

  • (String) 


7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7673

class StartTargetedSentimentDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :language_code,
  :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.

Returns:



7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7673

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

#tags ⇒ Array<Types::Tag>

Tags to associate with the targeted sentiment 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:



7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7673

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

#volume_kms_key_id ⇒ String

ID for the 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) 


7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7673

class StartTargetedSentimentDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :language_code,
  :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 the job. For more information, see Amazon VPC.

Returns:



7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7673

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