/
transfer.2018-11-05.json
4744 lines (4744 loc) · 268 KB
/
transfer.2018-11-05.json
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
{
"smithy": "1.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.transfer#AccessDeniedException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.transfer#ServiceErrorMessage"
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "AccessDenied",
"httpResponseCode": 403
},
"smithy.api#documentation": "<p>You do not have sufficient access to perform this action.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 403
}
},
"com.amazonaws.transfer#AddressAllocationId": {
"type": "string"
},
"com.amazonaws.transfer#AddressAllocationIds": {
"type": "list",
"member": {
"target": "com.amazonaws.transfer#AddressAllocationId"
}
},
"com.amazonaws.transfer#Arn": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 20,
"max": 1600
},
"smithy.api#pattern": "^arn:"
}
},
"com.amazonaws.transfer#CallbackToken": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 64
},
"smithy.api#pattern": "^\\w+$"
}
},
"com.amazonaws.transfer#Certificate": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 1600
}
}
},
"com.amazonaws.transfer#ConflictException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.transfer#Message",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>This exception is thrown when the <code>UpdateServer</code> is called for a file transfer\n protocol-enabled server that has VPC as the endpoint type and the server's\n <code>VpcEndpointID</code> is not in the available state.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
},
"com.amazonaws.transfer#CopyStepDetails": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.transfer#WorkflowStepName",
"traits": {
"smithy.api#documentation": "<p>The name of the step, used as an identifier.</p>"
}
},
"DestinationFileLocation": {
"target": "com.amazonaws.transfer#InputFileLocation",
"traits": {
"smithy.api#documentation": "<p>Specifies the location for the file being copied. Only applicable for Copy type workflow\n steps. Use <code>${Transfer:username}</code> in this field to parametrize the destination\n prefix by username.</p>"
}
},
"OverwriteExisting": {
"target": "com.amazonaws.transfer#OverwriteExisting",
"traits": {
"smithy.api#documentation": "<p>A flag that indicates whether or not to overwrite an existing file of the same name.\n The default is <code>FALSE</code>.</p>"
}
},
"SourceFileLocation": {
"target": "com.amazonaws.transfer#SourceFileLocation",
"traits": {
"smithy.api#documentation": "<p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\n for the workflow.</p>\n <ul>\n <li>\n <p>Enter <code>${previous.file}</code> to use the previous file as the input.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.</p>\n </li>\n <li>\n <p>Enter <code>${original.file}</code> to use the originally-uploaded file location as input for this step.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Each step type has its own <code>StepDetails</code> structure.</p>"
}
},
"com.amazonaws.transfer#CreateAccess": {
"type": "operation",
"input": {
"target": "com.amazonaws.transfer#CreateAccessRequest"
},
"output": {
"target": "com.amazonaws.transfer#CreateAccessResponse"
},
"errors": [
{
"target": "com.amazonaws.transfer#InternalServiceError"
},
{
"target": "com.amazonaws.transfer#InvalidRequestException"
},
{
"target": "com.amazonaws.transfer#ResourceExistsException"
},
{
"target": "com.amazonaws.transfer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.transfer#ServiceUnavailableException"
}
],
"traits": {
"smithy.api#documentation": "<p>Used by administrators to choose which groups in the directory should have access to\n upload and download files over the enabled protocols using Amazon Web Services Transfer Family. For example, a\n Microsoft Active Directory might contain 50,000 users, but only a small fraction might need\n the ability to transfer files to the server. An administrator can use\n <code>CreateAccess</code> to limit the access to the correct set of users who need this\n ability.</p>"
}
},
"com.amazonaws.transfer#CreateAccessRequest": {
"type": "structure",
"members": {
"HomeDirectory": {
"target": "com.amazonaws.transfer#HomeDirectory",
"traits": {
"smithy.api#documentation": "<p>The landing directory (folder) for a user when they log in to the server using the client.</p>\n <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>"
}
},
"HomeDirectoryType": {
"target": "com.amazonaws.transfer#HomeDirectoryType",
"traits": {
"smithy.api#documentation": "<p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.\n If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.\n If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon\n S3 or EFS paths visible to your users.</p>"
}
},
"HomeDirectoryMappings": {
"target": "com.amazonaws.transfer#HomeDirectoryMappings",
"traits": {
"smithy.api#documentation": "<p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path\n is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in <code>Target</code>. This value\n can only be set when <code>HomeDirectoryType</code> is set to\n <i>LOGICAL</i>.</p>\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>\n <p>\n <code>[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>\n <p>In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"<code>chroot</code>\"). To do this, you can set\n <code>Entry</code> to <code>/</code> and set <code>Target</code> to the\n <code>HomeDirectory</code> parameter value.</p>\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>\n <p>\n <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>"
}
},
"Policy": {
"target": "com.amazonaws.transfer#Policy",
"traits": {
"smithy.api#documentation": "<p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,\n <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>\n \n <note>\n <p>This only applies when the domain of <code>ServerId</code> is S3. EFS does not use session policies.</p>\n <p>For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead\n of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass\n it in the <code>Policy</code> argument.</p> \n <p>For an example of a session policy, see <a href=\"https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html\">Example\n session policy</a>.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\">AssumeRole</a> in the <i>Amazon Web Services Security Token Service API\n Reference</i>.</p>\n </note>"
}
},
"PosixProfile": {
"target": "com.amazonaws.transfer#PosixProfile"
},
"Role": {
"target": "com.amazonaws.transfer#Role",
"traits": {
"smithy.api#documentation": "<p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS\n file system. The policies attached to this role determine the level of access that you want to provide your users when transferring\n files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the\n server to access your resources when servicing your users' transfer requests.</p>",
"smithy.api#required": {}
}
},
"ServerId": {
"target": "com.amazonaws.transfer#ServerId",
"traits": {
"smithy.api#documentation": "<p>A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.</p>",
"smithy.api#required": {}
}
},
"ExternalId": {
"target": "com.amazonaws.transfer#ExternalId",
"traits": {
"smithy.api#documentation": "<p>A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.</p>\n\n <p>\n <code>Get-ADGroup -Filter {samAccountName -like \"<i>YourGroupName</i>*\"} -Properties * | Select SamAccountName,ObjectSid</code>\n </p>\n \n <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>\n\n <p>The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.transfer#CreateAccessResponse": {
"type": "structure",
"members": {
"ServerId": {
"target": "com.amazonaws.transfer#ServerId",
"traits": {
"smithy.api#documentation": "<p>The ID of the server that the user is attached to.</p>",
"smithy.api#required": {}
}
},
"ExternalId": {
"target": "com.amazonaws.transfer#ExternalId",
"traits": {
"smithy.api#documentation": "<p>The external ID of the group whose users have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.transfer#CreateServer": {
"type": "operation",
"input": {
"target": "com.amazonaws.transfer#CreateServerRequest"
},
"output": {
"target": "com.amazonaws.transfer#CreateServerResponse"
},
"errors": [
{
"target": "com.amazonaws.transfer#AccessDeniedException"
},
{
"target": "com.amazonaws.transfer#InternalServiceError"
},
{
"target": "com.amazonaws.transfer#InvalidRequestException"
},
{
"target": "com.amazonaws.transfer#ResourceExistsException"
},
{
"target": "com.amazonaws.transfer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.transfer#ServiceUnavailableException"
},
{
"target": "com.amazonaws.transfer#ThrottlingException"
}
],
"traits": {
"smithy.api#documentation": "<p>Instantiates an auto-scaling virtual server based on the selected file transfer protocol\n in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work\n with users, use the service-generated <code>ServerId</code> property that is assigned to the\n newly created server.</p>"
}
},
"com.amazonaws.transfer#CreateServerRequest": {
"type": "structure",
"members": {
"Certificate": {
"target": "com.amazonaws.transfer#Certificate",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager (ACM) certificate. Required\n when <code>Protocols</code> is set to <code>FTPS</code>.</p>\n\n <p>To request a new public certificate, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html\">Request a public certificate</a>\n in the <i> Amazon Web Services Certificate Manager User Guide</i>.</p>\n\n <p>To import an existing certificate into ACM, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing certificates into ACM</a>\n in the <i> Amazon Web Services Certificate Manager User Guide</i>.</p>\n\n <p>To request a private certificate to use FTPS through private IP addresses, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html\">Request a\n private certificate</a> in the <i> Amazon Web Services Certificate Manager User\n Guide</i>.</p>\n\n <p>Certificates with the following cryptographic algorithms and key sizes are\n supported:</p>\n\n <ul>\n <li>\n <p>2048-bit RSA (RSA_2048)</p>\n </li>\n <li>\n <p>4096-bit RSA (RSA_4096)</p>\n </li>\n <li>\n <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p>\n </li>\n <li>\n <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p>\n </li>\n <li>\n <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p>\n </li>\n </ul>\n\n <note>\n <p>The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP\n address specified and information about the issuer.</p>\n </note>"
}
},
"Domain": {
"target": "com.amazonaws.transfer#Domain",
"traits": {
"smithy.api#documentation": "<p>The domain of the storage system that is used for file transfers. There are two domains\n available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The\n default value is S3.</p>\n\n <note>\n <p>After the server is created, the domain cannot be changed.</p>\n </note>"
}
},
"EndpointDetails": {
"target": "com.amazonaws.transfer#EndpointDetails",
"traits": {
"smithy.api#documentation": "<p>The virtual private cloud (VPC) endpoint settings that are configured for your server.\n When you host your endpoint within your VPC, you can make it accessible only to resources\n within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over\n the internet. Your VPC's default security groups are automatically assigned to your\n endpoint.</p>"
}
},
"EndpointType": {
"target": "com.amazonaws.transfer#EndpointType",
"traits": {
"smithy.api#documentation": "<p>The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)\n or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and \n resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.</p>\n <note>\n <p> After May 19, 2021, you won't be able to create a server using\n <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Services account if your account hasn't already\n done so before May 19, 2021. If you have already created servers with\n <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Services account on or before May 19, 2021,\n you will not be affected. After this date, use\n <code>EndpointType</code>=<code>VPC</code>.</p> \n \n <p>For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>\n <p>It is recommended that you use <code>VPC</code> as the <code>EndpointType</code>. With\n this endpoint type, you have the option to directly associate up to three Elastic IPv4\n addresses (BYO IP included) with your server's endpoint and use VPC security groups to\n restrict traffic by the client's public IP address. This is not possible with\n <code>EndpointType</code> set to <code>VPC_ENDPOINT</code>.</p>\n </note>"
}
},
"HostKey": {
"target": "com.amazonaws.transfer#HostKey",
"traits": {
"smithy.api#documentation": "<p>The RSA private key as generated by the <code>ssh-keygen -N \"\" -m PEM -f\n my-new-server-key</code> command.</p>\n\n <important>\n <p>If you aren't planning to migrate existing users from an existing SFTP-enabled\n server to a new server, don't update the host key. Accidentally changing a\n server's host key can be disruptive.</p>\n </important>\n\n \n\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key\">Change the host key for your SFTP-enabled server</a> in the <i>Amazon Web Services Transfer\n Family User Guide</i>.</p>"
}
},
"IdentityProviderDetails": {
"target": "com.amazonaws.transfer#IdentityProviderDetails",
"traits": {
"smithy.api#documentation": "<p>Required when <code>IdentityProviderType</code> is set to\n <code>AWS_DIRECTORY_SERVICE</code> or <code>API_GATEWAY</code>. Accepts an array containing\n all of the information required to use a directory in <code>AWS_DIRECTORY_SERVICE</code> or\n invoke a customer-supplied authentication API, including the API Gateway URL. Not required\n when <code>IdentityProviderType</code> is set to <code>SERVICE_MANAGED</code>.</p>"
}
},
"IdentityProviderType": {
"target": "com.amazonaws.transfer#IdentityProviderType",
"traits": {
"smithy.api#documentation": "<p>Specifies the mode of authentication for a server. The default value is\n <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.</p>\n <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the <code>IdentityProviderDetails</code> parameter.</p>\n <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The\n <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the <code>IdentityProviderDetails</code> parameter.</p>\n <p>Use the <code>AWS_LAMBDA</code> value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p>"
}
},
"LoggingRole": {
"target": "com.amazonaws.transfer#Role",
"traits": {
"smithy.api#documentation": "<p>Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in\n your CloudWatch logs.</p>"
}
},
"PostAuthenticationLoginBanner": {
"target": "com.amazonaws.transfer#PostAuthenticationLoginBanner"
},
"PreAuthenticationLoginBanner": {
"target": "com.amazonaws.transfer#PreAuthenticationLoginBanner"
},
"Protocols": {
"target": "com.amazonaws.transfer#Protocols",
"traits": {
"smithy.api#documentation": "<p>Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:</p>\n\n <ul>\n <li>\n <p>\n <code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over\n SSH</p>\n </li>\n <li>\n <p>\n <code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS\n encryption</p>\n </li>\n <li>\n <p>\n <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p>\n </li>\n </ul>\n\n <note>\n <p>If you select <code>FTPS</code>, you must choose a certificate stored in Amazon Web Services Certificate\n Manager (ACM) which is used to identify your server when clients connect to it over\n FTPS.</p>\n\n <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the\n <code>EndpointType</code> must be <code>VPC</code> and the\n <code>IdentityProviderType</code> must be <code>AWS_DIRECTORY_SERVICE</code> or <code>API_GATEWAY</code>.</p>\n\n <p>If <code>Protocol</code> includes <code>FTP</code>, then\n <code>AddressAllocationIds</code> cannot be associated.</p>\n\n <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code>\n can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set to\n <code>SERVICE_MANAGED</code>.</p>\n </note>"
}
},
"ProtocolDetails": {
"target": "com.amazonaws.transfer#ProtocolDetails",
"traits": {
"smithy.api#documentation": "<p>The protocol settings that are configured for your server.</p>\n <p>\n Use the <code>PassiveIp</code> parameter to indicate passive mode (for FTP and FTPS protocols).\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n </p>\n <p>Use the <code>TlsSessionResumptionMode</code> parameter to determine whether or not your Transfer server\n resumes recent, negotiated sessions through a unique session ID.</p>"
}
},
"SecurityPolicyName": {
"target": "com.amazonaws.transfer#SecurityPolicyName",
"traits": {
"smithy.api#documentation": "<p>Specifies the name of the security policy that is attached to the server.</p>"
}
},
"Tags": {
"target": "com.amazonaws.transfer#Tags",
"traits": {
"smithy.api#documentation": "<p>Key-value pairs that can be used to group and search for servers.</p>"
}
},
"WorkflowDetails": {
"target": "com.amazonaws.transfer#WorkflowDetails",
"traits": {
"smithy.api#documentation": "<p>Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.</p>"
}
}
}
},
"com.amazonaws.transfer#CreateServerResponse": {
"type": "structure",
"members": {
"ServerId": {
"target": "com.amazonaws.transfer#ServerId",
"traits": {
"smithy.api#documentation": "<p>The service-assigned ID of the server that is created.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.transfer#CreateUser": {
"type": "operation",
"input": {
"target": "com.amazonaws.transfer#CreateUserRequest"
},
"output": {
"target": "com.amazonaws.transfer#CreateUserResponse"
},
"errors": [
{
"target": "com.amazonaws.transfer#InternalServiceError"
},
{
"target": "com.amazonaws.transfer#InvalidRequestException"
},
{
"target": "com.amazonaws.transfer#ResourceExistsException"
},
{
"target": "com.amazonaws.transfer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.transfer#ServiceUnavailableException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a user and associates them with an existing file transfer protocol-enabled server.\n You can only create and associate users with servers that have the\n <code>IdentityProviderType</code> set to <code>SERVICE_MANAGED</code>. Using parameters for\n <code>CreateUser</code>, you can specify the user name, set the home directory, store the\n user's public key, and assign the user's Amazon Web Services Identity and Access Management (IAM)\n role. You can also optionally add a session policy, and assign metadata with tags that can\n be used to group and search for users.</p>"
}
},
"com.amazonaws.transfer#CreateUserRequest": {
"type": "structure",
"members": {
"HomeDirectory": {
"target": "com.amazonaws.transfer#HomeDirectory",
"traits": {
"smithy.api#documentation": "<p>The landing directory (folder) for a user when they log in to the server using the client.</p>\n <p>A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.</p>"
}
},
"HomeDirectoryType": {
"target": "com.amazonaws.transfer#HomeDirectoryType",
"traits": {
"smithy.api#documentation": "<p>The type of landing directory (folder) you want your users' home directory to be when they log into the server.\n If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients.\n If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon\n S3 or EFS paths visible to your users.</p>"
}
},
"HomeDirectoryMappings": {
"target": "com.amazonaws.transfer#HomeDirectoryMappings",
"traits": {
"smithy.api#documentation": "<p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path\n is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in <code>Target</code>. This value\n can only be set when <code>HomeDirectoryType</code> is set to\n <i>LOGICAL</i>.</p>\n\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>\n\n <p>\n <code>[ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]</code>\n </p>\n\n <p>In most cases, you can use this value instead of the session policy to lock your user\n down to the designated home directory (\"<code>chroot</code>\"). To do this, you can set\n <code>Entry</code> to <code>/</code> and set <code>Target</code> to the HomeDirectory\n parameter value.</p>\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>\n <p>\n <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>"
}
},
"Policy": {
"target": "com.amazonaws.transfer#Policy",
"traits": {
"smithy.api#documentation": "<p>A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>,\n <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>\n\n <note>\n <p>This only applies when the domain of <code>ServerId</code> is S3. EFS does not use session policies.</p>\n <p>For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead\n of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass\n it in the <code>Policy</code> argument.</p>\n\n \n\n <p>For an example of a session policy, see <a href=\"https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html\">Example session\n policy</a>.</p>\n\n \n\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\">AssumeRole</a> in the <i>Amazon Web Services\n Security Token Service API Reference</i>.</p>\n </note>"
}
},
"PosixProfile": {
"target": "com.amazonaws.transfer#PosixProfile",
"traits": {
"smithy.api#documentation": "<p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), group ID\n (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls\n your users' access to your Amazon EFS file systems. The POSIX permissions that are set on\n files and directories in Amazon EFS determine the level of access your users get when\n transferring files into and out of your Amazon EFS file systems.</p>"
}
},
"Role": {
"target": "com.amazonaws.transfer#Role",
"traits": {
"smithy.api#documentation": "<p>Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS\n file system. The policies attached to this role determine the level of access that you want to provide your users when transferring\n files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the\n server to access your resources when servicing your users' transfer requests.</p>",
"smithy.api#required": {}
}
},
"ServerId": {
"target": "com.amazonaws.transfer#ServerId",
"traits": {
"smithy.api#documentation": "<p>A system-assigned unique identifier for a server instance. This is the specific server\n that you added your user to.</p>",
"smithy.api#required": {}
}
},
"SshPublicKeyBody": {
"target": "com.amazonaws.transfer#SshPublicKeyBody",
"traits": {
"smithy.api#documentation": "<p>The public portion of the Secure Shell (SSH) key used to authenticate the user to the\n server.</p>\n <note>\n <p>\n Currently, Transfer Family does not accept elliptical curve keys (keys beginning with <code>ecdsa</code>).\n </p>\n </note>"
}
},
"Tags": {
"target": "com.amazonaws.transfer#Tags",
"traits": {
"smithy.api#documentation": "<p>Key-value pairs that can be used to group and search for users. Tags are metadata attached\n to users for any purpose.</p>"
}
},
"UserName": {
"target": "com.amazonaws.transfer#UserName",
"traits": {
"smithy.api#documentation": "<p>A unique string that identifies a user and is associated with a <code>ServerId</code>. This user name must be a minimum of 3 and a maximum of 100 characters\n long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen\n '-', period '.', and at sign '@'. The user name can't start\n with a hyphen, period, or at sign.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.transfer#CreateUserResponse": {
"type": "structure",
"members": {
"ServerId": {
"target": "com.amazonaws.transfer#ServerId",
"traits": {
"smithy.api#documentation": "<p>The ID of the server that the user is attached to.</p>",
"smithy.api#required": {}
}
},
"UserName": {
"target": "com.amazonaws.transfer#UserName",
"traits": {
"smithy.api#documentation": "<p>A unique string that identifies a user account associated with a server.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.transfer#CreateWorkflow": {
"type": "operation",
"input": {
"target": "com.amazonaws.transfer#CreateWorkflowRequest"
},
"output": {
"target": "com.amazonaws.transfer#CreateWorkflowResponse"
},
"errors": [
{
"target": "com.amazonaws.transfer#AccessDeniedException"
},
{
"target": "com.amazonaws.transfer#InternalServiceError"
},
{
"target": "com.amazonaws.transfer#InvalidRequestException"
},
{
"target": "com.amazonaws.transfer#ResourceExistsException"
},
{
"target": "com.amazonaws.transfer#ServiceUnavailableException"
},
{
"target": "com.amazonaws.transfer#ThrottlingException"
}
],
"traits": {
"smithy.api#documentation": "<p>\n Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.\n After creating a workflow, you can associate the workflow created with any transfer servers by specifying the <code>workflow-details</code> field in <code>CreateServer</code> and <code>UpdateServer</code> operations.\n </p>"
}
},
"com.amazonaws.transfer#CreateWorkflowRequest": {
"type": "structure",
"members": {
"Description": {
"target": "com.amazonaws.transfer#WorkflowDescription",
"traits": {
"smithy.api#documentation": "<p>A textual description for the workflow.</p>"
}
},
"Steps": {
"target": "com.amazonaws.transfer#WorkflowSteps",
"traits": {
"smithy.api#documentation": "<p>Specifies the details for the steps that are in the specified workflow.</p>\n <p>\n The <code>TYPE</code> specifies which of the following actions is being taken for this step.\n </p>\n <ul>\n <li>\n <p>\n <i>Copy</i>: copy the file to another location</p>\n </li>\n <li>\n <p>\n <i>Custom</i>: custom step with a lambda target</p>\n </li>\n <li>\n <p>\n <i>Delete</i>: delete the file</p>\n </li>\n <li>\n <p>\n <i>Tag</i>: add a tag to the file</p>\n </li>\n </ul>\n <note>\n <p>\n Currently, copying and tagging are supported only on S3.\n </p>\n </note>\n <p>\n For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.\n </p>",
"smithy.api#required": {}
}
},
"OnExceptionSteps": {
"target": "com.amazonaws.transfer#WorkflowSteps",
"traits": {
"smithy.api#documentation": "<p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p>\n <note>\n <p>For custom steps, the lambda function needs to send <code>FAILURE</code> to the call\n back API to kick off the exception steps. Additionally, if the lambda does not send\n <code>SUCCESS</code> before it times out, the exception steps are executed.</p>\n </note>"
}
},
"Tags": {
"target": "com.amazonaws.transfer#Tags",
"traits": {
"smithy.api#documentation": "<p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached\n to workflows for any purpose.</p>"
}
}
}
},
"com.amazonaws.transfer#CreateWorkflowResponse": {
"type": "structure",
"members": {
"WorkflowId": {
"target": "com.amazonaws.transfer#WorkflowId",
"traits": {
"smithy.api#documentation": "<p>A unique identifier for the workflow.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.transfer#CustomStepDetails": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.transfer#WorkflowStepName",
"traits": {
"smithy.api#documentation": "<p>The name of the step, used as an identifier.</p>"
}
},
"Target": {
"target": "com.amazonaws.transfer#CustomStepTarget",
"traits": {
"smithy.api#documentation": "<p>The ARN for the lambda function that is being called.</p>"
}
},
"TimeoutSeconds": {
"target": "com.amazonaws.transfer#CustomStepTimeoutSeconds",
"traits": {
"smithy.api#documentation": "<p>Timeout, in seconds, for the step.</p>"
}
},
"SourceFileLocation": {
"target": "com.amazonaws.transfer#SourceFileLocation",
"traits": {
"smithy.api#documentation": "<p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\n for the workflow.</p>\n <ul>\n <li>\n <p>Enter <code>${previous.file}</code> to use the previous file as the input.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.</p>\n </li>\n <li>\n <p>Enter <code>${original.file}</code> to use the originally-uploaded file location as input for this step.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Each step type has its own <code>StepDetails</code> structure.</p>"
}
},
"com.amazonaws.transfer#CustomStepStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "SUCCESS",
"name": "SUCCESS"
},
{
"value": "FAILURE",
"name": "FAILURE"
}
]
}
},
"com.amazonaws.transfer#CustomStepTarget": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 170
},
"smithy.api#pattern": "^arn:[a-z-]+:lambda:.*$"
}
},
"com.amazonaws.transfer#CustomStepTimeoutSeconds": {
"type": "integer",
"traits": {
"smithy.api#box": {},
"smithy.api#range": {
"min": 1,
"max": 1800
}
}
},
"com.amazonaws.transfer#DateImported": {
"type": "timestamp"
},
"com.amazonaws.transfer#DeleteAccess": {
"type": "operation",
"input": {
"target": "com.amazonaws.transfer#DeleteAccessRequest"
},
"errors": [
{
"target": "com.amazonaws.transfer#InternalServiceError"
},
{
"target": "com.amazonaws.transfer#InvalidRequestException"
},
{
"target": "com.amazonaws.transfer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.transfer#ServiceUnavailableException"
}
],
"traits": {
"smithy.api#documentation": "<p>Allows you to delete the access specified in the <code>ServerID</code> and\n <code>ExternalID</code> parameters.</p>"
}
},
"com.amazonaws.transfer#DeleteAccessRequest": {
"type": "structure",
"members": {
"ServerId": {
"target": "com.amazonaws.transfer#ServerId",
"traits": {
"smithy.api#documentation": "<p>A system-assigned unique identifier for a server that has this user assigned.</p>",
"smithy.api#required": {}
}
},
"ExternalId": {
"target": "com.amazonaws.transfer#ExternalId",
"traits": {
"smithy.api#documentation": "<p>A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.</p>\n\n <p>\n <code>Get-ADGroup -Filter {samAccountName -like \"<i>YourGroupName</i>*\"} -Properties * | Select SamAccountName,ObjectSid</code>\n </p>\n \n <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>\n\n <p>The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.transfer#DeleteServer": {
"type": "operation",
"input": {
"target": "com.amazonaws.transfer#DeleteServerRequest"
},
"errors": [
{
"target": "com.amazonaws.transfer#AccessDeniedException"
},
{
"target": "com.amazonaws.transfer#InternalServiceError"
},
{
"target": "com.amazonaws.transfer#InvalidRequestException"
},
{
"target": "com.amazonaws.transfer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.transfer#ServiceUnavailableException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the file transfer protocol-enabled server that you specify.</p>\n\n <p>No response returns from this operation.</p>"
}
},
"com.amazonaws.transfer#DeleteServerRequest": {
"type": "structure",
"members": {
"ServerId": {
"target": "com.amazonaws.transfer#ServerId",
"traits": {
"smithy.api#documentation": "<p>A unique system-assigned identifier for a server instance.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.transfer#DeleteSshPublicKey": {
"type": "operation",
"input": {
"target": "com.amazonaws.transfer#DeleteSshPublicKeyRequest"
},
"errors": [
{
"target": "com.amazonaws.transfer#InternalServiceError"
},
{
"target": "com.amazonaws.transfer#InvalidRequestException"
},
{
"target": "com.amazonaws.transfer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.transfer#ServiceUnavailableException"
},
{
"target": "com.amazonaws.transfer#ThrottlingException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes a user's Secure Shell (SSH) public key.</p>"
}
},
"com.amazonaws.transfer#DeleteSshPublicKeyRequest": {
"type": "structure",
"members": {
"ServerId": {
"target": "com.amazonaws.transfer#ServerId",
"traits": {
"smithy.api#documentation": "<p>A system-assigned unique identifier for a file transfer protocol-enabled server instance\n that has the user assigned to it.</p>",
"smithy.api#required": {}
}
},
"SshPublicKeyId": {
"target": "com.amazonaws.transfer#SshPublicKeyId",
"traits": {
"smithy.api#documentation": "<p>A unique identifier used to reference your user's specific SSH key.</p>",
"smithy.api#required": {}
}
},
"UserName": {
"target": "com.amazonaws.transfer#UserName",
"traits": {
"smithy.api#documentation": "<p>A unique string that identifies a user whose public key is being deleted.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.transfer#DeleteStepDetails": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.transfer#WorkflowStepName",
"traits": {
"smithy.api#documentation": "<p>The name of the step, used as an identifier.</p>"
}
},
"SourceFileLocation": {
"target": "com.amazonaws.transfer#SourceFileLocation",
"traits": {
"smithy.api#documentation": "<p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file\n for the workflow.</p>\n <ul>\n <li>\n <p>Enter <code>${previous.file}</code> to use the previous file as the input.\n In this case, this workflow step uses the output file from the previous workflow step as input.\n This is the default value.</p>\n </li>\n <li>\n <p>Enter <code>${original.file}</code> to use the originally-uploaded file location as input for this step.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The name of the step, used to identify the delete step.</p>"
}
},
"com.amazonaws.transfer#DeleteUser": {
"type": "operation",
"input": {
"target": "com.amazonaws.transfer#DeleteUserRequest"
},
"errors": [
{
"target": "com.amazonaws.transfer#InternalServiceError"
},
{
"target": "com.amazonaws.transfer#InvalidRequestException"
},
{
"target": "com.amazonaws.transfer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.transfer#ServiceUnavailableException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the user belonging to a file transfer protocol-enabled server you specify.</p>\n\n <p>No response returns from this operation.</p>\n\n <note>\n <p>When you delete a user from a server, the user's information is lost.</p>\n </note>"
}
},
"com.amazonaws.transfer#DeleteUserRequest": {
"type": "structure",
"members": {
"ServerId": {
"target": "com.amazonaws.transfer#ServerId",
"traits": {
"smithy.api#documentation": "<p>A system-assigned unique identifier for a server instance that has the user assigned to\n it.</p>",
"smithy.api#required": {}
}
},
"UserName": {
"target": "com.amazonaws.transfer#UserName",
"traits": {
"smithy.api#documentation": "<p>A unique string that identifies a user that is being deleted from a server.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.transfer#DeleteWorkflow": {
"type": "operation",
"input": {
"target": "com.amazonaws.transfer#DeleteWorkflowRequest"
},
"errors": [
{
"target": "com.amazonaws.transfer#AccessDeniedException"
},
{
"target": "com.amazonaws.transfer#InternalServiceError"
},
{
"target": "com.amazonaws.transfer#InvalidRequestException"
},
{
"target": "com.amazonaws.transfer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.transfer#ServiceUnavailableException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the specified workflow.</p>"
}
},
"com.amazonaws.transfer#DeleteWorkflowRequest": {
"type": "structure",
"members": {
"WorkflowId": {
"target": "com.amazonaws.transfer#WorkflowId",
"traits": {
"smithy.api#documentation": "<p>A unique identifier for the workflow.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.transfer#DescribeAccess": {
"type": "operation",
"input": {
"target": "com.amazonaws.transfer#DescribeAccessRequest"
},
"output": {
"target": "com.amazonaws.transfer#DescribeAccessResponse"
},
"errors": [
{
"target": "com.amazonaws.transfer#InternalServiceError"
},
{
"target": "com.amazonaws.transfer#InvalidRequestException"
},
{
"target": "com.amazonaws.transfer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.transfer#ServiceUnavailableException"
}
],
"traits": {
"smithy.api#documentation": "<p>Describes the access that is assigned to the specific file transfer protocol-enabled\n server, as identified by its <code>ServerId</code> property and its\n <code>ExternalID</code>.</p>\n \n <p>The response from this call returns the properties of the access that is associated with\n the <code>ServerId</code> value that was specified.</p>"
}
},
"com.amazonaws.transfer#DescribeAccessRequest": {
"type": "structure",
"members": {
"ServerId": {
"target": "com.amazonaws.transfer#ServerId",
"traits": {
"smithy.api#documentation": "<p>A system-assigned unique identifier for a server that has this access assigned.</p>",
"smithy.api#required": {}
}
},
"ExternalId": {
"target": "com.amazonaws.transfer#ExternalId",
"traits": {
"smithy.api#documentation": "<p>A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.</p>\n\n <p>\n <code>Get-ADGroup -Filter {samAccountName -like \"<i>YourGroupName</i>*\"} -Properties * | Select SamAccountName,ObjectSid</code>\n </p>\n \n <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>\n\n <p>The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.transfer#DescribeAccessResponse": {
"type": "structure",
"members": {
"ServerId": {
"target": "com.amazonaws.transfer#ServerId",
"traits": {
"smithy.api#documentation": "<p>A system-assigned unique identifier for a server that has this access assigned.</p>",
"smithy.api#required": {}
}
},
"Access": {
"target": "com.amazonaws.transfer#DescribedAccess",
"traits": {
"smithy.api#documentation": "<p>The external ID of the server that the access is attached to.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.transfer#DescribeExecution": {
"type": "operation",
"input": {
"target": "com.amazonaws.transfer#DescribeExecutionRequest"
},
"output": {
"target": "com.amazonaws.transfer#DescribeExecutionResponse"
},
"errors": [
{
"target": "com.amazonaws.transfer#InternalServiceError"
},
{
"target": "com.amazonaws.transfer#InvalidRequestException"
},
{
"target": "com.amazonaws.transfer#ResourceNotFoundException"
},
{
"target": "com.amazonaws.transfer#ServiceUnavailableException"
}
],
"traits": {
"smithy.api#documentation": "<p>You can use <code>DescribeExecution</code> to check the details of the execution of the specified workflow.</p>"
}
},
"com.amazonaws.transfer#DescribeExecutionRequest": {
"type": "structure",
"members": {
"ExecutionId": {
"target": "com.amazonaws.transfer#ExecutionId",
"traits": {
"smithy.api#documentation": "<p>A unique identifier for the execution of a workflow.</p>",
"smithy.api#required": {}
}
},
"WorkflowId": {
"target": "com.amazonaws.transfer#WorkflowId",
"traits": {
"smithy.api#documentation": "<p>A unique identifier for the workflow.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.transfer#DescribeExecutionResponse": {
"type": "structure",
"members": {
"WorkflowId": {
"target": "com.amazonaws.transfer#WorkflowId",
"traits": {
"smithy.api#documentation": "<p>A unique identifier for the workflow.</p>",
"smithy.api#required": {}
}
},
"Execution": {
"target": "com.amazonaws.transfer#DescribedExecution",
"traits": {
"smithy.api#documentation": "<p>The structure that contains the details of the workflow' execution.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.transfer#DescribeSecurityPolicy": {
"type": "operation",
"input": {
"target": "com.amazonaws.transfer#DescribeSecurityPolicyRequest"
},
"output": {
"target": "com.amazonaws.transfer#DescribeSecurityPolicyResponse"
},
"errors": [