Amazon Translate · Schema
Amazon Translate Translation Job
Schema representing an Amazon Translate batch translation job resource.
Language ProcessingLocalizationMachine TranslationNLPTranslation
Properties
| Name | Type | Description |
|---|---|---|
| JobId | string | The ID of the translation job. |
| JobName | string | The user-provided name of the translation job. |
| JobStatus | string | The status of the translation job. |
| SourceLanguageCode | string | The language code of the source language. |
| TargetLanguageCodes | array | The language codes of the target languages. |
| InputDataConfig | object | The input data configuration for the translation job. |
| OutputDataConfig | object | The output data configuration for the translation job. |
| DataAccessRoleArn | string | The Amazon Resource Name (ARN) of the IAM role for S3 access. |
| TerminologyNames | array | The names of custom terminologies applied to the job. |
| SubmittedTime | string | The time the translation job was submitted. |
| EndTime | string | The time the translation job ended. |
| Tags | array | A list of tags associated with the translation job. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://translate.amazonaws.com/schemas/translation-job",
"title": "Amazon Translate Translation Job",
"description": "Schema representing an Amazon Translate batch translation job resource.",
"type": "object",
"required": [
"InputDataConfig",
"OutputDataConfig",
"DataAccessRoleArn",
"SourceLanguageCode",
"TargetLanguageCodes"
],
"properties": {
"JobId": {
"type": "string",
"description": "The ID of the translation job.",
"minLength": 1,
"maxLength": 32,
"pattern": "^[a-zA-Z0-9-]+$"
},
"JobName": {
"type": "string",
"description": "The user-provided name of the translation job.",
"minLength": 1,
"maxLength": 256,
"pattern": "^[\\P{M}\\p{M}]{1,256}$"
},
"JobStatus": {
"type": "string",
"description": "The status of the translation job.",
"enum": [
"SUBMITTED",
"IN_PROGRESS",
"COMPLETED",
"COMPLETED_WITH_ERROR",
"FAILED",
"STOP_REQUESTED",
"STOPPED"
]
},
"SourceLanguageCode": {
"type": "string",
"description": "The language code of the source language.",
"minLength": 2,
"maxLength": 5
},
"TargetLanguageCodes": {
"type": "array",
"description": "The language codes of the target languages.",
"items": {
"type": "string",
"minLength": 2,
"maxLength": 5
},
"minItems": 1
},
"InputDataConfig": {
"type": "object",
"description": "The input data configuration for the translation job.",
"required": [
"S3Uri",
"ContentType"
],
"properties": {
"S3Uri": {
"type": "string",
"description": "The URI of the S3 folder containing the input documents.",
"maxLength": 1024,
"pattern": "^s3://.*$"
},
"ContentType": {
"type": "string",
"description": "The content type of the input documents.",
"maxLength": 256
}
}
},
"OutputDataConfig": {
"type": "object",
"description": "The output data configuration for the translation job.",
"required": [
"S3Uri"
],
"properties": {
"S3Uri": {
"type": "string",
"description": "The URI of the S3 folder for the output documents.",
"maxLength": 1024,
"pattern": "^s3://.*$"
}
}
},
"DataAccessRoleArn": {
"type": "string",
"description": "The Amazon Resource Name (ARN) of the IAM role for S3 access.",
"pattern": "^arn:aws:iam::.+:role/.+"
},
"TerminologyNames": {
"type": "array",
"description": "The names of custom terminologies applied to the job.",
"items": {
"type": "string"
}
},
"SubmittedTime": {
"type": "string",
"format": "date-time",
"description": "The time the translation job was submitted."
},
"EndTime": {
"type": "string",
"format": "date-time",
"description": "The time the translation job ended."
},
"Tags": {
"type": "array",
"description": "A list of tags associated with the translation job.",
"items": {
"$ref": "#/$defs/Tag"
}
}
},
"$defs": {
"Tag": {
"type": "object",
"description": "A key-value pair for tagging resources.",
"required": [
"Key",
"Value"
],
"properties": {
"Key": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Value": {
"type": "string",
"minLength": 0,
"maxLength": 256
}
}
}
}
}