aws-sdk-transfer 1.59.0 → 1.61.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
@@ -1449,12 +1469,12 @@ module Aws::Transfer
1449
1469
  # }
1450
1470
  #
1451
1471
  # @!attribute [rw] server_id
1452
- # Provide the ID of the server that contains the host key that you are
1472
+ # The identifier of the server that contains the host key that you are
1453
1473
  # deleting.
1454
1474
  # @return [String]
1455
1475
  #
1456
1476
  # @!attribute [rw] host_key_id
1457
- # The ID of the host key that you are deleting.
1477
+ # The identifier of the host key that you are deleting.
1458
1478
  # @return [String]
1459
1479
  #
1460
1480
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteHostKeyRequest AWS API Documentation
@@ -1474,7 +1494,7 @@ module Aws::Transfer
1474
1494
  # }
1475
1495
  #
1476
1496
  # @!attribute [rw] profile_id
1477
- # The ID of the profile that you are deleting.
1497
+ # The identifier of the profile that you are deleting.
1478
1498
  # @return [String]
1479
1499
  #
1480
1500
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteProfileRequest AWS API Documentation
@@ -1667,7 +1687,8 @@ module Aws::Transfer
1667
1687
  # @return [String]
1668
1688
  #
1669
1689
  # @!attribute [rw] access
1670
- # 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.
1671
1692
  # @return [Types::DescribedAccess]
1672
1693
  #
1673
1694
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeAccessResponse AWS API Documentation
@@ -1693,7 +1714,7 @@ module Aws::Transfer
1693
1714
  # @return [String]
1694
1715
  #
1695
1716
  # @!attribute [rw] server_id
1696
- # The server ID that's associated with the agreement.
1717
+ # The server identifier that's associated with the agreement.
1697
1718
  # @return [String]
1698
1719
  #
1699
1720
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeAgreementRequest AWS API Documentation
@@ -1832,12 +1853,12 @@ module Aws::Transfer
1832
1853
  # }
1833
1854
  #
1834
1855
  # @!attribute [rw] server_id
1835
- # Provide the ID of the server that contains the host key that you
1856
+ # The identifier of the server that contains the host key that you
1836
1857
  # want described.
1837
1858
  # @return [String]
1838
1859
  #
1839
1860
  # @!attribute [rw] host_key_id
1840
- # Provide the ID of the host key that you want described.
1861
+ # The identifier of the host key that you want described.
1841
1862
  # @return [String]
1842
1863
  #
1843
1864
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeHostKeyRequest AWS API Documentation
@@ -2434,18 +2455,18 @@ module Aws::Transfer
2434
2455
  # @return [String]
2435
2456
  #
2436
2457
  # @!attribute [rw] type
2437
- # The encryption algorithm used for the host key. The `Type` is one of
2438
- # the following values:
2458
+ # The encryption algorithm that is used for the host key. The `Type`
2459
+ # parameter is specified by using one of the following values:
2439
2460
  #
2440
- # * ssh-rsa
2461
+ # * `ssh-rsa`
2441
2462
  #
2442
- # * ssh-ed25519
2463
+ # * `ssh-ed25519`
2443
2464
  #
2444
- # * ecdsa-sha2-nistp256
2465
+ # * `ecdsa-sha2-nistp256`
2445
2466
  #
2446
- # * ecdsa-sha2-nistp384
2467
+ # * `ecdsa-sha2-nistp384`
2447
2468
  #
2448
- # * ecdsa-sha2-nistp521
2469
+ # * `ecdsa-sha2-nistp521`
2449
2470
  # @return [String]
2450
2471
  #
2451
2472
  # @!attribute [rw] date_imported
@@ -2470,7 +2491,7 @@ module Aws::Transfer
2470
2491
  include Aws::Structure
2471
2492
  end
2472
2493
 
2473
- # The details for a local or partner AS2 profile. profile.
2494
+ # The details for a local or partner AS2 profile.
2474
2495
  #
2475
2496
  # @!attribute [rw] arn
2476
2497
  # The unique Amazon Resource Name (ARN) for the profile.
@@ -2766,6 +2787,12 @@ module Aws::Transfer
2766
2787
  # @!attribute [rw] workflow_details
2767
2788
  # Specifies the workflow ID for the workflow to assign and the
2768
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.
2769
2796
  # @return [Types::WorkflowDetails]
2770
2797
  #
2771
2798
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedServer AWS API Documentation
@@ -2951,7 +2978,7 @@ module Aws::Transfer
2951
2978
  # }
2952
2979
  #
2953
2980
  # @!attribute [rw] file_system_id
2954
- # The ID of the file system, assigned by Amazon EFS.
2981
+ # The identifier of the file system, assigned by Amazon EFS.
2955
2982
  # @return [String]
2956
2983
  #
2957
2984
  # @!attribute [rw] path
@@ -3016,7 +3043,7 @@ module Aws::Transfer
3016
3043
  # @return [Array<String>]
3017
3044
  #
3018
3045
  # @!attribute [rw] vpc_endpoint_id
3019
- # The ID of the VPC endpoint.
3046
+ # The identifier of the VPC endpoint.
3020
3047
  #
3021
3048
  # <note markdown="1"> This property can only be set when `EndpointType` is set to
3022
3049
  # `VPC_ENDPOINT`.
@@ -3028,7 +3055,8 @@ module Aws::Transfer
3028
3055
  # @return [String]
3029
3056
  #
3030
3057
  # @!attribute [rw] vpc_id
3031
- # 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.
3032
3060
  #
3033
3061
  # <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`.
3034
3062
  #
@@ -3184,7 +3212,8 @@ module Aws::Transfer
3184
3212
  # @return [Types::S3FileLocation]
3185
3213
  #
3186
3214
  # @!attribute [rw] efs_file_location
3187
- # 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.
3188
3217
  # @return [Types::EfsFileLocation]
3189
3218
  #
3190
3219
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/FileLocation AWS API Documentation
@@ -3372,7 +3401,7 @@ module Aws::Transfer
3372
3401
  # }
3373
3402
  #
3374
3403
  # @!attribute [rw] server_id
3375
- # Provide the ID of the server that contains the host key that you are
3404
+ # The identifier of the server that contains the host key that you are
3376
3405
  # importing.
3377
3406
  # @return [String]
3378
3407
  #
@@ -3383,7 +3412,7 @@ module Aws::Transfer
3383
3412
  # @return [String]
3384
3413
  #
3385
3414
  # @!attribute [rw] description
3386
- # Enter a text description to identify this host key.
3415
+ # The text description that identifies this host key.
3387
3416
  # @return [String]
3388
3417
  #
3389
3418
  # @!attribute [rw] tags
@@ -3402,11 +3431,11 @@ module Aws::Transfer
3402
3431
  end
3403
3432
 
3404
3433
  # @!attribute [rw] server_id
3405
- # Returns the server ID that contains the imported key.
3434
+ # Returns the server identifier that contains the imported key.
3406
3435
  # @return [String]
3407
3436
  #
3408
3437
  # @!attribute [rw] host_key_id
3409
- # Returns the host key ID for the imported key.
3438
+ # Returns the host key identifier for the imported key.
3410
3439
  # @return [String]
3411
3440
  #
3412
3441
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportHostKeyResponse AWS API Documentation
@@ -3868,7 +3897,7 @@ module Aws::Transfer
3868
3897
  # @return [String]
3869
3898
  #
3870
3899
  # @!attribute [rw] server_id
3871
- # Provide the ID of the server that contains the host keys that you
3900
+ # The identifier of the server that contains the host keys that you
3872
3901
  # want to view.
3873
3902
  # @return [String]
3874
3903
  #
@@ -3888,7 +3917,7 @@ module Aws::Transfer
3888
3917
  # @return [String]
3889
3918
  #
3890
3919
  # @!attribute [rw] server_id
3891
- # Returns the server ID that contains the listed host keys.
3920
+ # Returns the server identifier that contains the listed host keys.
3892
3921
  # @return [String]
3893
3922
  #
3894
3923
  # @!attribute [rw] host_keys
@@ -4454,13 +4483,14 @@ module Aws::Transfer
4454
4483
  include Aws::Structure
4455
4484
  end
4456
4485
 
4457
- # Returns properties of the host key that is specified.
4486
+ # Returns properties of the host key that's specified.
4458
4487
  #
4459
4488
  # @!attribute [rw] arn
4460
- # Specifies the unique Amazon Resource Name (ARN) of the host key.
4489
+ # The unique Amazon Resource Name (ARN) of the host key.
4461
4490
  # @return [String]
4462
4491
  #
4463
4492
  # @!attribute [rw] host_key_id
4493
+ # A unique identifier for the host key.
4464
4494
  # @return [String]
4465
4495
  #
4466
4496
  # @!attribute [rw] fingerprint
@@ -4475,18 +4505,18 @@ module Aws::Transfer
4475
4505
  # @return [String]
4476
4506
  #
4477
4507
  # @!attribute [rw] type
4478
- # The encryption algorithm used for the host key. The `Type` is one of
4479
- # the following values:
4508
+ # The encryption algorithm that is used for the host key. The `Type`
4509
+ # parameter is specified by using one of the following values:
4480
4510
  #
4481
- # * ssh-rsa
4511
+ # * `ssh-rsa`
4482
4512
  #
4483
- # * ssh-ed25519
4513
+ # * `ssh-ed25519`
4484
4514
  #
4485
- # * ecdsa-sha2-nistp256
4515
+ # * `ecdsa-sha2-nistp256`
4486
4516
  #
4487
- # * ecdsa-sha2-nistp384
4517
+ # * `ecdsa-sha2-nistp384`
4488
4518
  #
4489
- # * ecdsa-sha2-nistp521
4519
+ # * `ecdsa-sha2-nistp521`
4490
4520
  # @return [String]
4491
4521
  #
4492
4522
  # @!attribute [rw] date_imported
@@ -4699,8 +4729,8 @@ module Aws::Transfer
4699
4729
  include Aws::Structure
4700
4730
  end
4701
4731
 
4702
- # Contains the ID, text description, and Amazon Resource Name (ARN) for
4703
- # the workflow.
4732
+ # Contains the identifier, text description, and Amazon Resource Name
4733
+ # (ARN) for the workflow.
4704
4734
  #
4705
4735
  # @!attribute [rw] workflow_id
4706
4736
  # A unique identifier for the workflow.
@@ -4803,9 +4833,9 @@ module Aws::Transfer
4803
4833
  # IPv4 address, such as the public IP address of a firewall, router,
4804
4834
  # or load balancer. For example:
4805
4835
  #
4806
- # ` aws transfer update-server --protocol-details PassiveIp=0.0.0.0 `
4836
+ # `aws transfer update-server --protocol-details PassiveIp=0.0.0.0`
4807
4837
  #
4808
- # 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
4809
4839
  # you want to use.
4810
4840
  #
4811
4841
  # <note markdown="1"> If you change the `PassiveIp` value, you must stop and then restart
@@ -4816,6 +4846,24 @@ module Aws::Transfer
4816
4846
  #
4817
4847
  # </note>
4818
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
+ #
4819
4867
  #
4820
4868
  #
4821
4869
  # [1]: http://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/
@@ -5625,13 +5673,13 @@ module Aws::Transfer
5625
5673
  end
5626
5674
 
5627
5675
  # @!attribute [rw] server_id
5628
- # The ID of the server that the user is attached to.
5676
+ # The identifier of the server that the user is attached to.
5629
5677
  # @return [String]
5630
5678
  #
5631
5679
  # @!attribute [rw] external_id
5632
- # The external ID of the group whose users have access to your Amazon
5633
- # S3 or Amazon EFS resources over the enabled protocols using Amazon
5634
- # 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.
5635
5683
  # @return [String]
5636
5684
  #
5637
5685
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateAccessResponse AWS API Documentation
@@ -5877,16 +5925,16 @@ module Aws::Transfer
5877
5925
  # }
5878
5926
  #
5879
5927
  # @!attribute [rw] server_id
5880
- # Provide the ID of the server that contains the host key that you are
5928
+ # The identifier of the server that contains the host key that you are
5881
5929
  # updating.
5882
5930
  # @return [String]
5883
5931
  #
5884
5932
  # @!attribute [rw] host_key_id
5885
- # Provide the ID of the host key that you are updating.
5933
+ # The identifier of the host key that you are updating.
5886
5934
  # @return [String]
5887
5935
  #
5888
5936
  # @!attribute [rw] description
5889
- # Provide an updated description for the host key.
5937
+ # An updated description for the host key.
5890
5938
  # @return [String]
5891
5939
  #
5892
5940
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateHostKeyRequest AWS API Documentation
@@ -5900,12 +5948,12 @@ module Aws::Transfer
5900
5948
  end
5901
5949
 
5902
5950
  # @!attribute [rw] server_id
5903
- # Returns the server ID for the server that contains the updated host
5904
- # key.
5951
+ # Returns the server identifier for the server that contains the
5952
+ # updated host key.
5905
5953
  # @return [String]
5906
5954
  #
5907
5955
  # @!attribute [rw] host_key_id
5908
- # Returns the host key ID for the updated host key.
5956
+ # Returns the host key identifier for the updated host key.
5909
5957
  # @return [String]
5910
5958
  #
5911
5959
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateHostKeyResponse AWS API Documentation
@@ -5988,7 +6036,13 @@ module Aws::Transfer
5988
6036
  # security_policy_name: "SecurityPolicyName",
5989
6037
  # server_id: "ServerId", # required
5990
6038
  # workflow_details: {
5991
- # on_upload: [ # required
6039
+ # on_upload: [
6040
+ # {
6041
+ # workflow_id: "WorkflowId", # required
6042
+ # execution_role: "Role", # required
6043
+ # },
6044
+ # ],
6045
+ # on_partial_upload: [
5992
6046
  # {
5993
6047
  # workflow_id: "WorkflowId", # required
5994
6048
  # execution_role: "Role", # required
@@ -6103,7 +6157,9 @@ module Aws::Transfer
6103
6157
  # @return [String]
6104
6158
  #
6105
6159
  # @!attribute [rw] host_key
