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',
        'S3Uri' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request.

TooManyRequestsException:

You have made too many requests within a short period of time. Wait for a short time and then try your request again.

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

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' => [
            'Brevity' => 'ON',
            'Formality' => 'FORMAL|INFORMAL',
            'Profanity' => 'MASK',
        ],
        'SourceLanguageCode' => '<string>',
        'SubmittedTime' => <DateTime>,
        'TargetLanguageCodes' => ['<string>', ...],
        'TerminologyNames' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request.

TooManyRequestsException:

You have made too many requests within a short period of time. Wait for a short time and then try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

GetParallelData

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

Provides information about a parallel data resource.

Parameter Syntax

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

Parameter Details

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

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

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

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

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' => [
                'Brevity' => 'ON',
                'Formality' => 'FORMAL|INFORMAL',
                'Profanity' => 'MASK',
            ],
            'SourceLanguageCode' => '<string>',
            'SubmittedTime' => <DateTime>,
            'TargetLanguageCodes' => ['<string>', ...],
            'TerminologyNames' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

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' => [
        'Brevity' => 'ON',
        'Formality' => 'FORMAL|INFORMAL',
        'Profanity' => 'MASK',
    ],
    'SourceLanguageCode' => '<string>', // REQUIRED
    'TargetLanguageCodes' => ['<string>', ...], // REQUIRED
    'TerminologyNames' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request.

TooManyRequestsException:

You have made too many requests within a short period of time. Wait for a short time and then try your request again.

InternalServerException:

An internal server error occurred. Retry your request.

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

Result Syntax

[]

Result Details

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 text, HTML, or Word documents as 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).

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' => [
        'Brevity' => 'ON',
        'Formality' => 'FORMAL|INFORMAL',
        'Profanity' => 'MASK',
    ],
    'SourceLanguageCode' => '<string>', // REQUIRED
    'TargetLanguageCode' => '<string>', // REQUIRED
    'TerminologyNames' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'AppliedSettings' => [
        'Brevity' => 'ON',
        '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

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' => [
        'Brevity' => 'ON',
        'Formality' => 'FORMAL|INFORMAL',
        'Profanity' => 'MASK',
    ],
    'SourceLanguageCode' => '<string>', // REQUIRED
    'TargetLanguageCode' => '<string>', // REQUIRED
    'TerminologyNames' => ['<string>', ...],
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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',
        'S3Uri' => '<string>',
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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.