@aws-sdk/client-transfer 3.52.0 → 3.54.1

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 (36) hide show
  1. package/CHANGELOG.md +31 -0
  2. package/dist-cjs/index.js +4 -0
  3. package/dist-cjs/models/TransferServiceException.js +11 -0
  4. package/dist-cjs/models/models_0.js +141 -3
  5. package/dist-cjs/protocols/Aws_json1_1.js +360 -1302
  6. package/dist-cjs/waiters/index.js +5 -0
  7. package/dist-cjs/waiters/waitForServerOffline.js +45 -0
  8. package/dist-cjs/waiters/waitForServerOnline.js +45 -0
  9. package/dist-es/index.js +2 -0
  10. package/dist-es/models/TransferServiceException.js +12 -0
  11. package/dist-es/models/models_0.js +130 -1
  12. package/dist-es/protocols/Aws_json1_1.js +771 -1418
  13. package/dist-es/waiters/index.js +2 -0
  14. package/dist-es/waiters/waitForServerOffline.js +60 -0
  15. package/dist-es/waiters/waitForServerOnline.js +60 -0
  16. package/dist-types/TransferClient.d.ts +2 -2
  17. package/dist-types/index.d.ts +2 -0
  18. package/dist-types/models/TransferServiceException.d.ts +10 -0
  19. package/dist-types/models/models_0.d.ts +227 -77
  20. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  21. package/dist-types/runtimeConfig.d.ts +1 -1
  22. package/dist-types/runtimeConfig.native.d.ts +1 -1
  23. package/dist-types/ts3.4/TransferClient.d.ts +2 -2
  24. package/dist-types/ts3.4/index.d.ts +2 -0
  25. package/dist-types/ts3.4/models/TransferServiceException.d.ts +6 -0
  26. package/dist-types/ts3.4/models/models_0.d.ts +69 -29
  27. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
  28. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
  29. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
  30. package/dist-types/ts3.4/waiters/index.d.ts +2 -0
  31. package/dist-types/ts3.4/waiters/waitForServerOffline.d.ts +7 -0
  32. package/dist-types/ts3.4/waiters/waitForServerOnline.d.ts +7 -0
  33. package/dist-types/waiters/index.d.ts +2 -0
  34. package/dist-types/waiters/waitForServerOffline.d.ts +14 -0
  35. package/dist-types/waiters/waitForServerOnline.d.ts +14 -0
  36. package/package.json +28 -27
@@ -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,3 +3,5 @@ export * from "./TransferClient";
3
3
  export * from "./commands";
4
4
  export * from "./models";
5
5
  export * from "./pagination";
6
+ export * from "./waiters";
7
+ export { TransferServiceException } from "./models/TransferServiceException";
@@ -0,0 +1,10 @@
1
+ import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
+ /**
3
+ * Base exception class for all service exceptions from Transfer service.
4
+ */
5
+ export declare class TransferServiceException extends __ServiceException {
6
+ /**
7
+ * @internal
8
+ */
9
+ constructor(options: __ServiceExceptionOptions);
10
+ }
@@ -1,21 +1,30 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
+ import { TransferServiceException as __BaseException } from "./TransferServiceException";
2
3
  /**
3
4
  * <p>You do not have sufficient access to perform this action.</p>
4
5
  */
5
- export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
6
- name: "AccessDeniedException";
7
- $fault: "client";
6
+ export declare class AccessDeniedException extends __BaseException {
7
+ readonly name: "AccessDeniedException";
8
+ readonly $fault: "client";
8
9
  Message?: string;
10
+ /**
11
+ * @internal
12
+ */
13
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
9
14
  }
10
15
  /**
11
16
  * <p>This exception is thrown when the <code>UpdateServer</code> is called for a file transfer
12
17
  * protocol-enabled server that has VPC as the endpoint type and the server's
13
18
  * <code>VpcEndpointID</code> is not in the available state.</p>
14
19
  */
15
- export interface ConflictException extends __SmithyException, $MetadataBearer {
16
- name: "ConflictException";
17
- $fault: "client";
20
+ export declare class ConflictException extends __BaseException {
21
+ readonly name: "ConflictException";
22
+ readonly $fault: "client";
18
23
  Message: string | undefined;
24
+ /**
25
+ * @internal
26
+ */
27
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
19
28
  }
20
29
  /**
21
30
  * <p>Reserved for future use.</p>
@@ -100,7 +109,9 @@ export interface CopyStepDetails {
100
109
  */
101
110
  Name?: string;
102
111
  /**
103
- * <p>Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps.</p>
112
+ * <p>Specifies the location for the file being copied. Only applicable for Copy type workflow
113
+ * steps. Use <code>${Transfer:username}</code> in this field to parametrize the destination
114
+ * prefix by username.</p>
104
115
  */
105
116
  DestinationFileLocation?: InputFileLocation;
106
117
  /**
@@ -108,6 +119,21 @@ export interface CopyStepDetails {
108
119
  * The default is <code>FALSE</code>.</p>
109
120
  */
110
121
  OverwriteExisting?: OverwriteExisting | string;
122
+ /**
123
+ * <p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file
124
+ * for the workflow.</p>
125
+ * <ul>
126
+ * <li>
127
+ * <p>Enter <code>${previous.file}</code> to use the previous file as the input.
128
+ * In this case, this workflow step uses the output file from the previous workflow step as input.
129
+ * This is the default value.</p>
130
+ * </li>
131
+ * <li>
132
+ * <p>Enter <code>${original.file}</code> to use the originally-uploaded file location as input for this step.</p>
133
+ * </li>
134
+ * </ul>
135
+ */
136
+ SourceFileLocation?: string;
111
137
  }
