@aws-sdk/client-transfer 3.53.0 → 3.55.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/dist-cjs/TransferClient.js +13 -13
  3. package/dist-cjs/commands/CreateAccessCommand.js +3 -3
  4. package/dist-cjs/commands/CreateServerCommand.js +3 -3
  5. package/dist-cjs/commands/CreateUserCommand.js +3 -3
  6. package/dist-cjs/commands/CreateWorkflowCommand.js +3 -3
  7. package/dist-cjs/commands/DeleteAccessCommand.js +3 -3
  8. package/dist-cjs/commands/DeleteServerCommand.js +3 -3
  9. package/dist-cjs/commands/DeleteSshPublicKeyCommand.js +3 -3
  10. package/dist-cjs/commands/DeleteUserCommand.js +3 -3
  11. package/dist-cjs/commands/DeleteWorkflowCommand.js +3 -3
  12. package/dist-cjs/commands/DescribeAccessCommand.js +3 -3
  13. package/dist-cjs/commands/DescribeExecutionCommand.js +3 -3
  14. package/dist-cjs/commands/DescribeSecurityPolicyCommand.js +3 -3
  15. package/dist-cjs/commands/DescribeServerCommand.js +3 -3
  16. package/dist-cjs/commands/DescribeUserCommand.js +3 -3
  17. package/dist-cjs/commands/DescribeWorkflowCommand.js +3 -3
  18. package/dist-cjs/commands/ImportSshPublicKeyCommand.js +3 -3
  19. package/dist-cjs/commands/ListAccessesCommand.js +3 -3
  20. package/dist-cjs/commands/ListExecutionsCommand.js +3 -3
  21. package/dist-cjs/commands/ListSecurityPoliciesCommand.js +3 -3
  22. package/dist-cjs/commands/ListServersCommand.js +3 -3
  23. package/dist-cjs/commands/ListTagsForResourceCommand.js +3 -3
  24. package/dist-cjs/commands/ListUsersCommand.js +3 -3
  25. package/dist-cjs/commands/ListWorkflowsCommand.js +3 -3
  26. package/dist-cjs/commands/SendWorkflowStepStateCommand.js +3 -3
  27. package/dist-cjs/commands/StartServerCommand.js +3 -3
  28. package/dist-cjs/commands/StopServerCommand.js +3 -3
  29. package/dist-cjs/commands/TagResourceCommand.js +3 -3
  30. package/dist-cjs/commands/TestIdentityProviderCommand.js +3 -3
  31. package/dist-cjs/commands/UntagResourceCommand.js +3 -3
  32. package/dist-cjs/commands/UpdateAccessCommand.js +3 -3
  33. package/dist-cjs/commands/UpdateServerCommand.js +3 -3
  34. package/dist-cjs/commands/UpdateUserCommand.js +3 -3
  35. package/dist-cjs/endpoints.js +1 -1
  36. package/dist-cjs/index.js +1 -0
  37. package/dist-cjs/models/models_0.js +7 -0
  38. package/dist-cjs/protocols/Aws_json1_1.js +198 -198
  39. package/dist-cjs/runtimeConfig.browser.js +4 -4
  40. package/dist-cjs/runtimeConfig.js +9 -9
  41. package/dist-cjs/runtimeConfig.native.js +1 -1
  42. package/dist-cjs/waiters/index.js +5 -0
  43. package/dist-cjs/waiters/waitForServerOffline.js +45 -0
  44. package/dist-cjs/waiters/waitForServerOnline.js +45 -0
  45. package/dist-es/Transfer.js +32 -32
  46. package/dist-es/index.js +1 -0
  47. package/dist-es/models/models_0.js +7 -0
  48. package/dist-es/pagination/ListAccessesPaginator.js +4 -4
  49. package/dist-es/pagination/ListExecutionsPaginator.js +4 -4
  50. package/dist-es/pagination/ListSecurityPoliciesPaginator.js +4 -4
  51. package/dist-es/pagination/ListServersPaginator.js +4 -4
  52. package/dist-es/pagination/ListTagsForResourcePaginator.js +4 -4
  53. package/dist-es/pagination/ListUsersPaginator.js +4 -4
  54. package/dist-es/pagination/ListWorkflowsPaginator.js +4 -4
  55. package/dist-es/waiters/index.js +2 -0
  56. package/dist-es/waiters/waitForServerOffline.js +60 -0
  57. package/dist-es/waiters/waitForServerOnline.js +60 -0
  58. package/dist-types/TransferClient.d.ts +2 -2
  59. package/dist-types/index.d.ts +1 -0
  60. package/dist-types/models/models_0.d.ts +96 -3
  61. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  62. package/dist-types/runtimeConfig.d.ts +1 -1
  63. package/dist-types/runtimeConfig.native.d.ts +3 -3
  64. package/dist-types/ts3.4/TransferClient.d.ts +2 -2
  65. package/dist-types/ts3.4/index.d.ts +1 -0
  66. package/dist-types/ts3.4/models/models_0.d.ts +14 -1
  67. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
  68. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
  69. package/dist-types/ts3.4/runtimeConfig.native.d.ts +3 -3
  70. package/dist-types/ts3.4/waiters/index.d.ts +2 -0
  71. package/dist-types/ts3.4/waiters/waitForServerOffline.d.ts +7 -0
  72. package/dist-types/ts3.4/waiters/waitForServerOnline.d.ts +7 -0
  73. package/dist-types/waiters/index.d.ts +2 -0
  74. package/dist-types/waiters/waitForServerOffline.d.ts +14 -0
  75. package/dist-types/waiters/waitForServerOnline.d.ts +14 -0
  76. package/package.json +35 -34
@@ -10,7 +10,7 @@ var makePagedClientRequest = function (client, input) {
10
10
  return __awaiter(void 0, void 0, void 0, function () {
11
11
  return __generator(this, function (_a) {
12
12
  switch (_a.label) {
13
- case 0: return [4, client.send.apply(client, __spreadArray([new ListTagsForResourceCommand(input)], __read(args)))];
13
+ case 0: return [4, client.send.apply(client, __spreadArray([new ListTagsForResourceCommand(input)], __read(args), false))];
14
14
  case 1: return [2, _a.sent()];
15
15
  }
16
16
  });
@@ -24,7 +24,7 @@ var makePagedRequest = function (client, input) {
24
24
  return __awaiter(void 0, void 0, void 0, function () {
25
25
  return __generator(this, function (_a) {
26
26
  switch (_a.label) {
27
- case 0: return [4, client.listTagsForResource.apply(client, __spreadArray([input], __read(args)))];
27
+ case 0: return [4, client.listTagsForResource.apply(client, __spreadArray([input], __read(args), false))];
28
28
  case 1: return [2, _a.sent()];
29
29
  }
30
30
  });
@@ -48,13 +48,13 @@ export function paginateListTagsForResource(config, input) {
48
48
  input.NextToken = token;
49
49
  input["MaxResults"] = config.pageSize;
50
50
  if (!(config.client instanceof Transfer)) return [3, 3];
51
- return [4, __await(makePagedRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments))))];
51
+ return [4, __await(makePagedRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments), false)))];
52
52
  case 2:
53
53
  page = _a.sent();
54
54
  return [3, 6];
55
55
  case 3:
56
56
  if (!(config.client instanceof TransferClient)) return [3, 5];
57
- return [4, __await(makePagedClientRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments))))];
57
+ return [4, __await(makePagedClientRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments), false)))];
58
58
  case 4:
59
59
  page = _a.sent();
60
60
  return [3, 6];
@@ -10,7 +10,7 @@ var makePagedClientRequest = function (client, input) {
10
10
  return __awaiter(void 0, void 0, void 0, function () {
11
11
  return __generator(this, function (_a) {
12
12
  switch (_a.label) {
13
- case 0: return [4, client.send.apply(client, __spreadArray([new ListUsersCommand(input)], __read(args)))];
13
+ case 0: return [4, client.send.apply(client, __spreadArray([new ListUsersCommand(input)], __read(args), false))];
14
14
  case 1: return [2, _a.sent()];
15
15
  }
16
16
  });
@@ -24,7 +24,7 @@ var makePagedRequest = function (client, input) {
24
24
  return __awaiter(void 0, void 0, void 0, function () {
25
25
  return __generator(this, function (_a) {
26
26
  switch (_a.label) {
27
- case 0: return [4, client.listUsers.apply(client, __spreadArray([input], __read(args)))];
27
+ case 0: return [4, client.listUsers.apply(client, __spreadArray([input], __read(args), false))];
28
28
  case 1: return [2, _a.sent()];
29
29
  }
30
30
  });
@@ -48,13 +48,13 @@ export function paginateListUsers(config, input) {
48
48
  input.NextToken = token;
49
49
  input["MaxResults"] = config.pageSize;
50
50
  if (!(config.client instanceof Transfer)) return [3, 3];
51
- return [4, __await(makePagedRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments))))];
51
+ return [4, __await(makePagedRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments), false)))];
52
52
  case 2:
53
53
  page = _a.sent();
54
54
  return [3, 6];
55
55
  case 3:
56
56
  if (!(config.client instanceof TransferClient)) return [3, 5];
57
- return [4, __await(makePagedClientRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments))))];
57
+ return [4, __await(makePagedClientRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments), false)))];
58
58
  case 4:
59
59
  page = _a.sent();
60
60
  return [3, 6];
@@ -10,7 +10,7 @@ var makePagedClientRequest = function (client, input) {
10
10
  return __awaiter(void 0, void 0, void 0, function () {
11
11
  return __generator(this, function (_a) {
12
12
  switch (_a.label) {
13
- case 0: return [4, client.send.apply(client, __spreadArray([new ListWorkflowsCommand(input)], __read(args)))];
13
+ case 0: return [4, client.send.apply(client, __spreadArray([new ListWorkflowsCommand(input)], __read(args), false))];
14
14
  case 1: return [2, _a.sent()];
15
15
  }
16
16
  });
@@ -24,7 +24,7 @@ var makePagedRequest = function (client, input) {
24
24
  return __awaiter(void 0, void 0, void 0, function () {
25
25
  return __generator(this, function (_a) {
26
26
  switch (_a.label) {
27
- case 0: return [4, client.listWorkflows.apply(client, __spreadArray([input], __read(args)))];
27
+ case 0: return [4, client.listWorkflows.apply(client, __spreadArray([input], __read(args), false))];
28
28
  case 1: return [2, _a.sent()];
29
29
  }
30
30
  });
@@ -48,13 +48,13 @@ export function paginateListWorkflows(config, input) {
48
48
  input.NextToken = token;
49
49
  input["MaxResults"] = config.pageSize;
50
50
  if (!(config.client instanceof Transfer)) return [3, 3];
51
- return [4, __await(makePagedRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments))))];
51
+ return [4, __await(makePagedRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments), false)))];
52
52
  case 2:
53
53
  page = _a.sent();
54
54
  return [3, 6];
55
55
  case 3:
56
56
  if (!(config.client instanceof TransferClient)) return [3, 5];
57
- return [4, __await(makePagedClientRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments))))];
57
+ return [4, __await(makePagedClientRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments), false)))];
58
58
  case 4:
59
59
  page = _a.sent();
60
60
  return [3, 6];
@@ -0,0 +1,2 @@
1
+ export * from "./waitForServerOffline";
2
+ export * from "./waitForServerOnline";
@@ -0,0 +1,60 @@
1
+ import { __assign, __awaiter, __generator } from "tslib";
2
+ import { checkExceptions, createWaiter, WaiterState } from "@aws-sdk/util-waiter";
3
+ import { DescribeServerCommand } from "../commands/DescribeServerCommand";
4
+ var checkState = function (client, input) { return __awaiter(void 0, void 0, void 0, function () {
5
+ var reason, result_1, returnComparator, returnComparator, exception_1;
6
+ return __generator(this, function (_a) {
7
+ switch (_a.label) {
8
+ case 0:
9
+ _a.trys.push([0, 2, , 3]);
10
+ return [4, client.send(new DescribeServerCommand(input))];
11
+ case 1:
12
+ result_1 = _a.sent();
13
+ reason = result_1;
14
+ try {
15
+ returnComparator = function () {
16
+ return result_1.Server.State;
17
+ };
18
+ if (returnComparator() === "OFFLINE") {
19
+ return [2, { state: WaiterState.SUCCESS, reason: reason }];
20
+ }
21
+ }
22
+ catch (e) { }
23
+ try {
24
+ returnComparator = function () {
25
+ return result_1.Server.State;
26
+ };
27
+ if (returnComparator() === "STOP_FAILED") {
28
+ return [2, { state: WaiterState.FAILURE, reason: reason }];
29
+ }
30
+ }
31
+ catch (e) { }
32
+ return [3, 3];
33
+ case 2:
34
+ exception_1 = _a.sent();
35
+ reason = exception_1;
36
+ return [3, 3];
37
+ case 3: return [2, { state: WaiterState.RETRY, reason: reason }];
38
+ }
39
+ });
40
+ }); };
41
+ export var waitForServerOffline = function (params, input) { return __awaiter(void 0, void 0, void 0, function () {
42
+ var serviceDefaults;
43
+ return __generator(this, function (_a) {
44
+ serviceDefaults = { minDelay: 30, maxDelay: 120 };
45
+ return [2, createWaiter(__assign(__assign({}, serviceDefaults), params), input, checkState)];
46
+ });
47
+ }); };
48
+ export var waitUntilServerOffline = function (params, input) { return __awaiter(void 0, void 0, void 0, function () {
49
+ var serviceDefaults, result;
50
+ return __generator(this, function (_a) {
51
+ switch (_a.label) {
52
+ case 0:
53
+ serviceDefaults = { minDelay: 30, maxDelay: 120 };
54
+ return [4, createWaiter(__assign(__assign({}, serviceDefaults), params), input, checkState)];
55
+ case 1:
56
+ result = _a.sent();
57
+ return [2, checkExceptions(result)];
58
+ }
59
+ });
60
+ }); };
@@ -0,0 +1,60 @@
1
+ import { __assign, __awaiter, __generator } from "tslib";
2
+ import { checkExceptions, createWaiter, WaiterState } from "@aws-sdk/util-waiter";
3
+ import { DescribeServerCommand } from "../commands/DescribeServerCommand";
4
+ var checkState = function (client, input) { return __awaiter(void 0, void 0, void 0, function () {
5
+ var reason, result_1, returnComparator, returnComparator, exception_1;
6
+ return __generator(this, function (_a) {
7
+ switch (_a.label) {
8
+ case 0:
9
+ _a.trys.push([0, 2, , 3]);
10
+ return [4, client.send(new DescribeServerCommand(input))];
11
+ case 1:
12
+ result_1 = _a.sent();
13
+ reason = result_1;
14
+ try {
15
+ returnComparator = function () {
16
+ return result_1.Server.State;
17
+ };
18
+ if (returnComparator() === "ONLINE") {
19
+ return [2, { state: WaiterState.SUCCESS, reason: reason }];
20
+ }
21
+ }
22
+ catch (e) { }
23
+ try {
24
+ returnComparator = function () {
25
+ return result_1.Server.State;
26
+ };
27
+ if (returnComparator() === "START_FAILED") {
28
+ return [2, { state: WaiterState.FAILURE, reason: reason }];
29
+ }
30
+ }
31
+ catch (e) { }
32
+ return [3, 3];
33
+ case 2:
34
+ exception_1 = _a.sent();
35
+ reason = exception_1;
36
+ return [3, 3];
37
+ case 3: return [2, { state: WaiterState.RETRY, reason: reason }];
38
+ }
39
+ });
40
+ }); };
41
+ export var waitForServerOnline = function (params, input) { return __awaiter(void 0, void 0, void 0, function () {
42
+ var serviceDefaults;
43
+ return __generator(this, function (_a) {
44
+ serviceDefaults = { minDelay: 30, maxDelay: 120 };
45
+ return [2, createWaiter(__assign(__assign({}, serviceDefaults), params), input, checkState)];
46
+ });
47
+ }); };
48
+ export var waitUntilServerOnline = function (params, input) { return __awaiter(void 0, void 0, void 0, function () {
49
+ var serviceDefaults, result;
50
+ return __generator(this, function (_a) {
51
+ switch (_a.label) {
52
+ case 0:
53
+ serviceDefaults = { minDelay: 30, maxDelay: 120 };
54
+ return [4, createWaiter(__assign(__assign({}, serviceDefaults), params), input, checkState)];
55
+ case 1:
56
+ result = _a.sent();
57
+ return [2, checkExceptions(result)];
58
+ }
59
+ });
60
+ }); };
@@ -5,7 +5,7 @@ import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-s
5
5
  import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
6
6
  import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
7
7
  import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
8
- import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
8
+ import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
9
9
  import { CreateAccessCommandInput, CreateAccessCommandOutput } from "./commands/CreateAccessCommand";
10
10
  import { CreateServerCommandInput, CreateServerCommandOutput } from "./commands/CreateServerCommand";
11
11
  import { CreateUserCommandInput, CreateUserCommandOutput } from "./commands/CreateUserCommand";
@@ -60,7 +60,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
60
60
  * A function that can calculate the length of a request body.
61
61
  * @internal
62
62
  */
63
- bodyLengthChecker?: (body: any) => number | undefined;
63
+ bodyLengthChecker?: __BodyLengthCalculator;
64
64
  /**
65
65
  * A function that converts a stream into an array of bytes.
66
66
  * @internal
@@ -3,4 +3,5 @@ export * from "./TransferClient";
3
3
  export * from "./commands";
4
4
  export * from "./models";
5
5
  export * from "./pagination";
6
+ export * from "./waiters";
6
7
  export { TransferServiceException } from "./models/TransferServiceException";
@@ -760,7 +760,22 @@ export interface CreateServerRequest {
760
760
  * your CloudWatch logs.</p>
761
761
  */
762
762
  LoggingRole?: string;
763
+ /**
764
+ * <p>Specify a string to display when users connect to a server. This string is displayed after the user authenticates.</p>
765
+ * <note>
766
+ * <p>The SFTP protocol does not support post-authentication display banners.</p>
767
+ * </note>
768
+ */
763
769
  PostAuthenticationLoginBanner?: string;
