Module Smaws_Client_Translate.Types

type nonrec resource_name = string
type nonrec parallel_data_status =
  1. | FAILED
  2. | DELETING
  3. | ACTIVE
  4. | UPDATING
  5. | CREATING
type nonrec timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec update_parallel_data_response = {
  1. latest_update_attempt_at : timestamp option;
    (*

    The time that the most recent update was attempted.

    *)
  2. latest_update_attempt_status : parallel_data_status option;
    (*

    The status of the parallel data update attempt. When the updated parallel data resource is ready for you to use, the status is ACTIVE.

    *)
  3. status : parallel_data_status option;
    (*

    The status of the parallel data resource that you are attempting to update. Your update request is accepted only if this status is either ACTIVE or FAILED.

    *)
  4. name : resource_name option;
    (*

    The name of the parallel data resource being updated.

    *)
}
type nonrec description = string
type nonrec s3_uri = string
type nonrec parallel_data_format =
  1. | TMX
  2. | CSV
  3. | TSV
type nonrec parallel_data_config = {
  1. format : parallel_data_format option;
    (*

    The format of the parallel data input file.

    *)
  2. s3_uri : s3_uri option;
    (*

    The URI of the Amazon S3 folder that contains the parallel data input file. The folder must be in the same Region as the API endpoint you are calling.

    *)
}

Specifies the format and S3 location of the parallel data input file.

type nonrec client_token_string = string
type nonrec update_parallel_data_request = {
  1. client_token : client_token_string;
    (*

    A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.

    *)
  2. parallel_data_config : parallel_data_config;
    (*

    Specifies the format and S3 location of the parallel data input file.

    *)
  3. description : description option;
    (*

    A custom description for the parallel data resource in Amazon Translate.

    *)
  4. name : resource_name;
    (*

    The name of the parallel data resource being updated.

    *)
}
type nonrec string_ = string
type nonrec too_many_requests_exception = {
  1. message : string_ option;
}

You have made too many requests within a short period of time. Wait for a short time and then try your request again.

type nonrec resource_not_found_exception = {
  1. message : string_ option;
}

The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request.

type nonrec limit_exceeded_exception = {
  1. message : string_ option;
}

The specified limit has been exceeded. Review your request and retry it with a quantity below the stated limit.

type nonrec invalid_request_exception = {
  1. message : string_ option;
}

The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.

type nonrec invalid_parameter_value_exception = {
  1. message : string_ option;
}

The value of the parameter is not valid. Review the value of the parameter you are using to correct it, and then retry your operation.

type nonrec internal_server_exception = {
  1. message : string_ option;
}

An internal server error occurred. Retry your request.

type nonrec conflict_exception = {
  1. message : string_ option;
}

There was a conflict processing the request. Try your request again.

type nonrec concurrent_modification_exception = {
  1. message : string_ option;
}

Another modification is being made. That modification must complete before you can make your change.

type nonrec untag_resource_response = unit
type nonrec resource_arn = string
type nonrec tag_key = string
type nonrec tag_key_list = tag_key list
type nonrec untag_resource_request = {
  1. tag_keys : tag_key_list;
    (*

    The initial part of a key-value pair that forms a tag being removed from a given resource. Keys must be unique and cannot be duplicated for a particular resource.

    *)
  2. resource_arn : resource_arn;
    (*

    The Amazon Resource Name (ARN) of the given Amazon Translate resource from which you want to remove the tags.

    *)
}
type nonrec language_code_string = string
type nonrec unsupported_language_pair_exception = {
  1. target_language_code : language_code_string option;
    (*

    The language code for the language of the translated text.

    *)
  2. source_language_code : language_code_string option;
    (*

    The language code for the language of the input text.

    *)
  3. message : string_ option;
}

Amazon Translate does not support translation from the language of the source text into the requested target language. For more information, see Supported languages.

type nonrec unsupported_display_language_code_exception = {
  1. display_language_code : language_code_string option;
    (*

    Language code passed in with the request.

    *)
  2. message : string_ option;
}

Requested display language code is not supported.

type nonrec unbounded_length_string = string
type nonrec formality =
  1. | INFORMAL
  2. | FORMAL
type nonrec profanity =
  1. | MASK
type nonrec brevity =
  1. | ON
