@aws-sdk/client-translate 3.296.0 → 3.298.0

package/dist-types/commands/ListTextTranslationJobsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListTextTranslationJobsRequest, ListTextTranslationJobsResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TranslateClientResolvedConfig } from "../TranslateClient";
 /**
+ * @public
+ *
  * The input for {@link ListTextTranslationJobsCommand}.
  */
 export interface ListTextTranslationJobsCommandInput extends ListTextTranslationJobsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListTextTranslationJobsCommand}.
  */
 export interface ListTextTranslationJobsCommandOutput extends ListTextTranslationJobsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Gets a list of the batch translation jobs that you have submitted.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTextTranslationJobsCommandOutput extends ListTextTranslatio
  * const response = await client.send(command);
  * ```
  *
+ * @param ListTextTranslationJobsCommandInput - {@link ListTextTranslationJobsCommandInput}
+ * @returns {@link ListTextTranslationJobsCommandOutput}
  * @see {@link ListTextTranslationJobsCommandInput} for command's `input` shape.
  * @see {@link ListTextTranslationJobsCommandOutput} for command's `response` shape.
  * @see {@link TranslateClientResolvedConfig | config} for TranslateClient's `config` shape.
@@ -48,11 +55,20 @@ export interface ListTextTranslationJobsCommandOutput extends ListTextTranslatio
 export declare class ListTextTranslationJobsCommand extends $Command<ListTextTranslationJobsCommandInput, ListTextTranslationJobsCommandOutput, TranslateClientResolvedConfig> {
     readonly input: ListTextTranslationJobsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListTextTranslationJobsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TranslateClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTextTranslationJobsCommandInput, ListTextTranslationJobsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/StartTextTranslationJobCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StartTextTranslationJobRequest, StartTextTranslationJobResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TranslateClientResolvedConfig } from "../TranslateClient";
 /**
+ * @public
+ *
  * The input for {@link StartTextTranslationJobCommand}.
  */
 export interface StartTextTranslationJobCommandInput extends StartTextTranslationJobRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StartTextTranslationJobCommand}.
  */
 export interface StartTextTranslationJobCommandOutput extends StartTextTranslationJobResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>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 <code>auto</code>
@@ -33,6 +38,8 @@ export interface StartTextTranslationJobCommandOutput extends StartTextTranslati
  * const response = await client.send(command);
  * ```
  *
+ * @param StartTextTranslationJobCommandInput - {@link StartTextTranslationJobCommandInput}
+ * @returns {@link StartTextTranslationJobCommandOutput}
  * @see {@link StartTextTranslationJobCommandInput} for command's `input` shape.
  * @see {@link StartTextTranslationJobCommandOutput} for command's `response` shape.
  * @see {@link TranslateClientResolvedConfig | config} for TranslateClient's `config` shape.
@@ -66,11 +73,20 @@ export interface StartTextTranslationJobCommandOutput extends StartTextTranslati
 export declare class StartTextTranslationJobCommand extends $Command<StartTextTranslationJobCommandInput, StartTextTranslationJobCommandOutput, TranslateClientResolvedConfig> {
     readonly input: StartTextTranslationJobCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartTextTranslationJobCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TranslateClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartTextTranslationJobCommandInput, StartTextTranslationJobCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/StopTextTranslationJobCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StopTextTranslationJobRequest, StopTextTranslationJobResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TranslateClientResolvedConfig } from "../TranslateClient";
 /**
+ * @public
+ *
  * The input for {@link StopTextTranslationJobCommand}.
  */
 export interface StopTextTranslationJobCommandInput extends StopTextTranslationJobRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StopTextTranslationJobCommand}.
  */
 export interface StopTextTranslationJobCommandOutput extends StopTextTranslationJobResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Stops an asynchronous batch translation job that is in progress.</p>
  *          <p>If the job's state is <code>IN_PROGRESS</code>, the job will be marked for termination and
  *       put into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped,
