StopKeyPhrasesDetectionJob
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.
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 identifier of the key phrases detection job to stop.
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 identifier of the key phrases detection job to stop.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$ - JobStatus
-
Either
STOP_REQUESTEDif the job is currently running, orSTOPPEDif the job was previously stopped with theStopKeyPhrasesDetectionJoboperation.Type: String
Valid Values:
SUBMITTED | IN_PROGRESS | COMPLETED | 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
- InvalidRequestException
-
The request is invalid.
HTTP Status Code: 400
- JobNotFoundException
-
The specified job was not found. Check the job ID and try 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:
