Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- EncryptionKeyType
- JobStatus
- MergeStrategy
- ParallelDataFormat
- ParallelDataStatus
- TerminologyDataFormat
- AppliedTerminology
- EncryptionKey
- InputDataConfig
- JobDetails
- OutputDataConfig
- ParallelDataConfig
- ParallelDataDataLocation
- ParallelDataProperties
- Term
- TerminologyData
- TerminologyDataLocation
- TerminologyProperties
- TextTranslationJobFilter
- TextTranslationJobProperties
Synopsis
- defaultService :: Service
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedLanguagePairException :: AsError a => Getting (First ServiceError) a ServiceError
- _DetectedLanguageLowConfidenceException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidFilterException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TextSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype EncryptionKeyType where
- EncryptionKeyType' { }
- pattern EncryptionKeyType_KMS :: EncryptionKeyType
- 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 TerminologyDataFormat where
- data AppliedTerminology = AppliedTerminology' {}
- newAppliedTerminology :: AppliedTerminology
- appliedTerminology_terms :: Lens' AppliedTerminology (Maybe [Term])
- appliedTerminology_name :: Lens' AppliedTerminology (Maybe Text)
- 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_translatedDocumentsCount :: Lens' JobDetails (Maybe Int)
- jobDetails_documentsWithErrorsCount :: Lens' JobDetails (Maybe Int)
- jobDetails_inputDocumentsCount :: Lens' JobDetails (Maybe Int)
- data OutputDataConfig = OutputDataConfig' {}
- newOutputDataConfig :: Text -> OutputDataConfig
- 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' {
- status :: Maybe ParallelDataStatus
- lastUpdatedAt :: Maybe POSIX
- importedRecordCount :: Maybe Integer
- arn :: Maybe Text
- targetLanguageCodes :: Maybe [Text]
- createdAt :: Maybe POSIX
- failedRecordCount :: Maybe Integer
- importedDataSize :: Maybe Integer
- name :: Maybe Text
- sourceLanguageCode :: Maybe Text
- latestUpdateAttemptAt :: Maybe POSIX
- encryptionKey :: Maybe EncryptionKey
- latestUpdateAttemptStatus :: Maybe ParallelDataStatus
- message :: Maybe Text
- description :: Maybe Text
- skippedRecordCount :: Maybe Integer
- parallelDataConfig :: Maybe ParallelDataConfig
- newParallelDataProperties :: ParallelDataProperties
- parallelDataProperties_status :: Lens' ParallelDataProperties (Maybe ParallelDataStatus)
- parallelDataProperties_lastUpdatedAt :: Lens' ParallelDataProperties (Maybe UTCTime)
- parallelDataProperties_importedRecordCount :: Lens' ParallelDataProperties (Maybe Integer)
- parallelDataProperties_arn :: Lens' ParallelDataProperties (Maybe Text)
- parallelDataProperties_targetLanguageCodes :: Lens' ParallelDataProperties (Maybe [Text])
- parallelDataProperties_createdAt :: Lens' ParallelDataProperties (Maybe UTCTime)
- parallelDataProperties_failedRecordCount :: Lens' ParallelDataProperties (Maybe Integer)
- parallelDataProperties_importedDataSize :: Lens' ParallelDataProperties (Maybe Integer)
- parallelDataProperties_name :: Lens' ParallelDataProperties (Maybe Text)
- parallelDataProperties_sourceLanguageCode :: Lens' ParallelDataProperties (Maybe Text)
- parallelDataProperties_latestUpdateAttemptAt :: Lens' ParallelDataProperties (Maybe UTCTime)
- parallelDataProperties_encryptionKey :: Lens' ParallelDataProperties (Maybe EncryptionKey)
- parallelDataProperties_latestUpdateAttemptStatus :: Lens' ParallelDataProperties (Maybe ParallelDataStatus)
- parallelDataProperties_message :: Lens' ParallelDataProperties (Maybe Text)
- parallelDataProperties_description :: Lens' ParallelDataProperties (Maybe Text)
- parallelDataProperties_skippedRecordCount :: Lens' ParallelDataProperties (Maybe Integer)
- parallelDataProperties_parallelDataConfig :: Lens' ParallelDataProperties (Maybe ParallelDataConfig)
- data Term = Term' {
- targetText :: Maybe Text
- sourceText :: Maybe Text
- newTerm :: Term
- term_targetText :: Lens' Term (Maybe Text)
- term_sourceText :: Lens' Term (Maybe Text)
- data TerminologyData = TerminologyData' {}
- newTerminologyData :: ByteString -> TerminologyDataFormat -> TerminologyData
- 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' {
- sizeBytes :: Maybe Int
- lastUpdatedAt :: Maybe POSIX
- arn :: Maybe Text
- targetLanguageCodes :: Maybe [Text]
- createdAt :: Maybe POSIX
- name :: Maybe Text
- sourceLanguageCode :: Maybe Text
- termCount :: Maybe Int
- encryptionKey :: Maybe EncryptionKey
- description :: Maybe Text
- newTerminologyProperties :: TerminologyProperties
- terminologyProperties_sizeBytes :: Lens' TerminologyProperties (Maybe Int)
- terminologyProperties_lastUpdatedAt :: Lens' TerminologyProperties (Maybe UTCTime)
- terminologyProperties_arn :: Lens' TerminologyProperties (Maybe Text)
- terminologyProperties_targetLanguageCodes :: Lens' TerminologyProperties (Maybe [Text])
- terminologyProperties_createdAt :: Lens' TerminologyProperties (Maybe UTCTime)
- terminologyProperties_name :: Lens' TerminologyProperties (Maybe Text)
- terminologyProperties_sourceLanguageCode :: Lens' TerminologyProperties (Maybe Text)
- terminologyProperties_termCount :: Lens' TerminologyProperties (Maybe Int)
- terminologyProperties_encryptionKey :: Lens' TerminologyProperties (Maybe EncryptionKey)
- terminologyProperties_description :: Lens' TerminologyProperties (Maybe Text)
- data TextTranslationJobFilter = TextTranslationJobFilter' {}
- newTextTranslationJobFilter :: TextTranslationJobFilter
- textTranslationJobFilter_submittedBeforeTime :: Lens' TextTranslationJobFilter (Maybe UTCTime)
- textTranslationJobFilter_submittedAfterTime :: Lens' TextTranslationJobFilter (Maybe UTCTime)
- textTranslationJobFilter_jobName :: Lens' TextTranslationJobFilter (Maybe Text)
- textTranslationJobFilter_jobStatus :: Lens' TextTranslationJobFilter (Maybe JobStatus)
- data TextTranslationJobProperties = TextTranslationJobProperties' {
- jobId :: Maybe Text
- targetLanguageCodes :: Maybe (NonEmpty Text)
- jobName :: Maybe Text
- submittedTime :: Maybe POSIX
- inputDataConfig :: Maybe InputDataConfig
- parallelDataNames :: Maybe [Text]
- terminologyNames :: Maybe [Text]
- sourceLanguageCode :: Maybe Text
- endTime :: Maybe POSIX
- outputDataConfig :: Maybe OutputDataConfig
- jobDetails :: Maybe JobDetails
- dataAccessRoleArn :: Maybe Text
- jobStatus :: Maybe JobStatus
- message :: Maybe Text
- newTextTranslationJobProperties :: TextTranslationJobProperties
- textTranslationJobProperties_jobId :: Lens' TextTranslationJobProperties (Maybe Text)
- textTranslationJobProperties_targetLanguageCodes :: Lens' TextTranslationJobProperties (Maybe (NonEmpty Text))
- textTranslationJobProperties_jobName :: Lens' TextTranslationJobProperties (Maybe Text)
- textTranslationJobProperties_submittedTime :: Lens' TextTranslationJobProperties (Maybe UTCTime)
- textTranslationJobProperties_inputDataConfig :: Lens' TextTranslationJobProperties (Maybe InputDataConfig)
- textTranslationJobProperties_parallelDataNames :: Lens' TextTranslationJobProperties (Maybe [Text])
- textTranslationJobProperties_terminologyNames :: Lens' TextTranslationJobProperties (Maybe [Text])
- textTranslationJobProperties_sourceLanguageCode :: Lens' TextTranslationJobProperties (Maybe Text)
- textTranslationJobProperties_endTime :: Lens' TextTranslationJobProperties (Maybe UTCTime)
- textTranslationJobProperties_outputDataConfig :: Lens' TextTranslationJobProperties (Maybe OutputDataConfig)
- textTranslationJobProperties_jobDetails :: Lens' TextTranslationJobProperties (Maybe JobDetails)
- textTranslationJobProperties_dataAccessRoleArn :: Lens' TextTranslationJobProperties (Maybe Text)
- textTranslationJobProperties_jobStatus :: Lens' TextTranslationJobProperties (Maybe JobStatus)
- textTranslationJobProperties_message :: Lens' TextTranslationJobProperties (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2017-07-01
of the Amazon Translate SDK configuration.
Errors
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
_UnsupportedLanguagePairException :: AsError a => Getting (First ServiceError) 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 how-to-error-msg.
_DetectedLanguageLowConfidenceException :: AsError a => Getting (First ServiceError) 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.
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There was a conflict processing the request. Try your request again.
_InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The value of the parameter is invalid. Review the value of the parameter you are using to correct it, and then retry your operation.
_TooManyRequestsException :: AsError a => Getting (First ServiceError) 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.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Another modification is being made. That modification must complete before you can make your change.
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal server error occurred. Retry your request.
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The Amazon Translate service is temporarily unavailable. Please wait a bit and then retry your request.
_InvalidFilterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The filter specified for the operation is invalid. Specify a different filter.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) 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.
_TextSizeLimitExceededException :: AsError a => Getting (First ServiceError) 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.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified limit has been exceeded. Review your request and retry it with a quantity below the stated limit.
EncryptionKeyType
newtype EncryptionKeyType Source #
pattern EncryptionKeyType_KMS :: EncryptionKeyType |
Instances
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 |
Instances
MergeStrategy
newtype MergeStrategy Source #
pattern MergeStrategy_OVERWRITE :: MergeStrategy |
Instances
ParallelDataFormat
newtype ParallelDataFormat Source #
pattern ParallelDataFormat_CSV :: ParallelDataFormat | |
pattern ParallelDataFormat_TMX :: ParallelDataFormat | |
pattern ParallelDataFormat_TSV :: ParallelDataFormat |
Instances
ParallelDataStatus
newtype ParallelDataStatus Source #
pattern ParallelDataStatus_ACTIVE :: ParallelDataStatus | |
pattern ParallelDataStatus_CREATING :: ParallelDataStatus | |
pattern ParallelDataStatus_DELETING :: ParallelDataStatus | |
pattern ParallelDataStatus_FAILED :: ParallelDataStatus | |
pattern ParallelDataStatus_UPDATING :: ParallelDataStatus |
Instances
TerminologyDataFormat
newtype TerminologyDataFormat Source #
pattern TerminologyDataFormat_CSV :: TerminologyDataFormat | |
pattern TerminologyDataFormat_TMX :: 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.
AppliedTerminology' | |
|
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: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.
$sel:name:AppliedTerminology'
, appliedTerminology_name
- 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.
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.
EncryptionKey
data EncryptionKey Source #
The encryption key used to encrypt this object.
See: newEncryptionKey
smart constructor.
EncryptionKey' | |
|
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 custom
terminologies.
$sel:id:EncryptionKey'
, encryptionKey_id
- The Amazon Resource Name (ARN) of the encryption key being used to
encrypt the custom terminology.
encryptionKey_type :: Lens' EncryptionKey EncryptionKeyType Source #
The type of encryption key used by Amazon Translate to encrypt custom terminologies.
encryptionKey_id :: Lens' EncryptionKey Text Source #
The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.
InputDataConfig
data InputDataConfig Source #
The input configuration properties for requesting a batch translation job.
See: newInputDataConfig
smart constructor.
InputDataConfig' | |
|
Instances
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 file. 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 thehtml
element in each file.text/plain
: The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.application/vnd.openxmlformats-officedocument.wordprocessingml.document
: The input data consists of one or more Word documents (.docx).application/vnd.openxmlformats-officedocument.presentationml.presentation
: The input data consists of one or more PowerPoint Presentation files (.pptx).application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
: The input data consists of one or more Excel Workbook files (.xlsx).
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 file. The folder must be in the same Region as the API endpoint you are calling.
inputDataConfig_contentType :: Lens' InputDataConfig Text Source #
Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types:
text/html
: The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in thehtml
element in each file.text/plain
: The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.application/vnd.openxmlformats-officedocument.wordprocessingml.document
: The input data consists of one or more Word documents (.docx).application/vnd.openxmlformats-officedocument.presentationml.presentation
: The input data consists of one or more PowerPoint Presentation files (.pptx).application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
: The input data consists of one or more Excel Workbook files (.xlsx).
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.
JobDetails' | |
|
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:translatedDocumentsCount:JobDetails'
, jobDetails_translatedDocumentsCount
- The number of documents successfully processed during a translation job.
$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.
jobDetails_translatedDocumentsCount :: Lens' JobDetails (Maybe Int) Source #
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.
OutputDataConfig
data OutputDataConfig Source #
The output configuration properties for a batch translation job.
See: newOutputDataConfig
smart constructor.
Instances
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: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_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.
ParallelDataConfig' | |
|
Instances
newParallelDataConfig Source #
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.
ParallelDataDataLocation' | |
|
Instances
newParallelDataDataLocation Source #
:: 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.
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.
ParallelDataProperties
data ParallelDataProperties Source #
The properties of a parallel data resource.
See: newParallelDataProperties
smart constructor.
ParallelDataProperties' | |
|
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: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:lastUpdatedAt:ParallelDataProperties'
, parallelDataProperties_lastUpdatedAt
- The time at which the parallel data resource was last updated.
$sel:importedRecordCount:ParallelDataProperties'
, parallelDataProperties_importedRecordCount
- The number of records successfully imported from the parallel data input
file.
$sel:arn:ParallelDataProperties'
, parallelDataProperties_arn
- The Amazon Resource Name (ARN) of the parallel data resource.
$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.
$sel:createdAt:ParallelDataProperties'
, parallelDataProperties_createdAt
- The time at which the parallel data resource was created.
$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:name:ParallelDataProperties'
, parallelDataProperties_name
- The custom name assigned to the parallel data resource.
$sel:sourceLanguageCode:ParallelDataProperties'
, parallelDataProperties_sourceLanguageCode
- The source language of the translations in the parallel data file.
$sel:latestUpdateAttemptAt:ParallelDataProperties'
, parallelDataProperties_latestUpdateAttemptAt
- The time that the most recent update was attempted.
$sel:encryptionKey:ParallelDataProperties'
, parallelDataProperties_encryptionKey
- Undocumented member.
$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:description:ParallelDataProperties'
, parallelDataProperties_description
- The description assigned to the parallel data resource.
$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:parallelDataConfig:ParallelDataProperties'
, parallelDataProperties_parallelDataConfig
- Specifies the format and S3 location of the parallel data input 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_lastUpdatedAt :: Lens' ParallelDataProperties (Maybe UTCTime) Source #
The time at which the parallel data resource was last updated.
parallelDataProperties_importedRecordCount :: Lens' ParallelDataProperties (Maybe Integer) Source #
The number of records successfully imported from the parallel data input file.
parallelDataProperties_arn :: Lens' ParallelDataProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the parallel data resource.
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.
parallelDataProperties_createdAt :: Lens' ParallelDataProperties (Maybe UTCTime) Source #
The time at which the parallel data resource was created.
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_name :: Lens' ParallelDataProperties (Maybe Text) Source #
The custom name assigned to the parallel data resource.
parallelDataProperties_sourceLanguageCode :: Lens' ParallelDataProperties (Maybe Text) Source #
The source language of the translations in the parallel data file.
parallelDataProperties_latestUpdateAttemptAt :: Lens' ParallelDataProperties (Maybe UTCTime) Source #
The time that the most recent update was attempted.
parallelDataProperties_encryptionKey :: Lens' ParallelDataProperties (Maybe EncryptionKey) Source #
Undocumented member.
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_description :: Lens' ParallelDataProperties (Maybe Text) Source #
The description assigned to the parallel data resource.
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_parallelDataConfig :: Lens' ParallelDataProperties (Maybe ParallelDataConfig) Source #
Specifies the format and S3 location of the parallel data input file.
Term
The term being translated by the custom terminology.
See: newTerm
smart constructor.
Term' | |
|
Instances
Eq Term Source # | |
Read Term Source # | |
Show Term Source # | |
Generic Term Source # | |
NFData Term Source # | |
Defined in Amazonka.Translate.Types.Term | |
Hashable Term Source # | |
Defined in Amazonka.Translate.Types.Term | |
FromJSON Term Source # | |
type Rep Term Source # | |
Defined in Amazonka.Translate.Types.Term type Rep Term = D1 ('MetaData "Term" "Amazonka.Translate.Types.Term" "libZSservicesZSamazonka-translateZSamazonka-translate" 'False) (C1 ('MetaCons "Term'" 'PrefixI 'True) (S1 ('MetaSel ('Just "targetText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceText") '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:targetText:Term'
, term_targetText
- The target text of the term being translated by the custom terminology.
$sel:sourceText:Term'
, term_sourceText
- 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.
term_sourceText :: Lens' Term (Maybe Text) Source #
The source text of the term being translated by the custom terminology.
TerminologyData
data TerminologyData Source #
The data associated with the custom terminology.
See: newTerminologyData
smart constructor.
TerminologyData' | |
|
Instances
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: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. Either CSV or TMX.
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. Either CSV or TMX.
TerminologyDataLocation
data TerminologyDataLocation Source #
The location of the custom terminology data.
See: newTerminologyDataLocation
smart constructor.
TerminologyDataLocation' | |
|
Instances
newTerminologyDataLocation Source #
:: 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 location of the custom terminology data.
terminologyDataLocation_repositoryType :: Lens' TerminologyDataLocation Text Source #
The repository type for the custom terminology data.
terminologyDataLocation_location :: Lens' TerminologyDataLocation Text Source #
The location of the custom terminology data.
TerminologyProperties
data TerminologyProperties Source #
The properties of the custom terminology.
See: newTerminologyProperties
smart constructor.
TerminologyProperties' | |
|
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:sizeBytes:TerminologyProperties'
, terminologyProperties_sizeBytes
- The size of the file used when importing a custom terminology.
$sel:lastUpdatedAt:TerminologyProperties'
, terminologyProperties_lastUpdatedAt
- The time at which the custom terminology was last update, based on the
timestamp.
$sel:arn:TerminologyProperties'
, terminologyProperties_arn
- The Amazon Resource Name (ARN) of the custom terminology.
$sel:targetLanguageCodes:TerminologyProperties'
, terminologyProperties_targetLanguageCodes
- The language codes for the target languages available with the custom
terminology file. All possible target languages are returned in array.
$sel:createdAt:TerminologyProperties'
, terminologyProperties_createdAt
- The time at which the custom terminology was created, based on the
timestamp.
$sel:name:TerminologyProperties'
, terminologyProperties_name
- The name of the custom terminology.
$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:termCount:TerminologyProperties'
, terminologyProperties_termCount
- The number of terms included in the custom terminology.
$sel:encryptionKey:TerminologyProperties'
, terminologyProperties_encryptionKey
- The encryption key for the custom terminology.
$sel:description:TerminologyProperties'
, terminologyProperties_description
- The description of the custom terminology properties.
terminologyProperties_sizeBytes :: Lens' TerminologyProperties (Maybe Int) Source #
The size of the file used when importing a custom terminology.
terminologyProperties_lastUpdatedAt :: Lens' TerminologyProperties (Maybe UTCTime) Source #
The time at which the custom terminology was last update, based on the timestamp.
terminologyProperties_arn :: Lens' TerminologyProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the custom terminology.
terminologyProperties_targetLanguageCodes :: Lens' TerminologyProperties (Maybe [Text]) Source #
The language codes for the target languages available with the custom terminology file. All possible target languages are returned in array.
terminologyProperties_createdAt :: Lens' TerminologyProperties (Maybe UTCTime) Source #
The time at which the custom terminology was created, based on the timestamp.
terminologyProperties_name :: Lens' TerminologyProperties (Maybe Text) Source #
The name of the custom terminology.
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_termCount :: Lens' TerminologyProperties (Maybe Int) Source #
The number of terms included in the custom terminology.
terminologyProperties_encryptionKey :: Lens' TerminologyProperties (Maybe EncryptionKey) Source #
The encryption key for the custom terminology.
terminologyProperties_description :: Lens' TerminologyProperties (Maybe Text) Source #
The description of the custom terminology properties.
TextTranslationJobFilter
data TextTranslationJobFilter Source #
Provides information for filtering a list of translation jobs. For more information, see ListTextTranslationJobs.
See: newTextTranslationJobFilter
smart constructor.
TextTranslationJobFilter' | |
|
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: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.
$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: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.
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.
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_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.
TextTranslationJobProperties
data TextTranslationJobProperties Source #
Provides information about a translation job.
See: newTextTranslationJobProperties
smart constructor.
TextTranslationJobProperties' | |
|
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:jobId:TextTranslationJobProperties'
, textTranslationJobProperties_jobId
- The ID of the translation job.
$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:jobName:TextTranslationJobProperties'
, textTranslationJobProperties_jobName
- The user-defined name of the translation job.
$sel:submittedTime:TextTranslationJobProperties'
, textTranslationJobProperties_submittedTime
- The time at which the translation job was submitted.
$sel:inputDataConfig:TextTranslationJobProperties'
, textTranslationJobProperties_inputDataConfig
- The input 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: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.
$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:endTime:TextTranslationJobProperties'
, textTranslationJobProperties_endTime
- The time at which the translation job ended.
$sel:outputDataConfig:TextTranslationJobProperties'
, textTranslationJobProperties_outputDataConfig
- The output 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: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:jobStatus:TextTranslationJobProperties'
, textTranslationJobProperties_jobStatus
- The status of the translation job.
$sel:message:TextTranslationJobProperties'
, textTranslationJobProperties_message
- An explanation of any errors that may have occured during the
translation job.
textTranslationJobProperties_jobId :: Lens' TextTranslationJobProperties (Maybe Text) Source #
The ID of the translation job.
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_jobName :: Lens' TextTranslationJobProperties (Maybe Text) Source #
The user-defined name of the translation job.
textTranslationJobProperties_submittedTime :: Lens' TextTranslationJobProperties (Maybe UTCTime) Source #
The time at which the translation job was submitted.
textTranslationJobProperties_inputDataConfig :: Lens' TextTranslationJobProperties (Maybe InputDataConfig) Source #
The input 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_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.
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_endTime :: Lens' TextTranslationJobProperties (Maybe UTCTime) Source #
The time at which the translation job ended.
textTranslationJobProperties_outputDataConfig :: Lens' TextTranslationJobProperties (Maybe OutputDataConfig) Source #
The output 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_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_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 occured during the translation job.