Skip to content

Stop Key Phrases Detection Job

comprehend_stop_key_phrases_detection_job R Documentation

Stops a key phrases detection job in progress

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 stop_dominant_language_detection_job operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Usage

comprehend_stop_key_phrases_detection_job(JobId)

Arguments

JobId

[required] The identifier of the key phrases detection job to stop.

Value

A list with the following syntax:

list(
  JobId = "string",
  JobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"STOP_REQUESTED"|"STOPPED"
)

Request syntax

svc$stop_key_phrases_detection_job(
  JobId = "string"
)