AWS SDK for PHP 3.x

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 */).

CreateParallelData ( array $params = [] )
Creates a parallel data resource in Amazon Translate by importing an input file from Amazon S3.
DeleteParallelData ( array $params = [] )
Deletes a parallel data resource in Amazon Translate.
DeleteTerminology ( array $params = [] )
A synchronous action that deletes a custom terminology.
DescribeTextTranslationJob ( array $params = [] )
Gets the properties associated with an asynchronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on.
GetParallelData ( array $params = [] )
Provides information about a parallel data resource.
GetTerminology ( array $params = [] )
Retrieves a custom terminology.
ImportTerminology ( array $params = [] )
Creates or updates a custom terminology, depending on whether one already exists for the given terminology name.
ListLanguages ( array $params = [] )
Provides a list of languages (RFC-5646 codes and names) that Amazon Translate supports.
ListParallelData ( array $params = [] )
Provides a list of your parallel data resources in Amazon Translate.
ListTagsForResource ( array $params = [] )
Lists all tags associated with a given Amazon Translate resource.
ListTerminologies ( array $params = [] )
Provides a list of custom terminologies associated with your account.
ListTextTranslationJobs ( array $params = [] )
Gets a list of the batch translation jobs that you have submitted.
StartTextTranslationJob ( array $params = [] )
Starts an asynchronous batch translation job.
StopTextTranslationJob ( array $params = [] )
Stops an asynchronous batch translation job that is in progress.
TagResource ( array $params = [] )
Associates a specific tag with a resource.
TranslateDocument ( array $params = [] )
Translates the input document from the source language to the target language.
TranslateText ( array $params = [] )
Translates input text from the source language to the target language.
UntagResource ( array $params = [] )
Removes a specific tag associated with an Amazon Translate resource.
UpdateParallelData ( array $params = [] )
Updates a previously created parallel data resource by importing a new input file from Amazon S3.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListLanguages
ListParallelData
ListTerminologies
ListTextTranslationJobs

Operations

CreateParallelData

$result = $client->createParallelData([/* ... */]);
$promise = $client->createParallelDataAsync([/* ... */]);

Creates a parallel data resource in Amazon Translate by importing an input file from Amazon S3. Parallel data files contain examples that show how you want segments of text to be translated. By adding parallel data, you can influence the style, tone, and word choice in your translation output.

Parameter Syntax

