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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stops a targeted sentiment detection job in progress.

If the job state is IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Synopsis

Creating a Request

data StopTargetedSentimentDetectionJob Source #

See: newStopTargetedSentimentDetectionJob smart constructor.

Constructors

StopTargetedSentimentDetectionJob'
Fields jobId :: Text The identifier of the targeted sentiment detection job to stop.

Instances

Instances details

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

newStopTargetedSentimentDetectionJob Source #

Arguments

:: Text	`StopTargetedSentimentDetectionJob`
-> StopTargetedSentimentDetectionJob

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

StopTargetedSentimentDetectionJob, stopTargetedSentimentDetectionJob_jobId - The identifier of the targeted sentiment detection job to stop.

Request Lenses

stopTargetedSentimentDetectionJob_jobId :: Lens' StopTargetedSentimentDetectionJob Text Source #

The identifier of the targeted sentiment detection job to stop.

Destructuring the Response

data StopTargetedSentimentDetectionJobResponse Source #

See: newStopTargetedSentimentDetectionJobResponse smart constructor.

Constructors

StopTargetedSentimentDetectionJobResponse'
Fields jobId :: Maybe Text The identifier of the targeted sentiment detection job to stop. jobStatus :: Maybe JobStatus Either `STOP_REQUESTED` if the job is currently running, or `STOPPED` if the job was previously stopped with the `StopSentimentDetectionJob` operation. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic StopTargetedSentimentDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StopTargetedSentimentDetectionJob Associated Types type Rep StopTargetedSentimentDetectionJobResponse :: Type -> Type # Methods from :: StopTargetedSentimentDetectionJobResponse -> Rep StopTargetedSentimentDetectionJobResponse x # to :: Rep StopTargetedSentimentDetectionJobResponse x -> StopTargetedSentimentDetectionJobResponse #
Read StopTargetedSentimentDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StopTargetedSentimentDetectionJob Methods readsPrec :: Int -> ReadS StopTargetedSentimentDetectionJobResponse # readList :: ReadS [StopTargetedSentimentDetectionJobResponse] # readPrec :: ReadPrec StopTargetedSentimentDetectionJobResponse # readListPrec :: ReadPrec [StopTargetedSentimentDetectionJobResponse] #
Show StopTargetedSentimentDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StopTargetedSentimentDetectionJob Methods showsPrec :: Int -> StopTargetedSentimentDetectionJobResponse -> ShowS # show :: StopTargetedSentimentDetectionJobResponse -> String # showList :: [StopTargetedSentimentDetectionJobResponse] -> ShowS #
NFData StopTargetedSentimentDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StopTargetedSentimentDetectionJob Methods rnf :: StopTargetedSentimentDetectionJobResponse -> () #
Eq StopTargetedSentimentDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StopTargetedSentimentDetectionJob Methods (==) :: StopTargetedSentimentDetectionJobResponse -> StopTargetedSentimentDetectionJobResponse -> Bool # (/=) :: StopTargetedSentimentDetectionJobResponse -> StopTargetedSentimentDetectionJobResponse -> Bool #
type Rep StopTargetedSentimentDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StopTargetedSentimentDetectionJob type Rep StopTargetedSentimentDetectionJobResponse = D1 ('MetaData "StopTargetedSentimentDetectionJobResponse" "Amazonka.Comprehend.StopTargetedSentimentDetectionJob" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "StopTargetedSentimentDetectionJobResponse'" '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))))

newStopTargetedSentimentDetectionJobResponse Source #

Arguments

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

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

StopTargetedSentimentDetectionJob, stopTargetedSentimentDetectionJobResponse_jobId - The identifier of the targeted sentiment detection job to stop.

StopTargetedSentimentDetectionJobResponse, stopTargetedSentimentDetectionJobResponse_jobStatus - Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.

$sel:httpStatus:StopTargetedSentimentDetectionJobResponse', stopTargetedSentimentDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

stopTargetedSentimentDetectionJobResponse_jobId :: Lens' StopTargetedSentimentDetectionJobResponse (Maybe Text) Source #

The identifier of the targeted sentiment detection job to stop.

stopTargetedSentimentDetectionJobResponse_jobStatus :: Lens' StopTargetedSentimentDetectionJobResponse (Maybe JobStatus) Source #

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.

stopTargetedSentimentDetectionJobResponse_httpStatus :: Lens' StopTargetedSentimentDetectionJobResponse Int Source #

The response's http status code.