Amazon Comprehend
Developer Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.

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.


The identifier that Amazon Comprehend generated for the job. The StartKeyPhrasesDetectionJob operation returns this identifier in its response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Required: Yes

Response Syntax

{ "KeyPhrasesDetectionJobProperties": { "DataAccessRoleArn": "string", "EndTime": number, "InputDataConfig": { "InputFormat": "string", "S3Uri": "string" }, "JobId": "string", "JobName": "string", "JobStatus": "string", "LanguageCode": "string", "Message": "string", "OutputDataConfig": { "KmsKeyId": "string", "S3Uri": "string" }, "SubmitTime": number, "VolumeKmsKeyId": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "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.


An object that contains the properties associated with a key phrases detection job.

Type: KeyPhrasesDetectionJobProperties object


For information about the errors that are common to all actions, see Common Errors.


An internal server error occurred. Retry your request.

HTTP Status Code: 500


The request is invalid.

HTTP Status Code: 400


The specified job was not found. Check the job ID and try again.

HTTP Status Code: 400


The number of requests exceeds the limit. Resubmit your request later.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: