| 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.StartRxNormInferenceJob
Description
Starts an asynchronous job to detect medication entities and link them
to the RxNorm ontology. Use the DescribeRxNormInferenceJob operation
to track the status of a job.
Synopsis
- data StartRxNormInferenceJob = StartRxNormInferenceJob' {}
- newStartRxNormInferenceJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartRxNormInferenceJob
- startRxNormInferenceJob_clientRequestToken :: Lens' StartRxNormInferenceJob (Maybe Text)
- startRxNormInferenceJob_jobName :: Lens' StartRxNormInferenceJob (Maybe Text)
- startRxNormInferenceJob_kmsKey :: Lens' StartRxNormInferenceJob (Maybe Text)
- startRxNormInferenceJob_inputDataConfig :: Lens' StartRxNormInferenceJob InputDataConfig
- startRxNormInferenceJob_outputDataConfig :: Lens' StartRxNormInferenceJob OutputDataConfig
- startRxNormInferenceJob_dataAccessRoleArn :: Lens' StartRxNormInferenceJob Text
- startRxNormInferenceJob_languageCode :: Lens' StartRxNormInferenceJob LanguageCode
- data StartRxNormInferenceJobResponse = StartRxNormInferenceJobResponse' {
- jobId :: Maybe Text
- httpStatus :: Int
- newStartRxNormInferenceJobResponse :: Int -> StartRxNormInferenceJobResponse
- startRxNormInferenceJobResponse_jobId :: Lens' StartRxNormInferenceJobResponse (Maybe Text)
- startRxNormInferenceJobResponse_httpStatus :: Lens' StartRxNormInferenceJobResponse Int
Creating a Request
data StartRxNormInferenceJob Source #
See: newStartRxNormInferenceJob smart constructor.
Constructors
| StartRxNormInferenceJob' | |
Fields
| |
Instances
newStartRxNormInferenceJob Source #
Arguments
| :: InputDataConfig | |
| -> OutputDataConfig | |
| -> Text | |
| -> LanguageCode | |
| -> StartRxNormInferenceJob |
Create a value of StartRxNormInferenceJob 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:StartRxNormInferenceJob', startRxNormInferenceJob_clientRequestToken - A unique identifier for the request. If you don't set the client
request token, Comprehend Medical; generates one.
StartRxNormInferenceJob, startRxNormInferenceJob_jobName - The identifier of the job.
StartRxNormInferenceJob, startRxNormInferenceJob_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.
StartRxNormInferenceJob, startRxNormInferenceJob_inputDataConfig - Specifies the format and location of the input data for the job.
StartRxNormInferenceJob, startRxNormInferenceJob_outputDataConfig - Specifies where to send the output files.
StartRxNormInferenceJob, startRxNormInferenceJob_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.
StartRxNormInferenceJob, startRxNormInferenceJob_languageCode - The language of the input documents. All documents must be in the same
language.
Request Lenses
startRxNormInferenceJob_clientRequestToken :: Lens' StartRxNormInferenceJob (Maybe Text) Source #
A unique identifier for the request. If you don't set the client request token, Comprehend Medical; generates one.
startRxNormInferenceJob_jobName :: Lens' StartRxNormInferenceJob (Maybe Text) Source #
The identifier of the job.
startRxNormInferenceJob_kmsKey :: Lens' StartRxNormInferenceJob (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.
startRxNormInferenceJob_inputDataConfig :: Lens' StartRxNormInferenceJob InputDataConfig Source #
Specifies the format and location of the input data for the job.
startRxNormInferenceJob_outputDataConfig :: Lens' StartRxNormInferenceJob OutputDataConfig Source #
Specifies where to send the output files.
startRxNormInferenceJob_dataAccessRoleArn :: Lens' StartRxNormInferenceJob 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.
startRxNormInferenceJob_languageCode :: Lens' StartRxNormInferenceJob LanguageCode Source #
The language of the input documents. All documents must be in the same language.
Destructuring the Response
data StartRxNormInferenceJobResponse Source #
See: newStartRxNormInferenceJobResponse smart constructor.
Constructors
| StartRxNormInferenceJobResponse' | |
Fields
| |
Instances
newStartRxNormInferenceJobResponse Source #
Create a value of StartRxNormInferenceJobResponse 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:
StartRxNormInferenceJobResponse, startRxNormInferenceJobResponse_jobId - The identifier of the job.
$sel:httpStatus:StartRxNormInferenceJobResponse', startRxNormInferenceJobResponse_httpStatus - The response's http status code.
Response Lenses
startRxNormInferenceJobResponse_jobId :: Lens' StartRxNormInferenceJobResponse (Maybe Text) Source #
The identifier of the job.
startRxNormInferenceJobResponse_httpStatus :: Lens' StartRxNormInferenceJobResponse Int Source #
The response's http status code.