| 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.StopKeyPhrasesDetectionJob
Description
Stops a key phrases 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
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 StopKeyPhrasesDetectionJob = StopKeyPhrasesDetectionJob' {}
- newStopKeyPhrasesDetectionJob :: Text -> StopKeyPhrasesDetectionJob
- stopKeyPhrasesDetectionJob_jobId :: Lens' StopKeyPhrasesDetectionJob Text
- data StopKeyPhrasesDetectionJobResponse = StopKeyPhrasesDetectionJobResponse' {}
- newStopKeyPhrasesDetectionJobResponse :: Int -> StopKeyPhrasesDetectionJobResponse
- stopKeyPhrasesDetectionJobResponse_jobId :: Lens' StopKeyPhrasesDetectionJobResponse (Maybe Text)
- stopKeyPhrasesDetectionJobResponse_jobStatus :: Lens' StopKeyPhrasesDetectionJobResponse (Maybe JobStatus)
- stopKeyPhrasesDetectionJobResponse_httpStatus :: Lens' StopKeyPhrasesDetectionJobResponse Int
Creating a Request
data StopKeyPhrasesDetectionJob Source #
See: newStopKeyPhrasesDetectionJob smart constructor.
Constructors
| StopKeyPhrasesDetectionJob' | |
Instances
newStopKeyPhrasesDetectionJob Source #
Create a value of StopKeyPhrasesDetectionJob 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:StopKeyPhrasesDetectionJob', stopKeyPhrasesDetectionJob_jobId - The identifier of the key phrases detection job to stop.
Request Lenses
stopKeyPhrasesDetectionJob_jobId :: Lens' StopKeyPhrasesDetectionJob Text Source #
The identifier of the key phrases detection job to stop.
Destructuring the Response
data StopKeyPhrasesDetectionJobResponse Source #
See: newStopKeyPhrasesDetectionJobResponse smart constructor.
Constructors
| StopKeyPhrasesDetectionJobResponse' | |
Fields | |
Instances
newStopKeyPhrasesDetectionJobResponse Source #
Arguments
| :: Int | |
| -> StopKeyPhrasesDetectionJobResponse |
Create a value of StopKeyPhrasesDetectionJobResponse 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:StopKeyPhrasesDetectionJob', stopKeyPhrasesDetectionJobResponse_jobId - The identifier of the key phrases detection job to stop.
$sel:jobStatus:StopKeyPhrasesDetectionJobResponse', stopKeyPhrasesDetectionJobResponse_jobStatus - Either STOP_REQUESTED if the job is currently running, or STOPPED if
the job was previously stopped with the StopKeyPhrasesDetectionJob
operation.
$sel:httpStatus:StopKeyPhrasesDetectionJobResponse', stopKeyPhrasesDetectionJobResponse_httpStatus - The response's http status code.
Response Lenses
stopKeyPhrasesDetectionJobResponse_jobId :: Lens' StopKeyPhrasesDetectionJobResponse (Maybe Text) Source #
The identifier of the key phrases detection job to stop.
stopKeyPhrasesDetectionJobResponse_jobStatus :: Lens' StopKeyPhrasesDetectionJobResponse (Maybe JobStatus) Source #
Either STOP_REQUESTED if the job is currently running, or STOPPED if
the job was previously stopped with the StopKeyPhrasesDetectionJob
operation.
stopKeyPhrasesDetectionJobResponse_httpStatus :: Lens' StopKeyPhrasesDetectionJobResponse Int Source #
The response's http status code.