@aws-sdk/client-transfer 3.299.0 → 3.301.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 (59) hide show
  1. package/dist-types/commands/CreateAccessCommand.d.ts +21 -0
  2. package/dist-types/commands/CreateAgreementCommand.d.ts +15 -0
  3. package/dist-types/commands/CreateConnectorCommand.d.ts +21 -0
  4. package/dist-types/commands/CreateProfileCommand.d.ts +13 -0
  5. package/dist-types/commands/CreateServerCommand.d.ts +61 -0
  6. package/dist-types/commands/CreateUserCommand.d.ts +28 -0
  7. package/dist-types/commands/CreateWorkflowCommand.d.ts +121 -0
  8. package/dist-types/commands/DeleteAccessCommand.d.ts +4 -0
  9. package/dist-types/commands/DeleteAgreementCommand.d.ts +4 -0
  10. package/dist-types/commands/DeleteCertificateCommand.d.ts +3 -0
  11. package/dist-types/commands/DeleteConnectorCommand.d.ts +3 -0
  12. package/dist-types/commands/DeleteHostKeyCommand.d.ts +4 -0
  13. package/dist-types/commands/DeleteProfileCommand.d.ts +3 -0
  14. package/dist-types/commands/DeleteServerCommand.d.ts +3 -0
  15. package/dist-types/commands/DeleteSshPublicKeyCommand.d.ts +5 -0
  16. package/dist-types/commands/DeleteUserCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteWorkflowCommand.d.ts +3 -0
  18. package/dist-types/commands/DescribeAccessCommand.d.ts +4 -0
  19. package/dist-types/commands/DescribeAgreementCommand.d.ts +4 -0
  20. package/dist-types/commands/DescribeCertificateCommand.d.ts +3 -0
  21. package/dist-types/commands/DescribeConnectorCommand.d.ts +3 -0
  22. package/dist-types/commands/DescribeExecutionCommand.d.ts +4 -0
  23. package/dist-types/commands/DescribeHostKeyCommand.d.ts +4 -0
  24. package/dist-types/commands/DescribeProfileCommand.d.ts +3 -0
  25. package/dist-types/commands/DescribeSecurityPolicyCommand.d.ts +3 -0
  26. package/dist-types/commands/DescribeServerCommand.d.ts +3 -0
  27. package/dist-types/commands/DescribeUserCommand.d.ts +4 -0
  28. package/dist-types/commands/DescribeWorkflowCommand.d.ts +3 -0
  29. package/dist-types/commands/ImportCertificateCommand.d.ts +15 -0
  30. package/dist-types/commands/ImportHostKeyCommand.d.ts +11 -0
  31. package/dist-types/commands/ImportSshPublicKeyCommand.d.ts +5 -0
  32. package/dist-types/commands/ListAccessesCommand.d.ts +5 -0
  33. package/dist-types/commands/ListAgreementsCommand.d.ts +5 -0
  34. package/dist-types/commands/ListCertificatesCommand.d.ts +4 -0
  35. package/dist-types/commands/ListConnectorsCommand.d.ts +4 -0
  36. package/dist-types/commands/ListExecutionsCommand.d.ts +5 -0
  37. package/dist-types/commands/ListHostKeysCommand.d.ts +5 -0
  38. package/dist-types/commands/ListProfilesCommand.d.ts +5 -0
  39. package/dist-types/commands/ListSecurityPoliciesCommand.d.ts +4 -0
  40. package/dist-types/commands/ListServersCommand.d.ts +4 -0
  41. package/dist-types/commands/ListTagsForResourceCommand.d.ts +5 -0
  42. package/dist-types/commands/ListUsersCommand.d.ts +5 -0
  43. package/dist-types/commands/ListWorkflowsCommand.d.ts +4 -0
  44. package/dist-types/commands/SendWorkflowStepStateCommand.d.ts +6 -0
  45. package/dist-types/commands/StartFileTransferCommand.d.ts +6 -0
  46. package/dist-types/commands/StartServerCommand.d.ts +3 -0
  47. package/dist-types/commands/StopServerCommand.d.ts +3 -0
  48. package/dist-types/commands/TagResourceCommand.d.ts +9 -0
  49. package/dist-types/commands/TestIdentityProviderCommand.d.ts +7 -0
  50. package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
  51. package/dist-types/commands/UpdateAccessCommand.d.ts +21 -0
  52. package/dist-types/commands/UpdateAgreementCommand.d.ts +10 -0
  53. package/dist-types/commands/UpdateCertificateCommand.d.ts +6 -0
  54. package/dist-types/commands/UpdateConnectorCommand.d.ts +16 -0
  55. package/dist-types/commands/UpdateHostKeyCommand.d.ts +5 -0
  56. package/dist-types/commands/UpdateProfileCommand.d.ts +6 -0
  57. package/dist-types/commands/UpdateServerCommand.d.ts +54 -0
  58. package/dist-types/commands/UpdateUserCommand.d.ts +21 -0
  59. package/package.json +8 -8
@@ -31,6 +31,27 @@ export interface CreateAccessCommandOutput extends CreateAccessResponse, __Metad
31
31
  * import { TransferClient, CreateAccessCommand } from "@aws-sdk/client-transfer"; // ES Modules import
32
32
  * // const { TransferClient, CreateAccessCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
33
33
  * const client = new TransferClient(config);
34
+ * const input = { // CreateAccessRequest
35
+ * HomeDirectory: "STRING_VALUE",
36
+ * HomeDirectoryType: "PATH" || "LOGICAL",
37
+ * HomeDirectoryMappings: [ // HomeDirectoryMappings
38
+ * { // HomeDirectoryMapEntry
39
+ * Entry: "STRING_VALUE", // required
40
+ * Target: "STRING_VALUE", // required
41
+ * },
42
+ * ],
43
+ * Policy: "STRING_VALUE",
44
+ * PosixProfile: { // PosixProfile
45
+ * Uid: Number("long"), // required
46
+ * Gid: Number("long"), // required
47
+ * SecondaryGids: [ // SecondaryGids
48
+ * Number("long"),
49
+ * ],
50
+ * },
51
+ * Role: "STRING_VALUE", // required
52
+ * ServerId: "STRING_VALUE", // required
53
+ * ExternalId: "STRING_VALUE", // required
54
+ * };
34
55
  * const command = new CreateAccessCommand(input);
35
56
  * const response = await client.send(command);
36
57
  * ```
@@ -31,6 +31,21 @@ export interface CreateAgreementCommandOutput extends CreateAgreementResponse, _
31
31
  * import { TransferClient, CreateAgreementCommand } from "@aws-sdk/client-transfer"; // ES Modules import
32
32
  * // const { TransferClient, CreateAgreementCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
33
33
  * const client = new TransferClient(config);
34
+ * const input = { // CreateAgreementRequest
35
+ * Description: "STRING_VALUE",
36
+ * ServerId: "STRING_VALUE", // required
37
+ * LocalProfileId: "STRING_VALUE", // required
38
+ * PartnerProfileId: "STRING_VALUE", // required
39
+ * BaseDirectory: "STRING_VALUE", // required
40
+ * AccessRole: "STRING_VALUE", // required
41
+ * Status: "ACTIVE" || "INACTIVE",
42
+ * Tags: [ // Tags
43
+ * { // Tag
44
+ * Key: "STRING_VALUE", // required
45
+ * Value: "STRING_VALUE", // required
46
+ * },
47
+ * ],
48
+ * };
34
49
  * const command = new CreateAgreementCommand(input);
35
50
  * const response = await client.send(command);
36
51
  * ```
@@ -28,6 +28,27 @@ export interface CreateConnectorCommandOutput extends CreateConnectorResponse, _
28
28
  * import { TransferClient, CreateConnectorCommand } from "@aws-sdk/client-transfer"; // ES Modules import
29
29
  * // const { TransferClient, CreateConnectorCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
30
30
  * const client = new TransferClient(config);
31
+ * const input = { // CreateConnectorRequest
32
+ * Url: "STRING_VALUE", // required
33
+ * As2Config: { // As2ConnectorConfig
34
+ * LocalProfileId: "STRING_VALUE",
35
+ * PartnerProfileId: "STRING_VALUE",
36
+ * MessageSubject: "STRING_VALUE",
37
+ * Compression: "ZLIB" || "DISABLED",
38
+ * EncryptionAlgorithm: "AES128_CBC" || "AES192_CBC" || "AES256_CBC" || "NONE",
39
+ * SigningAlgorithm: "SHA256" || "SHA384" || "SHA512" || "SHA1" || "NONE",
40
+ * MdnSigningAlgorithm: "SHA256" || "SHA384" || "SHA512" || "SHA1" || "NONE" || "DEFAULT",
41
+ * MdnResponse: "SYNC" || "NONE",
42
+ * },
43
+ * AccessRole: "STRING_VALUE", // required
44
+ * LoggingRole: "STRING_VALUE",
45
+ * Tags: [ // Tags
46
+ * { // Tag
47
+ * Key: "STRING_VALUE", // required
48
+ * Value: "STRING_VALUE", // required
49
+ * },
50
+ * ],
51
+ * };
31
52
  * const command = new CreateConnectorCommand(input);
32
53
  * const response = await client.send(command);
33
54
  * ```
@@ -26,6 +26,19 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met
26
26
  * import { TransferClient, CreateProfileCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, CreateProfileCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // CreateProfileRequest
30
+ * As2Id: "STRING_VALUE", // required
31
+ * ProfileType: "LOCAL" || "PARTNER", // required
32
+ * CertificateIds: [ // CertificateIds
33
+ * "STRING_VALUE",
34
+ * ],
35
+ * Tags: [ // Tags
36
+ * { // Tag
37
+ * Key: "STRING_VALUE", // required
38
+ * Value: "STRING_VALUE", // required
39
+ * },
40
+ * ],
41
+ * };
29
42
  * const command = new CreateProfileCommand(input);
30
43
  * const response = await client.send(command);
31
44
  * ```
@@ -29,6 +29,67 @@ export interface CreateServerCommandOutput extends CreateServerResponse, __Metad
29
29
  * import { TransferClient, CreateServerCommand } from "@aws-sdk/client-transfer"; // ES Modules import
30
30
  * // const { TransferClient, CreateServerCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
31
31
  * const client = new TransferClient(config);
32
+ * const input = { // CreateServerRequest
33
+ * Certificate: "STRING_VALUE",
34
+ * Domain: "S3" || "EFS",
35
+ * EndpointDetails: { // EndpointDetails
36
+ * AddressAllocationIds: [ // AddressAllocationIds
37
+ * "STRING_VALUE",
38
+ * ],
39
+ * SubnetIds: [ // SubnetIds
40
+ * "STRING_VALUE",
41
+ * ],
42
+ * VpcEndpointId: "STRING_VALUE",
43
+ * VpcId: "STRING_VALUE",
44
+ * SecurityGroupIds: [ // SecurityGroupIds
45
+ * "STRING_VALUE",
46
+ * ],
47
+ * },
48
+ * EndpointType: "PUBLIC" || "VPC" || "VPC_ENDPOINT",
49
+ * HostKey: "STRING_VALUE",
50
+ * IdentityProviderDetails: { // IdentityProviderDetails
51
+ * Url: "STRING_VALUE",
52
+ * InvocationRole: "STRING_VALUE",
53
+ * DirectoryId: "STRING_VALUE",
54
+ * Function: "STRING_VALUE",
55
+ * },
56
+ * IdentityProviderType: "SERVICE_MANAGED" || "API_GATEWAY" || "AWS_DIRECTORY_SERVICE" || "AWS_LAMBDA",
57
+ * LoggingRole: "STRING_VALUE",
58
+ * PostAuthenticationLoginBanner: "STRING_VALUE",
59
+ * PreAuthenticationLoginBanner: "STRING_VALUE",
60
+ * Protocols: [ // Protocols
61
+ * "SFTP" || "FTP" || "FTPS" || "AS2",
62
+ * ],
63
+ * ProtocolDetails: { // ProtocolDetails
64
+ * PassiveIp: "STRING_VALUE",
65
+ * TlsSessionResumptionMode: "DISABLED" || "ENABLED" || "ENFORCED",
66
+ * SetStatOption: "DEFAULT" || "ENABLE_NO_OP",
67
+ * As2Transports: [ // As2Transports
68
+ * "HTTP",
69
+ * ],
70
+ * },
71
+ * SecurityPolicyName: "STRING_VALUE",
72
+ * Tags: [ // Tags
73
+ * { // Tag
74
+ * Key: "STRING_VALUE", // required
75
+ * Value: "STRING_VALUE", // required
76
+ * },
77
+ * ],
78
+ * WorkflowDetails: { // WorkflowDetails
79
+ * OnUpload: [ // OnUploadWorkflowDetails
80
+ * { // WorkflowDetail
81
+ * WorkflowId: "STRING_VALUE", // required
82
+ * ExecutionRole: "STRING_VALUE", // required
83
+ * },
84
+ * ],
85
+ * OnPartialUpload: [ // OnPartialUploadWorkflowDetails
86
+ * {
87
+ * WorkflowId: "STRING_VALUE", // required
88
+ * ExecutionRole: "STRING_VALUE", // required
89
+ * },
90
+ * ],
91
+ * },
92
+ * };
32
93
  * const command = new CreateServerCommand(input);
33
94
  * const response = await client.send(command);
34
95
  * ```
@@ -32,6 +32,34 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
32
32
  * import { TransferClient, CreateUserCommand } from "@aws-sdk/client-transfer"; // ES Modules import
33
33
  * // const { TransferClient, CreateUserCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
34
34
  * const client = new TransferClient(config);
35
+ * const input = { // CreateUserRequest
36
+ * HomeDirectory: "STRING_VALUE",
37
+ * HomeDirectoryType: "PATH" || "LOGICAL",
38
+ * HomeDirectoryMappings: [ // HomeDirectoryMappings
39
+ * { // HomeDirectoryMapEntry
40
+ * Entry: "STRING_VALUE", // required
41
+ * Target: "STRING_VALUE", // required
42
+ * },
43
+ * ],
44
+ * Policy: "STRING_VALUE",
45
+ * PosixProfile: { // PosixProfile
46
+ * Uid: Number("long"), // required
47
+ * Gid: Number("long"), // required
48
+ * SecondaryGids: [ // SecondaryGids
49
+ * Number("long"),
50
+ * ],
51
+ * },
52
+ * Role: "STRING_VALUE", // required
53
+ * ServerId: "STRING_VALUE", // required
54
+ * SshPublicKeyBody: "STRING_VALUE",
55
+ * Tags: [ // Tags
56
+ * { // Tag
57
+ * Key: "STRING_VALUE", // required
58
+ * Value: "STRING_VALUE", // required
59
+ * },
60
+ * ],
61
+ * UserName: "STRING_VALUE", // required
62
+ * };
35
63
  * const command = new CreateUserCommand(input);
36
64
  * const response = await client.send(command);
37
65
  * ```
@@ -29,6 +29,127 @@ export interface CreateWorkflowCommandOutput extends CreateWorkflowResponse, __M
29
29
  * import { TransferClient, CreateWorkflowCommand } from "@aws-sdk/client-transfer"; // ES Modules import
30
30
  * // const { TransferClient, CreateWorkflowCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
31
31
  * const client = new TransferClient(config);
32
+ * const input = { // CreateWorkflowRequest
33
+ * Description: "STRING_VALUE",
34
+ * Steps: [ // WorkflowSteps // required
35
+ * { // WorkflowStep
36
+ * Type: "COPY" || "CUSTOM" || "TAG" || "DELETE" || "DECRYPT",
37
+ * CopyStepDetails: { // CopyStepDetails
38
+ * Name: "STRING_VALUE",
39
+ * DestinationFileLocation: { // InputFileLocation
40
+ * S3FileLocation: { // S3InputFileLocation
41
+ * Bucket: "STRING_VALUE",
42
+ * Key: "STRING_VALUE",
43
+ * },
44
+ * EfsFileLocation: { // EfsFileLocation
45
+ * FileSystemId: "STRING_VALUE",
46
+ * Path: "STRING_VALUE",
47
+ * },
48
+ * },
49
+ * OverwriteExisting: "TRUE" || "FALSE",
50
+ * SourceFileLocation: "STRING_VALUE",
51
+ * },
52
+ * CustomStepDetails: { // CustomStepDetails
53
+ * Name: "STRING_VALUE",
54
+ * Target: "STRING_VALUE",
55
+ * TimeoutSeconds: Number("int"),
56
+ * SourceFileLocation: "STRING_VALUE",
57
+ * },
58
+ * DeleteStepDetails: { // DeleteStepDetails
59
+ * Name: "STRING_VALUE",
60
+ * SourceFileLocation: "STRING_VALUE",
61
+ * },
62
+ * TagStepDetails: { // TagStepDetails
63
+ * Name: "STRING_VALUE",
64
+ * Tags: [ // S3Tags
65
+ * { // S3Tag
66
+ * Key: "STRING_VALUE", // required
67
+ * Value: "STRING_VALUE", // required
68
+ * },
69
+ * ],
70
+ * SourceFileLocation: "STRING_VALUE",
71
+ * },
72
+ * DecryptStepDetails: { // DecryptStepDetails
73
+ * Name: "STRING_VALUE",
74
+ * Type: "PGP", // required
75
+ * SourceFileLocation: "STRING_VALUE",
76
+ * OverwriteExisting: "TRUE" || "FALSE",
77
+ * DestinationFileLocation: {
78
+ * S3FileLocation: {
79
+ * Bucket: "STRING_VALUE",
80
+ * Key: "STRING_VALUE",
81
+ * },
82
+ * EfsFileLocation: {
83
+ * FileSystemId: "STRING_VALUE",
84
+ * Path: "STRING_VALUE",
85
+ * },
86
+ * },
87
+ * },
88
+ * },
89
+ * ],
90
+ * OnExceptionSteps: [
91
+ * {
92
+ * Type: "COPY" || "CUSTOM" || "TAG" || "DELETE" || "DECRYPT",
93
+ * CopyStepDetails: {
94
+ * Name: "STRING_VALUE",
95
+ * DestinationFileLocation: {
96
+ * S3FileLocation: {
97
+ * Bucket: "STRING_VALUE",
98
+ * Key: "STRING_VALUE",
99
+ * },
100
+ * EfsFileLocation: {
101
+ * FileSystemId: "STRING_VALUE",
102
+ * Path: "STRING_VALUE",
103
+ * },
104
+ * },
105
+ * OverwriteExisting: "TRUE" || "FALSE",
106
+ * SourceFileLocation: "STRING_VALUE",
107
+ * },
108
+ * CustomStepDetails: {
109
+ * Name: "STRING_VALUE",
110
+ * Target: "STRING_VALUE",
111
+ * TimeoutSeconds: Number("int"),
112
+ * SourceFileLocation: "STRING_VALUE",
113
+ * },
114
+ * DeleteStepDetails: {
115
+ * Name: "STRING_VALUE",
116
+ * SourceFileLocation: "STRING_VALUE",
117
+ * },
118
+ * TagStepDetails: {
119
+ * Name: "STRING_VALUE",
120
+ * Tags: [
121
+ * {
122
+ * Key: "STRING_VALUE", // required
123
+ * Value: "STRING_VALUE", // required
124
+ * },
125
+ * ],
126
+ * SourceFileLocation: "STRING_VALUE",
127
+ * },
128
+ * DecryptStepDetails: {
129
+ * Name: "STRING_VALUE",
130
+ * Type: "PGP", // required
131
+ * SourceFileLocation: "STRING_VALUE",
132
+ * OverwriteExisting: "TRUE" || "FALSE",
133
+ * DestinationFileLocation: {
134
+ * S3FileLocation: {
135
+ * Bucket: "STRING_VALUE",
136
+ * Key: "STRING_VALUE",
137
+ * },
138
+ * EfsFileLocation: {
139
+ * FileSystemId: "STRING_VALUE",
140
+ * Path: "STRING_VALUE",
141
+ * },
142
+ * },
143
+ * },
144
+ * },
145
+ * ],
146
+ * Tags: [ // Tags
147
+ * { // Tag
148
+ * Key: "STRING_VALUE", // required
149
+ * Value: "STRING_VALUE", // required
150
+ * },
151
+ * ],
152
+ * };
32
153
  * const command = new CreateWorkflowCommand(input);
33
154
  * const response = await client.send(command);
