aws-sdk-transfer 1.79.0 → 1.80.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7184a8156f44a8bdab51e3346fecd7d40a24715b4ee1463df6c8fcdc2d985f05
4
- data.tar.gz: 5d88be935cf1464642f439da5d146f7550ef1fbc45e16b572050b2e3694b25e3
3
+ metadata.gz: e2da431a93d798e9c0adffcd9f4934bfd1a2e9540d27fe39b6e447599071de83
4
+ data.tar.gz: b6b37676c2618b874da9623b43646499145d74353e92eec1878b9de7f33f7cd4
5
5
  SHA512:
6
- metadata.gz: 55d8b22e89769638f11735d97d5f80778c74e56073fe92f18c55e3441462dcb3af08d0b1135599946b672c11af3b4834e184c7f36620dcd10f7d83af1f8d04f3
7
- data.tar.gz: 5c492417ff04804cc108bf280141a932ec318be9c222321b5e2907722a171b61a5de56771352171a2d6b0bb0a1f24b921d88e19f767a58ebd61ca2ea2bab6a76
6
+ metadata.gz: c265815464516b9380745a36b1462ae616eb5518155680d2ddea1cedc2e4384ab897f6e49a4514e08b2cdcbd6c0b4079565dffd3db05ba53908b2c7b9f88301b
7
+ data.tar.gz: 1abef31e31893ef405f385c9c0af9b3b45daabdec4905ad6b563cf159f2aa0dbfb2f941c19964980a52231fbfcf6179a38817849ce7376c4afb32f6a29d14c1c
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.80.0 (2023-10-02)
5
+ ------------------
6
+
7
+ * Feature - Documentation updates for AWS Transfer Family
8
+
4
9
  1.79.0 (2023-09-27)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.79.0
1
+ 1.80.0
@@ -412,15 +412,28 @@ module Aws::Transfer
412
412
  #
413
413
  # A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
414
414
  #
415
+ # <note markdown="1"> The `HomeDirectory` parameter is only used if `HomeDirectoryType` is
416
+ # set to `LOGICAL`.
417
+ #
418
+ # </note>
419
+ #
415
420
  # @option params [String] :home_directory_type
416
421
  # The type of landing directory (folder) that you want your users' home
417
422
  # directory to be when they log in to the server. If you set it to
418
- # `PATH`, the user will see the absolute Amazon S3 bucket or EFS paths
419
- # as is in their file transfer protocol clients. If you set it
423
+ # `PATH`, the user will see the absolute Amazon S3 bucket or Amazon EFS
424
+ # path as is in their file transfer protocol clients. If you set it to
420
425
  # `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings`
421
426
  # for how you want to make Amazon S3 or Amazon EFS paths visible to your
422
427
  # users.
423
428
  #
429
+ # <note markdown="1"> If `HomeDirectoryType` is `LOGICAL`, you must provide mappings, using
430
+ # the `HomeDirectoryMappings` parameter. If, on the other hand,
431
+ # `HomeDirectoryType` is `PATH`, you provide an absolute path using the
432
+ # `HomeDirectory` parameter. You cannot have both `HomeDirectory` and
433
+ # `HomeDirectoryMappings` in your template.
434
+ #
435
+ # </note>
436
+ #
424
437
  # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
425
438
  # Logical directory mappings that specify what Amazon S3 or Amazon EFS
426
439
  # paths and keys should be visible to your user and how you want to make
@@ -1205,15 +1218,28 @@ module Aws::Transfer
1205
1218
  #
1206
1219
  # A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
1207
1220
  #
1221
+ # <note markdown="1"> The `HomeDirectory` parameter is only used if `HomeDirectoryType` is
1222
+ # set to `LOGICAL`.
1223
+ #
1224
+ # </note>
1225
+ #
1208
1226
  # @option params [String] :home_directory_type
1209
1227
  # The type of landing directory (folder) that you want your users' home
1210
1228
  # directory to be when they log in to the server. If you set it to
