Container for the parameters to the StartEntitiesDetectionJob operation. Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.
This API can be used for either standard entity detection or custom entity recognition.
In order to be used for custom entity recognition, the optional EntityRecognizerArn
must be used in order to provide access to the recognizer being used to detect the
custom entity.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Comprehend.AmazonComprehendRequest
Amazon.Comprehend.Model.StartEntitiesDetectionJobRequest
Namespace: Amazon.Comprehend.Model
Assembly: AWSSDK.Comprehend.dll
Version: 3.x.y.z
Syntax
public class StartEntitiesDetectionJobRequest : AmazonComprehendRequest IAmazonWebServiceRequest
The StartEntitiesDetectionJobRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
StartEntitiesDetectionJobRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ClientRequestToken | System.String |
Gets and sets the property ClientRequestToken. A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one. |
|
|
DataAccessRoleArn | System.String |
Gets and sets the property DataAccessRoleArn. 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. |
|
|
EntityRecognizerArn | System.String |
Gets and sets the property EntityRecognizerArn.
The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be
used by the |
|
|
FlywheelArn | System.String |
Gets and sets the property FlywheelArn. The Amazon Resource Number (ARN) of the flywheel associated with the model to use. |
|
|
InputDataConfig | Amazon.Comprehend.Model.InputDataConfig |
Gets and sets the property InputDataConfig. Specifies the format and location of the input data for the job. |
|
|
JobName | System.String |
Gets and sets the property JobName. The identifier of the job. |
|
|
LanguageCode | Amazon.Comprehend.LanguageCode |
Gets and sets the property LanguageCode. 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. |
|
|
OutputDataConfig | Amazon.Comprehend.Model.OutputDataConfig |
Gets and sets the property OutputDataConfig. Specifies where to send the output files. |
|
|
Tags | System.Collections.Generic.List<Amazon.Comprehend.Model.Tag> |
Gets and sets the property Tags. Tags to associate 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. |
|
|
VolumeKmsKeyId | System.String |
Gets and sets the property VolumeKmsKeyId. 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:
|
|
|
VpcConfig | Amazon.Comprehend.Model.VpcConfig |
Gets and sets the property 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. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5