type nonrec translation_settings = {
  1. brevity : brevity option;
    (*

    When you turn on brevity, Amazon Translate reduces the length of the translation output for most translations (when compared with the same translation with brevity turned off). By default, brevity is turned off.

    If you turn on brevity for a translation request with an unsupported language pair, the translation proceeds with the brevity setting turned off.

    For the language pairs that brevity supports, see Using brevity in the Amazon Translate Developer Guide.

    *)
  2. profanity : profanity option;
    (*

    You can enable the profanity setting if you want to mask profane words and phrases in your translation output.

    To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.

    Amazon Translate doesn't detect profanity in all of its supported languages. For languages that don't support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.

    If you specify multiple target languages for the job, all the target languages must support profanity masking. If any of the target languages don't support profanity masking, the translation job won't mask profanity for any target language.

    *)
  3. formality : formality option;
    (*

    You can specify the desired level of formality for translations to supported target languages. The formality setting controls the level of formal language usage (also known as register) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.

    If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported target language.

    For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.

    *)
}

Settings to configure your translation output. You can configure the following options:

  • Brevity: reduces the length of the translation output for most translations. Available for TranslateText only.
  • Formality: sets the formality level of the translation output.
  • Profanity: masks profane words and phrases in the translation output.
type nonrec translated_text_string = string
type nonrec translated_document_content = bytes
type nonrec translated_document = {
  1. content : translated_document_content;
    (*

    The document containing the translated content.

    *)
}

The translated content.

type nonrec term = {
  1. target_text : string_ option;
    (*

    The target text of the term being translated by the custom terminology.

    *)
  2. source_text : string_ option;
    (*

    The source text of the term being translated by the custom terminology.

    *)
}

The term being translated by the custom terminology.

type nonrec term_list = term list
type nonrec applied_terminology = {
  1. terms : term_list option;
    (*

    The specific terms of the custom terminology applied to the input text by Amazon Translate for the translated text response. A maximum of 250 terms will be returned, and the specific terms applied will be the first 250 terms in the source text.

    *)
  2. name : resource_name option;
    (*

    The name of the custom terminology applied to the input text by Amazon Translate for the translated text response.

    *)
}

The custom terminology applied to the input text by Amazon Translate for the translated text response. This is optional in the response and will only be present if you specified terminology input in the request. Currently, only one terminology can be applied per TranslateText request.

type nonrec applied_terminology_list = applied_terminology list
type nonrec translate_text_response = {
  1. applied_settings : translation_settings option;
    (*

    Optional settings that modify the translation output.

    *)
  2. applied_terminologies : applied_terminology_list option;
    (*

    The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.

    *)
  3. target_language_code : language_code_string;
    (*

    The language code for the language of the target text.

    *)
  4. source_language_code : language_code_string;
    (*

    The language code for the language of the source text.

    *)
  5. translated_text : translated_text_string;
    (*

    The translated text.

    *)
}
type nonrec bounded_length_string = string
type nonrec resource_name_list = resource_name list
type nonrec translate_text_request = {
  1. settings : translation_settings option;
    (*

    Settings to configure your translation output. You can configure the following options:

    • Brevity: reduces the length of the translated output for most translations.
    • Formality: sets the formality level of the output text.
    • Profanity: masks profane words and phrases in your translation output.
    *)
  2. target_language_code : language_code_string;
    (*

    The language code requested for the language of the target text. For a list of language codes, see Supported languages.

    *)
  3. source_language_code : language_code_string;
    (*

    The language code for the language of the source text. For a list of language codes, see Supported languages.

    To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.

    If you specify auto, you must send the TranslateText request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.

    *)
  4. terminology_names : resource_name_list option;
    (*

    The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.

    Use the ListTerminologies operation to get the available terminology lists.

    For more information about custom terminology lists, see Custom terminology.

    *)
  5. text : bounded_length_string;
    (*

    The text to translate. The text string can be a maximum of 10,000 bytes long. Depending on your character set, this may be fewer than 10,000 characters.

    *)
}
type nonrec text_size_limit_exceeded_exception = {
  1. message : string_ option;
}

The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.

type nonrec service_unavailable_exception = {
  1. message : string_ option;
}

The Amazon Translate service is temporarily unavailable. Wait a bit and then retry your request.