112
138
  export declare namespace CopyStepDetails {
113
139
  /**
@@ -122,15 +148,6 @@ export declare namespace CopyStepDetails {
122
148
  * <p>
123
149
  * <code>[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]</code>
124
150
  * </p>
125
- *
126
- * <note>
127
- * <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
128
- * ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
129
- * holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of
130
- * <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the
131
- * following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make
132
- * sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p>
133
- * </note>
134
151
  */
135
152
  export interface HomeDirectoryMapEntry {
136
153
  /**
@@ -213,15 +230,6 @@ export interface CreateAccessRequest {
213
230
  * <p>
214
231
  * <code>[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]</code>
215
232
  * </p>
216
- *
217
- * <note>
218
- * <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
219
- * ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
220
- * holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of
221
- * <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the
222
- * following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make
223
- * sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p>
224
- * </note>
225
233
  */
226
234
  HomeDirectoryMappings?: HomeDirectoryMapEntry[];
227
235
  /**
@@ -303,47 +311,67 @@ export declare namespace CreateAccessResponse {
303
311
  /**
304
312
  * <p>This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.</p>
305
313
  */
306
- export interface InternalServiceError extends __SmithyException, $MetadataBearer {
307
- name: "InternalServiceError";
308
- $fault: "server";
314
+ export declare class InternalServiceError extends __BaseException {
315
+ readonly name: "InternalServiceError";
316
+ readonly $fault: "server";
309
317
  Message: string | undefined;
318
+ /**
319
+ * @internal
320
+ */
321
+ constructor(opts: __ExceptionOptionType<InternalServiceError, __BaseException>);
310
322
  }
311
323
  /**
312
324
  * <p>This exception is thrown when the client submits a malformed request.</p>
313
325
  */
314
- export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
315
- name: "InvalidRequestException";
316
- $fault: "client";
326
+ export declare class InvalidRequestException extends __BaseException {
327
+ readonly name: "InvalidRequestException";
328
+ readonly $fault: "client";
317
329
  Message: string | undefined;
330
+ /**
331
+ * @internal
332
+ */
333
+ constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
318
334
  }
319
335
  /**
320
336
  * <p>The requested resource does not exist.</p>
321
337
  */
322
- export interface ResourceExistsException extends __SmithyException, $MetadataBearer {
323
- name: "ResourceExistsException";
324
- $fault: "client";
338
+ export declare class ResourceExistsException extends __BaseException {
339
+ readonly name: "ResourceExistsException";
340
+ readonly $fault: "client";
325
341
  Message: string | undefined;
326
342
  Resource: string | undefined;
327
343
  ResourceType: string | undefined;
344
+ /**
345
+ * @internal
346
+ */
347
+ constructor(opts: __ExceptionOptionType<ResourceExistsException, __BaseException>);
328
348
  }
329
349
  /**
330
350
  * <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family
331
351
  * service.</p>
332
352
  */
333
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
334
- name: "ResourceNotFoundException";
335
- $fault: "client";
353
+ export declare class ResourceNotFoundException extends __BaseException {
354
+ readonly name: "ResourceNotFoundException";
355
+ readonly $fault: "client";
336
356
  Message: string | undefined;
337
357
  Resource: string | undefined;
338
358
  ResourceType: string | undefined;
359
+ /**
360
+ * @internal
361
+ */
362
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
339
363
  }
340
364
  /**
341
365
  * <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
342
366
  */
343
- export interface ServiceUnavailableException extends __SmithyException, $MetadataBearer {
344
- name: "ServiceUnavailableException";
345
- $fault: "server";
367
+ export declare class ServiceUnavailableException extends __BaseException {
368
+ readonly name: "ServiceUnavailableException";
369
+ readonly $fault: "server";
346
370
  Message?: string;
371
+ /**
372
+ * @internal
373
+ */
374
+ constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
347
375
  }
348
376
  export declare enum Domain {
349
377
  EFS = "EFS",
@@ -732,7 +760,22 @@ export interface CreateServerRequest {
732
760
  * your CloudWatch logs.</p>
733
761
  */
734
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
+ */
735
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
+ */
736
779
  PreAuthenticationLoginBanner?: string;
737
780
  /**
738
781
  * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
@@ -819,10 +862,14 @@ export declare namespace CreateServerResponse {
819
862
  *
820
863
  * <p> HTTP Status Code: 400</p>
821
864
  */
822
- export interface ThrottlingException extends __SmithyException, $MetadataBearer {
823
- name: "ThrottlingException";
824
- $fault: "client";
865
+ export declare class ThrottlingException extends __BaseException {
866
+ readonly name: "ThrottlingException";
867
+ readonly $fault: "client";
825
868
  RetryAfterSeconds?: string;
869
+ /**
870
+ * @internal
871
+ */
872
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
826
873
  }
827
874
  export interface CreateUserRequest {
828
875
  /**
@@ -862,15 +909,6 @@ export interface CreateUserRequest {
862
909
  * <p>
863
910
  * <code>[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]</code>
864
911
  * </p>
865
- *
866
- * <note>
867
- * <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
868
- * ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
869
- * holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of
870
- * <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the
871
- * following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make
872
- * sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p>
873
- * </note>
874
912
  */
875
913
  HomeDirectoryMappings?: HomeDirectoryMapEntry[];
876
914
  /**
@@ -977,6 +1015,21 @@ export interface CustomStepDetails {
977
1015
  * <p>Timeout, in seconds, for the step.</p>
978
1016
  */
979
1017
  TimeoutSeconds?: number;
1018
+ /**
1019
+ * <p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file
1020
+ * for the workflow.</p>
1021
+ * <ul>
1022
+ * <li>
1023
+ * <p>Enter <code>${previous.file}</code> to use the previous file as the input.
1024
+ * In this case, this workflow step uses the output file from the previous workflow step as input.
1025
+ * This is the default value.</p>
1026
+ * </li>
1027
+ * <li>
1028
+ * <p>Enter <code>${original.file}</code> to use the originally-uploaded file location as input for this step.</p>
1029
+ * </li>
1030
+ * </ul>
1031
+ */
1032
+ SourceFileLocation?: string;
980
1033
  }
981
1034
  export declare namespace CustomStepDetails {
982
1035
  /**
@@ -992,6 +1045,21 @@ export interface DeleteStepDetails {
992
1045
  * <p>The name of the step, used as an identifier.</p>
993
1046
  */
994
1047
  Name?: string;
1048
+ /**
1049
+ * <p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file
1050
+ * for the workflow.</p>
1051
+ * <ul>
1052
+ * <li>
1053
+ * <p>Enter <code>${previous.file}</code> to use the previous file as the input.
1054
+ * In this case, this workflow step uses the output file from the previous workflow step as input.
1055
+ * This is the default value.</p>
1056
+ * </li>
1057
+ * <li>
1058
+ * <p>Enter <code>${original.file}</code> to use the originally-uploaded file location as input for this step.</p>
1059
+ * </li>
1060
+ * </ul>
1061
+ */
1062
+ SourceFileLocation?: string;
995
1063
  }
996
1064
  export declare namespace DeleteStepDetails {
997
1065
  /**
@@ -1031,6 +1099,21 @@ export interface TagStepDetails {
1031
1099
  * <p>Array that contains from 1 to 10 key/value pairs.</p>
1032
1100
  */
1033
1101
  Tags?: S3Tag[];
1102
+ /**
1103
+ * <p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file
1104
+ * for the workflow.</p>
1105
+ * <ul>
1106
+ * <li>
1107
+ * <p>Enter <code>${previous.file}</code> to use the previous file as the input.
1108
+ * In this case, this workflow step uses the output file from the previous workflow step as input.
1109
+ * This is the default value.</p>
1110
+ * </li>
1111
+ * <li>
1112
+ * <p>Enter <code>${original.file}</code> to use the originally-uploaded file location as input for this step.</p>
1113
+ * </li>
1114
+ * </ul>
1115
+ */
1116
+ SourceFileLocation?: string;
1034
1117
  }
1035
1118
  export declare namespace TagStepDetails {
1036
1119
  /**
@@ -1467,15 +1550,63 @@ export declare namespace LoggingConfiguration {
1467
1550
  const filterSensitiveLog: (obj: LoggingConfiguration) => any;
1468
1551
  }
1469
1552
  export declare enum ExecutionErrorType {
1470
- 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"
1471
1561
  }
1472
1562
  /**
1473
1563
  * <p>Specifies the error message and type, for an error that occurs during the execution of the workflow.</p>
1474
1564
  */
1475
1565
  export interface ExecutionError {
1476
1566
  /**
1477
- * <p>Specifies the error type: currently, the only valid value is <code>PERMISSION_DENIED</code>, which occurs
1478
- * 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>
1479
1610
  */
1480
1611
  Type: ExecutionErrorType | string | undefined;
1481
1612
  /**
@@ -1768,7 +1899,22 @@ export interface DescribedServer {
1768
1899
  * your CloudWatch logs.</p>
1769
1900
  */
1770
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
+ */
1771
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
+ */
1772
1918
  PreAuthenticationLoginBanner?: string;
1773
1919
  /**
1774
1920
  * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
@@ -2166,10 +2312,14 @@ export declare namespace ImportSshPublicKeyResponse {
2166
2312
  /**
2167
2313
  * <p>The <code>NextToken</code> parameter that was passed is invalid.</p>
2168
2314
  */
2169
- export interface InvalidNextTokenException extends __SmithyException, $MetadataBearer {
2170
- name: "InvalidNextTokenException";
2171
- $fault: "client";
2315
+ export declare class InvalidNextTokenException extends __BaseException {
2316
+ readonly name: "InvalidNextTokenException";
2317
+ readonly $fault: "client";
2172
2318
  Message: string | undefined;
2319
+ /**
2320
+ * @internal
2321
+ */
2322
+ constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
2173
2323
  }
2174
2324
  export interface ListAccessesRequest {
2175
2325
  /**
@@ -2858,6 +3008,9 @@ export interface TestIdentityProviderResponse {
2858
3008
  StatusCode: number | undefined;
2859
3009
  /**
2860
3010
  * <p>A message that indicates whether the test was successful or not.</p>
3011
+ * <note>
3012
+ * <p>If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.</p>
3013
+ * </note>
2861
3014
  */
2862
3015
  Message?: string;
2863
3016
  /**
@@ -2923,15 +3076,6 @@ export interface UpdateAccessRequest {
2923
3076
  * <p>
2924
3077
  * <code>[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]</code>
2925
3078
  * </p>
2926
- *
2927
- * <note>
2928
- * <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
2929
- * ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
2930
- * holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of
2931
- * <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the
2932
- * following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make
2933
- * sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p>
2934
- * </note>
2935
3079
  */
2936
3080
  HomeDirectoryMappings?: HomeDirectoryMapEntry[];
2937
3081
  /**
@@ -3122,7 +3266,22 @@ export interface UpdateServerRequest {
3122
3266
  * your CloudWatch logs.</p>
3123
3267
  */
3124
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
+ */
3125
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
+ */
3126
3285
  PreAuthenticationLoginBanner?: string;
3127
3286
  /**
3128
3287
  * <p>Specifies the file transfer protocol or protocols over which your file transfer protocol
@@ -3230,15 +3389,6 @@ export interface UpdateUserRequest {
3230
3389
  * <p>
3231
3390
  * <code>[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]</code>
3232
3391
  * </p>
3233
- *
3234
- * <note>
3235
- * <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is
3236
- * ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place
3237
- * holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of
3238
- * <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the
3239
- * following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make
3240
- * sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p>
3241
- * </note>
3242
3392
  */
3243
3393
  HomeDirectoryMappings?: HomeDirectoryMapEntry[];
3244
3394
  /**
@@ -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>;