Documentation

Provides information about a dominant language detection job.

See: newDominantLanguageDetectionJobProperties smart constructor.

Create a value of DominantLanguageDetectionJobProperties 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:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_jobId - The identifier assigned to the dominant language detection job.

$sel:jobArn:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the dominant language 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>:dominant-language-detection-job/<job-id>

The following is an example job ARN:

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

$sel:jobName:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_jobName - The name that you assigned to the dominant language detection job.

$sel:inputDataConfig:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the dominant language detection job.

$sel:vpcConfig:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.

$sel:volumeKmsKeyId:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_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:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_endTime - The time that the dominant language detection job completed.

$sel:outputDataConfig:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the dominant language detection job.

$sel:dataAccessRoleArn:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

$sel:jobStatus:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_jobStatus - The current status of the dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure.

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

$sel:submitTime:DominantLanguageDetectionJobProperties', dominantLanguageDetectionJobProperties_submitTime - The time that the dominant language detection job was submitted for processing.

The identifier assigned to the dominant language detection job.

The Amazon Resource Name (ARN) of the dominant language 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>:dominant-language-detection-job/<job-id>

The following is an example job ARN:

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

The name that you assigned to the dominant language detection job.

The input data configuration that you supplied when you created the dominant language detection job.

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language 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 dominant language detection job completed.

The output data configuration that you supplied when you created the dominant language detection job.

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

The current status of the dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure.

A description for the status of a job.

The time that the dominant language detection job was submitted for processing.