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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stops a protected health information (PHI) detection job in progress.

Creating a Request

data StopPHIDetectionJob Source #

See: newStopPHIDetectionJob smart constructor.

Constructors

StopPHIDetectionJob'
Fields jobId :: Text The identifier of the PHI detection job to stop.

Instances

Instances details

ToJSON StopPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob Methods toJSON :: StopPHIDetectionJob -> Value # toEncoding :: StopPHIDetectionJob -> Encoding # toJSONList :: [StopPHIDetectionJob] -> Value # toEncodingList :: [StopPHIDetectionJob] -> Encoding #
ToHeaders StopPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob Methods toHeaders :: StopPHIDetectionJob -> [Header] #
ToPath StopPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob Methods toPath :: StopPHIDetectionJob -> ByteString #
ToQuery StopPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob Methods toQuery :: StopPHIDetectionJob -> QueryString #
AWSRequest StopPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob Associated Types type AWSResponse StopPHIDetectionJob # Methods request :: (Service -> Service) -> StopPHIDetectionJob -> Request StopPHIDetectionJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopPHIDetectionJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopPHIDetectionJob))) #
Generic StopPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob Associated Types type Rep StopPHIDetectionJob :: Type -> Type # Methods from :: StopPHIDetectionJob -> Rep StopPHIDetectionJob x # to :: Rep StopPHIDetectionJob x -> StopPHIDetectionJob #
Read StopPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob Methods readsPrec :: Int -> ReadS StopPHIDetectionJob # readList :: ReadS [StopPHIDetectionJob] # readPrec :: ReadPrec StopPHIDetectionJob # readListPrec :: ReadPrec [StopPHIDetectionJob] #
Show StopPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob Methods showsPrec :: Int -> StopPHIDetectionJob -> ShowS # show :: StopPHIDetectionJob -> String # showList :: [StopPHIDetectionJob] -> ShowS #
NFData StopPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob Methods rnf :: StopPHIDetectionJob -> () #
Eq StopPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob Methods (==) :: StopPHIDetectionJob -> StopPHIDetectionJob -> Bool # (/=) :: StopPHIDetectionJob -> StopPHIDetectionJob -> Bool #
Hashable StopPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob Methods hashWithSalt :: Int -> StopPHIDetectionJob -> Int # hash :: StopPHIDetectionJob -> Int #
type AWSResponse StopPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob type AWSResponse StopPHIDetectionJob = StopPHIDetectionJobResponse
type Rep StopPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob type Rep StopPHIDetectionJob = D1 ('MetaData "StopPHIDetectionJob" "Amazonka.ComprehendMedical.StopPHIDetectionJob" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" 'False) (C1 ('MetaCons "StopPHIDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopPHIDetectionJob Source #

Arguments

:: Text	`StopPHIDetectionJob`
-> StopPHIDetectionJob

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

StopPHIDetectionJob, stopPHIDetectionJob_jobId - The identifier of the PHI detection job to stop.

Request Lenses

stopPHIDetectionJob_jobId :: Lens' StopPHIDetectionJob Text Source #

The identifier of the PHI detection job to stop.

Destructuring the Response

data StopPHIDetectionJobResponse Source #

See: newStopPHIDetectionJobResponse smart constructor.

Constructors

StopPHIDetectionJobResponse'
Fields jobId :: Maybe Text The identifier of the PHI detection job that was stopped. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic StopPHIDetectionJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob Associated Types type Rep StopPHIDetectionJobResponse :: Type -> Type # Methods from :: StopPHIDetectionJobResponse -> Rep StopPHIDetectionJobResponse x # to :: Rep StopPHIDetectionJobResponse x -> StopPHIDetectionJobResponse #
Read StopPHIDetectionJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob Methods readsPrec :: Int -> ReadS StopPHIDetectionJobResponse # readList :: ReadS [StopPHIDetectionJobResponse] # readPrec :: ReadPrec StopPHIDetectionJobResponse # readListPrec :: ReadPrec [StopPHIDetectionJobResponse] #
Show StopPHIDetectionJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob Methods showsPrec :: Int -> StopPHIDetectionJobResponse -> ShowS # show :: StopPHIDetectionJobResponse -> String # showList :: [StopPHIDetectionJobResponse] -> ShowS #
NFData StopPHIDetectionJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob Methods rnf :: StopPHIDetectionJobResponse -> () #
Eq StopPHIDetectionJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob Methods (==) :: StopPHIDetectionJobResponse -> StopPHIDetectionJobResponse -> Bool # (/=) :: StopPHIDetectionJobResponse -> StopPHIDetectionJobResponse -> Bool #
type Rep StopPHIDetectionJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StopPHIDetectionJob type Rep StopPHIDetectionJobResponse = D1 ('MetaData "StopPHIDetectionJobResponse" "Amazonka.ComprehendMedical.StopPHIDetectionJob" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" 'False) (C1 ('MetaCons "StopPHIDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopPHIDetectionJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:StopPHIDetectionJobResponse'`
-> StopPHIDetectionJobResponse

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

StopPHIDetectionJob, stopPHIDetectionJobResponse_jobId - The identifier of the PHI detection job that was stopped.

$sel:httpStatus:StopPHIDetectionJobResponse', stopPHIDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

stopPHIDetectionJobResponse_jobId :: Lens' StopPHIDetectionJobResponse (Maybe Text) Source #

The identifier of the PHI detection job that was stopped.

stopPHIDetectionJobResponse_httpStatus :: Lens' StopPHIDetectionJobResponse Int Source #

The response's http status code.