34
155
  * ```
@@ -27,6 +27,10 @@ export interface DeleteAccessCommandOutput extends __MetadataBearer {
27
27
  * import { TransferClient, DeleteAccessCommand } from "@aws-sdk/client-transfer"; // ES Modules import
28
28
  * // const { TransferClient, DeleteAccessCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
29
29
  * const client = new TransferClient(config);
30
+ * const input = { // DeleteAccessRequest
31
+ * ServerId: "STRING_VALUE", // required
32
+ * ExternalId: "STRING_VALUE", // required
33
+ * };
30
34
  * const command = new DeleteAccessCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -26,6 +26,10 @@ export interface DeleteAgreementCommandOutput extends __MetadataBearer {
26
26
  * import { TransferClient, DeleteAgreementCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, DeleteAgreementCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // DeleteAgreementRequest
30
+ * AgreementId: "STRING_VALUE", // required
31
+ * ServerId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteAgreementCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -27,6 +27,9 @@ export interface DeleteCertificateCommandOutput extends __MetadataBearer {
27
27
  * import { TransferClient, DeleteCertificateCommand } from "@aws-sdk/client-transfer"; // ES Modules import
28
28
  * // const { TransferClient, DeleteCertificateCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
29
29
  * const client = new TransferClient(config);
30
+ * const input = { // DeleteCertificateRequest
31
+ * CertificateId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DeleteCertificateCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -26,6 +26,9 @@ export interface DeleteConnectorCommandOutput extends __MetadataBearer {
26
26
  * import { TransferClient, DeleteConnectorCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, DeleteConnectorCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // DeleteConnectorRequest
30
+ * ConnectorId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DeleteConnectorCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface DeleteHostKeyCommandOutput extends __MetadataBearer {
26
26
  * import { TransferClient, DeleteHostKeyCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, DeleteHostKeyCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // DeleteHostKeyRequest
30
+ * ServerId: "STRING_VALUE", // required
31
+ * HostKeyId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteHostKeyCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,9 @@ export interface DeleteProfileCommandOutput extends __MetadataBearer {
26
26
  * import { TransferClient, DeleteProfileCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, DeleteProfileCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // DeleteProfileRequest
30
+ * ProfileId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DeleteProfileCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -27,6 +27,9 @@ export interface DeleteServerCommandOutput extends __MetadataBearer {
27
27
  * import { TransferClient, DeleteServerCommand } from "@aws-sdk/client-transfer"; // ES Modules import
28
28
  * // const { TransferClient, DeleteServerCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
29
29
  * const client = new TransferClient(config);
30
+ * const input = { // DeleteServerRequest
31
+ * ServerId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DeleteServerCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -26,6 +26,11 @@ export interface DeleteSshPublicKeyCommandOutput extends __MetadataBearer {
26
26
  * import { TransferClient, DeleteSshPublicKeyCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, DeleteSshPublicKeyCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // DeleteSshPublicKeyRequest
30
+ * ServerId: "STRING_VALUE", // required
31
+ * SshPublicKeyId: "STRING_VALUE", // required
32
+ * UserName: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new DeleteSshPublicKeyCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -30,6 +30,10 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
30
30
  * import { TransferClient, DeleteUserCommand } from "@aws-sdk/client-transfer"; // ES Modules import
31
31
  * // const { TransferClient, DeleteUserCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
32
32
  * const client = new TransferClient(config);
33
+ * const input = { // DeleteUserRequest
34
+ * ServerId: "STRING_VALUE", // required
35
+ * UserName: "STRING_VALUE", // required
36
+ * };
33
37
  * const command = new DeleteUserCommand(input);
34
38
  * const response = await client.send(command);
35
39
  * ```
