See: newStartTopicsDetectionJob smart constructor.

Create a value of StartTopicsDetectionJob 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:jobName:StartTopicsDetectionJob', startTopicsDetectionJob_jobName - The identifier of the job.

$sel:vpcConfig:StartTopicsDetectionJob', startTopicsDetectionJob_vpcConfig - Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.

$sel:volumeKmsKeyId:StartTopicsDetectionJob', startTopicsDetectionJob_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:numberOfTopics:StartTopicsDetectionJob', startTopicsDetectionJob_numberOfTopics - The number of topics to detect.

$sel:clientRequestToken:StartTopicsDetectionJob', startTopicsDetectionJob_clientRequestToken - A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

$sel:tags:StartTopicsDetectionJob', startTopicsDetectionJob_tags - Tags to be associated with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

$sel:inputDataConfig:StartTopicsDetectionJob', startTopicsDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.

$sel:outputDataConfig:StartTopicsDetectionJob', startTopicsDetectionJob_outputDataConfig - Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

$sel:dataAccessRoleArn:StartTopicsDetectionJob', startTopicsDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

The identifier of the job.

Configuration parameters for an optional 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 number of topics to detect.

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Tags to be associated with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Specifies the format and location of the input data for the job.

Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

See: newStartTopicsDetectionJobResponse smart constructor.

Create a value of StartTopicsDetectionJobResponse 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:StartTopicsDetectionJobResponse', startTopicsDetectionJobResponse_jobId - The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.

$sel:jobArn:StartTopicsDetectionJobResponse', startTopicsDetectionJobResponse_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:document-classification-job/1234abcd12ab34cd56ef1234567890ab

$sel:jobStatus:StartTopicsDetectionJobResponse', startTopicsDetectionJobResponse_jobStatus - The status of the job:

• SUBMITTED - The job has been received and is queued for processing.
• IN_PROGRESS - Amazon Comprehend is processing the job.
• COMPLETED - The job was successfully completed and the output is available.
• FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob operation.

$sel:httpStatus:StartTopicsDetectionJobResponse', startTopicsDetectionJobResponse_httpStatus - The response's http status code.

The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.

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:document-classification-job/1234abcd12ab34cd56ef1234567890ab

The status of the job:

• SUBMITTED - The job has been received and is queued for processing.
• IN_PROGRESS - Amazon Comprehend is processing the job.
• COMPLETED - The job was successfully completed and the output is available.
• FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob operation.

The response's http status code.