1211
- # `PATH`, the user will see the absolute Amazon S3 bucket or EFS paths
1212
- # as is in their file transfer protocol clients. If you set it
1229
+ # `PATH`, the user will see the absolute Amazon S3 bucket or Amazon EFS
1230
+ # path as is in their file transfer protocol clients. If you set it to
1213
1231
  # `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings`
1214
1232
  # for how you want to make Amazon S3 or Amazon EFS paths visible to your
1215
1233
  # users.
1216
1234
  #
1235
+ # <note markdown="1"> If `HomeDirectoryType` is `LOGICAL`, you must provide mappings, using
1236
+ # the `HomeDirectoryMappings` parameter. If, on the other hand,
1237
+ # `HomeDirectoryType` is `PATH`, you provide an absolute path using the
1238
+ # `HomeDirectory` parameter. You cannot have both `HomeDirectory` and
1239
+ # `HomeDirectoryMappings` in your template.
1240
+ #
1241
+ # </note>
1242
+ #
1217
1243
  # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
1218
1244
  # Logical directory mappings that specify what Amazon S3 or Amazon EFS
1219
1245
  # paths and keys should be visible to your user and how you want to make
@@ -3161,9 +3187,9 @@ module Aws::Transfer
3161
3187
  # `ListUsers` request.
3162
3188
  #
3163
3189
  # @option params [String] :next_token
3164
- # When you can get additional results from the `ListUsers` call, a
3165
- # `NextToken` parameter is returned in the output. You can then pass in
3166
- # a subsequent command to the `NextToken` parameter to continue listing
3190
+ # If there are additional results from the `ListUsers` call, a
3191
+ # `NextToken` parameter is returned in the output. You can then pass the
3192
+ # `NextToken` to a subsequent `ListUsers` command, to continue listing
3167
3193
  # additional users.
3168
3194
  #
3169
3195
  # @option params [required, String] :server_id
@@ -3471,7 +3497,7 @@ module Aws::Transfer
3471
3497
 
3472
3498
  # Tests whether your SFTP connector is set up successfully. We highly
3473
3499
  # recommend that you call this operation to test your ability to
3474
- # transfer files between a Transfer Family server and a trading
3500
+ # transfer files between local Amazon Web Services storage and a trading
3475
3501
  # partner's SFTP server.
3476
3502
  #
3477
3503
  # @option params [required, String] :connector_id
@@ -3649,15 +3675,28 @@ module Aws::Transfer
3649
3675
  #
3650
3676
  # A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
3651
3677
  #
3678
+ # <note markdown="1"> The `HomeDirectory` parameter is only used if `HomeDirectoryType` is
3679
+ # set to `LOGICAL`.
3680
+ #
3681
+ # </note>
3682
+ #
3652
3683
  # @option params [String] :home_directory_type
3653
3684
  # The type of landing directory (folder) that you want your users' home
3654
3685
  # directory to be when they log in to the server. If you set it to
3655
- # `PATH`, the user will see the absolute Amazon S3 bucket or EFS paths
3656
- # as is in their file transfer protocol clients. If you set it
3686
+ # `PATH`, the user will see the absolute Amazon S3 bucket or Amazon EFS
3687
+ # path as is in their file transfer protocol clients. If you set it to
3657
3688
  # `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings`
3658
3689
  # for how you want to make Amazon S3 or Amazon EFS paths visible to your
3659
3690
  # users.
3660
3691
  #
3692
+ # <note markdown="1"> If `HomeDirectoryType` is `LOGICAL`, you must provide mappings, using
3693
+ # the `HomeDirectoryMappings` parameter. If, on the other hand,
3694
+ # `HomeDirectoryType` is `PATH`, you provide an absolute path using the
3695
+ # `HomeDirectory` parameter. You cannot have both `HomeDirectory` and
3696
+ # `HomeDirectoryMappings` in your template.
3697
+ #
3698
+ # </note>
3699
+ #
3661
3700
  # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
3662
3701
  # Logical directory mappings that specify what Amazon S3 or Amazon EFS
3663
3702
  # paths and keys should be visible to your user and how you want to make
@@ -4433,15 +4472,28 @@ module Aws::Transfer
4433
4472
  #
4434
4473
  # A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
4435
4474
  #
