TopicsDetectionJobProperties

The Amazon Resource Name (ARN) of the 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

The time that the topic detection job was completed.

Type: Timestamp

Required: No

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

Type: InputDataConfig object

Required: No

The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, AWS Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-*[a-zA-Z0-9])*((/dataset/[a-zA-Z0-9](-*[a-zA-Z0-9])*)|(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*))?

Required: No

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

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

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

A description for the status of a job.

Type: String

Required: No

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

Type: Integer

Required: No

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

Type: OutputDataConfig object

Required: No

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

Type: Timestamp

Required: No

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:

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^\p{ASCII}+$

Required: No

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