@@ -26,6 +26,9 @@ export interface DeleteWorkflowCommandOutput extends __MetadataBearer {
26
26
  * import { TransferClient, DeleteWorkflowCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, DeleteWorkflowCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // DeleteWorkflowRequest
30
+ * WorkflowId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DeleteWorkflowCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -30,6 +30,10 @@ export interface DescribeAccessCommandOutput extends DescribeAccessResponse, __M
30
30
  * import { TransferClient, DescribeAccessCommand } from "@aws-sdk/client-transfer"; // ES Modules import
31
31
  * // const { TransferClient, DescribeAccessCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
32
32
  * const client = new TransferClient(config);
33
+ * const input = { // DescribeAccessRequest
34
+ * ServerId: "STRING_VALUE", // required
35
+ * ExternalId: "STRING_VALUE", // required
36
+ * };
33
37
  * const command = new DescribeAccessCommand(input);
34
38
  * const response = await client.send(command);
35
39
  * ```
@@ -26,6 +26,10 @@ export interface DescribeAgreementCommandOutput extends DescribeAgreementRespons
26
26
  * import { TransferClient, DescribeAgreementCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, DescribeAgreementCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // DescribeAgreementRequest
30
+ * AgreementId: "STRING_VALUE", // required
31
+ * ServerId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DescribeAgreementCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,9 @@ export interface DescribeCertificateCommandOutput extends DescribeCertificateRes
26
26
  * import { TransferClient, DescribeCertificateCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, DescribeCertificateCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // DescribeCertificateRequest
30
+ * CertificateId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DescribeCertificateCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -27,6 +27,9 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
27
27
  * import { TransferClient, DescribeConnectorCommand } from "@aws-sdk/client-transfer"; // ES Modules import
28
28
  * // const { TransferClient, DescribeConnectorCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
29
29
  * const client = new TransferClient(config);
30
+ * const input = { // DescribeConnectorRequest
31
+ * ConnectorId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DescribeConnectorCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -26,6 +26,10 @@ export interface DescribeExecutionCommandOutput extends DescribeExecutionRespons
26
26
  * import { TransferClient, DescribeExecutionCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, DescribeExecutionCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // DescribeExecutionRequest
30
+ * ExecutionId: "STRING_VALUE", // required
31
+ * WorkflowId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DescribeExecutionCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface DescribeHostKeyCommandOutput extends DescribeHostKeyResponse, _
26
26
  * import { TransferClient, DescribeHostKeyCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, DescribeHostKeyCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // DescribeHostKeyRequest
30
+ * ServerId: "STRING_VALUE", // required
31
+ * HostKeyId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DescribeHostKeyCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,9 @@ export interface DescribeProfileCommandOutput extends DescribeProfileResponse, _
26
26
  * import { TransferClient, DescribeProfileCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, DescribeProfileCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // DescribeProfileRequest
30
+ * ProfileId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DescribeProfileCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -29,6 +29,9 @@ export interface DescribeSecurityPolicyCommandOutput extends DescribeSecurityPol
29
29
  * import { TransferClient, DescribeSecurityPolicyCommand } from "@aws-sdk/client-transfer"; // ES Modules import
30
30
  * // const { TransferClient, DescribeSecurityPolicyCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
31
31
  * const client = new TransferClient(config);
32
+ * const input = { // DescribeSecurityPolicyRequest
33
+ * SecurityPolicyName: "STRING_VALUE", // required
34
+ * };
32
35
  * const command = new DescribeSecurityPolicyCommand(input);
33
36
  * const response = await client.send(command);
34
37
  * ```
@@ -30,6 +30,9 @@ export interface DescribeServerCommandOutput extends DescribeServerResponse, __M
30
30
  * import { TransferClient, DescribeServerCommand } from "@aws-sdk/client-transfer"; // ES Modules import
31
31
  * // const { TransferClient, DescribeServerCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
32
32
  * const client = new TransferClient(config);
33
+ * const input = { // DescribeServerRequest
34
+ * ServerId: "STRING_VALUE", // required
35
+ * };
33
36
  * const command = new DescribeServerCommand(input);
34
37
  * const response = await client.send(command);
35
38
  * ```
@@ -29,6 +29,10 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad
29
29
  * import { TransferClient, DescribeUserCommand } from "@aws-sdk/client-transfer"; // ES Modules import
30
30
  * // const { TransferClient, DescribeUserCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
31
31
  * const client = new TransferClient(config);
32
+ * const input = { // DescribeUserRequest
33
+ * ServerId: "STRING_VALUE", // required
34
+ * UserName: "STRING_VALUE", // required
35
+ * };
32
36
  * const command = new DescribeUserCommand(input);
33
37
  * const response = await client.send(command);
34
38
  * ```
@@ -26,6 +26,9 @@ export interface DescribeWorkflowCommandOutput extends DescribeWorkflowResponse,
26
26
  * import { TransferClient, DescribeWorkflowCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, DescribeWorkflowCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // DescribeWorkflowRequest
30
+ * WorkflowId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DescribeWorkflowCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -28,6 +28,21 @@ export interface ImportCertificateCommandOutput extends ImportCertificateRespons
28
28
  * import { TransferClient, ImportCertificateCommand } from "@aws-sdk/client-transfer"; // ES Modules import
29
29
  * // const { TransferClient, ImportCertificateCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
30
30
  * const client = new TransferClient(config);
31
+ * const input = { // ImportCertificateRequest
32
+ * Usage: "SIGNING" || "ENCRYPTION", // required
33
+ * Certificate: "STRING_VALUE", // required
34
+ * CertificateChain: "STRING_VALUE",
35
+ * PrivateKey: "STRING_VALUE",
36
+ * ActiveDate: new Date("TIMESTAMP"),
37
+ * InactiveDate: new Date("TIMESTAMP"),
38
+ * Description: "STRING_VALUE",
39
+ * Tags: [ // Tags
40
+ * { // Tag
41
+ * Key: "STRING_VALUE", // required
42
+ * Value: "STRING_VALUE", // required
43
+ * },
44
+ * ],
45
+ * };
31
46
  * const command = new ImportCertificateCommand(input);
32
47
  * const response = await client.send(command);
33
48
  * ```
@@ -27,6 +27,17 @@ export interface ImportHostKeyCommandOutput extends ImportHostKeyResponse, __Met
27
27
  * import { TransferClient, ImportHostKeyCommand } from "@aws-sdk/client-transfer"; // ES Modules import
28
28
  * // const { TransferClient, ImportHostKeyCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
29
29
  * const client = new TransferClient(config);
30
+ * const input = { // ImportHostKeyRequest
31
+ * ServerId: "STRING_VALUE", // required
32
+ * HostKeyBody: "STRING_VALUE", // required
33
+ * Description: "STRING_VALUE",
34
+ * Tags: [ // Tags
35
+ * { // Tag
36
+ * Key: "STRING_VALUE", // required
37
+ * Value: "STRING_VALUE", // required
38
+ * },
39
+ * ],
40
+ * };
30
41
  * const command = new ImportHostKeyCommand(input);
31
42
  * const response = await client.send(command);
32
43
  * ```
@@ -30,6 +30,11 @@ export interface ImportSshPublicKeyCommandOutput extends ImportSshPublicKeyRespo
30
30
  * import { TransferClient, ImportSshPublicKeyCommand } from "@aws-sdk/client-transfer"; // ES Modules import
31
31
  * // const { TransferClient, ImportSshPublicKeyCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
32
32
  * const client = new TransferClient(config);
33
+ * const input = { // ImportSshPublicKeyRequest
34
+ * ServerId: "STRING_VALUE", // required
35
+ * SshPublicKeyBody: "STRING_VALUE", // required
36
+ * UserName: "STRING_VALUE", // required
37
+ * };
33
38
  * const command = new ImportSshPublicKeyCommand(input);
34
39
  * const response = await client.send(command);
35
40
  * ```
@@ -26,6 +26,11 @@ export interface ListAccessesCommandOutput extends ListAccessesResponse, __Metad
26
26
  * import { TransferClient, ListAccessesCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, ListAccessesCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // ListAccessesRequest
30
+ * MaxResults: Number("int"),
31
+ * NextToken: "STRING_VALUE",
32
+ * ServerId: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new ListAccessesCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -30,6 +30,11 @@ export interface ListAgreementsCommandOutput extends ListAgreementsResponse, __M
30
30
  * import { TransferClient, ListAgreementsCommand } from "@aws-sdk/client-transfer"; // ES Modules import
31
31
  * // const { TransferClient, ListAgreementsCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
32
32
  * const client = new TransferClient(config);
33
+ * const input = { // ListAgreementsRequest
34
+ * MaxResults: Number("int"),
35
+ * NextToken: "STRING_VALUE",
36
+ * ServerId: "STRING_VALUE", // required
37
+ * };
33
38
  * const command = new ListAgreementsCommand(input);
34
39
  * const response = await client.send(command);
35
40
  * ```
@@ -30,6 +30,10 @@ export interface ListCertificatesCommandOutput extends ListCertificatesResponse,
30
30
  * import { TransferClient, ListCertificatesCommand } from "@aws-sdk/client-transfer"; // ES Modules import
31
31
  * // const { TransferClient, ListCertificatesCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
32
32
  * const client = new TransferClient(config);
33
+ * const input = { // ListCertificatesRequest
34
+ * MaxResults: Number("int"),
35
+ * NextToken: "STRING_VALUE",
36
+ * };
33
37
  * const command = new ListCertificatesCommand(input);
34
38
  * const response = await client.send(command);
35
39
  * ```
@@ -26,6 +26,10 @@ export interface ListConnectorsCommandOutput extends ListConnectorsResponse, __M
26
26
  * import { TransferClient, ListConnectorsCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, ListConnectorsCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // ListConnectorsRequest
30
+ * MaxResults: Number("int"),
31
+ * NextToken: "STRING_VALUE",
32
+ * };
29
33
  * const command = new ListConnectorsCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,11 @@ export interface ListExecutionsCommandOutput extends ListExecutionsResponse, __M
26
26
  * import { TransferClient, ListExecutionsCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, ListExecutionsCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // ListExecutionsRequest
30
+ * MaxResults: Number("int"),
31
+ * NextToken: "STRING_VALUE",
32
+ * WorkflowId: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new ListExecutionsCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -27,6 +27,11 @@ export interface ListHostKeysCommandOutput extends ListHostKeysResponse, __Metad
27
27
  * import { TransferClient, ListHostKeysCommand } from "@aws-sdk/client-transfer"; // ES Modules import
28
28
  * // const { TransferClient, ListHostKeysCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
29
29
  * const client = new TransferClient(config);
30
+ * const input = { // ListHostKeysRequest
31
+ * MaxResults: Number("int"),
32
+ * NextToken: "STRING_VALUE",
33
+ * ServerId: "STRING_VALUE", // required
34
+ * };
30
35
  * const command = new ListHostKeysCommand(input);
31
36
  * const response = await client.send(command);
32
37
  * ```
@@ -29,6 +29,11 @@ export interface ListProfilesCommandOutput extends ListProfilesResponse, __Metad
29
29
  * import { TransferClient, ListProfilesCommand } from "@aws-sdk/client-transfer"; // ES Modules import
30
30
  * // const { TransferClient, ListProfilesCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
31
31
  * const client = new TransferClient(config);
32
+ * const input = { // ListProfilesRequest
33
+ * MaxResults: Number("int"),
34
+ * NextToken: "STRING_VALUE",
35
+ * ProfileType: "LOCAL" || "PARTNER",
36
+ * };
32
37
  * const command = new ListProfilesCommand(input);
33
38
  * const response = await client.send(command);
34
39
  * ```
@@ -27,6 +27,10 @@ export interface ListSecurityPoliciesCommandOutput extends ListSecurityPoliciesR
27
27
  * import { TransferClient, ListSecurityPoliciesCommand } from "@aws-sdk/client-transfer"; // ES Modules import
28
28
  * // const { TransferClient, ListSecurityPoliciesCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
29
29
  * const client = new TransferClient(config);
30
+ * const input = { // ListSecurityPoliciesRequest
31
+ * MaxResults: Number("int"),
32
+ * NextToken: "STRING_VALUE",
33
+ * };
30
34
  * const command = new ListSecurityPoliciesCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -27,6 +27,10 @@ export interface ListServersCommandOutput extends ListServersResponse, __Metadat
27
27
  * import { TransferClient, ListServersCommand } from "@aws-sdk/client-transfer"; // ES Modules import
28
28
  * // const { TransferClient, ListServersCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
29
29
  * const client = new TransferClient(config);
30
+ * const input = { // ListServersRequest
31
+ * MaxResults: Number("int"),
32
+ * NextToken: "STRING_VALUE",
33
+ * };
30
34
  * const command = new ListServersCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -27,6 +27,11 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
27
27
  * import { TransferClient, ListTagsForResourceCommand } from "@aws-sdk/client-transfer"; // ES Modules import
28
28
  * // const { TransferClient, ListTagsForResourceCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
29
29
  * const client = new TransferClient(config);
30
+ * const input = { // ListTagsForResourceRequest
31
+ * Arn: "STRING_VALUE", // required
32
+ * MaxResults: Number("int"),
33
+ * NextToken: "STRING_VALUE",
34
+ * };
30
35
  * const command = new ListTagsForResourceCommand(input);
31
36
  * const response = await client.send(command);
32
37
  * ```
@@ -27,6 +27,11 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
27
27
  * import { TransferClient, ListUsersCommand } from "@aws-sdk/client-transfer"; // ES Modules import
28
28
  * // const { TransferClient, ListUsersCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
29
29
  * const client = new TransferClient(config);
30
+ * const input = { // ListUsersRequest
31
+ * MaxResults: Number("int"),
32
+ * NextToken: "STRING_VALUE",
33
+ * ServerId: "STRING_VALUE", // required
34
+ * };
30
35
  * const command = new ListUsersCommand(input);
31
36
  * const response = await client.send(command);
32
37
  * ```
@@ -26,6 +26,10 @@ export interface ListWorkflowsCommandOutput extends ListWorkflowsResponse, __Met
26
26
  * import { TransferClient, ListWorkflowsCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, ListWorkflowsCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // ListWorkflowsRequest
30
+ * MaxResults: Number("int"),
31
+ * NextToken: "STRING_VALUE",
32
+ * };
29
33
  * const command = new ListWorkflowsCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -30,6 +30,12 @@ export interface SendWorkflowStepStateCommandOutput extends SendWorkflowStepStat
30
30
  * import { TransferClient, SendWorkflowStepStateCommand } from "@aws-sdk/client-transfer"; // ES Modules import
31
31
  * // const { TransferClient, SendWorkflowStepStateCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
32
32
  * const client = new TransferClient(config);
33
+ * const input = { // SendWorkflowStepStateRequest
34
+ * WorkflowId: "STRING_VALUE", // required
35
+ * ExecutionId: "STRING_VALUE", // required
36
+ * Token: "STRING_VALUE", // required
37
+ * Status: "SUCCESS" || "FAILURE", // required
38
+ * };
33
39
  * const command = new SendWorkflowStepStateCommand(input);
34
40
  * const response = await client.send(command);
35
41
  * ```
@@ -27,6 +27,12 @@ export interface StartFileTransferCommandOutput extends StartFileTransferRespons
27
27
  * import { TransferClient, StartFileTransferCommand } from "@aws-sdk/client-transfer"; // ES Modules import
28
28
  * // const { TransferClient, StartFileTransferCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
29
29
  * const client = new TransferClient(config);
30
+ * const input = { // StartFileTransferRequest
31
+ * ConnectorId: "STRING_VALUE", // required
32
+ * SendFilePaths: [ // FilePaths // required
33
+ * "STRING_VALUE",
34
+ * ],
35
+ * };
30
36
  * const command = new StartFileTransferCommand(input);
31
37
  * const response = await client.send(command);
32
38
  * ```
@@ -32,6 +32,9 @@ export interface StartServerCommandOutput extends __MetadataBearer {
32
32
  * import { TransferClient, StartServerCommand } from "@aws-sdk/client-transfer"; // ES Modules import
33
33
  * // const { TransferClient, StartServerCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
34
34
  * const client = new TransferClient(config);
35
+ * const input = { // StartServerRequest
36
+ * ServerId: "STRING_VALUE", // required
37
+ * };
35
38
  * const command = new StartServerCommand(input);
36
39
  * const response = await client.send(command);
37
40
  * ```
@@ -37,6 +37,9 @@ export interface StopServerCommandOutput extends __MetadataBearer {
37
37
  * import { TransferClient, StopServerCommand } from "@aws-sdk/client-transfer"; // ES Modules import
38
38
  * // const { TransferClient, StopServerCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
39
39
  * const client = new TransferClient(config);
40
+ * const input = { // StopServerRequest
41
+ * ServerId: "STRING_VALUE", // required
42
+ * };
40
43
  * const command = new StopServerCommand(input);
41
44
  * const response = await client.send(command);
42
45
  * ```
@@ -28,6 +28,15 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
28
28
  * import { TransferClient, TagResourceCommand } from "@aws-sdk/client-transfer"; // ES Modules import
29
29
  * // const { TransferClient, TagResourceCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
30
30
  * const client = new TransferClient(config);
31
+ * const input = { // TagResourceRequest
32
+ * Arn: "STRING_VALUE", // required
33
+ * Tags: [ // Tags // required
34
+ * { // Tag
35
+ * Key: "STRING_VALUE", // required
36
+ * Value: "STRING_VALUE", // required
37
+ * },
38
+ * ],
39
+ * };
31
40
  * const command = new TagResourceCommand(input);
32
41
  * const response = await client.send(command);
33
42
  * ```
@@ -64,6 +64,13 @@ export interface TestIdentityProviderCommandOutput extends TestIdentityProviderR
64
64
  * import { TransferClient, TestIdentityProviderCommand } from "@aws-sdk/client-transfer"; // ES Modules import
65
65
  * // const { TransferClient, TestIdentityProviderCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
66
66
  * const client = new TransferClient(config);
67
+ * const input = { // TestIdentityProviderRequest
68
+ * ServerId: "STRING_VALUE", // required
69
+ * ServerProtocol: "SFTP" || "FTP" || "FTPS" || "AS2",
70
+ * SourceIp: "STRING_VALUE",
71
+ * UserName: "STRING_VALUE", // required
72
+ * UserPassword: "STRING_VALUE",
73
+ * };
67
74
  * const command = new TestIdentityProviderCommand(input);
68
75
  * const response = await client.send(command);
69
76
  * ```
@@ -28,6 +28,12 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
28
28
  * import { TransferClient, UntagResourceCommand } from "@aws-sdk/client-transfer"; // ES Modules import
29
29
  * // const { TransferClient, UntagResourceCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
30
30
  * const client = new TransferClient(config);
31
+ * const input = { // UntagResourceRequest
32
+ * Arn: "STRING_VALUE", // required
33
+ * TagKeys: [ // TagKeys // required
34
+ * "STRING_VALUE",
35
+ * ],
36
+ * };
31
37
  * const command = new UntagResourceCommand(input);
32
38
  * const response = await client.send(command);
33
39
  * ```
@@ -27,6 +27,27 @@ export interface UpdateAccessCommandOutput extends UpdateAccessResponse, __Metad
27
27
  * import { TransferClient, UpdateAccessCommand } from "@aws-sdk/client-transfer"; // ES Modules import
28
28
  * // const { TransferClient, UpdateAccessCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
29
29
  * const client = new TransferClient(config);
30
+ * const input = { // UpdateAccessRequest
31
+ * HomeDirectory: "STRING_VALUE",
32
+ * HomeDirectoryType: "PATH" || "LOGICAL",
33
+ * HomeDirectoryMappings: [ // HomeDirectoryMappings
34
+ * { // HomeDirectoryMapEntry
35
+ * Entry: "STRING_VALUE", // required
36
+ * Target: "STRING_VALUE", // required
37
+ * },
38
+ * ],
39
+ * Policy: "STRING_VALUE",
40
+ * PosixProfile: { // PosixProfile
41
+ * Uid: Number("long"), // required
42
+ * Gid: Number("long"), // required
43
+ * SecondaryGids: [ // SecondaryGids
44
+ * Number("long"),
45
+ * ],
46
+ * },
47
+ * Role: "STRING_VALUE",
48
+ * ServerId: "STRING_VALUE", // required
49
+ * ExternalId: "STRING_VALUE", // required
50
+ * };
30
51
  * const command = new UpdateAccessCommand(input);
31
52
  * const response = await client.send(command);
32
53
  * ```
@@ -28,6 +28,16 @@ export interface UpdateAgreementCommandOutput extends UpdateAgreementResponse, _
28
28
  * import { TransferClient, UpdateAgreementCommand } from "@aws-sdk/client-transfer"; // ES Modules import
29
29
  * // const { TransferClient, UpdateAgreementCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
30
30
  * const client = new TransferClient(config);
31
+ * const input = { // UpdateAgreementRequest
32
+ * AgreementId: "STRING_VALUE", // required
33
+ * ServerId: "STRING_VALUE", // required
34
+ * Description: "STRING_VALUE",
35
+ * Status: "ACTIVE" || "INACTIVE",
36
+ * LocalProfileId: "STRING_VALUE",
37
+ * PartnerProfileId: "STRING_VALUE",
38
+ * BaseDirectory: "STRING_VALUE",
39
+ * AccessRole: "STRING_VALUE",
40
+ * };
31
41
  * const command = new UpdateAgreementCommand(input);
32
42
  * const response = await client.send(command);
33
43
  * ```
@@ -26,6 +26,12 @@ export interface UpdateCertificateCommandOutput extends UpdateCertificateRespons
26
26
  * import { TransferClient, UpdateCertificateCommand } from "@aws-sdk/client-transfer"; // ES Modules import
27
27
  * // const { TransferClient, UpdateCertificateCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
28
28
  * const client = new TransferClient(config);
29
+ * const input = { // UpdateCertificateRequest
30
+ * CertificateId: "STRING_VALUE", // required
31
+ * ActiveDate: new Date("TIMESTAMP"),
32
+ * InactiveDate: new Date("TIMESTAMP"),
33
+ * Description: "STRING_VALUE",
34
+ * };
29
35
  * const command = new UpdateCertificateCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -28,6 +28,22 @@ export interface UpdateConnectorCommandOutput extends UpdateConnectorResponse, _
28
28
  * import { TransferClient, UpdateConnectorCommand } from "@aws-sdk/client-transfer"; // ES Modules import
29
29
  * // const { TransferClient, UpdateConnectorCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
30
30
  * const client = new TransferClient(config);
31
+ * const input = { // UpdateConnectorRequest
32
+ * ConnectorId: "STRING_VALUE", // required
33
+ * Url: "STRING_VALUE",
34
+ * As2Config: { // As2ConnectorConfig
35
+ * LocalProfileId: "STRING_VALUE",
36
+ * PartnerProfileId: "STRING_VALUE",
37
+ * MessageSubject: "STRING_VALUE",
38
+ * Compression: "ZLIB" || "DISABLED",
39
+ * EncryptionAlgorithm: "AES128_CBC" || "AES192_CBC" || "AES256_CBC" || "NONE",
40
+ * SigningAlgorithm: "SHA256" || "SHA384" || "SHA512" || "SHA1" || "NONE",
41
+ * MdnSigningAlgorithm: "SHA256" || "SHA384" || "SHA512" || "SHA1" || "NONE" || "DEFAULT",
42
+ * MdnResponse: "SYNC" || "NONE",
43
+ * },
44
+ * AccessRole: "STRING_VALUE",
45
+ * LoggingRole: "STRING_VALUE",
46
+ * };
31
47
  * const command = new UpdateConnectorCommand(input);
32
48
  * const response = await client.send(command);
33
49
  * ```
@@ -27,6 +27,11 @@ export interface UpdateHostKeyCommandOutput extends UpdateHostKeyResponse, __Met
27
27
  * import { TransferClient, UpdateHostKeyCommand } from "@aws-sdk/client-transfer"; // ES Modules import
28
28
  * // const { TransferClient, UpdateHostKeyCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
29
29
  * const client = new TransferClient(config);
30
+ * const input = { // UpdateHostKeyRequest
31
+ * ServerId: "STRING_VALUE", // required
32
+ * HostKeyId: "STRING_VALUE", // required
33
+ * Description: "STRING_VALUE", // required
34
+ * };
30
35
  * const command = new UpdateHostKeyCommand(input);
31
36
  * const response = await client.send(command);
32
37
  * ```
@@ -28,6 +28,12 @@ export interface UpdateProfileCommandOutput extends UpdateProfileResponse, __Met
28
28
  * import { TransferClient, UpdateProfileCommand } from "@aws-sdk/client-transfer"; // ES Modules import
29
29
  * // const { TransferClient, UpdateProfileCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
30
30
  * const client = new TransferClient(config);
31
+ * const input = { // UpdateProfileRequest
32
+ * ProfileId: "STRING_VALUE", // required
33
+ * CertificateIds: [ // CertificateIds
34
+ * "STRING_VALUE",
35
+ * ],
36
+ * };
31
37
  * const command = new UpdateProfileCommand(input);
32
38
  * const response = await client.send(command);
33
39
  * ```
@@ -29,6 +29,60 @@ export interface UpdateServerCommandOutput extends UpdateServerResponse, __Metad
29
29
  * import { TransferClient, UpdateServerCommand } from "@aws-sdk/client-transfer"; // ES Modules import
30
30
  * // const { TransferClient, UpdateServerCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
31
31
  * const client = new TransferClient(config);
32
+ * const input = { // UpdateServerRequest
33
+ * Certificate: "STRING_VALUE",
34
+ * ProtocolDetails: { // ProtocolDetails
35
+ * PassiveIp: "STRING_VALUE",
36
+ * TlsSessionResumptionMode: "DISABLED" || "ENABLED" || "ENFORCED",
37
+ * SetStatOption: "DEFAULT" || "ENABLE_NO_OP",
38
+ * As2Transports: [ // As2Transports
39
+ * "HTTP",
40
+ * ],
41
+ * },
42
+ * EndpointDetails: { // EndpointDetails
43
+ * AddressAllocationIds: [ // AddressAllocationIds
44
+ * "STRING_VALUE",
45
+ * ],
46
+ * SubnetIds: [ // SubnetIds
47
+ * "STRING_VALUE",
48
+ * ],
49
+ * VpcEndpointId: "STRING_VALUE",
50
+ * VpcId: "STRING_VALUE",
51
+ * SecurityGroupIds: [ // SecurityGroupIds
52
+ * "STRING_VALUE",
53
+ * ],
54
+ * },
55
+ * EndpointType: "PUBLIC" || "VPC" || "VPC_ENDPOINT",
56
+ * HostKey: "STRING_VALUE",
57
+ * IdentityProviderDetails: { // IdentityProviderDetails
58
+ * Url: "STRING_VALUE",
59
+ * InvocationRole: "STRING_VALUE",
60
+ * DirectoryId: "STRING_VALUE",
61
+ * Function: "STRING_VALUE",
62
+ * },
63
+ * LoggingRole: "STRING_VALUE",
64
+ * PostAuthenticationLoginBanner: "STRING_VALUE",
65
+ * PreAuthenticationLoginBanner: "STRING_VALUE",
66
+ * Protocols: [ // Protocols
67
+ * "SFTP" || "FTP" || "FTPS" || "AS2",
68
+ * ],
69
+ * SecurityPolicyName: "STRING_VALUE",
70
+ * ServerId: "STRING_VALUE", // required
71
+ * WorkflowDetails: { // WorkflowDetails
72
+ * OnUpload: [ // OnUploadWorkflowDetails
73
+ * { // WorkflowDetail
74
+ * WorkflowId: "STRING_VALUE", // required
75
+ * ExecutionRole: "STRING_VALUE", // required
76
+ * },
77
+ * ],
78
+ * OnPartialUpload: [ // OnPartialUploadWorkflowDetails
79
+ * {
80
+ * WorkflowId: "STRING_VALUE", // required
81
+ * ExecutionRole: "STRING_VALUE", // required
82
+ * },
83
+ * ],
84
+ * },
85
+ * };
32
86
  * const command = new UpdateServerCommand(input);
33
87
  * const response = await client.send(command);
34
88
  * ```
@@ -30,6 +30,27 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB
30
30
  * import { TransferClient, UpdateUserCommand } from "@aws-sdk/client-transfer"; // ES Modules import
31
31
  * // const { TransferClient, UpdateUserCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
32
32
  * const client = new TransferClient(config);
33
+ * const input = { // UpdateUserRequest
34
+ * HomeDirectory: "STRING_VALUE",
35
+ * HomeDirectoryType: "PATH" || "LOGICAL",
36
+ * HomeDirectoryMappings: [ // HomeDirectoryMappings
37
+ * { // HomeDirectoryMapEntry
38
+ * Entry: "STRING_VALUE", // required
39
+ * Target: "STRING_VALUE", // required
40
+ * },
41
+ * ],
42
+ * Policy: "STRING_VALUE",
43
+ * PosixProfile: { // PosixProfile
44
+ * Uid: Number("long"), // required
45
+ * Gid: Number("long"), // required
46
+ * SecondaryGids: [ // SecondaryGids
47
+ * Number("long"),
48
+ * ],
49
+ * },
50
+ * Role: "STRING_VALUE",
51
+ * ServerId: "STRING_VALUE", // required
52
+ * UserName: "STRING_VALUE", // required
53
+ * };
33
54
  * const command = new UpdateUserCommand(input);
34
55
  * const response = await client.send(command);
35
56
  * ```
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-transfer",
3
3
  "description": "AWS SDK for JavaScript Transfer Client for Node.js, Browser and React Native",
4
- "version": "3.299.0",
4
+ "version": "3.301.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.299.0",
25
- "@aws-sdk/config-resolver": "3.299.0",
26
- "@aws-sdk/credential-provider-node": "3.299.0",
24
+ "@aws-sdk/client-sts": "3.301.0",
25
+ "@aws-sdk/config-resolver": "3.300.0",
26
+ "@aws-sdk/credential-provider-node": "3.301.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.296.0",
28
28
  "@aws-sdk/hash-node": "3.296.0",
29
29
  "@aws-sdk/invalid-dependency": "3.296.0",
@@ -32,12 +32,12 @@
32
32
  "@aws-sdk/middleware-host-header": "3.296.0",
33
33
  "@aws-sdk/middleware-logger": "3.296.0",
34
34
  "@aws-sdk/middleware-recursion-detection": "3.296.0",
35
- "@aws-sdk/middleware-retry": "3.296.0",
35
+ "@aws-sdk/middleware-retry": "3.300.0",
36
36
  "@aws-sdk/middleware-serde": "3.296.0",
37
37
  "@aws-sdk/middleware-signing": "3.299.0",
38
38
  "@aws-sdk/middleware-stack": "3.296.0",
39
39
  "@aws-sdk/middleware-user-agent": "3.299.0",
40
- "@aws-sdk/node-config-provider": "3.296.0",
40
+ "@aws-sdk/node-config-provider": "3.300.0",
41
41
  "@aws-sdk/node-http-handler": "3.296.0",
42
42
  "@aws-sdk/protocol-http": "3.296.0",
43
43
  "@aws-sdk/smithy-client": "3.296.0",
@@ -47,11 +47,11 @@
47
47
  "@aws-sdk/util-body-length-browser": "3.295.0",
48
48
  "@aws-sdk/util-body-length-node": "3.295.0",
49
49
  "@aws-sdk/util-defaults-mode-browser": "3.296.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.299.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.300.0",
51
51
  "@aws-sdk/util-endpoints": "3.296.0",
52
52
  "@aws-sdk/util-retry": "3.296.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.299.0",
54
- "@aws-sdk/util-user-agent-node": "3.299.0",
54
+ "@aws-sdk/util-user-agent-node": "3.300.0",
55
55
  "@aws-sdk/util-utf8": "3.295.0",
56
56
  "@aws-sdk/util-waiter": "3.296.0",
57
57
  "tslib": "^2.5.0"