Amazon Comprehend · JSON Structure
Openapi.Yml Dominant Language Detection Job Properties Structure
Provides information about a dominant language detection job.
Type: object
Properties: 12
Machine LearningNatural Language ProcessingNLPText Analysis
DominantLanguageDetectionJobProperties is a JSON Structure definition published by Amazon Comprehend, describing 12 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Properties
JobId
JobArn
JobName
JobStatus
Message
SubmitTime
EndTime
InputDataConfig
OutputDataConfig
DataAccessRoleArn
VolumeKmsKeyId
VpcConfig
Meta-schema: https://json-structure.org/meta/core/v0/#
JSON Structure
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-structure/openapi.yml-dominant-language-detection-job-properties-structure.json",
"name": "DominantLanguageDetectionJobProperties",
"description": "Provides information about a dominant language detection job.",
"type": "object",
"properties": {
"JobId": {
"allOf": [
{
"$ref": "#/components/schemas/JobId"
},
{
"description": "The identifier assigned to the dominant language detection job."
}
]
},
"JobArn": {
"allOf": [
{
"$ref": "#/components/schemas/ComprehendArn"
},
{
"description": "<p>The Amazon Resource Name (ARN) of the dominant language 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:</p> <p> <code>arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id></code> </p> <p>The following is an example job ARN:</p> <p> <code>arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab</code> </p>"
}
]
},
"JobName": {
"allOf": [
{
"$ref": "#/components/schemas/JobName"
},
{
"description": "The name that you assigned to the dominant language detection job."
}
]
},
"JobStatus": {
"allOf": [
{
"$ref": "#/components/schemas/JobStatus"
},
{
"description": "The current status of the dominant language detection job. If the status is <code>FAILED</code>, the <code>Message</code> field shows the reason for the failure."
}
]
},
"Message": {
"allOf": [
{
"$ref": "#/components/schemas/AnyLengthString"
},
{
"description": "A description for the status of a job."
}
]
},
"SubmitTime": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The time that the dominant language detection job was submitted for processing."
}
]
},
"EndTime": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The time that the dominant language detection job completed."
}
]
},
"InputDataConfig": {
"allOf": [
{
"$ref": "#/components/schemas/InputDataConfig"
},
{
"description": "The input data configuration that you supplied when you created the dominant language detection job."
}
]
},
"OutputDataConfig": {
"allOf": [
{
"$ref": "#/components/schemas/OutputDataConfig"
},
{
"description": "The output data configuration that you supplied when you created the dominant language detection job."
}
]
},
"DataAccessRoleArn": {
"allOf": [
{
"$ref": "#/components/schemas/IamRoleArn"
},
{
"description": "The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data."
}
]
},
"VolumeKmsKeyId": {
"allOf": [
{
"$ref": "#/components/schemas/KmsKeyId"
},
{
"description": "<p>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:</p> <ul> <li> <p>KMS Key ID: <code>\"1234abcd-12ab-34cd-56ef-1234567890ab\"</code> </p> </li> <li> <p>Amazon Resource Name (ARN) of a KMS Key: <code>\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"</code> </p> </li> </ul>"
}
]
},
"VpcConfig": {
"allOf": [
{
"$ref": "#/components/schemas/VpcConfig"
},
{
"description": " 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 <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html\">Amazon VPC</a>. "
}
]
}
}
}