AWS.Tools.Translate.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Translate</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.TRN.ConvertToTRNTargetLanguageCmdlet"> <summary> Translates input text from the source language to the target language. It is not necessary to use English (en) as either the source or the target language but not all language combinations are supported by Amazon Translate. For more information, see <a href="http://docs.aws.amazon.com/translate/latest/dg/pairs.html">Supported Language Pairs</a>. <ul><li><para> Arabic (ar) </para></li><li><para> Chinese (Simplified) (zh) </para></li><li><para> Chinese (Traditional) (zh-TW) </para></li><li><para> Czech (cs) </para></li><li><para> Danish (da) </para></li><li><para> Dutch (nl) </para></li><li><para> English (en) </para></li><li><para> Finnish (fi) </para></li><li><para> French (fr) </para></li><li><para> German (de) </para></li><li><para> Hebrew (he) </para></li><li><para> Indonesian (id) </para></li><li><para> Italian (it) </para></li><li><para> Japanese (ja) </para></li><li><para> Korean (ko) </para></li><li><para> Polish (pl) </para></li><li><para> Portuguese (pt) </para></li><li><para> Russian (ru) </para></li><li><para> Spanish (es) </para></li><li><para> Swedish (sv) </para></li><li><para> Turkish (tr) </para></li></ul><para> To have Amazon Translate determine the source language of your text, you can specify <code>auto</code> in the <code>SourceLanguageCode</code> field. If you specify <code>auto</code>, Amazon Translate will call Amazon Comprehend to determine the source language. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ConvertToTRNTargetLanguageCmdlet.SourceLanguageCode"> <summary> <para> <para>The language code for the language of the source text. The language must be a language supported by Amazon Translate. </para><para>To have Amazon Translate determine the source language of your text, you can specify <code>auto</code> in the <code>SourceLanguageCode</code> field. If you specify <code>auto</code>, Amazon Translate will call Amazon Comprehend to determine the source language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ConvertToTRNTargetLanguageCmdlet.TargetLanguageCode"> <summary> <para> <para>The language code requested for the language of the target text. The language must be a language supported by Amazon Translate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ConvertToTRNTargetLanguageCmdlet.TerminologyName"> <summary> <para> <para>The TerminologyNames list that is taken as input to the TranslateText request. This has a minimum length of 0 and a maximum length of 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ConvertToTRNTargetLanguageCmdlet.Text"> <summary> <para> <para>The text to translate. The text string can be a maximum of 5,000 bytes long. Depending on your character set, this may be fewer than 5,000 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ConvertToTRNTargetLanguageCmdlet.Select"> <summary> 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.TranslateTextResponse). Specifying the name of a property of type Amazon.Translate.Model.TranslateTextResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ConvertToTRNTargetLanguageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Text parameter. The -PassThru parameter is deprecated, use -Select '^Text' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ConvertToTRNTargetLanguageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRN.GetTRNTerminologyCmdlet"> <summary> Retrieves a custom terminology. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.GetTRNTerminologyCmdlet.Name"> <summary> <para> <para>The name of the custom terminology being retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.GetTRNTerminologyCmdlet.TerminologyDataFormat"> <summary> <para> <para>The data format of the custom terminology being retrieved, either CSV or TMX.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.GetTRNTerminologyCmdlet.Select"> <summary> 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.GetTerminologyResponse). Specifying the name of a property of type Amazon.Translate.Model.GetTerminologyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.GetTRNTerminologyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRN.GetTRNTerminologyListCmdlet"> <summary> Provides a list of custom terminologies associated with your account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.GetTRNTerminologyListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of custom terminologies returned per list request.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>500</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.GetTRNTerminologyListCmdlet.NextToken"> <summary> <para> <para>If the result of the request to ListTerminologies was truncated, include the NextToken to fetch the next group of custom terminologies. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.GetTRNTerminologyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TerminologyPropertiesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Translate.Model.ListTerminologiesResponse). Specifying the name of a property of type Amazon.Translate.Model.ListTerminologiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.GetTRNTerminologyListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRN.ImportTRNTerminologyCmdlet"> <summary> Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name. Importing a terminology with the same name as an existing one will merge the terminologies based on the chosen merge strategy. Currently, the only supported merge strategy is OVERWRITE, and so the imported terminology will overwrite an existing terminology of the same name. <para> If you import a terminology that overwrites an existing one, the new terminology take up to 10 minutes to fully propagate and be available for use in a translation due to cache policies with the DataPlane service that performs the translations. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ImportTRNTerminologyCmdlet.Description"> <summary> <para> <para>The description of the custom terminology being imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ImportTRNTerminologyCmdlet.TerminologyData_File"> <summary> <para> <para>The file containing the custom terminology data.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ImportTRNTerminologyCmdlet.TerminologyData_Format"> <summary> <para> <para>The data format of the custom terminology. Either CSV or TMX.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ImportTRNTerminologyCmdlet.EncryptionKey_Id"> <summary> <para> <para>The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ImportTRNTerminologyCmdlet.MergeStrategy"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ImportTRNTerminologyCmdlet.Name"> <summary> <para> <para>The name of the custom terminology being imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ImportTRNTerminologyCmdlet.EncryptionKey_Type"> <summary> <para> <para>The type of encryption key used by Amazon Translate to encrypt custom terminologies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ImportTRNTerminologyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TerminologyProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Translate.Model.ImportTerminologyResponse). Specifying the name of a property of type Amazon.Translate.Model.ImportTerminologyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ImportTRNTerminologyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.ImportTRNTerminologyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TRN.RemoveTRNTerminologyCmdlet"> <summary> A synchronous action that deletes a custom terminology. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.RemoveTRNTerminologyCmdlet.Name"> <summary> <para> <para>The name of the custom terminology being deleted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.RemoveTRNTerminologyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Translate.Model.DeleteTerminologyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.RemoveTRNTerminologyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TRN.RemoveTRNTerminologyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |