Amazon Comprehend
Developer Guide

TopicsDetectionJobProperties

Provides information about a topic detection job.

Contents

DataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

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

Required: No

EndTime

The time that the topic detection job was completed.

Type: Timestamp

Required: No

InputDataConfig

The input data configuration supplied when you created the topic detection job.

Type: InputDataConfig object

Required: No

JobId

The identifier assigned to the topic detection job.

Type: String

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

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

Required: No

JobName

The name of the topic 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 topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

Type: String

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

Required: No

Message

A description for the status of a job.

Type: String

Required: No

NumberOfTopics

The number of topics to detect supplied when you created the topic detection job. The default is 10.

Type: Integer

Required: No

OutputDataConfig

The output data configuration supplied when you created the topic detection job.

Type: OutputDataConfig object

Required: No

SubmitTime

The time that the topic detection job was submitted for processing.

Type: Timestamp

Required: No

VolumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Type: String

Length Constraints: Maximum length of 2048.

Required: No

VpcConfig

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.

Type: VpcConfig object

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: