Interface TopicsDetectionJobProperties

Provides information about a topic detection job.

interface TopicsDetectionJobProperties {
    DataAccessRoleArn?: string;
    EndTime?: Date;
    InputDataConfig?: InputDataConfig;
    JobArn?: string;
    JobId?: string;
    JobName?: string;
    JobStatus?: JobStatus;
    Message?: string;
    NumberOfTopics?: number;
    OutputDataConfig?: OutputDataConfig;
    SubmitTime?: Date;
    VolumeKmsKeyId?: string;
    VpcConfig?: VpcConfig;
}

Properties

DataAccessRoleArn? EndTime? InputDataConfig? JobArn? JobId? JobName? JobStatus? Message? NumberOfTopics? OutputDataConfig? SubmitTime? VolumeKmsKeyId? VpcConfig?

Properties

Optional DataAccessRoleArn

DataAccessRoleArn?: string

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

Optional EndTime

EndTime?: Date

The time that the topic detection job was completed.

Optional InputDataConfig

InputDataConfig?: InputDataConfig

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

Optional JobArn

JobArn?: string

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

arn::comprehend:::topics-detection-job/

The following is an example job ARN:

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

Optional JobId

JobId?: string

The identifier assigned to the topic detection job.

Optional JobName

JobName?: string

The name of the topic detection job.

Optional JobStatus

JobStatus?: 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.

Optional Message

Message?: string

A description for the status of a job.

Optional NumberOfTopics

NumberOfTopics?: number

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

Optional OutputDataConfig

OutputDataConfig?: OutputDataConfig

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

Optional SubmitTime

SubmitTime?: Date

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

Optional VolumeKmsKeyId

VolumeKmsKeyId?: string

ID for the Amazon Web Services 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"

Optional VpcConfig

VpcConfig?: 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.

Settings

Member Visibility

Theme

On This Page