| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job
Description
Starts an asynchronous medical entity detection job for a collection of
documents. Use the DescribeEntitiesDetectionV2Job operation to track
the status of a job.
Synopsis
- data StartEntitiesDetectionV2Job = StartEntitiesDetectionV2Job' {}
- newStartEntitiesDetectionV2Job :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartEntitiesDetectionV2Job
- startEntitiesDetectionV2Job_clientRequestToken :: Lens' StartEntitiesDetectionV2Job (Maybe Text)
- startEntitiesDetectionV2Job_jobName :: Lens' StartEntitiesDetectionV2Job (Maybe Text)
- startEntitiesDetectionV2Job_kmsKey :: Lens' StartEntitiesDetectionV2Job (Maybe Text)
- startEntitiesDetectionV2Job_inputDataConfig :: Lens' StartEntitiesDetectionV2Job InputDataConfig
- startEntitiesDetectionV2Job_outputDataConfig :: Lens' StartEntitiesDetectionV2Job OutputDataConfig
- startEntitiesDetectionV2Job_dataAccessRoleArn :: Lens' StartEntitiesDetectionV2Job Text
- startEntitiesDetectionV2Job_languageCode :: Lens' StartEntitiesDetectionV2Job LanguageCode
- data StartEntitiesDetectionV2JobResponse = StartEntitiesDetectionV2JobResponse' {
- jobId :: Maybe Text
- httpStatus :: Int
- newStartEntitiesDetectionV2JobResponse :: Int -> StartEntitiesDetectionV2JobResponse
- startEntitiesDetectionV2JobResponse_jobId :: Lens' StartEntitiesDetectionV2JobResponse (Maybe Text)
- startEntitiesDetectionV2JobResponse_httpStatus :: Lens' StartEntitiesDetectionV2JobResponse Int
Creating a Request
data StartEntitiesDetectionV2Job Source #
See: newStartEntitiesDetectionV2Job smart constructor.
Constructors
| StartEntitiesDetectionV2Job' | |
Fields
| |
Instances
newStartEntitiesDetectionV2Job Source #
Arguments
| :: InputDataConfig | |
| -> OutputDataConfig | |
| -> Text | |
| -> LanguageCode | |
| -> StartEntitiesDetectionV2Job |
Create a value of StartEntitiesDetectionV2Job 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:clientRequestToken:StartEntitiesDetectionV2Job', startEntitiesDetectionV2Job_clientRequestToken - A unique identifier for the request. If you don't set the client
request token, Comprehend Medical; generates one for you.
StartEntitiesDetectionV2Job, startEntitiesDetectionV2Job_jobName - The identifier of the job.
StartEntitiesDetectionV2Job, startEntitiesDetectionV2Job_kmsKey - An AWS Key Management Service key to encrypt your output files. If you
do not specify a key, the files are written in plain text.
StartEntitiesDetectionV2Job, startEntitiesDetectionV2Job_inputDataConfig - The input configuration that specifies the format and location of the
input data for the job.
StartEntitiesDetectionV2Job, startEntitiesDetectionV2Job_outputDataConfig - The output configuration that specifies where to send the output files.
StartEntitiesDetectionV2Job, startEntitiesDetectionV2Job_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that grants Comprehend Medical; read access to your input
data. For more information, see
Role-Based Permissions Required for Asynchronous Operations.
StartEntitiesDetectionV2Job, startEntitiesDetectionV2Job_languageCode - The language of the input documents. All documents must be in the same
language. Comprehend Medical; processes files in US English (en).
Request Lenses
startEntitiesDetectionV2Job_clientRequestToken :: Lens' StartEntitiesDetectionV2Job (Maybe Text) Source #
A unique identifier for the request. If you don't set the client request token, Comprehend Medical; generates one for you.
startEntitiesDetectionV2Job_jobName :: Lens' StartEntitiesDetectionV2Job (Maybe Text) Source #
The identifier of the job.
startEntitiesDetectionV2Job_kmsKey :: Lens' StartEntitiesDetectionV2Job (Maybe Text) Source #
An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.
startEntitiesDetectionV2Job_inputDataConfig :: Lens' StartEntitiesDetectionV2Job InputDataConfig Source #
The input configuration that specifies the format and location of the input data for the job.
startEntitiesDetectionV2Job_outputDataConfig :: Lens' StartEntitiesDetectionV2Job OutputDataConfig Source #
The output configuration that specifies where to send the output files.
startEntitiesDetectionV2Job_dataAccessRoleArn :: Lens' StartEntitiesDetectionV2Job Text Source #
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Comprehend Medical; read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.
startEntitiesDetectionV2Job_languageCode :: Lens' StartEntitiesDetectionV2Job LanguageCode Source #
The language of the input documents. All documents must be in the same language. Comprehend Medical; processes files in US English (en).
Destructuring the Response
data StartEntitiesDetectionV2JobResponse Source #
See: newStartEntitiesDetectionV2JobResponse smart constructor.
Constructors
| StartEntitiesDetectionV2JobResponse' | |
Fields
| |
Instances
newStartEntitiesDetectionV2JobResponse Source #
Arguments
| :: Int | |
| -> StartEntitiesDetectionV2JobResponse |
Create a value of StartEntitiesDetectionV2JobResponse 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:
StartEntitiesDetectionV2JobResponse, startEntitiesDetectionV2JobResponse_jobId - The identifier generated for the job. To get the status of a job, use
this identifier with the DescribeEntitiesDetectionV2Job operation.
$sel:httpStatus:StartEntitiesDetectionV2JobResponse', startEntitiesDetectionV2JobResponse_httpStatus - The response's http status code.
Response Lenses
startEntitiesDetectionV2JobResponse_jobId :: Lens' StartEntitiesDetectionV2JobResponse (Maybe Text) Source #
The identifier generated for the job. To get the status of a job, use
this identifier with the DescribeEntitiesDetectionV2Job operation.
startEntitiesDetectionV2JobResponse_httpStatus :: Lens' StartEntitiesDetectionV2JobResponse Int Source #
The response's http status code.