@aws-sdk/client-transfer 3.296.0 → 3.297.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateHostKeyRequest, UpdateHostKeyResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateHostKeyCommand}.
  */
 export interface UpdateHostKeyCommandInput extends UpdateHostKeyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateHostKeyCommand}.
  */
 export interface UpdateHostKeyCommandOutput extends UpdateHostKeyResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the description for the host key that's specified by the <code>ServerId</code> and
  *         <code>HostKeyId</code> parameters.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UpdateHostKeyCommandOutput extends UpdateHostKeyResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateHostKeyCommandInput - {@link UpdateHostKeyCommandInput}
+ * @returns {@link UpdateHostKeyCommandOutput}
  * @see {@link UpdateHostKeyCommandInput} for command's `input` shape.
  * @see {@link UpdateHostKeyCommandOutput} for command's `response` shape.
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -51,11 +58,20 @@ export interface UpdateHostKeyCommandOutput extends UpdateHostKeyResponse, __Met
 export declare class UpdateHostKeyCommand extends $Command<UpdateHostKeyCommandInput, UpdateHostKeyCommandOutput, TransferClientResolvedConfig> {
     readonly input: UpdateHostKeyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateHostKeyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateHostKeyCommandInput, UpdateHostKeyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateProfileRequest, UpdateProfileResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateProfileCommand}.
  */
 export interface UpdateProfileCommandInput extends UpdateProfileRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateProfileCommand}.
  */
 export interface UpdateProfileCommandOutput extends UpdateProfileResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates some of the parameters for an existing profile. Provide the <code>ProfileId</code>
  *       for the profile that you want to update, along with the new values for the parameters to
  *       update.</p>
@@ -27,6 +32,8 @@ export interface UpdateProfileCommandOutput extends UpdateProfileResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateProfileCommandInput - {@link UpdateProfileCommandInput}
+ * @returns {@link UpdateProfileCommandOutput}
  * @see {@link UpdateProfileCommandInput} for command's `input` shape.
  * @see {@link UpdateProfileCommandOutput} for command's `response` shape.
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -52,11 +59,20 @@ export interface UpdateProfileCommandOutput extends UpdateProfileResponse, __Met
 export declare class UpdateProfileCommand extends $Command<UpdateProfileCommandInput, UpdateProfileCommandOutput, TransferClientResolvedConfig> {
     readonly input: UpdateProfileCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateProfileCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateProfileCommandInput, UpdateProfileCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateServerRequest, UpdateServerResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateServerCommand}.
  */
 export interface UpdateServerCommandInput extends UpdateServerRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateServerCommand}.
  */
 export interface UpdateServerCommandOutput extends UpdateServerResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the file transfer protocol-enabled server's properties after that server has
  *       been created.</p>
  *          <p>The <code>UpdateServer</code> call returns the <code>ServerId</code> of the server you
@@ -28,6 +33,8 @@ export interface UpdateServerCommandOutput extends UpdateServerResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateServerCommandInput - {@link UpdateServerCommandInput}
+ * @returns {@link UpdateServerCommandOutput}
  * @see {@link UpdateServerCommandInput} for command's `input` shape.
  * @see {@link UpdateServerCommandOutput} for command's `response` shape.
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -64,11 +71,20 @@ export interface UpdateServerCommandOutput extends UpdateServerResponse, __Metad
 export declare class UpdateServerCommand extends $Command<UpdateServerCommandInput, UpdateServerCommandOutput, TransferClientResolvedConfig> {
     readonly input: UpdateServerCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateServerCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateServerCommandInput, UpdateServerCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateUserRequest, UpdateUserResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateUserCommand}.
  */
 export interface UpdateUserCommandInput extends UpdateUserRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateUserCommand}.
  */
 export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Assigns new properties to a user. Parameters you pass modify any or all of the following:
  *       the home directory, role, and policy for the <code>UserName</code> and <code>ServerId</code>
  *       you specify.</p>
@@ -29,6 +34,8 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateUserCommandInput - {@link UpdateUserCommandInput}
+ * @returns {@link UpdateUserCommandOutput}
  * @see {@link UpdateUserCommandInput} for command's `input` shape.
  * @see {@link UpdateUserCommandOutput} for command's `response` shape.
  * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape.
@@ -54,11 +61,20 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB
 export declare class UpdateUserCommand extends $Command<UpdateUserCommandInput, UpdateUserCommandOutput, TransferClientResolvedConfig> {
     readonly input: UpdateUserCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateUserCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TransferClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateUserCommandInput, UpdateUserCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/TransferServiceException.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 Transfer service.
  */
 export declare class TransferServiceException extends __ServiceException {