type nonrec detected_language_low_confidence_exception = {
  1. detected_language_code : language_code_string option;
    (*

    The language code of the auto-detected language from Amazon Comprehend.

    *)
  2. message : string_ option;
}

The confidence that Amazon Comprehend accurately detected the source language is low. If a low confidence level is acceptable for your application, you can use the language in the exception to call Amazon Translate again. For more information, see the DetectDominantLanguage operation in the Amazon Comprehend Developer Guide.

type nonrec translate_document_response = {
  1. applied_settings : translation_settings option;
  2. applied_terminologies : applied_terminology_list option;
    (*

    The names of the custom terminologies applied to the input text by Amazon Translate to produce the translated text document.

    *)
  3. target_language_code : language_code_string;
    (*

    The language code of the translated document.

    *)
  4. source_language_code : language_code_string;
    (*

    The language code of the source document.

    *)
  5. translated_document : translated_document;
    (*

    The document containing the translated content. The document format matches the source document format.

    *)
}
type nonrec document_content = bytes
type nonrec content_type = string
type nonrec document = {
  1. content_type : content_type;
    (*

    Describes the format of the document. You can specify one of the following:

    • text/html - The input data consists of HTML content. Amazon Translate translates only the text in the HTML element.
    • text/plain - The input data consists of unformatted text. Amazon Translate translates every character in the content.
    • application/vnd.openxmlformats-officedocument.wordprocessingml.document - The input data consists of a Word document (.docx).
    *)
  2. content : document_content;
    (*

    The Contentfield type is Binary large object (blob). This object contains the document content converted into base64-encoded binary data. If you use one of the AWS SDKs, the SDK performs the Base64-encoding on this field before sending the request.

    *)
}

The content and content type of a document.

type nonrec translate_document_request = {
  1. settings : translation_settings option;
    (*

    Settings to configure your translation output. You can configure the following options:

    • Brevity: not supported.
    • Formality: sets the formality level of the output text.
    • Profanity: masks profane words and phrases in your translation output.
    *)
  2. target_language_code : language_code_string;
    (*

    The language code requested for the translated document. For a list of supported language codes, see Supported languages.

    *)
  3. source_language_code : language_code_string;
    (*

    The language code for the language of the source text. For a list of supported language codes, see Supported languages.

    To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.

    If you specify auto, you must send the TranslateDocument request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.

    *)
  4. terminology_names : resource_name_list option;
    (*

    The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.

    Use the ListTerminologies operation to get the available terminology lists.

    For more information about custom terminology lists, see Custom terminology.

    *)
  5. document : document;
    (*

    The content and content type for the document to be translated. The document size must not exceed 100 KB.

    *)
}
type nonrec too_many_tags_exception = {
  1. resource_arn : resource_arn option;
  2. message : string_ option;
}

You have added too many tags to this resource. The maximum is 50 tags.

type nonrec job_id = string
type nonrec job_name = string
type nonrec job_status =
  1. | STOPPED
  2. | STOP_REQUESTED
  3. | FAILED
  4. | COMPLETED_WITH_ERROR
  5. | COMPLETED
  6. | IN_PROGRESS
  7. | SUBMITTED
type nonrec integer = int
type nonrec job_details = {
  1. input_documents_count : integer option;
    (*

    The number of documents used as input in a translation job.

    *)
  2. documents_with_errors_count : integer option;
    (*

    The number of documents that could not be processed during a translation job.

    *)
  3. translated_documents_count : integer option;
    (*

    The number of documents successfully processed during a translation job.

    *)
}

The number of documents successfully and unsuccessfully processed during a translation job.

type nonrec target_language_code_string_list = language_code_string list
type nonrec input_data_config = {
  1. content_type : content_type;
    (*

    Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types:

    • text/html: The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in the html element in each file.
    • text/plain: The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.
    • application/vnd.openxmlformats-officedocument.wordprocessingml.document: The input data consists of one or more Word documents (.docx).
    • application/vnd.openxmlformats-officedocument.presentationml.presentation: The input data consists of one or more PowerPoint Presentation files (.pptx).
    • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input data consists of one or more Excel Workbook files (.xlsx).
    • application/x-xliff+xml: The input data consists of one or more XML Localization Interchange File Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.

    If you structure your input data as HTML, ensure that you set this parameter to text/html. By doing so, you cut costs by limiting the translation to the contents of the html element in each file. Otherwise, if you set this parameter to text/plain, your costs will cover the translation of every character.

    *)
  2. s3_uri : s3_uri;
    (*

    The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in the folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are calling.

    *)
}

