AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Translate StartTextTranslationJob API operation.

Syntax

Start-TRNTextTranslationJob
-Settings_Brevity <Brevity>
-InputDataConfig_ContentType <String>
-DataAccessRoleArn <String>
-Settings_Formality <Formality>
-EncryptionKey_Id <String>
-JobName <String>
-ParallelDataName <String[]>
-Settings_Profanity <Profanity>
-InputDataConfig_S3Uri <String>
-OutputDataConfig_S3Uri <String>
-SourceLanguageCode <String>
-TargetLanguageCode <String[]>
-TerminologyName <String[]>
-EncryptionKey_Type <EncryptionKeyType>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonTranslateConfig>

Description

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

Parameters

-ClientConfig <AmazonTranslateConfig>
Amazon.PowerShell.Cmdlets.TRN.AmazonTranslateClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique identifier for the request. This token is generated for you when using the Amazon Translate SDK.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataAccessRoleArn <String>
The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more information, see Identity and access management .
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionKey_Id <String>
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOutputDataConfig_EncryptionKey_Id
-EncryptionKey_Type <EncryptionKeyType>
The type of encryption key used by Amazon Translate to encrypt this object.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOutputDataConfig_EncryptionKey_Type
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputDataConfig_ContentType <String>
Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types:
  • text/html: The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in the html element in each file.
  • text/plain: The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document: The input data consists of one or more Word documents (.docx).
  • application/vnd.openxmlformats-officedocument.presentationml.presentation: The input data consists of one or more PowerPoint Presentation files (.pptx).
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input data consists of one or more Excel Workbook files (.xlsx).
  • application/x-xliff+xml: The input data consists of one or more XML Localization Interchange File Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.
If you structure your input data as HTML, ensure that you set this parameter to text/html. By doing so, you cut costs by limiting the translation to the contents of the html element in each file. Otherwise, if you set this parameter to text/plain, your costs will cover the translation of every character.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputDataConfig_S3Uri <String>
The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in the folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are calling.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobName <String>
The name of the batch translation job to be performed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputDataConfig_S3Uri <String>
The URI of the S3 folder that contains a translation job's output file. The folder must be in the same Region as the API endpoint that you are calling.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ParallelDataName <String[]>
The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. If you specify multiple target languages for the job, the parallel data file must include translations for all the target languages.When you add parallel data to a translation job, you create an Active Custom Translation job. This parameter accepts only one parallel data resource.Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.For a list of available parallel data resources, use the ListParallelData operation.For more information, see Customizing your translations with parallel data. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParallelDataNames
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Translate.Model.StartTextTranslationJobResponse). Specifying the name of a property of type Amazon.Translate.Model.StartTextTranslationJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_Brevity <Brevity>
When you turn on brevity, Amazon Translate reduces the length of the translation output for most translations (when compared with the same translation with brevity turned off). By default, brevity is turned off.If you turn on brevity for a translation request with an unsupported language pair, the translation proceeds with the brevity setting turned off.For the language pairs that brevity supports, see Using brevity in the Amazon Translate Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_Formality <Formality>
You can specify the desired level of formality for translations to supported target languages. The formality setting controls the level of formal language usage (also known as register) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting. If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported target language.For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_Profanity <Profanity>
You can enable the profanity setting if you want to mask profane words and phrases in your translation output.To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.Amazon Translate doesn't detect profanity in all of its supported languages. For languages that don't support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.If you specify multiple target languages for the job, all the target languages must support profanity masking. If any of the target languages don't support profanity masking, the translation job won't mask profanity for any target language.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceLanguageCode <String>
The language code of the input language. Specify the language if all input documents share the same language. If you don't know the language of the source files, or your input documents contains different source languages, select auto. Amazon Translate auto detects the source language for each input document. For a list of supported language codes, see Supported languages.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-TargetLanguageCode <String[]>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetLanguageCodes
-TerminologyName <String[]>
The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.This parameter accepts only one custom terminology resource.If you specify multiple target languages for the job, translate uses the designated terminology for each requested target language that has an entry for the source term in the terminology file.For a list of available custom terminology resources, use the ListTerminologies operation.For more information, see Custom terminology. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTerminologyNames

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Translate.Model.StartTextTranslationJobResponse
This cmdlet returns an Amazon.Translate.Model.StartTextTranslationJobResponse object containing multiple properties.
Developer Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z