libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Description

Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology. Use the DescribeICD10CMInferenceJob operation to track the status of a job.

Synopsis

Creating a Request

data StartICD10CMInferenceJob Source #

See: newStartICD10CMInferenceJob smart constructor.

Constructors

StartICD10CMInferenceJob' 

Fields

Instances

Instances details
Eq StartICD10CMInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Methods

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

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

Read StartICD10CMInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Methods

readsPrec :: Int -> ReadS StartICD10CMInferenceJob #

readList :: ReadS [StartICD10CMInferenceJob] #

readPrec :: ReadPrec StartICD10CMInferenceJob #

readListPrec :: ReadPrec [StartICD10CMInferenceJob] #

Show StartICD10CMInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Methods

showsPrec :: Int -> StartICD10CMInferenceJob -> ShowS #

show :: StartICD10CMInferenceJob -> String #

showList :: [StartICD10CMInferenceJob] -> ShowS #

Generic StartICD10CMInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Associated Types

type Rep StartICD10CMInferenceJob :: Type -> Type #

Methods

from :: StartICD10CMInferenceJob -> Rep StartICD10CMInferenceJob x #

to :: Rep StartICD10CMInferenceJob x -> StartICD10CMInferenceJob #

NFData StartICD10CMInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Methods

rnf :: StartICD10CMInferenceJob -> () #

Hashable StartICD10CMInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Methods

hashWithSalt :: Int -> StartICD10CMInferenceJob -> Int #

hash :: StartICD10CMInferenceJob -> Int #

ToJSON StartICD10CMInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Methods

toJSON :: StartICD10CMInferenceJob -> Value #

toEncoding :: StartICD10CMInferenceJob -> Encoding #

toJSONList :: [StartICD10CMInferenceJob] -> Value #

toEncodingList :: [StartICD10CMInferenceJob] -> Encoding #

AWSRequest StartICD10CMInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Associated Types

type AWSResponse StartICD10CMInferenceJob #

Methods

request :: StartICD10CMInferenceJob -> Request StartICD10CMInferenceJob #

response :: MonadResource m => Logger -> Service -> Proxy StartICD10CMInferenceJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartICD10CMInferenceJob))) #

ToHeaders StartICD10CMInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Methods

toHeaders :: StartICD10CMInferenceJob -> [Header] #

ToPath StartICD10CMInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Methods

toPath :: StartICD10CMInferenceJob -> ByteString #

ToQuery StartICD10CMInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Methods

toQuery :: StartICD10CMInferenceJob -> QueryString #

type Rep StartICD10CMInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

type Rep StartICD10CMInferenceJob = D1 ('MetaData "StartICD10CMInferenceJob" "Amazonka.ComprehendMedical.StartICD10CMInferenceJob" "libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical" 'False) (C1 ('MetaCons "StartICD10CMInferenceJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "kmsKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clientRequestToken") '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)))))
type AWSResponse StartICD10CMInferenceJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

type AWSResponse StartICD10CMInferenceJob = StartICD10CMInferenceJobResponse

newStartICD10CMInferenceJob Source #

Arguments

:: InputDataConfig

$sel:inputDataConfig:StartICD10CMInferenceJob'

-> OutputDataConfig

$sel:outputDataConfig:StartICD10CMInferenceJob'

-> Text

$sel:dataAccessRoleArn:StartICD10CMInferenceJob'

-> LanguageCode

$sel:languageCode:StartICD10CMInferenceJob'

-> StartICD10CMInferenceJob 

Create a value of StartICD10CMInferenceJob 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:kmsKey:StartICD10CMInferenceJob', startICD10CMInferenceJob_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.

$sel:jobName:StartICD10CMInferenceJob', startICD10CMInferenceJob_jobName - The identifier of the job.

$sel:clientRequestToken:StartICD10CMInferenceJob', startICD10CMInferenceJob_clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

$sel:inputDataConfig:StartICD10CMInferenceJob', startICD10CMInferenceJob_inputDataConfig - Specifies the format and location of the input data for the job.

