comprehend/aws.sdk.kotlin.services.comprehend.model/TopicsDetectionJobProperties/Builder

Builder

class Builder

Properties

dataAccessRoleArn

var dataAccessRoleArn: String?

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

endTime

var endTime: Instant?

The time that the topic detection job was completed.

inputDataConfig

var inputDataConfig: InputDataConfig?

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

jobArn

var 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:

jobId

var jobId: String?

The identifier assigned to the topic detection job.

jobName

var jobName: String?

The name of the topic detection job.

jobStatus

var 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.

message

var message: String?

A description for the status of a job.

numberOfTopics

var numberOfTopics: Int?

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

outputDataConfig

var outputDataConfig: OutputDataConfig?

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

submitTime

var submitTime: Instant?

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

volumeKmsKeyId

var 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:

vpcConfig

var 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.

Functions

inputDataConfig

fun inputDataConfig(block: InputDataConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.comprehend.model.InputDataConfig inside the given block

outputDataConfig

fun outputDataConfig(block: OutputDataConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.comprehend.model.OutputDataConfig inside the given block

vpcConfig

fun vpcConfig(block: VpcConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.comprehend.model.VpcConfig inside the given block