770
+ /**
771
+ * <p>Specify a string to display when users connect to a server. This string is displayed before the user authenticates.
772
+ * For example, the following banner displays details about using the system.</p>
773
+ * <p>
774
+ * <code>This system is for the use of authorized users only. Individuals using this computer system without authority,
775
+ * or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by
776
+ * system personnel.</code>
777
+ * </p>
778
+ */
764
779
  PreAuthenticationLoginBanner?: string;
765
780
  /**
766
781
  * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
@@ -1535,15 +1550,63 @@ export declare namespace LoggingConfiguration {
1535
1550
  const filterSensitiveLog: (obj: LoggingConfiguration) => any;
1536
1551
  }
1537
1552
  export declare enum ExecutionErrorType {
1538
- PERMISSION_DENIED = "PERMISSION_DENIED"
1553
+ ALREADY_EXISTS = "ALREADY_EXISTS",
1554
+ BAD_REQUEST = "BAD_REQUEST",
1555
+ CUSTOM_STEP_FAILED = "CUSTOM_STEP_FAILED",
1556
+ INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR",
1557
+ NOT_FOUND = "NOT_FOUND",
1558
+ PERMISSION_DENIED = "PERMISSION_DENIED",
1559
+ THROTTLED = "THROTTLED",
1560
+ TIMEOUT = "TIMEOUT"
1539
1561
  }
1540
1562
  /**
1541
1563
  * <p>Specifies the error message and type, for an error that occurs during the execution of the workflow.</p>
1542
1564
  */