6106
- # 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.
6107
6163
  #
6108
6164
  # Use the following command to generate an RSA 2048 bit key with no
6109
6165
  # passphrase:
@@ -6132,7 +6188,7 @@ module Aws::Transfer
6132
6188
  # SFTP-enabled server to a new server, don't update the host key.
6133
6189
  # Accidentally changing a server's host key can be disruptive.
6134
6190
  #
6135
- # For more information, see [Change the host key for your SFTP-enabled
6191
+ # For more information, see [Update host keys for your SFTP-enabled
6136
6192
  # server][1] in the *Transfer Family User Guide*.
6137
6193
  #
6138
6194
  #
@@ -6224,6 +6280,12 @@ module Aws::Transfer
6224
6280
  # Specifies the workflow ID for the workflow to assign and the
6225
6281
  # execution role that's used for executing the workflow.
6226
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
+ #
6227
6289
  # To remove an associated workflow from a server, you can provide an
6228
6290
  # empty `OnUpload` object, as in the following example.
6229
6291
  #
@@ -6461,6 +6523,11 @@ module Aws::Transfer
6461
6523
  # Specifies the workflow ID for the workflow to assign and the execution
6462
6524
  # role that's used for executing the workflow.
6463
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
+ #
6464
6531
  # @note When making an API call, you may pass WorkflowDetail
6465
6532
  # data as a hash:
6466
6533
  #
@@ -6495,7 +6562,13 @@ module Aws::Transfer
6495
6562
  # data as a hash:
6496
6563
  #
6497
6564
  # {
6498
- # on_upload: [ # required
6565
+ # on_upload: [
6566
+ # {
6567
+ # workflow_id: "WorkflowId", # required
6568
+ # execution_role: "Role", # required
6569
+ # },
6570
+ # ],
6571
+ # on_partial_upload: [
6499
6572
  # {
6500
6573
  # workflow_id: "WorkflowId", # required
6501
6574
  # execution_role: "Role", # required
@@ -6514,10 +6587,20 @@ module Aws::Transfer
6514
6587
  # --workflow-details '\{"OnUpload":[]\}'`
6515
6588
  # @return [Array<Types::WorkflowDetail>]
6516
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
+ #
6517
6599
  # @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/WorkflowDetails AWS API Documentation
6518
6600
  #
6519
6601
  class WorkflowDetails < Struct.new(
6520
- :on_upload)
6602
+ :on_upload,
6603
+ :on_partial_upload)
6521
6604
  SENSITIVE = []
6522
6605
  include Aws::Structure
6523
6606
  end
@@ -13,10 +13,14 @@ require 'aws-sigv4'
13
13
 
14
14
  require_relative 'aws-sdk-transfer/types'
15
15
  require_relative 'aws-sdk-transfer/client_api'
16
+ require_relative 'aws-sdk-transfer/plugins/endpoints.rb'
16
17
  require_relative 'aws-sdk-transfer/client'
17
18
  require_relative 'aws-sdk-transfer/errors'
18
19
  require_relative 'aws-sdk-transfer/waiters'
19
20
  require_relative 'aws-sdk-transfer/resource'
21
+ require_relative 'aws-sdk-transfer/endpoint_parameters'
22
+ require_relative 'aws-sdk-transfer/endpoint_provider'
23
+ require_relative 'aws-sdk-transfer/endpoints'
20
24
  require_relative 'aws-sdk-transfer/customizations'
21
25
 
22
26
  # This module provides support for AWS Transfer Family. This module is available in the
@@ -49,6 +53,6 @@ require_relative 'aws-sdk-transfer/customizations'
49
53
  # @!group service
50
54
  module Aws::Transfer
51
55
 
52
- GEM_VERSION = '1.59.0'
56
+ GEM_VERSION = '1.61.0'
53
57
 
54
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.59.0
4
+ version: 1.61.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: 2022-09-13 00:00:00.000000000 Z
11
+ date: 2022-10-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.127.0
22
+ version: 3.165.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.127.0
32
+ version: 3.165.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -59,7 +59,11 @@ files:
59
59
  - lib/aws-sdk-transfer/client.rb
60
60
  - lib/aws-sdk-transfer/client_api.rb
61
61
  - lib/aws-sdk-transfer/customizations.rb
62
+ - lib/aws-sdk-transfer/endpoint_parameters.rb
63
+ - lib/aws-sdk-transfer/endpoint_provider.rb
64
+ - lib/aws-sdk-transfer/endpoints.rb
62
65
  - lib/aws-sdk-transfer/errors.rb
66
+ - lib/aws-sdk-transfer/plugins/endpoints.rb
63
67
  - lib/aws-sdk-transfer/resource.rb
64
68
  - lib/aws-sdk-transfer/types.rb
65
69
  - lib/aws-sdk-transfer/waiters.rb