AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Provides information about a topic detection job.

Inheritance Hierarchy

System.Object
  Amazon.Comprehend.Model.TopicsDetectionJobProperties

Namespace: Amazon.Comprehend.Model
Assembly: AWSSDK.Comprehend.dll
Version: 3.x.y.z

Syntax

C#
public class TopicsDetectionJobProperties

The TopicsDetectionJobProperties type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property DataAccessRoleArn System.String

Gets and sets the property DataAccessRoleArn.

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

Public Property EndTime System.DateTime

Gets and sets the property EndTime.

The time that the topic detection job was completed.

Public Property InputDataConfig Amazon.Comprehend.Model.InputDataConfig

Gets and sets the property InputDataConfig.

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

Public Property JobArn System.String

Gets and sets the property JobArn.

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

Public Property JobId System.String

Gets and sets the property JobId.

The identifier assigned to the topic detection job.

Public Property JobName System.String

Gets and sets the property JobName.

The name of the topic detection job.

Public Property JobStatus Amazon.Comprehend.JobStatus

Gets and sets the property 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.

Public Property Message System.String

Gets and sets the property Message.

A description for the status of a job.

Public Property NumberOfTopics System.Int32

Gets and sets the property NumberOfTopics.

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

Public Property OutputDataConfig Amazon.Comprehend.Model.OutputDataConfig

Gets and sets the property OutputDataConfig.

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

Public Property SubmitTime System.DateTime

Gets and sets the property SubmitTime.

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

Public Property VolumeKmsKeyId System.String

Gets and sets the property VolumeKmsKeyId.

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"

Public Property VpcConfig Amazon.Comprehend.Model.VpcConfig

Gets and sets the property 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5