aws-sdk-transfer 1.26.0 → 1.31.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2d0f0f2b780ccf6098059679b5a75b2fb9b7010ba270105b290ccd5c0fc4c253
4
- data.tar.gz: 9af305903a7eb50497ce93eb26358e3b53bf36f5d2f08a4a97ae5211409a9d86
3
+ metadata.gz: 401a690bab93547dd1a8dc253914adc04c634358b42bd71d386ff5f1bbe5c474
4
+ data.tar.gz: 45c6a68128095dd3e10f743ad95c64331e51aa16424e1fea27398190a26ed652
5
5
  SHA512:
6
- metadata.gz: 4d7fa3d7a6f26784d4d5d65e6a53e797a45a0089baadf109c43b53fe3243fb83efdf4eddb34d687377ec030239868bf0497f2a640936b3bdaa7b4816536f2920
7
- data.tar.gz: 587c91282d749181f7ba815c343697eb6ec1b65dbdb307932f4a6f631dd27ee57bde2bcd063bc2f575582a3c557ea5e73c28935f4ae62f90a9d959dc11cacbd1
6
+ metadata.gz: 8d3f5493342760c2f0080de20891a6c3213d07449950be9ee076dc084f929bc25e3bafe56e92586e7a3ad503771f3e153c4a5250b5936409f35d0d9325d578a8
7
+ data.tar.gz: bb41b1bdf2a69153f753ce8aad5436e2de654c52aeae3126950aac0034a0d7e4a1379072a12e3526d0db173c87edbeb8825bcab5d32f61965df9c69a097c7085
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-transfer/customizations'
48
48
  # @!group service
49
49
  module Aws::Transfer
50
50
 
51
- GEM_VERSION = '1.26.0'
51
+ GEM_VERSION = '1.31.0'
52
52
 
53
53
  end
@@ -382,19 +382,21 @@ module Aws::Transfer
382
382
  # [2]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html
383
383
  # [3]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html
384
384
  #
385
+ # @option params [String] :domain
386
+ #
385
387
  # @option params [Types::EndpointDetails] :endpoint_details
386
388
  # The virtual private cloud (VPC) endpoint settings that are configured
387
- # for your file transfer protocol-enabled server. When you host your
388
- # endpoint within your VPC, you can make it accessible only to resources
389
- # within your VPC, or you can attach Elastic IPs and make it accessible
390
- # to clients over the internet. Your VPC's default security groups are
391
- # automatically assigned to your endpoint.
389
+ # for your server. When you host your endpoint within your VPC, you can
390
+ # make it accessible only to resources within your VPC, or you can
391
+ # attach Elastic IPs and make it accessible to clients over the
392
+ # internet. Your VPC's default security groups are automatically
393
+ # assigned to your endpoint.
392
394
  #
393
395
  # @option params [String] :endpoint_type
394
- # The type of VPC endpoint that you want your file transfer
395
- # protocol-enabled server to connect to. You can choose to connect to
396
- # the public internet or a VPC endpoint. With a VPC endpoint, you can
397
- # restrict access to your server and resources only within your VPC.
396
+ # The type of VPC endpoint that you want your server to connect to. You
397
+ # can choose to connect to the public internet or a VPC endpoint. With a
398
+ # VPC endpoint, you can restrict access to your server and resources
399
+ # only within your VPC.
398
400
  #
399
401
  # <note markdown="1"> It is recommended that you use `VPC` as the `EndpointType`. With this
400
402
  # endpoint type, you have the option to directly associate up to three
@@ -427,13 +429,13 @@ module Aws::Transfer
427
429
  # Not required when `IdentityProviderType` is set to `SERVICE_MANAGED`.
428
430
  #
429
431
  # @option params [String] :identity_provider_type
430
- # Specifies the mode of authentication for a file transfer
431
- # protocol-enabled server. The default value is `SERVICE_MANAGED`, which
432
- # allows you to store and access user credentials within the AWS
433
- # Transfer Family service. Use the `API_GATEWAY` value to integrate with
434
- # an identity provider of your choosing. The `API_GATEWAY` setting
435
- # requires you to provide an API Gateway endpoint URL to call for
436
- # authentication using the `IdentityProviderDetails` parameter.
432
+ # Specifies the mode of authentication for a server. The default value
433
+ # is `SERVICE_MANAGED`, which allows you to store and access user
434
+ # credentials within the AWS Transfer Family service. Use the
435
+ # `API_GATEWAY` value to integrate with an identity provider of your
436
+ # choosing. The `API_GATEWAY` setting requires you to provide an API
437
+ # Gateway endpoint URL to call for authentication using the
438
+ # `IdentityProviderDetails` parameter.
437
439
  #
438
440
  # @option params [String] :logging_role
439
441
  # Allows the service to write your users' activity to your Amazon
@@ -453,8 +455,8 @@ module Aws::Transfer
453
455
  # * `FTP` (File Transfer Protocol): Unencrypted file transfer
454
456
  #
455
457
  # <note markdown="1"> If you select `FTPS`, you must choose a certificate stored in AWS
456
- # Certificate Manager (ACM) which will be used to identify your file
457
- # transfer protocol-enabled server when clients connect to it over FTPS.
458
+ # Certificate Manager (ACM) which will be used to identify your server
459
+ # when clients connect to it over FTPS.
458
460
  #
459
461
  # If `Protocol` includes either `FTP` or `FTPS`, then the `EndpointType`
460
462
  # must be `VPC` and the `IdentityProviderType` must be `API_GATEWAY`.
@@ -473,8 +475,7 @@ module Aws::Transfer
473
475
  # server.
474
476
  #
475
477
  # @option params [Array<Types::Tag>] :tags
476
- # Key-value pairs that can be used to group and search for file transfer
477
- # protocol-enabled servers.
478
+ # Key-value pairs that can be used to group and search for servers.
478
479
  #
479
480
  # @return [Types::CreateServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
480
481
  #
@@ -484,11 +485,13 @@ module Aws::Transfer
484
485
  #
485
486
  # resp = client.create_server({
486
487
  # certificate: "Certificate",
488
+ # domain: "S3", # accepts S3, EFS
487
489
  # endpoint_details: {
488
490
  # address_allocation_ids: ["AddressAllocationId"],
489
491
  # subnet_ids: ["SubnetId"],
490
492
  # vpc_endpoint_id: "VpcEndpointId",
491
493
  # vpc_id: "VpcId",
494
+ # security_group_ids: ["SecurityGroupId"],
492
495
  # },
493
496
  # endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
494
497
  # host_key: "HostKey",
@@ -531,20 +534,19 @@ module Aws::Transfer
531
534
  # can be used to group and search for users.
532
535
  #
533
536
  # @option params [String] :home_directory
534
- # The landing directory (folder) for a user when they log in to the file
535
- # transfer protocol-enabled server using the client.
537
+ # The landing directory (folder) for a user when they log in to the
538
+ # server using the client.
536
539
  #
537
540
  # An example is <i>
538
541
  # <code>your-Amazon-S3-bucket-name&gt;/home/username</code> </i>.
539
542
  #
540
543
  # @option params [String] :home_directory_type
541
544
  # The type of landing directory (folder) you want your users' home
542
- # directory to be when they log into the file transfer protocol-enabled
543
- # server. If you set it to `PATH`, the user will see the absolute Amazon
544
- # S3 bucket paths as is in their file transfer protocol clients. If you
545
- # set it `LOGICAL`, you will need to provide mappings in the
546
- # `HomeDirectoryMappings` for how you want to make Amazon S3 paths
547
- # visible to your users.
545
+ # directory to be when they log into the server. If you set it to
546
+ # `PATH`, the user will see the absolute Amazon S3 bucket paths as is in
547
+ # their file transfer protocol clients. If you set it `LOGICAL`, you
548
+ # will need to provide mappings in the `HomeDirectoryMappings` for how
549
+ # you want to make Amazon S3 paths visible to your users.
548
550
  #
549
551
  # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
550
552
  # Logical directory mappings that specify what Amazon S3 paths and keys
@@ -600,35 +602,35 @@ module Aws::Transfer
600
602
  # [1]: https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down
601
603
  # [2]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
602
604
  #
605
+ # @option params [Types::PosixProfile] :posix_profile
606
+ #
603
607
  # @option params [required, String] :role
604
608
  # The IAM role that controls your users' access to your Amazon S3
605
609
  # bucket. The policies attached to this role will determine the level of
606
610
  # access you want to provide your users when transferring files into and
607
611
  # out of your Amazon S3 bucket or buckets. The IAM role should also
608
- # contain a trust relationship that allows the file transfer
609
- # protocol-enabled server to access your resources when servicing your
610
- # users' transfer requests.
612
+ # contain a trust relationship that allows the server to access your
613
+ # resources when servicing your users' transfer requests.
611
614
  #
612
615
  # @option params [required, String] :server_id
613
- # A system-assigned unique identifier for a file transfer
614
- # protocol-enabled server instance. This is the specific server that you
615
- # added your user to.
616
+ # A system-assigned unique identifier for a server instance. This is the
617
+ # specific server that you added your user to.
616
618
  #
617
619
  # @option params [String] :ssh_public_key_body
618
620
  # The public portion of the Secure Shell (SSH) key used to authenticate
619
- # the user to the file transfer protocol-enabled server.
621
+ # the user to the server.
620
622
  #
621
623
  # @option params [Array<Types::Tag>] :tags
622
624
  # Key-value pairs that can be used to group and search for users. Tags
623
625
  # are metadata attached to users for any purpose.
624
626
  #
625
627
  # @option params [required, String] :user_name
626
- # A unique string that identifies a user and is associated with a file
627
- # transfer protocol-enabled server as specified by the `ServerId`. This
628
- # user name must be a minimum of 3 and a maximum of 100 characters long.
629
- # The following are valid characters: a-z, A-Z, 0-9, underscore '\_',
630
- # hyphen '-', period '.', and at sign '@'. The user name can't
631
- # start with a hyphen, period, and at sign.
628
+ # A unique string that identifies a user and is associated with a as
629
+ # specified by the `ServerId`. This user name must be a minimum of 3 and
630
+ # a maximum of 100 characters long. The following are valid characters:
631
+ # a-z, A-Z, 0-9, underscore '\_', hyphen '-', period '.', and at
632
+ # sign '@'. The user name can't start with a hyphen, period, or at
633
+ # sign.
632
634
  #
633
635
  # @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
634
636
  #
@@ -647,6 +649,11 @@ module Aws::Transfer
647
649
  # },
648
650
  # ],
649
651
  # policy: "Policy",
652
+ # posix_profile: {
653
+ # uid: 1, # required
654
+ # gid: 1, # required
655
+ # secondary_gids: [1],
656
+ # },
650
657
  # role: "Role", # required
651
658
  # server_id: "ServerId", # required
652
659
  # ssh_public_key_body: "SshPublicKeyBody",
@@ -678,8 +685,7 @@ module Aws::Transfer
678
685
  # No response returns from this operation.
679
686
  #
680
687
  # @option params [required, String] :server_id
681
- # A unique system-assigned identifier for a file transfer
682
- # protocol-enabled server instance.
688
+ # A unique system-assigned identifier for a server instance.
683
689
  #
684
690
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
685
691
  #
@@ -742,12 +748,12 @@ module Aws::Transfer
742
748
  # </note>
743
749
  #
744
750
  # @option params [required, String] :server_id
745
- # A system-assigned unique identifier for a file transfer
746
- # protocol-enabled server instance that has the user assigned to it.
751
+ # A system-assigned unique identifier for a server instance that has the
752
+ # user assigned to it.
747
753
  #
748
754
  # @option params [required, String] :user_name
749
755
  # A unique string that identifies a user that is being deleted from a
750
- # file transfer protocol-enabled server.
756
+ # server.
751
757
  #
752
758
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
753
759
  #
@@ -820,8 +826,7 @@ module Aws::Transfer
820
826
  # `EndpointDetails`.
821
827
  #
822
828
  # @option params [required, String] :server_id
823
- # A system-assigned unique identifier for a file transfer
824
- # protocol-enabled server.
829
+ # A system-assigned unique identifier for a server.
825
830
  #
826
831
  # @return [Types::DescribeServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
827
832
  #
@@ -837,12 +842,15 @@ module Aws::Transfer
837
842
  #
838
843
  # resp.server.arn #=> String
839
844
  # resp.server.certificate #=> String
845
+ # resp.server.domain #=> String, one of "S3", "EFS"
840
846
  # resp.server.endpoint_details.address_allocation_ids #=> Array
841
847
  # resp.server.endpoint_details.address_allocation_ids[0] #=> String
842
848
  # resp.server.endpoint_details.subnet_ids #=> Array
843
849
  # resp.server.endpoint_details.subnet_ids[0] #=> String
844
850
  # resp.server.endpoint_details.vpc_endpoint_id #=> String
845
851
  # resp.server.endpoint_details.vpc_id #=> String
852
+ # resp.server.endpoint_details.security_group_ids #=> Array
853
+ # resp.server.endpoint_details.security_group_ids[0] #=> String
846
854
  # resp.server.endpoint_type #=> String, one of "PUBLIC", "VPC", "VPC_ENDPOINT"
847
855
  # resp.server.host_key_fingerprint #=> String
848
856
  # resp.server.identity_provider_details.url #=> String
@@ -875,14 +883,13 @@ module Aws::Transfer
875
883
  # associated with the `ServerId` value that was specified.
876
884
  #
877
885
  # @option params [required, String] :server_id
878
- # A system-assigned unique identifier for a file transfer
879
- # protocol-enabled server that has this user assigned.
886
+ # A system-assigned unique identifier for a server that has this user
887
+ # assigned.
880
888
  #
881
889
  # @option params [required, String] :user_name
882
- # The name of the user assigned to one or more file transfer
883
- # protocol-enabled servers. User names are part of the sign-in
884
- # credentials to use the AWS Transfer Family service and perform file
885
- # transfer tasks.
890
+ # The name of the user assigned to one or more servers. User names are
891
+ # part of the sign-in credentials to use the AWS Transfer Family service
892
+ # and perform file transfer tasks.
886
893
  #
887
894
  # @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
888
895
  #
@@ -906,6 +913,10 @@ module Aws::Transfer
906
913
  # resp.user.home_directory_mappings[0].target #=> String
907
914
  # resp.user.home_directory_type #=> String, one of "PATH", "LOGICAL"
908
915
  # resp.user.policy #=> String
916
+ # resp.user.posix_profile.uid #=> Integer
917
+ # resp.user.posix_profile.gid #=> Integer
918
+ # resp.user.posix_profile.secondary_gids #=> Array
919
+ # resp.user.posix_profile.secondary_gids[0] #=> Integer
909
920
  # resp.user.role #=> String
910
921
  # resp.user.ssh_public_keys #=> Array
911
922
  # resp.user.ssh_public_keys[0].date_imported #=> Time
@@ -933,15 +944,13 @@ module Aws::Transfer
933
944
  # the name of the `SshPublicKeyId`.
934
945
  #
935
946
  # @option params [required, String] :server_id
936
- # A system-assigned unique identifier for a file transfer
937
- # protocol-enabled server.
947
+ # A system-assigned unique identifier for a server.
938
948
  #
939
949
  # @option params [required, String] :ssh_public_key_body
940
950
  # The public key portion of an SSH key pair.
941
951
  #
942
952
  # @option params [required, String] :user_name
943
- # The name of the user account that is assigned to one or more file
944
- # transfer protocol-enabled servers.
953
+ # The name of the user account that is assigned to one or more servers.
945
954
  #
946
955
  # @return [Types::ImportSshPublicKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
