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.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

Creating a Request

data StartEntitiesDetectionV2Job Source #

See: newStartEntitiesDetectionV2Job smart constructor.

Constructors

StartEntitiesDetectionV2Job' 

Fields

Instances

Instances details
Eq StartEntitiesDetectionV2Job Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

Methods

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

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

Read StartEntitiesDetectionV2Job Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

Methods

readsPrec :: Int -> ReadS StartEntitiesDetectionV2Job #

readList :: ReadS [StartEntitiesDetectionV2Job] #

readPrec :: ReadPrec StartEntitiesDetectionV2Job #

readListPrec :: ReadPrec [StartEntitiesDetectionV2Job] #

Show StartEntitiesDetectionV2Job Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

Methods

showsPrec :: Int -> StartEntitiesDetectionV2Job -> ShowS #

show :: StartEntitiesDetectionV2Job -> String #

showList :: [StartEntitiesDetectionV2Job] -> ShowS #

Generic StartEntitiesDetectionV2Job Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

Associated Types

type Rep StartEntitiesDetectionV2Job :: Type -> Type #

Methods

from :: StartEntitiesDetectionV2Job -> Rep StartEntitiesDetectionV2Job x #

to :: Rep StartEntitiesDetectionV2Job x -> StartEntitiesDetectionV2Job #

NFData StartEntitiesDetectionV2Job Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

Methods

rnf :: StartEntitiesDetectionV2Job -> () #

Hashable StartEntitiesDetectionV2Job Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

Methods

hashWithSalt :: Int -> StartEntitiesDetectionV2Job -> Int #

hash :: StartEntitiesDetectionV2Job -> Int #

ToJSON StartEntitiesDetectionV2Job Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

Methods

toJSON :: StartEntitiesDetectionV2Job -> Value #

toEncoding :: StartEntitiesDetectionV2Job -> Encoding #

toJSONList :: [StartEntitiesDetectionV2Job] -> Value #

toEncodingList :: [StartEntitiesDetectionV2Job] -> Encoding #

AWSRequest StartEntitiesDetectionV2Job Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

Associated Types

type AWSResponse StartEntitiesDetectionV2Job #

Methods

request :: StartEntitiesDetectionV2Job -> Request StartEntitiesDetectionV2Job #

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

ToHeaders StartEntitiesDetectionV2Job Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

Methods

toHeaders :: StartEntitiesDetectionV2Job -> [Header] #

ToPath StartEntitiesDetectionV2Job Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

Methods

toPath :: StartEntitiesDetectionV2Job -> ByteString #

ToQuery StartEntitiesDetectionV2Job Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

Methods

toQuery :: StartEntitiesDetectionV2Job -> QueryString #

type Rep StartEntitiesDetectionV2Job Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

type Rep StartEntitiesDetectionV2Job = D1 ('MetaData "StartEntitiesDetectionV2Job" "Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job" "libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical" 'False) (C1 ('MetaCons "StartEntitiesDetectionV2Job'" '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 StartEntitiesDetectionV2Job Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

type AWSResponse StartEntitiesDetectionV2Job = StartEntitiesDetectionV2JobResponse

newStartEntitiesDetectionV2Job Source #

Arguments

:: InputDataConfig

$sel:inputDataConfig:StartEntitiesDetectionV2Job'

-> OutputDataConfig

$sel:outputDataConfig:StartEntitiesDetectionV2Job'

-> Text

$sel:dataAccessRoleArn:StartEntitiesDetectionV2Job'

-> LanguageCode

$sel:languageCode:StartEntitiesDetectionV2Job'

-> 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:kmsKey: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.

$sel:jobName:StartEntitiesDetectionV2Job', startEntitiesDetectionV2Job_jobName - The identifier of the job.

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

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

$sel:outputDataConfig:StartEntitiesDetectionV2Job', startEntitiesDetectionV2Job_outputDataConfig - Specifies where to send the output files.

$sel:dataAccessRoleArn:StartEntitiesDetectionV2Job', startEntitiesDetectionV2Job_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:StartEntitiesDetectionV2Job', startEntitiesDetectionV2Job_languageCode - The language of the input documents. All documents must be in the same language.

Request Lenses

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_jobName :: Lens' StartEntitiesDetectionV2Job (Maybe Text) Source #

The identifier of the job.

startEntitiesDetectionV2Job_clientRequestToken :: Lens' StartEntitiesDetectionV2Job (Maybe Text) Source #

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

startEntitiesDetectionV2Job_inputDataConfig :: Lens' StartEntitiesDetectionV2Job InputDataConfig Source #

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

startEntitiesDetectionV2Job_outputDataConfig :: Lens' StartEntitiesDetectionV2Job OutputDataConfig Source #

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 Amazon 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.

Destructuring the Response

data StartEntitiesDetectionV2JobResponse Source #

See: newStartEntitiesDetectionV2JobResponse smart constructor.

Constructors

StartEntitiesDetectionV2JobResponse' 

Fields

  • jobId :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq StartEntitiesDetectionV2JobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

Methods

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

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

Read StartEntitiesDetectionV2JobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

Methods

readsPrec :: Int -> ReadS StartEntitiesDetectionV2JobResponse #

readList :: ReadS [StartEntitiesDetectionV2JobResponse] #

readPrec :: ReadPrec StartEntitiesDetectionV2JobResponse #

readListPrec :: ReadPrec [StartEntitiesDetectionV2JobResponse] #

Show StartEntitiesDetectionV2JobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

Methods

showsPrec :: Int -> StartEntitiesDetectionV2JobResponse -> ShowS #

show :: StartEntitiesDetectionV2JobResponse -> String #

showList :: [StartEntitiesDetectionV2JobResponse] -> ShowS #

Generic StartEntitiesDetectionV2JobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

Associated Types

type Rep StartEntitiesDetectionV2JobResponse :: Type -> Type #

Methods

from :: StartEntitiesDetectionV2JobResponse -> Rep StartEntitiesDetectionV2JobResponse x #

to :: Rep StartEntitiesDetectionV2JobResponse x -> StartEntitiesDetectionV2JobResponse #

NFData StartEntitiesDetectionV2JobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

Methods

rnf :: StartEntitiesDetectionV2JobResponse -> () #

type Rep StartEntitiesDetectionV2JobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.StartEntitiesDetectionV2Job

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

newStartEntitiesDetectionV2JobResponse Source #

Arguments

:: Int

$sel:httpStatus:StartEntitiesDetectionV2JobResponse'

-> 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:

$sel:jobId: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.