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

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 StartTargetedSentimentDetectionJobRequest 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
    document_reader_config: {
      document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
      document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
      feature_types: ["TABLES"], # accepts TABLES, FORMS
    },
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
    kms_key_id: "KmsKeyId",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
  client_request_token: "ClientRequestTokenString",
  volume_kms_key_id: "KmsKeyId",
  vpc_config: {
    security_group_ids: ["SecurityGroupId"], # required
    subnets: ["SubnetId"], # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

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) 


6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6802

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 AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

Returns:

  • (String) 


6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6802

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.

Returns:



6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6802

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) 


6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6802

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 valid language.

Returns:

  • (String) 


6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6802

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:



6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6802

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 be associated 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:



6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6802

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) 


6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6802

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:



6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6802

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