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

Description

Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.

Synopsis

Creating a Request

data DescribePHIDetectionJob Source #

See: newDescribePHIDetectionJob smart constructor.

Constructors

DescribePHIDetectionJob' 

Fields

  • jobId :: Text

    The identifier that Amazon Comprehend Medical generated for the job. The StartPHIDetectionJob operation returns this identifier in its response.

Instances

Instances details
Eq DescribePHIDetectionJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

Methods

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

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

Read DescribePHIDetectionJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

Methods

readsPrec :: Int -> ReadS DescribePHIDetectionJob #

readList :: ReadS [DescribePHIDetectionJob] #

readPrec :: ReadPrec DescribePHIDetectionJob #

readListPrec :: ReadPrec [DescribePHIDetectionJob] #

Show DescribePHIDetectionJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

Methods

showsPrec :: Int -> DescribePHIDetectionJob -> ShowS #

show :: DescribePHIDetectionJob -> String #

showList :: [DescribePHIDetectionJob] -> ShowS #

Generic DescribePHIDetectionJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

Associated Types

type Rep DescribePHIDetectionJob :: Type -> Type #

Methods

from :: DescribePHIDetectionJob -> Rep DescribePHIDetectionJob x #

to :: Rep DescribePHIDetectionJob x -> DescribePHIDetectionJob #

NFData DescribePHIDetectionJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

Methods

rnf :: DescribePHIDetectionJob -> () #

Hashable DescribePHIDetectionJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

Methods

hashWithSalt :: Int -> DescribePHIDetectionJob -> Int #

hash :: DescribePHIDetectionJob -> Int #

ToJSON DescribePHIDetectionJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

Methods

toJSON :: DescribePHIDetectionJob -> Value #

toEncoding :: DescribePHIDetectionJob -> Encoding #

toJSONList :: [DescribePHIDetectionJob] -> Value #

toEncodingList :: [DescribePHIDetectionJob] -> Encoding #

AWSRequest DescribePHIDetectionJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

Associated Types

type AWSResponse DescribePHIDetectionJob #

Methods

request :: DescribePHIDetectionJob -> Request DescribePHIDetectionJob #

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

ToHeaders DescribePHIDetectionJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

Methods

toHeaders :: DescribePHIDetectionJob -> [Header] #

ToPath DescribePHIDetectionJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

Methods

toPath :: DescribePHIDetectionJob -> ByteString #

ToQuery DescribePHIDetectionJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

Methods

toQuery :: DescribePHIDetectionJob -> QueryString #

type Rep DescribePHIDetectionJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

type Rep DescribePHIDetectionJob = D1 ('MetaData "DescribePHIDetectionJob" "Amazonka.ComprehendMedical.DescribePHIDetectionJob" "libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical" 'False) (C1 ('MetaCons "DescribePHIDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribePHIDetectionJob Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

type AWSResponse DescribePHIDetectionJob = DescribePHIDetectionJobResponse

newDescribePHIDetectionJob Source #

Arguments

:: Text

$sel:jobId:DescribePHIDetectionJob'

-> DescribePHIDetectionJob 

Create a value of DescribePHIDetectionJob 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:DescribePHIDetectionJob', describePHIDetectionJob_jobId - The identifier that Amazon Comprehend Medical generated for the job. The StartPHIDetectionJob operation returns this identifier in its response.

Request Lenses

describePHIDetectionJob_jobId :: Lens' DescribePHIDetectionJob Text Source #

The identifier that Amazon Comprehend Medical generated for the job. The StartPHIDetectionJob operation returns this identifier in its response.

Destructuring the Response

data DescribePHIDetectionJobResponse Source #

See: newDescribePHIDetectionJobResponse smart constructor.

Constructors

DescribePHIDetectionJobResponse' 

Fields

Instances

Instances details
Eq DescribePHIDetectionJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

Methods

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

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

Read DescribePHIDetectionJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

Methods

readsPrec :: Int -> ReadS DescribePHIDetectionJobResponse #

readList :: ReadS [DescribePHIDetectionJobResponse] #

readPrec :: ReadPrec DescribePHIDetectionJobResponse #

readListPrec :: ReadPrec [DescribePHIDetectionJobResponse] #

Show DescribePHIDetectionJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

Methods

showsPrec :: Int -> DescribePHIDetectionJobResponse -> ShowS #

show :: DescribePHIDetectionJobResponse -> String #

showList :: [DescribePHIDetectionJobResponse] -> ShowS #

Generic DescribePHIDetectionJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

Associated Types

type Rep DescribePHIDetectionJobResponse :: Type -> Type #

Methods

from :: DescribePHIDetectionJobResponse -> Rep DescribePHIDetectionJobResponse x #

to :: Rep DescribePHIDetectionJobResponse x -> DescribePHIDetectionJobResponse #

NFData DescribePHIDetectionJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

Methods

rnf :: DescribePHIDetectionJobResponse -> () #

type Rep DescribePHIDetectionJobResponse Source # 
Instance details

Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob

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

newDescribePHIDetectionJobResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribePHIDetectionJobResponse'

-> DescribePHIDetectionJobResponse 

Create a value of DescribePHIDetectionJobResponse 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:comprehendMedicalAsyncJobProperties:DescribePHIDetectionJobResponse', describePHIDetectionJobResponse_comprehendMedicalAsyncJobProperties - An object that contains the properties associated with a detection job.

$sel:httpStatus:DescribePHIDetectionJobResponse', describePHIDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

describePHIDetectionJobResponse_comprehendMedicalAsyncJobProperties :: Lens' DescribePHIDetectionJobResponse (Maybe ComprehendMedicalAsyncJobProperties) Source #

An object that contains the properties associated with a detection job.

describePHIDetectionJobResponse_httpStatus :: Lens' DescribePHIDetectionJobResponse Int Source #

The response's http status code.