4475
+ # <note markdown="1"> The `HomeDirectory` parameter is only used if `HomeDirectoryType` is
4476
+ # set to `LOGICAL`.
4477
+ #
4478
+ # </note>
4479
+ #
4436
4480
  # @option params [String] :home_directory_type
4437
4481
  # The type of landing directory (folder) that you want your users' home
4438
4482
  # directory to be when they log in to the server. If you set it to
4439
- # `PATH`, the user will see the absolute Amazon S3 bucket or EFS paths
4440
- # as is in their file transfer protocol clients. If you set it
4483
+ # `PATH`, the user will see the absolute Amazon S3 bucket or Amazon EFS
4484
+ # path as is in their file transfer protocol clients. If you set it to
4441
4485
  # `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings`
4442
4486
  # for how you want to make Amazon S3 or Amazon EFS paths visible to your
4443
4487
  # users.
4444
4488
  #
4489
+ # <note markdown="1"> If `HomeDirectoryType` is `LOGICAL`, you must provide mappings, using
4490
+ # the `HomeDirectoryMappings` parameter. If, on the other hand,
4491
+ # `HomeDirectoryType` is `PATH`, you provide an absolute path using the
4492
+ # `HomeDirectory` parameter. You cannot have both `HomeDirectory` and
4493
+ # `HomeDirectoryMappings` in your template.
4494
+ #
4495
+ # </note>
4496
+ #
4445
4497
  # @option params [Array<Types::HomeDirectoryMapEntry>] :home_directory_mappings
4446
4498
  # Logical directory mappings that specify what Amazon S3 or Amazon EFS
4447
4499
  # paths and keys should be visible to your user and how you want to make
@@ -4578,7 +4630,7 @@ module Aws::Transfer
4578
4630
  params: params,
4579
4631
  config: config)
4580
4632
  context[:gem_name] = 'aws-sdk-transfer'
4581
- context[:gem_version] = '1.79.0'
4633
+ context[:gem_version] = '1.80.0'
4582
4634
  Seahorse::Client::Request.new(handlers, context)
4583
4635
  end
4584
4636
 
@@ -215,16 +215,29 @@ module Aws::Transfer
215
215
  # server using the client.
216
216
  #
217
217
  # A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
218
+ #
219
+ # <note markdown="1"> The `HomeDirectory` parameter is only used if `HomeDirectoryType` is
220
+ # set to `LOGICAL`.
221
+ #
222
+ # </note>
218
223
  # @return [String]
219
224
  #
220
225
  # @!attribute [rw] home_directory_type
221
226
  # The type of landing directory (folder) that you want your users'
222
227
  # home directory to be when they log in to the server. If you set it
223
- # to `PATH`, the user will see the absolute Amazon S3 bucket or EFS
224
- # paths as is in their file transfer protocol clients. If you set it
225
- # `LOGICAL`, you need to provide mappings in the
228
+ # to `PATH`, the user will see the absolute Amazon S3 bucket or Amazon
229
+ # EFS path as is in their file transfer protocol clients. If you set
230
+ # it to `LOGICAL`, you need to provide mappings in the
226
231
  # `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon
227
232
  # EFS paths visible to your users.
233
+ #
234
+ # <note markdown="1"> If `HomeDirectoryType` is `LOGICAL`, you must provide mappings,
235
+ # using the `HomeDirectoryMappings` parameter. If, on the other hand,
236
+ # `HomeDirectoryType` is `PATH`, you provide an absolute path using
237
+ # the `HomeDirectory` parameter. You cannot have both `HomeDirectory`
238
+ # and `HomeDirectoryMappings` in your template.
239
+ #
240
+ # </note>
228
241
  # @return [String]
229
242
  #
230
243
  # @!attribute [rw] home_directory_mappings
@@ -935,16 +948,29 @@ module Aws::Transfer
935
948
  # server using the client.
936
949
  #
937
950
  # A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
951
+ #
952
+ # <note markdown="1"> The `HomeDirectory` parameter is only used if `HomeDirectoryType` is
953
+ # set to `LOGICAL`.
954
+ #
955
+ # </note>
938
956
  # @return [String]
