-
Notifications
You must be signed in to change notification settings - Fork 62
/
transfer.jl
2869 lines (2644 loc) · 117 KB
/
transfer.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: transfer
using AWS.Compat
using AWS.UUIDs
"""
create_access(external_id, role, server_id)
create_access(external_id, role, server_id, params::Dict{String,<:Any})
Used by administrators to choose which groups in the directory should have access to upload
and download files over the enabled protocols using Transfer Family. For example, a
Microsoft Active Directory might contain 50,000 users, but only a small fraction might need
the ability to transfer files to the server. An administrator can use CreateAccess to limit
the access to the correct set of users who need this ability.
# Arguments
- `external_id`: A unique identifier that is required to identify specific groups within
your directory. The users of the group that you associate have access to your Amazon S3 or
Amazon EFS resources over the enabled protocols using Transfer Family. If you know the
group name, you can view the SID values by running the following command using Windows
PowerShell. Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * |
Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of
your Active Directory group. The regular expression used to validate this parameter is a
string of characters consisting of uppercase and lowercase alphanumeric characters with no
spaces. You can also include underscores or any of the following characters: =,.@:/-
- `role`: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The
policies attached to this role determine the level of access that you want to provide your
users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file
system. The IAM role should also contain a trust relationship that allows the server to
access your resources when servicing your users' transfer requests.
- `server_id`: A system-assigned unique identifier for a server instance. This is the
specific server that you added your user to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HomeDirectory"`: The landing directory (folder) for a user when they log in to the
server using the client. A HomeDirectory example is /bucket_name/home/mydirectory.
- `"HomeDirectoryMappings"`: Logical directory mappings that specify what Amazon S3 or
Amazon EFS paths and keys should be visible to your user and how you want to make them
visible. You must specify the Entry and Target pair, where Entry shows how the path is made
visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a
target, it is displayed as is. You also must ensure that your Identity and Access
Management (IAM) role provides access to paths in Target. This value can be set only when
HomeDirectoryType is set to LOGICAL. The following is an Entry and Target pair example. [
{ \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ] In most
cases, you can use this value instead of the session policy to lock down your user to the
designated home directory (\"chroot\"). To do this, you can set Entry to / and set Target
to the HomeDirectory parameter value. The following is an Entry and Target pair example for
chroot. [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]
- `"HomeDirectoryType"`: The type of landing directory (folder) that you want your users'
home directory to be when they log in to the server. If you set it to PATH, the user will
see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol
clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings
for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
- `"Policy"`: A session policy for your user so that you can use the same Identity and
Access Management (IAM) role across multiple users. This policy scopes down a user's access
to portions of their Amazon S3 bucket. Variables that you can use inside this policy
include {Transfer:UserName}, {Transfer:HomeDirectory}, and {Transfer:HomeBucket}. This
policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use
session policies. For session policies, Transfer Family stores the policy as a JSON blob,
instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob
and pass it in the Policy argument. For an example of a session policy, see Example session
policy. For more information, see AssumeRole in the Security Token Service API Reference.
- `"PosixProfile"`:
"""
function create_access(
ExternalId, Role, ServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"CreateAccess",
Dict{String,Any}(
"ExternalId" => ExternalId, "Role" => Role, "ServerId" => ServerId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_access(
ExternalId,
Role,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"CreateAccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExternalId" => ExternalId, "Role" => Role, "ServerId" => ServerId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_agreement(access_role, base_directory, local_profile_id, partner_profile_id, server_id)
create_agreement(access_role, base_directory, local_profile_id, partner_profile_id, server_id, params::Dict{String,<:Any})
Creates an agreement. An agreement is a bilateral trading partner agreement, or
partnership, between an Transfer Family server and an AS2 process. The agreement defines
the file and message transfer relationship between the server and the AS2 process. To
define an agreement, Transfer Family combines a server, local profile, partner profile,
certificate, and other attributes. The partner is identified with the PartnerProfileId, and
the AS2 process is identified with the LocalProfileId.
# Arguments
- `access_role`: With AS2, you can send files by calling StartFileTransfer and specifying
the file paths in the request parameter, SendFilePaths. We use the file’s parent
directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is
/bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we
receive them from the partner, and write a final JSON file containing relevant metadata of
the transmission. So, the AccessRole needs to provide read and write access to the parent
directory of the file location used in the StartFileTransfer request. Additionally, you
need to provide read and write access to the parent directory of the files that you intend
to send with StartFileTransfer.
- `base_directory`: The landing directory (folder) for files transferred by using the AS2
protocol. A BaseDirectory example is /DOC-EXAMPLE-BUCKET/home/mydirectory.
- `local_profile_id`: A unique identifier for the AS2 local profile.
- `partner_profile_id`: A unique identifier for the partner profile used in the agreement.
- `server_id`: A system-assigned unique identifier for a server instance. This is the
specific server that the agreement uses.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A name or short description to identify the agreement.
- `"Status"`: The status of the agreement. The agreement can be either ACTIVE or INACTIVE.
- `"Tags"`: Key-value pairs that can be used to group and search for agreements.
"""
function create_agreement(
AccessRole,
BaseDirectory,
LocalProfileId,
PartnerProfileId,
ServerId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"CreateAgreement",
Dict{String,Any}(
"AccessRole" => AccessRole,
"BaseDirectory" => BaseDirectory,
"LocalProfileId" => LocalProfileId,
"PartnerProfileId" => PartnerProfileId,
"ServerId" => ServerId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_agreement(
AccessRole,
BaseDirectory,
LocalProfileId,
PartnerProfileId,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"CreateAgreement",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccessRole" => AccessRole,
"BaseDirectory" => BaseDirectory,
"LocalProfileId" => LocalProfileId,
"PartnerProfileId" => PartnerProfileId,
"ServerId" => ServerId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_connector(access_role, as2_config, url)
create_connector(access_role, as2_config, url, params::Dict{String,<:Any})
Creates the connector, which captures the parameters for an outbound connection for the AS2
protocol. The connector is required for sending files to an externally hosted AS2 server.
For more details about connectors, see Create AS2 connectors.
# Arguments
- `access_role`: With AS2, you can send files by calling StartFileTransfer and specifying
the file paths in the request parameter, SendFilePaths. We use the file’s parent
directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is
/bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we
receive them from the partner, and write a final JSON file containing relevant metadata of
the transmission. So, the AccessRole needs to provide read and write access to the parent
directory of the file location used in the StartFileTransfer request. Additionally, you
need to provide read and write access to the parent directory of the files that you intend
to send with StartFileTransfer.
- `as2_config`: A structure that contains the parameters for a connector object.
- `url`: The URL of the partner's AS2 endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LoggingRole"`: The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When
set, you can view connector activity in your CloudWatch logs.
- `"Tags"`: Key-value pairs that can be used to group and search for connectors. Tags are
metadata attached to connectors for any purpose.
"""
function create_connector(
AccessRole, As2Config, Url; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"CreateConnector",
Dict{String,Any}(
"AccessRole" => AccessRole, "As2Config" => As2Config, "Url" => Url
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connector(
AccessRole,
As2Config,
Url,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"CreateConnector",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccessRole" => AccessRole, "As2Config" => As2Config, "Url" => Url
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_profile(as2_id, profile_type)
create_profile(as2_id, profile_type, params::Dict{String,<:Any})
Creates the local or partner profile to use for AS2 transfers.
# Arguments
- `as2_id`: The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers,
this is the AS2-From header for the AS2 messages sent from the partner. For outbound
connectors, this is the AS2-To header for the AS2 messages sent to the partner using the
StartFileTransfer API operation. This ID cannot include spaces.
- `profile_type`: Determines the type of profile to create: Specify LOCAL to create a
local profile. A local profile represents the AS2-enabled Transfer Family server
organization or party. Specify PARTNER to create a partner profile. A partner profile
represents a remote organization, external to Transfer Family.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CertificateIds"`: An array of identifiers for the imported certificates. You use this
identifier for working with profiles and partner profiles.
- `"Tags"`: Key-value pairs that can be used to group and search for AS2 profiles.
"""
function create_profile(
As2Id, ProfileType; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"CreateProfile",
Dict{String,Any}("As2Id" => As2Id, "ProfileType" => ProfileType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_profile(
As2Id,
ProfileType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"CreateProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("As2Id" => As2Id, "ProfileType" => ProfileType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_server()
create_server(params::Dict{String,<:Any})
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in
Amazon Web Services. When you make updates to your file transfer protocol-enabled server or
when you work with users, use the service-generated ServerId property that is assigned to
the newly created server.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Certificate"`: The Amazon Resource Name (ARN) of the Certificate Manager (ACM)
certificate. Required when Protocols is set to FTPS. To request a new public certificate,
see Request a public certificate in the Certificate Manager User Guide. To import an
existing certificate into ACM, see Importing certificates into ACM in the Certificate
Manager User Guide. To request a private certificate to use FTPS through private IP
addresses, see Request a private certificate in the Certificate Manager User Guide.
Certificates with the following cryptographic algorithms and key sizes are supported:
2048-bit RSA (RSA_2048) 4096-bit RSA (RSA_4096) Elliptic Prime Curve 256 bit
(EC_prime256v1) Elliptic Prime Curve 384 bit (EC_secp384r1) Elliptic Prime Curve 521
bit (EC_secp521r1) The certificate must be a valid SSL/TLS X.509 version 3 certificate
with FQDN or IP address specified and information about the issuer.
- `"Domain"`: The domain of the storage system that is used for file transfers. There are
two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File
System (Amazon EFS). The default value is S3. After the server is created, the domain
cannot be changed.
- `"EndpointDetails"`: The virtual private cloud (VPC) endpoint settings that are
configured for your server. When you host your endpoint within your VPC, you can make your
endpoint accessible only to resources within your VPC, or you can attach Elastic IP
addresses and make your endpoint accessible to clients over the internet. Your VPC's
default security groups are automatically assigned to your endpoint.
- `"EndpointType"`: The type of endpoint that you want your server to use. You can choose
to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC.
With an endpoint that is hosted in a VPC, you can restrict access to your server and
resources only within your VPC or choose to make it internet facing by attaching Elastic IP
addresses directly to it. After May 19, 2021, you won't be able to create a server using
EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't
already done so before May 19, 2021. If you have already created servers with
EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021,
you will not be affected. After this date, use EndpointType=VPC. For more information, see
https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vp
c-endpoint. It is recommended that you use VPC as the EndpointType. With this endpoint
type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP
included) with your server's endpoint and use VPC security groups to restrict traffic by
the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
- `"HostKey"`: The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server.
You can add multiple host keys, in case you want to rotate keys, or have a set of active
keys that use different algorithms. Use the following command to generate an RSA 2048 bit
key with no passphrase: ssh-keygen -t rsa -b 2048 -N \"\" -m PEM -f my-new-server-key. Use
a minimum value of 2048 for the -b option. You can create a stronger key by using 3072 or
4096. Use the following command to generate an ECDSA 256 bit key with no passphrase:
ssh-keygen -t ecdsa -b 256 -N \"\" -m PEM -f my-new-server-key. Valid values for the -b
option for ECDSA are 256, 384, and 521. Use the following command to generate an ED25519
key with no passphrase: ssh-keygen -t ed25519 -N \"\" -f my-new-server-key. For all of
these commands, you can replace my-new-server-key with a string of your choice. If you
aren't planning to migrate existing users from an existing SFTP-enabled server to a new
server, don't update the host key. Accidentally changing a server's host key can be
disruptive. For more information, see Manage host keys for your SFTP-enabled server in the
Transfer Family User Guide.
- `"IdentityProviderDetails"`: Required when IdentityProviderType is set to
AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing all of the information
required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied
authentication API, including the API Gateway URL. Not required when IdentityProviderType
is set to SERVICE_MANAGED.
- `"IdentityProviderType"`: The mode of authentication for a server. The default value is
SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer
Family service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in
Directory Service for Microsoft Active Directory or Microsoft Active Directory in your
on-premises environment or in Amazon Web Services using AD Connector. This option also
requires you to provide a Directory ID by using the IdentityProviderDetails parameter. Use
the API_GATEWAY value to integrate with an identity provider of your choosing. The
API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for
authentication by using the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to
directly use an Lambda function as your identity provider. If you choose this value, you
must specify the ARN for the Lambda function in the Function parameter or the
IdentityProviderDetails data type.
- `"LoggingRole"`: The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or
Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
- `"PostAuthenticationLoginBanner"`: Specifies a string to display when users connect to a
server. This string is displayed after the user authenticates. The SFTP protocol does not
support post-authentication display banners.
- `"PreAuthenticationLoginBanner"`: Specifies a string to display when users connect to a
server. This string is displayed before the user authenticates. For example, the following
banner displays details about using the system: This system is for the use of authorized
users only. Individuals using this computer system without authority, or in excess of their
authority, are subject to having all of their activities on this system monitored and
recorded by system personnel.
- `"ProtocolDetails"`: The protocol settings that are configured for your server. To
indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a
single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or
load balancer. To ignore the error that is generated when the client attempts to use the
SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the
SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and
upload files without needing to make any changes to your SFTP client, set the value to
ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family
generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client
is making a SETSTAT call. To determine whether your Transfer Family server resumes
recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode
parameter. As2Transports indicates the transport method for the AS2 messages. Currently,
only HTTP is supported.
- `"Protocols"`: Specifies the file transfer protocol or protocols over which your file
transfer protocol client can connect to your server's endpoint. The available protocols
are: SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption FTP (File Transfer
Protocol): Unencrypted file transfer AS2 (Applicability Statement 2): used for
transporting structured business-to-business data If you select FTPS, you must choose
a certificate stored in Certificate Manager (ACM) which is used to identify your server
when clients connect to it over FTPS. If Protocol includes either FTP or FTPS, then the
EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE,
AWS_LAMBDA, or API_GATEWAY. If Protocol includes FTP, then AddressAllocationIds cannot be
associated. If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and
the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED,
AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY. If Protocol includes AS2, then the
EndpointType must be VPC, and domain must be Amazon S3.
- `"SecurityPolicyName"`: Specifies the name of the security policy that is attached to the
server.
- `"Tags"`: Key-value pairs that can be used to group and search for servers.
- `"WorkflowDetails"`: Specifies the workflow ID for the workflow to assign and the
execution role that's used for executing the workflow. In addition to a workflow to execute
when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and
execution role) for a workflow to execute on partial upload. A partial upload occurs when a
file is open when the session disconnects.
"""
function create_server(; aws_config::AbstractAWSConfig=global_aws_config())
return transfer("CreateServer"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function create_server(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"CreateServer", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
create_user(role, server_id, user_name)
create_user(role, server_id, user_name, params::Dict{String,<:Any})
Creates a user and associates them with an existing file transfer protocol-enabled server.
You can only create and associate users with servers that have the IdentityProviderType set
to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the
home directory, store the user's public key, and assign the user's Identity and Access
Management (IAM) role. You can also optionally add a session policy, and assign metadata
with tags that can be used to group and search for users.
# Arguments
- `role`: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The
policies attached to this role determine the level of access that you want to provide your
users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file
system. The IAM role should also contain a trust relationship that allows the server to
access your resources when servicing your users' transfer requests.
- `server_id`: A system-assigned unique identifier for a server instance. This is the
specific server that you added your user to.
- `user_name`: A unique string that identifies a user and is associated with a ServerId.
This user name must be a minimum of 3 and a maximum of 100 characters long. The following
are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign
'@'. The user name can't start with a hyphen, period, or at sign.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HomeDirectory"`: The landing directory (folder) for a user when they log in to the
server using the client. A HomeDirectory example is /bucket_name/home/mydirectory.
- `"HomeDirectoryMappings"`: Logical directory mappings that specify what Amazon S3 or
Amazon EFS paths and keys should be visible to your user and how you want to make them
visible. You must specify the Entry and Target pair, where Entry shows how the path is made
visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a
target, it is displayed as is. You also must ensure that your Identity and Access
Management (IAM) role provides access to paths in Target. This value can be set only when
HomeDirectoryType is set to LOGICAL. The following is an Entry and Target pair example. [
{ \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ] In most
cases, you can use this value instead of the session policy to lock your user down to the
designated home directory (\"chroot\"). To do this, you can set Entry to / and set Target
to the HomeDirectory parameter value. The following is an Entry and Target pair example for
chroot. [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]
- `"HomeDirectoryType"`: The type of landing directory (folder) that you want your users'
home directory to be when they log in to the server. If you set it to PATH, the user will
see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol
clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings
for how you want to make Amazon S3 or Amazon EFS paths visible to your users.
- `"Policy"`: A session policy for your user so that you can use the same Identity and
Access Management (IAM) role across multiple users. This policy scopes down a user's access
to portions of their Amazon S3 bucket. Variables that you can use inside this policy
include {Transfer:UserName}, {Transfer:HomeDirectory}, and {Transfer:HomeBucket}. This
policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use
session policies. For session policies, Transfer Family stores the policy as a JSON blob,
instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob
and pass it in the Policy argument. For an example of a session policy, see Example session
policy. For more information, see AssumeRole in the Amazon Web Services Security Token
Service API Reference.
- `"PosixProfile"`: Specifies the full POSIX identity, including user ID (Uid), group ID
(Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to
your Amazon EFS file systems. The POSIX permissions that are set on files and directories
in Amazon EFS determine the level of access your users get when transferring files into and
out of your Amazon EFS file systems.
- `"SshPublicKeyBody"`: The public portion of the Secure Shell (SSH) key used to
authenticate the user to the server. The three standard SSH public key format elements are
<key type>, <body base64>, and an optional <comment>, with spaces between
each element. Transfer Family accepts RSA, ECDSA, and ED25519 keys. For RSA keys, the key
type is ssh-rsa. For ED25519 keys, the key type is ssh-ed25519. For ECDSA keys, the key
type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending
on the size of the key you generated.
- `"Tags"`: Key-value pairs that can be used to group and search for users. Tags are
metadata attached to users for any purpose.
"""
function create_user(
Role, ServerId, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"CreateUser",
Dict{String,Any}("Role" => Role, "ServerId" => ServerId, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user(
Role,
ServerId,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"CreateUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Role" => Role, "ServerId" => ServerId, "UserName" => UserName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workflow(steps)
create_workflow(steps, params::Dict{String,<:Any})
Allows you to create a workflow with specified steps and step details the workflow invokes
after file transfer completes. After creating a workflow, you can associate the workflow
created with any transfer servers by specifying the workflow-details field in CreateServer
and UpdateServer operations.
# Arguments
- `steps`: Specifies the details for the steps that are in the specified workflow. The
TYPE specifies which of the following actions is being taken for this step. COPY -
Copy the file to another location. CUSTOM - Perform a custom step with an Lambda
function target. DECRYPT - Decrypt a file that was encrypted before it was uploaded.
DELETE - Delete the file. TAG - Add a tag to the file. Currently, copying and
tagging are supported only on S3. For file location, you specify either the Amazon S3
bucket and key, or the Amazon EFS file system ID and path.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A textual description for the workflow.
- `"OnExceptionSteps"`: Specifies the steps (actions) to take if errors are encountered
during execution of the workflow. For custom steps, the lambda function needs to send
FAILURE to the call back API to kick off the exception steps. Additionally, if the lambda
does not send SUCCESS before it times out, the exception steps are executed.
- `"Tags"`: Key-value pairs that can be used to group and search for workflows. Tags are
metadata attached to workflows for any purpose.
"""
function create_workflow(Steps; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"CreateWorkflow",
Dict{String,Any}("Steps" => Steps);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workflow(
Steps, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"CreateWorkflow",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Steps" => Steps), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access(external_id, server_id)
delete_access(external_id, server_id, params::Dict{String,<:Any})
Allows you to delete the access specified in the ServerID and ExternalID parameters.
# Arguments
- `external_id`: A unique identifier that is required to identify specific groups within
your directory. The users of the group that you associate have access to your Amazon S3 or
Amazon EFS resources over the enabled protocols using Transfer Family. If you know the
group name, you can view the SID values by running the following command using Windows
PowerShell. Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * |
Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of
your Active Directory group. The regular expression used to validate this parameter is a
string of characters consisting of uppercase and lowercase alphanumeric characters with no
spaces. You can also include underscores or any of the following characters: =,.@:/-
- `server_id`: A system-assigned unique identifier for a server that has this user assigned.
"""
function delete_access(
ExternalId, ServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DeleteAccess",
Dict{String,Any}("ExternalId" => ExternalId, "ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access(
ExternalId,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteAccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ExternalId" => ExternalId, "ServerId" => ServerId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_agreement(agreement_id, server_id)
delete_agreement(agreement_id, server_id, params::Dict{String,<:Any})
Delete the agreement that's specified in the provided AgreementId.
# Arguments
- `agreement_id`: A unique identifier for the agreement. This identifier is returned when
you create an agreement.
- `server_id`: The server identifier associated with the agreement that you are deleting.
"""
function delete_agreement(
AgreementId, ServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DeleteAgreement",
Dict{String,Any}("AgreementId" => AgreementId, "ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_agreement(
AgreementId,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteAgreement",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AgreementId" => AgreementId, "ServerId" => ServerId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_certificate(certificate_id)
delete_certificate(certificate_id, params::Dict{String,<:Any})
Deletes the certificate that's specified in the CertificateId parameter.
# Arguments
- `certificate_id`: The identifier of the certificate object that you are deleting.
"""
function delete_certificate(
CertificateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DeleteCertificate",
Dict{String,Any}("CertificateId" => CertificateId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_certificate(
CertificateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteCertificate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CertificateId" => CertificateId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_connector(connector_id)
delete_connector(connector_id, params::Dict{String,<:Any})
Deletes the agreement that's specified in the provided ConnectorId.
# Arguments
- `connector_id`: The unique identifier for the connector.
"""
function delete_connector(ConnectorId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"DeleteConnector",
Dict{String,Any}("ConnectorId" => ConnectorId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_connector(
ConnectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteConnector",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConnectorId" => ConnectorId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_host_key(host_key_id, server_id)
delete_host_key(host_key_id, server_id, params::Dict{String,<:Any})
Deletes the host key that's specified in the HoskKeyId parameter.
# Arguments
- `host_key_id`: The identifier of the host key that you are deleting.
- `server_id`: The identifier of the server that contains the host key that you are
deleting.
"""
function delete_host_key(
HostKeyId, ServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DeleteHostKey",
Dict{String,Any}("HostKeyId" => HostKeyId, "ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_host_key(
HostKeyId,
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteHostKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("HostKeyId" => HostKeyId, "ServerId" => ServerId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_profile(profile_id)
delete_profile(profile_id, params::Dict{String,<:Any})
Deletes the profile that's specified in the ProfileId parameter.
# Arguments
- `profile_id`: The identifier of the profile that you are deleting.
"""
function delete_profile(ProfileId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"DeleteProfile",
Dict{String,Any}("ProfileId" => ProfileId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_profile(
ProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteProfile",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProfileId" => ProfileId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_server(server_id)
delete_server(server_id, params::Dict{String,<:Any})
Deletes the file transfer protocol-enabled server that you specify. No response returns
from this operation.
# Arguments
- `server_id`: A unique system-assigned identifier for a server instance.
"""
function delete_server(ServerId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"DeleteServer",
Dict{String,Any}("ServerId" => ServerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_server(
ServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteServer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServerId" => ServerId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_ssh_public_key(server_id, ssh_public_key_id, user_name)
delete_ssh_public_key(server_id, ssh_public_key_id, user_name, params::Dict{String,<:Any})
Deletes a user's Secure Shell (SSH) public key.
# Arguments
- `server_id`: A system-assigned unique identifier for a file transfer protocol-enabled
server instance that has the user assigned to it.
- `ssh_public_key_id`: A unique identifier used to reference your user's specific SSH key.
- `user_name`: A unique string that identifies a user whose public key is being deleted.
"""
function delete_ssh_public_key(
ServerId, SshPublicKeyId, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return transfer(
"DeleteSshPublicKey",
Dict{String,Any}(
"ServerId" => ServerId,
"SshPublicKeyId" => SshPublicKeyId,
"UserName" => UserName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_ssh_public_key(
ServerId,
SshPublicKeyId,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteSshPublicKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ServerId" => ServerId,
"SshPublicKeyId" => SshPublicKeyId,
"UserName" => UserName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user(server_id, user_name)
delete_user(server_id, user_name, params::Dict{String,<:Any})
Deletes the user belonging to a file transfer protocol-enabled server you specify. No
response returns from this operation. When you delete a user from a server, the user's
information is lost.
# Arguments
- `server_id`: A system-assigned unique identifier for a server instance that has the user
assigned to it.
- `user_name`: A unique string that identifies a user that is being deleted from a server.
"""
function delete_user(ServerId, UserName; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"DeleteUser",
Dict{String,Any}("ServerId" => ServerId, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user(
ServerId,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ServerId" => ServerId, "UserName" => UserName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workflow(workflow_id)
delete_workflow(workflow_id, params::Dict{String,<:Any})
Deletes the specified workflow.
# Arguments
- `workflow_id`: A unique identifier for the workflow.
"""
function delete_workflow(WorkflowId; aws_config::AbstractAWSConfig=global_aws_config())
return transfer(
"DeleteWorkflow",
Dict{String,Any}("WorkflowId" => WorkflowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workflow(
WorkflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return transfer(
"DeleteWorkflow",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("WorkflowId" => WorkflowId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_access(external_id, server_id)
describe_access(external_id, server_id, params::Dict{String,<:Any})
Describes the access that is assigned to the specific file transfer protocol-enabled
server, as identified by its ServerId property and its ExternalId. The response from this
call returns the properties of the access that is associated with the ServerId value that
was specified.
# Arguments
- `external_id`: A unique identifier that is required to identify specific groups within
your directory. The users of the group that you associate have access to your Amazon S3 or
Amazon EFS resources over the enabled protocols using Transfer Family. If you know the
group name, you can view the SID values by running the following command using Windows
PowerShell. Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * |
Select SamAccountName,ObjectSid In that command, replace YourGroupName with the name of
your Active Directory group. The regular expression used to validate this parameter is a