| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Comprehend.StopSentimentDetectionJob
Description
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.
Synopsis
- data StopSentimentDetectionJob = StopSentimentDetectionJob' {}
- newStopSentimentDetectionJob :: Text -> StopSentimentDetectionJob
- stopSentimentDetectionJob_jobId :: Lens' StopSentimentDetectionJob Text
- data StopSentimentDetectionJobResponse = StopSentimentDetectionJobResponse' {}
- newStopSentimentDetectionJobResponse :: Int -> StopSentimentDetectionJobResponse
- stopSentimentDetectionJobResponse_jobId :: Lens' StopSentimentDetectionJobResponse (Maybe Text)
- stopSentimentDetectionJobResponse_jobStatus :: Lens' StopSentimentDetectionJobResponse (Maybe JobStatus)
- stopSentimentDetectionJobResponse_httpStatus :: Lens' StopSentimentDetectionJobResponse Int
Creating a Request
data StopSentimentDetectionJob Source #
See: newStopSentimentDetectionJob smart constructor.
Constructors
| StopSentimentDetectionJob' | |
Instances
newStopSentimentDetectionJob Source #
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:
$sel:jobId:StopSentimentDetectionJob', stopSentimentDetectionJob_jobId - The identifier of the sentiment detection job to stop.
Request Lenses
stopSentimentDetectionJob_jobId :: Lens' StopSentimentDetectionJob Text Source #
The identifier of the sentiment detection job to stop.
Destructuring the Response
data StopSentimentDetectionJobResponse Source #
See: newStopSentimentDetectionJobResponse smart constructor.
Constructors
| StopSentimentDetectionJobResponse' | |
Fields | |
Instances
newStopSentimentDetectionJobResponse Source #
Arguments
| :: Int | |
| -> 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:
$sel:jobId:StopSentimentDetectionJob', stopSentimentDetectionJobResponse_jobId - The identifier of the sentiment detection job to stop.
$sel:jobStatus: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) Source #
The identifier of the sentiment detection job to stop.
stopSentimentDetectionJobResponse_jobStatus :: Lens' StopSentimentDetectionJobResponse (Maybe JobStatus) Source #
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 Source #
The response's http status code.