You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Comprehend::Types::StartEntitiesDetectionJobRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Comprehend::Types::StartEntitiesDetectionJobRequest
- Defined in:
- (unknown)
Overview
When passing StartEntitiesDetectionJobRequest as input to an Aws::Client method, you can use a vanilla 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
kms_key_id: "KmsKeyId",
},
data_access_role_arn: "IamRoleArn", # required
job_name: "JobName",
entity_recognizer_arn: "EntityRecognizerArn",
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
},
}
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
A unique identifier for the request.
-
#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.
-
#entity_recognizer_arn ⇒ String
The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the
StartEntitiesDetectionJob
. -
#input_data_config ⇒ Types::InputDataConfig
Specifies the format and location of the input data for the job.
-
#job_name ⇒ String
The identifier of the job.
-
#language_code ⇒ String
The language of the input documents.
-
#output_data_config ⇒ Types::OutputDataConfig
Specifies where to send the output files.
-
#volume_kms_key_id ⇒ String
ID for the AWS 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.
-
#vpc_config ⇒ Types::VpcConfig
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job.
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.
#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 https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
#entity_recognizer_arn ⇒ String
The Amazon Resource Name (ARN) that identifies the specific entity
recognizer to be used by the StartEntitiesDetectionJob
. This ARN is
optional and is only used for a custom entity recognition job.
#input_data_config ⇒ Types::InputDataConfig
Specifies the format and location of the input data for the job.
#job_name ⇒ String
The identifier of the job.
#language_code ⇒ String
The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
Possible values:
- en
- es
- fr
- de
- it
- pt
- ar
- hi
- ja
- ko
- zh
- zh-TW
#output_data_config ⇒ Types::OutputDataConfig
Specifies where to send the output files.
#volume_kms_key_id ⇒ String
ID for the AWS 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"
#vpc_config ⇒ Types::VpcConfig
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.