aws-sdk-transfer 1.58.0 → 1.60.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -333,13 +333,13 @@ module Aws::Transfer
333
333
  end
334
334
 
335
335
  # @!attribute [rw] server_id
336
- # The ID of the server that the user is attached to.
336
+ # The identifier of the server that the user is attached to.
337
337
  # @return [String]
338
338
  #
339
339
  # @!attribute [rw] external_id
340
- # The external ID of the group whose users have access to your Amazon
341
- # S3 or Amazon EFS resources over the enabled protocols using Transfer
342
- # Family.
340
+ # The external identifier of the group whose users have access to your
341
+ # Amazon S3 or Amazon EFS resources over the enabled protocols using
342
+ # Transfer Family.
343
343
  # @return [String]
344
344
  #
345
345
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateAccessResponse AWS API Documentation
@@ -391,8 +391,8 @@ module Aws::Transfer
391
391
  # The landing directory (folder) for files transferred by using the
392
392
  # AS2 protocol.
393
393
  #
394
- # A `BaseDirectory` example is `/DOC-EXAMPLE-BUCKET/home/mydirectory
395
- # `.
394
+ # A `BaseDirectory` example is
395
+ # *DOC-EXAMPLE-BUCKET*/*home*/*mydirectory*.
396
396
  # @return [String]
397
397
  #
398
398
  # @!attribute [rw] access_role
@@ -561,9 +561,14 @@ module Aws::Transfer
561
561
  # @return [String]
562
562
  #
563
563
  # @!attribute [rw] profile_type
564
- # Indicates whether to list only `LOCAL` type profiles or only
565
- # `PARTNER` type profiles. If not supplied in the request, the command
566
- # lists all types of profiles.
564
+ # Determines the type of profile to create:
565
+ #
566
+ # * Specify `LOCAL` to create a local profile. A local profile
567
+ # represents the AS2-enabled Transfer Family server organization or
568
+ # party.
569
+ #
570
+ # * Specify `PARTNER` to create a partner profile. A partner profile
571
+ # represents a remote organization, external to Transfer Family.
567
572
  # @return [String]
568
573
  #
569
574
  # @!attribute [rw] certificate_ids
@@ -640,7 +645,13 @@ module Aws::Transfer
640
645
  # },
641
646
  # ],
642
647
  # workflow_details: {
643
- # on_upload: [ # required
648
+ # on_upload: [
649
+ # {
650
+ # workflow_id: "WorkflowId", # required
651
+ # execution_role: "Role", # required
652
+ # },
653
+ # ],
654
+ # on_partial_upload: [
644
655
  # {
645
656
  # workflow_id: "WorkflowId", # required
646
657
  # execution_role: "Role", # required
@@ -737,7 +748,9 @@ module Aws::Transfer
737
748
  # @return [String]
738
749
  #
739
750
  # @!attribute [rw] host_key
740
- # The RSA, ECDSA, or ED25519 private key to use for your server.
751
+ # The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled
752
+ # server. You can add multiple host keys, in case you want to rotate
753
+ # keys, or have a set of active keys that use different algorithms.
741
754
  #
742
755
  # Use the following command to generate an RSA 2048 bit key with no
743
756
  # passphrase:
@@ -766,7 +779,7 @@ module Aws::Transfer
766
779
  # SFTP-enabled server to a new server, don't update the host key.
767
780
  # Accidentally changing a server's host key can be disruptive.
768
781
  #
769
- # For more information, see [Change the host key for your SFTP-enabled
782
+ # For more information, see [Update host keys for your SFTP-enabled
770
783
  # server][1] in the *Transfer Family User Guide*.
771
784
  #
772
785
  #
@@ -909,6 +922,12 @@ module Aws::Transfer
909
922
  # @!attribute [rw] workflow_details
910
923
  # Specifies the workflow ID for the workflow to assign and the
911
924
  # execution role that's used for executing the workflow.
925
+ #
926
+ # In additon to a workflow to execute when a file is uploaded
927
+ # completely, `WorkflowDeatails` can also contain a workflow ID (and
928
+ # execution role) for a workflow to execute on partial upload. A
929
+ # partial upload occurs when a file is open when the session
930
+ # disconnects.
912
931
  # @return [Types::WorkflowDetails]
913
932
  #
914
933
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServerRequest AWS API Documentation
@@ -934,7 +953,7 @@ module Aws::Transfer
934
953
  end
935
954
 
936
955
  # @!attribute [rw] server_id
937
- # The service-assigned ID of the server that is created.
956
+ # The service-assigned identifier of the server that is created.
938
957
  # @return [String]
939
958
  #
940
959
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServerResponse AWS API Documentation
@@ -1109,7 +1128,7 @@ module Aws::Transfer
1109
1128
  end
1110
1129
 
1111
1130
  # @!attribute [rw] server_id
1112
- # The ID of the server that the user is attached to.
1131
+ # The identifier of the server that the user is attached to.
1113
1132
  # @return [String]
1114
1133
  #
1115
1134
  # @!attribute [rw] user_name
@@ -1390,7 +1409,8 @@ module Aws::Transfer
1390
1409
  # @return [String]
1391
1410
  #
1392
1411
  # @!attribute [rw] server_id
1393
- # The server ID associated with the agreement that you are deleting.
1412
+ # The server identifier associated with the agreement that you are
1413
+ # deleting.
1394
1414
  # @return [String]
1395
1415
  #
1396
1416
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteAgreementRequest AWS API Documentation
@@ -1410,7 +1430,7 @@ module Aws::Transfer
1410
1430
  # }
1411
1431
  #
1412
1432
  # @!attribute [rw] certificate_id
1413
- # The ID of the certificate object that you are deleting.
1433
+ # The identifier of the certificate object that you are deleting.
1414
1434
  # @return [String]
1415
1435
  #
1416
1436
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteCertificateRequest AWS API Documentation
@@ -1440,6 +1460,32 @@ module Aws::Transfer
1440
1460
  include Aws::Structure
1441
1461
  end
1442
1462
 
1463
+ # @note When making an API call, you may pass DeleteHostKeyRequest
1464
+ # data as a hash:
1465
+ #
1466
+ # {
1467
+ # server_id: "ServerId", # required
1468
+ # host_key_id: "HostKeyId", # required
1469
+ # }
1470
+ #
1471
+ # @!attribute [rw] server_id
1472
+ # The identifier of the server that contains the host key that you are
1473
+ # deleting.
1474
+ # @return [String]
1475
+ #
1476
+ # @!attribute [rw] host_key_id
1477
+ # The identifier of the host key that you are deleting.
1478
+ # @return [String]
1479
+ #
1480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteHostKeyRequest AWS API Documentation
1481
+ #
1482
+ class DeleteHostKeyRequest < Struct.new(
1483
+ :server_id,
1484
+ :host_key_id)
1485
+ SENSITIVE = []
1486
+ include Aws::Structure
1487
+ end
1488
+
1443
1489
  # @note When making an API call, you may pass DeleteProfileRequest
1444
1490
  # data as a hash:
1445
1491
  #
@@ -1448,7 +1494,7 @@ module Aws::Transfer
1448
1494
  # }
1449
1495
  #
1450
1496
  # @!attribute [rw] profile_id
1451
- # The ID of the profile that you are deleting.
1497
+ # The identifier of the profile that you are deleting.
1452
1498
  # @return [String]
1453
1499
  #
1454
1500
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteProfileRequest AWS API Documentation
@@ -1641,7 +1687,8 @@ module Aws::Transfer
1641
1687
  # @return [String]
1642
1688
  #
1643
1689
  # @!attribute [rw] access
1644
- # The external ID of the server that the access is attached to.
1690
+ # The external identifier of the server that the access is attached
1691
+ # to.
1645
1692
  # @return [Types::DescribedAccess]
1646
1693
  #
1647
1694
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeAccessResponse AWS API Documentation
@@ -1667,7 +1714,7 @@ module Aws::Transfer
1667
1714
  # @return [String]
1668
1715
  #
1669
1716
  # @!attribute [rw] server_id
