amazonka-comprehendmedical-2.0: Amazon Comprehend Medical SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Description

Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job.

Synopsis

Creating a Request

data StartSNOMEDCTInferenceJob Source #

See: newStartSNOMEDCTInferenceJob smart constructor.

Constructors

StartSNOMEDCTInferenceJob' 

Fields

Instances

Instances details
ToJSON StartSNOMEDCTInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Methods

toJSON :: StartSNOMEDCTInferenceJob -> Value #

toEncoding :: StartSNOMEDCTInferenceJob -> Encoding #

toJSONList :: [StartSNOMEDCTInferenceJob] -> Value #

toEncodingList :: [StartSNOMEDCTInferenceJob] -> Encoding #

ToHeaders StartSNOMEDCTInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Methods

toHeaders :: StartSNOMEDCTInferenceJob -> [Header] #

ToPath StartSNOMEDCTInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Methods

toPath :: StartSNOMEDCTInferenceJob -> ByteString #

ToQuery StartSNOMEDCTInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Methods

toQuery :: StartSNOMEDCTInferenceJob -> QueryString #

AWSRequest StartSNOMEDCTInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Associated Types

type AWSResponse StartSNOMEDCTInferenceJob #

Methods

request :: (Service -> Service) -> StartSNOMEDCTInferenceJob -> Request StartSNOMEDCTInferenceJob #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartSNOMEDCTInferenceJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartSNOMEDCTInferenceJob))) #

Generic StartSNOMEDCTInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Associated Types

type Rep StartSNOMEDCTInferenceJob :: Type -> Type #

Methods

from :: StartSNOMEDCTInferenceJob -> Rep StartSNOMEDCTInferenceJob x #

to :: Rep StartSNOMEDCTInferenceJob x -> StartSNOMEDCTInferenceJob #

Read StartSNOMEDCTInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Methods

readsPrec :: Int -> ReadS StartSNOMEDCTInferenceJob #

readList :: ReadS [StartSNOMEDCTInferenceJob] #

readPrec :: ReadPrec StartSNOMEDCTInferenceJob #

readListPrec :: ReadPrec [StartSNOMEDCTInferenceJob] #

Show StartSNOMEDCTInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Methods

showsPrec :: Int -> StartSNOMEDCTInferenceJob -> ShowS #

show :: StartSNOMEDCTInferenceJob -> String #

showList :: [StartSNOMEDCTInferenceJob] -> ShowS #

NFData StartSNOMEDCTInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Methods

rnf :: StartSNOMEDCTInferenceJob -> () #

Eq StartSNOMEDCTInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Methods

(==) :: StartSNOMEDCTInferenceJob -> StartSNOMEDCTInferenceJob -> Bool #

(/=) :: StartSNOMEDCTInferenceJob -> StartSNOMEDCTInferenceJob -> Bool #

Hashable StartSNOMEDCTInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Methods

hashWithSalt :: Int -> StartSNOMEDCTInferenceJob -> Int #

hash :: StartSNOMEDCTInferenceJob -> Int #

type AWSResponse StartSNOMEDCTInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

type AWSResponse StartSNOMEDCTInferenceJob = StartSNOMEDCTInferenceJobResponse
type Rep StartSNOMEDCTInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