939
957
  #
940
958
  # @!attribute [rw] home_directory_type
941
959
  # The type of landing directory (folder) that you want your users'
942
960
  # home directory to be when they log in to the server. If you set it
943
- # to `PATH`, the user will see the absolute Amazon S3 bucket or EFS
944
- # paths as is in their file transfer protocol clients. If you set it
945
- # `LOGICAL`, you need to provide mappings in the
961
+ # to `PATH`, the user will see the absolute Amazon S3 bucket or Amazon
962
+ # EFS path as is in their file transfer protocol clients. If you set
963
+ # it to `LOGICAL`, you need to provide mappings in the
946
964
  # `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon
947
965
  # EFS paths visible to your users.
966
+ #
967
+ # <note markdown="1"> If `HomeDirectoryType` is `LOGICAL`, you must provide mappings,
968
+ # using the `HomeDirectoryMappings` parameter. If, on the other hand,
969
+ # `HomeDirectoryType` is `PATH`, you provide an absolute path using
970
+ # the `HomeDirectory` parameter. You cannot have both `HomeDirectory`
971
+ # and `HomeDirectoryMappings` in your template.
972
+ #
973
+ # </note>
948
974
  # @return [String]
949
975
  #
950
976
  # @!attribute [rw] home_directory_mappings
@@ -1814,6 +1840,11 @@ module Aws::Transfer
1814
1840
  # server using the client.
1815
1841
  #
1816
1842
  # A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
1843
+ #
1844
+ # <note markdown="1"> The `HomeDirectory` parameter is only used if `HomeDirectoryType` is
1845
+ # set to `LOGICAL`.
1846
+ #
1847
+ # </note>
1817
1848
  # @return [String]
1818
1849
  #
1819
1850
  # @!attribute [rw] home_directory_mappings
@@ -1836,11 +1867,19 @@ module Aws::Transfer
1836
1867
  # @!attribute [rw] home_directory_type
1837
1868
  # The type of landing directory (folder) that you want your users'
1838
1869
  # home directory to be when they log in to the server. If you set it
1839
- # to `PATH`, the user will see the absolute Amazon S3 bucket or EFS
1840
- # paths as is in their file transfer protocol clients. If you set it
1841
- # `LOGICAL`, you need to provide mappings in the
1870
+ # to `PATH`, the user will see the absolute Amazon S3 bucket or Amazon
1871
+ # EFS path as is in their file transfer protocol clients. If you set
1872
+ # it to `LOGICAL`, you need to provide mappings in the
1842
1873
  # `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon
1843
1874
  # EFS paths visible to your users.
1875
+ #
1876
+ # <note markdown="1"> If `HomeDirectoryType` is `LOGICAL`, you must provide mappings,
1877
+ # using the `HomeDirectoryMappings` parameter. If, on the other hand,
1878
+ # `HomeDirectoryType` is `PATH`, you provide an absolute path using
1879
+ # the `HomeDirectory` parameter. You cannot have both `HomeDirectory`
1880
+ # and `HomeDirectoryMappings` in your template.
1881
+ #
1882
+ # </note>
1844
1883
  # @return [String]
1845
1884
  #
1846
1885
  # @!attribute [rw] policy
@@ -2656,6 +2695,11 @@ module Aws::Transfer
2656
2695
  # server using the client.
2657
2696
  #
2658
2697
  # A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
2698
+ #
2699
+ # <note markdown="1"> The `HomeDirectory` parameter is only used if `HomeDirectoryType` is
2700
+ # set to `LOGICAL`.
2701
+ #
2702
+ # </note>
2659
2703
  # @return [String]
2660
2704
  #
2661
2705
  # @!attribute [rw] home_directory_mappings
@@ -2678,11 +2722,19 @@ module Aws::Transfer
2678
2722
  # @!attribute [rw] home_directory_type
2679
2723
  # The type of landing directory (folder) that you want your users'
2680
2724
  # home directory to be when they log in to the server. If you set it
