| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Comprehend.StartEntitiesDetectionJob
Description
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.
Synopsis
- data StartEntitiesDetectionJob = StartEntitiesDetectionJob' {}
- newStartEntitiesDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartEntitiesDetectionJob
- startEntitiesDetectionJob_entityRecognizerArn :: Lens' StartEntitiesDetectionJob (Maybe Text)
- startEntitiesDetectionJob_jobName :: Lens' StartEntitiesDetectionJob (Maybe Text)
- startEntitiesDetectionJob_vpcConfig :: Lens' StartEntitiesDetectionJob (Maybe VpcConfig)
- startEntitiesDetectionJob_volumeKmsKeyId :: Lens' StartEntitiesDetectionJob (Maybe Text)
- startEntitiesDetectionJob_clientRequestToken :: Lens' StartEntitiesDetectionJob (Maybe Text)
- startEntitiesDetectionJob_tags :: Lens' StartEntitiesDetectionJob (Maybe [Tag])
- startEntitiesDetectionJob_inputDataConfig :: Lens' StartEntitiesDetectionJob InputDataConfig
- startEntitiesDetectionJob_outputDataConfig :: Lens' StartEntitiesDetectionJob OutputDataConfig
- startEntitiesDetectionJob_dataAccessRoleArn :: Lens' StartEntitiesDetectionJob Text
- startEntitiesDetectionJob_languageCode :: Lens' StartEntitiesDetectionJob LanguageCode
- data StartEntitiesDetectionJobResponse = StartEntitiesDetectionJobResponse' {}
- newStartEntitiesDetectionJobResponse :: Int -> StartEntitiesDetectionJobResponse
- startEntitiesDetectionJobResponse_jobId :: Lens' StartEntitiesDetectionJobResponse (Maybe Text)
- startEntitiesDetectionJobResponse_jobArn :: Lens' StartEntitiesDetectionJobResponse (Maybe Text)
- startEntitiesDetectionJobResponse_jobStatus :: Lens' StartEntitiesDetectionJobResponse (Maybe JobStatus)
- startEntitiesDetectionJobResponse_httpStatus :: Lens' StartEntitiesDetectionJobResponse Int
Creating a Request
data StartEntitiesDetectionJob Source #
See: newStartEntitiesDetectionJob smart constructor.
Constructors
| StartEntitiesDetectionJob' | |
Fields
| |
Instances
newStartEntitiesDetectionJob Source #
Arguments
| :: InputDataConfig | |
| -> OutputDataConfig | |
| -> Text | |
| -> LanguageCode | |
| -> StartEntitiesDetectionJob |
Create a value of StartEntitiesDetectionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entityRecognizerArn:StartEntitiesDetectionJob', startEntitiesDetectionJob_entityRecognizerArn - 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.
$sel:jobName:StartEntitiesDetectionJob', startEntitiesDetectionJob_jobName - The identifier of the job.
$sel:vpcConfig:StartEntitiesDetectionJob', startEntitiesDetectionJob_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.
$sel:volumeKmsKeyId:StartEntitiesDetectionJob', startEntitiesDetectionJob_volumeKmsKeyId - 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"
$sel:clientRequestToken:StartEntitiesDetectionJob', startEntitiesDetectionJob_clientRequestToken - A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
$sel:tags:StartEntitiesDetectionJob', startEntitiesDetectionJob_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.
$sel:inputDataConfig:StartEntitiesDetectionJob', startEntitiesDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.
$sel:outputDataConfig:StartEntitiesDetectionJob', startEntitiesDetectionJob_outputDataConfig - Specifies where to send the output files.
$sel:dataAccessRoleArn:StartEntitiesDetectionJob', startEntitiesDetectionJob_dataAccessRoleArn - 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.
$sel:languageCode:StartEntitiesDetectionJob', startEntitiesDetectionJob_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.
Request Lenses
startEntitiesDetectionJob_entityRecognizerArn :: Lens' StartEntitiesDetectionJob (Maybe Text) Source #
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.
startEntitiesDetectionJob_jobName :: Lens' StartEntitiesDetectionJob (Maybe Text) Source #
The identifier of the job.
startEntitiesDetectionJob_vpcConfig :: Lens' StartEntitiesDetectionJob (Maybe VpcConfig) Source #
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.
startEntitiesDetectionJob_volumeKmsKeyId :: Lens' StartEntitiesDetectionJob (Maybe Text) Source #
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"
startEntitiesDetectionJob_clientRequestToken :: Lens' StartEntitiesDetectionJob (Maybe Text) Source #
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
startEntitiesDetectionJob_tags :: Lens' StartEntitiesDetectionJob (Maybe [Tag]) Source #
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.
startEntitiesDetectionJob_inputDataConfig :: Lens' StartEntitiesDetectionJob InputDataConfig Source #
Specifies the format and location of the input data for the job.
startEntitiesDetectionJob_outputDataConfig :: Lens' StartEntitiesDetectionJob OutputDataConfig Source #
Specifies where to send the output files.
startEntitiesDetectionJob_dataAccessRoleArn :: Lens' StartEntitiesDetectionJob Text Source #
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.
startEntitiesDetectionJob_languageCode :: Lens' StartEntitiesDetectionJob LanguageCode Source #
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.
Destructuring the Response
data StartEntitiesDetectionJobResponse Source #
See: newStartEntitiesDetectionJobResponse smart constructor.
Constructors
| StartEntitiesDetectionJobResponse' | |
Fields
| |
Instances
newStartEntitiesDetectionJobResponse Source #
Arguments
| :: Int | |
| -> StartEntitiesDetectionJobResponse |
Create a value of StartEntitiesDetectionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartEntitiesDetectionJobResponse', startEntitiesDetectionJobResponse_jobId - The identifier generated for the job. To get the status of job, use this
identifier with the operation.
$sel:jobArn:StartEntitiesDetectionJobResponse', startEntitiesDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the entities detection job. It is a
unique, fully qualified identifier for the job. It includes the AWS
account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
$sel:jobStatus:StartEntitiesDetectionJobResponse', startEntitiesDetectionJobResponse_jobStatus - The status of the job.
- SUBMITTED - The job has been received and is queued for processing.
- IN_PROGRESS - Amazon Comprehend is processing the job.
- COMPLETED - The job was successfully completed and the output is available.
- FAILED - The job did not complete. To get details, use the operation.
- STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
- STOPPED - The job was successfully stopped without completing.
$sel:httpStatus:StartEntitiesDetectionJobResponse', startEntitiesDetectionJobResponse_httpStatus - The response's http status code.
Response Lenses
startEntitiesDetectionJobResponse_jobId :: Lens' StartEntitiesDetectionJobResponse (Maybe Text) Source #
The identifier generated for the job. To get the status of job, use this identifier with the operation.
startEntitiesDetectionJobResponse_jobArn :: Lens' StartEntitiesDetectionJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
startEntitiesDetectionJobResponse_jobStatus :: Lens' StartEntitiesDetectionJobResponse (Maybe JobStatus) Source #
The status of the job.
- SUBMITTED - The job has been received and is queued for processing.
- IN_PROGRESS - Amazon Comprehend is processing the job.
- COMPLETED - The job was successfully completed and the output is available.
- FAILED - The job did not complete. To get details, use the operation.
- STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
- STOPPED - The job was successfully stopped without completing.
startEntitiesDetectionJobResponse_httpStatus :: Lens' StartEntitiesDetectionJobResponse Int Source #
The response's http status code.