# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [CreateParallelData](API_CreateParallelData.md) 
+  [DeleteParallelData](API_DeleteParallelData.md) 
+  [DeleteTerminology](API_DeleteTerminology.md) 
+  [DescribeTextTranslationJob](API_DescribeTextTranslationJob.md) 
+  [GetParallelData](API_GetParallelData.md) 
+  [GetTerminology](API_GetTerminology.md) 
+  [ImportTerminology](API_ImportTerminology.md) 
+  [ListLanguages](API_ListLanguages.md) 
+  [ListParallelData](API_ListParallelData.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListTerminologies](API_ListTerminologies.md) 
+  [ListTextTranslationJobs](API_ListTextTranslationJobs.md) 
+  [StartTextTranslationJob](API_StartTextTranslationJob.md) 
+  [StopTextTranslationJob](API_StopTextTranslationJob.md) 
+  [TagResource](API_TagResource.md) 
+  [TranslateDocument](API_TranslateDocument.md) 
+  [TranslateText](API_TranslateText.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateParallelData](API_UpdateParallelData.md) 

# CreateParallelData
<a name="API_CreateParallelData"></a>

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.

## Request Syntax
<a name="API_CreateParallelData_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "Description": "string",
   "EncryptionKey": { 
      "Id": "string",
      "Type": "string"
   },
   "Name": "string",
   "ParallelDataConfig": { 
      "Format": "string",
      "S3Uri": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateParallelData_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateParallelData_RequestSyntax) **   <a name="translate-CreateParallelData-request-ClientToken"></a>
A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: Yes

 ** [Description](#API_CreateParallelData_RequestSyntax) **   <a name="translate-CreateParallelData-request-Description"></a>
A custom description for the parallel data resource in Amazon Translate.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `[\P{M}\p{M}]{0,256}`   
Required: No

 ** [EncryptionKey](#API_CreateParallelData_RequestSyntax) **   <a name="translate-CreateParallelData-request-EncryptionKey"></a>
The encryption key used to encrypt this object.  
Type: [EncryptionKey](API_EncryptionKey.md) object  
Required: No

 ** [Name](#API_CreateParallelData_RequestSyntax) **   <a name="translate-CreateParallelData-request-Name"></a>
A custom name for the parallel data resource in Amazon Translate. You must assign a name that is unique in the account and region.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([A-Za-z0-9-]_?)+$`   
Required: Yes

 ** [ParallelDataConfig](#API_CreateParallelData_RequestSyntax) **   <a name="translate-CreateParallelData-request-ParallelDataConfig"></a>
Specifies the format and S3 location of the parallel data input file.  
Type: [ParallelDataConfig](API_ParallelDataConfig.md) object  
Required: Yes

 ** [Tags](#API_CreateParallelData_RequestSyntax) **   <a name="translate-CreateParallelData-request-Tags"></a>
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](https://docs.aws.amazon.com/translate/latest/dg/tagging.html) in the Amazon Translate Developer Guide.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateParallelData_ResponseSyntax"></a>

```
{
   "Name": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_CreateParallelData_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Name](#API_CreateParallelData_ResponseSyntax) **   <a name="translate-CreateParallelData-response-Name"></a>
The custom name that you assigned to the parallel data resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([A-Za-z0-9-]_?)+$` 

 ** [Status](#API_CreateParallelData_ResponseSyntax) **   <a name="translate-CreateParallelData-response-Status"></a>
The status of the parallel data resource. When the resource is ready for you to use, the status is `ACTIVE`.  
Type: String  
Valid Values: `CREATING | UPDATING | ACTIVE | DELETING | FAILED` 

## Errors
<a name="API_CreateParallelData_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
Another modification is being made. That modification must complete before you can make your change.  
HTTP Status Code: 400

 ** ConflictException **   
There was a conflict processing the request. Try your request again.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** 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.  
HTTP Status Code: 400

 ** InvalidRequestException **   
 The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.   
HTTP Status Code: 400

 ** LimitExceededException **   
The specified limit has been exceeded. Review your request and retry it with a quantity below the stated limit.  
HTTP Status Code: 400

 ** TooManyRequestsException **   
 You have made too many requests within a short period of time. Wait for a short time and then try your request again.  
HTTP Status Code: 400

 ** TooManyTagsException **   
You have added too many tags to this resource. The maximum is 50 tags.  
HTTP Status Code: 400

## See Also
<a name="API_CreateParallelData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/CreateParallelData) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/CreateParallelData) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/CreateParallelData) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/CreateParallelData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/CreateParallelData) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/CreateParallelData) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/CreateParallelData) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/CreateParallelData) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/CreateParallelData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/CreateParallelData) 

# DeleteParallelData
<a name="API_DeleteParallelData"></a>

Deletes a parallel data resource in Amazon Translate.

## Request Syntax
<a name="API_DeleteParallelData_RequestSyntax"></a>

```
{
   "Name": "string"
}
```

## Request Parameters
<a name="API_DeleteParallelData_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_DeleteParallelData_RequestSyntax) **   <a name="translate-DeleteParallelData-request-Name"></a>
The name of the parallel data resource that is being deleted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([A-Za-z0-9-]_?)+$`   
Required: Yes

## Response Syntax
<a name="API_DeleteParallelData_ResponseSyntax"></a>

```
{
   "Name": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_DeleteParallelData_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Name](#API_DeleteParallelData_ResponseSyntax) **   <a name="translate-DeleteParallelData-response-Name"></a>
The name of the parallel data resource that is being deleted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([A-Za-z0-9-]_?)+$` 

 ** [Status](#API_DeleteParallelData_ResponseSyntax) **   <a name="translate-DeleteParallelData-response-Status"></a>
The status of the parallel data deletion.  
Type: String  
Valid Values: `CREATING | UPDATING | ACTIVE | DELETING | FAILED` 

## Errors
<a name="API_DeleteParallelData_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
Another modification is being made. That modification must complete before you can make your change.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** 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.  
HTTP Status Code: 400

 ** TooManyRequestsException **   
 You have made too many requests within a short period of time. Wait for a short time and then try your request again.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteParallelData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/DeleteParallelData) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/DeleteParallelData) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/DeleteParallelData) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/DeleteParallelData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/DeleteParallelData) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/DeleteParallelData) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/DeleteParallelData) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/DeleteParallelData) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/DeleteParallelData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/DeleteParallelData) 

# DeleteTerminology
<a name="API_DeleteTerminology"></a>

A synchronous action that deletes a custom terminology.

## Request Syntax
<a name="API_DeleteTerminology_RequestSyntax"></a>

```
{
   "Name": "string"
}
```