2681
- # to `PATH`, the user will see the absolute Amazon S3 bucket or EFS
2682
- # paths as is in their file transfer protocol clients. If you set it
2683
- # `LOGICAL`, you need to provide mappings in the
2725
+ # to `PATH`, the user will see the absolute Amazon S3 bucket or Amazon
2726
+ # EFS path as is in their file transfer protocol clients. If you set
2727
+ # it to `LOGICAL`, you need to provide mappings in the
2684
2728
  # `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon
2685
2729
  # EFS paths visible to your users.
2730
+ #
2731
+ # <note markdown="1"> If `HomeDirectoryType` is `LOGICAL`, you must provide mappings,
2732
+ # using the `HomeDirectoryMappings` parameter. If, on the other hand,
2733
+ # `HomeDirectoryType` is `PATH`, you provide an absolute path using
2734
+ # the `HomeDirectory` parameter. You cannot have both `HomeDirectory`
2735
+ # and `HomeDirectoryMappings` in your template.
2736
+ #
2737
+ # </note>
2686
2738
  # @return [String]
2687
2739
  #
2688
2740
  # @!attribute [rw] policy
@@ -3308,8 +3360,8 @@ module Aws::Transfer
3308
3360
  include Aws::Structure
3309
3361
  end
3310
3362
 
3311
- # This exception is thrown when an error occurs in the Amazon Web
3312
- # ServicesTransfer Family service.
3363
+ # This exception is thrown when an error occurs in the Transfer Family
3364
+ # service.
3313
3365
  #
3314
3366
  # @!attribute [rw] message
3315
3367
  # @return [String]
@@ -3826,9 +3878,9 @@ module Aws::Transfer
3826
3878
  # @return [Integer]
3827
3879
  #
3828
3880
  # @!attribute [rw] next_token
3829
- # When you can get additional results from the `ListUsers` call, a
3881
+ # If there are additional results from the `ListUsers` call, a
3830
3882
  # `NextToken` parameter is returned in the output. You can then pass
3831
- # in a subsequent command to the `NextToken` parameter to continue
3883
+ # the `NextToken` to a subsequent `ListUsers` command, to continue
3832
3884
  # listing additional users.
3833
3885
  # @return [String]
3834
3886
  #
@@ -3920,16 +3972,29 @@ module Aws::Transfer
3920
3972
  # server using the client.
3921
3973
  #
3922
3974
  # A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
3975
+ #
3976
+ # <note markdown="1"> The `HomeDirectory` parameter is only used if `HomeDirectoryType` is
3977
+ # set to `LOGICAL`.
3978
+ #
3979
+ # </note>
3923
3980
  # @return [String]
3924
3981
  #
3925
3982
  # @!attribute [rw] home_directory_type
3926
3983
  # The type of landing directory (folder) that you want your users'
3927
3984
  # home directory to be when they log in to the server. If you set it
3928
- # to `PATH`, the user will see the absolute Amazon S3 bucket or EFS
3929
- # paths as is in their file transfer protocol clients. If you set it
3930
- # `LOGICAL`, you need to provide mappings in the
3985
+ # to `PATH`, the user will see the absolute Amazon S3 bucket or Amazon
3986
+ # EFS path as is in their file transfer protocol clients. If you set
3987
+ # it to `LOGICAL`, you need to provide mappings in the
3931
3988
  # `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon
3932
3989
  # EFS paths visible to your users.
3990
+ #
3991
+ # <note markdown="1"> If `HomeDirectoryType` is `LOGICAL`, you must provide mappings,
3992
+ # using the `HomeDirectoryMappings` parameter. If, on the other hand,
3993
+ # `HomeDirectoryType` is `PATH`, you provide an absolute path using
3994
+ # the `HomeDirectory` parameter. You cannot have both `HomeDirectory`
3995
+ # and `HomeDirectoryMappings` in your template.
3996
+ #
3997
+ # </note>
3933
3998
  # @return [String]
3934
3999
  #
3935
4000
  # @!attribute [rw] role
@@ -4326,16 +4391,29 @@ module Aws::Transfer
4326
4391
  # server using the client.
4327
4392
  #
4328
4393
  # A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