1670
- # The server ID that's associated with the agreement.
1717
+ # The server identifier that's associated with the agreement.
1671
1718
  # @return [String]
1672
1719
  #
1673
1720
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeAgreementRequest AWS API Documentation
@@ -1797,6 +1844,44 @@ module Aws::Transfer
1797
1844
  include Aws::Structure
1798
1845
  end
1799
1846
 
1847
+ # @note When making an API call, you may pass DescribeHostKeyRequest
1848
+ # data as a hash:
1849
+ #
1850
+ # {
1851
+ # server_id: "ServerId", # required
1852
+ # host_key_id: "HostKeyId", # required
1853
+ # }
1854
+ #
1855
+ # @!attribute [rw] server_id
1856
+ # The identifier of the server that contains the host key that you
1857
+ # want described.
1858
+ # @return [String]
1859
+ #
1860
+ # @!attribute [rw] host_key_id
1861
+ # The identifier of the host key that you want described.
1862
+ # @return [String]
1863
+ #
1864
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeHostKeyRequest AWS API Documentation
1865
+ #
1866
+ class DescribeHostKeyRequest < Struct.new(
1867
+ :server_id,
1868
+ :host_key_id)
1869
+ SENSITIVE = []
1870
+ include Aws::Structure
1871
+ end
1872
+
1873
+ # @!attribute [rw] host_key
1874
+ # Returns the details for the specified host key.
1875
+ # @return [Types::DescribedHostKey]
1876
+ #
1877
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeHostKeyResponse AWS API Documentation
1878
+ #
1879
+ class DescribeHostKeyResponse < Struct.new(
1880
+ :host_key)
1881
+ SENSITIVE = []
1882
+ include Aws::Structure
1883
+ end
1884
+
1800
1885
  # @note When making an API call, you may pass DescribeProfileRequest
1801
1886
  # data as a hash:
1802
1887
  #
@@ -2350,7 +2435,63 @@ module Aws::Transfer
2350
2435
  include Aws::Structure
2351
2436
  end
2352
2437
 
2353
- # The details for a local or partner AS2 profile. profile.
2438
+ # The details for a server host key.
2439
+ #
2440
+ # @!attribute [rw] arn
2441
+ # The unique Amazon Resource Name (ARN) for the host key.
2442
+ # @return [String]
2443
+ #
2444
+ # @!attribute [rw] host_key_id
2445
+ # A unique identifier for the host key.
2446
+ # @return [String]
2447
+ #
2448
+ # @!attribute [rw] host_key_fingerprint
2449
+ # The public key fingerprint, which is a short sequence of bytes used
2450
+ # to identify the longer public key.
2451
+ # @return [String]
2452
+ #
2453
+ # @!attribute [rw] description
2454
+ # The text description for this host key.
2455
+ # @return [String]
2456
+ #
2457
+ # @!attribute [rw] type
2458
+ # The encryption algorithm that is used for the host key. The `Type`
2459
+ # parameter is specified by using one of the following values:
2460
+ #
2461
+ # * `ssh-rsa`
2462
+ #
2463
+ # * `ssh-ed25519`
2464
+ #
2465
+ # * `ecdsa-sha2-nistp256`
2466
+ #
2467
+ # * `ecdsa-sha2-nistp384`
2468
+ #
2469
+ # * `ecdsa-sha2-nistp521`
2470
+ # @return [String]
2471
+ #
2472
+ # @!attribute [rw] date_imported
2473
+ # The date on which the host key was added to the server.
2474
+ # @return [Time]
2475
+ #
2476
+ # @!attribute [rw] tags
2477
+ # Key-value pairs that can be used to group and search for host keys.
2478
+ # @return [Array<Types::Tag>]
2479
+ #
2480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedHostKey AWS API Documentation
2481
+ #
2482
+ class DescribedHostKey < Struct.new(
2483
+ :arn,
2484
+ :host_key_id,
2485
+ :host_key_fingerprint,
2486
+ :description,
2487
+ :type,
2488
+ :date_imported,
2489
+ :tags)
2490
+ SENSITIVE = []
2491
+ include Aws::Structure
2492
+ end
2493
+
2494
+ # The details for a local or partner AS2 profile.
2354
2495
  #
2355
2496
  # @!attribute [rw] arn
2356
2497
  # The unique Amazon Resource Name (ARN) for the profile.
@@ -2646,6 +2787,12 @@ module Aws::Transfer
2646
2787
  # @!attribute [rw] workflow_details
2647
2788
  # Specifies the workflow ID for the workflow to assign and the
2648
2789
  # execution role that's used for executing the workflow.
2790
+ #
2791
+ # In additon to a workflow to execute when a file is uploaded
2792
+ # completely, `WorkflowDeatails` can also contain a workflow ID (and
2793
+ # execution role) for a workflow to execute on partial upload. A
2794
+ # partial upload occurs when a file is open when the session
2795
+ # disconnects.
2649
2796
  # @return [Types::WorkflowDetails]
2650
2797
  #
2651
2798
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedServer AWS API Documentation
@@ -2831,7 +2978,7 @@ module Aws::Transfer
2831
2978
  # }
2832
2979
  #
2833
2980
  # @!attribute [rw] file_system_id
2834
- # The ID of the file system, assigned by Amazon EFS.
2981
+ # The identifier of the file system, assigned by Amazon EFS.
2835
2982
  # @return [String]
2836
2983
  #
2837
2984
  # @!attribute [rw] path
@@ -2896,7 +3043,7 @@ module Aws::Transfer
2896
3043
  # @return [Array<String>]
2897
3044
  #
2898
3045
  # @!attribute [rw] vpc_endpoint_id
2899
- # The ID of the VPC endpoint.
3046
+ # The identifier of the VPC endpoint.
2900
3047
  #
2901
3048
  # <note markdown="1"> This property can only be set when `EndpointType` is set to
2902
3049
  # `VPC_ENDPOINT`.
@@ -2908,7 +3055,8 @@ module Aws::Transfer
2908
3055
  # @return [String]
2909
3056
  #
2910
3057
  # @!attribute [rw] vpc_id
2911
- # The VPC ID of the VPC in which a server's endpoint will be hosted.
3058
+ # The VPC identifier of the VPC in which a server's endpoint will be
3059
+ # hosted.
2912
3060
  #
2913
3061
  # <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`.
2914
3062
  #
@@ -3064,7 +3212,8 @@ module Aws::Transfer
3064
3212
  # @return [Types::S3FileLocation]
3065
3213
  #
3066
3214
  # @!attribute [rw] efs_file_location
3067
- # Specifies the Amazon EFS ID and the path for the file being used.
3215
+ # Specifies the Amazon EFS identifier and the path for the file being
3216
+ # used.
3068
3217
  # @return [Types::EfsFileLocation]
3069
3218
  #
3070
3219
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/FileLocation AWS API Documentation
@@ -3236,6 +3385,68 @@ module Aws::Transfer
3236
3385
  include Aws::Structure
3237
3386
  end
3238
3387
 
