Amazon Translate 2017-07-01
- Client: Aws\Translate\TranslateClient
- Service ID: translate
- Version: 2017-07-01
This page describes the parameters and results for the operations of the Amazon Translate (2017-07-01), and shows how to use the Aws\Translate\TranslateClient object to call the described operations. This documentation is specific to the 2017-07-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- TranslateText ( array $params = [] )
Translates input text from the source language to the target language.
Operations
TranslateText
$result = $client->translateText([/* ... */]); $promise = $client->translateTextAsync([/* ... */]);
Translates input text from the source language to the target language. You can translate between English (en) and one of the following languages, or between one of the following languages and English.
-
Arabic (ar)
-
Chinese (Simplified) (zh)
-
French (fr)
-
German (de)
-
Portuguese (pt)
-
Spanish (es)
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.
Parameter Syntax
$result = $client->translateText([
'SourceLanguageCode' => '<string>', // REQUIRED
'TargetLanguageCode' => '<string>', // REQUIRED
'Text' => '<string>', // REQUIRED
]);
Parameter Details
Members
- SourceLanguageCode
-
- Type: string
One of the supported language codes for the source text. If the
TargetLanguageCodeis not "en", theSourceLanguageCodemust be "en".To have Amazon Translate determine the source language of your text, you can specify
autoin theSourceLanguageCodefield. If you specifyauto, Amazon Translate will call Amazon Comprehend to determine the source language. - TargetLanguageCode
-
- Type: string
One of the supported language codes for the target text. If the
SourceLanguageCodeis not "en", theTargetLanguageCodemust be "en". - Text
-
- Type: string
The text to translate.
Result Syntax
[
'SourceLanguageCode' => '<string>',
'TargetLanguageCode' => '<string>',
'TranslatedText' => '<string>',
]
Result Details
Members
Errors
-
InvalidRequestException:
The request is invalid.
-
TextSizeLimitExceededException:
The size of the input text exceeds the length constraint for the
Textfield. Try again with a shorter text. -
TooManyRequestsException:
The number of requests exceeds the limit. Resubmit your request later.
-
UnsupportedLanguagePairException:
Amazon Translate cannot translate input text in the source language into this target language. For more information, see how-to-error-msg.
-
DetectedLanguageLowConfidenceException:
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:
An internal server error occurred. Retry your request.
-
ServiceUnavailableException:
Amazon Translate is unavailable. Retry your request later.
Shapes
DetectedLanguageLowConfidenceException
Description
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.
Members
InternalServerException
InvalidRequestException
ServiceUnavailableException
TextSizeLimitExceededException
Description
The size of the input text exceeds the length constraint for the Text field. Try again with a shorter text.
Members
TooManyRequestsException
Description
The number of requests exceeds the limit. Resubmit your request later.
Members
UnsupportedLanguagePairException
Description
Amazon Translate cannot translate input text in the source language into this target language. For more information, see how-to-error-msg.