4394
+ #
4395
+ # <note markdown="1"> The `HomeDirectory` parameter is only used if `HomeDirectoryType` is
4396
+ # set to `LOGICAL`.
4397
+ #
4398
+ # </note>
4329
4399
  # @return [String]
4330
4400
  #
4331
4401
  # @!attribute [rw] home_directory_type
4332
4402
  # The type of landing directory (folder) that you want your users'
4333
4403
  # home directory to be when they log in to the server. If you set it
4334
- # to `PATH`, the user will see the absolute Amazon S3 bucket or EFS
4335
- # paths as is in their file transfer protocol clients. If you set it
4336
- # `LOGICAL`, you need to provide mappings in the
4404
+ # to `PATH`, the user will see the absolute Amazon S3 bucket or Amazon
4405
+ # EFS path as is in their file transfer protocol clients. If you set
4406
+ # it to `LOGICAL`, you need to provide mappings in the
4337
4407
  # `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon
4338
4408
  # EFS paths visible to your users.
4409
+ #
4410
+ # <note markdown="1"> If `HomeDirectoryType` is `LOGICAL`, you must provide mappings,
4411
+ # using the `HomeDirectoryMappings` parameter. If, on the other hand,
4412
+ # `HomeDirectoryType` is `PATH`, you provide an absolute path using
4413
+ # the `HomeDirectory` parameter. You cannot have both `HomeDirectory`
4414
+ # and `HomeDirectoryMappings` in your template.
4415
+ #
4416
+ # </note>
4339
4417
  # @return [String]
4340
4418
  #
4341
4419
  # @!attribute [rw] role
@@ -4580,7 +4658,8 @@ module Aws::Transfer
4580
4658
  include Aws::Structure
4581
4659
  end
4582
4660
 
4583
- # The requested resource does not exist.
4661
+ # The requested resource does not exist, or exists in a region other
4662
+ # than the one specified for the command.
4584
4663
  #
4585
4664
  # @!attribute [rw] message
4586
4665
  # @return [String]
@@ -4792,7 +4871,8 @@ module Aws::Transfer
4792
4871
  #
4793
4872
  # The three standard SSH public key format elements are `<key type>`,
4794
4873
  # `<body base64>`, and an optional `<comment>`, with spaces between
4795
- # each element.
4874
+ # each element. Specify only the `<key type>` and `<body base64>`: do
4875
+ # not enter the `<comment>` portion of the key.
4796
4876
  #
4797
4877
  # For the trusted host key, Transfer Family accepts RSA and ECDSA
4798
4878
  # keys.
@@ -5032,21 +5112,20 @@ module Aws::Transfer
5032
5112
  # @!attribute [rw] status_message
5033
5113
  # Returns `Connection succeeded` if the test is successful. Or,
5034
5114
  # returns a descriptive error message if the test fails. The following
5035
- # list provides the details for some error messages and
5036
- # troubleshooting steps for each.
5115
+ # list provides troubleshooting details, depending on the error
5116
+ # message that you receive.
5037
5117
  #
5038
- # * **Unable to access secrets manager**: Verify that your secret name
5039
- # aligns with the one in Transfer Role permissions.
5118
+ # * Verify that your secret name aligns with the one in Transfer Role
5119
+ # permissions.
5040
5120
  #
5041
- # * **Unknown Host/Connection failed**: Verify the server URL in the
5042
- # connector configuration , and verify that the login credentials
5043
- # work successfully outside of the connector.
5121
+ # * Verify the server URL in the connector configuration , and verify
5122
+ # that the login credentials work successfully outside of the
5123
+ # connector.
5044
5124
  #
5045
- # * **Private key not found**: Verify that the secret exists and is
5046
- # formatted correctly.
5125
+ # * Verify that the secret exists and is formatted correctly.
5047
5126
  #
5048
- # * **Invalid trusted host keys**: Verify that the trusted host key in
5049
- # the connector configuration matches the `ssh-keyscan` output.
5127
+ # * Verify that the trusted host key in the connector configuration
5128
+ # matches the `ssh-keyscan` output.
5050
5129
  # @return [String]
5051
5130
  #