## Request Parameters
<a name="API_DeleteTerminology_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_DeleteTerminology_RequestSyntax) **   <a name="translate-DeleteTerminology-request-Name"></a>
The name of the custom terminology being deleted.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([A-Za-z0-9-]_?)+$`   
Required: Yes

## Response Elements
<a name="API_DeleteTerminology_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteTerminology_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** 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.  
HTTP Status Code: 400

 ** 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.  
HTTP Status Code: 400

 ** TooManyRequestsException **   
 You have made too many requests within a short period of time. Wait for a short time and then try your request again.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteTerminology_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/DeleteTerminology) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/DeleteTerminology) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/DeleteTerminology) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/DeleteTerminology) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/DeleteTerminology) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/DeleteTerminology) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/DeleteTerminology) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/DeleteTerminology) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/DeleteTerminology) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/DeleteTerminology) 

# DescribeTextTranslationJob
<a name="API_DescribeTextTranslationJob"></a>

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.

## Request Syntax
<a name="API_DescribeTextTranslationJob_RequestSyntax"></a>

```
{
   "JobId": "string"
}
```

## Request Parameters
<a name="API_DescribeTextTranslationJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [JobId](#API_DescribeTextTranslationJob_RequestSyntax) **   <a name="translate-DescribeTextTranslationJob-request-JobId"></a>
The identifier that Amazon Translate generated for the job. The [StartTextTranslationJob](API_StartTextTranslationJob.md) operation returns this identifier in its response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$`   
Required: Yes

## Response Syntax
<a name="API_DescribeTextTranslationJob_ResponseSyntax"></a>

```
{
   "TextTranslationJobProperties": { 
      "DataAccessRoleArn": "string",
      "EndTime": number,
      "InputDataConfig": { 
         "ContentType": "string",
         "S3Uri": "string"
      },
      "JobDetails": { 
         "DocumentsWithErrorsCount": number,
         "InputDocumentsCount": number,
         "TranslatedDocumentsCount": number
      },
      "JobId": "string",
      "JobName": "string",
      "JobStatus": "string",
      "Message": "string",
      "OutputDataConfig": { 
         "EncryptionKey": { 
            "Id": "string",
            "Type": "string"
         },
         "S3Uri": "string"
      },
      "ParallelDataNames": [ "string" ],
      "Settings": { 
         "Brevity": "string",
         "Formality": "string",
         "Profanity": "string"
      },
      "SourceLanguageCode": "string",
      "SubmittedTime": number,
      "TargetLanguageCodes": [ "string" ],
      "TerminologyNames": [ "string" ]
   }
}
```

## Response Elements
<a name="API_DescribeTextTranslationJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TextTranslationJobProperties](#API_DescribeTextTranslationJob_ResponseSyntax) **   <a name="translate-DescribeTextTranslationJob-response-TextTranslationJobProperties"></a>
An object that contains the properties associated with an asynchronous batch translation job.  
Type: [TextTranslationJobProperties](API_TextTranslationJobProperties.md) object

## Errors
<a name="API_DescribeTextTranslationJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** 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.  
HTTP Status Code: 400

 ** TooManyRequestsException **   
 You have made too many requests within a short period of time. Wait for a short time and then try your request again.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeTextTranslationJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/DescribeTextTranslationJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/DescribeTextTranslationJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/DescribeTextTranslationJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/DescribeTextTranslationJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/DescribeTextTranslationJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/DescribeTextTranslationJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/DescribeTextTranslationJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/DescribeTextTranslationJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/DescribeTextTranslationJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/DescribeTextTranslationJob) 

# GetParallelData
<a name="API_GetParallelData"></a>

Provides information about a parallel data resource.

## Request Syntax
<a name="API_GetParallelData_RequestSyntax"></a>

```
{
   "Name": "string"
}
```