The input configuration properties for requesting a batch translation job.

type nonrec encryption_key_type =
  1. | KMS
type nonrec encryption_key_i_d = string
type nonrec encryption_key = {
  1. id : encryption_key_i_d;
    (*

    The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.

    *)
  2. type_ : encryption_key_type;
    (*

    The type of encryption key used by Amazon Translate to encrypt this object.

    *)
}

The encryption key used to encrypt this object.

type nonrec output_data_config = {
  1. encryption_key : encryption_key option;
  2. s3_uri : s3_uri;
    (*

    The URI of the S3 folder that contains a translation job's output file. The folder must be in the same Region as the API endpoint that you are calling.

    *)
}

The output configuration properties for a batch translation job.

type nonrec iam_role_arn = string
type nonrec text_translation_job_properties = {
  1. settings : translation_settings option;
    (*

    Settings that modify the translation output.

    *)
  2. data_access_role_arn : iam_role_arn option;
    (*

    The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.

    *)
  3. output_data_config : output_data_config option;
    (*

    The output configuration properties that were specified when the job was requested.

    *)
  4. input_data_config : input_data_config option;
    (*

    The input configuration properties that were specified when the job was requested.

    *)
  5. end_time : timestamp option;
    (*

    The time at which the translation job ended.

    *)
  6. submitted_time : timestamp option;
    (*

    The time at which the translation job was submitted.

    *)
  7. message : unbounded_length_string option;
    (*

    An explanation of any errors that may have occurred during the translation job.

    *)
  8. parallel_data_names : resource_name_list option;
    (*

    A list containing the names of the parallel data resources applied to the translation job.

    *)
  9. terminology_names : resource_name_list option;
    (*

    A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.

    *)
  10. target_language_codes : target_language_code_string_list option;
    (*

    The language code of the language of the target text. The language must be a language supported by Amazon Translate.

    *)
  11. source_language_code : language_code_string option;
    (*

    The language code of the language of the source text. The language must be a language supported by Amazon Translate.

    *)
  12. job_details : job_details option;
    (*

    The number of documents successfully and unsuccessfully processed during the translation job.

    *)
  13. job_status : job_status option;
    (*

    The status of the translation job.

    *)
  14. job_name : job_name option;
    (*

    The user-defined name of the translation job.

    *)
  15. job_id : job_id option;
    (*

    The ID of the translation job.

    *)
}

Provides information about a translation job.

type nonrec text_translation_job_properties_list = text_translation_job_properties list
type nonrec text_translation_job_filter = {
  1. submitted_after_time : timestamp option;
    (*

    Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

    *)
  2. submitted_before_time : timestamp option;
    (*

    Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

    *)
  3. job_status : job_status option;
    (*

    Filters the list of jobs based by job status.

    *)
  4. job_name : job_name option;
    (*

    Filters the list of jobs by name.

    *)
}

Provides information for filtering a list of translation jobs. For more information, see ListTextTranslationJobs.

type nonrec terminology_arn = string
type nonrec language_code_string_list = language_code_string list
type nonrec directionality =
  1. | MULTI
  2. | UNI
type nonrec terminology_data_format =
  1. | TSV
  2. | TMX
  3. | CSV
type nonrec terminology_properties = {
  1. format : terminology_data_format option;
    (*

    The format of the custom terminology input file.

    *)
  2. skipped_term_count : integer option;
    (*

    The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.

    *)
  3. message : unbounded_length_string option;
    (*

    Additional information from Amazon Translate about the terminology resource.

    *)
  4. directionality : directionality option;
    (*

    The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

    UNI The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.

    MULTI Any language in the terminology resource can be the source language.

    *)
  5. last_updated_at : timestamp option;
    (*

    The time at which the custom terminology was last update, based on the timestamp.

    *)
  6. created_at : timestamp option;
    (*

    The time at which the custom terminology was created, based on the timestamp.

    *)
  7. term_count : integer option;
    (*

    The number of terms included in the custom terminology.

    *)
  8. size_bytes : integer option;
    (*

    The size of the file used when importing a custom terminology.

    *)
  9. encryption_key : encryption_key option;
    (*

    The encryption key for the custom terminology.

    *)
  10. target_language_codes : language_code_string_list option;
    (*

    The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.

    *)
  11. source_language_code : language_code_string option;
    (*

    The language code for the source text of the translation request for which the custom terminology is being used.

    *)
  12. arn : terminology_arn option;
    (*

    The Amazon Resource Name (ARN) of the custom terminology.

    *)
  13. description : description option;
    (*

    The description of the custom terminology properties.

    *)
  14. name : resource_name option;
    (*

    The name of the custom terminology.

    *)
}

The properties of the custom terminology.

type nonrec terminology_properties_list = terminology_properties list
type nonrec terminology_file = bytes
type nonrec terminology_data_location = {
  1. location : string_;
    (*

    The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration .

    Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

    CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.

    Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

    *)
  2. repository_type : string_;
    (*

    The repository type for the custom terminology data.

    *)
}

The location of the custom terminology data.

type nonrec terminology_data = {
  1. directionality : directionality option;
    (*

    The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

    UNI The terminology resource has one source language (for example, the first column in a CSV file), and all of its other languages are target languages.

    MULTI Any language in the terminology resource can be the source language or a target language. A single multi-directional terminology resource can be used for jobs that translate different language pairs. For example, if the terminology contains English and Spanish terms, it can be used for jobs that translate English to Spanish and Spanish to English.

    When you create a custom terminology resource without specifying the directionality, it behaves as uni-directional terminology, although this parameter will have a null value.

    *)
  2. format : terminology_data_format;
    (*

    The data format of the custom terminology.

    *)
  3. file : terminology_file;
    (*

    The file containing the custom terminology data. Your version of the AWS SDK performs a Base64-encoding on this field before sending a request to the AWS service. Users of the SDK should not perform Base64-encoding themselves.

    *)
}

The data associated with the custom terminology. For information about the custom terminology file, see Creating a Custom Terminology.

type nonrec tag_value = string
type nonrec tag_resource_response = unit
type nonrec tag = {
  1. value : tag_value;
    (*

    The second part of a key-value pair that forms a tag associated with a given resource.

    *)
  2. key : tag_key;
    (*

    The initial part of a key-value pair that forms a tag associated with a given resource.

    *)
}

A key-value pair that adds as a metadata to a resource used by Amazon Translate.

type nonrec tag_list = tag list
type nonrec tag_resource_request = {
  1. tags : tag_list;
    (*

    Tags being associated with a specific Amazon Translate resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.

    *)
  2. resource_arn : resource_arn;
    (*

    The Amazon Resource Name (ARN) of the given Amazon Translate resource to which you want to associate the tags.

    *)
}
type nonrec stop_text_translation_job_response = {
  1. job_status : job_status option;
    (*

    The status of the designated job. Upon successful completion, the job's status will be STOPPED.

    *)
  2. job_id : job_id option;
    (*

    The job ID of the stopped batch translation job.

    *)
}
type nonrec stop_text_translation_job_request = {
  1. job_id : job_id;
    (*

    The job ID of the job to be stopped.

    *)
}
type nonrec start_text_translation_job_response = {
  1. job_status : job_status option;
    (*

    The status of the job. Possible values include:

    • SUBMITTED - The job has been received and is queued for processing.
    • IN_PROGRESS - Amazon Translate is processing the job.
    • COMPLETED - The job was successfully completed and the output is available.
    • COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the job's output.
    • FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob operation.
    • STOP_REQUESTED - The user who started the job has requested that it be stopped.
    • STOPPED - The job has been stopped.
    *)
  2. job_id : job_id option;
    (*

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

    *)
}
type nonrec start_text_translation_job_request = {
  1. settings : translation_settings option;
    (*

    Settings to configure your translation output. You can configure the following options:

    • Brevity: not supported.
    • Formality: sets the formality level of the output text.
    • Profanity: masks profane words and phrases in your translation output.
    *)
  2. client_token : client_token_string;
    (*

    A unique identifier for the request. This token is generated for you when using the Amazon Translate SDK.

    *)
  3. parallel_data_names : resource_name_list option;
    (*

    The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. If you specify multiple target languages for the job, the parallel data file must include translations for all the target languages.

    When you add parallel data to a translation job, you create an Active Custom Translation job.

    This parameter accepts only one parallel data resource.

    Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

    For a list of available parallel data resources, use the ListParallelData operation.

    For more information, see Customizing your translations with parallel data.

    *)
  4. terminology_names : resource_name_list option;
    (*

    The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

    This parameter accepts only one custom terminology resource.

    If you specify multiple target languages for the job, translate uses the designated terminology for each requested target language that has an entry for the source term in the terminology file.

    For a list of available custom terminology resources, use the ListTerminologies operation.

    For more information, see Custom terminology.

    *)
  5. target_language_codes : target_language_code_string_list;
    (*

    The target languages of the translation job. Enter up to 10 language codes. Each input file is translated into each target language.

    Each language code is 2 or 5 characters long. For a list of language codes, see Supported languages.

    *)
  6. source_language_code : language_code_string;
    (*

    The language code of the input language. Specify the language if all input documents share the same language. If you don't know the language of the source files, or your input documents contains different source languages, select auto. Amazon Translate auto detects the source language for each input document. For a list of supported language codes, see Supported languages.

    *)
  7. data_access_role_arn : iam_role_arn;
    (*

    The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more information, see Identity and access management.

    *)
  8. output_data_config : output_data_config;
    (*

    Specifies the S3 folder to which your job output will be saved.

    *)
  9. input_data_config : input_data_config;
    (*

    Specifies the format and location of the input documents for the translation job.

    *)
  10. job_name : job_name option;
    (*

    The name of the batch translation job to be performed.

    *)
}
type nonrec parallel_data_arn = string
type nonrec long = Smaws_Lib.CoreTypes.Int64.t
type nonrec parallel_data_properties = {
  1. latest_update_attempt_at : timestamp option;
    (*

    The time that the most recent update was attempted.

    *)
  2. latest_update_attempt_status : parallel_data_status option;
    (*

    The status of the most recent update attempt for the parallel data resource.

    *)
  3. last_updated_at : timestamp option;
    (*

    The time at which the parallel data resource was last updated.

    *)
  4. created_at : timestamp option;
    (*

    The time at which the parallel data resource was created.

    *)
  5. encryption_key : encryption_key option;
  6. skipped_record_count : long option;
    (*

    The number of items in the input file that Amazon Translate skipped when you created or updated the parallel data resource. For example, Amazon Translate skips empty records, empty target texts, and empty lines.

    *)
  7. failed_record_count : long option;
    (*

    The number of records unsuccessfully imported from the parallel data input file.

    *)
  8. imported_record_count : long option;
    (*

    The number of records successfully imported from the parallel data input file.

    *)
  9. imported_data_size : long option;
    (*

    The number of UTF-8 characters that Amazon Translate imported from the parallel data input file. This number includes only the characters in your translation examples. It does not include characters that are used to format your file. For example, if you provided a Translation Memory Exchange (.tmx) file, this number does not include the tags.

    *)
  10. message : unbounded_length_string option;
    (*

    Additional information from Amazon Translate about the parallel data resource.

    *)
  11. parallel_data_config : parallel_data_config option;
    (*

    Specifies the format and S3 location of the parallel data input file.

    *)
  12. target_language_codes : language_code_string_list option;
    (*

    The language codes for the target languages available in the parallel data file. All possible target languages are returned as an array.

    *)
  13. source_language_code : language_code_string option;
    (*

    The source language of the translations in the parallel data file.

    *)
  14. status : parallel_data_status option;
    (*

    The status of the parallel data resource. When the parallel data is ready for you to use, the status is ACTIVE.

    *)
  15. description : description option;
    (*

    The description assigned to the parallel data resource.

    *)
  16. arn : parallel_data_arn option;
    (*

    The Amazon Resource Name (ARN) of the parallel data resource.

    *)
  17. name : resource_name option;
    (*

    The custom name assigned to the parallel data resource.

    *)
}

The properties of a parallel data resource.

type nonrec parallel_data_properties_list = parallel_data_properties list
type nonrec parallel_data_data_location = {
  1. location : string_;
    (*

    The Amazon S3 location of the parallel data input file. The location is returned as a presigned URL to that has a 30-minute expiration.

    Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

    CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.

    Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

    *)
  2. repository_type : string_;
    (*

    Describes the repository that contains the parallel data input file.

    *)
}

The location of the most recent parallel data input file that was successfully imported into Amazon Translate.

type nonrec next_token = string
type nonrec merge_strategy =
  1. | OVERWRITE
type nonrec max_results_integer = int
type nonrec localized_name_string = string
type nonrec list_text_translation_jobs_response = {
  1. next_token : next_token option;
    (*

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    *)
  2. text_translation_job_properties_list : text_translation_job_properties_list option;
    (*

    A list containing the properties of each job that is returned.

    *)
}
type nonrec list_text_translation_jobs_request = {
  1. max_results : max_results_integer option;
    (*

    The maximum number of results to return in each page. The default value is 100.

    *)
  2. next_token : next_token option;
    (*

    The token to request the next page of results.

    *)
  3. filter : text_translation_job_filter option;
    (*

    The parameters that specify which batch translation jobs to retrieve. Filters include job name, job status, and submission time. You can only set one filter at a time.

    *)
}
type nonrec invalid_filter_exception = {
  1. message : string_ option;
}

The filter specified for the operation is not valid. Specify a different filter.

type nonrec list_terminologies_response = {
  1. next_token : next_token option;
    (*

    If the response to the ListTerminologies was truncated, the NextToken fetches the next group of custom terminologies.

    *)
  2. terminology_properties_list : terminology_properties_list option;
    (*

    The properties list of the custom terminologies returned on the list request.

    *)
}
type nonrec list_terminologies_request = {
  1. max_results : max_results_integer option;
    (*

    The maximum number of custom terminologies returned per list request.

    *)
  2. next_token : next_token option;
    (*

    If the result of the request to ListTerminologies was truncated, include the NextToken to fetch the next group of custom terminologies.

    *)
}
type nonrec list_tags_for_resource_response = {
  1. tags : tag_list option;
    (*

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

    *)
}
type nonrec list_tags_for_resource_request = {
  1. resource_arn : resource_arn;
    (*

    The Amazon Resource Name (ARN) of the given Amazon Translate resource you are querying.

    *)
}
type nonrec list_parallel_data_response = {
  1. next_token : next_token option;
    (*

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    *)
  2. parallel_data_properties_list : parallel_data_properties_list option;
    (*

    The properties of the parallel data resources returned by this request.

    *)
}
type nonrec list_parallel_data_request = {
  1. max_results : max_results_integer option;
    (*

    The maximum number of parallel data resources returned for each request.

    *)
  2. next_token : next_token option;
    (*

    A string that specifies the next page of results to return in a paginated response.

    *)
}
type nonrec language = {
  1. language_code : language_code_string;
    (*

    Language code for the supported language.

    *)
  2. language_name : localized_name_string;
    (*

    Language name of the supported language.

    *)
}

A supported language.

type nonrec languages_list = language list
type nonrec display_language_code =
  1. | ZH_TW
  2. | ZH
  3. | PT
  4. | KO
  5. | JA
  6. | IT
  7. | FR
  8. | ES
  9. | EN
  10. | DE