5052
5131
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestConnectionResponse AWS API Documentation
@@ -5175,16 +5254,29 @@ module Aws::Transfer
5175
5254
  # server using the client.
5176
5255
  #
5177
5256
  # A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
5257
+ #
5258
+ # <note markdown="1"> The `HomeDirectory` parameter is only used if `HomeDirectoryType` is
5259
+ # set to `LOGICAL`.
5260
+ #
5261
+ # </note>
5178
5262
  # @return [String]
5179
5263
  #
5180
5264
  # @!attribute [rw] home_directory_type
5181
5265
  # The type of landing directory (folder) that you want your users'
5182
5266
  # home directory to be when they log in to the server. If you set it
5183
- # to `PATH`, the user will see the absolute Amazon S3 bucket or EFS
5184
- # paths as is in their file transfer protocol clients. If you set it
5185
- # `LOGICAL`, you need to provide mappings in the
5267
+ # to `PATH`, the user will see the absolute Amazon S3 bucket or Amazon
5268
+ # EFS path as is in their file transfer protocol clients. If you set
5269
+ # it to `LOGICAL`, you need to provide mappings in the
5186
5270
  # `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon
5187
5271
  # EFS paths visible to your users.
5272
+ #
5273
+ # <note markdown="1"> If `HomeDirectoryType` is `LOGICAL`, you must provide mappings,
5274
+ # using the `HomeDirectoryMappings` parameter. If, on the other hand,
5275
+ # `HomeDirectoryType` is `PATH`, you provide an absolute path using
5276
+ # the `HomeDirectory` parameter. You cannot have both `HomeDirectory`
5277
+ # and `HomeDirectoryMappings` in your template.
5278
+ #
5279
+ # </note>
5188
5280
  # @return [String]
5189
5281
  #
5190
5282
  # @!attribute [rw] home_directory_mappings
@@ -5922,16 +6014,29 @@ module Aws::Transfer
5922
6014
  # server using the client.
5923
6015
  #
5924
6016
  # A `HomeDirectory` example is `/bucket_name/home/mydirectory`.
6017
+ #
6018
+ # <note markdown="1"> The `HomeDirectory` parameter is only used if `HomeDirectoryType` is
6019
+ # set to `LOGICAL`.
6020
+ #
6021
+ # </note>
5925
6022
  # @return [String]
5926
6023
  #
5927
6024
  # @!attribute [rw] home_directory_type
5928
6025
  # The type of landing directory (folder) that you want your users'
5929
6026
  # home directory to be when they log in to the server. If you set it
5930
- # to `PATH`, the user will see the absolute Amazon S3 bucket or EFS
5931
- # paths as is in their file transfer protocol clients. If you set it
5932
- # `LOGICAL`, you need to provide mappings in the
6027
+ # to `PATH`, the user will see the absolute Amazon S3 bucket or Amazon
6028
+ # EFS path as is in their file transfer protocol clients. If you set
6029
+ # it to `LOGICAL`, you need to provide mappings in the
5933
6030
  # `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon
5934
6031
  # EFS paths visible to your users.
6032
+ #
6033
+ # <note markdown="1"> If `HomeDirectoryType` is `LOGICAL`, you must provide mappings,
6034
+ # using the `HomeDirectoryMappings` parameter. If, on the other hand,
6035
+ # `HomeDirectoryType` is `PATH`, you provide an absolute path using
6036
+ # the `HomeDirectory` parameter. You cannot have both `HomeDirectory`
6037
+ # and `HomeDirectoryMappings` in your template.
6038
+ #
6039
+ # </note>
5935
6040
  # @return [String]
5936
6041
  #
5937
6042
  # @!attribute [rw] home_directory_mappings
@@ -53,6 +53,6 @@ require_relative 'aws-sdk-transfer/customizations'
53
53
  # @!group service
54
54
  module Aws::Transfer
55
55
 
56
- GEM_VERSION = '1.79.0'
56
+ GEM_VERSION = '1.80.0'
57
57
 
58
58
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-transfer
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.79.0
4
+ version: 1.80.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-09-27 00:00:00.000000000 Z
11
+ date: 2023-10-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core