## Request Parameters
<a name="API_GetParallelData_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_GetParallelData_RequestSyntax) **   <a name="translate-GetParallelData-request-Name"></a>
The name of the parallel data resource that is being retrieved.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([A-Za-z0-9-]_?)+$`   
Required: Yes

## Response Syntax
<a name="API_GetParallelData_ResponseSyntax"></a>

```
{
   "AuxiliaryDataLocation": { 
      "Location": "string",
      "RepositoryType": "string"
   },
   "DataLocation": { 
      "Location": "string",
      "RepositoryType": "string"
   },
   "LatestUpdateAttemptAuxiliaryDataLocation": { 
      "Location": "string",
      "RepositoryType": "string"
   },
   "ParallelDataProperties": { 
      "Arn": "string",
      "CreatedAt": number,
      "Description": "string",
      "EncryptionKey": { 
         "Id": "string",
         "Type": "string"
      },
      "FailedRecordCount": number,
      "ImportedDataSize": number,
      "ImportedRecordCount": number,
      "LastUpdatedAt": number,
      "LatestUpdateAttemptAt": number,
      "LatestUpdateAttemptStatus": "string",
      "Message": "string",
      "Name": "string",
      "ParallelDataConfig": { 
         "Format": "string",
         "S3Uri": "string"
      },
      "SkippedRecordCount": number,
      "SourceLanguageCode": "string",
      "Status": "string",
      "TargetLanguageCodes": [ "string" ]
   }
}
```

## Response Elements
<a name="API_GetParallelData_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AuxiliaryDataLocation](#API_GetParallelData_ResponseSyntax) **   <a name="translate-GetParallelData-response-AuxiliaryDataLocation"></a>
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.  
Type: [ParallelDataDataLocation](API_ParallelDataDataLocation.md) object

 ** [DataLocation](#API_GetParallelData_ResponseSyntax) **   <a name="translate-GetParallelData-response-DataLocation"></a>
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 =, \$1, -, 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.
Type: [ParallelDataDataLocation](API_ParallelDataDataLocation.md) object

 ** [LatestUpdateAttemptAuxiliaryDataLocation](#API_GetParallelData_ResponseSyntax) **   <a name="translate-GetParallelData-response-LatestUpdateAttemptAuxiliaryDataLocation"></a>
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.  
Type: [ParallelDataDataLocation](API_ParallelDataDataLocation.md) object

 ** [ParallelDataProperties](#API_GetParallelData_ResponseSyntax) **   <a name="translate-GetParallelData-response-ParallelDataProperties"></a>
The properties of the parallel data resource that is being retrieved.  
Type: [ParallelDataProperties](API_ParallelDataProperties.md) object

## Errors
<a name="API_GetParallelData_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** 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.  
HTTP Status Code: 400

 ** 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.  
HTTP Status Code: 400

 ** TooManyRequestsException **   
 You have made too many requests within a short period of time. Wait for a short time and then try your request again.  
HTTP Status Code: 400

## See Also
<a name="API_GetParallelData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/GetParallelData) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/GetParallelData) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/GetParallelData) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/GetParallelData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/GetParallelData) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/GetParallelData) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/GetParallelData) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/GetParallelData) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/GetParallelData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/GetParallelData) 

# GetTerminology
<a name="API_GetTerminology"></a>

Retrieves a custom terminology.

## Request Syntax
<a name="API_GetTerminology_RequestSyntax"></a>

```
{
   "Name": "string",
   "TerminologyDataFormat": "string"
}
```

## Request Parameters
<a name="API_GetTerminology_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_GetTerminology_RequestSyntax) **   <a name="translate-GetTerminology-request-Name"></a>
The name of the custom terminology being retrieved.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([A-Za-z0-9-]_?)+$`   
Required: Yes

 ** [TerminologyDataFormat](#API_GetTerminology_RequestSyntax) **   <a name="translate-GetTerminology-request-TerminologyDataFormat"></a>
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.  
Type: String  
Valid Values: `CSV | TMX | TSV`   
Required: No

## Response Syntax
<a name="API_GetTerminology_ResponseSyntax"></a>

```
{
   "AuxiliaryDataLocation": { 
      "Location": "string",
      "RepositoryType": "string"
   },
   "TerminologyDataLocation": { 
      "Location": "string",
      "RepositoryType": "string"
   },
   "TerminologyProperties": { 
      "Arn": "string",
      "CreatedAt": number,
      "Description": "string",
      "Directionality": "string",
      "EncryptionKey": { 
         "Id": "string",
         "Type": "string"
      },
      "Format": "string",
      "LastUpdatedAt": number,
      "Message": "string",
      "Name": "string",
      "SizeBytes": number,
      "SkippedTermCount": number,
      "SourceLanguageCode": "string",
      "TargetLanguageCodes": [ "string" ],
      "TermCount": number
   }
}
```

## Response Elements
<a name="API_GetTerminology_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AuxiliaryDataLocation](#API_GetTerminology_ResponseSyntax) **   <a name="translate-GetTerminology-response-AuxiliaryDataLocation"></a>
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.  
Type: [TerminologyDataLocation](API_TerminologyDataLocation.md) object

 ** [TerminologyDataLocation](#API_GetTerminology_ResponseSyntax) **   <a name="translate-GetTerminology-response-TerminologyDataLocation"></a>
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.   
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 =, \$1, -, 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.
Type: [TerminologyDataLocation](API_TerminologyDataLocation.md) object

 ** [TerminologyProperties](#API_GetTerminology_ResponseSyntax) **   <a name="translate-GetTerminology-response-TerminologyProperties"></a>
The properties of the custom terminology being retrieved.  
Type: [TerminologyProperties](API_TerminologyProperties.md) object

## Errors
<a name="API_GetTerminology_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** 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.  
HTTP Status Code: 400

 ** 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.  
HTTP Status Code: 400

 ** TooManyRequestsException **   
 You have made too many requests within a short period of time. Wait for a short time and then try your request again.  
HTTP Status Code: 400

## See Also
<a name="API_GetTerminology_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/GetTerminology) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/GetTerminology) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/GetTerminology) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/GetTerminology) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/GetTerminology) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/GetTerminology) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/GetTerminology) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/GetTerminology) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/GetTerminology) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/GetTerminology) 

# ImportTerminology
<a name="API_ImportTerminology"></a>

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.

## Request Syntax
<a name="API_ImportTerminology_RequestSyntax"></a>

```
{
   "Description": "string",
   "EncryptionKey": { 
      "Id": "string",
      "Type": "string"
   },
   "MergeStrategy": "string",
   "Name": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TerminologyData": { 
      "Directionality": "string",
      "File": blob,
      "Format": "string"
   }
}
```

## Request Parameters
<a name="API_ImportTerminology_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_ImportTerminology_RequestSyntax) **   <a name="translate-ImportTerminology-request-Description"></a>
The description of the custom terminology being imported.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `[\P{M}\p{M}]{0,256}`   
Required: No

 ** [EncryptionKey](#API_ImportTerminology_RequestSyntax) **   <a name="translate-ImportTerminology-request-EncryptionKey"></a>
The encryption key for the custom terminology being imported.  
Type: [EncryptionKey](API_EncryptionKey.md) object  
Required: No

 ** [MergeStrategy](#API_ImportTerminology_RequestSyntax) **   <a name="translate-ImportTerminology-request-MergeStrategy"></a>
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.  
Type: String  
Valid Values: `OVERWRITE`   
Required: Yes

 ** [Name](#API_ImportTerminology_RequestSyntax) **   <a name="translate-ImportTerminology-request-Name"></a>
The name of the custom terminology being imported.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([A-Za-z0-9-]_?)+$`   
Required: Yes

 ** [Tags](#API_ImportTerminology_RequestSyntax) **   <a name="translate-ImportTerminology-request-Tags"></a>
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](https://docs.aws.amazon.com/translate/latest/dg/tagging.html) in the Amazon Translate Developer Guide.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

 ** [TerminologyData](#API_ImportTerminology_RequestSyntax) **   <a name="translate-ImportTerminology-request-TerminologyData"></a>
The terminology data for the custom terminology being imported.  
Type: [TerminologyData](API_TerminologyData.md) object  
Required: Yes

## Response Syntax
<a name="API_ImportTerminology_ResponseSyntax"></a>

```
{
   "AuxiliaryDataLocation": { 
      "Location": "string",
      "RepositoryType": "string"
   },
   "TerminologyProperties": { 
      "Arn": "string",
      "CreatedAt": number,
      "Description": "string",
      "Directionality": "string",
      "EncryptionKey": { 
         "Id": "string",
         "Type": "string"
      },
      "Format": "string",
      "LastUpdatedAt": number,
      "Message": "string",
      "Name": "string",
      "SizeBytes": number,
      "SkippedTermCount": number,
      "SourceLanguageCode": "string",
      "TargetLanguageCodes": [ "string" ],
      "TermCount": number
   }
}
```

## Response Elements
<a name="API_ImportTerminology_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AuxiliaryDataLocation](#API_ImportTerminology_ResponseSyntax) **   <a name="translate-ImportTerminology-response-AuxiliaryDataLocation"></a>
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.  
Type: [TerminologyDataLocation](API_TerminologyDataLocation.md) object

 ** [TerminologyProperties](#API_ImportTerminology_ResponseSyntax) **   <a name="translate-ImportTerminology-response-TerminologyProperties"></a>
The properties of the custom terminology being imported.  
Type: [TerminologyProperties](API_TerminologyProperties.md) object

## Errors
<a name="API_ImportTerminology_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
Another modification is being made. That modification must complete before you can make your change.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** 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.  
HTTP Status Code: 400

 ** LimitExceededException **   
The specified limit has been exceeded. Review your request and retry it with a quantity below the stated limit.  
HTTP Status Code: 400

 ** TooManyRequestsException **   
 You have made too many requests within a short period of time. Wait for a short time and then try your request again.  
HTTP Status Code: 400

 ** TooManyTagsException **   
You have added too many tags to this resource. The maximum is 50 tags.  
HTTP Status Code: 400

## See Also
<a name="API_ImportTerminology_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/ImportTerminology) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/ImportTerminology) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/ImportTerminology) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/ImportTerminology) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/ImportTerminology) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/ImportTerminology) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/ImportTerminology) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/ImportTerminology) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/ImportTerminology) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/ImportTerminology) 

# ListLanguages
<a name="API_ListLanguages"></a>

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

## Request Syntax
<a name="API_ListLanguages_RequestSyntax"></a>

```
{
   "DisplayLanguageCode": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListLanguages_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DisplayLanguageCode](#API_ListLanguages_RequestSyntax) **   <a name="translate-ListLanguages-request-DisplayLanguageCode"></a>
The language code for the language to use to display the language names in the response. The language code is `en` by default.   
Type: String  
Valid Values: `de | en | es | fr | it | ja | ko | pt | zh | zh-TW`   
Required: No

 ** [MaxResults](#API_ListLanguages_RequestSyntax) **   <a name="translate-ListLanguages-request-MaxResults"></a>
The maximum number of results to return in each response.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [NextToken](#API_ListLanguages_RequestSyntax) **   <a name="translate-ListLanguages-request-NextToken"></a>
Include the NextToken value to fetch the next group of supported languages.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_ListLanguages_ResponseSyntax"></a>

```
{
   "DisplayLanguageCode": "string",
   "Languages": [ 
      { 
         "LanguageCode": "string",
         "LanguageName": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListLanguages_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DisplayLanguageCode](#API_ListLanguages_ResponseSyntax) **   <a name="translate-ListLanguages-response-DisplayLanguageCode"></a>
The language code passed in with the request.  
Type: String  
Valid Values: `de | en | es | fr | it | ja | ko | pt | zh | zh-TW` 

 ** [Languages](#API_ListLanguages_ResponseSyntax) **   <a name="translate-ListLanguages-response-Languages"></a>
The list of supported languages.  
Type: Array of [Language](API_Language.md) objects

 ** [NextToken](#API_ListLanguages_ResponseSyntax) **   <a name="translate-ListLanguages-response-NextToken"></a>
 If the response does not include all remaining results, use the NextToken in the next request to fetch the next group of supported languages.  
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}` 

## Errors
<a name="API_ListLanguages_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** 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.  
HTTP Status Code: 400

 ** TooManyRequestsException **   
 You have made too many requests within a short period of time. Wait for a short time and then try your request again.  
HTTP Status Code: 400

 ** UnsupportedDisplayLanguageCodeException **   
Requested display language code is not supported.    
 ** DisplayLanguageCode **   
Language code passed in with the request.
HTTP Status Code: 400

## See Also
<a name="API_ListLanguages_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/ListLanguages) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/ListLanguages) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/ListLanguages) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/ListLanguages) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/ListLanguages) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/ListLanguages) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/ListLanguages) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/ListLanguages) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/ListLanguages) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/ListLanguages) 

# ListParallelData
<a name="API_ListParallelData"></a>

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

## Request Syntax
<a name="API_ListParallelData_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListParallelData_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListParallelData_RequestSyntax) **   <a name="translate-ListParallelData-request-MaxResults"></a>
The maximum number of parallel data resources returned for each request.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [NextToken](#API_ListParallelData_RequestSyntax) **   <a name="translate-ListParallelData-request-NextToken"></a>
A string that specifies the next page of results to return in a paginated response.  
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_ListParallelData_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "ParallelDataPropertiesList": [ 
      { 
         "Arn": "string",
         "CreatedAt": number,
         "Description": "string",
         "EncryptionKey": { 
            "Id": "string",
            "Type": "string"
         },
         "FailedRecordCount": number,
         "ImportedDataSize": number,
         "ImportedRecordCount": number,
         "LastUpdatedAt": number,
         "LatestUpdateAttemptAt": number,
         "LatestUpdateAttemptStatus": "string",
         "Message": "string",
         "Name": "string",
         "ParallelDataConfig": { 
            "Format": "string",
            "S3Uri": "string"
         },
         "SkippedRecordCount": number,
         "SourceLanguageCode": "string",
         "Status": "string",
         "TargetLanguageCodes": [ "string" ]
      }
   ]
}
```

## Response Elements
<a name="API_ListParallelData_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListParallelData_ResponseSyntax) **   <a name="translate-ListParallelData-response-NextToken"></a>
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.  
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}` 

 ** [ParallelDataPropertiesList](#API_ListParallelData_ResponseSyntax) **   <a name="translate-ListParallelData-response-ParallelDataPropertiesList"></a>
The properties of the parallel data resources returned by this request.  
Type: Array of [ParallelDataProperties](API_ParallelDataProperties.md) objects

## Errors
<a name="API_ListParallelData_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** 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.  
HTTP Status Code: 400

 ** TooManyRequestsException **   
 You have made too many requests within a short period of time. Wait for a short time and then try your request again.  
HTTP Status Code: 400

## See Also
<a name="API_ListParallelData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/ListParallelData) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/ListParallelData) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/ListParallelData) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/ListParallelData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/ListParallelData) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/ListParallelData) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/ListParallelData) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/ListParallelData) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/ListParallelData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/ListParallelData) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Lists all tags associated with a given Amazon Translate resource. For more information, see [ Tagging your resources](https://docs.aws.amazon.com/translate/latest/dg/tagging.html) in the Amazon Translate Developer Guide.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="translate-ListTagsForResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the given Amazon Translate resource you are querying.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: Yes

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="translate-ListTagsForResource-response-Tags"></a>
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.   
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** 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.  
HTTP Status Code: 400

 ** 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.  
HTTP Status Code: 400

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/ListTagsForResource) 

# ListTerminologies
<a name="API_ListTerminologies"></a>

Provides a list of custom terminologies associated with your account.

## Request Syntax
<a name="API_ListTerminologies_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListTerminologies_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListTerminologies_RequestSyntax) **   <a name="translate-ListTerminologies-request-MaxResults"></a>
The maximum number of custom terminologies returned per list request.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [NextToken](#API_ListTerminologies_RequestSyntax) **   <a name="translate-ListTerminologies-request-NextToken"></a>
If the result of the request to ListTerminologies was truncated, include the NextToken to fetch the next group of custom terminologies.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_ListTerminologies_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "TerminologyPropertiesList": [ 
      { 
         "Arn": "string",
         "CreatedAt": number,
         "Description": "string",
         "Directionality": "string",
         "EncryptionKey": { 
            "Id": "string",
            "Type": "string"
         },
         "Format": "string",
         "LastUpdatedAt": number,
         "Message": "string",
         "Name": "string",
         "SizeBytes": number,
         "SkippedTermCount": number,
         "SourceLanguageCode": "string",
         "TargetLanguageCodes": [ "string" ],
         "TermCount": number
      }
   ]
}
```

## Response Elements
<a name="API_ListTerminologies_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListTerminologies_ResponseSyntax) **   <a name="translate-ListTerminologies-response-NextToken"></a>
 If the response to the ListTerminologies was truncated, the NextToken fetches the next group of custom terminologies.  
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}` 

 ** [TerminologyPropertiesList](#API_ListTerminologies_ResponseSyntax) **   <a name="translate-ListTerminologies-response-TerminologyPropertiesList"></a>
The properties list of the custom terminologies returned on the list request.  
Type: Array of [TerminologyProperties](API_TerminologyProperties.md) objects

## Errors
<a name="API_ListTerminologies_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** 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.  
HTTP Status Code: 400

 ** TooManyRequestsException **   
 You have made too many requests within a short period of time. Wait for a short time and then try your request again.  
HTTP Status Code: 400

## See Also
<a name="API_ListTerminologies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/ListTerminologies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/ListTerminologies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/ListTerminologies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/ListTerminologies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/ListTerminologies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/ListTerminologies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/ListTerminologies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/ListTerminologies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/ListTerminologies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/ListTerminologies) 

# ListTextTranslationJobs
<a name="API_ListTextTranslationJobs"></a>

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

## Request Syntax
<a name="API_ListTextTranslationJobs_RequestSyntax"></a>

```
{
   "Filter": { 
      "JobName": "string",
      "JobStatus": "string",
      "SubmittedAfterTime": number,
      "SubmittedBeforeTime": number
   },
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListTextTranslationJobs_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filter](#API_ListTextTranslationJobs_RequestSyntax) **   <a name="translate-ListTextTranslationJobs-request-Filter"></a>
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.  
Type: [TextTranslationJobFilter](API_TextTranslationJobFilter.md) object  
Required: No

 ** [MaxResults](#API_ListTextTranslationJobs_RequestSyntax) **   <a name="translate-ListTextTranslationJobs-request-MaxResults"></a>
The maximum number of results to return in each page. The default value is 100.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [NextToken](#API_ListTextTranslationJobs_RequestSyntax) **   <a name="translate-ListTextTranslationJobs-request-NextToken"></a>
The token to request the next page of results.  
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_ListTextTranslationJobs_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "TextTranslationJobPropertiesList": [ 
      { 
         "DataAccessRoleArn": "string",
         "EndTime": number,
         "InputDataConfig": { 
            "ContentType": "string",
            "S3Uri": "string"
         },
         "JobDetails": { 
            "DocumentsWithErrorsCount": number,
            "InputDocumentsCount": number,
            "TranslatedDocumentsCount": number
         },
         "JobId": "string",
         "JobName": "string",
         "JobStatus": "string",
         "Message": "string",
         "OutputDataConfig": { 
            "EncryptionKey": { 
               "Id": "string",
               "Type": "string"
            },
            "S3Uri": "string"
         },
         "ParallelDataNames": [ "string" ],
         "Settings": { 
            "Brevity": "string",
            "Formality": "string",
            "Profanity": "string"
         },
         "SourceLanguageCode": "string",
         "SubmittedTime": number,
         "TargetLanguageCodes": [ "string" ],
         "TerminologyNames": [ "string" ]
      }
   ]
}
```

## Response Elements
<a name="API_ListTextTranslationJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListTextTranslationJobs_ResponseSyntax) **   <a name="translate-ListTextTranslationJobs-response-NextToken"></a>
The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.  
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}` 

 ** [TextTranslationJobPropertiesList](#API_ListTextTranslationJobs_ResponseSyntax) **   <a name="translate-ListTextTranslationJobs-response-TextTranslationJobPropertiesList"></a>
A list containing the properties of each job that is returned.  
Type: Array of [TextTranslationJobProperties](API_TextTranslationJobProperties.md) objects

## Errors
<a name="API_ListTextTranslationJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** InvalidFilterException **   
The filter specified for the operation is not valid. Specify a different filter.  
HTTP Status Code: 400

 ** InvalidRequestException **   
 The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.   
HTTP Status Code: 400

 ** TooManyRequestsException **   
 You have made too many requests within a short period of time. Wait for a short time and then try your request again.  
HTTP Status Code: 400

## See Also
<a name="API_ListTextTranslationJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/ListTextTranslationJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/ListTextTranslationJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/ListTextTranslationJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/ListTextTranslationJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/ListTextTranslationJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/ListTextTranslationJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/ListTextTranslationJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/ListTextTranslationJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/ListTextTranslationJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/ListTextTranslationJobs) 

# StartTextTranslationJob
<a name="API_StartTextTranslationJob"></a>

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](https://docs.aws.amazon.com/translate/latest/dg/async.html) in the Amazon Translate Developer Guide.

Batch translation jobs can be described with the [DescribeTextTranslationJob](API_DescribeTextTranslationJob.md) operation, listed with the [ListTextTranslationJobs](API_ListTextTranslationJobs.md) operation, and stopped with the [StopTextTranslationJob](API_StopTextTranslationJob.md) operation.

## Request Syntax
<a name="API_StartTextTranslationJob_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "DataAccessRoleArn": "string",
   "InputDataConfig": { 
      "ContentType": "string",
      "S3Uri": "string"
   },
   "JobName": "string",
   "OutputDataConfig": { 
      "EncryptionKey": { 
         "Id": "string",
         "Type": "string"
      },
      "S3Uri": "string"
   },
   "ParallelDataNames": [ "string" ],
   "Settings": { 
      "Brevity": "string",
      "Formality": "string",
      "Profanity": "string"
   },
   "SourceLanguageCode": "string",
   "TargetLanguageCodes": [ "string" ],
   "TerminologyNames": [ "string" ]
}
```

## Request Parameters
<a name="API_StartTextTranslationJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_StartTextTranslationJob_RequestSyntax) **   <a name="translate-StartTextTranslationJob-request-ClientToken"></a>
A unique identifier for the request. This token is generated for you when using the Amazon Translate SDK.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: Yes

 ** [DataAccessRoleArn](#API_StartTextTranslationJob_RequestSyntax) **   <a name="translate-StartTextTranslationJob-request-DataAccessRoleArn"></a>
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 [Prerequisite permissions](https://docs.aws.amazon.com/translate/latest/dg/async-prereqs.html#async-prereqs-permissions) in the Amazon Translate Developer Guide.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+`   
Required: Yes

 ** [InputDataConfig](#API_StartTextTranslationJob_RequestSyntax) **   <a name="translate-StartTextTranslationJob-request-InputDataConfig"></a>
Specifies the format and location of the input documents for the translation job.  
Type: [InputDataConfig](API_InputDataConfig.md) object  
Required: Yes

 ** [JobName](#API_StartTextTranslationJob_RequestSyntax) **   <a name="translate-StartTextTranslationJob-request-JobName"></a>
The name of the batch translation job to be performed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$`   
Required: No

 ** [OutputDataConfig](#API_StartTextTranslationJob_RequestSyntax) **   <a name="translate-StartTextTranslationJob-request-OutputDataConfig"></a>
Specifies the S3 folder to which your job output will be saved.   
Type: [OutputDataConfig](API_OutputDataConfig.md) object  
Required: Yes

 ** [ParallelDataNames](#API_StartTextTranslationJob_RequestSyntax) **   <a name="translate-StartTextTranslationJob-request-ParallelDataNames"></a>
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](http://aws.amazon.com/translate/pricing/).
For a list of available parallel data resources, use the [ListParallelData](API_ListParallelData.md) operation.  
For more information, see [ Customizing your translations with parallel data](https://docs.aws.amazon.com/translate/latest/dg/customizing-translations-parallel-data.html) in the Amazon Translate Developer Guide.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([A-Za-z0-9-]_?)+$`   
Required: No

 ** [Settings](#API_StartTextTranslationJob_RequestSyntax) **   <a name="translate-StartTextTranslationJob-request-Settings"></a>
Settings to configure your translation output. You can configure the following options:  
+ Brevity: not supported.
+ Formality: sets the formality level of the output text.
+ Profanity: masks profane words and phrases in your translation output.
Type: [TranslationSettings](API_TranslationSettings.md) object  
Required: No

 ** [SourceLanguageCode](#API_StartTextTranslationJob_RequestSyntax) **   <a name="translate-StartTextTranslationJob-request-SourceLanguageCode"></a>
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](https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html) in the Amazon Translate Developer Guide.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.  
Required: Yes

 ** [TargetLanguageCodes](#API_StartTextTranslationJob_RequestSyntax) **   <a name="translate-StartTextTranslationJob-request-TargetLanguageCodes"></a>
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](https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html) in the Amazon Translate Developer Guide.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 2. Maximum length of 5.  
Required: Yes

 ** [TerminologyNames](#API_StartTextTranslationJob_RequestSyntax) **   <a name="translate-StartTextTranslationJob-request-TerminologyNames"></a>
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](API_ListTerminologies.md) operation.  
For more information, see [Custom terminology](https://docs.aws.amazon.com/translate/latest/dg/how-custom-terminology.html) in the Amazon Translate Developer Guide.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([A-Za-z0-9-]_?)+$`   
Required: No

## Response Syntax
<a name="API_StartTextTranslationJob_ResponseSyntax"></a>

```
{
   "JobId": "string",
   "JobStatus": "string"
}
```

## Response Elements
<a name="API_StartTextTranslationJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [JobId](#API_StartTextTranslationJob_ResponseSyntax) **   <a name="translate-StartTextTranslationJob-response-JobId"></a>
The identifier generated for the job. To get the status of a job, use this ID with the [DescribeTextTranslationJob](API_DescribeTextTranslationJob.md) operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` 

 ** [JobStatus](#API_StartTextTranslationJob_ResponseSyntax) **   <a name="translate-StartTextTranslationJob-response-JobStatus"></a>
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](API_DescribeTextTranslationJob.md) operation.
+  `STOP_REQUESTED` - The user who started the job has requested that it be stopped.
+  `STOPPED` - The job has been stopped.
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERROR | FAILED | STOP_REQUESTED | STOPPED` 

## Errors
<a name="API_StartTextTranslationJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** 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.  
HTTP Status Code: 400

 ** InvalidRequestException **   
 The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.   
HTTP Status Code: 400

 ** 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.  
HTTP Status Code: 400

 ** TooManyRequestsException **   
 You have made too many requests within a short period of time. Wait for a short time and then try your request again.  
HTTP Status Code: 400

 ** 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](https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html) in the Amazon Translate Developer Guide.    
 ** SourceLanguageCode **   
The language code for the language of the input text.   
 ** TargetLanguageCode **   
The language code for the language of the translated text. 
HTTP Status Code: 400

## See Also
<a name="API_StartTextTranslationJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/StartTextTranslationJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/StartTextTranslationJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/StartTextTranslationJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/StartTextTranslationJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/StartTextTranslationJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/StartTextTranslationJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/StartTextTranslationJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/StartTextTranslationJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/StartTextTranslationJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/StartTextTranslationJob) 

# StopTextTranslationJob
<a name="API_StopTextTranslationJob"></a>

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](API_StartTextTranslationJob.md) operation. You can use the [DescribeTextTranslationJob](API_DescribeTextTranslationJob.md) or [ListTextTranslationJobs](API_ListTextTranslationJobs.md) operations to get a batch translation job's `JobId`.

## Request Syntax
<a name="API_StopTextTranslationJob_RequestSyntax"></a>

```
{
   "JobId": "string"
}
```

## Request Parameters
<a name="API_StopTextTranslationJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [JobId](#API_StopTextTranslationJob_RequestSyntax) **   <a name="translate-StopTextTranslationJob-request-JobId"></a>
The job ID of the job to be stopped.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$`   
Required: Yes

## Response Syntax
<a name="API_StopTextTranslationJob_ResponseSyntax"></a>

```
{
   "JobId": "string",
   "JobStatus": "string"
}
```

## Response Elements
<a name="API_StopTextTranslationJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [JobId](#API_StopTextTranslationJob_ResponseSyntax) **   <a name="translate-StopTextTranslationJob-response-JobId"></a>
The job ID of the stopped batch translation job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$` 

 ** [JobStatus](#API_StopTextTranslationJob_ResponseSyntax) **   <a name="translate-StopTextTranslationJob-response-JobStatus"></a>
The status of the designated job. Upon successful completion, the job's status will be `STOPPED`.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERROR | FAILED | STOP_REQUESTED | STOPPED` 

## Errors
<a name="API_StopTextTranslationJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** 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.  
HTTP Status Code: 400

 ** TooManyRequestsException **   
 You have made too many requests within a short period of time. Wait for a short time and then try your request again.  
HTTP Status Code: 400

## See Also
<a name="API_StopTextTranslationJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/StopTextTranslationJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/StopTextTranslationJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/StopTextTranslationJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/StopTextTranslationJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/StopTextTranslationJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/StopTextTranslationJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/StopTextTranslationJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/StopTextTranslationJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/StopTextTranslationJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/StopTextTranslationJob) 

# TagResource
<a name="API_TagResource"></a>

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](https://docs.aws.amazon.com/translate/latest/dg/tagging.html) in the Amazon Translate Developer Guide.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_TagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_TagResource_RequestSyntax) **   <a name="translate-TagResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the given Amazon Translate resource to which you want to associate the tags.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: Yes

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="translate-TagResource-request-Tags"></a>
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.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: Yes

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
Another modification is being made. That modification must complete before you can make your change.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** 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.  
HTTP Status Code: 400

 ** 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.  
HTTP Status Code: 400

 ** TooManyTagsException **   
You have added too many tags to this resource. The maximum is 50 tags.  
HTTP Status Code: 400

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/TagResource) 

# TranslateDocument
<a name="API_TranslateDocument"></a>

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](https://docs.aws.amazon.com/translate/latest/dg/customizing-translations-formality.html) in the Amazon Translate Developer Guide.

## Request Syntax
<a name="API_TranslateDocument_RequestSyntax"></a>

```
{
   "Document": { 
      "Content": blob,
      "ContentType": "string"
   },
   "Settings": { 
      "Brevity": "string",
      "Formality": "string",
      "Profanity": "string"
   },
   "SourceLanguageCode": "string",
   "TargetLanguageCode": "string",
   "TerminologyNames": [ "string" ]
}
```

## Request Parameters
<a name="API_TranslateDocument_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Document](#API_TranslateDocument_RequestSyntax) **   <a name="translate-TranslateDocument-request-Document"></a>
The content and content type for the document to be translated. The document size must not exceed 100 KB.  
Type: [Document](API_Document.md) object  
Required: Yes

 ** [Settings](#API_TranslateDocument_RequestSyntax) **   <a name="translate-TranslateDocument-request-Settings"></a>
Settings to configure your translation output. You can configure the following options:  
+ Brevity: not supported.
+ Formality: sets the formality level of the output text.
+ Profanity: masks profane words and phrases in your translation output.
Type: [TranslationSettings](API_TranslationSettings.md) object  
Required: No

 ** [SourceLanguageCode](#API_TranslateDocument_RequestSyntax) **   <a name="translate-TranslateDocument-request-SourceLanguageCode"></a>
The language code for the language of the source text. For a list of supported language codes, see [Supported languages](https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html) in the Amazon Translate Developer Guide.  
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](https://docs.aws.amazon.com/comprehend/latest/dg/comprehend-general.html) to determine the source language.  
If you specify `auto`, you must send the `TranslateDocument` request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported. 
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.  
Required: Yes

 ** [TargetLanguageCode](#API_TranslateDocument_RequestSyntax) **   <a name="translate-TranslateDocument-request-TargetLanguageCode"></a>
The language code requested for the translated document. For a list of supported language codes, see [Supported languages](https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html).  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.  
Required: Yes

 ** [TerminologyNames](#API_TranslateDocument_RequestSyntax) **   <a name="translate-TranslateDocument-request-TerminologyNames"></a>
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](API_ListTerminologies.md) operation to get the available terminology lists.  
For more information about custom terminology lists, see [Custom terminology](https://docs.aws.amazon.com/translate/latest/dg/how-custom-terminology.html) in the Amazon Translate Developer Guide.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([A-Za-z0-9-]_?)+$`   
Required: No

## Response Syntax
<a name="API_TranslateDocument_ResponseSyntax"></a>

```
{
   "AppliedSettings": { 
      "Brevity": "string",
      "Formality": "string",
      "Profanity": "string"
   },
   "AppliedTerminologies": [ 
      { 
         "Name": "string",
         "Terms": [ 
            { 
               "SourceText": "string",
               "TargetText": "string"
            }
         ]
      }
   ],
   "SourceLanguageCode": "string",
   "TargetLanguageCode": "string",
   "TranslatedDocument": { 
      "Content": blob
   }
}
```

## Response Elements
<a name="API_TranslateDocument_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AppliedSettings](#API_TranslateDocument_ResponseSyntax) **   <a name="translate-TranslateDocument-response-AppliedSettings"></a>
Settings to configure your translation output. You can configure the following options:  
+ Brevity: reduces the length of the translation output for most translations. Available for `TranslateText` only.
+ Formality: sets the formality level of the translation output.
+ Profanity: masks profane words and phrases in the translation output.
Type: [TranslationSettings](API_TranslationSettings.md) object

 ** [AppliedTerminologies](#API_TranslateDocument_ResponseSyntax) **   <a name="translate-TranslateDocument-response-AppliedTerminologies"></a>
The names of the custom terminologies applied to the input text by Amazon Translate to produce the translated text document.  
Type: Array of [AppliedTerminology](API_AppliedTerminology.md) objects

 ** [SourceLanguageCode](#API_TranslateDocument_ResponseSyntax) **   <a name="translate-TranslateDocument-response-SourceLanguageCode"></a>
The language code of the source document.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.

 ** [TargetLanguageCode](#API_TranslateDocument_ResponseSyntax) **   <a name="translate-TranslateDocument-response-TargetLanguageCode"></a>
The language code of the translated document.   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.

 ** [TranslatedDocument](#API_TranslateDocument_ResponseSyntax) **   <a name="translate-TranslateDocument-response-TranslatedDocument"></a>
The document containing the translated content. The document format matches the source document format.  
Type: [TranslatedDocument](API_TranslatedDocument.md) object

## Errors
<a name="API_TranslateDocument_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** InvalidRequestException **   
 The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.   
HTTP Status Code: 400

 ** LimitExceededException **   
The specified limit has been exceeded. Review your request and retry it with a quantity below the stated limit.  
HTTP Status Code: 400

 ** 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.  
HTTP Status Code: 400

 ** ServiceUnavailableException **   
The Amazon Translate service is temporarily unavailable. Wait a bit and then retry your request.  
HTTP Status Code: 500

 ** TooManyRequestsException **   
 You have made too many requests within a short period of time. Wait for a short time and then try your request again.  
HTTP Status Code: 400

 ** 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](https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html) in the Amazon Translate Developer Guide.    
 ** SourceLanguageCode **   
The language code for the language of the input text.   
 ** TargetLanguageCode **   
The language code for the language of the translated text. 
HTTP Status Code: 400

## See Also
<a name="API_TranslateDocument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/TranslateDocument) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/TranslateDocument) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/TranslateDocument) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/TranslateDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/TranslateDocument) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/TranslateDocument) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/TranslateDocument) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/TranslateDocument) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/TranslateDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/TranslateDocument) 

# TranslateText
<a name="API_TranslateText"></a>

Translates input text from the source language to the target language. For a list of available languages and language codes, see [Supported languages](https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html) in the Amazon Translate Developer Guide.

## Request Syntax
<a name="API_TranslateText_RequestSyntax"></a>

```
{
   "Settings": { 
      "Brevity": "string",
      "Formality": "string",
      "Profanity": "string"
   },
   "SourceLanguageCode": "string",
   "TargetLanguageCode": "string",
   "TerminologyNames": [ "string" ],
   "Text": "string"
}
```

## Request Parameters
<a name="API_TranslateText_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Settings](#API_TranslateText_RequestSyntax) **   <a name="translate-TranslateText-request-Settings"></a>
Settings to configure your translation output. You can configure the following options:  
+ Brevity: reduces the length of the translated output for most translations.
+ Formality: sets the formality level of the output text.
+ Profanity: masks profane words and phrases in your translation output.
Type: [TranslationSettings](API_TranslationSettings.md) object  
Required: No

 ** [SourceLanguageCode](#API_TranslateText_RequestSyntax) **   <a name="translate-TranslateText-request-SourceLanguageCode"></a>
The language code for the language of the source text. For a list of language codes, see [Supported languages](https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html) in the Amazon Translate Developer Guide.  
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](https://docs.aws.amazon.com/comprehend/latest/dg/comprehend-general.html) 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. 
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.  
Required: Yes

 ** [TargetLanguageCode](#API_TranslateText_RequestSyntax) **   <a name="translate-TranslateText-request-TargetLanguageCode"></a>
The language code requested for the language of the target text. For a list of language codes, see [Supported languages](https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html) in the Amazon Translate Developer Guide.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.  
Required: Yes

 ** [TerminologyNames](#API_TranslateText_RequestSyntax) **   <a name="translate-TranslateText-request-TerminologyNames"></a>
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](API_ListTerminologies.md) operation to get the available terminology lists.  
For more information about custom terminology lists, see [Custom terminology](https://docs.aws.amazon.com/translate/latest/dg/how-custom-terminology.html) in the Amazon Translate Developer Guide.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([A-Za-z0-9-]_?)+$`   
Required: No

 ** [Text](#API_TranslateText_RequestSyntax) **   <a name="translate-TranslateText-request-Text"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10000.  
Pattern: `[\P{M}\p{M}]{1,10000}`   
Required: Yes

## Response Syntax
<a name="API_TranslateText_ResponseSyntax"></a>

```
{
   "AppliedSettings": { 
      "Brevity": "string",
      "Formality": "string",
      "Profanity": "string"
   },
   "AppliedTerminologies": [ 
      { 
         "Name": "string",
         "Terms": [ 
            { 
               "SourceText": "string",
               "TargetText": "string"
            }
         ]
      }
   ],
   "SourceLanguageCode": "string",
   "TargetLanguageCode": "string",
   "TranslatedText": "string"
}
```

## Response Elements
<a name="API_TranslateText_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AppliedSettings](#API_TranslateText_ResponseSyntax) **   <a name="translate-TranslateText-response-AppliedSettings"></a>
Optional settings that modify the translation output.  
Type: [TranslationSettings](API_TranslationSettings.md) object

 ** [AppliedTerminologies](#API_TranslateText_ResponseSyntax) **   <a name="translate-TranslateText-response-AppliedTerminologies"></a>
The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.  
Type: Array of [AppliedTerminology](API_AppliedTerminology.md) objects

 ** [SourceLanguageCode](#API_TranslateText_ResponseSyntax) **   <a name="translate-TranslateText-response-SourceLanguageCode"></a>
The language code for the language of the source text.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.

 ** [TargetLanguageCode](#API_TranslateText_ResponseSyntax) **   <a name="translate-TranslateText-response-TargetLanguageCode"></a>
The language code for the language of the target text.   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.

 ** [TranslatedText](#API_TranslateText_ResponseSyntax) **   <a name="translate-TranslateText-response-TranslatedText"></a>
The translated text.  
Type: String  
Length Constraints: Maximum length of 20000.  
Pattern: `[\P{M}\p{M}]{0,20000}` 

## Errors
<a name="API_TranslateText_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://docs.aws.amazon.com/comprehend/latest/dg/API_DetectDominantLanguage.html) operation in the *Amazon Comprehend Developer Guide*.     
 ** DetectedLanguageCode **   
The language code of the auto-detected language from Amazon Comprehend.
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** InvalidRequestException **   
 The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.   
HTTP Status Code: 400

 ** 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.  
HTTP Status Code: 400

 ** ServiceUnavailableException **   
The Amazon Translate service is temporarily unavailable. Wait a bit and then retry your request.  
HTTP Status Code: 500

 ** 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.   
HTTP Status Code: 400

 ** TooManyRequestsException **   
 You have made too many requests within a short period of time. Wait for a short time and then try your request again.  
HTTP Status Code: 400

 ** 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](https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html) in the Amazon Translate Developer Guide.    
 ** SourceLanguageCode **   
The language code for the language of the input text.   
 ** TargetLanguageCode **   
The language code for the language of the translated text. 
HTTP Status Code: 400

## See Also
<a name="API_TranslateText_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/TranslateText) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/TranslateText) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/TranslateText) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/TranslateText) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/TranslateText) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/TranslateText) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/TranslateText) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/TranslateText) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/TranslateText) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/TranslateText) 

# UntagResource
<a name="API_UntagResource"></a>

Removes a specific tag associated with an Amazon Translate resource. For more information, see [ Tagging your resources](https://docs.aws.amazon.com/translate/latest/dg/tagging.html) in the Amazon Translate Developer Guide.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_UntagResource_RequestSyntax) **   <a name="translate-UntagResource-request-ResourceArn"></a>
 The Amazon Resource Name (ARN) of the given Amazon Translate resource from which you want to remove the tags.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: Yes

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="translate-UntagResource-request-TagKeys"></a>
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.   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
Another modification is being made. That modification must complete before you can make your change.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** 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.  
HTTP Status Code: 400

 ** 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.  
HTTP Status Code: 400

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/UntagResource) 

# UpdateParallelData
<a name="API_UpdateParallelData"></a>

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

## Request Syntax
<a name="API_UpdateParallelData_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "Description": "string",
   "Name": "string",
   "ParallelDataConfig": { 
      "Format": "string",
      "S3Uri": "string"
   }
}
```

## Request Parameters
<a name="API_UpdateParallelData_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_UpdateParallelData_RequestSyntax) **   <a name="translate-UpdateParallelData-request-ClientToken"></a>
A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: Yes

 ** [Description](#API_UpdateParallelData_RequestSyntax) **   <a name="translate-UpdateParallelData-request-Description"></a>
A custom description for the parallel data resource in Amazon Translate.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `[\P{M}\p{M}]{0,256}`   
Required: No

 ** [Name](#API_UpdateParallelData_RequestSyntax) **   <a name="translate-UpdateParallelData-request-Name"></a>
The name of the parallel data resource being updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([A-Za-z0-9-]_?)+$`   
Required: Yes

 ** [ParallelDataConfig](#API_UpdateParallelData_RequestSyntax) **   <a name="translate-UpdateParallelData-request-ParallelDataConfig"></a>
Specifies the format and S3 location of the parallel data input file.  
Type: [ParallelDataConfig](API_ParallelDataConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_UpdateParallelData_ResponseSyntax"></a>

```
{
   "LatestUpdateAttemptAt": number,
   "LatestUpdateAttemptStatus": "string",
   "Name": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_UpdateParallelData_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LatestUpdateAttemptAt](#API_UpdateParallelData_ResponseSyntax) **   <a name="translate-UpdateParallelData-response-LatestUpdateAttemptAt"></a>
The time that the most recent update was attempted.  
Type: Timestamp

 ** [LatestUpdateAttemptStatus](#API_UpdateParallelData_ResponseSyntax) **   <a name="translate-UpdateParallelData-response-LatestUpdateAttemptStatus"></a>
The status of the parallel data update attempt. When the updated parallel data resource is ready for you to use, the status is `ACTIVE`.  
Type: String  
Valid Values: `CREATING | UPDATING | ACTIVE | DELETING | FAILED` 

 ** [Name](#API_UpdateParallelData_ResponseSyntax) **   <a name="translate-UpdateParallelData-response-Name"></a>
The name of the parallel data resource being updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([A-Za-z0-9-]_?)+$` 

 ** [Status](#API_UpdateParallelData_ResponseSyntax) **   <a name="translate-UpdateParallelData-response-Status"></a>
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`.  
Type: String  
Valid Values: `CREATING | UPDATING | ACTIVE | DELETING | FAILED` 

## Errors
<a name="API_UpdateParallelData_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
Another modification is being made. That modification must complete before you can make your change.  
HTTP Status Code: 400

 ** ConflictException **   
There was a conflict processing the request. Try your request again.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** 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.  
HTTP Status Code: 400

 ** InvalidRequestException **   
 The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.   
HTTP Status Code: 400

 ** LimitExceededException **   
The specified limit has been exceeded. Review your request and retry it with a quantity below the stated limit.  
HTTP Status Code: 400

 ** 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.  
HTTP Status Code: 400

 ** TooManyRequestsException **   
 You have made too many requests within a short period of time. Wait for a short time and then try your request again.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateParallelData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/translate-2017-07-01/UpdateParallelData) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/translate-2017-07-01/UpdateParallelData) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/translate-2017-07-01/UpdateParallelData) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/translate-2017-07-01/UpdateParallelData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/translate-2017-07-01/UpdateParallelData) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/translate-2017-07-01/UpdateParallelData) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/translate-2017-07-01/UpdateParallelData) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/translate-2017-07-01/UpdateParallelData) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/translate-2017-07-01/UpdateParallelData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/translate-2017-07-01/UpdateParallelData)