| 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
Contents
- Service Configuration
- Errors
- ConcurrentModificationException
- ConflictException
- DetectedLanguageLowConfidenceException
- InternalServerException
- InvalidFilterException
- InvalidParameterValueException
- InvalidRequestException
- LimitExceededException
- ResourceNotFoundException
- ServiceUnavailableException
- TextSizeLimitExceededException
- TooManyRequestsException
- TooManyTagsException
- UnsupportedDisplayLanguageCodeException
- UnsupportedLanguagePairException
- Waiters
- Operations
- CreateParallelData
- DeleteParallelData
- DeleteTerminology
- DescribeTextTranslationJob
- GetParallelData
- GetTerminology
- ImportTerminology
- ListLanguages
- ListParallelData
- ListTagsForResource
- ListTerminologies (Paginated)
- ListTextTranslationJobs
- StartTextTranslationJob
- StopTextTranslationJob
- TagResource
- TranslateText
- UntagResource
- UpdateParallelData
- Types
- 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
Derived from API version 2017-07-01 of the AWS service descriptions, licensed under Apache 2.0.
Provides translation of the input content from the source language to the target language.
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
- data CreateParallelData = CreateParallelData' (Maybe Text) (Maybe EncryptionKey) (Maybe [Tag]) Text ParallelDataConfig Text
- newCreateParallelData :: Text -> ParallelDataConfig -> Text -> CreateParallelData
- data CreateParallelDataResponse = CreateParallelDataResponse' (Maybe Text) (Maybe ParallelDataStatus) Int
- newCreateParallelDataResponse :: Int -> CreateParallelDataResponse
- data DeleteParallelData = DeleteParallelData' Text
- newDeleteParallelData :: Text -> DeleteParallelData
- data DeleteParallelDataResponse = DeleteParallelDataResponse' (Maybe Text) (Maybe ParallelDataStatus) Int
- newDeleteParallelDataResponse :: Int -> DeleteParallelDataResponse
- data DeleteTerminology = DeleteTerminology' Text
- newDeleteTerminology :: Text -> DeleteTerminology
- data DeleteTerminologyResponse = DeleteTerminologyResponse' {
- newDeleteTerminologyResponse :: DeleteTerminologyResponse
- data DescribeTextTranslationJob = DescribeTextTranslationJob' Text
- newDescribeTextTranslationJob :: Text -> DescribeTextTranslationJob
- data DescribeTextTranslationJobResponse = DescribeTextTranslationJobResponse' (Maybe TextTranslationJobProperties) Int
- newDescribeTextTranslationJobResponse :: Int -> DescribeTextTranslationJobResponse
- data GetParallelData = GetParallelData' Text
- newGetParallelData :: Text -> GetParallelData
- data GetParallelDataResponse = GetParallelDataResponse' (Maybe ParallelDataDataLocation) (Maybe ParallelDataDataLocation) (Maybe ParallelDataDataLocation) (Maybe ParallelDataProperties) Int
- newGetParallelDataResponse :: Int -> GetParallelDataResponse
- data GetTerminology = GetTerminology' (Maybe TerminologyDataFormat) Text
- newGetTerminology :: Text -> GetTerminology
- data GetTerminologyResponse = GetTerminologyResponse' (Maybe TerminologyDataLocation) (Maybe TerminologyDataLocation) (Maybe TerminologyProperties) Int
- newGetTerminologyResponse :: Int -> GetTerminologyResponse
- data ImportTerminology = ImportTerminology' (Maybe Text) (Maybe EncryptionKey) (Maybe [Tag]) Text MergeStrategy TerminologyData
- newImportTerminology :: Text -> MergeStrategy -> TerminologyData -> ImportTerminology
- data ImportTerminologyResponse = ImportTerminologyResponse' (Maybe TerminologyDataLocation) (Maybe TerminologyProperties) Int
- newImportTerminologyResponse :: Int -> ImportTerminologyResponse
- data ListLanguages = ListLanguages' (Maybe DisplayLanguageCode) (Maybe Natural) (Maybe Text)
- newListLanguages :: ListLanguages
- data ListLanguagesResponse = ListLanguagesResponse' (Maybe DisplayLanguageCode) (Maybe [Language]) (Maybe Text) Int
- newListLanguagesResponse :: Int -> ListLanguagesResponse
- data ListParallelData = ListParallelData' (Maybe Natural) (Maybe Text)
- newListParallelData :: ListParallelData
- data ListParallelDataResponse = ListParallelDataResponse' (Maybe Text) (Maybe [ParallelDataProperties]) Int
- newListParallelDataResponse :: Int -> ListParallelDataResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListTerminologies = ListTerminologies' (Maybe Natural) (Maybe Text)
- newListTerminologies :: ListTerminologies
- data ListTerminologiesResponse = ListTerminologiesResponse' (Maybe Text) (Maybe [TerminologyProperties]) Int
- newListTerminologiesResponse :: Int -> ListTerminologiesResponse
- data ListTextTranslationJobs = ListTextTranslationJobs' (Maybe TextTranslationJobFilter) (Maybe Natural) (Maybe Text)
- newListTextTranslationJobs :: ListTextTranslationJobs
- data ListTextTranslationJobsResponse = ListTextTranslationJobsResponse' (Maybe Text) (Maybe [TextTranslationJobProperties]) Int
- newListTextTranslationJobsResponse :: Int -> ListTextTranslationJobsResponse
- data StartTextTranslationJob = StartTextTranslationJob' (Maybe Text) (Maybe [Text]) (Maybe TranslationSettings) (Maybe [Text]) InputDataConfig OutputDataConfig Text Text (NonEmpty Text) Text
- newStartTextTranslationJob :: InputDataConfig -> OutputDataConfig -> Text -> Text -> NonEmpty Text -> Text -> StartTextTranslationJob
- data StartTextTranslationJobResponse = StartTextTranslationJobResponse' (Maybe Text) (Maybe JobStatus) Int
- newStartTextTranslationJobResponse :: Int -> StartTextTranslationJobResponse
- data StopTextTranslationJob = StopTextTranslationJob' Text
- newStopTextTranslationJob :: Text -> StopTextTranslationJob
- data StopTextTranslationJobResponse = StopTextTranslationJobResponse' (Maybe Text) (Maybe JobStatus) Int
- newStopTextTranslationJobResponse :: Int -> StopTextTranslationJobResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data TranslateText = TranslateText' (Maybe TranslationSettings) (Maybe [Text]) Text Text Text
- newTranslateText :: Text -> Text -> Text -> TranslateText
- data TranslateTextResponse = TranslateTextResponse' (Maybe TranslationSettings) (Maybe [AppliedTerminology]) Int Text Text Text
- newTranslateTextResponse :: Int -> Text -> Text -> Text -> TranslateTextResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateParallelData = UpdateParallelData' (Maybe Text) Text ParallelDataConfig Text
- newUpdateParallelData :: Text -> ParallelDataConfig -> Text -> UpdateParallelData
- data UpdateParallelDataResponse = UpdateParallelDataResponse' (Maybe POSIX) (Maybe ParallelDataStatus) (Maybe Text) (Maybe ParallelDataStatus) Int
- newUpdateParallelDataResponse :: Int -> UpdateParallelDataResponse
- 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' (Maybe Text) (Maybe [Term])
- newAppliedTerminology :: AppliedTerminology
- data EncryptionKey = EncryptionKey' EncryptionKeyType Text
- newEncryptionKey :: EncryptionKeyType -> Text -> EncryptionKey
- data InputDataConfig = InputDataConfig' Text Text
- newInputDataConfig :: Text -> Text -> InputDataConfig
- data JobDetails = JobDetails' (Maybe Int) (Maybe Int) (Maybe Int)
- newJobDetails :: JobDetails
- data Language = Language' Text Text
- newLanguage :: Text -> Text -> Language
- data OutputDataConfig = OutputDataConfig' (Maybe EncryptionKey) Text
- newOutputDataConfig :: Text -> OutputDataConfig
- data ParallelDataConfig = ParallelDataConfig' Text ParallelDataFormat
- newParallelDataConfig :: Text -> ParallelDataFormat -> ParallelDataConfig
- data ParallelDataDataLocation = ParallelDataDataLocation' Text Text
- newParallelDataDataLocation :: Text -> Text -> ParallelDataDataLocation
- data ParallelDataProperties = ParallelDataProperties' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe EncryptionKey) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe POSIX) (Maybe POSIX) (Maybe ParallelDataStatus) (Maybe Text) (Maybe Text) (Maybe ParallelDataConfig) (Maybe Integer) (Maybe Text) (Maybe ParallelDataStatus) (Maybe [Text])
- newParallelDataProperties :: ParallelDataProperties
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data Term = Term' (Maybe Text) (Maybe Text)
- newTerm :: Term
- data TerminologyData = TerminologyData' (Maybe Directionality) (Sensitive Base64) TerminologyDataFormat
- newTerminologyData :: ByteString -> TerminologyDataFormat -> TerminologyData
- data TerminologyDataLocation = TerminologyDataLocation' Text Text
- newTerminologyDataLocation :: Text -> Text -> TerminologyDataLocation
- data TerminologyProperties = TerminologyProperties' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Directionality) (Maybe EncryptionKey) (Maybe TerminologyDataFormat) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe [Text]) (Maybe Int)
- newTerminologyProperties :: TerminologyProperties
- data TextTranslationJobFilter = TextTranslationJobFilter' (Maybe Text) (Maybe JobStatus) (Maybe POSIX) (Maybe POSIX)
- newTextTranslationJobFilter :: TextTranslationJobFilter
- data TextTranslationJobProperties = TextTranslationJobProperties' (Maybe Text) (Maybe POSIX) (Maybe InputDataConfig) (Maybe JobDetails) (Maybe Text) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe OutputDataConfig) (Maybe [Text]) (Maybe TranslationSettings) (Maybe Text) (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe [Text])
- newTextTranslationJobProperties :: TextTranslationJobProperties
- data TranslationSettings = TranslationSettings' (Maybe Formality) (Maybe Profanity)
- newTranslationSettings :: TranslationSettings
Service Configuration
defaultService :: Service Source #
API version 2017-07-01 of the Amazon Translate SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Translate.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
Another modification is being made. That modification must complete before you can make your change.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
There was a conflict processing the request. Try your request again.
DetectedLanguageLowConfidenceException
_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
_InternalServerException :: AsError a => Fold a ServiceError Source #
An internal server error occurred. Retry your request.
InvalidFilterException
_InvalidFilterException :: AsError a => Fold a ServiceError Source #
The filter specified for the operation is not valid. Specify a different filter.
InvalidParameterValueException
_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
_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
_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
_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
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The Amazon Translate service is temporarily unavailable. Wait a bit and then retry your request.
TextSizeLimitExceededException
_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
_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
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
You have added too many tags to this resource. The maximum is 50 tags.
UnsupportedDisplayLanguageCodeException
_UnsupportedDisplayLanguageCodeException :: AsError a => Fold a ServiceError Source #
Requested display language code is not supported.
UnsupportedLanguagePairException
_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.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateParallelData
data CreateParallelData Source #
See: newCreateParallelData smart constructor.
Constructors
| CreateParallelData' (Maybe Text) (Maybe EncryptionKey) (Maybe [Tag]) Text ParallelDataConfig Text |
Instances
newCreateParallelData Source #
Arguments
| :: Text | |
| -> ParallelDataConfig | |
| -> Text | |
| -> CreateParallelData |
Create a value of CreateParallelData 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:
CreateParallelData, createParallelData_description - A custom description for the parallel data resource in Amazon Translate.
CreateParallelData, createParallelData_encryptionKey - Undocumented member.
$sel:tags:CreateParallelData', createParallelData_tags - 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, createParallelData_name - A custom name for the parallel data resource in Amazon Translate. You
must assign a name that is unique in the account and region.
CreateParallelData, createParallelData_parallelDataConfig - Specifies the format and S3 location of the parallel data input file.
$sel:clientToken:CreateParallelData', createParallelData_clientToken - A unique identifier for the request. This token is automatically
generated when you use Amazon Translate through an AWS SDK.
data CreateParallelDataResponse Source #
See: newCreateParallelDataResponse smart constructor.
Constructors
| CreateParallelDataResponse' (Maybe Text) (Maybe ParallelDataStatus) Int |
Instances
newCreateParallelDataResponse Source #
Create a value of CreateParallelDataResponse 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:
CreateParallelData, createParallelDataResponse_name - The custom name that you assigned to the parallel data resource.
CreateParallelDataResponse, createParallelDataResponse_status - The status of the parallel data resource. When the resource is ready for
you to use, the status is ACTIVE.
$sel:httpStatus:CreateParallelDataResponse', createParallelDataResponse_httpStatus - The response's http status code.
DeleteParallelData
data DeleteParallelData Source #
See: newDeleteParallelData smart constructor.
Constructors
| DeleteParallelData' Text |
Instances
newDeleteParallelData Source #
Arguments
| :: Text | |
| -> DeleteParallelData |
Create a value of DeleteParallelData 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:
DeleteParallelData, deleteParallelData_name - The name of the parallel data resource that is being deleted.
data DeleteParallelDataResponse Source #
See: newDeleteParallelDataResponse smart constructor.
Constructors
| DeleteParallelDataResponse' (Maybe Text) (Maybe ParallelDataStatus) Int |
Instances
newDeleteParallelDataResponse Source #
Create a value of DeleteParallelDataResponse 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:
DeleteParallelData, deleteParallelDataResponse_name - The name of the parallel data resource that is being deleted.
DeleteParallelDataResponse, deleteParallelDataResponse_status - The status of the parallel data deletion.
$sel:httpStatus:DeleteParallelDataResponse', deleteParallelDataResponse_httpStatus - The response's http status code.
DeleteTerminology
data DeleteTerminology Source #
See: newDeleteTerminology smart constructor.
Constructors
| DeleteTerminology' Text |
Instances
Arguments
| :: Text | |
| -> DeleteTerminology |
Create a value of DeleteTerminology 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:
DeleteTerminology, deleteTerminology_name - The name of the custom terminology being deleted.
data DeleteTerminologyResponse Source #
See: newDeleteTerminologyResponse smart constructor.
Constructors
| DeleteTerminologyResponse' | |
Instances
newDeleteTerminologyResponse :: DeleteTerminologyResponse Source #
Create a value of DeleteTerminologyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeTextTranslationJob
data DescribeTextTranslationJob Source #
See: newDescribeTextTranslationJob smart constructor.
Constructors
| DescribeTextTranslationJob' Text |
Instances
newDescribeTextTranslationJob Source #
Arguments
| :: Text | |
| -> DescribeTextTranslationJob |
Create a value of DescribeTextTranslationJob 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:
DescribeTextTranslationJob, describeTextTranslationJob_jobId - The identifier that Amazon Translate generated for the job. The
StartTextTranslationJob operation returns this identifier in its
response.
data DescribeTextTranslationJobResponse Source #
See: newDescribeTextTranslationJobResponse smart constructor.
Instances
newDescribeTextTranslationJobResponse Source #
Arguments
| :: Int | |
| -> DescribeTextTranslationJobResponse |
Create a value of DescribeTextTranslationJobResponse 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:textTranslationJobProperties:DescribeTextTranslationJobResponse', describeTextTranslationJobResponse_textTranslationJobProperties - An object that contains the properties associated with an asynchronous
batch translation job.
$sel:httpStatus:DescribeTextTranslationJobResponse', describeTextTranslationJobResponse_httpStatus - The response's http status code.
GetParallelData
data GetParallelData Source #
See: newGetParallelData smart constructor.
Constructors
| GetParallelData' Text |
Instances
Arguments
| :: Text | |
| -> GetParallelData |
Create a value of GetParallelData 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:
GetParallelData, getParallelData_name - The name of the parallel data resource that is being retrieved.
data GetParallelDataResponse Source #
See: newGetParallelDataResponse smart constructor.
Constructors
| GetParallelDataResponse' (Maybe ParallelDataDataLocation) (Maybe ParallelDataDataLocation) (Maybe ParallelDataDataLocation) (Maybe ParallelDataProperties) Int |
Instances
newGetParallelDataResponse Source #
Create a value of GetParallelDataResponse 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:auxiliaryDataLocation:GetParallelDataResponse', getParallelDataResponse_auxiliaryDataLocation - 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.
$sel:dataLocation:GetParallelDataResponse', getParallelDataResponse_dataLocation - 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.
$sel:latestUpdateAttemptAuxiliaryDataLocation:GetParallelDataResponse', getParallelDataResponse_latestUpdateAttemptAuxiliaryDataLocation - 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.
$sel:parallelDataProperties:GetParallelDataResponse', getParallelDataResponse_parallelDataProperties - The properties of the parallel data resource that is being retrieved.
$sel:httpStatus:GetParallelDataResponse', getParallelDataResponse_httpStatus - The response's http status code.
GetTerminology
data GetTerminology Source #
See: newGetTerminology smart constructor.
Constructors
| GetTerminology' (Maybe TerminologyDataFormat) Text |
Instances
Arguments
| :: Text | |
| -> GetTerminology |
Create a value of GetTerminology 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:terminologyDataFormat:GetTerminology', getTerminology_terminologyDataFormat - 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, getTerminology_name - The name of the custom terminology being retrieved.
data GetTerminologyResponse Source #
See: newGetTerminologyResponse smart constructor.
Constructors
| GetTerminologyResponse' (Maybe TerminologyDataLocation) (Maybe TerminologyDataLocation) (Maybe TerminologyProperties) Int |
Instances
newGetTerminologyResponse Source #
Create a value of GetTerminologyResponse 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:auxiliaryDataLocation:GetTerminologyResponse', getTerminologyResponse_auxiliaryDataLocation - 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.
$sel:terminologyDataLocation:GetTerminologyResponse', getTerminologyResponse_terminologyDataLocation - 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.
$sel:terminologyProperties:GetTerminologyResponse', getTerminologyResponse_terminologyProperties - The properties of the custom terminology being retrieved.
$sel:httpStatus:GetTerminologyResponse', getTerminologyResponse_httpStatus - The response's http status code.
ImportTerminology
data ImportTerminology Source #
See: newImportTerminology smart constructor.
Constructors
| ImportTerminology' (Maybe Text) (Maybe EncryptionKey) (Maybe [Tag]) Text MergeStrategy TerminologyData |
Instances
Arguments
| :: Text | |
| -> MergeStrategy | |
| -> TerminologyData | |
| -> ImportTerminology |
Create a value of ImportTerminology 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:
ImportTerminology, importTerminology_description - The description of the custom terminology being imported.
ImportTerminology, importTerminology_encryptionKey - The encryption key for the custom terminology being imported.
$sel:tags:ImportTerminology', importTerminology_tags - 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, importTerminology_name - The name of the custom terminology being imported.
$sel:mergeStrategy:ImportTerminology', importTerminology_mergeStrategy - 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.
$sel:terminologyData:ImportTerminology', importTerminology_terminologyData - The terminology data for the custom terminology being imported.
data ImportTerminologyResponse Source #
See: newImportTerminologyResponse smart constructor.
Constructors
| ImportTerminologyResponse' (Maybe TerminologyDataLocation) (Maybe TerminologyProperties) Int |
Instances
newImportTerminologyResponse Source #
Create a value of ImportTerminologyResponse 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:auxiliaryDataLocation:ImportTerminologyResponse', importTerminologyResponse_auxiliaryDataLocation - 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.
$sel:terminologyProperties:ImportTerminologyResponse', importTerminologyResponse_terminologyProperties - The properties of the custom terminology being imported.
$sel:httpStatus:ImportTerminologyResponse', importTerminologyResponse_httpStatus - The response's http status code.
ListLanguages
data ListLanguages Source #
See: newListLanguages smart constructor.
Constructors
| ListLanguages' (Maybe DisplayLanguageCode) (Maybe Natural) (Maybe Text) |
Instances
newListLanguages :: ListLanguages Source #
Create a value of ListLanguages 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:
ListLanguages, listLanguages_displayLanguageCode - The language code for the language to use to display the language names
in the response. The language code is en by default.
$sel:maxResults:ListLanguages', listLanguages_maxResults - The maximum number of results to return in each response.
ListLanguages, listLanguages_nextToken - Include the NextToken value to fetch the next group of supported
languages.
data ListLanguagesResponse Source #
See: newListLanguagesResponse smart constructor.
Constructors
| ListLanguagesResponse' (Maybe DisplayLanguageCode) (Maybe [Language]) (Maybe Text) Int |
Instances
newListLanguagesResponse Source #
Create a value of ListLanguagesResponse 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:
ListLanguages, listLanguagesResponse_displayLanguageCode - The language code passed in with the request.
$sel:languages:ListLanguagesResponse', listLanguagesResponse_languages - The list of supported languages.
ListLanguages, listLanguagesResponse_nextToken - If the response does not include all remaining results, use the
NextToken in the next request to fetch the next group of supported
languages.
$sel:httpStatus:ListLanguagesResponse', listLanguagesResponse_httpStatus - The response's http status code.
ListParallelData
data ListParallelData Source #
See: newListParallelData smart constructor.
Constructors
| ListParallelData' (Maybe Natural) (Maybe Text) |
Instances
newListParallelData :: ListParallelData Source #
Create a value of ListParallelData 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:maxResults:ListParallelData', listParallelData_maxResults - The maximum number of parallel data resources returned for each request.
ListParallelData, listParallelData_nextToken - A string that specifies the next page of results to return in a
paginated response.
data ListParallelDataResponse Source #
See: newListParallelDataResponse smart constructor.
Constructors
| ListParallelDataResponse' (Maybe Text) (Maybe [ParallelDataProperties]) Int |
Instances
newListParallelDataResponse Source #
Create a value of ListParallelDataResponse 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:
ListParallelData, listParallelDataResponse_nextToken - 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.
$sel:parallelDataPropertiesList:ListParallelDataResponse', listParallelDataResponse_parallelDataPropertiesList - The properties of the parallel data resources returned by this request.
$sel:httpStatus:ListParallelDataResponse', listParallelDataResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the given Amazon Translate resource
you are querying.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - 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.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
ListTerminologies (Paginated)
data ListTerminologies Source #
See: newListTerminologies smart constructor.
Constructors
| ListTerminologies' (Maybe Natural) (Maybe Text) |
Instances
newListTerminologies :: ListTerminologies Source #
Create a value of ListTerminologies 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:maxResults:ListTerminologies', listTerminologies_maxResults - The maximum number of custom terminologies returned per list request.
ListTerminologies, listTerminologies_nextToken - If the result of the request to ListTerminologies was truncated, include
the NextToken to fetch the next group of custom terminologies.
data ListTerminologiesResponse Source #
See: newListTerminologiesResponse smart constructor.
Constructors
| ListTerminologiesResponse' (Maybe Text) (Maybe [TerminologyProperties]) Int |
Instances
newListTerminologiesResponse Source #
Create a value of ListTerminologiesResponse 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:
ListTerminologies, listTerminologiesResponse_nextToken - If the response to the ListTerminologies was truncated, the NextToken
fetches the next group of custom terminologies.
$sel:terminologyPropertiesList:ListTerminologiesResponse', listTerminologiesResponse_terminologyPropertiesList - The properties list of the custom terminologies returned on the list
request.
$sel:httpStatus:ListTerminologiesResponse', listTerminologiesResponse_httpStatus - The response's http status code.
ListTextTranslationJobs
data ListTextTranslationJobs Source #
See: newListTextTranslationJobs smart constructor.
Constructors
| ListTextTranslationJobs' (Maybe TextTranslationJobFilter) (Maybe Natural) (Maybe Text) |
Instances
newListTextTranslationJobs :: ListTextTranslationJobs Source #
Create a value of ListTextTranslationJobs 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:filter':ListTextTranslationJobs', listTextTranslationJobs_filter - 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.
$sel:maxResults:ListTextTranslationJobs', listTextTranslationJobs_maxResults - The maximum number of results to return in each page. The default value
is 100.
ListTextTranslationJobs, listTextTranslationJobs_nextToken - The token to request the next page of results.
data ListTextTranslationJobsResponse Source #
See: newListTextTranslationJobsResponse smart constructor.
Constructors
| ListTextTranslationJobsResponse' (Maybe Text) (Maybe [TextTranslationJobProperties]) Int |
Instances
newListTextTranslationJobsResponse Source #
Create a value of ListTextTranslationJobsResponse 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:
ListTextTranslationJobs, listTextTranslationJobsResponse_nextToken - The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:textTranslationJobPropertiesList:ListTextTranslationJobsResponse', listTextTranslationJobsResponse_textTranslationJobPropertiesList - A list containing the properties of each job that is returned.
$sel:httpStatus:ListTextTranslationJobsResponse', listTextTranslationJobsResponse_httpStatus - The response's http status code.
StartTextTranslationJob
data StartTextTranslationJob Source #
See: newStartTextTranslationJob smart constructor.
Constructors
| StartTextTranslationJob' (Maybe Text) (Maybe [Text]) (Maybe TranslationSettings) (Maybe [Text]) InputDataConfig OutputDataConfig Text Text (NonEmpty Text) Text |
Instances
newStartTextTranslationJob Source #
Arguments
| :: InputDataConfig | |
| -> OutputDataConfig | |
| -> Text | |
| -> Text | |
| -> NonEmpty Text | |
| -> Text | |
| -> StartTextTranslationJob |
Create a value of StartTextTranslationJob 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:
StartTextTranslationJob, startTextTranslationJob_jobName - The name of the batch translation job to be performed.
StartTextTranslationJob, startTextTranslationJob_parallelDataNames - 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, startTextTranslationJob_settings - 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, startTextTranslationJob_terminologyNames - 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, startTextTranslationJob_inputDataConfig - Specifies the format and location of the input documents for the
translation job.
StartTextTranslationJob, startTextTranslationJob_outputDataConfig - Specifies the S3 folder to which your job output will be saved.
StartTextTranslationJob, startTextTranslationJob_dataAccessRoleArn - 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, startTextTranslationJob_sourceLanguageCode - 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, startTextTranslationJob_targetLanguageCodes - 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.
$sel:clientToken:StartTextTranslationJob', startTextTranslationJob_clientToken - A unique identifier for the request. This token is generated for you
when using the Amazon Translate SDK.
data StartTextTranslationJobResponse Source #
See: newStartTextTranslationJobResponse smart constructor.
Instances
newStartTextTranslationJobResponse Source #
Create a value of StartTextTranslationJobResponse 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:
StartTextTranslationJobResponse, startTextTranslationJobResponse_jobId - The identifier generated for the job. To get the status of a job, use
this ID with the DescribeTextTranslationJob operation.
StartTextTranslationJobResponse, startTextTranslationJobResponse_jobStatus - 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.
$sel:httpStatus:StartTextTranslationJobResponse', startTextTranslationJobResponse_httpStatus - The response's http status code.
StopTextTranslationJob
data StopTextTranslationJob Source #
See: newStopTextTranslationJob smart constructor.
Constructors
| StopTextTranslationJob' Text |
Instances
newStopTextTranslationJob Source #
Arguments
| :: Text | |
| -> StopTextTranslationJob |
Create a value of StopTextTranslationJob 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:
StopTextTranslationJob, stopTextTranslationJob_jobId - The job ID of the job to be stopped.
data StopTextTranslationJobResponse Source #
See: newStopTextTranslationJobResponse smart constructor.
Instances
newStopTextTranslationJobResponse Source #
Create a value of StopTextTranslationJobResponse 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:
StopTextTranslationJob, stopTextTranslationJobResponse_jobId - The job ID of the stopped batch translation job.
StopTextTranslationJobResponse, stopTextTranslationJobResponse_jobStatus - The status of the designated job. Upon successful completion, the job's
status will be STOPPED.
$sel:httpStatus:StopTextTranslationJobResponse', stopTextTranslationJobResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the given Amazon Translate resource to
which you want to associate the tags.
$sel:tags:TagResource', tagResource_tags - 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.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
TranslateText
data TranslateText Source #
See: newTranslateText smart constructor.
Constructors
| TranslateText' (Maybe TranslationSettings) (Maybe [Text]) Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> TranslateText |
Create a value of TranslateText 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:
TranslateText, translateText_settings - 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, translateText_terminologyNames - 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.
$sel:text:TranslateText', translateText_text - 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, translateText_sourceLanguageCode - 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, translateText_targetLanguageCode - The language code requested for the language of the target text. The
language must be a language supported by Amazon Translate.
data TranslateTextResponse Source #
See: newTranslateTextResponse smart constructor.
Constructors
| TranslateTextResponse' (Maybe TranslationSettings) (Maybe [AppliedTerminology]) Int Text Text Text |
Instances
newTranslateTextResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> TranslateTextResponse |
Create a value of TranslateTextResponse 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:appliedSettings:TranslateTextResponse', translateTextResponse_appliedSettings - Settings that configure the translation output.
$sel:appliedTerminologies:TranslateTextResponse', translateTextResponse_appliedTerminologies - The names of the custom terminologies applied to the input text by
Amazon Translate for the translated text response.
$sel:httpStatus:TranslateTextResponse', translateTextResponse_httpStatus - The response's http status code.
$sel:translatedText:TranslateTextResponse', translateTextResponse_translatedText - The translated text.
TranslateText, translateTextResponse_sourceLanguageCode - The language code for the language of the source text.
TranslateText, translateTextResponse_targetLanguageCode - The language code for the language of the target text.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the given Amazon Translate resource
from which you want to remove the tags.
$sel:tagKeys:UntagResource', untagResource_tagKeys - 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.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateParallelData
data UpdateParallelData Source #
See: newUpdateParallelData smart constructor.
Constructors
| UpdateParallelData' (Maybe Text) Text ParallelDataConfig Text |
Instances
newUpdateParallelData Source #
Arguments
| :: Text | |
| -> ParallelDataConfig | |
| -> Text | |
| -> UpdateParallelData |
Create a value of UpdateParallelData 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:
UpdateParallelData, updateParallelData_description - A custom description for the parallel data resource in Amazon Translate.
UpdateParallelData, updateParallelData_name - The name of the parallel data resource being updated.
UpdateParallelData, updateParallelData_parallelDataConfig - Specifies the format and S3 location of the parallel data input file.
$sel:clientToken:UpdateParallelData', updateParallelData_clientToken - A unique identifier for the request. This token is automatically
generated when you use Amazon Translate through an AWS SDK.
data UpdateParallelDataResponse Source #
See: newUpdateParallelDataResponse smart constructor.
Constructors
| UpdateParallelDataResponse' (Maybe POSIX) (Maybe ParallelDataStatus) (Maybe Text) (Maybe ParallelDataStatus) Int |
Instances
newUpdateParallelDataResponse Source #
Create a value of UpdateParallelDataResponse 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:
UpdateParallelDataResponse, updateParallelDataResponse_latestUpdateAttemptAt - The time that the most recent update was attempted.
UpdateParallelDataResponse, updateParallelDataResponse_latestUpdateAttemptStatus - The status of the parallel data update attempt. When the updated
parallel data resource is ready for you to use, the status is ACTIVE.
UpdateParallelData, updateParallelDataResponse_name - The name of the parallel data resource being updated.
UpdateParallelDataResponse, updateParallelDataResponse_status - 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.
$sel:httpStatus:UpdateParallelDataResponse', updateParallelDataResponse_httpStatus - The response's http status code.
Types
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' (Maybe Text) (Maybe [Term]) |
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.
EncryptionKey
data EncryptionKey Source #
The encryption key used to encrypt this object.
See: newEncryptionKey smart constructor.
Constructors
| EncryptionKey' EncryptionKeyType Text |
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.
InputDataConfig
data InputDataConfig Source #
The input configuration properties for requesting a batch translation job.
See: newInputDataConfig smart constructor.
Constructors
| InputDataConfig' Text Text |
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.
JobDetails
data JobDetails Source #
The number of documents successfully and unsuccessfully processed during a translation job.
See: newJobDetails smart constructor.
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.
Language
A supported language.
See: newLanguage smart constructor.
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' (Maybe EncryptionKey) Text |
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.
ParallelDataConfig
data ParallelDataConfig Source #
Specifies the format and S3 location of the parallel data input file.
See: newParallelDataConfig smart constructor.
Constructors
| ParallelDataConfig' Text ParallelDataFormat |
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.
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' Text Text |
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.
ParallelDataProperties
data ParallelDataProperties Source #
The properties of a parallel data resource.
See: newParallelDataProperties smart constructor.
Constructors
| ParallelDataProperties' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe EncryptionKey) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe POSIX) (Maybe POSIX) (Maybe ParallelDataStatus) (Maybe Text) (Maybe Text) (Maybe ParallelDataConfig) (Maybe Integer) (Maybe Text) (Maybe ParallelDataStatus) (Maybe [Text]) |
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.
Tag
A key-value pair that adds as a metadata to a resource used by Amazon Translate.
See: newTag smart constructor.
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.
Term
The term being translated by the custom terminology.
See: newTerm smart constructor.
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.
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' (Maybe Directionality) (Sensitive Base64) TerminologyDataFormat |
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.
TerminologyDataLocation
data TerminologyDataLocation Source #
The location of the custom terminology data.
See: newTerminologyDataLocation smart constructor.
Constructors
| TerminologyDataLocation' Text Text |
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.
TerminologyProperties
data TerminologyProperties Source #
The properties of the custom terminology.
See: newTerminologyProperties smart constructor.
Constructors
| TerminologyProperties' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Directionality) (Maybe EncryptionKey) (Maybe TerminologyDataFormat) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe [Text]) (Maybe Int) |
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.
TextTranslationJobFilter
data TextTranslationJobFilter Source #
Provides information for filtering a list of translation jobs. For more information, see ListTextTranslationJobs.
See: newTextTranslationJobFilter smart constructor.
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.
TextTranslationJobProperties
data TextTranslationJobProperties Source #
Provides information about a translation job.
See: newTextTranslationJobProperties smart constructor.
Constructors
| TextTranslationJobProperties' (Maybe Text) (Maybe POSIX) (Maybe InputDataConfig) (Maybe JobDetails) (Maybe Text) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe OutputDataConfig) (Maybe [Text]) (Maybe TranslationSettings) (Maybe Text) (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe [Text]) |
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.
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' (Maybe Formality) (Maybe Profanity) |
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.