@@ -31,6 +36,8 @@ export interface StopTextTranslationJobCommandOutput extends StopTextTranslation
  * const response = await client.send(command);
  * ```
  *
+ * @param StopTextTranslationJobCommandInput - {@link StopTextTranslationJobCommandInput}
+ * @returns {@link StopTextTranslationJobCommandOutput}
  * @see {@link StopTextTranslationJobCommandInput} for command's `input` shape.
  * @see {@link StopTextTranslationJobCommandOutput} for command's `response` shape.
  * @see {@link TranslateClientResolvedConfig | config} for TranslateClient's `config` shape.
@@ -52,11 +59,20 @@ export interface StopTextTranslationJobCommandOutput extends StopTextTranslation
 export declare class StopTextTranslationJobCommand extends $Command<StopTextTranslationJobCommandInput, StopTextTranslationJobCommandOutput, TranslateClientResolvedConfig> {
     readonly input: StopTextTranslationJobCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StopTextTranslationJobCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TranslateClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopTextTranslationJobCommandInput, StopTextTranslationJobCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/TagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TranslateClientResolvedConfig } from "../TranslateClient";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>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 <a href="https://docs.aws.amazon.com/translate/latest/dg/tagging.html">
@@ -28,6 +33,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link TranslateClientResolvedConfig | config} for TranslateClient's `config` shape.
@@ -56,11 +63,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, TranslateClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TranslateClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/TranslateTextCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { TranslateTextRequest, TranslateTextResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TranslateClientResolvedConfig } from "../TranslateClient";
 /**
+ * @public
+ *
  * The input for {@link TranslateTextCommand}.
  */
 export interface TranslateTextCommandInput extends TranslateTextRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TranslateTextCommand}.
  */
 export interface TranslateTextCommandOutput extends TranslateTextResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Translates input text from the source language to the target language. For a list of
  *       available languages and language codes, see <a href="https://docs.aws.amazon.com/translate/latest/dg/what-is-languages.html">Supported languages</a>.</p>
  * @example
@@ -26,6 +31,8 @@ export interface TranslateTextCommandOutput extends TranslateTextResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param TranslateTextCommandInput - {@link TranslateTextCommandInput}
+ * @returns {@link TranslateTextCommandOutput}
  * @see {@link TranslateTextCommandInput} for command's `input` shape.
  * @see {@link TranslateTextCommandOutput} for command's `response` shape.
  * @see {@link TranslateClientResolvedConfig | config} for TranslateClient's `config` shape.
@@ -69,11 +76,20 @@ export interface TranslateTextCommandOutput extends TranslateTextResponse, __Met
 export declare class TranslateTextCommand extends $Command<TranslateTextCommandInput, TranslateTextCommandOutput, TranslateClientResolvedConfig> {
     readonly input: TranslateTextCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TranslateTextCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TranslateClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TranslateTextCommandInput, TranslateTextCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TranslateClientResolvedConfig } from "../TranslateClient";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes a specific tag associated with an Amazon Translate resource.
  *       For more information, see <a href="https://docs.aws.amazon.com/translate/latest/dg/tagging.html">
  *         Tagging your resources</a>.</p>
@@ -27,6 +32,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link TranslateClientResolvedConfig | config} for TranslateClient's `config` shape.
@@ -52,11 +59,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, TranslateClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TranslateClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateParallelDataCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateParallelDataRequest, UpdateParallelDataResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TranslateClientResolvedConfig } from "../TranslateClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateParallelDataCommand}.
  */
 export interface UpdateParallelDataCommandInput extends UpdateParallelDataRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateParallelDataCommand}.
  */
 export interface UpdateParallelDataCommandOutput extends UpdateParallelDataResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates a previously created parallel data resource by importing a new input file from
  *       Amazon S3.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UpdateParallelDataCommandOutput extends UpdateParallelDataRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateParallelDataCommandInput - {@link UpdateParallelDataCommandInput}
+ * @returns {@link UpdateParallelDataCommandOutput}
  * @see {@link UpdateParallelDataCommandInput} for command's `input` shape.
  * @see {@link UpdateParallelDataCommandOutput} for command's `response` shape.
  * @see {@link TranslateClientResolvedConfig | config} for TranslateClient's `config` shape.
@@ -66,11 +73,20 @@ export interface UpdateParallelDataCommandOutput extends UpdateParallelDataRespo
 export declare class UpdateParallelDataCommand extends $Command<UpdateParallelDataCommandInput, UpdateParallelDataCommandOutput, TranslateClientResolvedConfig> {
     readonly input: UpdateParallelDataCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateParallelDataCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TranslateClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateParallelDataCommandInput, UpdateParallelDataCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/TranslateServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from Translate service.
  */
 export declare class TranslateServiceException extends __ServiceException {