947
956
  #
@@ -1018,14 +1027,14 @@ module Aws::Transfer
1018
1027
  # with your AWS account.
1019
1028
  #
1020
1029
  # @option params [Integer] :max_results
1021
- # Specifies the number of file transfer protocol-enabled servers to
1022
- # return as a response to the `ListServers` query.
1030
+ # Specifies the number of servers to return as a response to the
1031
+ # `ListServers` query.
1023
1032
  #
1024
1033
  # @option params [String] :next_token
1025
1034
  # When additional results are obtained from the `ListServers` command, a
1026
1035
  # `NextToken` parameter is returned in the output. You can then pass the
1027
1036
  # `NextToken` parameter in a subsequent command to continue listing
1028
- # additional file transfer protocol-enabled servers.
1037
+ # additional servers.
1029
1038
  #
1030
1039
  # @return [Types::ListServersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1031
1040
  #
@@ -1046,6 +1055,7 @@ module Aws::Transfer
1046
1055
  # resp.next_token #=> String
1047
1056
  # resp.servers #=> Array
1048
1057
  # resp.servers[0].arn #=> String
1058
+ # resp.servers[0].domain #=> String, one of "S3", "EFS"
1049
1059
  # resp.servers[0].identity_provider_type #=> String, one of "SERVICE_MANAGED", "API_GATEWAY"
1050
1060
  # resp.servers[0].endpoint_type #=> String, one of "PUBLIC", "VPC", "VPC_ENDPOINT"
1051
1061
  # resp.servers[0].logging_role #=> String
@@ -1127,8 +1137,8 @@ module Aws::Transfer
1127
1137
  # additional users.
1128
1138
  #
1129
1139
  # @option params [required, String] :server_id
1130
- # A system-assigned unique identifier for a file transfer
1131
- # protocol-enabled server that has users assigned to it.
1140
+ # A system-assigned unique identifier for a server that has users
1141
+ # assigned to it.
1132
1142
  #
1133
1143
  # @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1134
1144
  #
@@ -1179,8 +1189,7 @@ module Aws::Transfer
1179
1189
  # No response is returned from this call.
1180
1190
  #
1181
1191
  # @option params [required, String] :server_id
1182
- # A system-assigned unique identifier for a file transfer
1183
- # protocol-enabled server that you start.
1192
+ # A system-assigned unique identifier for a server that you start.
1184
1193
  #
1185
1194
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1186
1195
  #
@@ -1203,8 +1212,12 @@ module Aws::Transfer
1203
1212
  # `ONLINE` to `OFFLINE`. An `OFFLINE` server cannot accept and process
1204
1213
  # file transfer jobs. Information tied to your server, such as server
1205
1214
  # and user properties, are not affected by stopping your server.
1206
- # Stopping the server will not reduce or impact your file transfer
1207
- # protocol endpoint billing.
1215
+ #
1216
+ # <note markdown="1"> Stopping the server will not reduce or impact your file transfer
1217
+ # protocol endpoint billing; you must delete the server to stop being
1218
+ # billed.
1219
+ #
1220
+ # </note>
1208
1221
  #
1209
1222
  # The state of `STOPPING` indicates that the server is in an
1210
1223
  # intermediate state, either not fully able to respond, or not fully
@@ -1213,8 +1226,7 @@ module Aws::Transfer
1213
1226
  # No response is returned from this call.
1214
1227
  #
1215
1228
  # @option params [required, String] :server_id
1216
- # A system-assigned unique identifier for a file transfer
1217
- # protocol-enabled server that you stopped.
1229
+ # A system-assigned unique identifier for a server that you stopped.
1218
1230
  #
1219
1231
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1220
1232
  #
@@ -1279,9 +1291,8 @@ module Aws::Transfer
1279
1291
  # ensure that your users can successfully use the service.
1280
1292
  #
1281
1293
  # @option params [required, String] :server_id
