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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stops a PII entities detection job in progress.

Creating a Request

data StopPiiEntitiesDetectionJob Source #

See: newStopPiiEntitiesDetectionJob smart constructor.

Constructors

StopPiiEntitiesDetectionJob'
Fields jobId :: Text The identifier of the PII entities detection job to stop.

Instances

Instances details

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

newStopPiiEntitiesDetectionJob Source #

Arguments

:: Text	`StopPiiEntitiesDetectionJob`
-> StopPiiEntitiesDetectionJob

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

StopPiiEntitiesDetectionJob, stopPiiEntitiesDetectionJob_jobId - The identifier of the PII entities detection job to stop.

Request Lenses

stopPiiEntitiesDetectionJob_jobId :: Lens' StopPiiEntitiesDetectionJob Text Source #

The identifier of the PII entities detection job to stop.

Destructuring the Response

data StopPiiEntitiesDetectionJobResponse Source #

See: newStopPiiEntitiesDetectionJobResponse smart constructor.

Constructors

StopPiiEntitiesDetectionJobResponse'
Fields jobId :: Maybe Text The identifier of the PII entities detection job to stop. jobStatus :: Maybe JobStatus The status of the PII entities detection job. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStopPiiEntitiesDetectionJobResponse Source #

Arguments

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

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

StopPiiEntitiesDetectionJob, stopPiiEntitiesDetectionJobResponse_jobId - The identifier of the PII entities detection job to stop.

StopPiiEntitiesDetectionJobResponse, stopPiiEntitiesDetectionJobResponse_jobStatus - The status of the PII entities detection job.

$sel:httpStatus:StopPiiEntitiesDetectionJobResponse', stopPiiEntitiesDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

stopPiiEntitiesDetectionJobResponse_jobId :: Lens' StopPiiEntitiesDetectionJobResponse (Maybe Text) Source #

The identifier of the PII entities detection job to stop.

stopPiiEntitiesDetectionJobResponse_jobStatus :: Lens' StopPiiEntitiesDetectionJobResponse (Maybe JobStatus) Source #

The status of the PII entities detection job.

stopPiiEntitiesDetectionJobResponse_httpStatus :: Lens' StopPiiEntitiesDetectionJobResponse Int Source #

The response's http status code.