| 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.Translate.StopTextTranslationJob
Description
Stops an asynchronous batch translation job that is in progress.
If the job's state is IN_PROGRESS, the job will be 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 put into the STOPPED state.
Asynchronous batch translation jobs are started with the
StartTextTranslationJob operation. You can use the
DescribeTextTranslationJob or ListTextTranslationJobs operations to get
a batch translation job's JobId.
Synopsis
- data StopTextTranslationJob = StopTextTranslationJob' {}
- newStopTextTranslationJob :: Text -> StopTextTranslationJob
- stopTextTranslationJob_jobId :: Lens' StopTextTranslationJob Text
- data StopTextTranslationJobResponse = StopTextTranslationJobResponse' {}
- newStopTextTranslationJobResponse :: Int -> StopTextTranslationJobResponse
- stopTextTranslationJobResponse_jobId :: Lens' StopTextTranslationJobResponse (Maybe Text)
- stopTextTranslationJobResponse_jobStatus :: Lens' StopTextTranslationJobResponse (Maybe JobStatus)
- stopTextTranslationJobResponse_httpStatus :: Lens' StopTextTranslationJobResponse Int
Creating a Request
data StopTextTranslationJob Source #
See: newStopTextTranslationJob smart constructor.
Constructors
| StopTextTranslationJob' | |
Instances
newStopTextTranslationJob Source #
Arguments
| :: Text | |
| -> StopTextTranslationJob |
Create a value of StopTextTranslationJob 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:StopTextTranslationJob', stopTextTranslationJob_jobId - The job ID of the job to be stopped.
Request Lenses
stopTextTranslationJob_jobId :: Lens' StopTextTranslationJob Text Source #
The job ID of the job to be stopped.
Destructuring the Response
data StopTextTranslationJobResponse Source #
See: newStopTextTranslationJobResponse smart constructor.
Constructors
| StopTextTranslationJobResponse' | |
Instances
newStopTextTranslationJobResponse Source #
Create a value of StopTextTranslationJobResponse 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:StopTextTranslationJob', stopTextTranslationJobResponse_jobId - The job ID of the stopped batch translation job.
$sel:jobStatus:StopTextTranslationJobResponse', stopTextTranslationJobResponse_jobStatus - The status of the designated job. Upon successful completion, the job's
status will be STOPPED.
$sel:httpStatus:StopTextTranslationJobResponse', stopTextTranslationJobResponse_httpStatus - The response's http status code.
Response Lenses
stopTextTranslationJobResponse_jobId :: Lens' StopTextTranslationJobResponse (Maybe Text) Source #
The job ID of the stopped batch translation job.
stopTextTranslationJobResponse_jobStatus :: Lens' StopTextTranslationJobResponse (Maybe JobStatus) Source #
The status of the designated job. Upon successful completion, the job's
status will be STOPPED.
stopTextTranslationJobResponse_httpStatus :: Lens' StopTextTranslationJobResponse Int Source #
The response's http status code.