1543
1565
  export interface ExecutionError {
1544
1566
  /**
1545
- * <p>Specifies the error type: currently, the only valid value is <code>PERMISSION_DENIED</code>, which occurs
1546
- * if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.</p>
1567
+ * <p>Specifies the error type.</p>
1568
+ * <ul>
1569
+ * <li>
1570
+ * <p>
1571
+ * <code>ALREADY_EXISTS</code>: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.</p>
1572
+ * </li>
1573
+ * <li>
1574
+ * <p>
1575
+ * <code>BAD_REQUEST</code>: a general bad request: for example, a step that attempts to
1576
+ * tag an EFS file returns <code>BAD_REQUEST</code>, as only S3 files can be tagged.</p>
1577
+ * </li>
1578
+ * <li>
1579
+ * <p>
1580
+ * <code>CUSTOM_STEP_FAILED</code>: occurs when the custom step provided a callback that indicates failure.</p>
1581
+ * </li>
1582
+ * <li>
1583
+ * <p>
1584
+ * <code>INTERNAL_SERVER_ERROR</code>: a catch-all error that can occur for a variety of
1585
+ * reasons.</p>
1586
+ * </li>
1587
+ * <li>
1588
+ * <p>
1589
+ * <code>NOT_FOUND</code>: occurs when a requested entity, for example a source file for
1590
+ * a copy step, does not exist.</p>
1591
+ * </li>
1592
+ * <li>
1593
+ * <p>
1594
+ * <code>PERMISSION_DENIED</code>: occurs if your policy does not contain the correct
1595
+ * permissions to complete one or more of the steps in the workflow.</p>
1596
+ * </li>
1597
+ * <li>
1598
+ * <p>
1599
+ * <code>TIMEOUT</code>: occurs when the execution times out.</p>
1600
+ * <note>
1601
+ * <p> You can set the <code>TimeoutSeconds</code> for a custom step, anywhere from 1 second to 1800 seconds (30 minutes). </p>
1602
+ * </note>
1603
+ * </li>
1604
+ * <li>
1605
+ * <p>
1606
+ * <code>THROTTLED</code>: occurs if you exceed the new execution refill rate of one
1607
+ * workflow per second.</p>
1608
+ * </li>
1609
+ * </ul>
1547
1610
  */
1548
1611
  Type: ExecutionErrorType | string | undefined;
1549
1612
  /**
@@ -1836,7 +1899,22 @@ export interface DescribedServer {
1836
1899
  * your CloudWatch logs.</p>
1837
1900
  */
1838
1901
  LoggingRole?: string;
1902
+ /**
1903
+ * <p>Specify a string to display when users connect to a server. This string is displayed after the user authenticates.</p>
1904
+ * <note>
1905
+ * <p>The SFTP protocol does not support post-authentication display banners.</p>
1906
+ * </note>
1907
+ */
1839
1908
  PostAuthenticationLoginBanner?: string;
1909
+ /**
1910
+ * <p>Specify a string to display when users connect to a server. This string is displayed before the user authenticates.
1911
+ * For example, the following banner displays details about using the system.</p>
1912
+ * <p>
1913
+ * <code>This system is for the use of authorized users only. Individuals using this computer system without authority,
1914
+ * or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by
1915
+ * system personnel.</code>
1916
+ * </p>
1917
+ */
1840
1918
  PreAuthenticationLoginBanner?: string;
1841
1919
  /**
1842
1920
  * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
@@ -3188,7 +3266,22 @@ export interface UpdateServerRequest {
3188
3266
  * your CloudWatch logs.</p>
3189
3267
  */
3190
3268
  LoggingRole?: string;
3269
+ /**
3270
+ * <p>Specify a string to display when users connect to a server. This string is displayed after the user authenticates.</p>
3271
+ * <note>
3272
+ * <p>The SFTP protocol does not support post-authentication display banners.</p>
3273
+ * </note>
3274
+ */
3191
3275
  PostAuthenticationLoginBanner?: string;
3276
+ /**
3277
+ * <p>Specify a string to display when users connect to a server. This string is displayed before the user authenticates.
3278
+ * For example, the following banner displays details about using the system.</p>
3279
+ * <p>
3280
+ * <code>This system is for the use of authorized users only. Individuals using this computer system without authority,
3281
+ * or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by
3282
+ * system personnel.</code>
3283
+ * </p>
3284
+ */
3192
3285
  PreAuthenticationLoginBanner?: string;
3193
3286
  /**
3194
3287
  * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
@@ -8,7 +8,7 @@ export declare const getRuntimeConfig: (config: TransferClientConfig) => {
8
8
  defaultsMode: import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
9
9
  base64Decoder: import("@aws-sdk/types").Decoder;
10
10
  base64Encoder: import("@aws-sdk/types").Encoder;
11
- bodyLengthChecker: (body: any) => number | undefined;
11
+ bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
12
12
  credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
13
13
  defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
14
14
  maxAttempts: number | import("@aws-sdk/types").Provider<number>;
@@ -8,7 +8,7 @@ export declare const getRuntimeConfig: (config: TransferClientConfig) => {
8
8
  defaultsMode: import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
9
9
  base64Decoder: import("@aws-sdk/types").Decoder;
10
10
  base64Encoder: import("@aws-sdk/types").Encoder;
11
- bodyLengthChecker: (body: any) => number | undefined;
11
+ bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
12
12
  credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
13
13
  defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
14
14
  maxAttempts: number | import("@aws-sdk/types").Provider<number>;
@@ -8,7 +8,7 @@ export declare const getRuntimeConfig: (config: TransferClientConfig) => {
8
8
  requestHandler: (import("@aws-sdk/types").RequestHandler<any, any, import("@aws-sdk/types").HttpHandlerOptions> & import("@aws-sdk/protocol-http").HttpHandler) | import("@aws-sdk/fetch-http-handler").FetchHttpHandler;
9
9
  apiVersion: string;
10
10
  urlParser: import("@aws-sdk/types").UrlParser;
11
- bodyLengthChecker: (body: any) => number | undefined;
11
+ bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
12
12
  streamCollector: import("@aws-sdk/types").StreamCollector;
13
13
  base64Decoder: import("@aws-sdk/types").Decoder;
14
14
  base64Encoder: import("@aws-sdk/types").Encoder;
@@ -21,11 +21,11 @@ export declare const getRuntimeConfig: (config: TransferClientConfig) => {
21
21
  useDualstackEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
22
22
  useFipsEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
23
23
  serviceId: string;
24
- region: string | import("@aws-sdk/types").Provider<string> | import("@aws-sdk/types").Provider<any>;
24
+ region: string | import("@aws-sdk/types").Provider<any>;
25
25
  credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
26
26
  regionInfoProvider: import("@aws-sdk/types").RegionInfoProvider;
27
27
  defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
28
- defaultsMode: import("@aws-sdk/smithy-client").DefaultsMode | import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").DefaultsMode> | import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
28
+ defaultsMode: import("@aws-sdk/smithy-client").DefaultsMode | import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").DefaultsMode>;
29
29
  endpoint?: string | import("@aws-sdk/types").Endpoint | import("@aws-sdk/types").Provider<import("@aws-sdk/types").Endpoint> | undefined;
30
30
  tls?: boolean | undefined;
31
31
  retryStrategy?: import("@aws-sdk/types").RetryStrategy | undefined;
@@ -5,7 +5,7 @@ import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-s
5
5
  import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
6
6
  import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
7
7
  import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
8
- import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
8
+ import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
9
9
  import { CreateAccessCommandInput, CreateAccessCommandOutput } from "./commands/CreateAccessCommand";
10
10
  import { CreateServerCommandInput, CreateServerCommandOutput } from "./commands/CreateServerCommand";
11
11
  import { CreateUserCommandInput, CreateUserCommandOutput } from "./commands/CreateUserCommand";
@@ -48,7 +48,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
48
48
 
49
49
  urlParser?: __UrlParser;
50
50
 
51
- bodyLengthChecker?: (body: any) => number | undefined;
51
+ bodyLengthChecker?: __BodyLengthCalculator;
52
52
 
53
53
  streamCollector?: __StreamCollector;
54
54
 
@@ -3,4 +3,5 @@ export * from "./TransferClient";
3
3
  export * from "./commands";
4
4
  export * from "./models";
5
5
  export * from "./pagination";
6
+ export * from "./waiters";
6
7
  export { TransferServiceException } from "./models/TransferServiceException";
@@ -288,7 +288,9 @@ export interface CreateServerRequest {
288
288
  IdentityProviderType?: IdentityProviderType | string;
289
289
 
290
290
  LoggingRole?: string;
291
+
291
292
  PostAuthenticationLoginBanner?: string;
293
+
292
294
  PreAuthenticationLoginBanner?: string;
293
295
 
294
296
  Protocols?: (Protocol | string)[];
@@ -583,7 +585,14 @@ export declare namespace LoggingConfiguration {
583
585
  const filterSensitiveLog: (obj: LoggingConfiguration) => any;
584
586
  }
585
587
  export declare enum ExecutionErrorType {
586
- PERMISSION_DENIED = "PERMISSION_DENIED"
588
+ ALREADY_EXISTS = "ALREADY_EXISTS",
589
+ BAD_REQUEST = "BAD_REQUEST",
590
+ CUSTOM_STEP_FAILED = "CUSTOM_STEP_FAILED",
591
+ INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR",
592
+ NOT_FOUND = "NOT_FOUND",
593
+ PERMISSION_DENIED = "PERMISSION_DENIED",
594
+ THROTTLED = "THROTTLED",
595
+ TIMEOUT = "TIMEOUT"
587
596
  }
588
597
 
589
598
  export interface ExecutionError {
@@ -720,7 +729,9 @@ export interface DescribedServer {
720
729
  IdentityProviderType?: IdentityProviderType | string;
721
730
 
722
731
  LoggingRole?: string;
732
+
723
733
  PostAuthenticationLoginBanner?: string;
734
+
724
735
  PreAuthenticationLoginBanner?: string;
725
736
 
726
737
  Protocols?: (Protocol | string)[];
@@ -1295,7 +1306,9 @@ export interface UpdateServerRequest {
1295
1306
  IdentityProviderDetails?: IdentityProviderDetails;
1296
1307
 
1297
1308
  LoggingRole?: string;
1309
+
1298
1310
  PostAuthenticationLoginBanner?: string;
1311
+
1299
1312
  PreAuthenticationLoginBanner?: string;
1300
1313
 
1301
1314
  Protocols?: (Protocol | string)[];
@@ -6,7 +6,7 @@ export declare const getRuntimeConfig: (config: TransferClientConfig) => {
6
6
  defaultsMode: import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
7
7
  base64Decoder: import("@aws-sdk/types").Decoder;
8
8
  base64Encoder: import("@aws-sdk/types").Encoder;
9
- bodyLengthChecker: (body: any) => number | undefined;
9
+ bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
10
10
  credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
11
11
  defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
12
12
  maxAttempts: number | import("@aws-sdk/types").Provider<number>;
@@ -6,7 +6,7 @@ export declare const getRuntimeConfig: (config: TransferClientConfig) => {
6
6
  defaultsMode: import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
7
7
  base64Decoder: import("@aws-sdk/types").Decoder;
8
8
  base64Encoder: import("@aws-sdk/types").Encoder;
9
- bodyLengthChecker: (body: any) => number | undefined;
9
+ bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
10
10
  credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
11
11
  defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
12
12
  maxAttempts: number | import("@aws-sdk/types").Provider<number>;
@@ -6,7 +6,7 @@ export declare const getRuntimeConfig: (config: TransferClientConfig) => {
6
6
  requestHandler: (import("@aws-sdk/types").RequestHandler<any, any, import("@aws-sdk/types").HttpHandlerOptions> & import("@aws-sdk/protocol-http").HttpHandler) | import("@aws-sdk/fetch-http-handler").FetchHttpHandler;
7
7
  apiVersion: string;
8
8
  urlParser: import("@aws-sdk/types").UrlParser;
9
- bodyLengthChecker: (body: any) => number | undefined;
9
+ bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
10
10
  streamCollector: import("@aws-sdk/types").StreamCollector;
11
11
  base64Decoder: import("@aws-sdk/types").Decoder;
12
12
  base64Encoder: import("@aws-sdk/types").Encoder;
@@ -19,11 +19,11 @@ export declare const getRuntimeConfig: (config: TransferClientConfig) => {
19
19
  useDualstackEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
20
20
  useFipsEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
21
21
  serviceId: string;
22
- region: string | import("@aws-sdk/types").Provider<string> | import("@aws-sdk/types").Provider<any>;
22
+ region: string | import("@aws-sdk/types").Provider<any>;
23
23
  credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
24
24
  regionInfoProvider: import("@aws-sdk/types").RegionInfoProvider;
25
25
  defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
26
- defaultsMode: import("@aws-sdk/smithy-client").DefaultsMode | import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").DefaultsMode> | import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
26
+ defaultsMode: import("@aws-sdk/smithy-client").DefaultsMode | import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").DefaultsMode>;
27
27
  endpoint?: string | import("@aws-sdk/types").Endpoint | import("@aws-sdk/types").Provider<import("@aws-sdk/types").Endpoint> | undefined;
28
28
  tls?: boolean | undefined;
29
29
  retryStrategy?: import("@aws-sdk/types").RetryStrategy | undefined;
@@ -0,0 +1,2 @@
1
+ export * from "./waitForServerOffline";
2
+ export * from "./waitForServerOnline";
@@ -0,0 +1,7 @@
1
+ import { WaiterConfiguration, WaiterResult } from "@aws-sdk/util-waiter";
2
+ import { DescribeServerCommandInput } from "../commands/DescribeServerCommand";
3
+ import { TransferClient } from "../TransferClient";
4
+
5
+ export declare const waitForServerOffline: (params: WaiterConfiguration<TransferClient>, input: DescribeServerCommandInput) => Promise<WaiterResult>;
6
+
7
+ export declare const waitUntilServerOffline: (params: WaiterConfiguration<TransferClient>, input: DescribeServerCommandInput) => Promise<WaiterResult>;
@@ -0,0 +1,7 @@
1
+ import { WaiterConfiguration, WaiterResult } from "@aws-sdk/util-waiter";
2
+ import { DescribeServerCommandInput } from "../commands/DescribeServerCommand";
3
+ import { TransferClient } from "../TransferClient";
4
+
5
+ export declare const waitForServerOnline: (params: WaiterConfiguration<TransferClient>, input: DescribeServerCommandInput) => Promise<WaiterResult>;
6
+
7
+ export declare const waitUntilServerOnline: (params: WaiterConfiguration<TransferClient>, input: DescribeServerCommandInput) => Promise<WaiterResult>;
@@ -0,0 +1,2 @@
1
+ export * from "./waitForServerOffline";
2
+ export * from "./waitForServerOnline";
@@ -0,0 +1,14 @@
1
+ import { WaiterConfiguration, WaiterResult } from "@aws-sdk/util-waiter";
2
+ import { DescribeServerCommandInput } from "../commands/DescribeServerCommand";
3
+ import { TransferClient } from "../TransferClient";
4
+ /**
5
+ *
6
+ * @deprecated Use waitUntilServerOffline instead. waitForServerOffline does not throw error in non-success cases.
7
+ */
8
+ export declare const waitForServerOffline: (params: WaiterConfiguration<TransferClient>, input: DescribeServerCommandInput) => Promise<WaiterResult>;
9
+ /**
10
+ *
11
+ * @param params - Waiter configuration options.
12
+ * @param input - The input to DescribeServerCommand for polling.
13
+ */
14
+ export declare const waitUntilServerOffline: (params: WaiterConfiguration<TransferClient>, input: DescribeServerCommandInput) => Promise<WaiterResult>;
@@ -0,0 +1,14 @@
1
+ import { WaiterConfiguration, WaiterResult } from "@aws-sdk/util-waiter";
2
+ import { DescribeServerCommandInput } from "../commands/DescribeServerCommand";
3
+ import { TransferClient } from "../TransferClient";
4
+ /**
5
+ *
6
+ * @deprecated Use waitUntilServerOnline instead. waitForServerOnline does not throw error in non-success cases.
7
+ */
8
+ export declare const waitForServerOnline: (params: WaiterConfiguration<TransferClient>, input: DescribeServerCommandInput) => Promise<WaiterResult>;
9
+ /**
10
+ *
11
+ * @param params - Waiter configuration options.
12
+ * @param input - The input to DescribeServerCommand for polling.
13
+ */
14
+ export declare const waitUntilServerOnline: (params: WaiterConfiguration<TransferClient>, input: DescribeServerCommandInput) => Promise<WaiterResult>;