| 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 |
Amazonka.Translate.Types
Contents
- Service Configuration
- Errors
- Directionality
- DisplayLanguageCode
- EncryptionKeyType
- Formality
- JobStatus
- MergeStrategy
- ParallelDataFormat
- ParallelDataStatus
- Profanity
- TerminologyDataFormat
- AppliedTerminology
- EncryptionKey
- InputDataConfig
- JobDetails
- Language
- OutputDataConfig
- ParallelDataConfig
- ParallelDataDataLocation
- ParallelDataProperties
- Tag
- Term
- TerminologyData
- TerminologyDataLocation
- TerminologyProperties
- TextTranslationJobFilter
- TextTranslationJobProperties
- TranslationSettings
Description
Synopsis
- defaultService :: Service
- _ConcurrentModificationException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _DetectedLanguageLowConfidenceException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _InvalidFilterException :: AsError a => Fold a ServiceError
- _InvalidParameterValueException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- _TextSizeLimitExceededException :: AsError a => Fold a ServiceError
- _TooManyRequestsException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- _UnsupportedDisplayLanguageCodeException :: AsError a => Fold a ServiceError
- _UnsupportedLanguagePairException :: AsError a => Fold a ServiceError
- newtype Directionality where
- Directionality' { }
- pattern Directionality_MULTI :: Directionality
- pattern Directionality_UNI :: Directionality
- newtype DisplayLanguageCode where
- DisplayLanguageCode' { }
- pattern DisplayLanguageCode_De :: DisplayLanguageCode
- pattern DisplayLanguageCode_En :: DisplayLanguageCode
- pattern DisplayLanguageCode_Es :: DisplayLanguageCode
- pattern DisplayLanguageCode_Fr :: DisplayLanguageCode
- pattern DisplayLanguageCode_It :: DisplayLanguageCode
- pattern DisplayLanguageCode_Ja :: DisplayLanguageCode
- pattern DisplayLanguageCode_Ko :: DisplayLanguageCode
- pattern DisplayLanguageCode_Pt :: DisplayLanguageCode
- pattern DisplayLanguageCode_Zh :: DisplayLanguageCode
- pattern DisplayLanguageCode_Zh_TW :: DisplayLanguageCode
- newtype EncryptionKeyType where
- EncryptionKeyType' { }
- pattern EncryptionKeyType_KMS :: EncryptionKeyType
- newtype Formality where
- Formality' { }
- pattern Formality_FORMAL :: Formality
- pattern Formality_INFORMAL :: Formality
- newtype JobStatus where
- JobStatus' { }
- pattern JobStatus_COMPLETED :: JobStatus
- pattern JobStatus_COMPLETED_WITH_ERROR :: JobStatus
- pattern JobStatus_FAILED :: JobStatus
- pattern JobStatus_IN_PROGRESS :: JobStatus
- pattern JobStatus_STOPPED :: JobStatus
- pattern JobStatus_STOP_REQUESTED :: JobStatus
- pattern JobStatus_SUBMITTED :: JobStatus
- newtype MergeStrategy where
- MergeStrategy' { }
- pattern MergeStrategy_OVERWRITE :: MergeStrategy
- newtype ParallelDataFormat where
- ParallelDataFormat' { }
- pattern ParallelDataFormat_CSV :: ParallelDataFormat
- pattern ParallelDataFormat_TMX :: ParallelDataFormat
- pattern ParallelDataFormat_TSV :: ParallelDataFormat
- newtype ParallelDataStatus where
- ParallelDataStatus' { }
- pattern ParallelDataStatus_ACTIVE :: ParallelDataStatus
- pattern ParallelDataStatus_CREATING :: ParallelDataStatus
- pattern ParallelDataStatus_DELETING :: ParallelDataStatus
- pattern ParallelDataStatus_FAILED :: ParallelDataStatus
- pattern ParallelDataStatus_UPDATING :: ParallelDataStatus
- newtype Profanity where
- Profanity' { }
- pattern Profanity_MASK :: Profanity
- newtype TerminologyDataFormat where
- data AppliedTerminology = AppliedTerminology' {}
- newAppliedTerminology :: AppliedTerminology
- appliedTerminology_name :: Lens' AppliedTerminology (Maybe Text)
- appliedTerminology_terms :: Lens' AppliedTerminology (Maybe [Term])
- data EncryptionKey = EncryptionKey' {
- type' :: EncryptionKeyType
- id :: Text
- newEncryptionKey :: EncryptionKeyType -> Text -> EncryptionKey
- encryptionKey_type :: Lens' EncryptionKey EncryptionKeyType
- encryptionKey_id :: Lens' EncryptionKey Text
- data InputDataConfig = InputDataConfig' {
- s3Uri :: Text
- contentType :: Text
- newInputDataConfig :: Text -> Text -> InputDataConfig
- inputDataConfig_s3Uri :: Lens' InputDataConfig Text
- inputDataConfig_contentType :: Lens' InputDataConfig Text
- data JobDetails = JobDetails' {}
- newJobDetails :: JobDetails
- jobDetails_documentsWithErrorsCount :: Lens' JobDetails (Maybe Int)
- jobDetails_inputDocumentsCount :: Lens' JobDetails (Maybe Int)
- jobDetails_translatedDocumentsCount :: Lens' JobDetails (Maybe Int)
- data Language = Language' {
- languageName :: Text
- languageCode :: Text
- newLanguage :: Text -> Text -> Language
- language_languageName :: Lens' Language Text
- language_languageCode :: Lens' Language Text
- data OutputDataConfig = OutputDataConfig' {}
- newOutputDataConfig :: Text -> OutputDataConfig
- outputDataConfig_encryptionKey :: Lens' OutputDataConfig (Maybe EncryptionKey)
- outputDataConfig_s3Uri :: Lens' OutputDataConfig Text
- data ParallelDataConfig = ParallelDataConfig' {}
- newParallelDataConfig :: Text -> ParallelDataFormat -> ParallelDataConfig
- parallelDataConfig_s3Uri :: Lens' ParallelDataConfig Text
- parallelDataConfig_format :: Lens' ParallelDataConfig ParallelDataFormat
- data ParallelDataDataLocation = ParallelDataDataLocation' {
- repositoryType :: Text
- location :: Text
- newParallelDataDataLocation :: Text -> Text -> ParallelDataDataLocation
- parallelDataDataLocation_repositoryType :: Lens' ParallelDataDataLocation Text
- parallelDataDataLocation_location :: Lens' ParallelDataDataLocation Text
- data ParallelDataProperties = ParallelDataProperties' {
- arn :: Maybe Text
- createdAt :: Maybe POSIX
- description :: Maybe Text
- encryptionKey :: Maybe EncryptionKey
- failedRecordCount :: Maybe Integer
- importedDataSize :: Maybe Integer
- importedRecordCount :: Maybe Integer
- lastUpdatedAt :: Maybe POSIX
- latestUpdateAttemptAt :: Maybe POSIX
- latestUpdateAttemptStatus :: Maybe ParallelDataStatus
- message :: Maybe Text
- name :: Maybe Text
- parallelDataConfig :: Maybe ParallelDataConfig
- skippedRecordCount :: Maybe Integer
- sourceLanguageCode :: Maybe Text
- status :: Maybe ParallelDataStatus
- targetLanguageCodes :: Maybe [Text]
- newParallelDataProperties :: ParallelDataProperties
- 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])
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data Term = Term' {
- sourceText :: Maybe Text
- targetText :: Maybe Text
- newTerm :: Term
- term_sourceText :: Lens' Term (Maybe Text)
- term_targetText :: Lens' Term (Maybe Text)
- data TerminologyData = TerminologyData' {}
- newTerminologyData :: ByteString -> TerminologyDataFormat -> TerminologyData
- terminologyData_directionality :: Lens' TerminologyData (Maybe Directionality)
- terminologyData_file :: Lens' TerminologyData ByteString
- terminologyData_format :: Lens' TerminologyData TerminologyDataFormat
- data TerminologyDataLocation = TerminologyDataLocation' {
- repositoryType :: Text
- location :: Text
- newTerminologyDataLocation :: Text -> Text -> TerminologyDataLocation
- terminologyDataLocation_repositoryType :: Lens' TerminologyDataLocation Text
- terminologyDataLocation_location :: Lens' TerminologyDataLocation Text
- data TerminologyProperties = TerminologyProperties' {
- arn :: Maybe Text
- createdAt :: Maybe POSIX
- description :: Maybe Text
- directionality :: Maybe Directionality
- encryptionKey :: Maybe EncryptionKey
- format :: Maybe TerminologyDataFormat
- lastUpdatedAt :: Maybe POSIX
- message :: Maybe Text
- name :: Maybe Text
- sizeBytes :: Maybe Int
- skippedTermCount :: Maybe Int
- sourceLanguageCode :: Maybe Text
- targetLanguageCodes :: Maybe [Text]
- termCount :: Maybe Int
- newTerminologyProperties :: TerminologyProperties
- 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)
- data TextTranslationJobFilter = TextTranslationJobFilter' {}
- newTextTranslationJobFilter :: TextTranslationJobFilter
- textTranslationJobFilter_jobName :: Lens' TextTranslationJobFilter (Maybe Text)
- textTranslationJobFilter_jobStatus :: Lens' TextTranslationJobFilter (Maybe JobStatus)
- textTranslationJobFilter_submittedAfterTime :: Lens' TextTranslationJobFilter (Maybe UTCTime)
- textTranslationJobFilter_submittedBeforeTime :: Lens' TextTranslationJobFilter (Maybe UTCTime)
- data TextTranslationJobProperties = TextTranslationJobProperties' {
- dataAccessRoleArn :: Maybe Text
- endTime :: Maybe POSIX
- inputDataConfig :: Maybe InputDataConfig
- jobDetails :: Maybe JobDetails
- jobId :: Maybe Text
- jobName :: Maybe Text
- jobStatus :: Maybe JobStatus
- message :: Maybe Text
- outputDataConfig :: Maybe OutputDataConfig
- parallelDataNames :: Maybe [Text]
- settings :: Maybe TranslationSettings
- sourceLanguageCode :: Maybe Text
- submittedTime :: Maybe POSIX
- targetLanguageCodes :: Maybe (NonEmpty Text)
- terminologyNames :: Maybe [Text]
- newTextTranslationJobProperties :: TextTranslationJobProperties
- 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])
- data TranslationSettings = TranslationSettings' {}
- newTranslationSettings :: TranslationSettings
- translationSettings_formality :: Lens' TranslationSettings (Maybe Formality)
- translationSettings_profanity :: Lens' TranslationSettings (Maybe Profanity)
Service Configuration
defaultService :: Service Source #
API version 2017-07-01 of the Amazon Translate SDK configuration.
Errors
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
Another modification is being made. That modification must complete before you can make your change.
_ConflictException :: AsError a => Fold a ServiceError Source #
There was a conflict processing the request. Try your request again.
_DetectedLanguageLowConfidenceException :: AsError a => Fold a ServiceError Source #
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.
_InternalServerException :: AsError a => Fold a ServiceError Source #
An internal server error occurred. Retry your request.
_InvalidFilterException :: AsError a => Fold a ServiceError Source #
The filter specified for the operation is not valid. Specify a different filter.
_InvalidParameterValueException :: AsError a => Fold a ServiceError Source #
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.
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The specified limit has been exceeded. Review your request and retry it with a quantity below the stated limit.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
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.
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The Amazon Translate service is temporarily unavailable. Wait a bit and then retry your request.
_TextSizeLimitExceededException :: AsError a => Fold a ServiceError Source #
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.
_TooManyRequestsException :: AsError a => Fold a ServiceError Source #
You have made too many requests within a short period of time. Wait for a short time and then try your request again.
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
You have added too many tags to this resource. The maximum is 50 tags.
_UnsupportedDisplayLanguageCodeException :: AsError a => Fold a ServiceError Source #
Requested display language code is not supported.
_UnsupportedLanguagePairException :: AsError a => Fold a ServiceError Source #
Amazon Translate does not support translation from the language of the source text into the requested target language. For more information, see Error messages.
Directionality
newtype Directionality Source #
Constructors
| Directionality' | |
Fields | |
Bundled Patterns
| pattern Directionality_MULTI :: Directionality | |
| pattern Directionality_UNI :: Directionality |
Instances
DisplayLanguageCode
newtype DisplayLanguageCode Source #
Constructors
| DisplayLanguageCode' | |
Fields | |
Bundled Patterns
| pattern DisplayLanguageCode_De :: DisplayLanguageCode | |
| pattern DisplayLanguageCode_En :: DisplayLanguageCode | |
| pattern DisplayLanguageCode_Es :: DisplayLanguageCode | |
| pattern DisplayLanguageCode_Fr :: DisplayLanguageCode | |
| pattern DisplayLanguageCode_It :: DisplayLanguageCode | |
| pattern DisplayLanguageCode_Ja :: DisplayLanguageCode | |
| pattern DisplayLanguageCode_Ko :: DisplayLanguageCode | |
| pattern DisplayLanguageCode_Pt :: DisplayLanguageCode | |
| pattern DisplayLanguageCode_Zh :: DisplayLanguageCode | |
| pattern DisplayLanguageCode_Zh_TW :: DisplayLanguageCode |
Instances
EncryptionKeyType
newtype EncryptionKeyType Source #
Constructors
| EncryptionKeyType' | |
Fields | |
Bundled Patterns
| pattern EncryptionKeyType_KMS :: EncryptionKeyType |
Instances
Formality
Constructors
| Formality' | |
Fields | |
Bundled Patterns
| pattern Formality_FORMAL :: Formality | |
| pattern Formality_INFORMAL :: Formality |
Instances
JobStatus
Constructors
| JobStatus' | |
Fields | |
Bundled Patterns
| pattern JobStatus_COMPLETED :: JobStatus | |
| pattern JobStatus_COMPLETED_WITH_ERROR :: JobStatus | |
| pattern JobStatus_FAILED :: JobStatus | |
| pattern JobStatus_IN_PROGRESS :: JobStatus | |
| pattern JobStatus_STOPPED :: JobStatus | |
| pattern JobStatus_STOP_REQUESTED :: JobStatus | |
| pattern JobStatus_SUBMITTED :: JobStatus |
Instances
MergeStrategy
newtype MergeStrategy Source #
Constructors
| MergeStrategy' | |
Fields | |
Bundled Patterns
| pattern MergeStrategy_OVERWRITE :: MergeStrategy |
Instances
ParallelDataFormat
newtype ParallelDataFormat Source #
Constructors
| ParallelDataFormat' | |
Fields | |
Bundled Patterns
| pattern ParallelDataFormat_CSV :: ParallelDataFormat | |
| pattern ParallelDataFormat_TMX :: ParallelDataFormat | |
| pattern ParallelDataFormat_TSV :: ParallelDataFormat |
Instances
ParallelDataStatus
newtype ParallelDataStatus Source #
Constructors
| ParallelDataStatus' | |
Fields | |
Bundled Patterns
| pattern ParallelDataStatus_ACTIVE :: ParallelDataStatus | |
| pattern ParallelDataStatus_CREATING :: ParallelDataStatus | |
| pattern ParallelDataStatus_DELETING :: ParallelDataStatus | |
| pattern ParallelDataStatus_FAILED :: ParallelDataStatus | |
| pattern ParallelDataStatus_UPDATING :: ParallelDataStatus |
Instances
Profanity
Constructors
| Profanity' | |
Fields | |
Bundled Patterns
| pattern Profanity_MASK :: Profanity |
Instances
TerminologyDataFormat
newtype TerminologyDataFormat Source #
Constructors
| TerminologyDataFormat' | |
Fields | |
Bundled Patterns
| pattern TerminologyDataFormat_CSV :: TerminologyDataFormat | |
| pattern TerminologyDataFormat_TMX :: TerminologyDataFormat | |
| pattern TerminologyDataFormat_TSV :: TerminologyDataFormat |
Instances
AppliedTerminology
data AppliedTerminology Source #
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.
See: newAppliedTerminology smart constructor.
Constructors
| AppliedTerminology' | |
Fields
| |
Instances
newAppliedTerminology :: AppliedTerminology Source #
Create a value of AppliedTerminology with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:AppliedTerminology', appliedTerminology_name - The name of the custom terminology applied to the input text by Amazon
Translate for the translated text response.
$sel:terms:AppliedTerminology', appliedTerminology_terms - 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.
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
data EncryptionKey Source #
The encryption key used to encrypt this object.
See: newEncryptionKey smart constructor.
Constructors
| EncryptionKey' | |
Fields
| |
Instances
Create a value of EncryptionKey with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':EncryptionKey', encryptionKey_type - The type of encryption key used by Amazon Translate to encrypt this
object.
$sel:id:EncryptionKey', encryptionKey_id - The Amazon Resource Name (ARN) of the encryption key being used to
encrypt this object.
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
data InputDataConfig Source #
The input configuration properties for requesting a batch translation job.
See: newInputDataConfig smart constructor.
Constructors
| InputDataConfig' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> InputDataConfig |
Create a value of InputDataConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Uri:InputDataConfig', inputDataConfig_s3Uri - 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.
$sel:contentType:InputDataConfig', inputDataConfig_contentType - 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 thehtmlelement 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.
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 thehtmlelement 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
data JobDetails Source #
The number of documents successfully and unsuccessfully processed during a translation job.
See: newJobDetails smart constructor.
Constructors
| JobDetails' | |
Fields
| |
Instances
newJobDetails :: JobDetails Source #
Create a value of JobDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:documentsWithErrorsCount:JobDetails', jobDetails_documentsWithErrorsCount - The number of documents that could not be processed during a translation
job.
$sel:inputDocumentsCount:JobDetails', jobDetails_inputDocumentsCount - The number of documents used as input in a translation job.
$sel:translatedDocumentsCount:JobDetails', jobDetails_translatedDocumentsCount - The number of documents successfully processed during a translation job.
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
A supported language.
See: newLanguage smart constructor.
Constructors
| Language' | |
Fields
| |
Instances
| FromJSON Language Source # | |
| Generic Language Source # | |
| Read Language Source # | |
| Show Language Source # | |
| NFData Language Source # | |
Defined in Amazonka.Translate.Types.Language | |
| Eq Language Source # | |
| Hashable Language Source # | |
Defined in Amazonka.Translate.Types.Language | |
| type Rep Language Source # | |
Defined in Amazonka.Translate.Types.Language type Rep Language = D1 ('MetaData "Language" "Amazonka.Translate.Types.Language" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" 'False) (C1 ('MetaCons "Language'" 'PrefixI 'True) (S1 ('MetaSel ('Just "languageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Language with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:languageName:Language', language_languageName - Language name of the supported language.
$sel:languageCode:Language', language_languageCode - Language code for the supported language.
OutputDataConfig
data OutputDataConfig Source #
The output configuration properties for a batch translation job.
See: newOutputDataConfig smart constructor.
Constructors
| OutputDataConfig' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> OutputDataConfig |
Create a value of OutputDataConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encryptionKey:OutputDataConfig', outputDataConfig_encryptionKey - Undocumented member.
$sel:s3Uri:OutputDataConfig', outputDataConfig_s3Uri - 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.
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
data ParallelDataConfig Source #
Specifies the format and S3 location of the parallel data input file.
See: newParallelDataConfig smart constructor.
Constructors
| ParallelDataConfig' | |
Fields
| |
Instances
newParallelDataConfig Source #
Arguments
| :: Text | |
| -> ParallelDataFormat | |
| -> ParallelDataConfig |
Create a value of ParallelDataConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Uri:ParallelDataConfig', parallelDataConfig_s3Uri - 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.
$sel:format:ParallelDataConfig', parallelDataConfig_format - The format of the parallel data input file.
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
data ParallelDataDataLocation Source #
The location of the most recent parallel data input file that was successfully imported into Amazon Translate.
See: newParallelDataDataLocation smart constructor.
Constructors
| ParallelDataDataLocation' | |
Fields
| |
Instances
newParallelDataDataLocation Source #
Arguments
| :: Text | |
| -> Text | |
| -> ParallelDataDataLocation |
Create a value of ParallelDataDataLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:repositoryType:ParallelDataDataLocation', parallelDataDataLocation_repositoryType - Describes the repository that contains the parallel data input file.
$sel:location:ParallelDataDataLocation', parallelDataDataLocation_location - 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.
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
data ParallelDataProperties Source #
The properties of a parallel data resource.
See: newParallelDataProperties smart constructor.
Constructors
| ParallelDataProperties' | |
Fields
| |
Instances
newParallelDataProperties :: ParallelDataProperties Source #
Create a value of ParallelDataProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ParallelDataProperties', parallelDataProperties_arn - The Amazon Resource Name (ARN) of the parallel data resource.
$sel:createdAt:ParallelDataProperties', parallelDataProperties_createdAt - The time at which the parallel data resource was created.
$sel:description:ParallelDataProperties', parallelDataProperties_description - The description assigned to the parallel data resource.
$sel:encryptionKey:ParallelDataProperties', parallelDataProperties_encryptionKey - Undocumented member.
$sel:failedRecordCount:ParallelDataProperties', parallelDataProperties_failedRecordCount - The number of records unsuccessfully imported from the parallel data
input file.
$sel:importedDataSize:ParallelDataProperties', parallelDataProperties_importedDataSize - 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.
$sel:importedRecordCount:ParallelDataProperties', parallelDataProperties_importedRecordCount - The number of records successfully imported from the parallel data input
file.
$sel:lastUpdatedAt:ParallelDataProperties', parallelDataProperties_lastUpdatedAt - The time at which the parallel data resource was last updated.
$sel:latestUpdateAttemptAt:ParallelDataProperties', parallelDataProperties_latestUpdateAttemptAt - The time that the most recent update was attempted.
$sel:latestUpdateAttemptStatus:ParallelDataProperties', parallelDataProperties_latestUpdateAttemptStatus - The status of the most recent update attempt for the parallel data
resource.
$sel:message:ParallelDataProperties', parallelDataProperties_message - Additional information from Amazon Translate about the parallel data
resource.
$sel:name:ParallelDataProperties', parallelDataProperties_name - The custom name assigned to the parallel data resource.
$sel:parallelDataConfig:ParallelDataProperties', parallelDataProperties_parallelDataConfig - Specifies the format and S3 location of the parallel data input file.
$sel:skippedRecordCount:ParallelDataProperties', parallelDataProperties_skippedRecordCount - 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.
$sel:sourceLanguageCode:ParallelDataProperties', parallelDataProperties_sourceLanguageCode - The source language of the translations in the parallel data file.
$sel:status:ParallelDataProperties', parallelDataProperties_status - The status of the parallel data resource. When the parallel data is
ready for you to use, the status is ACTIVE.
$sel:targetLanguageCodes:ParallelDataProperties', parallelDataProperties_targetLanguageCodes - The language codes for the target languages available in the parallel
data file. All possible target languages are returned as an array.
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
A key-value pair that adds as a metadata to a resource used by Amazon Translate.
See: newTag smart constructor.
Constructors
| Tag' | |
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.Translate.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.Translate.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.Translate.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.Translate.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Translate.Types.Tag" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The initial part of a key-value pair that forms a tag associated with a
given resource.
$sel:value:Tag', tag_value - The second part of a key-value pair that forms a tag associated with a
given resource.
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
The term being translated by the custom terminology.
See: newTerm smart constructor.
Constructors
| Term' | |
Fields
| |
Instances
| FromJSON Term Source # | |
| Generic Term Source # | |
| Read Term Source # | |
| Show Term Source # | |
| NFData Term Source # | |
Defined in Amazonka.Translate.Types.Term | |
| Eq Term Source # | |
| Hashable Term Source # | |
Defined in Amazonka.Translate.Types.Term | |
| type Rep Term Source # | |
Defined in Amazonka.Translate.Types.Term type Rep Term = D1 ('MetaData "Term" "Amazonka.Translate.Types.Term" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" 'False) (C1 ('MetaCons "Term'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sourceText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "targetText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Term with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceText:Term', term_sourceText - The source text of the term being translated by the custom terminology.
$sel:targetText:Term', term_targetText - The target text of the term being translated by the custom terminology.
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
data TerminologyData Source #
The data associated with the custom terminology. For information about the custom terminology file, see Creating a Custom Terminology.
See: newTerminologyData smart constructor.
Constructors
| TerminologyData' | |
Fields
| |
Instances
Arguments
| :: ByteString | |
| -> TerminologyDataFormat | |
| -> TerminologyData |
Create a value of TerminologyData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:directionality:TerminologyData', terminologyData_directionality - 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.
$sel:file:TerminologyData', terminologyData_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.--
-- 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.
$sel:format:TerminologyData', terminologyData_format - The data format of the custom terminology.
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
data TerminologyDataLocation Source #
The location of the custom terminology data.
See: newTerminologyDataLocation smart constructor.
Constructors
| TerminologyDataLocation' | |
Fields
| |
Instances
newTerminologyDataLocation Source #
Arguments
| :: Text | |
| -> Text | |
| -> TerminologyDataLocation |
Create a value of TerminologyDataLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:repositoryType:TerminologyDataLocation', terminologyDataLocation_repositoryType - The repository type for the custom terminology data.
$sel:location:TerminologyDataLocation', terminologyDataLocation_location - 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.
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
data TerminologyProperties Source #
The properties of the custom terminology.
See: newTerminologyProperties smart constructor.
Constructors
| TerminologyProperties' | |
Fields
| |
Instances
newTerminologyProperties :: TerminologyProperties Source #
Create a value of TerminologyProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:TerminologyProperties', terminologyProperties_arn - The Amazon Resource Name (ARN) of the custom terminology.
$sel:createdAt:TerminologyProperties', terminologyProperties_createdAt - The time at which the custom terminology was created, based on the
timestamp.
$sel:description:TerminologyProperties', terminologyProperties_description - The description of the custom terminology properties.
$sel:directionality:TerminologyProperties', terminologyProperties_directionality - 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.
$sel:encryptionKey:TerminologyProperties', terminologyProperties_encryptionKey - The encryption key for the custom terminology.
$sel:format:TerminologyProperties', terminologyProperties_format - The format of the custom terminology input file.
$sel:lastUpdatedAt:TerminologyProperties', terminologyProperties_lastUpdatedAt - The time at which the custom terminology was last update, based on the
timestamp.
$sel:message:TerminologyProperties', terminologyProperties_message - Additional information from Amazon Translate about the terminology
resource.
$sel:name:TerminologyProperties', terminologyProperties_name - The name of the custom terminology.
$sel:sizeBytes:TerminologyProperties', terminologyProperties_sizeBytes - The size of the file used when importing a custom terminology.
$sel:skippedTermCount:TerminologyProperties', terminologyProperties_skippedTermCount - The number of terms in the input file that Amazon Translate skipped when
you created or updated the terminology resource.
$sel:sourceLanguageCode:TerminologyProperties', terminologyProperties_sourceLanguageCode - The language code for the source text of the translation request for
which the custom terminology is being used.
$sel:targetLanguageCodes:TerminologyProperties', terminologyProperties_targetLanguageCodes - The language codes for the target languages available with the custom
terminology resource. All possible target languages are returned in
array.
$sel:termCount:TerminologyProperties', terminologyProperties_termCount - The number of terms included in the custom terminology.
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
data TextTranslationJobFilter Source #
Provides information for filtering a list of translation jobs. For more information, see ListTextTranslationJobs.
See: newTextTranslationJobFilter smart constructor.
Constructors
| TextTranslationJobFilter' | |
Fields
| |
Instances
newTextTranslationJobFilter :: TextTranslationJobFilter Source #
Create a value of TextTranslationJobFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobName:TextTranslationJobFilter', textTranslationJobFilter_jobName - Filters the list of jobs by name.
$sel:jobStatus:TextTranslationJobFilter', textTranslationJobFilter_jobStatus - Filters the list of jobs based by job status.
$sel:submittedAfterTime:TextTranslationJobFilter', textTranslationJobFilter_submittedAfterTime - 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.
$sel:submittedBeforeTime:TextTranslationJobFilter', textTranslationJobFilter_submittedBeforeTime - 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.
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
data TextTranslationJobProperties Source #
Provides information about a translation job.
See: newTextTranslationJobProperties smart constructor.
Constructors
| TextTranslationJobProperties' | |
Fields
| |
Instances
newTextTranslationJobProperties :: TextTranslationJobProperties Source #
Create a value of TextTranslationJobProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataAccessRoleArn:TextTranslationJobProperties', textTranslationJobProperties_dataAccessRoleArn - 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.
$sel:endTime:TextTranslationJobProperties', textTranslationJobProperties_endTime - The time at which the translation job ended.
$sel:inputDataConfig:TextTranslationJobProperties', textTranslationJobProperties_inputDataConfig - The input configuration properties that were specified when the job was
requested.
$sel:jobDetails:TextTranslationJobProperties', textTranslationJobProperties_jobDetails - The number of documents successfully and unsuccessfully processed during
the translation job.
$sel:jobId:TextTranslationJobProperties', textTranslationJobProperties_jobId - The ID of the translation job.
$sel:jobName:TextTranslationJobProperties', textTranslationJobProperties_jobName - The user-defined name of the translation job.
$sel:jobStatus:TextTranslationJobProperties', textTranslationJobProperties_jobStatus - The status of the translation job.
$sel:message:TextTranslationJobProperties', textTranslationJobProperties_message - An explanation of any errors that may have occurred during the
translation job.
$sel:outputDataConfig:TextTranslationJobProperties', textTranslationJobProperties_outputDataConfig - The output configuration properties that were specified when the job was
requested.
$sel:parallelDataNames:TextTranslationJobProperties', textTranslationJobProperties_parallelDataNames - A list containing the names of the parallel data resources applied to
the translation job.
$sel:settings:TextTranslationJobProperties', textTranslationJobProperties_settings - Settings that configure the translation output.
$sel:sourceLanguageCode:TextTranslationJobProperties', textTranslationJobProperties_sourceLanguageCode - The language code of the language of the source text. The language must
be a language supported by Amazon Translate.
$sel:submittedTime:TextTranslationJobProperties', textTranslationJobProperties_submittedTime - The time at which the translation job was submitted.
$sel:targetLanguageCodes:TextTranslationJobProperties', textTranslationJobProperties_targetLanguageCodes - The language code of the language of the target text. The language must
be a language supported by Amazon Translate.
$sel:terminologyNames:TextTranslationJobProperties', textTranslationJobProperties_terminologyNames - 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.
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
data TranslationSettings Source #
Optional settings that configure the translation output. Use these settings for real time translations and asynchronous translation jobs.
See: newTranslationSettings smart constructor.
Constructors
| TranslationSettings' | |
Fields
| |
Instances
newTranslationSettings :: TranslationSettings Source #
Create a value of TranslationSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:formality:TranslationSettings', translationSettings_formality - 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.
$sel:profanity:TranslationSettings', translationSettings_profanity - 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.
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.