Documentation

Provides information about a topic detection job.

See: newTopicsDetectionJobProperties smart constructor.

Create a value of TopicsDetectionJobProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:TopicsDetectionJobProperties', topicsDetectionJobProperties_jobId - The identifier assigned to the topic detection job.

$sel:jobArn:TopicsDetectionJobProperties', topicsDetectionJobProperties_jobArn - 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, 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

$sel:jobName:TopicsDetectionJobProperties', topicsDetectionJobProperties_jobName - The name of the topic detection job.

$sel:inputDataConfig:TopicsDetectionJobProperties', topicsDetectionJobProperties_inputDataConfig - The input data configuration supplied when you created the topic detection job.

$sel:vpcConfig:TopicsDetectionJobProperties', topicsDetectionJobProperties_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.

$sel:volumeKmsKeyId:TopicsDetectionJobProperties', topicsDetectionJobProperties_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"

$sel:endTime:TopicsDetectionJobProperties', topicsDetectionJobProperties_endTime - The time that the topic detection job was completed.

$sel:outputDataConfig:TopicsDetectionJobProperties', topicsDetectionJobProperties_outputDataConfig - The output data configuration supplied when you created the topic detection job.

$sel:dataAccessRoleArn:TopicsDetectionJobProperties', topicsDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.

$sel:numberOfTopics:TopicsDetectionJobProperties', topicsDetectionJobProperties_numberOfTopics - The number of topics to detect supplied when you created the topic detection job. The default is 10.

$sel:jobStatus:TopicsDetectionJobProperties', topicsDetectionJobProperties_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.

$sel:message:TopicsDetectionJobProperties', topicsDetectionJobProperties_message - A description for the status of a job.

$sel:submitTime:TopicsDetectionJobProperties', topicsDetectionJobProperties_submitTime - The time that the topic detection job was submitted for processing.

The identifier assigned to the topic detection job.

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, 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

The name of the topic detection job.

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

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.

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"

The time that the topic detection job was completed.

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

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

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

The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

A description for the status of a job.

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