Amazon Comprehend
Developer Guide

KeyPhrasesDetectionJobProperties

Provides information about a key phrases detection job.

Contents

DataAccessRoleArn

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Type: String

Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

Required: No

EndTime

The time that the key phrases detection job completed.

Type: Timestamp

Required: No

InputDataConfig

The input data configuration that you supplied when you created the key phrases detection job.

Type: InputDataConfig object

Required: No

JobId

The identifier assigned to the key phrases detection job.

Type: String

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

Required: No

JobName

The name that you assigned the key phrases detection job.

Type: String

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

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

Required: No

JobStatus

The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.

Type: String

Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED | STOP_REQUESTED | STOPPED

Required: No

LanguageCode

The language code of the input documents.

Type: String

Valid Values: en | es

Required: No

Message

A description of the status of a job.

Type: String

Required: No

OutputDataConfig

The output data configuration that you supplied when you created the key phrases detection job.

Type: OutputDataConfig object

Required: No

SubmitTime

The time that the key phrases detection job was submitted for processing.

Type: Timestamp

Required: No

See Also

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

On this page: