Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Operations
- CreateParallelData
- DeleteParallelData
- DeleteTerminology
- DescribeTextTranslationJob
- GetParallelData
- GetTerminology
- ImportTerminology
- ListLanguages
- ListParallelData
- ListTagsForResource
- ListTerminologies
- ListTextTranslationJobs
- StartTextTranslationJob
- StopTextTranslationJob
- TagResource
- TranslateText
- UntagResource
- UpdateParallelData
- Types
Synopsis
- createParallelData_description :: Lens' CreateParallelData (Maybe Text)
- createParallelData_encryptionKey :: Lens' CreateParallelData (Maybe EncryptionKey)
- createParallelData_tags :: Lens' CreateParallelData (Maybe [Tag])
- createParallelData_name :: Lens' CreateParallelData Text
- createParallelData_parallelDataConfig :: Lens' CreateParallelData ParallelDataConfig
- createParallelData_clientToken :: Lens' CreateParallelData Text
- createParallelDataResponse_name :: Lens' CreateParallelDataResponse (Maybe Text)
- createParallelDataResponse_status :: Lens' CreateParallelDataResponse (Maybe ParallelDataStatus)
- createParallelDataResponse_httpStatus :: Lens' CreateParallelDataResponse Int
- deleteParallelData_name :: Lens' DeleteParallelData Text
- deleteParallelDataResponse_name :: Lens' DeleteParallelDataResponse (Maybe Text)
- deleteParallelDataResponse_status :: Lens' DeleteParallelDataResponse (Maybe ParallelDataStatus)
- deleteParallelDataResponse_httpStatus :: Lens' DeleteParallelDataResponse Int
- deleteTerminology_name :: Lens' DeleteTerminology Text
- describeTextTranslationJob_jobId :: Lens' DescribeTextTranslationJob Text
- describeTextTranslationJobResponse_textTranslationJobProperties :: Lens' DescribeTextTranslationJobResponse (Maybe TextTranslationJobProperties)
- describeTextTranslationJobResponse_httpStatus :: Lens' DescribeTextTranslationJobResponse Int
- getParallelData_name :: Lens' GetParallelData Text
- getParallelDataResponse_auxiliaryDataLocation :: Lens' GetParallelDataResponse (Maybe ParallelDataDataLocation)
- getParallelDataResponse_dataLocation :: Lens' GetParallelDataResponse (Maybe ParallelDataDataLocation)
- getParallelDataResponse_latestUpdateAttemptAuxiliaryDataLocation :: Lens' GetParallelDataResponse (Maybe ParallelDataDataLocation)
- getParallelDataResponse_parallelDataProperties :: Lens' GetParallelDataResponse (Maybe ParallelDataProperties)
- getParallelDataResponse_httpStatus :: Lens' GetParallelDataResponse Int
- getTerminology_terminologyDataFormat :: Lens' GetTerminology (Maybe TerminologyDataFormat)
- getTerminology_name :: Lens' GetTerminology Text
- getTerminologyResponse_auxiliaryDataLocation :: Lens' GetTerminologyResponse (Maybe TerminologyDataLocation)
- getTerminologyResponse_terminologyDataLocation :: Lens' GetTerminologyResponse (Maybe TerminologyDataLocation)
- getTerminologyResponse_terminologyProperties :: Lens' GetTerminologyResponse (Maybe TerminologyProperties)
- getTerminologyResponse_httpStatus :: Lens' GetTerminologyResponse Int
- importTerminology_description :: Lens' ImportTerminology (Maybe Text)
- importTerminology_encryptionKey :: Lens' ImportTerminology (Maybe EncryptionKey)
- importTerminology_tags :: Lens' ImportTerminology (Maybe [Tag])
- importTerminology_name :: Lens' ImportTerminology Text
- importTerminology_mergeStrategy :: Lens' ImportTerminology MergeStrategy
- importTerminology_terminologyData :: Lens' ImportTerminology TerminologyData
- importTerminologyResponse_auxiliaryDataLocation :: Lens' ImportTerminologyResponse (Maybe TerminologyDataLocation)
- importTerminologyResponse_terminologyProperties :: Lens' ImportTerminologyResponse (Maybe TerminologyProperties)
- importTerminologyResponse_httpStatus :: Lens' ImportTerminologyResponse Int
- listLanguages_displayLanguageCode :: Lens' ListLanguages (Maybe DisplayLanguageCode)
- listLanguages_maxResults :: Lens' ListLanguages (Maybe Natural)
- listLanguages_nextToken :: Lens' ListLanguages (Maybe Text)
- listLanguagesResponse_displayLanguageCode :: Lens' ListLanguagesResponse (Maybe DisplayLanguageCode)
- listLanguagesResponse_languages :: Lens' ListLanguagesResponse (Maybe [Language])
- listLanguagesResponse_nextToken :: Lens' ListLanguagesResponse (Maybe Text)
- listLanguagesResponse_httpStatus :: Lens' ListLanguagesResponse Int
- listParallelData_maxResults :: Lens' ListParallelData (Maybe Natural)
- listParallelData_nextToken :: Lens' ListParallelData (Maybe Text)
- listParallelDataResponse_nextToken :: Lens' ListParallelDataResponse (Maybe Text)
- listParallelDataResponse_parallelDataPropertiesList :: Lens' ListParallelDataResponse (Maybe [ParallelDataProperties])
- listParallelDataResponse_httpStatus :: Lens' ListParallelDataResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- listTerminologies_maxResults :: Lens' ListTerminologies (Maybe Natural)
- listTerminologies_nextToken :: Lens' ListTerminologies (Maybe Text)
- listTerminologiesResponse_nextToken :: Lens' ListTerminologiesResponse (Maybe Text)
- listTerminologiesResponse_terminologyPropertiesList :: Lens' ListTerminologiesResponse (Maybe [TerminologyProperties])
- listTerminologiesResponse_httpStatus :: Lens' ListTerminologiesResponse Int
- listTextTranslationJobs_filter :: Lens' ListTextTranslationJobs (Maybe TextTranslationJobFilter)
- listTextTranslationJobs_maxResults :: Lens' ListTextTranslationJobs (Maybe Natural)
- listTextTranslationJobs_nextToken :: Lens' ListTextTranslationJobs (Maybe Text)
- listTextTranslationJobsResponse_nextToken :: Lens' ListTextTranslationJobsResponse (Maybe Text)
- listTextTranslationJobsResponse_textTranslationJobPropertiesList :: Lens' ListTextTranslationJobsResponse (Maybe [TextTranslationJobProperties])
- listTextTranslationJobsResponse_httpStatus :: Lens' ListTextTranslationJobsResponse Int
- startTextTranslationJob_jobName :: Lens' StartTextTranslationJob (Maybe Text)
- startTextTranslationJob_parallelDataNames :: Lens' StartTextTranslationJob (Maybe [Text])
- startTextTranslationJob_settings :: Lens' StartTextTranslationJob (Maybe TranslationSettings)
- startTextTranslationJob_terminologyNames :: Lens' StartTextTranslationJob (Maybe [Text])
- startTextTranslationJob_inputDataConfig :: Lens' StartTextTranslationJob InputDataConfig
- startTextTranslationJob_outputDataConfig :: Lens' StartTextTranslationJob OutputDataConfig
- startTextTranslationJob_dataAccessRoleArn :: Lens' StartTextTranslationJob Text
- startTextTranslationJob_sourceLanguageCode :: Lens' StartTextTranslationJob Text
- startTextTranslationJob_targetLanguageCodes :: Lens' StartTextTranslationJob (NonEmpty Text)
- startTextTranslationJob_clientToken :: Lens' StartTextTranslationJob Text
- startTextTranslationJobResponse_jobId :: Lens' StartTextTranslationJobResponse (Maybe Text)
- startTextTranslationJobResponse_jobStatus :: Lens' StartTextTranslationJobResponse (Maybe JobStatus)
- startTextTranslationJobResponse_httpStatus :: Lens' StartTextTranslationJobResponse Int
- stopTextTranslationJob_jobId :: Lens' StopTextTranslationJob Text
- stopTextTranslationJobResponse_jobId :: Lens' StopTextTranslationJobResponse (Maybe Text)
- stopTextTranslationJobResponse_jobStatus :: Lens' StopTextTranslationJobResponse (Maybe JobStatus)
- stopTextTranslationJobResponse_httpStatus :: Lens' StopTextTranslationJobResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource [Tag]
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- translateText_settings :: Lens' TranslateText (Maybe TranslationSettings)
- translateText_terminologyNames :: Lens' TranslateText (Maybe [Text])
- translateText_text :: Lens' TranslateText Text
- translateText_sourceLanguageCode :: Lens' TranslateText Text
- translateText_targetLanguageCode :: Lens' TranslateText Text
- translateTextResponse_appliedSettings :: Lens' TranslateTextResponse (Maybe TranslationSettings)
- translateTextResponse_appliedTerminologies :: Lens' TranslateTextResponse (Maybe [AppliedTerminology])
- translateTextResponse_httpStatus :: Lens' TranslateTextResponse Int
- translateTextResponse_translatedText :: Lens' TranslateTextResponse Text
- translateTextResponse_sourceLanguageCode :: Lens' TranslateTextResponse Text
- translateTextResponse_targetLanguageCode :: Lens' TranslateTextResponse Text
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateParallelData_description :: Lens' UpdateParallelData (Maybe Text)
- updateParallelData_name :: Lens' UpdateParallelData Text
- updateParallelData_parallelDataConfig :: Lens' UpdateParallelData ParallelDataConfig
- updateParallelData_clientToken :: Lens' UpdateParallelData Text
- updateParallelDataResponse_latestUpdateAttemptAt :: Lens' UpdateParallelDataResponse (Maybe UTCTime)
- updateParallelDataResponse_latestUpdateAttemptStatus :: Lens' UpdateParallelDataResponse (Maybe ParallelDataStatus)
- updateParallelDataResponse_name :: Lens' UpdateParallelDataResponse (Maybe Text)
- updateParallelDataResponse_status :: Lens' UpdateParallelDataResponse (Maybe ParallelDataStatus)
- updateParallelDataResponse_httpStatus :: Lens' UpdateParallelDataResponse Int
- appliedTerminology_name :: Lens' AppliedTerminology (Maybe Text)
- appliedTerminology_terms :: Lens' AppliedTerminology (Maybe [Term])
- encryptionKey_type :: Lens' EncryptionKey EncryptionKeyType
- encryptionKey_id :: Lens' EncryptionKey Text
- inputDataConfig_s3Uri :: Lens' InputDataConfig Text
- inputDataConfig_contentType :: Lens' InputDataConfig Text
- jobDetails_documentsWithErrorsCount :: Lens' JobDetails (Maybe Int)
- jobDetails_inputDocumentsCount :: Lens' JobDetails (Maybe Int)
- jobDetails_translatedDocumentsCount :: Lens' JobDetails (Maybe Int)
- language_languageName :: Lens' Language Text
- language_languageCode :: Lens' Language Text
- outputDataConfig_encryptionKey :: Lens' OutputDataConfig (Maybe EncryptionKey)
- outputDataConfig_s3Uri :: Lens' OutputDataConfig Text
- parallelDataConfig_s3Uri :: Lens' ParallelDataConfig Text
- parallelDataConfig_format :: Lens' ParallelDataConfig ParallelDataFormat
- parallelDataDataLocation_repositoryType :: Lens' ParallelDataDataLocation Text
- parallelDataDataLocation_location :: Lens' ParallelDataDataLocation Text
- parallelDataProperties_arn :: Lens' ParallelDataProperties (Maybe Text)
- parallelDataProperties_createdAt :: Lens' ParallelDataProperties (Maybe UTCTime)
- parallelDataProperties_description :: Lens' ParallelDataProperties (Maybe Text)
- parallelDataProperties_encryptionKey :: Lens' ParallelDataProperties (Maybe EncryptionKey)
- parallelDataProperties_failedRecordCount :: Lens' ParallelDataProperties (Maybe Integer)
- parallelDataProperties_importedDataSize :: Lens' ParallelDataProperties (Maybe Integer)
- parallelDataProperties_importedRecordCount :: Lens' ParallelDataProperties (Maybe Integer)
- parallelDataProperties_lastUpdatedAt :: Lens' ParallelDataProperties (Maybe UTCTime)
- parallelDataProperties_latestUpdateAttemptAt :: Lens' ParallelDataProperties (Maybe UTCTime)
- parallelDataProperties_latestUpdateAttemptStatus :: Lens' ParallelDataProperties (Maybe ParallelDataStatus)
- parallelDataProperties_message :: Lens' ParallelDataProperties (Maybe Text)
- parallelDataProperties_name :: Lens' ParallelDataProperties (Maybe Text)
- parallelDataProperties_parallelDataConfig :: Lens' ParallelDataProperties (Maybe ParallelDataConfig)
- parallelDataProperties_skippedRecordCount :: Lens' ParallelDataProperties (Maybe Integer)
- parallelDataProperties_sourceLanguageCode :: Lens' ParallelDataProperties (Maybe Text)
- parallelDataProperties_status :: Lens' ParallelDataProperties (Maybe ParallelDataStatus)
- parallelDataProperties_targetLanguageCodes :: Lens' ParallelDataProperties (Maybe [Text])
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- term_sourceText :: Lens' Term (Maybe Text)
- term_targetText :: Lens' Term (Maybe Text)
- terminologyData_directionality :: Lens' TerminologyData (Maybe Directionality)
- terminologyData_file :: Lens' TerminologyData ByteString
- terminologyData_format :: Lens' TerminologyData TerminologyDataFormat
- terminologyDataLocation_repositoryType :: Lens' TerminologyDataLocation Text
- terminologyDataLocation_location :: Lens' TerminologyDataLocation Text
- terminologyProperties_arn :: Lens' TerminologyProperties (Maybe Text)
- terminologyProperties_createdAt :: Lens' TerminologyProperties (Maybe UTCTime)
- terminologyProperties_description :: Lens' TerminologyProperties (Maybe Text)
- terminologyProperties_directionality :: Lens' TerminologyProperties (Maybe Directionality)
- terminologyProperties_encryptionKey :: Lens' TerminologyProperties (Maybe EncryptionKey)
- terminologyProperties_format :: Lens' TerminologyProperties (Maybe TerminologyDataFormat)
- terminologyProperties_lastUpdatedAt :: Lens' TerminologyProperties (Maybe UTCTime)
- terminologyProperties_message :: Lens' TerminologyProperties (Maybe Text)
- terminologyProperties_name :: Lens' TerminologyProperties (Maybe Text)
- terminologyProperties_sizeBytes :: Lens' TerminologyProperties (Maybe Int)
- terminologyProperties_skippedTermCount :: Lens' TerminologyProperties (Maybe Int)
- terminologyProperties_sourceLanguageCode :: Lens' TerminologyProperties (Maybe Text)
- terminologyProperties_targetLanguageCodes :: Lens' TerminologyProperties (Maybe [Text])
- terminologyProperties_termCount :: Lens' TerminologyProperties (Maybe Int)
- textTranslationJobFilter_jobName :: Lens' TextTranslationJobFilter (Maybe Text)
- textTranslationJobFilter_jobStatus :: Lens' TextTranslationJobFilter (Maybe JobStatus)
- textTranslationJobFilter_submittedAfterTime :: Lens' TextTranslationJobFilter (Maybe UTCTime)
- textTranslationJobFilter_submittedBeforeTime :: Lens' TextTranslationJobFilter (Maybe UTCTime)
- textTranslationJobProperties_dataAccessRoleArn :: Lens' TextTranslationJobProperties (Maybe Text)
- textTranslationJobProperties_endTime :: Lens' TextTranslationJobProperties (Maybe UTCTime)
- textTranslationJobProperties_inputDataConfig :: Lens' TextTranslationJobProperties (Maybe InputDataConfig)
- textTranslationJobProperties_jobDetails :: Lens' TextTranslationJobProperties (Maybe JobDetails)
- textTranslationJobProperties_jobId :: Lens' TextTranslationJobProperties (Maybe Text)
- textTranslationJobProperties_jobName :: Lens' TextTranslationJobProperties (Maybe Text)
- textTranslationJobProperties_jobStatus :: Lens' TextTranslationJobProperties (Maybe JobStatus)
- textTranslationJobProperties_message :: Lens' TextTranslationJobProperties (Maybe Text)
- textTranslationJobProperties_outputDataConfig :: Lens' TextTranslationJobProperties (Maybe OutputDataConfig)
- textTranslationJobProperties_parallelDataNames :: Lens' TextTranslationJobProperties (Maybe [Text])
- textTranslationJobProperties_settings :: Lens' TextTranslationJobProperties (Maybe TranslationSettings)
- textTranslationJobProperties_sourceLanguageCode :: Lens' TextTranslationJobProperties (Maybe Text)
- textTranslationJobProperties_submittedTime :: Lens' TextTranslationJobProperties (Maybe UTCTime)
- textTranslationJobProperties_targetLanguageCodes :: Lens' TextTranslationJobProperties (Maybe (NonEmpty Text))
- textTranslationJobProperties_terminologyNames :: Lens' TextTranslationJobProperties (Maybe [Text])
- translationSettings_formality :: Lens' TranslationSettings (Maybe Formality)
- translationSettings_profanity :: Lens' TranslationSettings (Maybe Profanity)
Operations
CreateParallelData
createParallelData_description :: Lens' CreateParallelData (Maybe Text) Source #
A custom description for the parallel data resource in Amazon Translate.
createParallelData_encryptionKey :: Lens' CreateParallelData (Maybe EncryptionKey) Source #
Undocumented member.
createParallelData_tags :: Lens' CreateParallelData (Maybe [Tag]) Source #
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.
createParallelData_name :: Lens' CreateParallelData Text Source #
A custom name for the parallel data resource in Amazon Translate. You must assign a name that is unique in the account and region.
createParallelData_parallelDataConfig :: Lens' CreateParallelData ParallelDataConfig Source #
Specifies the format and S3 location of the parallel data input file.
createParallelData_clientToken :: Lens' CreateParallelData Text Source #
A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.
createParallelDataResponse_name :: Lens' CreateParallelDataResponse (Maybe Text) Source #
The custom name that you assigned to the parallel data resource.
createParallelDataResponse_status :: Lens' CreateParallelDataResponse (Maybe ParallelDataStatus) Source #
The status of the parallel data resource. When the resource is ready for
you to use, the status is ACTIVE
.
createParallelDataResponse_httpStatus :: Lens' CreateParallelDataResponse Int Source #
The response's http status code.
DeleteParallelData
deleteParallelData_name :: Lens' DeleteParallelData Text Source #
The name of the parallel data resource that is being deleted.
deleteParallelDataResponse_name :: Lens' DeleteParallelDataResponse (Maybe Text) Source #
The name of the parallel data resource that is being deleted.
deleteParallelDataResponse_status :: Lens' DeleteParallelDataResponse (Maybe ParallelDataStatus) Source #
The status of the parallel data deletion.
deleteParallelDataResponse_httpStatus :: Lens' DeleteParallelDataResponse Int Source #
The response's http status code.
DeleteTerminology
deleteTerminology_name :: Lens' DeleteTerminology Text Source #
The name of the custom terminology being deleted.
DescribeTextTranslationJob
describeTextTranslationJob_jobId :: Lens' DescribeTextTranslationJob Text Source #
The identifier that Amazon Translate generated for the job. The StartTextTranslationJob operation returns this identifier in its response.
describeTextTranslationJobResponse_textTranslationJobProperties :: Lens' DescribeTextTranslationJobResponse (Maybe TextTranslationJobProperties) Source #
An object that contains the properties associated with an asynchronous batch translation job.
describeTextTranslationJobResponse_httpStatus :: Lens' DescribeTextTranslationJobResponse Int Source #
The response's http status code.
GetParallelData
getParallelData_name :: Lens' GetParallelData Text Source #
The name of the parallel data resource that is being retrieved.
getParallelDataResponse_auxiliaryDataLocation :: Lens' GetParallelDataResponse (Maybe ParallelDataDataLocation) Source #
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.
getParallelDataResponse_dataLocation :: Lens' GetParallelDataResponse (Maybe ParallelDataDataLocation) Source #
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.
getParallelDataResponse_latestUpdateAttemptAuxiliaryDataLocation :: Lens' GetParallelDataResponse (Maybe ParallelDataDataLocation) Source #
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.
getParallelDataResponse_parallelDataProperties :: Lens' GetParallelDataResponse (Maybe ParallelDataProperties) Source #
The properties of the parallel data resource that is being retrieved.
getParallelDataResponse_httpStatus :: Lens' GetParallelDataResponse Int Source #
The response's http status code.
GetTerminology
getTerminology_terminologyDataFormat :: Lens' GetTerminology (Maybe TerminologyDataFormat) Source #
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.
getTerminology_name :: Lens' GetTerminology Text Source #
The name of the custom terminology being retrieved.
getTerminologyResponse_auxiliaryDataLocation :: Lens' GetTerminologyResponse (Maybe TerminologyDataLocation) Source #
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.
getTerminologyResponse_terminologyDataLocation :: Lens' GetTerminologyResponse (Maybe TerminologyDataLocation) Source #
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.
getTerminologyResponse_terminologyProperties :: Lens' GetTerminologyResponse (Maybe TerminologyProperties) Source #
The properties of the custom terminology being retrieved.
getTerminologyResponse_httpStatus :: Lens' GetTerminologyResponse Int Source #
The response's http status code.
ImportTerminology
importTerminology_description :: Lens' ImportTerminology (Maybe Text) Source #
The description of the custom terminology being imported.
importTerminology_encryptionKey :: Lens' ImportTerminology (Maybe EncryptionKey) Source #
The encryption key for the custom terminology being imported.
importTerminology_tags :: Lens' ImportTerminology (Maybe [Tag]) Source #
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.
importTerminology_name :: Lens' ImportTerminology Text Source #
The name of the custom terminology being imported.
importTerminology_mergeStrategy :: Lens' ImportTerminology MergeStrategy Source #
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.
importTerminology_terminologyData :: Lens' ImportTerminology TerminologyData Source #
The terminology data for the custom terminology being imported.
importTerminologyResponse_auxiliaryDataLocation :: Lens' ImportTerminologyResponse (Maybe TerminologyDataLocation) Source #
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.
importTerminologyResponse_terminologyProperties :: Lens' ImportTerminologyResponse (Maybe TerminologyProperties) Source #
The properties of the custom terminology being imported.
importTerminologyResponse_httpStatus :: Lens' ImportTerminologyResponse Int Source #
The response's http status code.
ListLanguages
listLanguages_displayLanguageCode :: Lens' ListLanguages (Maybe DisplayLanguageCode) Source #
The language code for the language to use to display the language names
in the response. The language code is en
by default.
listLanguages_maxResults :: Lens' ListLanguages (Maybe Natural) Source #
The maximum number of results to return in each response.
listLanguages_nextToken :: Lens' ListLanguages (Maybe Text) Source #
Include the NextToken value to fetch the next group of supported languages.
listLanguagesResponse_displayLanguageCode :: Lens' ListLanguagesResponse (Maybe DisplayLanguageCode) Source #
The language code passed in with the request.
listLanguagesResponse_languages :: Lens' ListLanguagesResponse (Maybe [Language]) Source #
The list of supported languages.
listLanguagesResponse_nextToken :: Lens' ListLanguagesResponse (Maybe Text) Source #
If the response does not include all remaining results, use the NextToken in the next request to fetch the next group of supported languages.
listLanguagesResponse_httpStatus :: Lens' ListLanguagesResponse Int Source #
The response's http status code.
ListParallelData
listParallelData_maxResults :: Lens' ListParallelData (Maybe Natural) Source #
The maximum number of parallel data resources returned for each request.
listParallelData_nextToken :: Lens' ListParallelData (Maybe Text) Source #
A string that specifies the next page of results to return in a paginated response.
listParallelDataResponse_nextToken :: Lens' ListParallelDataResponse (Maybe Text) Source #
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.
listParallelDataResponse_parallelDataPropertiesList :: Lens' ListParallelDataResponse (Maybe [ParallelDataProperties]) Source #
The properties of the parallel data resources returned by this request.
listParallelDataResponse_httpStatus :: Lens' ListParallelDataResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN) of the given Amazon Translate resource you are querying.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #
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.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
ListTerminologies
listTerminologies_maxResults :: Lens' ListTerminologies (Maybe Natural) Source #
The maximum number of custom terminologies returned per list request.
listTerminologies_nextToken :: Lens' ListTerminologies (Maybe Text) Source #
If the result of the request to ListTerminologies was truncated, include the NextToken to fetch the next group of custom terminologies.
listTerminologiesResponse_nextToken :: Lens' ListTerminologiesResponse (Maybe Text) Source #
If the response to the ListTerminologies was truncated, the NextToken fetches the next group of custom terminologies.
listTerminologiesResponse_terminologyPropertiesList :: Lens' ListTerminologiesResponse (Maybe [TerminologyProperties]) Source #
The properties list of the custom terminologies returned on the list request.
listTerminologiesResponse_httpStatus :: Lens' ListTerminologiesResponse Int Source #
The response's http status code.
ListTextTranslationJobs
listTextTranslationJobs_filter :: Lens' ListTextTranslationJobs (Maybe TextTranslationJobFilter) Source #
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.
listTextTranslationJobs_maxResults :: Lens' ListTextTranslationJobs (Maybe Natural) Source #
The maximum number of results to return in each page. The default value is 100.
listTextTranslationJobs_nextToken :: Lens' ListTextTranslationJobs (Maybe Text) Source #
The token to request the next page of results.
listTextTranslationJobsResponse_nextToken :: Lens' ListTextTranslationJobsResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
listTextTranslationJobsResponse_textTranslationJobPropertiesList :: Lens' ListTextTranslationJobsResponse (Maybe [TextTranslationJobProperties]) Source #
A list containing the properties of each job that is returned.
listTextTranslationJobsResponse_httpStatus :: Lens' ListTextTranslationJobsResponse Int Source #
The response's http status code.
StartTextTranslationJob
startTextTranslationJob_jobName :: Lens' StartTextTranslationJob (Maybe Text) Source #
The name of the batch translation job to be performed.
startTextTranslationJob_parallelDataNames :: Lens' StartTextTranslationJob (Maybe [Text]) Source #
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.
startTextTranslationJob_settings :: Lens' StartTextTranslationJob (Maybe TranslationSettings) Source #
Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.
startTextTranslationJob_terminologyNames :: Lens' StartTextTranslationJob (Maybe [Text]) Source #
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.
startTextTranslationJob_inputDataConfig :: Lens' StartTextTranslationJob InputDataConfig Source #
Specifies the format and location of the input documents for the translation job.
startTextTranslationJob_outputDataConfig :: Lens' StartTextTranslationJob OutputDataConfig Source #
Specifies the S3 folder to which your job output will be saved.
startTextTranslationJob_dataAccessRoleArn :: Lens' StartTextTranslationJob Text Source #
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 .
startTextTranslationJob_sourceLanguageCode :: Lens' StartTextTranslationJob Text Source #
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.
startTextTranslationJob_targetLanguageCodes :: Lens' StartTextTranslationJob (NonEmpty Text) Source #
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.
startTextTranslationJob_clientToken :: Lens' StartTextTranslationJob Text Source #
A unique identifier for the request. This token is generated for you when using the Amazon Translate SDK.
startTextTranslationJobResponse_jobId :: Lens' StartTextTranslationJobResponse (Maybe Text) Source #
The identifier generated for the job. To get the status of a job, use this ID with the DescribeTextTranslationJob operation.
startTextTranslationJobResponse_jobStatus :: Lens' StartTextTranslationJobResponse (Maybe JobStatus) Source #
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.
startTextTranslationJobResponse_httpStatus :: Lens' StartTextTranslationJobResponse Int Source #
The response's http status code.
StopTextTranslationJob
stopTextTranslationJob_jobId :: Lens' StopTextTranslationJob Text Source #
The job ID of the job to be stopped.
stopTextTranslationJobResponse_jobId :: Lens' StopTextTranslationJobResponse (Maybe Text) Source #
The job ID of the stopped batch translation job.
stopTextTranslationJobResponse_jobStatus :: Lens' StopTextTranslationJobResponse (Maybe JobStatus) Source #
The status of the designated job. Upon successful completion, the job's
status will be STOPPED
.
stopTextTranslationJobResponse_httpStatus :: Lens' StopTextTranslationJobResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) of the given Amazon Translate resource to which you want to associate the tags.
tagResource_tags :: Lens' TagResource [Tag] Source #
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.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
TranslateText
translateText_settings :: Lens' TranslateText (Maybe TranslationSettings) Source #
Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.
translateText_terminologyNames :: Lens' TranslateText (Maybe [Text]) Source #
The name of the terminology list file to be used in the TranslateText
request. You can use 1 terminology list at most in a TranslateText
request. Terminology lists can contain a maximum of 256 terms.
translateText_text :: Lens' TranslateText Text Source #
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.
translateText_sourceLanguageCode :: Lens' TranslateText Text Source #
The language code for the language of the source text. The language must be a language supported by Amazon Translate. 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.
translateText_targetLanguageCode :: Lens' TranslateText Text Source #
The language code requested for the language of the target text. The language must be a language supported by Amazon Translate.
translateTextResponse_appliedSettings :: Lens' TranslateTextResponse (Maybe TranslationSettings) Source #
Settings that configure the translation output.
translateTextResponse_appliedTerminologies :: Lens' TranslateTextResponse (Maybe [AppliedTerminology]) Source #
The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.
translateTextResponse_httpStatus :: Lens' TranslateTextResponse Int Source #
The response's http status code.
translateTextResponse_translatedText :: Lens' TranslateTextResponse Text Source #
The translated text.
translateTextResponse_sourceLanguageCode :: Lens' TranslateTextResponse Text Source #
The language code for the language of the source text.
translateTextResponse_targetLanguageCode :: Lens' TranslateTextResponse Text Source #
The language code for the language of the target text.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The Amazon Resource Name (ARN) of the given Amazon Translate resource from which you want to remove the tags.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
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.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateParallelData
updateParallelData_description :: Lens' UpdateParallelData (Maybe Text) Source #
A custom description for the parallel data resource in Amazon Translate.
updateParallelData_name :: Lens' UpdateParallelData Text Source #
The name of the parallel data resource being updated.
updateParallelData_parallelDataConfig :: Lens' UpdateParallelData ParallelDataConfig Source #
Specifies the format and S3 location of the parallel data input file.
updateParallelData_clientToken :: Lens' UpdateParallelData Text Source #
A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.
updateParallelDataResponse_latestUpdateAttemptAt :: Lens' UpdateParallelDataResponse (Maybe UTCTime) Source #
The time that the most recent update was attempted.
updateParallelDataResponse_latestUpdateAttemptStatus :: Lens' UpdateParallelDataResponse (Maybe ParallelDataStatus) Source #
The status of the parallel data update attempt. When the updated
parallel data resource is ready for you to use, the status is ACTIVE
.
updateParallelDataResponse_name :: Lens' UpdateParallelDataResponse (Maybe Text) Source #
The name of the parallel data resource being updated.
updateParallelDataResponse_status :: Lens' UpdateParallelDataResponse (Maybe ParallelDataStatus) Source #
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
.
updateParallelDataResponse_httpStatus :: Lens' UpdateParallelDataResponse Int Source #
The response's http status code.
Types
AppliedTerminology
appliedTerminology_name :: Lens' AppliedTerminology (Maybe Text) Source #
The name of the custom terminology applied to the input text by Amazon Translate for the translated text response.
appliedTerminology_terms :: Lens' AppliedTerminology (Maybe [Term]) Source #
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.
EncryptionKey
encryptionKey_type :: Lens' EncryptionKey EncryptionKeyType Source #
The type of encryption key used by Amazon Translate to encrypt this object.
encryptionKey_id :: Lens' EncryptionKey Text Source #
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
InputDataConfig
inputDataConfig_s3Uri :: Lens' InputDataConfig Text Source #
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.
inputDataConfig_contentType :: Lens' InputDataConfig Text Source #
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 thehtml
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.
JobDetails
jobDetails_documentsWithErrorsCount :: Lens' JobDetails (Maybe Int) Source #
The number of documents that could not be processed during a translation job.
jobDetails_inputDocumentsCount :: Lens' JobDetails (Maybe Int) Source #
The number of documents used as input in a translation job.
jobDetails_translatedDocumentsCount :: Lens' JobDetails (Maybe Int) Source #
The number of documents successfully processed during a translation job.
Language
OutputDataConfig
outputDataConfig_encryptionKey :: Lens' OutputDataConfig (Maybe EncryptionKey) Source #
Undocumented member.
outputDataConfig_s3Uri :: Lens' OutputDataConfig Text Source #
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.
ParallelDataConfig
parallelDataConfig_s3Uri :: Lens' ParallelDataConfig Text Source #
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.
parallelDataConfig_format :: Lens' ParallelDataConfig ParallelDataFormat Source #
The format of the parallel data input file.
ParallelDataDataLocation
parallelDataDataLocation_repositoryType :: Lens' ParallelDataDataLocation Text Source #
Describes the repository that contains the parallel data input file.
parallelDataDataLocation_location :: Lens' ParallelDataDataLocation Text Source #
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.
ParallelDataProperties
parallelDataProperties_arn :: Lens' ParallelDataProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the parallel data resource.
parallelDataProperties_createdAt :: Lens' ParallelDataProperties (Maybe UTCTime) Source #
The time at which the parallel data resource was created.
parallelDataProperties_description :: Lens' ParallelDataProperties (Maybe Text) Source #
The description assigned to the parallel data resource.
parallelDataProperties_encryptionKey :: Lens' ParallelDataProperties (Maybe EncryptionKey) Source #
Undocumented member.
parallelDataProperties_failedRecordCount :: Lens' ParallelDataProperties (Maybe Integer) Source #
The number of records unsuccessfully imported from the parallel data input file.
parallelDataProperties_importedDataSize :: Lens' ParallelDataProperties (Maybe Integer) Source #
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.
parallelDataProperties_importedRecordCount :: Lens' ParallelDataProperties (Maybe Integer) Source #
The number of records successfully imported from the parallel data input file.
parallelDataProperties_lastUpdatedAt :: Lens' ParallelDataProperties (Maybe UTCTime) Source #
The time at which the parallel data resource was last updated.
parallelDataProperties_latestUpdateAttemptAt :: Lens' ParallelDataProperties (Maybe UTCTime) Source #
The time that the most recent update was attempted.
parallelDataProperties_latestUpdateAttemptStatus :: Lens' ParallelDataProperties (Maybe ParallelDataStatus) Source #
The status of the most recent update attempt for the parallel data resource.
parallelDataProperties_message :: Lens' ParallelDataProperties (Maybe Text) Source #
Additional information from Amazon Translate about the parallel data resource.
parallelDataProperties_name :: Lens' ParallelDataProperties (Maybe Text) Source #
The custom name assigned to the parallel data resource.
parallelDataProperties_parallelDataConfig :: Lens' ParallelDataProperties (Maybe ParallelDataConfig) Source #
Specifies the format and S3 location of the parallel data input file.
parallelDataProperties_skippedRecordCount :: Lens' ParallelDataProperties (Maybe Integer) Source #
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.
parallelDataProperties_sourceLanguageCode :: Lens' ParallelDataProperties (Maybe Text) Source #
The source language of the translations in the parallel data file.
parallelDataProperties_status :: Lens' ParallelDataProperties (Maybe ParallelDataStatus) Source #
The status of the parallel data resource. When the parallel data is
ready for you to use, the status is ACTIVE
.
parallelDataProperties_targetLanguageCodes :: Lens' ParallelDataProperties (Maybe [Text]) Source #
The language codes for the target languages available in the parallel data file. All possible target languages are returned as an array.
Tag
tag_key :: Lens' Tag Text Source #
The initial part of a key-value pair that forms a tag associated with a given resource.
tag_value :: Lens' Tag Text Source #
The second part of a key-value pair that forms a tag associated with a given resource.
Term
term_sourceText :: Lens' Term (Maybe Text) Source #
The source text of the term being translated by the custom terminology.
term_targetText :: Lens' Term (Maybe Text) Source #
The target text of the term being translated by the custom terminology.
TerminologyData
terminologyData_directionality :: Lens' TerminologyData (Maybe Directionality) Source #
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.
terminologyData_file :: Lens' TerminologyData ByteString Source #
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.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
terminologyData_format :: Lens' TerminologyData TerminologyDataFormat Source #
The data format of the custom terminology.
TerminologyDataLocation
terminologyDataLocation_repositoryType :: Lens' TerminologyDataLocation Text Source #
The repository type for the custom terminology data.
terminologyDataLocation_location :: Lens' TerminologyDataLocation Text Source #
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.
TerminologyProperties
terminologyProperties_arn :: Lens' TerminologyProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the custom terminology.
terminologyProperties_createdAt :: Lens' TerminologyProperties (Maybe UTCTime) Source #
The time at which the custom terminology was created, based on the timestamp.
terminologyProperties_description :: Lens' TerminologyProperties (Maybe Text) Source #
The description of the custom terminology properties.
terminologyProperties_directionality :: Lens' TerminologyProperties (Maybe Directionality) Source #
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.
terminologyProperties_encryptionKey :: Lens' TerminologyProperties (Maybe EncryptionKey) Source #
The encryption key for the custom terminology.
terminologyProperties_format :: Lens' TerminologyProperties (Maybe TerminologyDataFormat) Source #
The format of the custom terminology input file.
terminologyProperties_lastUpdatedAt :: Lens' TerminologyProperties (Maybe UTCTime) Source #
The time at which the custom terminology was last update, based on the timestamp.
terminologyProperties_message :: Lens' TerminologyProperties (Maybe Text) Source #
Additional information from Amazon Translate about the terminology resource.
terminologyProperties_name :: Lens' TerminologyProperties (Maybe Text) Source #
The name of the custom terminology.
terminologyProperties_sizeBytes :: Lens' TerminologyProperties (Maybe Int) Source #
The size of the file used when importing a custom terminology.
terminologyProperties_skippedTermCount :: Lens' TerminologyProperties (Maybe Int) Source #
The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.
terminologyProperties_sourceLanguageCode :: Lens' TerminologyProperties (Maybe Text) Source #
The language code for the source text of the translation request for which the custom terminology is being used.
terminologyProperties_targetLanguageCodes :: Lens' TerminologyProperties (Maybe [Text]) Source #
The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.
terminologyProperties_termCount :: Lens' TerminologyProperties (Maybe Int) Source #
The number of terms included in the custom terminology.
TextTranslationJobFilter
textTranslationJobFilter_jobName :: Lens' TextTranslationJobFilter (Maybe Text) Source #
Filters the list of jobs by name.
textTranslationJobFilter_jobStatus :: Lens' TextTranslationJobFilter (Maybe JobStatus) Source #
Filters the list of jobs based by job status.
textTranslationJobFilter_submittedAfterTime :: Lens' TextTranslationJobFilter (Maybe UTCTime) Source #
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.
textTranslationJobFilter_submittedBeforeTime :: Lens' TextTranslationJobFilter (Maybe UTCTime) Source #
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.
TextTranslationJobProperties
textTranslationJobProperties_dataAccessRoleArn :: Lens' TextTranslationJobProperties (Maybe Text) Source #
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.
textTranslationJobProperties_endTime :: Lens' TextTranslationJobProperties (Maybe UTCTime) Source #
The time at which the translation job ended.
textTranslationJobProperties_inputDataConfig :: Lens' TextTranslationJobProperties (Maybe InputDataConfig) Source #
The input configuration properties that were specified when the job was requested.
textTranslationJobProperties_jobDetails :: Lens' TextTranslationJobProperties (Maybe JobDetails) Source #
The number of documents successfully and unsuccessfully processed during the translation job.
textTranslationJobProperties_jobId :: Lens' TextTranslationJobProperties (Maybe Text) Source #
The ID of the translation job.
textTranslationJobProperties_jobName :: Lens' TextTranslationJobProperties (Maybe Text) Source #
The user-defined name of the translation job.
textTranslationJobProperties_jobStatus :: Lens' TextTranslationJobProperties (Maybe JobStatus) Source #
The status of the translation job.
textTranslationJobProperties_message :: Lens' TextTranslationJobProperties (Maybe Text) Source #
An explanation of any errors that may have occurred during the translation job.
textTranslationJobProperties_outputDataConfig :: Lens' TextTranslationJobProperties (Maybe OutputDataConfig) Source #
The output configuration properties that were specified when the job was requested.
textTranslationJobProperties_parallelDataNames :: Lens' TextTranslationJobProperties (Maybe [Text]) Source #
A list containing the names of the parallel data resources applied to the translation job.
textTranslationJobProperties_settings :: Lens' TextTranslationJobProperties (Maybe TranslationSettings) Source #
Settings that configure the translation output.
textTranslationJobProperties_sourceLanguageCode :: Lens' TextTranslationJobProperties (Maybe Text) Source #
The language code of the language of the source text. The language must be a language supported by Amazon Translate.
textTranslationJobProperties_submittedTime :: Lens' TextTranslationJobProperties (Maybe UTCTime) Source #
The time at which the translation job was submitted.
textTranslationJobProperties_targetLanguageCodes :: Lens' TextTranslationJobProperties (Maybe (NonEmpty Text)) Source #
The language code of the language of the target text. The language must be a language supported by Amazon Translate.
textTranslationJobProperties_terminologyNames :: Lens' TextTranslationJobProperties (Maybe [Text]) Source #
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.
TranslationSettings
translationSettings_formality :: Lens' TranslationSettings (Maybe Formality) Source #
You can optionally 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.
translationSettings_profanity :: Lens' TranslationSettings (Maybe Profanity) Source #
Enable the profanity setting if you want Amazon Translate 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.