@aws-sdk/client-transfer 3.321.1 → 3.326.0

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

@@ -34,6 +34,17 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * };
  * const command = new ListTagsForResourceCommand(input);
  * const response = await client.send(command);
+ * // { // ListTagsForResourceResponse
+ * //   Arn: "STRING_VALUE",
+ * //   NextToken: "STRING_VALUE",
+ * //   Tags: [ // Tags
+ * //     { // Tag
+ * //       Key: "STRING_VALUE", // required
+ * //       Value: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -54,6 +65,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, TransferClientResolvedConfig> {

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

@@ -34,6 +34,21 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
  * };
  * const command = new ListUsersCommand(input);
  * const response = await client.send(command);
+ * // { // ListUsersResponse
+ * //   NextToken: "STRING_VALUE",
+ * //   ServerId: "STRING_VALUE", // required
+ * //   Users: [ // ListedUsers // required
+ * //     { // ListedUser
+ * //       Arn: "STRING_VALUE", // required
+ * //       HomeDirectory: "STRING_VALUE",
+ * //       HomeDirectoryType: "PATH" || "LOGICAL",
+ * //       Role: "STRING_VALUE",
+ * //       SshPublicKeyCount: Number("int"),
+ * //       UserName: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param ListUsersCommandInput - {@link ListUsersCommandInput}
@@ -58,6 +73,8 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class ListUsersCommand extends $Command<ListUsersCommandInput, ListUsersCommandOutput, TransferClientResolvedConfig> {

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

@@ -32,6 +32,17 @@ export interface ListWorkflowsCommandOutput extends ListWorkflowsResponse, __Met
  * };
  * const command = new ListWorkflowsCommand(input);
  * const response = await client.send(command);
+ * // { // ListWorkflowsResponse
+ * //   NextToken: "STRING_VALUE",
+ * //   Workflows: [ // ListedWorkflows // required
+ * //     { // ListedWorkflow
+ * //       WorkflowId: "STRING_VALUE",
+ * //       Description: "STRING_VALUE",
+ * //       Arn: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param ListWorkflowsCommandInput - {@link ListWorkflowsCommandInput}
@@ -52,6 +63,8 @@ export interface ListWorkflowsCommandOutput extends ListWorkflowsResponse, __Met
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class ListWorkflowsCommand extends $Command<ListWorkflowsCommandInput, ListWorkflowsCommandOutput, TransferClientResolvedConfig> {

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

@@ -38,6 +38,8 @@ export interface SendWorkflowStepStateCommandOutput extends SendWorkflowStepStat
  * };
  * const command = new SendWorkflowStepStateCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param SendWorkflowStepStateCommandInput - {@link SendWorkflowStepStateCommandInput}
@@ -65,6 +67,8 @@ export interface SendWorkflowStepStateCommandOutput extends SendWorkflowStepStat
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class SendWorkflowStepStateCommand extends $Command<SendWorkflowStepStateCommandInput, SendWorkflowStepStateCommandOutput, TransferClientResolvedConfig> {

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

@@ -35,6 +35,10 @@ export interface StartFileTransferCommandOutput extends StartFileTransferRespons
  * };
  * const command = new StartFileTransferCommand(input);
  * const response = await client.send(command);