3388
+ # @note When making an API call, you may pass ImportHostKeyRequest
3389
+ # data as a hash:
3390
+ #
3391
+ # {
3392
+ # server_id: "ServerId", # required
3393
+ # host_key_body: "HostKey", # required
3394
+ # description: "HostKeyDescription",
3395
+ # tags: [
3396
+ # {
3397
+ # key: "TagKey", # required
3398
+ # value: "TagValue", # required
3399
+ # },
3400
+ # ],
3401
+ # }
3402
+ #
3403
+ # @!attribute [rw] server_id
3404
+ # The identifier of the server that contains the host key that you are
3405
+ # importing.
3406
+ # @return [String]
3407
+ #
3408
+ # @!attribute [rw] host_key_body
3409
+ # The public key portion of an SSH key pair.
3410
+ #
3411
+ # Transfer Family accepts RSA, ECDSA, and ED25519 keys.
3412
+ # @return [String]
3413
+ #
3414
+ # @!attribute [rw] description
3415
+ # The text description that identifies this host key.
3416
+ # @return [String]
3417
+ #
3418
+ # @!attribute [rw] tags
3419
+ # Key-value pairs that can be used to group and search for host keys.
3420
+ # @return [Array<Types::Tag>]
3421
+ #
3422
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportHostKeyRequest AWS API Documentation
3423
+ #
3424
+ class ImportHostKeyRequest < Struct.new(
3425
+ :server_id,
3426
+ :host_key_body,
3427
+ :description,
3428
+ :tags)
3429
+ SENSITIVE = [:host_key_body]
3430
+ include Aws::Structure
3431
+ end
3432
+
3433
+ # @!attribute [rw] server_id
3434
+ # Returns the server identifier that contains the imported key.
3435
+ # @return [String]
3436
+ #
3437
+ # @!attribute [rw] host_key_id
3438
+ # Returns the host key identifier for the imported key.
3439
+ # @return [String]
3440
+ #
3441
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportHostKeyResponse AWS API Documentation
3442
+ #
3443
+ class ImportHostKeyResponse < Struct.new(
3444
+ :server_id,
3445
+ :host_key_id)
3446
+ SENSITIVE = []
3447
+ include Aws::Structure
3448
+ end
3449
+
3239
3450
  # @note When making an API call, you may pass ImportSshPublicKeyRequest
3240
3451
  # data as a hash:
3241
3452
  #
@@ -3666,6 +3877,64 @@ module Aws::Transfer
3666
3877
  include Aws::Structure
3667
3878
  end
3668
3879
 
3880
+ # @note When making an API call, you may pass ListHostKeysRequest
3881
+ # data as a hash:
3882
+ #
3883
+ # {
3884
+ # max_results: 1,
3885
+ # next_token: "NextToken",
3886
+ # server_id: "ServerId", # required
3887
+ # }
3888
+ #
3889
+ # @!attribute [rw] max_results
3890
+ # The maximum number of host keys to return.
3891
+ # @return [Integer]
3892
+ #
3893
+ # @!attribute [rw] next_token
3894
+ # When there are additional results that were not returned, a
3895
+ # `NextToken` parameter is returned. You can use that value for a
3896
+ # subsequent call to `ListHostKeys` to continue listing results.
3897
+ # @return [String]
3898
+ #
3899
+ # @!attribute [rw] server_id
3900
+ # The identifier of the server that contains the host keys that you
3901
+ # want to view.
3902
+ # @return [String]
3903
+ #
3904
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListHostKeysRequest AWS API Documentation
3905
+ #
3906
+ class ListHostKeysRequest < Struct.new(
3907
+ :max_results,
3908
+ :next_token,
3909
+ :server_id)
3910
+ SENSITIVE = []
3911
+ include Aws::Structure
3912
+ end
3913
+
3914
+ # @!attribute [rw] next_token
3915
+ # Returns a token that you can use to call `ListHostKeys` again and
3916
+ # receive additional results, if there are any.
3917
+ # @return [String]
3918
+ #
3919
+ # @!attribute [rw] server_id
3920
+ # Returns the server identifier that contains the listed host keys.
3921
+ # @return [String]
3922
+ #
3923
+ # @!attribute [rw] host_keys
3924
+ # Returns an array, where each item contains the details of a host
3925
+ # key.
3926
+ # @return [Array<Types::ListedHostKey>]
3927
+ #
3928
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListHostKeysResponse AWS API Documentation
3929
+ #
3930
+ class ListHostKeysResponse < Struct.new(
3931
+ :next_token,
3932
+ :server_id,
3933
+ :host_keys)
3934
+ SENSITIVE = []
3935
+ include Aws::Structure
3936
+ end
3937
+
3669
3938
  # @note When making an API call, you may pass ListProfilesRequest
3670
3939
  # data as a hash:
3671
3940
  #
@@ -4214,6 +4483,59 @@ module Aws::Transfer
4214
4483
  include Aws::Structure
4215
4484
  end
4216
4485
 