$result = $client->createParallelData([
    'ClientToken' => '<string>', // REQUIRED
    'Description' => '<string>',
    'EncryptionKey' => [
        'Id' => '<string>', // REQUIRED
        'Type' => 'KMS', // REQUIRED
    ],
    'Name' => '<string>', // REQUIRED
    'ParallelDataConfig' => [ // REQUIRED
        'Format' => 'TSV|CSV|TMX', // REQUIRED
        'S3Uri' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ClientToken

Required: Yes
Type: string

A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.

Description

Type: string

A custom description for the parallel data resource in Amazon Translate.

EncryptionKey

Type: EncryptionKey structure

The encryption key used to encrypt this object.

Name

Required: Yes
Type: string

A custom name for the parallel data resource in Amazon Translate. You must assign a name that is unique in the account and region.

ParallelDataConfig

Required: Yes
Type: ParallelDataConfig structure

Specifies the format and S3 location of the parallel data input file.

Tags

Type: Array of Tag structures

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.

Result Syntax

[
    'Name' => '<string>',
    'Status' => 'CREATING|UPDATING|ACTIVE|DELETING|FAILED',
]

Result Details

Members

Name

Type: string

The custom name that you assigned to the parallel data resource.

Status

Type: string

The status of the parallel data resource. When the resource is ready for you to use, the status is ACTIVE.

Errors

InvalidParameterValueException:
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:
The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.
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.
TooManyTagsException:
You have added too many tags to this resource. The maximum is 50 tags.
ConflictException:
There was a conflict processing the request. Try your request again.
ConcurrentModificationException:
Another modification is being made. That modification must complete before you can make your change.
InternalServerException:
An internal server error occurred. Retry your request.

DeleteParallelData

$result = $client->deleteParallelData([/* ... */]);
$promise = $client->deleteParallelDataAsync([/* ... */]);

Deletes a parallel data resource in Amazon Translate.

Parameter Syntax

$result = $client->deleteParallelData([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Required: Yes
Type: string

The name of the parallel data resource that is being deleted.

Result Syntax

[
    'Name' => '<string>',
    'Status' => 'CREATING|UPDATING|ACTIVE|DELETING|FAILED',
]

Result Details

Members

Name

Type: string

The name of the parallel data resource that is being deleted.

Status

Type: string

The status of the parallel data deletion.

Errors

ConcurrentModificationException:
Another modification is being made. That modification must complete before you can make your change.
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.

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

Members

Name

Required: Yes
Type: string

The name of the custom terminology being deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.
InvalidParameterValueException:
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.
InternalServerException:
An internal server error occurred. Retry your request.

DescribeTextTranslationJob

$result = $client->describeTextTranslationJob([/* ... */]);
$promise = $client->describeTextTranslationJobAsync([/* ... */]);

Gets the properties associated with an asynchronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on.

Parameter Syntax

$result = $client->describeTextTranslationJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The identifier that Amazon Translate generated for the job. The StartTextTranslationJob operation returns this identifier in its response.

Result Syntax

[
    'TextTranslationJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'InputDataConfig' => [
            'ContentType' => '<string>',
            'S3Uri' => '<string>',
        ],
        'JobDetails' => [
            'DocumentsWithErrorsCount' => <integer>,
            'InputDocumentsCount' => <integer>,
            'TranslatedDocumentsCount' => <integer>,
        ],
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|COMPLETED_WITH_ERROR|FAILED|STOP_REQUESTED|STOPPED',
        'Message' => '<string>',
        'OutputDataConfig' => [
            'EncryptionKey' => [
                'Id' => '<string>',
                'Type' => 'KMS',
            ],
            'S3Uri' => '<string>',
        ],
        'ParallelDataNames' => ['<string>', ...],
        'Settings' => [
            'Formality' => 'FORMAL|INFORMAL',
            'Profanity' => 'MASK',
        ],
        'SourceLanguageCode' => '<string>',
        'SubmittedTime' => <DateTime>,
        'TargetLanguageCodes' => ['<string>', ...],
        'TerminologyNames' => ['<string>', ...],
    ],
]

Result Details

Members

TextTranslationJobProperties

Type: TextTranslationJobProperties structure

An object that contains the properties associated with an asynchronous batch translation job.

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.

GetParallelData

$result = $client->getParallelData([/* ... */]);
$promise = $client->getParallelDataAsync([/* ... */]);

Provides information about a parallel data resource.

Parameter Syntax

$result = $client->getParallelData([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Required: Yes
Type: string

The name of the parallel data resource that is being retrieved.

Result Syntax

[
    'AuxiliaryDataLocation' => [
        'Location' => '<string>',
        'RepositoryType' => '<string>',
    ],
    'DataLocation' => [
        'Location' => '<string>',
        'RepositoryType' => '<string>',
    ],
    'LatestUpdateAttemptAuxiliaryDataLocation' => [
        'Location' => '<string>',
        'RepositoryType' => '<string>',
    ],
    'ParallelDataProperties' => [
        'Arn' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'EncryptionKey' => [
            'Id' => '<string>',
            'Type' => 'KMS',
        ],
        'FailedRecordCount' => <integer>,
        'ImportedDataSize' => <integer>,
        'ImportedRecordCount' => <integer>,
        'LastUpdatedAt' => <DateTime>,
        'LatestUpdateAttemptAt' => <DateTime>,
        'LatestUpdateAttemptStatus' => 'CREATING|UPDATING|ACTIVE|DELETING|FAILED',
        'Message' => '<string>',
        'Name' => '<string>',
        'ParallelDataConfig' => [
            'Format' => 'TSV|CSV|TMX',
            'S3Uri' => '<string>',
        ],
        'SkippedRecordCount' => <integer>,
        'SourceLanguageCode' => '<string>',
        'Status' => 'CREATING|UPDATING|ACTIVE|DELETING|FAILED',
        'TargetLanguageCodes' => ['<string>', ...],
    ],
]

Result Details

Members

AuxiliaryDataLocation

Type: ParallelDataDataLocation structure

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.

DataLocation

Type: ParallelDataDataLocation structure

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.

LatestUpdateAttemptAuxiliaryDataLocation

Type: ParallelDataDataLocation structure

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.

ParallelDataProperties

Type: ParallelDataProperties structure

The properties of the parallel data resource that is 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 not valid. 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.

GetTerminology

$result = $client->getTerminology([/* ... */]);
$promise = $client->getTerminologyAsync([/* ... */]);

Retrieves a custom terminology.

Parameter Syntax

$result = $client->getTerminology([
    'Name' => '<string>', // REQUIRED
    'TerminologyDataFormat' => 'CSV|TMX|TSV',
]);

Parameter Details

Members

Name

Required: Yes
Type: string

The name of the custom terminology being retrieved.

TerminologyDataFormat

Type: string

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.

Result Syntax

[
    'AuxiliaryDataLocation' => [
        'Location' => '<string>',
        'RepositoryType' => '<string>',
    ],
    'TerminologyDataLocation' => [
        'Location' => '<string>',
        'RepositoryType' => '<string>',
    ],
    'TerminologyProperties' => [
        'Arn' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'Directionality' => 'UNI|MULTI',
        'EncryptionKey' => [
            'Id' => '<string>',
            'Type' => 'KMS',
        ],
        'Format' => 'CSV|TMX|TSV',
        'LastUpdatedAt' => <DateTime>,
        'Message' => '<string>',
        'Name' => '<string>',
        'SizeBytes' => <integer>,
        'SkippedTermCount' => <integer>,
        'SourceLanguageCode' => '<string>',
        'TargetLanguageCodes' => ['<string>', ...],
        'TermCount' => <integer>,
    ],
]

Result Details

Members

AuxiliaryDataLocation

Type: TerminologyDataLocation structure

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.

TerminologyDataLocation

Type: TerminologyDataLocation structure

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.

Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

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 not valid. 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 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. The only supported merge strategy is OVERWRITE, where the imported terminology overwrites the existing terminology of the same name.

If you import a terminology that overwrites an existing one, the new terminology takes up to 10 minutes to fully propagate. After that, translations have access to the new terminology.

Parameter Syntax

$result = $client->importTerminology([
    'Description' => '<string>',
    'EncryptionKey' => [
        'Id' => '<string>', // REQUIRED
        'Type' => 'KMS', // REQUIRED
    ],
    'MergeStrategy' => 'OVERWRITE', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TerminologyData' => [ // REQUIRED
        'Directionality' => 'UNI|MULTI',
        'File' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
        'Format' => 'CSV|TMX|TSV', // 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.

Tags

Type: Array of Tag structures

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.

TerminologyData

Required: Yes
Type: TerminologyData structure

The terminology data for the custom terminology being imported.

Result Syntax

[
    'AuxiliaryDataLocation' => [
        'Location' => '<string>',
        'RepositoryType' => '<string>',
    ],
    'TerminologyProperties' => [
        'Arn' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'Directionality' => 'UNI|MULTI',
        'EncryptionKey' => [
            'Id' => '<string>',
            'Type' => 'KMS',
        ],
        'Format' => 'CSV|TMX|TSV',
        'LastUpdatedAt' => <DateTime>,
        'Message' => '<string>',
        'Name' => '<string>',
        'SizeBytes' => <integer>,
        'SkippedTermCount' => <integer>,
        'SourceLanguageCode' => '<string>',
        'TargetLanguageCodes' => ['<string>', ...],
        'TermCount' => <integer>,
    ],
]

Result Details

Members

AuxiliaryDataLocation

Type: TerminologyDataLocation structure

TerminologyProperties

Type: TerminologyProperties structure

The properties of the custom terminology being imported.

Errors

InvalidParameterValueException:
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.
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.
TooManyTagsException:
You have added too many tags to this resource. The maximum is 50 tags.
ConcurrentModificationException:
Another modification is being made. That modification must complete before you can make your change.
InternalServerException:
An internal server error occurred. Retry your request.

ListLanguages

$result = $client->listLanguages([/* ... */]);
$promise = $client->listLanguagesAsync([/* ... */]);

Provides a list of languages (RFC-5646 codes and names) that Amazon Translate supports.

Parameter Syntax

$result = $client->listLanguages([
    'DisplayLanguageCode' => 'de|en|es|fr|it|ja|ko|pt|zh|zh-TW',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

DisplayLanguageCode

Type: string

The language code for the language to use to display the language names in the response. The language code is en by default.

MaxResults

Type: int

The maximum number of results to return in each response.

NextToken

Type: string

Include the NextToken value to fetch the next group of supported languages.

Result Syntax

[
    'DisplayLanguageCode' => 'de|en|es|fr|it|ja|ko|pt|zh|zh-TW',
    'Languages' => [
        [
            'LanguageCode' => '<string>',
            'LanguageName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

DisplayLanguageCode

Type: string

The language code passed in with the request.

Languages

Type: Array of Language structures

The list of supported languages.

NextToken

Type: string

If the response does not include all remaining results, use the NextToken in the next request to fetch the next group of supported languages.

Errors

InvalidParameterValueException:
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.
TooManyRequestsException:
You have made too many requests within a short period of time. Wait for a short time and then try your request again.
UnsupportedDisplayLanguageCodeException:
Requested display language code is not supported.
InternalServerException:
An internal server error occurred. Retry your request.

ListParallelData

$result = $client->listParallelData([/* ... */]);
$promise = $client->listParallelDataAsync([/* ... */]);

Provides a list of your parallel data resources in Amazon Translate.

Parameter Syntax

$result = $client->listParallelData([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of parallel data resources returned for each request.

NextToken

Type: string

A string that specifies the next page of results to return in a paginated response.

Result Syntax

[
    'NextToken' => '<string>',
    'ParallelDataPropertiesList' => [
        [
            'Arn' => '<string>',
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'EncryptionKey' => [
                'Id' => '<string>',
                'Type' => 'KMS',
            ],
            'FailedRecordCount' => <integer>,
            'ImportedDataSize' => <integer>,
            'ImportedRecordCount' => <integer>,
            'LastUpdatedAt' => <DateTime>,
            'LatestUpdateAttemptAt' => <DateTime>,
            'LatestUpdateAttemptStatus' => 'CREATING|UPDATING|ACTIVE|DELETING|FAILED',
            'Message' => '<string>',
            'Name' => '<string>',
            'ParallelDataConfig' => [
                'Format' => 'TSV|CSV|TMX',
                'S3Uri' => '<string>',
            ],
            'SkippedRecordCount' => <integer>,
            'SourceLanguageCode' => '<string>',
            'Status' => 'CREATING|UPDATING|ACTIVE|DELETING|FAILED',
            'TargetLanguageCodes' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

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.

ParallelDataPropertiesList

Type: Array of ParallelDataProperties structures

The properties of the parallel data resources returned by this request.

Errors

InvalidParameterValueException:
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.
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.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all tags associated with a given Amazon Translate resource. For more information, see Tagging your resources.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the given Amazon Translate resource you are querying.

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Tags

Type: Array of Tag structures

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.

Errors

InvalidParameterValueException:
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.
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.

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

MaxResults

Type: int

The maximum number of custom terminologies returned per list request.

NextToken

Type: string

If the result of the request to ListTerminologies was truncated, include the NextToken to fetch the next group of custom terminologies.

Result Syntax

[
    'NextToken' => '<string>',
    'TerminologyPropertiesList' => [
        [
            'Arn' => '<string>',
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'Directionality' => 'UNI|MULTI',
            'EncryptionKey' => [
                'Id' => '<string>',
                'Type' => 'KMS',
            ],
            'Format' => 'CSV|TMX|TSV',
            'LastUpdatedAt' => <DateTime>,
            'Message' => '<string>',
            'Name' => '<string>',
            'SizeBytes' => <integer>,
            'SkippedTermCount' => <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 not valid. 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.

ListTextTranslationJobs

$result = $client->listTextTranslationJobs([/* ... */]);
$promise = $client->listTextTranslationJobsAsync([/* ... */]);

Gets a list of the batch translation jobs that you have submitted.

Parameter Syntax

$result = $client->listTextTranslationJobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|COMPLETED_WITH_ERROR|FAILED|STOP_REQUESTED|STOPPED',
        'SubmittedAfterTime' => <integer || string || DateTime>,
        'SubmittedBeforeTime' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filter

Type: TextTranslationJobFilter structure

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.

MaxResults

Type: int

The maximum number of results to return in each page. The default value is 100.

NextToken

Type: string

The token to request the next page of results.

Result Syntax

[
    'NextToken' => '<string>',
    'TextTranslationJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'InputDataConfig' => [
                'ContentType' => '<string>',
                'S3Uri' => '<string>',
            ],
            'JobDetails' => [
                'DocumentsWithErrorsCount' => <integer>,
                'InputDocumentsCount' => <integer>,
                'TranslatedDocumentsCount' => <integer>,
            ],
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|COMPLETED_WITH_ERROR|FAILED|STOP_REQUESTED|STOPPED',
            'Message' => '<string>',
            'OutputDataConfig' => [
                'EncryptionKey' => [
                    'Id' => '<string>',
                    'Type' => 'KMS',
                ],
                'S3Uri' => '<string>',
            ],
            'ParallelDataNames' => ['<string>', ...],
            'Settings' => [
                'Formality' => 'FORMAL|INFORMAL',
                'Profanity' => 'MASK',
            ],
            'SourceLanguageCode' => '<string>',
            'SubmittedTime' => <DateTime>,
            'TargetLanguageCodes' => ['<string>', ...],
            'TerminologyNames' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

TextTranslationJobPropertiesList

Type: Array of TextTranslationJobProperties structures

A list containing the properties of each job that is returned.

Errors

InvalidRequestException:
The request that you made is not valid. Check your request to determine why it's not valid and then retry the 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.
InvalidFilterException:
The filter specified for the operation is not valid. Specify a different filter.
InternalServerException:
An internal server error occurred. Retry your request.

StartTextTranslationJob

$result = $client->startTextTranslationJob([/* ... */]);
$promise = $client->startTextTranslationJobAsync([/* ... */]);

Starts an asynchronous batch translation job. Use batch translation jobs to translate large volumes of text across multiple documents at once. For batch translation, you can input documents with different source languages (specify auto as the source language). You can specify one or more target languages. Batch translation translates each input document into each of the target languages. For more information, see Asynchronous batch processing.

Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation.

Parameter Syntax

$result = $client->startTextTranslationJob([
    'ClientToken' => '<string>', // REQUIRED
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'ContentType' => '<string>', // REQUIRED
        'S3Uri' => '<string>', // REQUIRED
    ],
    'JobName' => '<string>',
    'OutputDataConfig' => [ // REQUIRED
        'EncryptionKey' => [
            'Id' => '<string>', // REQUIRED
            'Type' => 'KMS', // REQUIRED
        ],
        'S3Uri' => '<string>', // REQUIRED
    ],
    'ParallelDataNames' => ['<string>', ...],
    'Settings' => [
        'Formality' => 'FORMAL|INFORMAL',
        'Profanity' => 'MASK',
    ],
    'SourceLanguageCode' => '<string>', // REQUIRED
    'TargetLanguageCodes' => ['<string>', ...], // REQUIRED
    'TerminologyNames' => ['<string>', ...],
]);

Parameter Details

Members

ClientToken

Required: Yes
Type: string

A unique identifier for the request. This token is generated for you when using the Amazon Translate SDK.

DataAccessRoleArn

Required: Yes
Type: string

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 .

InputDataConfig

Required: Yes
Type: InputDataConfig structure

Specifies the format and location of the input documents for the translation job.

JobName

Type: string

The name of the batch translation job to be performed.

OutputDataConfig

Required: Yes
Type: OutputDataConfig structure

Specifies the S3 folder to which your job output will be saved.

ParallelDataNames

Type: Array of strings

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.

Settings

Type: TranslationSettings structure

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.

SourceLanguageCode

Required: Yes
Type: string

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.

TargetLanguageCodes

Required: Yes
Type: Array of strings

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.

TerminologyNames

Type: Array of strings

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.

Result Syntax

[
    'JobId' => '<string>',
    'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|COMPLETED_WITH_ERROR|FAILED|STOP_REQUESTED|STOPPED',
]

Result Details

Members

JobId

Type: string

The identifier generated for the job. To get the status of a job, use this ID with the DescribeTextTranslationJob operation.

JobStatus

Type: string

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.

Errors

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 Supported languages.
InvalidRequestException:
The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.
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 not valid. Review the value of the parameter you are using to correct it, and then retry your operation.
InternalServerException:
An internal server error occurred. Retry your request.

StopTextTranslationJob

$result = $client->stopTextTranslationJob([/* ... */]);
$promise = $client->stopTextTranslationJobAsync([/* ... */]);

Stops an asynchronous batch translation job that is in progress.

If the job's state is IN_PROGRESS, the job will be marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state. Otherwise, the job is put into the STOPPED state.

Asynchronous batch translation jobs are started with the StartTextTranslationJob operation. You can use the DescribeTextTranslationJob or ListTextTranslationJobs operations to get a batch translation job's JobId.

Parameter Syntax

$result = $client->stopTextTranslationJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The job ID of the job to be stopped.

Result Syntax

[
    'JobId' => '<string>',
    'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|COMPLETED_WITH_ERROR|FAILED|STOP_REQUESTED|STOPPED',
]

Result Details

Members

JobId

Type: string

The job ID of the stopped batch translation job.

JobStatus

Type: string

The status of the designated job. Upon successful completion, the job's status will be STOPPED.

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.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Associates a specific tag with a resource. A tag is a key-value pair that adds as a metadata to a resource. For more information, see Tagging your resources.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the given Amazon Translate resource to which you want to associate the tags.

Tags

Required: Yes
Type: Array of Tag structures

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterValueException:
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.
ConcurrentModificationException:
Another modification is being made. That modification must complete before you can make your change.
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.
TooManyTagsException:
You have added too many tags to this resource. The maximum is 50 tags.
InternalServerException:
An internal server error occurred. Retry your request.

TranslateDocument

$result = $client->translateDocument([/* ... */]);
$promise = $client->translateDocumentAsync([/* ... */]);

Translates the input document from the source language to the target language. This synchronous operation supports plain text or HTML for the input document. TranslateDocument supports translations from English to any supported language, and from any supported language to English. Therefore, specify either the source language code or the target language code as “en” (English).

TranslateDocument does not support language auto-detection.

If you set the Formality parameter, the request will fail if the target language does not support formality. For a list of target languages that support formality, see Setting formality.

Parameter Syntax

$result = $client->translateDocument([
    'Document' => [ // REQUIRED
        'Content' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
        'ContentType' => '<string>', // REQUIRED
    ],
    'Settings' => [
        'Formality' => 'FORMAL|INFORMAL',
        'Profanity' => 'MASK',
    ],
    'SourceLanguageCode' => '<string>', // REQUIRED
    'TargetLanguageCode' => '<string>', // REQUIRED
    'TerminologyNames' => ['<string>', ...],
]);

Parameter Details

Members

Document

Required: Yes
Type: Document structure

The content and content type for the document to be translated. The document size must not exceed 100 KB.

Settings

Type: TranslationSettings structure

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.

SourceLanguageCode

Required: Yes
Type: string

The language code for the language of the source text. Do not use auto, because TranslateDocument does not support language auto-detection. For a list of supported language codes, see Supported languages.

TargetLanguageCode

Required: Yes
Type: string

The language code requested for the translated document. For a list of supported language codes, see Supported languages.

TerminologyNames

Type: Array of strings

The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.

Use the ListTerminologies operation to get the available terminology lists.

For more information about custom terminology lists, see Custom terminology.

Result Syntax

[
    'AppliedSettings' => [
        'Formality' => 'FORMAL|INFORMAL',
        'Profanity' => 'MASK',
    ],
    'AppliedTerminologies' => [
        [
            'Name' => '<string>',
            'Terms' => [
                [
                    'SourceText' => '<string>',
                    'TargetText' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'SourceLanguageCode' => '<string>',
    'TargetLanguageCode' => '<string>',
    'TranslatedDocument' => [
        'Content' => <string || resource || Psr\Http\Message\StreamInterface>,
    ],
]

Result Details

Members

AppliedSettings

Type: TranslationSettings structure

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.

AppliedTerminologies

Type: Array of AppliedTerminology structures

The names of the custom terminologies applied to the input text by Amazon Translate to produce the translated text document.

SourceLanguageCode

Required: Yes
Type: string

The language code of the source document.

TargetLanguageCode

Required: Yes
Type: string

The language code of the translated document.

TranslatedDocument

Required: Yes
Type: TranslatedDocument structure

The document containing the translated content. The document format matches the source document format.

Errors

InvalidRequestException:
The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.
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.
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.
UnsupportedLanguagePairException:
Amazon Translate does not support translation from the language of the source text into the requested target language. For more information, see Supported languages.
InternalServerException:
An internal server error occurred. Retry your request.
ServiceUnavailableException:
The Amazon Translate service is temporarily unavailable. Wait a bit and then retry your request.

TranslateText

$result = $client->translateText([/* ... */]);
$promise = $client->translateTextAsync([/* ... */]);

Translates input text from the source language to the target language. For a list of available languages and language codes, see Supported languages.

Parameter Syntax

$result = $client->translateText([
    'Settings' => [
        'Formality' => 'FORMAL|INFORMAL',
        'Profanity' => 'MASK',
    ],
    'SourceLanguageCode' => '<string>', // REQUIRED
    'TargetLanguageCode' => '<string>', // REQUIRED
    'TerminologyNames' => ['<string>', ...],
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Members

Settings

Type: TranslationSettings structure

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.

SourceLanguageCode

Required: Yes
Type: string

The language code for the language of the source text. 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.

TargetLanguageCode

Required: Yes
Type: string

The language code requested for the language of the target text. For a list of language codes, see Supported languages.

TerminologyNames

Type: Array of strings

Use the ListTerminologies operation to get the available terminology lists.

For more information about custom terminology lists, see Custom terminology.

Text

Required: Yes
Type: string

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.

Result Syntax

[
    'AppliedSettings' => [
        'Formality' => 'FORMAL|INFORMAL',
        'Profanity' => 'MASK',
    ],
    'AppliedTerminologies' => [
        [
            'Name' => '<string>',
            'Terms' => [
                [
                    'SourceText' => '<string>',
                    'TargetText' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'SourceLanguageCode' => '<string>',
    'TargetLanguageCode' => '<string>',
    'TranslatedText' => '<string>',
]

Result Details

Members

AppliedSettings

Type: TranslationSettings structure

Optional settings that modify the translation output.

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 translated text.

Errors

InvalidRequestException:
The request that you made is not valid. Check your request to determine why it's not valid 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 Supported languages.
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. Wait a bit and then retry your request.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a specific tag associated with an Amazon Translate resource. For more information, see Tagging your resources.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the given Amazon Translate resource from which you want to remove the tags.

TagKeys

Required: Yes
Type: Array of strings

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterValueException:
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.
ConcurrentModificationException:
Another modification is being made. That modification must complete before you can make your change.
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.

UpdateParallelData

$result = $client->updateParallelData([/* ... */]);
$promise = $client->updateParallelDataAsync([/* ... */]);

Updates a previously created parallel data resource by importing a new input file from Amazon S3.

Parameter Syntax

$result = $client->updateParallelData([
    'ClientToken' => '<string>', // REQUIRED
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'ParallelDataConfig' => [ // REQUIRED
        'Format' => 'TSV|CSV|TMX', // REQUIRED
        'S3Uri' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

ClientToken

Required: Yes
Type: string

A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.

Description

Type: string

A custom description for the parallel data resource in Amazon Translate.

Name

Required: Yes
Type: string

The name of the parallel data resource being updated.

ParallelDataConfig

Required: Yes
Type: ParallelDataConfig structure

Specifies the format and S3 location of the parallel data input file.

Result Syntax

[
    'LatestUpdateAttemptAt' => <DateTime>,
    'LatestUpdateAttemptStatus' => 'CREATING|UPDATING|ACTIVE|DELETING|FAILED',
    'Name' => '<string>',
    'Status' => 'CREATING|UPDATING|ACTIVE|DELETING|FAILED',
]

Result Details

Members

LatestUpdateAttemptAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the most recent update was attempted.

LatestUpdateAttemptStatus

Type: string

The status of the parallel data update attempt. When the updated parallel data resource is ready for you to use, the status is ACTIVE.

Name

Type: string

The name of the parallel data resource being updated.

Status

Type: string

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.

Errors

ConcurrentModificationException:
Another modification is being made. That modification must complete before you can make your change.
InvalidParameterValueException:
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:
The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.
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.
ConflictException:
There was a conflict processing the request. Try your request again.
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.

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

Type: string

The language code of the auto-detected language from Amazon Comprehend.

Message

Type: string

Document

Description

The content and content type of a document.

Members

Content

Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The Contentfield type is Binary large object (blob). This object contains the document content converted into base64-encoded binary data. If you use one of the AWS SDKs, the SDK performs the Base64-encoding on this field before sending the request.

ContentType

Required: Yes
Type: string

Describes the format of the document. You can specify one of the following:

text/html - The input data consists of HTML content. Amazon Translate translates only the text in the HTML element.
text/plain - The input data consists of unformatted text. Amazon Translate translates every character in the content.

EncryptionKey

Description

The encryption key used to encrypt this object.

Members

Id

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.

Type

Required: Yes
Type: string

The type of encryption key used by Amazon Translate to encrypt this object.

InputDataConfig

Description

The input configuration properties for requesting a batch translation job.

Members

ContentType

Required: Yes
Type: string

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 the html 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).
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.

S3Uri

Required: Yes
Type: string

Type: int

The number of documents that could not be processed during a translation job.

InputDocumentsCount

Type: int

The number of documents used as input in a translation job.

TranslatedDocumentsCount

Type: int

The number of documents successfully processed during a translation job.

Language

Description

A supported language.

Members

LanguageCode

Required: Yes
Type: string

Language code for the supported language.

LanguageName

Required: Yes
Type: string

Language name of the supported language.

LimitExceededException

Description

The specified limit has been exceeded. Review your request and retry it with a quantity below the stated limit.

Members

Message

Type: string

OutputDataConfig

Description

The output configuration properties for a batch translation job.

Members

EncryptionKey

Type: EncryptionKey structure

The encryption key used to encrypt this object.

S3Uri

Required: Yes
Type: string

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

Description

Specifies the format and S3 location of the parallel data input file.

Members

Format

Required: Yes
Type: string

The format of the parallel data input file.

S3Uri

Required: Yes
Type: string

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.

ParallelDataDataLocation

Description

The location of the most recent parallel data input file that was successfully imported into Amazon Translate.

Members

Location

Required: Yes
Type: string

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.

Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

RepositoryType

Required: Yes
Type: string

Describes the repository that contains the parallel data input file.

ParallelDataProperties

Description

The properties of a parallel data resource.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the parallel data resource.

CreatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the parallel data resource was created.

Description

Type: string

The description assigned to the parallel data resource.

EncryptionKey

Type: EncryptionKey structure

The encryption key used to encrypt this object.

FailedRecordCount

Type: long (int|float)

The number of records unsuccessfully imported from the parallel data input file.

ImportedDataSize

Type: long (int|float)

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.

ImportedRecordCount

Type: long (int|float)

The number of records successfully imported from the parallel data input file.

LastUpdatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the parallel data resource was last updated.

LatestUpdateAttemptAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the most recent update was attempted.

LatestUpdateAttemptStatus

Type: string

The status of the most recent update attempt for the parallel data resource.

Message

Type: string

Additional information from Amazon Translate about the parallel data resource.

Name

Type: string

The custom name assigned to the parallel data resource.

ParallelDataConfig

Type: ParallelDataConfig structure

Specifies the format and S3 location of the parallel data input file.

SkippedRecordCount

Type: long (int|float)

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.

SourceLanguageCode

Type: string

The source language of the translations in the parallel data file.

Status

Type: string

The status of the parallel data resource. When the parallel data is ready for you to use, the status is ACTIVE.

TargetLanguageCodes

Type: Array of strings

Type: string

The source text of the term being translated by the custom terminology.

TargetText

Type: string

The target text of the term being translated by the custom terminology.

TerminologyData

Description

The data associated with the custom terminology. For information about the custom terminology file, see Creating a Custom Terminology.

Members

Directionality

Type: string

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.

File

Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

Format

Required: Yes
Type: string

The data format of the custom terminology.

TerminologyDataLocation

Description

The location of the custom terminology data.

Members

Location

Required: Yes
Type: string

Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

RepositoryType

Required: Yes
Type: string

The repository type for the custom terminology data.

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.

Directionality

Type: string

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.

EncryptionKey

Type: EncryptionKey structure

The encryption key for the custom terminology.

Format

Type: string

The format of the custom terminology input file.

LastUpdatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the custom terminology was last update, based on the timestamp.

Message

Type: string

Additional information from Amazon Translate about the terminology resource.

Name

Type: string

The name of the custom terminology.

SizeBytes

Type: int

The size of the file used when importing a custom terminology.

SkippedTermCount

Type: int

The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.

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 resource. 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

Message

Type: string

TextTranslationJobFilter

Description

Provides information for filtering a list of translation jobs. For more information, see ListTextTranslationJobs.

Members

JobName

Type: string

Filters the list of jobs by name.

JobStatus

Type: string

Filters the list of jobs based by job status.

SubmittedAfterTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

SubmittedBeforeTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Description

Provides information about a translation job.

Members

DataAccessRoleArn

Type: string

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.

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the translation job ended.

InputDataConfig

Type: InputDataConfig structure

The input configuration properties that were specified when the job was requested.

JobDetails

Type: JobDetails structure

The number of documents successfully and unsuccessfully processed during the translation job.

JobId

Type: string

The ID of the translation job.

JobName

Type: string

The user-defined name of the translation job.

JobStatus

Type: string

The status of the translation job.

Message

Type: string

An explanation of any errors that may have occurred during the translation job.

OutputDataConfig

Type: OutputDataConfig structure

The output configuration properties that were specified when the job was requested.

ParallelDataNames

Type: Array of strings

A list containing the names of the parallel data resources applied to the translation job.

Settings

Type: TranslationSettings structure

Settings that modify the translation output.

SourceLanguageCode

Type: string

The language code of the language of the source text. The language must be a language supported by Amazon Translate.

SubmittedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the translation job was submitted.

TargetLanguageCodes

Type: Array of strings

The language code of the language of the target text. The language must be a language supported by Amazon Translate.

TerminologyNames

Type: Array of strings

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.

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

Message

Type: string

TooManyTagsException

Description

You have added too many tags to this resource. The maximum is 50 tags.

Members

ResourceArn

Type: string

message

Type: string

TranslatedDocument

Description

The translated content.

Members

Content

Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The document containing the translated content.

TranslationSettings

Description

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.

Members

Formality

Type: string

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.

Profanity

Type: string

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.

UnsupportedDisplayLanguageCodeException

Description

Requested display language code is not supported.

Members

DisplayLanguageCode

Type: string

Language code passed in with the request.

Message

Type: string

UnsupportedLanguagePairException

Description

Amazon Translate does not support translation from the language of the source text into the requested target language. For more information, see Supported languages.

Members

Message

Type: string

SourceLanguageCode

Type: string

The language code for the language of the input text.

TargetLanguageCode

Type: string

The language code for the language of the translated text.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Translate 2017-07-01

Operation Summary

Paginators

Operations

CreateParallelData

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteParallelData

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteTerminology

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeTextTranslationJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetParallelData

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetTerminology

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ImportTerminology

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListLanguages

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListParallelData

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members