class Aws::Comprehend::Types::StartEntitiesDetectionJobRequest
@note When making an API call, you may pass StartEntitiesDetectionJobRequest
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 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 }, tags: [ { key: "TagKey", # required value: "TagValue", }, ], }
@!attribute [rw] input_data_config
Specifies the format and location of the input data for the job. @return [Types::InputDataConfig]
@!attribute [rw] output_data_config
Specifies where to send the output files. @return [Types::OutputDataConfig]
@!attribute [rw] data_access_role_arn
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][1]. [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions @return [String]
@!attribute [rw] job_name
The identifier of the job. @return [String]
@!attribute [rw] entity_recognizer_arn
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. @return [String]
@!attribute [rw] language_code
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. @return [String]
@!attribute [rw] client_request_token
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. @return [String]
@!attribute [rw] volume_kms_key_id
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"` @return [String]
@!attribute [rw] vpc_config
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][1]. [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html @return [Types::VpcConfig]
@!attribute [rw] tags
Tags to be associated with the entities 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. @return [Array<Types::Tag>]
@see docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJobRequest AWS API Documentation
Constants
- SENSITIVE