1282
- # A system-assigned identifier for a specific file transfer
1283
- # protocol-enabled server. That server's user authentication method is
1284
- # tested with a user name and password.
1294
+ # A system-assigned identifier for a specific server. That server's
1295
+ # user authentication method is tested with a user name and password.
1285
1296
  #
1286
1297
  # @option params [String] :server_protocol
1287
1298
  # The type of file transfer protocol to be tested.
@@ -1417,16 +1428,16 @@ module Aws::Transfer
1417
1428
  #
1418
1429
  # @option params [Types::EndpointDetails] :endpoint_details
1419
1430
  # The virtual private cloud (VPC) endpoint settings that are configured
1420
- # for your file transfer protocol-enabled server. With a VPC endpoint,
1421
- # you can restrict access to your server to resources only within your
1422
- # VPC. To control incoming internet traffic, you will need to associate
1423
- # one or more Elastic IP addresses with your server's endpoint.
1431
+ # for your server. With a VPC endpoint, you can restrict access to your
1432
+ # server to resources only within your VPC. To control incoming internet
1433
+ # traffic, you will need to associate one or more Elastic IP addresses
1434
+ # with your server's endpoint.
1424
1435
  #
1425
1436
  # @option params [String] :endpoint_type
1426
- # The type of endpoint that you want your file transfer protocol-enabled
1427
- # server to connect to. You can choose to connect to the public internet
1428
- # or a VPC endpoint. With a VPC endpoint, you can restrict access to
1429
- # your server and resources only within your VPC.
1437
+ # The type of endpoint that you want your server to connect to. You can
1438
+ # choose to connect to the public internet or a VPC endpoint. With a VPC
1439
+ # endpoint, you can restrict access to your server and resources only
1440
+ # within your VPC.
1430
1441
  #
1431
1442
  # <note markdown="1"> It is recommended that you use `VPC` as the `EndpointType`. With this
1432
1443
  # endpoint type, you have the option to directly associate up to three
@@ -1442,9 +1453,8 @@ module Aws::Transfer
1442
1453
  # my-new-server-key`.
1443
1454
  #
1444
1455
  # If you aren't planning to migrate existing users from an existing
1445
- # file transfer protocol-enabled server to a new server, don't update
1446
- # the host key. Accidentally changing a server's host key can be
1447
- # disruptive.
1456
+ # server to a new server, don't update the host key. Accidentally
1457
+ # changing a server's host key can be disruptive.
1448
1458
  #
1449
1459
  # For more information, see [Change the host key for your SFTP-enabled
1450
1460
  # server][1] in the *AWS Transfer Family User Guide*.
@@ -1496,8 +1506,8 @@ module Aws::Transfer
1496
1506
  # server.
1497
1507
  #
1498
1508
  # @option params [required, String] :server_id
1499
- # A system-assigned unique identifier for a file transfer
1500
- # protocol-enabled server instance that the user account is assigned to.
1509
+ # A system-assigned unique identifier for a server instance that the
1510
+ # user account is assigned to.
1501
1511
  #
1502
1512
  # @return [Types::UpdateServerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1503
1513
  #
@@ -1512,6 +1522,7 @@ module Aws::Transfer
1512
1522
  # subnet_ids: ["SubnetId"],
1513
1523
  # vpc_endpoint_id: "VpcEndpointId",
1514
1524
  # vpc_id: "VpcId",
1525
+ # security_group_ids: ["SecurityGroupId"],
1515
1526
  # },
1516
1527
  # endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
1517
1528
  # host_key: "HostKey",
@@ -1547,19 +1558,17 @@ module Aws::Transfer
1547
1558
  #
1548
1559
  # @option params [String] :home_directory
1549
1560
  # Specifies the landing directory (folder) for a user when they log in
1550
- # to the file transfer protocol-enabled server using their file transfer
1551
- # protocol client.
1561
+ # to the server using their file transfer protocol client.
1552
1562
  #
1553
1563
  # An example is `your-Amazon-S3-bucket-name>/home/username`.
1554
1564
  #
1555
1565
  # @option params [String] :home_directory_type