$sel:outputDataConfig:StartICD10CMInferenceJob', startICD10CMInferenceJob_outputDataConfig - Specifies where to send the output files.

$sel:dataAccessRoleArn:StartICD10CMInferenceJob', startICD10CMInferenceJob_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. For more information, see Role-Based Permissions Required for Asynchronous Operations.

$sel:languageCode:StartICD10CMInferenceJob', startICD10CMInferenceJob_languageCode - The language of the input documents. All documents must be in the same language.

Request Lenses

startICD10CMInferenceJob_kmsKey :: Lens' StartICD10CMInferenceJob (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.

startICD10CMInferenceJob_jobName :: Lens' StartICD10CMInferenceJob (Maybe Text) Source #

The identifier of the job.

startICD10CMInferenceJob_clientRequestToken :: Lens' StartICD10CMInferenceJob (Maybe Text) Source #

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

startICD10CMInferenceJob_inputDataConfig :: Lens' StartICD10CMInferenceJob InputDataConfig Source #

Specifies the format and location of the input data for the job.

startICD10CMInferenceJob_outputDataConfig :: Lens' StartICD10CMInferenceJob OutputDataConfig Source #

Specifies where to send the output files.

startICD10CMInferenceJob_dataAccessRoleArn :: Lens' StartICD10CMInferenceJob 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. For more information, see Role-Based Permissions Required for Asynchronous Operations.

startICD10CMInferenceJob_languageCode :: Lens' StartICD10CMInferenceJob LanguageCode Source #

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

Destructuring the Response

data StartICD10CMInferenceJobResponse Source #

See: newStartICD10CMInferenceJobResponse smart constructor.

Constructors

StartICD10CMInferenceJobResponse' 

Fields

  • jobId :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq StartICD10CMInferenceJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Methods

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

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

Read StartICD10CMInferenceJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Methods

readsPrec :: Int -> ReadS StartICD10CMInferenceJobResponse #

readList :: ReadS [StartICD10CMInferenceJobResponse] #

readPrec :: ReadPrec StartICD10CMInferenceJobResponse #

readListPrec :: ReadPrec [StartICD10CMInferenceJobResponse] #

Show StartICD10CMInferenceJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Methods

showsPrec :: Int -> StartICD10CMInferenceJobResponse -> ShowS #

show :: StartICD10CMInferenceJobResponse -> String #

showList :: [StartICD10CMInferenceJobResponse] -> ShowS #

Generic StartICD10CMInferenceJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Associated Types

type Rep StartICD10CMInferenceJobResponse :: Type -> Type #

Methods

from :: StartICD10CMInferenceJobResponse -> Rep StartICD10CMInferenceJobResponse x #

to :: Rep StartICD10CMInferenceJobResponse x -> StartICD10CMInferenceJobResponse #

NFData StartICD10CMInferenceJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

Methods

rnf :: StartICD10CMInferenceJobResponse -> () #

type Rep StartICD10CMInferenceJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob

type Rep StartICD10CMInferenceJobResponse = D1 ('MetaData "StartICD10CMInferenceJobResponse" "Amazonka.ComprehendMedical.StartICD10CMInferenceJob" "libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical" 'False) (C1 ('MetaCons "StartICD10CMInferenceJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartICD10CMInferenceJobResponse Source #

Arguments

:: Int

$sel:httpStatus:StartICD10CMInferenceJobResponse'

-> StartICD10CMInferenceJobResponse 

Create a value of StartICD10CMInferenceJobResponse 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:StartICD10CMInferenceJobResponse', startICD10CMInferenceJobResponse_jobId - The identifier generated for the job. To get the status of a job, use this identifier with the StartICD10CMInferenceJob operation.

$sel:httpStatus:StartICD10CMInferenceJobResponse', startICD10CMInferenceJobResponse_httpStatus - The response's http status code.

Response Lenses

startICD10CMInferenceJobResponse_jobId :: Lens' StartICD10CMInferenceJobResponse (Maybe Text) Source #

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

startICD10CMInferenceJobResponse_httpStatus :: Lens' StartICD10CMInferenceJobResponse Int Source #

The response's http status code.