Amazonka.Comprehend.StopSentimentDetectionJob

Stops a 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.

Creating a Request

data StopSentimentDetectionJob

See: newStopSentimentDetectionJob smart constructor.

Constructors

StopSentimentDetectionJob'

Fields

• jobId :: Text

  The identifier of the sentiment detection job to stop.

Instances

ToJSON StopSentimentDetectionJob

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Methods

toJSON :: StopSentimentDetectionJob -> Value

toEncoding :: StopSentimentDetectionJob -> Encoding

toJSONList :: [StopSentimentDetectionJob] -> Value

toEncodingList :: [StopSentimentDetectionJob] -> Encoding

ToHeaders StopSentimentDetectionJob

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Methods

toHeaders :: StopSentimentDetectionJob -> [Header]

ToPath StopSentimentDetectionJob

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Methods

toPath :: StopSentimentDetectionJob -> ByteString

ToQuery StopSentimentDetectionJob

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Methods

toQuery :: StopSentimentDetectionJob -> QueryString

AWSRequest StopSentimentDetectionJob

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Associated Types

type AWSResponse StopSentimentDetectionJob

Methods

request :: (Service -> Service) -> StopSentimentDetectionJob -> Request StopSentimentDetectionJob

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopSentimentDetectionJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopSentimentDetectionJob)))

Generic StopSentimentDetectionJob

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Associated Types

type Rep StopSentimentDetectionJob :: Type -> Type

Methods

from :: StopSentimentDetectionJob -> Rep StopSentimentDetectionJob x

to :: Rep StopSentimentDetectionJob x -> StopSentimentDetectionJob

Read StopSentimentDetectionJob

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Methods

readsPrec :: Int -> ReadS StopSentimentDetectionJob

readList :: ReadS [StopSentimentDetectionJob]

readPrec :: ReadPrec StopSentimentDetectionJob

readListPrec :: ReadPrec [StopSentimentDetectionJob]

Show StopSentimentDetectionJob

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Methods

showsPrec :: Int -> StopSentimentDetectionJob -> ShowS

show :: StopSentimentDetectionJob -> String

showList :: [StopSentimentDetectionJob] -> ShowS

NFData StopSentimentDetectionJob

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Methods

rnf :: StopSentimentDetectionJob -> ()

Eq StopSentimentDetectionJob

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Methods

(==) :: StopSentimentDetectionJob -> StopSentimentDetectionJob -> Bool

(/=) :: StopSentimentDetectionJob -> StopSentimentDetectionJob -> Bool

Hashable StopSentimentDetectionJob

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Methods

hashWithSalt :: Int -> StopSentimentDetectionJob -> Int

hash :: StopSentimentDetectionJob -> Int

type AWSResponse StopSentimentDetectionJob

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

type AWSResponse StopSentimentDetectionJob = StopSentimentDetectionJobResponse

type Rep StopSentimentDetectionJob

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

type Rep StopSentimentDetectionJob = D1 ('MetaData "StopSentimentDetectionJob" "Amazonka.Comprehend.StopSentimentDetectionJob" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "StopSentimentDetectionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopSentimentDetectionJob

Arguments

:: Text

StopSentimentDetectionJob

-> StopSentimentDetectionJob

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

StopSentimentDetectionJob, stopSentimentDetectionJob_jobId - The identifier of the sentiment detection job to stop.

Request Lenses

stopSentimentDetectionJob_jobId :: Lens' StopSentimentDetectionJob Text

The identifier of the sentiment detection job to stop.

Destructuring the Response

data StopSentimentDetectionJobResponse

See: newStopSentimentDetectionJobResponse smart constructor.

Constructors

StopSentimentDetectionJobResponse'

Fields

• jobId :: Maybe Text

  The identifier of the 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

Generic StopSentimentDetectionJobResponse

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Associated Types

type Rep StopSentimentDetectionJobResponse :: Type -> Type

Methods

from :: StopSentimentDetectionJobResponse -> Rep StopSentimentDetectionJobResponse x

to :: Rep StopSentimentDetectionJobResponse x -> StopSentimentDetectionJobResponse

Read StopSentimentDetectionJobResponse

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Methods

readsPrec :: Int -> ReadS StopSentimentDetectionJobResponse

readList :: ReadS [StopSentimentDetectionJobResponse]

readPrec :: ReadPrec StopSentimentDetectionJobResponse

readListPrec :: ReadPrec [StopSentimentDetectionJobResponse]

Show StopSentimentDetectionJobResponse

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Methods

showsPrec :: Int -> StopSentimentDetectionJobResponse -> ShowS

show :: StopSentimentDetectionJobResponse -> String

showList :: [StopSentimentDetectionJobResponse] -> ShowS

NFData StopSentimentDetectionJobResponse

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Methods

rnf :: StopSentimentDetectionJobResponse -> ()

Eq StopSentimentDetectionJobResponse

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

Methods

(==) :: StopSentimentDetectionJobResponse -> StopSentimentDetectionJobResponse -> Bool

(/=) :: StopSentimentDetectionJobResponse -> StopSentimentDetectionJobResponse -> Bool

type Rep StopSentimentDetectionJobResponse

Defined in Amazonka.Comprehend.StopSentimentDetectionJob

type Rep StopSentimentDetectionJobResponse = D1 ('MetaData "StopSentimentDetectionJobResponse" "Amazonka.Comprehend.StopSentimentDetectionJob" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "StopSentimentDetectionJobResponse'" '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))))

newStopSentimentDetectionJobResponse

Arguments

:: Int

$sel:httpStatus:StopSentimentDetectionJobResponse'

-> StopSentimentDetectionJobResponse

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

StopSentimentDetectionJob, stopSentimentDetectionJobResponse_jobId - The identifier of the sentiment detection job to stop.

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

$sel:httpStatus:StopSentimentDetectionJobResponse', stopSentimentDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

stopSentimentDetectionJobResponse_jobId :: Lens' StopSentimentDetectionJobResponse (Maybe Text)

The identifier of the sentiment detection job to stop.

stopSentimentDetectionJobResponse_jobStatus :: Lens' StopSentimentDetectionJobResponse (Maybe JobStatus)

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

stopSentimentDetectionJobResponse_httpStatus :: Lens' StopSentimentDetectionJobResponse Int

The response's http status code.