type Rep StartSNOMEDCTInferenceJob = D1 ('MetaData "StartSNOMEDCTInferenceJob" "Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" 'False) (C1 ('MetaCons "StartSNOMEDCTInferenceJob'" '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)))))

newStartSNOMEDCTInferenceJob Source #

Arguments

:: InputDataConfig

StartSNOMEDCTInferenceJob

-> OutputDataConfig

StartSNOMEDCTInferenceJob

-> Text

StartSNOMEDCTInferenceJob

-> LanguageCode

StartSNOMEDCTInferenceJob

-> StartSNOMEDCTInferenceJob 

Create a value of StartSNOMEDCTInferenceJob 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:StartSNOMEDCTInferenceJob', startSNOMEDCTInferenceJob_clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

StartSNOMEDCTInferenceJob, startSNOMEDCTInferenceJob_jobName - The user generated name the asynchronous InferSNOMEDCT job.

StartSNOMEDCTInferenceJob, startSNOMEDCTInferenceJob_kmsKey - An AWS Key Management Service key used to encrypt your output files. If you do not specify a key, the files are written in plain text.

StartSNOMEDCTInferenceJob, startSNOMEDCTInferenceJob_inputDataConfig - Undocumented member.

StartSNOMEDCTInferenceJob, startSNOMEDCTInferenceJob_outputDataConfig - Undocumented member.

StartSNOMEDCTInferenceJob, startSNOMEDCTInferenceJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data.

StartSNOMEDCTInferenceJob, startSNOMEDCTInferenceJob_languageCode - The language of the input documents. All documents must be in the same language.

Request Lenses

startSNOMEDCTInferenceJob_clientRequestToken :: Lens' StartSNOMEDCTInferenceJob (Maybe Text) Source #

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

startSNOMEDCTInferenceJob_jobName :: Lens' StartSNOMEDCTInferenceJob (Maybe Text) Source #

The user generated name the asynchronous InferSNOMEDCT job.

startSNOMEDCTInferenceJob_kmsKey :: Lens' StartSNOMEDCTInferenceJob (Maybe Text) Source #

An AWS Key Management Service key used to encrypt your output files. If you do not specify a key, the files are written in plain text.

startSNOMEDCTInferenceJob_inputDataConfig :: Lens' StartSNOMEDCTInferenceJob InputDataConfig Source #

Undocumented member.

startSNOMEDCTInferenceJob_outputDataConfig :: Lens' StartSNOMEDCTInferenceJob OutputDataConfig Source #

Undocumented member.

startSNOMEDCTInferenceJob_dataAccessRoleArn :: Lens' StartSNOMEDCTInferenceJob Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data.

startSNOMEDCTInferenceJob_languageCode :: Lens' StartSNOMEDCTInferenceJob LanguageCode Source #

The language of the input documents. All documents must be in the same language.

Destructuring the Response

data StartSNOMEDCTInferenceJobResponse Source #

See: newStartSNOMEDCTInferenceJobResponse smart constructor.

Constructors

StartSNOMEDCTInferenceJobResponse' 

Fields

  • jobId :: Maybe Text

    The identifier generated for the job. To get the status of a job, use this identifier with the StartSNOMEDCTInferenceJob operation.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic StartSNOMEDCTInferenceJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Associated Types

type Rep StartSNOMEDCTInferenceJobResponse :: Type -> Type #

Methods

from :: StartSNOMEDCTInferenceJobResponse -> Rep StartSNOMEDCTInferenceJobResponse x #

to :: Rep StartSNOMEDCTInferenceJobResponse x -> StartSNOMEDCTInferenceJobResponse #

Read StartSNOMEDCTInferenceJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Methods

readsPrec :: Int -> ReadS StartSNOMEDCTInferenceJobResponse #

readList :: ReadS [StartSNOMEDCTInferenceJobResponse] #

readPrec :: ReadPrec StartSNOMEDCTInferenceJobResponse #

readListPrec :: ReadPrec [StartSNOMEDCTInferenceJobResponse] #

Show StartSNOMEDCTInferenceJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Methods

showsPrec :: Int -> StartSNOMEDCTInferenceJobResponse -> ShowS #

show :: StartSNOMEDCTInferenceJobResponse -> String #

showList :: [StartSNOMEDCTInferenceJobResponse] -> ShowS #

NFData StartSNOMEDCTInferenceJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Methods

rnf :: StartSNOMEDCTInferenceJobResponse -> () #

Eq StartSNOMEDCTInferenceJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

Methods

(==) :: StartSNOMEDCTInferenceJobResponse -> StartSNOMEDCTInferenceJobResponse -> Bool #

(/=) :: StartSNOMEDCTInferenceJobResponse -> StartSNOMEDCTInferenceJobResponse -> Bool #

type Rep StartSNOMEDCTInferenceJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob

type Rep StartSNOMEDCTInferenceJobResponse = D1 ('MetaData "StartSNOMEDCTInferenceJobResponse" "Amazonka.ComprehendMedical.StartSNOMEDCTInferenceJob" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" 'False) (C1 ('MetaCons "StartSNOMEDCTInferenceJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartSNOMEDCTInferenceJobResponse Source #

Arguments

:: Int

$sel:httpStatus:StartSNOMEDCTInferenceJobResponse'

-> StartSNOMEDCTInferenceJobResponse 

Create a value of StartSNOMEDCTInferenceJobResponse 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:

StartSNOMEDCTInferenceJobResponse, startSNOMEDCTInferenceJobResponse_jobId - The identifier generated for the job. To get the status of a job, use this identifier with the StartSNOMEDCTInferenceJob operation.

$sel:httpStatus:StartSNOMEDCTInferenceJobResponse', startSNOMEDCTInferenceJobResponse_httpStatus - The response's http status code.

Response Lenses

startSNOMEDCTInferenceJobResponse_jobId :: Lens' StartSNOMEDCTInferenceJobResponse (Maybe Text) Source #

The identifier generated for the job. To get the status of a job, use this identifier with the StartSNOMEDCTInferenceJob operation.

startSNOMEDCTInferenceJobResponse_httpStatus :: Lens' StartSNOMEDCTInferenceJobResponse Int Source #

The response's http status code.