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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

Creating a Request

data StartRxNormInferenceJob Source #

See: newStartRxNormInferenceJob smart constructor.

Constructors

StartRxNormInferenceJob'

Fields

clientRequestToken :: Maybe Text
A unique identifier for the request. If you don't set the client request token, Comprehend Medical; generates one.
jobName :: Maybe Text
The identifier of the job.
kmsKey :: Maybe Text
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.
inputDataConfig :: InputDataConfig
Specifies the format and location of the input data for the job.
outputDataConfig :: OutputDataConfig
Specifies where to send the output files.
dataAccessRoleArn :: Text
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.
languageCode :: LanguageCode
The language of the input documents. All documents must be in the same language.

Instances

Instances details

ToJSON StartRxNormInferenceJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob Methods toJSON :: StartRxNormInferenceJob -> Value # toEncoding :: StartRxNormInferenceJob -> Encoding # toJSONList :: [StartRxNormInferenceJob] -> Value # toEncodingList :: [StartRxNormInferenceJob] -> Encoding #
ToHeaders StartRxNormInferenceJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob Methods toHeaders :: StartRxNormInferenceJob -> [Header] #
ToPath StartRxNormInferenceJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob Methods toPath :: StartRxNormInferenceJob -> ByteString #
ToQuery StartRxNormInferenceJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob Methods toQuery :: StartRxNormInferenceJob -> QueryString #
AWSRequest StartRxNormInferenceJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob Associated Types type AWSResponse StartRxNormInferenceJob # Methods request :: (Service -> Service) -> StartRxNormInferenceJob -> Request StartRxNormInferenceJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartRxNormInferenceJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartRxNormInferenceJob))) #
Generic StartRxNormInferenceJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob Associated Types type Rep StartRxNormInferenceJob :: Type -> Type # Methods from :: StartRxNormInferenceJob -> Rep StartRxNormInferenceJob x # to :: Rep StartRxNormInferenceJob x -> StartRxNormInferenceJob #
Read StartRxNormInferenceJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob Methods readsPrec :: Int -> ReadS StartRxNormInferenceJob # readList :: ReadS [StartRxNormInferenceJob] # readPrec :: ReadPrec StartRxNormInferenceJob # readListPrec :: ReadPrec [StartRxNormInferenceJob] #
Show StartRxNormInferenceJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob Methods showsPrec :: Int -> StartRxNormInferenceJob -> ShowS # show :: StartRxNormInferenceJob -> String # showList :: [StartRxNormInferenceJob] -> ShowS #
NFData StartRxNormInferenceJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob Methods rnf :: StartRxNormInferenceJob -> () #
Eq StartRxNormInferenceJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob Methods (==) :: StartRxNormInferenceJob -> StartRxNormInferenceJob -> Bool # (/=) :: StartRxNormInferenceJob -> StartRxNormInferenceJob -> Bool #
Hashable StartRxNormInferenceJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob Methods hashWithSalt :: Int -> StartRxNormInferenceJob -> Int # hash :: StartRxNormInferenceJob -> Int #
type AWSResponse StartRxNormInferenceJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob type AWSResponse StartRxNormInferenceJob = StartRxNormInferenceJobResponse
type Rep StartRxNormInferenceJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob type Rep StartRxNormInferenceJob = D1 ('MetaData "StartRxNormInferenceJob" "Amazonka.ComprehendMedical.StartRxNormInferenceJob" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" 'False) (C1 ('MetaCons "StartRxNormInferenceJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kmsKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputDataConfig) :: S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputDataConfig)) :: (S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode)))))

newStartRxNormInferenceJob Source #

Arguments

:: InputDataConfig	`StartRxNormInferenceJob`
-> OutputDataConfig	`StartRxNormInferenceJob`
-> Text	`StartRxNormInferenceJob`
-> LanguageCode	`StartRxNormInferenceJob`
-> 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 jobId :: Maybe Text The identifier of the job. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic StartRxNormInferenceJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob Associated Types type Rep StartRxNormInferenceJobResponse :: Type -> Type # Methods from :: StartRxNormInferenceJobResponse -> Rep StartRxNormInferenceJobResponse x # to :: Rep StartRxNormInferenceJobResponse x -> StartRxNormInferenceJobResponse #
Read StartRxNormInferenceJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob Methods readsPrec :: Int -> ReadS StartRxNormInferenceJobResponse # readList :: ReadS [StartRxNormInferenceJobResponse] # readPrec :: ReadPrec StartRxNormInferenceJobResponse # readListPrec :: ReadPrec [StartRxNormInferenceJobResponse] #
Show StartRxNormInferenceJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob Methods showsPrec :: Int -> StartRxNormInferenceJobResponse -> ShowS # show :: StartRxNormInferenceJobResponse -> String # showList :: [StartRxNormInferenceJobResponse] -> ShowS #
NFData StartRxNormInferenceJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob Methods rnf :: StartRxNormInferenceJobResponse -> () #
Eq StartRxNormInferenceJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob Methods (==) :: StartRxNormInferenceJobResponse -> StartRxNormInferenceJobResponse -> Bool # (/=) :: StartRxNormInferenceJobResponse -> StartRxNormInferenceJobResponse -> Bool #
type Rep StartRxNormInferenceJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob type Rep StartRxNormInferenceJobResponse = D1 ('MetaData "StartRxNormInferenceJobResponse" "Amazonka.ComprehendMedical.StartRxNormInferenceJob" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" 'False) (C1 ('MetaCons "StartRxNormInferenceJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartRxNormInferenceJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartRxNormInferenceJobResponse'`
-> StartRxNormInferenceJobResponse

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.