type nonrec list_languages_response = {
  1. next_token : next_token option;
    (*

    If the response does not include all remaining results, use the NextToken in the next request to fetch the next group of supported languages.

    *)
  2. display_language_code : display_language_code option;
    (*

    The language code passed in with the request.

    *)
  3. languages : languages_list option;
    (*

    The list of supported languages.

    *)
}
type nonrec list_languages_request = {
  1. max_results : max_results_integer option;
    (*

    The maximum number of results to return in each response.

    *)
  2. next_token : next_token option;
    (*

    Include the NextToken value to fetch the next group of supported languages.

    *)
  3. display_language_code : display_language_code option;
    (*

    The language code for the language to use to display the language names in the response. The language code is en by default.

    *)
}
type nonrec import_terminology_response = {
  1. auxiliary_data_location : terminology_data_location option;
    (*

    The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a terminology resource. The location is returned as a presigned URL to that has a 30 minute expiration.

    *)
  2. terminology_properties : terminology_properties option;
    (*

    The properties of the custom terminology being imported.

    *)
}
type nonrec import_terminology_request = {
  1. tags : tag_list option;
    (*

    Tags to be associated with this resource. A tag is a key-value pair that adds metadata to a resource. Each tag key for the resource must be unique. For more information, see Tagging your resources.

    *)
  2. encryption_key : encryption_key option;
    (*

    The encryption key for the custom terminology being imported.

    *)
  3. terminology_data : terminology_data;
    (*

    The terminology data for the custom terminology being imported.

    *)
  4. description : description option;
    (*

    The description of the custom terminology being imported.

    *)
  5. merge_strategy : merge_strategy;
    (*

    The merge strategy of the custom terminology being imported. Currently, only the OVERWRITE merge strategy is supported. In this case, the imported terminology will overwrite an existing terminology of the same name.

    *)
  6. name : resource_name;
    (*

    The name of the custom terminology being imported.

    *)
}
type nonrec get_terminology_response = {
  1. auxiliary_data_location : terminology_data_location option;
    (*

    The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a terminology resource. The location is returned as a presigned URL to that has a 30-minute expiration.

    *)
  2. terminology_data_location : terminology_data_location option;
    (*

    The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration.

    Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

    CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.

    Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

    *)
  3. terminology_properties : terminology_properties option;
    (*

    The properties of the custom terminology being retrieved.

    *)
}
type nonrec get_terminology_request = {
  1. terminology_data_format : terminology_data_format option;
    (*

    The data format of the custom terminology being retrieved.

    If you don't specify this parameter, Amazon Translate returns a file with the same format as the file that was imported to create the terminology.

    If you specify this parameter when you retrieve a multi-directional terminology resource, you must specify the same format as the input file that was imported to create it. Otherwise, Amazon Translate throws an error.

    *)
  2. name : resource_name;
    (*

    The name of the custom terminology being retrieved.

    *)
}
type nonrec get_parallel_data_response = {
  1. latest_update_attempt_auxiliary_data_location : parallel_data_data_location option;
    (*

    The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to update a parallel data resource. The location is returned as a presigned URL to that has a 30-minute expiration.

    *)
  2. auxiliary_data_location : parallel_data_data_location option;
    (*

    The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a parallel data resource. The location is returned as a presigned URL to that has a 30-minute expiration.

    *)
  3. data_location : parallel_data_data_location option;
    (*

    The Amazon S3 location of the most recent parallel data input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration.

    Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

    CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.

    Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

    *)
  4. parallel_data_properties : parallel_data_properties option;
    (*

    The properties of the parallel data resource that is being retrieved.

    *)
}
type nonrec get_parallel_data_request = {
  1. name : resource_name;
    (*

    The name of the parallel data resource that is being retrieved.

    *)
}
type nonrec describe_text_translation_job_response = {
  1. text_translation_job_properties : text_translation_job_properties option;
    (*

    An object that contains the properties associated with an asynchronous batch translation job.

    *)
}
type nonrec describe_text_translation_job_request = {
  1. job_id : job_id;
    (*

    The identifier that Amazon Translate generated for the job. The StartTextTranslationJob operation returns this identifier in its response.

    *)
}
type nonrec delete_terminology_request = {
  1. name : resource_name;
    (*

    The name of the custom terminology being deleted.

    *)
}
type nonrec delete_parallel_data_response = {
  1. status : parallel_data_status option;
    (*

    The status of the parallel data deletion.

    *)
  2. name : resource_name option;
    (*

    The name of the parallel data resource that is being deleted.

    *)
}
type nonrec delete_parallel_data_request = {
  1. name : resource_name;
    (*

    The name of the parallel data resource that is being deleted.

    *)
}
type nonrec create_parallel_data_response = {
  1. status : parallel_data_status option;
    (*

    The status of the parallel data resource. When the resource is ready for you to use, the status is ACTIVE.

    *)
  2. name : resource_name option;
    (*

    The custom name that you assigned to the parallel data resource.

    *)
}
type nonrec create_parallel_data_request = {
  1. tags : tag_list option;
    (*

    Tags to be associated with this resource. A tag is a key-value pair that adds metadata to a resource. Each tag key for the resource must be unique. For more information, see Tagging your resources.

    *)
  2. client_token : client_token_string;
    (*

    A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.

    *)
  3. encryption_key : encryption_key option;
  4. parallel_data_config : parallel_data_config;
    (*

    Specifies the format and S3 location of the parallel data input file.

    *)
  5. description : description option;
    (*

    A custom description for the parallel data resource in Amazon Translate.

    *)
  6. name : resource_name;
    (*

    A custom name for the parallel data resource in Amazon Translate. You must assign a name that is unique in the account and region.

    *)
}