4486
+ # Returns properties of the host key that's specified.
4487
+ #
4488
+ # @!attribute [rw] arn
4489
+ # The unique Amazon Resource Name (ARN) of the host key.
4490
+ # @return [String]
4491
+ #
4492
+ # @!attribute [rw] host_key_id
4493
+ # A unique identifier for the host key.
4494
+ # @return [String]
4495
+ #
4496
+ # @!attribute [rw] fingerprint
4497
+ # The public key fingerprint, which is a short sequence of bytes used
4498
+ # to identify the longer public key.
4499
+ # @return [String]
4500
+ #
4501
+ # @!attribute [rw] description
4502
+ # The current description for the host key. You can change it by
4503
+ # calling the `UpdateHostKey` operation and providing a new
4504
+ # description.
4505
+ # @return [String]
4506
+ #
4507
+ # @!attribute [rw] type
4508
+ # The encryption algorithm that is used for the host key. The `Type`
4509
+ # parameter is specified by using one of the following values:
4510
+ #
4511
+ # * `ssh-rsa`
4512
+ #
4513
+ # * `ssh-ed25519`
4514
+ #
4515
+ # * `ecdsa-sha2-nistp256`
4516
+ #
4517
+ # * `ecdsa-sha2-nistp384`
4518
+ #
4519
+ # * `ecdsa-sha2-nistp521`
4520
+ # @return [String]
4521
+ #
4522
+ # @!attribute [rw] date_imported
4523
+ # The date on which the host key was added to the server.
4524
+ # @return [Time]
4525
+ #
4526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListedHostKey AWS API Documentation
4527
+ #
4528
+ class ListedHostKey < Struct.new(
4529
+ :arn,
4530
+ :host_key_id,
4531
+ :fingerprint,
4532
+ :description,
4533
+ :type,
4534
+ :date_imported)
4535
+ SENSITIVE = []
4536
+ include Aws::Structure
4537
+ end
4538
+
4217
4539
  # Returns the properties of the profile that was specified.
4218
4540
  #
4219
4541
  # @!attribute [rw] arn
@@ -4407,8 +4729,8 @@ module Aws::Transfer
4407
4729
  include Aws::Structure
4408
4730
  end
4409
4731
 
4410
- # Contains the ID, text description, and Amazon Resource Name (ARN) for
4411
- # the workflow.
4732
+ # Contains the identifier, text description, and Amazon Resource Name
4733
+ # (ARN) for the workflow.
4412
4734
  #
4413
4735
  # @!attribute [rw] workflow_id
4414
4736
  # A unique identifier for the workflow.
@@ -4511,9 +4833,9 @@ module Aws::Transfer
4511
4833
  # IPv4 address, such as the public IP address of a firewall, router,
4512
4834
  # or load balancer. For example:
4513
4835
  #
4514
- # ` aws transfer update-server --protocol-details PassiveIp=0.0.0.0 `
4836
+ # `aws transfer update-server --protocol-details PassiveIp=0.0.0.0`
4515
4837
  #
4516
- # Replace ` 0.0.0.0 ` in the example above with the actual IP address
4838
+ # Replace `0.0.0.0` in the example above with the actual IP address
4517
4839
  # you want to use.
4518
4840
  #
4519
4841
  # <note markdown="1"> If you change the `PassiveIp` value, you must stop and then restart
@@ -4524,6 +4846,24 @@ module Aws::Transfer
4524
4846
  #
4525
4847
  # </note>
4526
4848
  #
4849
+ # *Special values*
4850
+ #
4851
+ # The `AUTO` and `0.0.0.0` are special values for the `PassiveIp`
4852
+ # parameter. The value `PassiveIp=AUTO` is assigned by default to FTP
4853
+ # and FTPS type servers. In this case, the server automatically
4854
+ # responds with one of the endpoint IPs within the PASV response.
4855
+ # `PassiveIp=0.0.0.0` has a more unique application for its usage. For
4856
+ # example, if you have a High Availability (HA) Network Load Balancer
4857
+ # (NLB) environment, where you have 3 subnets, you can only specify a
4858
+ # single IP address using the `PassiveIp` parameter. This reduces the
4859
+ # effectiveness of having High Availability. In this case, you can
4860
+ # specify `PassiveIp=0.0.0.0`. This tells the client to use the same
4861
+ # IP address as the Control connection and utilize all AZs for their
4862
+ # connections. Note, however, that not all FTP clients support the
4863
+ # `PassiveIp=0.0.0.0` response. FileZilla and WinSCP do support it. If
4864
+ # you are using other clients, check to see if your client supports
4865
+ # the `PassiveIp=0.0.0.0` response.
4866
+ #
4527
4867
  #
