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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data DescribePHIDetectionJob Source #

See: newDescribePHIDetectionJob smart constructor.

Constructors

DescribePHIDetectionJob'
Fields jobId :: Text The identifier that Comprehend Medical; generated for the job. The `StartPHIDetectionJob` operation returns this identifier in its response.

Instances

Instances details

ToJSON DescribePHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob Methods toJSON :: DescribePHIDetectionJob -> Value # toEncoding :: DescribePHIDetectionJob -> Encoding # toJSONList :: [DescribePHIDetectionJob] -> Value # toEncodingList :: [DescribePHIDetectionJob] -> Encoding #
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 #
AWSRequest DescribePHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob Associated Types type AWSResponse DescribePHIDetectionJob # Methods request :: (Service -> Service) -> DescribePHIDetectionJob -> Request DescribePHIDetectionJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribePHIDetectionJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribePHIDetectionJob))) #
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 #
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 #
NFData DescribePHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob Methods rnf :: DescribePHIDetectionJob -> () #
Eq DescribePHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob Methods (==) :: DescribePHIDetectionJob -> DescribePHIDetectionJob -> Bool # (/=) :: DescribePHIDetectionJob -> DescribePHIDetectionJob -> Bool #
Hashable DescribePHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob Methods hashWithSalt :: Int -> DescribePHIDetectionJob -> Int # hash :: DescribePHIDetectionJob -> Int #
type AWSResponse DescribePHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob type AWSResponse DescribePHIDetectionJob = DescribePHIDetectionJobResponse
type Rep DescribePHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob type Rep DescribePHIDetectionJob = D1 ('MetaData "DescribePHIDetectionJob" "Amazonka.ComprehendMedical.DescribePHIDetectionJob" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" 'False) (C1 ('MetaCons "DescribePHIDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribePHIDetectionJob Source #

Arguments

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

DescribePHIDetectionJob, describePHIDetectionJob_jobId - The identifier that 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 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 comprehendMedicalAsyncJobProperties :: Maybe ComprehendMedicalAsyncJobProperties An object that contains the properties associated with a detection job. httpStatus :: Int The response's http status code.

Instances

Instances details

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 #
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 #
NFData DescribePHIDetectionJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob Methods rnf :: DescribePHIDetectionJobResponse -> () #
Eq DescribePHIDetectionJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob Methods (==) :: DescribePHIDetectionJobResponse -> DescribePHIDetectionJobResponse -> Bool # (/=) :: DescribePHIDetectionJobResponse -> DescribePHIDetectionJobResponse -> Bool #
type Rep DescribePHIDetectionJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.DescribePHIDetectionJob type Rep DescribePHIDetectionJobResponse = D1 ('MetaData "DescribePHIDetectionJobResponse" "Amazonka.ComprehendMedical.DescribePHIDetectionJob" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" '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.