+ * // { // StartFileTransferResponse
+ * //   TransferId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param StartFileTransferCommandInput - {@link StartFileTransferCommandInput}
@@ -59,6 +63,8 @@ export interface StartFileTransferCommandOutput extends StartFileTransferRespons
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class StartFileTransferCommand extends $Command<StartFileTransferCommandInput, StartFileTransferCommandOutput, TransferClientResolvedConfig> {

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

@@ -37,6 +37,8 @@ export interface StartServerCommandOutput extends __MetadataBearer {
  * };
  * const command = new StartServerCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param StartServerCommandInput - {@link StartServerCommandInput}
@@ -61,6 +63,8 @@ export interface StartServerCommandOutput extends __MetadataBearer {
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class StartServerCommand extends $Command<StartServerCommandInput, StartServerCommandOutput, TransferClientResolvedConfig> {

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

@@ -42,6 +42,8 @@ export interface StopServerCommandOutput extends __MetadataBearer {
  * };
  * const command = new StopServerCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param StopServerCommandInput - {@link StopServerCommandInput}
@@ -66,6 +68,8 @@ export interface StopServerCommandOutput extends __MetadataBearer {
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class StopServerCommand extends $Command<StopServerCommandInput, StopServerCommandOutput, TransferClientResolvedConfig> {

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

@@ -39,6 +39,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
  * };
  * const command = new TagResourceCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -60,6 +62,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, TransferClientResolvedConfig> {

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

@@ -73,6 +73,13 @@ export interface TestIdentityProviderCommandOutput extends TestIdentityProviderR
  * };
  * const command = new TestIdentityProviderCommand(input);
  * const response = await client.send(command);
+ * // { // TestIdentityProviderResponse
+ * //   Response: "STRING_VALUE",
+ * //   StatusCode: Number("int"), // required
+ * //   Message: "STRING_VALUE",
+ * //   Url: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param TestIdentityProviderCommandInput - {@link TestIdentityProviderCommandInput}
@@ -94,6 +101,8 @@ export interface TestIdentityProviderCommandOutput extends TestIdentityProviderR
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class TestIdentityProviderCommand extends $Command<TestIdentityProviderCommandInput, TestIdentityProviderCommandOutput, TransferClientResolvedConfig> {

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

@@ -36,6 +36,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
  * };
  * const command = new UntagResourceCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -57,6 +59,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
  * @throws {@link ServiceUnavailableException} (server fault)
  *  <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, TransferClientResolvedConfig> {

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

@@ -50,6 +50,11 @@ export interface UpdateAccessCommandOutput extends UpdateAccessResponse, __Metad
  * };
  * const command = new UpdateAccessCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateAccessResponse
+ * //   ServerId: "STRING_VALUE", // required
+ * //   ExternalId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param UpdateAccessCommandInput - {@link UpdateAccessCommandInput}
@@ -77,6 +82,8 @@ export interface UpdateAccessCommandOutput extends UpdateAccessResponse, __Metad
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class UpdateAccessCommand extends $Command<UpdateAccessCommandInput, UpdateAccessCommandOutput, TransferClientResolvedConfig> {

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

@@ -40,6 +40,10 @@ export interface UpdateAgreementCommandOutput extends UpdateAgreementResponse, _
  * };
  * const command = new UpdateAgreementCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateAgreementResponse
+ * //   AgreementId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param UpdateAgreementCommandInput - {@link UpdateAgreementCommandInput}
@@ -67,6 +71,8 @@ export interface UpdateAgreementCommandOutput extends UpdateAgreementResponse, _
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class UpdateAgreementCommand extends $Command<UpdateAgreementCommandInput, UpdateAgreementCommandOutput, TransferClientResolvedConfig> {

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

@@ -34,6 +34,10 @@ export interface UpdateCertificateCommandOutput extends UpdateCertificateRespons
  * };
  * const command = new UpdateCertificateCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateCertificateResponse
+ * //   CertificateId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param UpdateCertificateCommandInput - {@link UpdateCertificateCommandInput}
@@ -58,6 +62,8 @@ export interface UpdateCertificateCommandOutput extends UpdateCertificateRespons
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class UpdateCertificateCommand extends $Command<UpdateCertificateCommandInput, UpdateCertificateCommandOutput, TransferClientResolvedConfig> {

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

@@ -46,6 +46,10 @@ export interface UpdateConnectorCommandOutput extends UpdateConnectorResponse, _
  * };
  * const command = new UpdateConnectorCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateConnectorResponse
+ * //   ConnectorId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param UpdateConnectorCommandInput - {@link UpdateConnectorCommandInput}
@@ -73,6 +77,8 @@ export interface UpdateConnectorCommandOutput extends UpdateConnectorResponse, _
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class UpdateConnectorCommand extends $Command<UpdateConnectorCommandInput, UpdateConnectorCommandOutput, TransferClientResolvedConfig> {

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

@@ -34,6 +34,11 @@ export interface UpdateHostKeyCommandOutput extends UpdateHostKeyResponse, __Met
  * };
  * const command = new UpdateHostKeyCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateHostKeyResponse
+ * //   ServerId: "STRING_VALUE", // required
+ * //   HostKeyId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param UpdateHostKeyCommandInput - {@link UpdateHostKeyCommandInput}
@@ -58,6 +63,8 @@ export interface UpdateHostKeyCommandOutput extends UpdateHostKeyResponse, __Met
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class UpdateHostKeyCommand extends $Command<UpdateHostKeyCommandInput, UpdateHostKeyCommandOutput, TransferClientResolvedConfig> {

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

@@ -36,6 +36,10 @@ export interface UpdateProfileCommandOutput extends UpdateProfileResponse, __Met
  * };
  * const command = new UpdateProfileCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateProfileResponse
+ * //   ProfileId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param UpdateProfileCommandInput - {@link UpdateProfileCommandInput}
@@ -60,6 +64,8 @@ export interface UpdateProfileCommandOutput extends UpdateProfileResponse, __Met
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class UpdateProfileCommand extends $Command<UpdateProfileCommandInput, UpdateProfileCommandOutput, TransferClientResolvedConfig> {

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

@@ -85,6 +85,10 @@ export interface UpdateServerCommandOutput extends UpdateServerResponse, __Metad
  * };
  * const command = new UpdateServerCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateServerResponse
+ * //   ServerId: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param UpdateServerCommandInput - {@link UpdateServerCommandInput}
@@ -120,6 +124,8 @@ export interface UpdateServerCommandOutput extends UpdateServerResponse, __Metad
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class UpdateServerCommand extends $Command<UpdateServerCommandInput, UpdateServerCommandOutput, TransferClientResolvedConfig> {

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

@@ -53,6 +53,11 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB
  * };
  * const command = new UpdateUserCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateUserResponse
+ * //   ServerId: "STRING_VALUE", // required
+ * //   UserName: "STRING_VALUE", // required
+ * // };
+ *
  * ```
  *
  * @param UpdateUserCommandInput - {@link UpdateUserCommandInput}
@@ -77,6 +82,8 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
  *
+ * @throws {@link TransferServiceException}
+ * <p>Base exception class for all service exceptions from Transfer service.</p>
  *
  */
 export declare class UpdateUserCommand extends $Command<UpdateUserCommandInput, UpdateUserCommandOutput, TransferClientResolvedConfig> {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-transfer",
   "description": "AWS SDK for JavaScript Transfer Client for Node.js, Browser and React Native",
-  "version": "3.321.1",
+  "version": "3.326.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,33 +21,33 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.321.1",
+    "@aws-sdk/client-sts": "3.326.0",
     "@aws-sdk/config-resolver": "3.310.0",
-    "@aws-sdk/credential-provider-node": "3.321.1",
+    "@aws-sdk/credential-provider-node": "3.326.0",
     "@aws-sdk/fetch-http-handler": "3.310.0",
     "@aws-sdk/hash-node": "3.310.0",
     "@aws-sdk/invalid-dependency": "3.310.0",
-    "@aws-sdk/middleware-content-length": "3.310.0",
-    "@aws-sdk/middleware-endpoint": "3.310.0",
-    "@aws-sdk/middleware-host-header": "3.310.0",
-    "@aws-sdk/middleware-logger": "3.310.0",
-    "@aws-sdk/middleware-recursion-detection": "3.310.0",
-    "@aws-sdk/middleware-retry": "3.310.0",
-    "@aws-sdk/middleware-serde": "3.310.0",
-    "@aws-sdk/middleware-signing": "3.310.0",
-    "@aws-sdk/middleware-stack": "3.310.0",
-    "@aws-sdk/middleware-user-agent": "3.319.0",
+    "@aws-sdk/middleware-content-length": "3.325.0",
+    "@aws-sdk/middleware-endpoint": "3.325.0",
+    "@aws-sdk/middleware-host-header": "3.325.0",
+    "@aws-sdk/middleware-logger": "3.325.0",
+    "@aws-sdk/middleware-recursion-detection": "3.325.0",
+    "@aws-sdk/middleware-retry": "3.325.0",
+    "@aws-sdk/middleware-serde": "3.325.0",
+    "@aws-sdk/middleware-signing": "3.325.0",
+    "@aws-sdk/middleware-stack": "3.325.0",
+    "@aws-sdk/middleware-user-agent": "3.325.0",
     "@aws-sdk/node-config-provider": "3.310.0",
     "@aws-sdk/node-http-handler": "3.321.1",
     "@aws-sdk/protocol-http": "3.310.0",
-    "@aws-sdk/smithy-client": "3.316.0",
+    "@aws-sdk/smithy-client": "3.325.0",
     "@aws-sdk/types": "3.310.0",
     "@aws-sdk/url-parser": "3.310.0",
     "@aws-sdk/util-base64": "3.310.0",
     "@aws-sdk/util-body-length-browser": "3.310.0",
     "@aws-sdk/util-body-length-node": "3.310.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.316.0",
-    "@aws-sdk/util-defaults-mode-node": "3.316.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.325.0",
+    "@aws-sdk/util-defaults-mode-node": "3.325.0",
     "@aws-sdk/util-endpoints": "3.319.0",
     "@aws-sdk/util-retry": "3.310.0",
     "@aws-sdk/util-user-agent-browser": "3.310.0",