| 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.StopEntitiesDetectionJob
Description
Stops an entities 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 StopEntitiesDetectionJob = StopEntitiesDetectionJob' {}
- newStopEntitiesDetectionJob :: Text -> StopEntitiesDetectionJob
- stopEntitiesDetectionJob_jobId :: Lens' StopEntitiesDetectionJob Text
- data StopEntitiesDetectionJobResponse = StopEntitiesDetectionJobResponse' {}
- newStopEntitiesDetectionJobResponse :: Int -> StopEntitiesDetectionJobResponse
- stopEntitiesDetectionJobResponse_jobId :: Lens' StopEntitiesDetectionJobResponse (Maybe Text)
- stopEntitiesDetectionJobResponse_jobStatus :: Lens' StopEntitiesDetectionJobResponse (Maybe JobStatus)
- stopEntitiesDetectionJobResponse_httpStatus :: Lens' StopEntitiesDetectionJobResponse Int
Creating a Request
data StopEntitiesDetectionJob Source #
See: newStopEntitiesDetectionJob smart constructor.
Constructors
| StopEntitiesDetectionJob' | |
Instances
newStopEntitiesDetectionJob Source #
Create a value of StopEntitiesDetectionJob 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:StopEntitiesDetectionJob', stopEntitiesDetectionJob_jobId - The identifier of the entities detection job to stop.
Request Lenses
stopEntitiesDetectionJob_jobId :: Lens' StopEntitiesDetectionJob Text Source #
The identifier of the entities detection job to stop.
Destructuring the Response
data StopEntitiesDetectionJobResponse Source #
See: newStopEntitiesDetectionJobResponse smart constructor.
Constructors
| StopEntitiesDetectionJobResponse' | |
Instances
newStopEntitiesDetectionJobResponse Source #
Create a value of StopEntitiesDetectionJobResponse 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:StopEntitiesDetectionJob', stopEntitiesDetectionJobResponse_jobId - The identifier of the entities detection job to stop.
$sel:jobStatus:StopEntitiesDetectionJobResponse', stopEntitiesDetectionJobResponse_jobStatus - Either STOP_REQUESTED if the job is currently running, or STOPPED if
the job was previously stopped with the StopEntitiesDetectionJob
operation.
$sel:httpStatus:StopEntitiesDetectionJobResponse', stopEntitiesDetectionJobResponse_httpStatus - The response's http status code.
Response Lenses
stopEntitiesDetectionJobResponse_jobId :: Lens' StopEntitiesDetectionJobResponse (Maybe Text) Source #
The identifier of the entities detection job to stop.
stopEntitiesDetectionJobResponse_jobStatus :: Lens' StopEntitiesDetectionJobResponse (Maybe JobStatus) Source #
Either STOP_REQUESTED if the job is currently running, or STOPPED if
the job was previously stopped with the StopEntitiesDetectionJob
operation.
stopEntitiesDetectionJobResponse_httpStatus :: Lens' StopEntitiesDetectionJobResponse Int Source #
The response's http status code.