1556
1566
  # The type of landing directory (folder) you want your users' home
1557
- # directory to be when they log into the file transfer protocol-enabled
1558
- # server. If you set it to `PATH`, the user will see the absolute Amazon
1559
- # S3 bucket paths as is in their file transfer protocol clients. If you
1560
- # set it `LOGICAL`, you will need to provide mappings in the
1561
- # `HomeDirectoryMappings` for how you want to make Amazon S3 paths
1562
- # visible to your users.
1567
+ # directory to be when they log into the server. If you set it to
1568
+ # `PATH`, the user will see the absolute Amazon S3 bucket paths as is in
1569
+ # their file transfer protocol clients. If you set it `LOGICAL`, you
1570
+ # will need to provide mappings in the `HomeDirectoryMappings` for how
1571
+ # you want to make Amazon S3 paths visible to your users.
1563
1572
  #
1564
1573
  # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
1565
1574
  # Logical directory mappings that specify what Amazon S3 paths and keys
@@ -1615,26 +1624,27 @@ module Aws::Transfer
1615
1624
  # [1]: https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down
1616
1625
  # [2]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
1617
1626
  #
1627
+ # @option params [Types::PosixProfile] :posix_profile
1628
+ #
1618
1629
  # @option params [String] :role
1619
1630
  # The IAM role that controls your users' access to your Amazon S3
1620
1631
  # bucket. The policies attached to this role will determine the level of
1621
1632
  # access you want to provide your users when transferring files into and
1622
1633
  # out of your Amazon S3 bucket or buckets. The IAM role should also
1623
- # contain a trust relationship that allows the file transfer
1624
- # protocol-enabled server to access your resources when servicing your
1625
- # users' transfer requests.
1634
+ # contain a trust relationship that allows the server to access your
1635
+ # resources when servicing your users' transfer requests.
1626
1636
  #
1627
1637
  # @option params [required, String] :server_id
1628
- # A system-assigned unique identifier for a file transfer
1629
- # protocol-enabled server instance that the user account is assigned to.
1638
+ # A system-assigned unique identifier for a server instance that the
1639
+ # user account is assigned to.
1630
1640
  #
1631
1641
  # @option params [required, String] :user_name
1632
- # A unique string that identifies a user and is associated with a file
1633
- # transfer protocol-enabled server as specified by the `ServerId`. This
1634
- # user name must be a minimum of 3 and a maximum of 100 characters long.
1635
- # The following are valid characters: a-z, A-Z, 0-9, underscore '\_',
1636
- # hyphen '-', period '.', and at sign '@'. The user name can't
1637
- # start with a hyphen, period, and at sign.
1642
+ # A unique string that identifies a user and is associated with a server
1643
+ # as specified by the `ServerId`. This user name must be a minimum of 3
1644
+ # and a maximum of 100 characters long. The following are valid
1645
+ # characters: a-z, A-Z, 0-9, underscore '\_', hyphen '-', period
1646
+ # '.', and at sign '@'. The user name can't start with a hyphen,
1647
+ # period, or at sign.
1638
1648
  #
1639
1649
  # @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1640
1650
  #
@@ -1653,6 +1663,11 @@ module Aws::Transfer
1653
1663
  # },
1654
1664
  # ],
1655
1665
  # policy: "Policy",
1666
+ # posix_profile: {
1667
+ # uid: 1, # required
1668
+ # gid: 1, # required
1669
+ # secondary_gids: [1],
1670
+ # },
1656
1671
  # role: "Role",
1657
1672
  # server_id: "ServerId", # required
1658
1673
  # user_name: "UserName", # required
@@ -1685,7 +1700,7 @@ module Aws::Transfer
1685
1700
  params: params,
1686
1701
  config: config)
1687
1702
  context[:gem_name] = 'aws-sdk-transfer'
1688
- context[:gem_version] = '1.26.0'
1703
+ context[:gem_version] = '1.31.0'
1689
1704
  Seahorse::Client::Request.new(handlers, context)
1690
1705
  end
1691
1706