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 */).
- DeleteTerminology ( array $params = [] )
A synchronous action that deletes a custom terminology.
- GetTerminology ( array $params = [] )
Retrieves a custom terminology.
- ImportTerminology ( array $params = [] )
Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name.
- ListTerminologies ( array $params = [] )
Provides a list of custom terminologies associated with your account.
- TranslateText ( array $params = [] )
Translates input text from the source language to the target language.
Operations
DeleteTerminology
$result = $client->deleteTerminology([/* ... */]); $promise = $client->deleteTerminologyAsync([/* ... */]);
A synchronous action that deletes a custom terminology.
Parameter Syntax
$result = $client->deleteTerminology([
'Name' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
ResourceNotFoundException:
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. .
-
TooManyRequestsException:
You have made too many requests within a short period of time. Wait for a short time and then try your request again.
-
InternalServerException:
An internal server error occurred. Retry your request.
GetTerminology
$result = $client->getTerminology([/* ... */]); $promise = $client->getTerminologyAsync([/* ... */]);
Retrieves a custom terminology.
Parameter Syntax
$result = $client->getTerminology([
'Name' => '<string>', // REQUIRED
'TerminologyDataFormat' => 'CSV|TMX', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'TerminologyDataLocation' => [
'Location' => '<string>',
'RepositoryType' => '<string>',
],
'TerminologyProperties' => [
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'EncryptionKey' => [
'Id' => '<string>',
'Type' => 'KMS',
],
'LastUpdatedAt' => <DateTime>,
'Name' => '<string>',
'SizeBytes' => <integer>,
'SourceLanguageCode' => '<string>',
'TargetLanguageCodes' => ['<string>', ...],
'TermCount' => <integer>,
],
]
Result Details
Members
- TerminologyDataLocation
-
- Type: TerminologyDataLocation structure
The data location of the custom terminology being retrieved. The custom terminology file is returned in a presigned url that has a 30 minute expiration.
- TerminologyProperties
-
- Type: TerminologyProperties structure
The properties of the custom terminology being retrieved.
Errors
-
ResourceNotFoundException:
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. .
-
InvalidParameterValueException:
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:
You have made too many requests within a short period of time. Wait for a short time and then try your request again.
-
InternalServerException:
An internal server error occurred. Retry your request.
ImportTerminology
$result = $client->importTerminology([/* ... */]); $promise = $client->importTerminologyAsync([/* ... */]);
Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name. Importing a terminology with the same name as an existing one will merge the terminologies based on the chosen merge strategy. Currently, the only supported merge strategy is OVERWRITE, and so the imported terminology will overwrite an existing terminology of the same name.
If you import a terminology that overwrites an existing one, the new terminology take up to 10 minutes to fully propagate and be available for use in a translation due to cache policies with the DataPlane service that performs the translations.
Parameter Syntax
$result = $client->importTerminology([
'Description' => '<string>',
'EncryptionKey' => [
'Id' => '<string>', // REQUIRED
'Type' => 'KMS', // REQUIRED
],
'MergeStrategy' => 'OVERWRITE', // REQUIRED
'Name' => '<string>', // REQUIRED
'TerminologyData' => [ // REQUIRED
'File' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
'Format' => 'CSV|TMX', // REQUIRED
],
]);
Parameter Details
Members
- Description
-
- Type: string
The description of the custom terminology being imported.
- EncryptionKey
-
- Type: EncryptionKey structure
The encryption key for the custom terminology being imported.
- MergeStrategy
-
- Required: Yes
- Type: string
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.
- Name
-
- Required: Yes
- Type: string
The name of the custom terminology being imported.
- TerminologyData
-
- Required: Yes
- Type: TerminologyData structure
The terminology data for the custom terminology being imported.
Result Syntax
[
'TerminologyProperties' => [
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'EncryptionKey' => [
'Id' => '<string>',
'Type' => 'KMS',
],
'LastUpdatedAt' => <DateTime>,
'Name' => '<string>',
'SizeBytes' => <integer>,
'SourceLanguageCode' => '<string>',
'TargetLanguageCodes' => ['<string>', ...],
'TermCount' => <integer>,
],
]
Result Details
Members
- TerminologyProperties
-
- Type: TerminologyProperties structure
The properties of the custom terminology being imported.
Errors
-
InvalidParameterValueException:
The value of the parameter is invalid. Review the value of the parameter you are using to correct it, and then retry your operation.
-
LimitExceededException:
The specified limit has been exceeded. Review your request and retry it with a quantity below the stated limit.
-
TooManyRequestsException:
You have made too many requests within a short period of time. Wait for a short time and then try your request again.
-
InternalServerException:
An internal server error occurred. Retry your request.
ListTerminologies
$result = $client->listTerminologies([/* ... */]); $promise = $client->listTerminologiesAsync([/* ... */]);
Provides a list of custom terminologies associated with your account.
Parameter Syntax
$result = $client->listTerminologies([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'NextToken' => '<string>',
'TerminologyPropertiesList' => [
[
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'EncryptionKey' => [
'Id' => '<string>',
'Type' => 'KMS',
],
'LastUpdatedAt' => <DateTime>,
'Name' => '<string>',
'SizeBytes' => <integer>,
'SourceLanguageCode' => '<string>',
'TargetLanguageCodes' => ['<string>', ...],
'TermCount' => <integer>,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If the response to the ListTerminologies was truncated, the NextToken fetches the next group of custom terminologies.
- TerminologyPropertiesList
-
- Type: Array of TerminologyProperties structures
The properties list of the custom terminologies returned on the list request.
Errors
-
InvalidParameterValueException:
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:
You have made too many requests within a short period of time. Wait for a short time and then try your request again.
-
InternalServerException:
An internal server error occurred. Retry your request.
TranslateText
$result = $client->translateText([/* ... */]); $promise = $client->translateTextAsync([/* ... */]);
Translates input text from the source language to the target language. It is not necessary to use English (en) as either the source or the target language but not all language combinations are supported by Amazon Translate. For more information, see Supported Language Pairs.
-
Arabic (ar)
-
Chinese (Simplified) (zh)
-
Chinese (Traditional) (zh-TW)
-
Czech (cs)
-
Danish (da)
-
Dutch (nl)
-
English (en)
-
Finnish (fi)
-
French (fr)
-
German (de)
-
Hebrew (he)
-
Indonesian (id)
-
Italian (it)
-
Japanese (ja)
-
Korean (ko)
-
Polish (pl)
-
Portuguese (pt)
-
Russian (ru)
-
Spanish (es)
-
Swedish (sv)
-
Turkish (tr)
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
'TerminologyNames' => ['<string>', ...],
'Text' => '<string>', // REQUIRED
]);
Parameter Details
Members
- SourceLanguageCode
-
- Required: Yes
- Type: string
The language code for the language of the source text. The language must be a language supported by Amazon Translate.
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
-
- Required: Yes
- Type: string
The language code requested for the language of the target text. The language must be a language supported by Amazon Translate.
- TerminologyNames
-
- Type: Array of strings
The TerminologyNames list that is taken as input to the TranslateText request. This has a minimum length of 0 and a maximum length of 1.
- Text
-
- Required: Yes
- Type: string
The text to translate. The text string can be a maximum of 5,000 bytes long. Depending on your character set, this may be fewer than 5,000 characters.
Result Syntax
[
'AppliedTerminologies' => [
[
'Name' => '<string>',
'Terms' => [
[
'SourceText' => '<string>',
'TargetText' => '<string>',
],
// ...
],
],
// ...
],
'SourceLanguageCode' => '<string>',
'TargetLanguageCode' => '<string>',
'TranslatedText' => '<string>',
]
Result Details
Members
- AppliedTerminologies
-
- Type: Array of AppliedTerminology structures
The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.
- SourceLanguageCode
-
- Required: Yes
- Type: string
The language code for the language of the source text.
- TargetLanguageCode
-
- Required: Yes
- Type: string
The language code for the language of the target text.
- TranslatedText
-
- Required: Yes
- Type: string
The the translated text. The maximum length of this text is 5kb.
Errors
-
InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
-
TextSizeLimitExceededException:
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:
You have made too many requests within a short period of time. Wait for a short time and then try your request again.
-
UnsupportedLanguagePairException:
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:
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.
-
ResourceNotFoundException:
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. .
-
InternalServerException:
An internal server error occurred. Retry your request.
-
ServiceUnavailableException:
The Amazon Translate service is temporarily unavailable. Please wait a bit and then retry your request.
Shapes
AppliedTerminology
Description
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.
Members
- Name
-
- Type: string
The name of the custom terminology applied to the input text by Amazon Translate for the translated text response.
- Terms
-
- Type: Array of Term structures
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.
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
EncryptionKey
Description
The encryption key used to encrypt the custom terminologies used by Amazon Translate.
Members
InternalServerException
InvalidParameterValueException
Description
The value of the parameter is invalid. Review the value of the parameter you are using to correct it, and then retry your operation.
Members
InvalidRequestException
Description
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
Members
LimitExceededException
Description
The specified limit has been exceeded. Review your request and retry it with a quantity below the stated limit.
Members
ResourceNotFoundException
Description
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. .
Members
ServiceUnavailableException
Description
The Amazon Translate service is temporarily unavailable. Please wait a bit and then retry your request.
Members
Term
Description
The term being translated by the custom terminology.
Members
TerminologyData
Description
The data associated with the custom terminology.
Members
TerminologyDataLocation
Description
The location of the custom terminology data.
Members
TerminologyProperties
Description
The properties of the custom terminology.
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the custom terminology.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the custom terminology was created, based on the timestamp.
- Description
-
- Type: string
The description of the custom terminology properties.
- EncryptionKey
-
- Type: EncryptionKey structure
The encryption key for the custom terminology.
- LastUpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the custom terminology was last update, based on the timestamp.
- Name
-
- Type: string
The name of the custom terminology.
- SizeBytes
-
- Type: int
The size of the file used when importing a custom terminology.
- SourceLanguageCode
-
- Type: string
The language code for the source text of the translation request for which the custom terminology is being used.
- TargetLanguageCodes
-
- Type: Array of strings
The language codes for the target languages available with the custom terminology file. All possible target languages are returned in array.
- TermCount
-
- Type: int
The number of terms included in the custom terminology.
TextSizeLimitExceededException
Description
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.
Members
TooManyRequestsException
Description
You have made too many requests within a short period of time. Wait for a short time and then try your request again.
Members
UnsupportedLanguagePairException
Description
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.
