StopTextTranslationJob
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.
Request Syntax
{
"JobId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- JobId
-
The job ID of the job to be stopped.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$Required: Yes
Response Syntax
{
"JobId": "string",
"JobStatus": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- JobId
-
The job ID of the stopped batch translation job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$ - JobStatus
-
The status of the designated job. Upon successful completion, the job's status will be
STOPPED.Type: String
Valid Values:
SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERROR | FAILED | STOP_REQUESTED | STOPPED
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request.
HTTP Status Code: 400
- TooManyRequestsException
-
You have made too many requests within a short period of time. Wait for a short time and then try your request again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
