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

DeleteTerminology ( array $params = [] )
A synchronous action that deletes a custom terminology.
DescribeTextTranslationJob ( array $params = [] )
Gets the properties associated with an asycnhronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on.
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.
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.
TranslateText ( array $params = [] )
Translates input text from the source language to the target language.

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:

ListTerminologies
ListTextTranslationJobs

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

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 invalid. 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 asycnhronous 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' => [
            'S3Uri' => '<string>',
        ],
        '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.

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

Name

Required: Yes
Type: string

The name of the custom terminology being retrieved.

TerminologyDataFormat

Required: Yes
Type: string

The data format of the custom terminology being retrieved, either CSV or TMX.

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

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>',
            '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.

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' => [
                'S3Uri' => '<string>',
            ],
            'SourceLanguageCode' => '<string>',
            'SubmittedTime' => <DateTime>,
            'TargetLanguageCodes' => ['<string>', ...],
            'TerminologyNames' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The token to use to retreive 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 invalid. Check your request to determine why it's invalid 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 invalid. 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. Batch translation jobs can be used to translate large volumes of text across multiple documents at once. For more information, see async.

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

Amazon Translate does not support batch translation of multiple source languages at once.

Parameter Syntax

$result = $client->startTextTranslationJob([
    'ClientToken' => '<string>', // REQUIRED
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'ContentType' => '<string>', // REQUIRED
        'S3Uri' => '<string>', // REQUIRED
    ],
    'JobName' => '<string>',
    'OutputDataConfig' => [ // REQUIRED
        'S3Uri' => '<string>', // REQUIRED
    ],
    '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 auto-generated 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 nformation, see identity-and-access-management.

InputDataConfig

Required: Yes
Type: InputDataConfig structure

Specifies the format and S3 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.

SourceLanguageCode

Required: Yes
Type: string

The language code of the input language. For a list of language codes, see what-is-languages.

Amazon Translate does not automatically detect a source language during batch translation jobs.

TargetLanguageCodes

Required: Yes
Type: Array of strings

The language code of the output language.

TerminologyNames

Type: Array of strings

The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.

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 how-to-error-msg.
InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid 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.
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.

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 what-is-languages.

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. For a list of language codes, see what-is-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.

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 name of the terminology list file to be used in the TranslateText request. You can use 1 terminology list at most in a TranslateText request. Terminology lists can contain a maximum of 256 terms.

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

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

DetectedLanguageCode

Type: string

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

Message

Type: string

EncryptionKey

Description

The encryption key used to encrypt the custom terminologies used by Amazon Translate.

Members

Id

Required: Yes
Type: string

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

Type

Required: Yes
Type: string

The type of encryption key used by Amazon Translate to encrypt custom terminologies.

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

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.

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

S3Uri

Required: Yes
Type: string

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.

Members

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. Either CSV or TMX.

TerminologyDataLocation

Description

The location of the custom terminology data.

Members

Location

Required: Yes
Type: string

The location of the custom terminology data.

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.

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

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 occured during the translation job.

OutputDataConfig

Type: OutputDataConfig structure

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

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

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.

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

DeleteTerminology

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeTextTranslationJob

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

ListTerminologies

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListTextTranslationJobs

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

StartTextTranslationJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

StopTextTranslationJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

TranslateText

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members