4528
4868
  #
4529
4869
  # [1]: http://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/
@@ -5333,13 +5673,13 @@ module Aws::Transfer
5333
5673
  end
5334
5674
 
5335
5675
  # @!attribute [rw] server_id
5336
- # The ID of the server that the user is attached to.
5676
+ # The identifier of the server that the user is attached to.
5337
5677
  # @return [String]
5338
5678
  #
5339
5679
  # @!attribute [rw] external_id
5340
- # The external ID of the group whose users have access to your Amazon
5341
- # S3 or Amazon EFS resources over the enabled protocols using Amazon
5342
- # Web ServicesTransfer Family.
5680
+ # The external identifier of the group whose users have access to your
5681
+ # Amazon S3 or Amazon EFS resources over the enabled protocols using
5682
+ # Amazon Web ServicesTransfer Family.
5343
5683
  # @return [String]
5344
5684
  #
5345
5685
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateAccessResponse AWS API Documentation
@@ -5575,6 +5915,56 @@ module Aws::Transfer
5575
5915
  include Aws::Structure
5576
5916
  end
5577
5917
 
5918
+ # @note When making an API call, you may pass UpdateHostKeyRequest
5919
+ # data as a hash:
5920
+ #
5921
+ # {
5922
+ # server_id: "ServerId", # required
5923
+ # host_key_id: "HostKeyId", # required
5924
+ # description: "HostKeyDescription", # required
5925
+ # }
5926
+ #
5927
+ # @!attribute [rw] server_id
5928
+ # The identifier of the server that contains the host key that you are
5929
+ # updating.
5930
+ # @return [String]
5931
+ #
5932
+ # @!attribute [rw] host_key_id
5933
+ # The identifier of the host key that you are updating.
5934
+ # @return [String]
5935
+ #
5936
+ # @!attribute [rw] description
5937
+ # An updated description for the host key.
5938
+ # @return [String]
5939
+ #
5940
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateHostKeyRequest AWS API Documentation
5941
+ #
5942
+ class UpdateHostKeyRequest < Struct.new(
5943
+ :server_id,
5944
+ :host_key_id,
5945
+ :description)
5946
+ SENSITIVE = []
5947
+ include Aws::Structure
5948
+ end
5949
+
5950
+ # @!attribute [rw] server_id
5951
+ # Returns the server identifier for the server that contains the
5952
+ # updated host key.
5953
+ # @return [String]
5954
+ #
5955
+ # @!attribute [rw] host_key_id
5956
+ # Returns the host key identifier for the updated host key.
5957
+ # @return [String]
5958
+ #
5959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateHostKeyResponse AWS API Documentation
5960
+ #
5961
+ class UpdateHostKeyResponse < Struct.new(
5962
+ :server_id,
5963
+ :host_key_id)
5964
+ SENSITIVE = []
5965
+ include Aws::Structure
5966
+ end
5967
+
5578
5968
  # @note When making an API call, you may pass UpdateProfileRequest
5579
5969
  # data as a hash:
5580
5970
  #
@@ -5646,7 +6036,13 @@ module Aws::Transfer
5646
6036
  # security_policy_name: "SecurityPolicyName",
5647
6037
  # server_id: "ServerId", # required
5648
6038
  # workflow_details: {
5649
- # on_upload: [ # required
6039
+ # on_upload: [
6040
+ # {
6041
+ # workflow_id: "WorkflowId", # required
6042
+ # execution_role: "Role", # required
6043
+ # },
6044
+ # ],
6045
+ # on_partial_upload: [
5650
6046
  # {
5651
6047
  # workflow_id: "WorkflowId", # required
5652
6048
  # execution_role: "Role", # required
@@ -5761,7 +6157,9 @@ module Aws::Transfer
5761
6157
  # @return [String]
5762
6158
  #
5763
6159
  # @!attribute [rw] host_key
5764
- # The RSA, ECDSA, or ED25519 private key to use for your server.
6160
+ # The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled
6161
+ # server. You can add multiple host keys, in case you want to rotate
6162
+ # keys, or have a set of active keys that use different algorithms.
5765
6163
  #
5766
6164
  # Use the following command to generate an RSA 2048 bit key with no
5767
6165
  # passphrase:
@@ -5790,7 +6188,7 @@ module Aws::Transfer
5790
6188
  # SFTP-enabled server to a new server, don't update the host key.
5791
6189
  # Accidentally changing a server's host key can be disruptive.
5792
6190
  #
5793
- # For more information, see [Change the host key for your SFTP-enabled
6191
+ # For more information, see [Update host keys for your SFTP-enabled
5794
6192
  # server][1] in the *Transfer Family User Guide*.
5795
6193
  #
5796
6194
  #
@@ -5882,6 +6280,12 @@ module Aws::Transfer
5882
6280
  # Specifies the workflow ID for the workflow to assign and the
5883
6281
  # execution role that's used for executing the workflow.
5884
6282
  #
6283
+ # In additon to a workflow to execute when a file is uploaded
6284
+ # completely, `WorkflowDeatails` can also contain a workflow ID (and
6285
+ # execution role) for a workflow to execute on partial upload. A
6286
+ # partial upload occurs when a file is open when the session
6287
+ # disconnects.
6288
+ #
5885
6289
  # To remove an associated workflow from a server, you can provide an
5886
6290
  # empty `OnUpload` object, as in the following example.
5887
6291
  #
@@ -6119,6 +6523,11 @@ module Aws::Transfer
6119
6523
  # Specifies the workflow ID for the workflow to assign and the execution
6120
6524
  # role that's used for executing the workflow.
6121
6525
  #
6526
+ # In additon to a workflow to execute when a file is uploaded
6527
+ # completely, `WorkflowDeatails` can also contain a workflow ID (and
6528
+ # execution role) for a workflow to execute on partial upload. A partial
6529
+ # upload occurs when a file is open when the session disconnects.
6530
+ #
6122
6531
  # @note When making an API call, you may pass WorkflowDetail
6123
6532
  # data as a hash:
6124
6533
  #
@@ -6153,7 +6562,13 @@ module Aws::Transfer
6153
6562
  # data as a hash:
6154
6563
  #
6155
6564
  # {
6156
- # on_upload: [ # required
6565
+ # on_upload: [
6566
+ # {
6567
+ # workflow_id: "WorkflowId", # required
6568
+ # execution_role: "Role", # required
6569
+ # },
6570
+ # ],
6571
+ # on_partial_upload: [
6157
6572
  # {
6158
6573
  # workflow_id: "WorkflowId", # required
6159
6574
  # execution_role: "Role", # required
@@ -6172,10 +6587,20 @@ module Aws::Transfer
6172
6587
  # --workflow-details '\{"OnUpload":[]\}'`
6173
6588
  # @return [Array<Types::WorkflowDetail>]
6174
6589
  #
6590
+ # @!attribute [rw] on_partial_upload
6591
+ # A trigger that starts a workflow if a file is only partially
6592
+ # uploaded. You can attach a workflow to a server that executes
6593
+ # whenever there is a partial upload.
6594
+ #
6595
+ # A *partial upload* occurs when a file is open when the session
6596
+ # disconnects.
6597
+ # @return [Array<Types::WorkflowDetail>]
6598
+ #
6175
6599
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/WorkflowDetails AWS API Documentation
6176
6600
  #
6177
6601
  class WorkflowDetails < Struct.new(
6178
- :on_upload)
6602
+ :on_upload,
6603
+ :on_partial_upload)
6179
6604
  SENSITIVE = []
6180
6605
  include Aws::Structure
6181
6606
  end