aws-sdk-transfer 1.63.0 → 1.64.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 +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-transfer/client.rb +59 -23
- data/lib/aws-sdk-transfer/client_api.rb +10 -8
- data/lib/aws-sdk-transfer/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-transfer/endpoint_provider.rb +76 -76
- data/lib/aws-sdk-transfer/types.rb +41 -1035
- data/lib/aws-sdk-transfer.rb +1 -1
- metadata +2 -2
|
@@ -27,20 +27,6 @@ module Aws::Transfer
|
|
|
27
27
|
# used for AS2 outbound processes, to connect the Transfer Family
|
|
28
28
|
# customer with the trading partner.
|
|
29
29
|
#
|
|
30
|
-
# @note When making an API call, you may pass As2ConnectorConfig
|
|
31
|
-
# data as a hash:
|
|
32
|
-
#
|
|
33
|
-
# {
|
|
34
|
-
# local_profile_id: "ProfileId",
|
|
35
|
-
# partner_profile_id: "ProfileId",
|
|
36
|
-
# message_subject: "MessageSubject",
|
|
37
|
-
# compression: "ZLIB", # accepts ZLIB, DISABLED
|
|
38
|
-
# encryption_algorithm: "AES128_CBC", # accepts AES128_CBC, AES192_CBC, AES256_CBC, NONE
|
|
39
|
-
# signing_algorithm: "SHA256", # accepts SHA256, SHA384, SHA512, SHA1, NONE
|
|
40
|
-
# mdn_signing_algorithm: "SHA256", # accepts SHA256, SHA384, SHA512, SHA1, NONE, DEFAULT
|
|
41
|
-
# mdn_response: "SYNC", # accepts SYNC, NONE
|
|
42
|
-
# }
|
|
43
|
-
#
|
|
44
30
|
# @!attribute [rw] local_profile_id
|
|
45
31
|
# A unique identifier for the AS2 local profile.
|
|
46
32
|
# @return [String]
|
|
@@ -60,11 +46,6 @@ module Aws::Transfer
|
|
|
60
46
|
#
|
|
61
47
|
# @!attribute [rw] encryption_algorithm
|
|
62
48
|
# The algorithm that is used to encrypt the file.
|
|
63
|
-
#
|
|
64
|
-
# <note markdown="1"> You can only specify `NONE` if the URL for your connector uses
|
|
65
|
-
# HTTPS. This ensures that no traffic is sent in clear text.
|
|
66
|
-
#
|
|
67
|
-
# </note>
|
|
68
49
|
# @return [String]
|
|
69
50
|
#
|
|
70
51
|
# @!attribute [rw] signing_algorithm
|
|
@@ -76,7 +57,7 @@ module Aws::Transfer
|
|
|
76
57
|
# The signing algorithm for the MDN response.
|
|
77
58
|
#
|
|
78
59
|
# <note markdown="1"> If set to DEFAULT (or not set at all), the value for
|
|
79
|
-
# `
|
|
60
|
+
# `SigningAlogorithm` is used.
|
|
80
61
|
#
|
|
81
62
|
# </note>
|
|
82
63
|
# @return [String]
|
|
@@ -125,25 +106,6 @@ module Aws::Transfer
|
|
|
125
106
|
|
|
126
107
|
# Each step type has its own `StepDetails` structure.
|
|
127
108
|
#
|
|
128
|
-
# @note When making an API call, you may pass CopyStepDetails
|
|
129
|
-
# data as a hash:
|
|
130
|
-
#
|
|
131
|
-
# {
|
|
132
|
-
# name: "WorkflowStepName",
|
|
133
|
-
# destination_file_location: {
|
|
134
|
-
# s3_file_location: {
|
|
135
|
-
# bucket: "S3Bucket",
|
|
136
|
-
# key: "S3Key",
|
|
137
|
-
# },
|
|
138
|
-
# efs_file_location: {
|
|
139
|
-
# file_system_id: "EfsFileSystemId",
|
|
140
|
-
# path: "EfsPath",
|
|
141
|
-
# },
|
|
142
|
-
# },
|
|
143
|
-
# overwrite_existing: "TRUE", # accepts TRUE, FALSE
|
|
144
|
-
# source_file_location: "SourceFileLocation",
|
|
145
|
-
# }
|
|
146
|
-
#
|
|
147
109
|
# @!attribute [rw] name
|
|
148
110
|
# The name of the step, used as an identifier.
|
|
149
111
|
# @return [String]
|
|
@@ -183,29 +145,6 @@ module Aws::Transfer
|
|
|
183
145
|
include Aws::Structure
|
|
184
146
|
end
|
|
185
147
|
|
|
186
|
-
# @note When making an API call, you may pass CreateAccessRequest
|
|
187
|
-
# data as a hash:
|
|
188
|
-
#
|
|
189
|
-
# {
|
|
190
|
-
# home_directory: "HomeDirectory",
|
|
191
|
-
# home_directory_type: "PATH", # accepts PATH, LOGICAL
|
|
192
|
-
# home_directory_mappings: [
|
|
193
|
-
# {
|
|
194
|
-
# entry: "MapEntry", # required
|
|
195
|
-
# target: "MapTarget", # required
|
|
196
|
-
# },
|
|
197
|
-
# ],
|
|
198
|
-
# policy: "Policy",
|
|
199
|
-
# posix_profile: {
|
|
200
|
-
# uid: 1, # required
|
|
201
|
-
# gid: 1, # required
|
|
202
|
-
# secondary_gids: [1],
|
|
203
|
-
# },
|
|
204
|
-
# role: "Role", # required
|
|
205
|
-
# server_id: "ServerId", # required
|
|
206
|
-
# external_id: "ExternalId", # required
|
|
207
|
-
# }
|
|
208
|
-
#
|
|
209
148
|
# @!attribute [rw] home_directory
|
|
210
149
|
# The landing directory (folder) for a user when they log in to the
|
|
211
150
|
# server using the client.
|
|
@@ -356,25 +295,6 @@ module Aws::Transfer
|
|
|
356
295
|
include Aws::Structure
|
|
357
296
|
end
|
|
358
297
|
|
|
359
|
-
# @note When making an API call, you may pass CreateAgreementRequest
|
|
360
|
-
# data as a hash:
|
|
361
|
-
#
|
|
362
|
-
# {
|
|
363
|
-
# description: "Description",
|
|
364
|
-
# server_id: "ServerId", # required
|
|
365
|
-
# local_profile_id: "ProfileId", # required
|
|
366
|
-
# partner_profile_id: "ProfileId", # required
|
|
367
|
-
# base_directory: "HomeDirectory", # required
|
|
368
|
-
# access_role: "Role", # required
|
|
369
|
-
# status: "ACTIVE", # accepts ACTIVE, INACTIVE
|
|
370
|
-
# tags: [
|
|
371
|
-
# {
|
|
372
|
-
# key: "TagKey", # required
|
|
373
|
-
# value: "TagValue", # required
|
|
374
|
-
# },
|
|
375
|
-
# ],
|
|
376
|
-
# }
|
|
377
|
-
#
|
|
378
298
|
# @!attribute [rw] description
|
|
379
299
|
# A name or short description to identify the agreement.
|
|
380
300
|
# @return [String]
|
|
@@ -453,31 +373,6 @@ module Aws::Transfer
|
|
|
453
373
|
include Aws::Structure
|
|
454
374
|
end
|
|
455
375
|
|
|
456
|
-
# @note When making an API call, you may pass CreateConnectorRequest
|
|
457
|
-
# data as a hash:
|
|
458
|
-
#
|
|
459
|
-
# {
|
|
460
|
-
# url: "Url", # required
|
|
461
|
-
# as_2_config: { # required
|
|
462
|
-
# local_profile_id: "ProfileId",
|
|
463
|
-
# partner_profile_id: "ProfileId",
|
|
464
|
-
# message_subject: "MessageSubject",
|
|
465
|
-
# compression: "ZLIB", # accepts ZLIB, DISABLED
|
|
466
|
-
# encryption_algorithm: "AES128_CBC", # accepts AES128_CBC, AES192_CBC, AES256_CBC, NONE
|
|
467
|
-
# signing_algorithm: "SHA256", # accepts SHA256, SHA384, SHA512, SHA1, NONE
|
|
468
|
-
# mdn_signing_algorithm: "SHA256", # accepts SHA256, SHA384, SHA512, SHA1, NONE, DEFAULT
|
|
469
|
-
# mdn_response: "SYNC", # accepts SYNC, NONE
|
|
470
|
-
# },
|
|
471
|
-
# access_role: "Role", # required
|
|
472
|
-
# logging_role: "Role",
|
|
473
|
-
# tags: [
|
|
474
|
-
# {
|
|
475
|
-
# key: "TagKey", # required
|
|
476
|
-
# value: "TagValue", # required
|
|
477
|
-
# },
|
|
478
|
-
# ],
|
|
479
|
-
# }
|
|
480
|
-
#
|
|
481
376
|
# @!attribute [rw] url
|
|
482
377
|
# The URL of the partner's AS2 endpoint.
|
|
483
378
|
# @return [String]
|
|
@@ -538,21 +433,6 @@ module Aws::Transfer
|
|
|
538
433
|
include Aws::Structure
|
|
539
434
|
end
|
|
540
435
|
|
|
541
|
-
# @note When making an API call, you may pass CreateProfileRequest
|
|
542
|
-
# data as a hash:
|
|
543
|
-
#
|
|
544
|
-
# {
|
|
545
|
-
# as_2_id: "As2Id", # required
|
|
546
|
-
# profile_type: "LOCAL", # required, accepts LOCAL, PARTNER
|
|
547
|
-
# certificate_ids: ["CertificateId"],
|
|
548
|
-
# tags: [
|
|
549
|
-
# {
|
|
550
|
-
# key: "TagKey", # required
|
|
551
|
-
# value: "TagValue", # required
|
|
552
|
-
# },
|
|
553
|
-
# ],
|
|
554
|
-
# }
|
|
555
|
-
#
|
|
556
436
|
# @!attribute [rw] as_2_id
|
|
557
437
|
# The `As2Id` is the *AS2-name*, as defined in the [RFC 4130][1]. For
|
|
558
438
|
# inbound transfers, this is the `AS2-From` header for the AS2
|
|
@@ -610,61 +490,6 @@ module Aws::Transfer
|
|
|
610
490
|
include Aws::Structure
|
|
611
491
|
end
|
|
612
492
|
|
|
613
|
-
# @note When making an API call, you may pass CreateServerRequest
|
|
614
|
-
# data as a hash:
|
|
615
|
-
#
|
|
616
|
-
# {
|
|
617
|
-
# certificate: "Certificate",
|
|
618
|
-
# domain: "S3", # accepts S3, EFS
|
|
619
|
-
# endpoint_details: {
|
|
620
|
-
# address_allocation_ids: ["AddressAllocationId"],
|
|
621
|
-
# subnet_ids: ["SubnetId"],
|
|
622
|
-
# vpc_endpoint_id: "VpcEndpointId",
|
|
623
|
-
# vpc_id: "VpcId",
|
|
624
|
-
# security_group_ids: ["SecurityGroupId"],
|
|
625
|
-
# },
|
|
626
|
-
# endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
|
|
627
|
-
# host_key: "HostKey",
|
|
628
|
-
# identity_provider_details: {
|
|
629
|
-
# url: "Url",
|
|
630
|
-
# invocation_role: "Role",
|
|
631
|
-
# directory_id: "DirectoryId",
|
|
632
|
-
# function: "Function",
|
|
633
|
-
# },
|
|
634
|
-
# identity_provider_type: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, API_GATEWAY, AWS_DIRECTORY_SERVICE, AWS_LAMBDA
|
|
635
|
-
# logging_role: "Role",
|
|
636
|
-
# post_authentication_login_banner: "PostAuthenticationLoginBanner",
|
|
637
|
-
# pre_authentication_login_banner: "PreAuthenticationLoginBanner",
|
|
638
|
-
# protocols: ["SFTP"], # accepts SFTP, FTP, FTPS, AS2
|
|
639
|
-
# protocol_details: {
|
|
640
|
-
# passive_ip: "PassiveIp",
|
|
641
|
-
# tls_session_resumption_mode: "DISABLED", # accepts DISABLED, ENABLED, ENFORCED
|
|
642
|
-
# set_stat_option: "DEFAULT", # accepts DEFAULT, ENABLE_NO_OP
|
|
643
|
-
# as_2_transports: ["HTTP"], # accepts HTTP
|
|
644
|
-
# },
|
|
645
|
-
# security_policy_name: "SecurityPolicyName",
|
|
646
|
-
# tags: [
|
|
647
|
-
# {
|
|
648
|
-
# key: "TagKey", # required
|
|
649
|
-
# value: "TagValue", # required
|
|
650
|
-
# },
|
|
651
|
-
# ],
|
|
652
|
-
# workflow_details: {
|
|
653
|
-
# on_upload: [
|
|
654
|
-
# {
|
|
655
|
-
# workflow_id: "WorkflowId", # required
|
|
656
|
-
# execution_role: "Role", # required
|
|
657
|
-
# },
|
|
658
|
-
# ],
|
|
659
|
-
# on_partial_upload: [
|
|
660
|
-
# {
|
|
661
|
-
# workflow_id: "WorkflowId", # required
|
|
662
|
-
# execution_role: "Role", # required
|
|
663
|
-
# },
|
|
664
|
-
# ],
|
|
665
|
-
# },
|
|
666
|
-
# }
|
|
667
|
-
#
|
|
668
493
|
# @!attribute [rw] certificate
|
|
669
494
|
# The Amazon Resource Name (ARN) of the Certificate Manager (ACM)
|
|
670
495
|
# certificate. Required when `Protocols` is set to `FTPS`.
|
|
@@ -928,8 +753,8 @@ module Aws::Transfer
|
|
|
928
753
|
# Specifies the workflow ID for the workflow to assign and the
|
|
929
754
|
# execution role that's used for executing the workflow.
|
|
930
755
|
#
|
|
931
|
-
# In
|
|
932
|
-
# completely, `
|
|
756
|
+
# In additon to a workflow to execute when a file is uploaded
|
|
757
|
+
# completely, `WorkflowDeatails` can also contain a workflow ID (and
|
|
933
758
|
# execution role) for a workflow to execute on partial upload. A
|
|
934
759
|
# partial upload occurs when a file is open when the session
|
|
935
760
|
# disconnects.
|
|
@@ -969,36 +794,6 @@ module Aws::Transfer
|
|
|
969
794
|
include Aws::Structure
|
|
970
795
|
end
|
|
971
796
|
|
|
972
|
-
# @note When making an API call, you may pass CreateUserRequest
|
|
973
|
-
# data as a hash:
|
|
974
|
-
#
|
|
975
|
-
# {
|
|
976
|
-
# home_directory: "HomeDirectory",
|
|
977
|
-
# home_directory_type: "PATH", # accepts PATH, LOGICAL
|
|
978
|
-
# home_directory_mappings: [
|
|
979
|
-
# {
|
|
980
|
-
# entry: "MapEntry", # required
|
|
981
|
-
# target: "MapTarget", # required
|
|
982
|
-
# },
|
|
983
|
-
# ],
|
|
984
|
-
# policy: "Policy",
|
|
985
|
-
# posix_profile: {
|
|
986
|
-
# uid: 1, # required
|
|
987
|
-
# gid: 1, # required
|
|
988
|
-
# secondary_gids: [1],
|
|
989
|
-
# },
|
|
990
|
-
# role: "Role", # required
|
|
991
|
-
# server_id: "ServerId", # required
|
|
992
|
-
# ssh_public_key_body: "SshPublicKeyBody",
|
|
993
|
-
# tags: [
|
|
994
|
-
# {
|
|
995
|
-
# key: "TagKey", # required
|
|
996
|
-
# value: "TagValue", # required
|
|
997
|
-
# },
|
|
998
|
-
# ],
|
|
999
|
-
# user_name: "UserName", # required
|
|
1000
|
-
# }
|
|
1001
|
-
#
|
|
1002
797
|
# @!attribute [rw] home_directory
|
|
1003
798
|
# The landing directory (folder) for a user when they log in to the
|
|
1004
799
|
# server using the client.
|
|
@@ -1099,19 +894,7 @@ module Aws::Transfer
|
|
|
1099
894
|
# The public portion of the Secure Shell (SSH) key used to
|
|
1100
895
|
# authenticate the user to the server.
|
|
1101
896
|
#
|
|
1102
|
-
# The three standard SSH public key format elements are `<key type>`,
|
|
1103
|
-
# `<body base64>`, and an optional `<comment>`, with spaces between
|
|
1104
|
-
# each element.
|
|
1105
|
-
#
|
|
1106
897
|
# Transfer Family accepts RSA, ECDSA, and ED25519 keys.
|
|
1107
|
-
#
|
|
1108
|
-
# * For RSA keys, the key type is `ssh-rsa`.
|
|
1109
|
-
#
|
|
1110
|
-
# * For ED25519 keys, the key type is `ssh-ed25519`.
|
|
1111
|
-
#
|
|
1112
|
-
# * For ECDSA keys, the key type is either `ecdsa-sha2-nistp256`,
|
|
1113
|
-
# `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`, depending on the
|
|
1114
|
-
# size of the key you generated.
|
|
1115
898
|
# @return [String]
|
|
1116
899
|
#
|
|
1117
900
|
# @!attribute [rw] tags
|
|
@@ -1162,99 +945,6 @@ module Aws::Transfer
|
|
|
1162
945
|
include Aws::Structure
|
|
1163
946
|
end
|
|
1164
947
|
|
|
1165
|
-
# @note When making an API call, you may pass CreateWorkflowRequest
|
|
1166
|
-
# data as a hash:
|
|
1167
|
-
#
|
|
1168
|
-
# {
|
|
1169
|
-
# description: "WorkflowDescription",
|
|
1170
|
-
# steps: [ # required
|
|
1171
|
-
# {
|
|
1172
|
-
# type: "COPY", # accepts COPY, CUSTOM, TAG, DELETE
|
|
1173
|
-
# copy_step_details: {
|
|
1174
|
-
# name: "WorkflowStepName",
|
|
1175
|
-
# destination_file_location: {
|
|
1176
|
-
# s3_file_location: {
|
|
1177
|
-
# bucket: "S3Bucket",
|
|
1178
|
-
# key: "S3Key",
|
|
1179
|
-
# },
|
|
1180
|
-
# efs_file_location: {
|
|
1181
|
-
# file_system_id: "EfsFileSystemId",
|
|
1182
|
-
# path: "EfsPath",
|
|
1183
|
-
# },
|
|
1184
|
-
# },
|
|
1185
|
-
# overwrite_existing: "TRUE", # accepts TRUE, FALSE
|
|
1186
|
-
# source_file_location: "SourceFileLocation",
|
|
1187
|
-
# },
|
|
1188
|
-
# custom_step_details: {
|
|
1189
|
-
# name: "WorkflowStepName",
|
|
1190
|
-
# target: "CustomStepTarget",
|
|
1191
|
-
# timeout_seconds: 1,
|
|
1192
|
-
# source_file_location: "SourceFileLocation",
|
|
1193
|
-
# },
|
|
1194
|
-
# delete_step_details: {
|
|
1195
|
-
# name: "WorkflowStepName",
|
|
1196
|
-
# source_file_location: "SourceFileLocation",
|
|
1197
|
-
# },
|
|
1198
|
-
# tag_step_details: {
|
|
1199
|
-
# name: "WorkflowStepName",
|
|
1200
|
-
# tags: [
|
|
1201
|
-
# {
|
|
1202
|
-
# key: "S3TagKey", # required
|
|
1203
|
-
# value: "S3TagValue", # required
|
|
1204
|
-
# },
|
|
1205
|
-
# ],
|
|
1206
|
-
# source_file_location: "SourceFileLocation",
|
|
1207
|
-
# },
|
|
1208
|
-
# },
|
|
1209
|
-
# ],
|
|
1210
|
-
# on_exception_steps: [
|
|
1211
|
-
# {
|
|
1212
|
-
# type: "COPY", # accepts COPY, CUSTOM, TAG, DELETE
|
|
1213
|
-
# copy_step_details: {
|
|
1214
|
-
# name: "WorkflowStepName",
|
|
1215
|
-
# destination_file_location: {
|
|
1216
|
-
# s3_file_location: {
|
|
1217
|
-
# bucket: "S3Bucket",
|
|
1218
|
-
# key: "S3Key",
|
|
1219
|
-
# },
|
|
1220
|
-
# efs_file_location: {
|
|
1221
|
-
# file_system_id: "EfsFileSystemId",
|
|
1222
|
-
# path: "EfsPath",
|
|
1223
|
-
# },
|
|
1224
|
-
# },
|
|
1225
|
-
# overwrite_existing: "TRUE", # accepts TRUE, FALSE
|
|
1226
|
-
# source_file_location: "SourceFileLocation",
|
|
1227
|
-
# },
|
|
1228
|
-
# custom_step_details: {
|
|
1229
|
-
# name: "WorkflowStepName",
|
|
1230
|
-
# target: "CustomStepTarget",
|
|
1231
|
-
# timeout_seconds: 1,
|
|
1232
|
-
# source_file_location: "SourceFileLocation",
|
|
1233
|
-
# },
|
|
1234
|
-
# delete_step_details: {
|
|
1235
|
-
# name: "WorkflowStepName",
|
|
1236
|
-
# source_file_location: "SourceFileLocation",
|
|
1237
|
-
# },
|
|
1238
|
-
# tag_step_details: {
|
|
1239
|
-
# name: "WorkflowStepName",
|
|
1240
|
-
# tags: [
|
|
1241
|
-
# {
|
|
1242
|
-
# key: "S3TagKey", # required
|
|
1243
|
-
# value: "S3TagValue", # required
|
|
1244
|
-
# },
|
|
1245
|
-
# ],
|
|
1246
|
-
# source_file_location: "SourceFileLocation",
|
|
1247
|
-
# },
|
|
1248
|
-
# },
|
|
1249
|
-
# ],
|
|
1250
|
-
# tags: [
|
|
1251
|
-
# {
|
|
1252
|
-
# key: "TagKey", # required
|
|
1253
|
-
# value: "TagValue", # required
|
|
1254
|
-
# },
|
|
1255
|
-
# ],
|
|
1256
|
-
# }
|
|
1257
|
-
#
|
|
1258
948
|
# @!attribute [rw] description
|
|
1259
949
|
# A textual description for the workflow.
|
|
1260
950
|
# @return [String]
|
|
@@ -1324,16 +1014,6 @@ module Aws::Transfer
|
|
|
1324
1014
|
|
|
1325
1015
|
# Each step type has its own `StepDetails` structure.
|
|
1326
1016
|
#
|
|
1327
|
-
# @note When making an API call, you may pass CustomStepDetails
|
|
1328
|
-
# data as a hash:
|
|
1329
|
-
#
|
|
1330
|
-
# {
|
|
1331
|
-
# name: "WorkflowStepName",
|
|
1332
|
-
# target: "CustomStepTarget",
|
|
1333
|
-
# timeout_seconds: 1,
|
|
1334
|
-
# source_file_location: "SourceFileLocation",
|
|
1335
|
-
# }
|
|
1336
|
-
#
|
|
1337
1017
|
# @!attribute [rw] name
|
|
1338
1018
|
# The name of the step, used as an identifier.
|
|
1339
1019
|
# @return [String]
|
|
@@ -1370,14 +1050,35 @@ module Aws::Transfer
|
|
|
1370
1050
|
include Aws::Structure
|
|
1371
1051
|
end
|
|
1372
1052
|
|
|
1373
|
-
#
|
|
1374
|
-
#
|
|
1053
|
+
# @!attribute [rw] name
|
|
1054
|
+
# @return [String]
|
|
1055
|
+
#
|
|
1056
|
+
# @!attribute [rw] type
|
|
1057
|
+
# @return [String]
|
|
1375
1058
|
#
|
|
1376
|
-
#
|
|
1377
|
-
#
|
|
1378
|
-
# external_id: "ExternalId", # required
|
|
1379
|
-
# }
|
|
1059
|
+
# @!attribute [rw] source_file_location
|
|
1060
|
+
# @return [String]
|
|
1380
1061
|
#
|
|
1062
|
+
# @!attribute [rw] overwrite_existing
|
|
1063
|
+
# @return [String]
|
|
1064
|
+
#
|
|
1065
|
+
# @!attribute [rw] destination_file_location
|
|
1066
|
+
# Specifies the location for the file being copied. Only applicable
|
|
1067
|
+
# for the Copy type of workflow steps.
|
|
1068
|
+
# @return [Types::InputFileLocation]
|
|
1069
|
+
#
|
|
1070
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DecryptStepDetails AWS API Documentation
|
|
1071
|
+
#
|
|
1072
|
+
class DecryptStepDetails < Struct.new(
|
|
1073
|
+
:name,
|
|
1074
|
+
:type,
|
|
1075
|
+
:source_file_location,
|
|
1076
|
+
:overwrite_existing,
|
|
1077
|
+
:destination_file_location)
|
|
1078
|
+
SENSITIVE = []
|
|
1079
|
+
include Aws::Structure
|
|
1080
|
+
end
|
|
1081
|
+
|
|
1381
1082
|
# @!attribute [rw] server_id
|
|
1382
1083
|
# A system-assigned unique identifier for a server that has this user
|
|
1383
1084
|
# assigned.
|
|
@@ -1412,14 +1113,6 @@ module Aws::Transfer
|
|
|
1412
1113
|
include Aws::Structure
|
|
1413
1114
|
end
|
|
1414
1115
|
|
|
1415
|
-
# @note When making an API call, you may pass DeleteAgreementRequest
|
|
1416
|
-
# data as a hash:
|
|
1417
|
-
#
|
|
1418
|
-
# {
|
|
1419
|
-
# agreement_id: "AgreementId", # required
|
|
1420
|
-
# server_id: "ServerId", # required
|
|
1421
|
-
# }
|
|
1422
|
-
#
|
|
1423
1116
|
# @!attribute [rw] agreement_id
|
|
1424
1117
|
# A unique identifier for the agreement. This identifier is returned
|
|
1425
1118
|
# when you create an agreement.
|
|
@@ -1439,13 +1132,6 @@ module Aws::Transfer
|
|
|
1439
1132
|
include Aws::Structure
|
|
1440
1133
|
end
|
|
1441
1134
|
|
|
1442
|
-
# @note When making an API call, you may pass DeleteCertificateRequest
|
|
1443
|
-
# data as a hash:
|
|
1444
|
-
#
|
|
1445
|
-
# {
|
|
1446
|
-
# certificate_id: "CertificateId", # required
|
|
1447
|
-
# }
|
|
1448
|
-
#
|
|
1449
1135
|
# @!attribute [rw] certificate_id
|
|
1450
1136
|
# The identifier of the certificate object that you are deleting.
|
|
1451
1137
|
# @return [String]
|
|
@@ -1458,13 +1144,6 @@ module Aws::Transfer
|
|
|
1458
1144
|
include Aws::Structure
|
|
1459
1145
|
end
|
|
1460
1146
|
|
|
1461
|
-
# @note When making an API call, you may pass DeleteConnectorRequest
|
|
1462
|
-
# data as a hash:
|
|
1463
|
-
#
|
|
1464
|
-
# {
|
|
1465
|
-
# connector_id: "ConnectorId", # required
|
|
1466
|
-
# }
|
|
1467
|
-
#
|
|
1468
1147
|
# @!attribute [rw] connector_id
|
|
1469
1148
|
# The unique identifier for the connector.
|
|
1470
1149
|
# @return [String]
|
|
@@ -1477,14 +1156,6 @@ module Aws::Transfer
|
|
|
1477
1156
|
include Aws::Structure
|
|
1478
1157
|
end
|
|
1479
1158
|
|
|
1480
|
-
# @note When making an API call, you may pass DeleteHostKeyRequest
|
|
1481
|
-
# data as a hash:
|
|
1482
|
-
#
|
|
1483
|
-
# {
|
|
1484
|
-
# server_id: "ServerId", # required
|
|
1485
|
-
# host_key_id: "HostKeyId", # required
|
|
1486
|
-
# }
|
|
1487
|
-
#
|
|
1488
1159
|
# @!attribute [rw] server_id
|
|
1489
1160
|
# The identifier of the server that contains the host key that you are
|
|
1490
1161
|
# deleting.
|
|
@@ -1503,13 +1174,6 @@ module Aws::Transfer
|
|
|
1503
1174
|
include Aws::Structure
|
|
1504
1175
|
end
|
|
1505
1176
|
|
|
1506
|
-
# @note When making an API call, you may pass DeleteProfileRequest
|
|
1507
|
-
# data as a hash:
|
|
1508
|
-
#
|
|
1509
|
-
# {
|
|
1510
|
-
# profile_id: "ProfileId", # required
|
|
1511
|
-
# }
|
|
1512
|
-
#
|
|
1513
1177
|
# @!attribute [rw] profile_id
|
|
1514
1178
|
# The identifier of the profile that you are deleting.
|
|
1515
1179
|
# @return [String]
|
|
@@ -1522,13 +1186,6 @@ module Aws::Transfer
|
|
|
1522
1186
|
include Aws::Structure
|
|
1523
1187
|
end
|
|
1524
1188
|
|
|
1525
|
-
# @note When making an API call, you may pass DeleteServerRequest
|
|
1526
|
-
# data as a hash:
|
|
1527
|
-
#
|
|
1528
|
-
# {
|
|
1529
|
-
# server_id: "ServerId", # required
|
|
1530
|
-
# }
|
|
1531
|
-
#
|
|
1532
1189
|
# @!attribute [rw] server_id
|
|
1533
1190
|
# A unique system-assigned identifier for a server instance.
|
|
1534
1191
|
# @return [String]
|
|
@@ -1541,15 +1198,6 @@ module Aws::Transfer
|
|
|
1541
1198
|
include Aws::Structure
|
|
1542
1199
|
end
|
|
1543
1200
|
|
|
1544
|
-
# @note When making an API call, you may pass DeleteSshPublicKeyRequest
|
|
1545
|
-
# data as a hash:
|
|
1546
|
-
#
|
|
1547
|
-
# {
|
|
1548
|
-
# server_id: "ServerId", # required
|
|
1549
|
-
# ssh_public_key_id: "SshPublicKeyId", # required
|
|
1550
|
-
# user_name: "UserName", # required
|
|
1551
|
-
# }
|
|
1552
|
-
#
|
|
1553
1201
|
# @!attribute [rw] server_id
|
|
1554
1202
|
# A system-assigned unique identifier for a file transfer
|
|
1555
1203
|
# protocol-enabled server instance that has the user assigned to it.
|
|
@@ -1576,14 +1224,6 @@ module Aws::Transfer
|
|
|
1576
1224
|
|
|
1577
1225
|
# The name of the step, used to identify the delete step.
|
|
1578
1226
|
#
|
|
1579
|
-
# @note When making an API call, you may pass DeleteStepDetails
|
|
1580
|
-
# data as a hash:
|
|
1581
|
-
#
|
|
1582
|
-
# {
|
|
1583
|
-
# name: "WorkflowStepName",
|
|
1584
|
-
# source_file_location: "SourceFileLocation",
|
|
1585
|
-
# }
|
|
1586
|
-
#
|
|
1587
1227
|
# @!attribute [rw] name
|
|
1588
1228
|
# The name of the step, used as an identifier.
|
|
1589
1229
|
# @return [String]
|
|
@@ -1610,14 +1250,6 @@ module Aws::Transfer
|
|
|
1610
1250
|
include Aws::Structure
|
|
1611
1251
|
end
|
|
1612
1252
|
|
|
1613
|
-
# @note When making an API call, you may pass DeleteUserRequest
|
|
1614
|
-
# data as a hash:
|
|
1615
|
-
#
|
|
1616
|
-
# {
|
|
1617
|
-
# server_id: "ServerId", # required
|
|
1618
|
-
# user_name: "UserName", # required
|
|
1619
|
-
# }
|
|
1620
|
-
#
|
|
1621
1253
|
# @!attribute [rw] server_id
|
|
1622
1254
|
# A system-assigned unique identifier for a server instance that has
|
|
1623
1255
|
# the user assigned to it.
|
|
@@ -1637,13 +1269,6 @@ module Aws::Transfer
|
|
|
1637
1269
|
include Aws::Structure
|
|
1638
1270
|
end
|
|
1639
1271
|
|
|
1640
|
-
# @note When making an API call, you may pass DeleteWorkflowRequest
|
|
1641
|
-
# data as a hash:
|
|
1642
|
-
#
|
|
1643
|
-
# {
|
|
1644
|
-
# workflow_id: "WorkflowId", # required
|
|
1645
|
-
# }
|
|
1646
|
-
#
|
|
1647
1272
|
# @!attribute [rw] workflow_id
|
|
1648
1273
|
# A unique identifier for the workflow.
|
|
1649
1274
|
# @return [String]
|
|
@@ -1656,14 +1281,6 @@ module Aws::Transfer
|
|
|
1656
1281
|
include Aws::Structure
|
|
1657
1282
|
end
|
|
1658
1283
|
|
|
1659
|
-
# @note When making an API call, you may pass DescribeAccessRequest
|
|
1660
|
-
# data as a hash:
|
|
1661
|
-
#
|
|
1662
|
-
# {
|
|
1663
|
-
# server_id: "ServerId", # required
|
|
1664
|
-
# external_id: "ExternalId", # required
|
|
1665
|
-
# }
|
|
1666
|
-
#
|
|
1667
1284
|
# @!attribute [rw] server_id
|
|
1668
1285
|
# A system-assigned unique identifier for a server that has this
|
|
1669
1286
|
# access assigned.
|
|
@@ -1717,14 +1334,6 @@ module Aws::Transfer
|
|
|
1717
1334
|
include Aws::Structure
|
|
1718
1335
|
end
|
|
1719
1336
|
|
|
1720
|
-
# @note When making an API call, you may pass DescribeAgreementRequest
|
|
1721
|
-
# data as a hash:
|
|
1722
|
-
#
|
|
1723
|
-
# {
|
|
1724
|
-
# agreement_id: "AgreementId", # required
|
|
1725
|
-
# server_id: "ServerId", # required
|
|
1726
|
-
# }
|
|
1727
|
-
#
|
|
1728
1337
|
# @!attribute [rw] agreement_id
|
|
1729
1338
|
# A unique identifier for the agreement. This identifier is returned
|
|
1730
1339
|
# when you create an agreement.
|
|
@@ -1756,13 +1365,6 @@ module Aws::Transfer
|
|
|
1756
1365
|
include Aws::Structure
|
|
1757
1366
|
end
|
|
1758
1367
|
|
|
1759
|
-
# @note When making an API call, you may pass DescribeCertificateRequest
|
|
1760
|
-
# data as a hash:
|
|
1761
|
-
#
|
|
1762
|
-
# {
|
|
1763
|
-
# certificate_id: "CertificateId", # required
|
|
1764
|
-
# }
|
|
1765
|
-
#
|
|
1766
1368
|
# @!attribute [rw] certificate_id
|
|
1767
1369
|
# An array of identifiers for the imported certificates. You use this
|
|
1768
1370
|
# identifier for working with profiles and partner profiles.
|
|
@@ -1788,13 +1390,6 @@ module Aws::Transfer
|
|
|
1788
1390
|
include Aws::Structure
|
|
1789
1391
|
end
|
|
1790
1392
|
|
|
1791
|
-
# @note When making an API call, you may pass DescribeConnectorRequest
|
|
1792
|
-
# data as a hash:
|
|
1793
|
-
#
|
|
1794
|
-
# {
|
|
1795
|
-
# connector_id: "ConnectorId", # required
|
|
1796
|
-
# }
|
|
1797
|
-
#
|
|
1798
1393
|
# @!attribute [rw] connector_id
|
|
1799
1394
|
# The unique identifier for the connector.
|
|
1800
1395
|
# @return [String]
|
|
@@ -1819,14 +1414,6 @@ module Aws::Transfer
|
|
|
1819
1414
|
include Aws::Structure
|
|
1820
1415
|
end
|
|
1821
1416
|
|
|
1822
|
-
# @note When making an API call, you may pass DescribeExecutionRequest
|
|
1823
|
-
# data as a hash:
|
|
1824
|
-
#
|
|
1825
|
-
# {
|
|
1826
|
-
# execution_id: "ExecutionId", # required
|
|
1827
|
-
# workflow_id: "WorkflowId", # required
|
|
1828
|
-
# }
|
|
1829
|
-
#
|
|
1830
1417
|
# @!attribute [rw] execution_id
|
|
1831
1418
|
# A unique identifier for the execution of a workflow.
|
|
1832
1419
|
# @return [String]
|
|
@@ -1861,14 +1448,6 @@ module Aws::Transfer
|
|
|
1861
1448
|
include Aws::Structure
|
|
1862
1449
|
end
|
|
1863
1450
|
|
|
1864
|
-
# @note When making an API call, you may pass DescribeHostKeyRequest
|
|
1865
|
-
# data as a hash:
|
|
1866
|
-
#
|
|
1867
|
-
# {
|
|
1868
|
-
# server_id: "ServerId", # required
|
|
1869
|
-
# host_key_id: "HostKeyId", # required
|
|
1870
|
-
# }
|
|
1871
|
-
#
|
|
1872
1451
|
# @!attribute [rw] server_id
|
|
1873
1452
|
# The identifier of the server that contains the host key that you
|
|
1874
1453
|
# want described.
|
|
@@ -1899,13 +1478,6 @@ module Aws::Transfer
|
|
|
1899
1478
|
include Aws::Structure
|
|
1900
1479
|
end
|
|
1901
1480
|
|
|
1902
|
-
# @note When making an API call, you may pass DescribeProfileRequest
|
|
1903
|
-
# data as a hash:
|
|
1904
|
-
#
|
|
1905
|
-
# {
|
|
1906
|
-
# profile_id: "ProfileId", # required
|
|
1907
|
-
# }
|
|
1908
|
-
#
|
|
1909
1481
|
# @!attribute [rw] profile_id
|
|
1910
1482
|
# The identifier of the profile that you want described.
|
|
1911
1483
|
# @return [String]
|
|
@@ -1930,13 +1502,6 @@ module Aws::Transfer
|
|
|
1930
1502
|
include Aws::Structure
|
|
1931
1503
|
end
|
|
1932
1504
|
|
|
1933
|
-
# @note When making an API call, you may pass DescribeSecurityPolicyRequest
|
|
1934
|
-
# data as a hash:
|
|
1935
|
-
#
|
|
1936
|
-
# {
|
|
1937
|
-
# security_policy_name: "SecurityPolicyName", # required
|
|
1938
|
-
# }
|
|
1939
|
-
#
|
|
1940
1505
|
# @!attribute [rw] security_policy_name
|
|
1941
1506
|
# Specifies the name of the security policy that is attached to the
|
|
1942
1507
|
# server.
|
|
@@ -1962,13 +1527,6 @@ module Aws::Transfer
|
|
|
1962
1527
|
include Aws::Structure
|
|
1963
1528
|
end
|
|
1964
1529
|
|
|
1965
|
-
# @note When making an API call, you may pass DescribeServerRequest
|
|
1966
|
-
# data as a hash:
|
|
1967
|
-
#
|
|
1968
|
-
# {
|
|
1969
|
-
# server_id: "ServerId", # required
|
|
1970
|
-
# }
|
|
1971
|
-
#
|
|
1972
1530
|
# @!attribute [rw] server_id
|
|
1973
1531
|
# A system-assigned unique identifier for a server.
|
|
1974
1532
|
# @return [String]
|
|
@@ -1994,14 +1552,6 @@ module Aws::Transfer
|
|
|
1994
1552
|
include Aws::Structure
|
|
1995
1553
|
end
|
|
1996
1554
|
|
|
1997
|
-
# @note When making an API call, you may pass DescribeUserRequest
|
|
1998
|
-
# data as a hash:
|
|
1999
|
-
#
|
|
2000
|
-
# {
|
|
2001
|
-
# server_id: "ServerId", # required
|
|
2002
|
-
# user_name: "UserName", # required
|
|
2003
|
-
# }
|
|
2004
|
-
#
|
|
2005
1555
|
# @!attribute [rw] server_id
|
|
2006
1556
|
# A system-assigned unique identifier for a server that has this user
|
|
2007
1557
|
# assigned.
|
|
@@ -2041,13 +1591,6 @@ module Aws::Transfer
|
|
|
2041
1591
|
include Aws::Structure
|
|
2042
1592
|
end
|
|
2043
1593
|
|
|
2044
|
-
# @note When making an API call, you may pass DescribeWorkflowRequest
|
|
2045
|
-
# data as a hash:
|
|
2046
|
-
#
|
|
2047
|
-
# {
|
|
2048
|
-
# workflow_id: "WorkflowId", # required
|
|
2049
|
-
# }
|
|
2050
|
-
#
|
|
2051
1594
|
# @!attribute [rw] workflow_id
|
|
2052
1595
|
# A unique identifier for the workflow.
|
|
2053
1596
|
# @return [String]
|
|
@@ -2805,8 +2348,8 @@ module Aws::Transfer
|
|
|
2805
2348
|
# Specifies the workflow ID for the workflow to assign and the
|
|
2806
2349
|
# execution role that's used for executing the workflow.
|
|
2807
2350
|
#
|
|
2808
|
-
# In
|
|
2809
|
-
# completely, `
|
|
2351
|
+
# In additon to a workflow to execute when a file is uploaded
|
|
2352
|
+
# completely, `WorkflowDeatails` can also contain a workflow ID (and
|
|
2810
2353
|
# execution role) for a workflow to execute on partial upload. A
|
|
2811
2354
|
# partial upload occurs when a file is open when the session
|
|
2812
2355
|
# disconnects.
|
|
@@ -2986,14 +2529,6 @@ module Aws::Transfer
|
|
|
2986
2529
|
|
|
2987
2530
|
# Reserved for future use.
|
|
2988
2531
|
#
|
|
2989
|
-
# @note When making an API call, you may pass EfsFileLocation
|
|
2990
|
-
# data as a hash:
|
|
2991
|
-
#
|
|
2992
|
-
# {
|
|
2993
|
-
# file_system_id: "EfsFileSystemId",
|
|
2994
|
-
# path: "EfsPath",
|
|
2995
|
-
# }
|
|
2996
|
-
#
|
|
2997
2532
|
# @!attribute [rw] file_system_id
|
|
2998
2533
|
# The identifier of the file system, assigned by Amazon EFS.
|
|
2999
2534
|
# @return [String]
|
|
@@ -3029,17 +2564,6 @@ module Aws::Transfer
|
|
|
3029
2564
|
#
|
|
3030
2565
|
# </note>
|
|
3031
2566
|
#
|
|
3032
|
-
# @note When making an API call, you may pass EndpointDetails
|
|
3033
|
-
# data as a hash:
|
|
3034
|
-
#
|
|
3035
|
-
# {
|
|
3036
|
-
# address_allocation_ids: ["AddressAllocationId"],
|
|
3037
|
-
# subnet_ids: ["SubnetId"],
|
|
3038
|
-
# vpc_endpoint_id: "VpcEndpointId",
|
|
3039
|
-
# vpc_id: "VpcId",
|
|
3040
|
-
# security_group_ids: ["SecurityGroupId"],
|
|
3041
|
-
# }
|
|
3042
|
-
#
|
|
3043
2567
|
# @!attribute [rw] address_allocation_ids
|
|
3044
2568
|
# A list of address allocation IDs that are required to attach an
|
|
3045
2569
|
# Elastic IP address to your server's endpoint.
|
|
@@ -3249,14 +2773,6 @@ module Aws::Transfer
|
|
|
3249
2773
|
#
|
|
3250
2774
|
# `[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]`
|
|
3251
2775
|
#
|
|
3252
|
-
# @note When making an API call, you may pass HomeDirectoryMapEntry
|
|
3253
|
-
# data as a hash:
|
|
3254
|
-
#
|
|
3255
|
-
# {
|
|
3256
|
-
# entry: "MapEntry", # required
|
|
3257
|
-
# target: "MapTarget", # required
|
|
3258
|
-
# }
|
|
3259
|
-
#
|
|
3260
2776
|
# @!attribute [rw] entry
|
|
3261
2777
|
# Represents an entry for `HomeDirectoryMappings`.
|
|
3262
2778
|
# @return [String]
|
|
@@ -3278,16 +2794,6 @@ module Aws::Transfer
|
|
|
3278
2794
|
# in use for a file transfer protocol-enabled server's users. A server
|
|
3279
2795
|
# can have only one method of authentication.
|
|
3280
2796
|
#
|
|
3281
|
-
# @note When making an API call, you may pass IdentityProviderDetails
|
|
3282
|
-
# data as a hash:
|
|
3283
|
-
#
|
|
3284
|
-
# {
|
|
3285
|
-
# url: "Url",
|
|
3286
|
-
# invocation_role: "Role",
|
|
3287
|
-
# directory_id: "DirectoryId",
|
|
3288
|
-
# function: "Function",
|
|
3289
|
-
# }
|
|
3290
|
-
#
|
|
3291
2797
|
# @!attribute [rw] url
|
|
3292
2798
|
# Provides the location of the service endpoint used to authenticate
|
|
3293
2799
|
# users.
|
|
@@ -3318,25 +2824,6 @@ module Aws::Transfer
|
|
|
3318
2824
|
include Aws::Structure
|
|
3319
2825
|
end
|
|
3320
2826
|
|
|
3321
|
-
# @note When making an API call, you may pass ImportCertificateRequest
|
|
3322
|
-
# data as a hash:
|
|
3323
|
-
#
|
|
3324
|
-
# {
|
|
3325
|
-
# usage: "SIGNING", # required, accepts SIGNING, ENCRYPTION
|
|
3326
|
-
# certificate: "CertificateBodyType", # required
|
|
3327
|
-
# certificate_chain: "CertificateChainType",
|
|
3328
|
-
# private_key: "PrivateKeyType",
|
|
3329
|
-
# active_date: Time.now,
|
|
3330
|
-
# inactive_date: Time.now,
|
|
3331
|
-
# description: "Description",
|
|
3332
|
-
# tags: [
|
|
3333
|
-
# {
|
|
3334
|
-
# key: "TagKey", # required
|
|
3335
|
-
# value: "TagValue", # required
|
|
3336
|
-
# },
|
|
3337
|
-
# ],
|
|
3338
|
-
# }
|
|
3339
|
-
#
|
|
3340
2827
|
# @!attribute [rw] usage
|
|
3341
2828
|
# Specifies whether this certificate is used for signing or
|
|
3342
2829
|
# encryption.
|
|
@@ -3402,21 +2889,6 @@ module Aws::Transfer
|
|
|
3402
2889
|
include Aws::Structure
|
|
3403
2890
|
end
|
|
3404
2891
|
|
|
3405
|
-
# @note When making an API call, you may pass ImportHostKeyRequest
|
|
3406
|
-
# data as a hash:
|
|
3407
|
-
#
|
|
3408
|
-
# {
|
|
3409
|
-
# server_id: "ServerId", # required
|
|
3410
|
-
# host_key_body: "HostKey", # required
|
|
3411
|
-
# description: "HostKeyDescription",
|
|
3412
|
-
# tags: [
|
|
3413
|
-
# {
|
|
3414
|
-
# key: "TagKey", # required
|
|
3415
|
-
# value: "TagValue", # required
|
|
3416
|
-
# },
|
|
3417
|
-
# ],
|
|
3418
|
-
# }
|
|
3419
|
-
#
|
|
3420
2892
|
# @!attribute [rw] server_id
|
|
3421
2893
|
# The identifier of the server that contains the host key that you are
|
|
3422
2894
|
# importing.
|
|
@@ -3464,15 +2936,6 @@ module Aws::Transfer
|
|
|
3464
2936
|
include Aws::Structure
|
|
3465
2937
|
end
|
|
3466
2938
|
|
|
3467
|
-
# @note When making an API call, you may pass ImportSshPublicKeyRequest
|
|
3468
|
-
# data as a hash:
|
|
3469
|
-
#
|
|
3470
|
-
# {
|
|
3471
|
-
# server_id: "ServerId", # required
|
|
3472
|
-
# ssh_public_key_body: "SshPublicKeyBody", # required
|
|
3473
|
-
# user_name: "UserName", # required
|
|
3474
|
-
# }
|
|
3475
|
-
#
|
|
3476
2939
|
# @!attribute [rw] server_id
|
|
3477
2940
|
# A system-assigned unique identifier for a server.
|
|
3478
2941
|
# @return [String]
|
|
@@ -3527,20 +2990,6 @@ module Aws::Transfer
|
|
|
3527
2990
|
# Specifies the location for the file being copied. Only applicable for
|
|
3528
2991
|
# the Copy type of workflow steps.
|
|
3529
2992
|
#
|
|
3530
|
-
# @note When making an API call, you may pass InputFileLocation
|
|
3531
|
-
# data as a hash:
|
|
3532
|
-
#
|
|
3533
|
-
# {
|
|
3534
|
-
# s3_file_location: {
|
|
3535
|
-
# bucket: "S3Bucket",
|
|
3536
|
-
# key: "S3Key",
|
|
3537
|
-
# },
|
|
3538
|
-
# efs_file_location: {
|
|
3539
|
-
# file_system_id: "EfsFileSystemId",
|
|
3540
|
-
# path: "EfsPath",
|
|
3541
|
-
# },
|
|
3542
|
-
# }
|
|
3543
|
-
#
|
|
3544
2993
|
# @!attribute [rw] s3_file_location
|
|
3545
2994
|
# Specifies the details for the S3 file being copied.
|
|
3546
2995
|
# @return [Types::S3InputFileLocation]
|
|
@@ -3598,15 +3047,6 @@ module Aws::Transfer
|
|
|
3598
3047
|
include Aws::Structure
|
|
3599
3048
|
end
|
|
3600
3049
|
|
|
3601
|
-
# @note When making an API call, you may pass ListAccessesRequest
|
|
3602
|
-
# data as a hash:
|
|
3603
|
-
#
|
|
3604
|
-
# {
|
|
3605
|
-
# max_results: 1,
|
|
3606
|
-
# next_token: "NextToken",
|
|
3607
|
-
# server_id: "ServerId", # required
|
|
3608
|
-
# }
|
|
3609
|
-
#
|
|
3610
3050
|
# @!attribute [rw] max_results
|
|
3611
3051
|
# Specifies the maximum number of access SIDs to return.
|
|
3612
3052
|
# @return [Integer]
|
|
@@ -3660,15 +3100,6 @@ module Aws::Transfer
|
|
|
3660
3100
|
include Aws::Structure
|
|
3661
3101
|
end
|
|
3662
3102
|
|
|
3663
|
-
# @note When making an API call, you may pass ListAgreementsRequest
|
|
3664
|
-
# data as a hash:
|
|
3665
|
-
#
|
|
3666
|
-
# {
|
|
3667
|
-
# max_results: 1,
|
|
3668
|
-
# next_token: "NextToken",
|
|
3669
|
-
# server_id: "ServerId", # required
|
|
3670
|
-
# }
|
|
3671
|
-
#
|
|
3672
3103
|
# @!attribute [rw] max_results
|
|
3673
3104
|
# The maximum number of agreements to return.
|
|
3674
3105
|
# @return [Integer]
|
|
@@ -3714,14 +3145,6 @@ module Aws::Transfer
|
|
|
3714
3145
|
include Aws::Structure
|
|
3715
3146
|
end
|
|
3716
3147
|
|
|
3717
|
-
# @note When making an API call, you may pass ListCertificatesRequest
|
|
3718
|
-
# data as a hash:
|
|
3719
|
-
#
|
|
3720
|
-
# {
|
|
3721
|
-
# max_results: 1,
|
|
3722
|
-
# next_token: "NextToken",
|
|
3723
|
-
# }
|
|
3724
|
-
#
|
|
3725
3148
|
# @!attribute [rw] max_results
|
|
3726
3149
|
# The maximum number of certificates to return.
|
|
3727
3150
|
# @return [Integer]
|
|
@@ -3761,14 +3184,6 @@ module Aws::Transfer
|
|
|
3761
3184
|
include Aws::Structure
|
|
3762
3185
|
end
|
|
3763
3186
|
|
|
3764
|
-
# @note When making an API call, you may pass ListConnectorsRequest
|
|
3765
|
-
# data as a hash:
|
|
3766
|
-
#
|
|
3767
|
-
# {
|
|
3768
|
-
# max_results: 1,
|
|
3769
|
-
# next_token: "NextToken",
|
|
3770
|
-
# }
|
|
3771
|
-
#
|
|
3772
3187
|
# @!attribute [rw] max_results
|
|
3773
3188
|
# The maximum number of connectors to return.
|
|
3774
3189
|
# @return [Integer]
|
|
@@ -3808,15 +3223,6 @@ module Aws::Transfer
|
|
|
3808
3223
|
include Aws::Structure
|
|
3809
3224
|
end
|
|
3810
3225
|
|
|
3811
|
-
# @note When making an API call, you may pass ListExecutionsRequest
|
|
3812
|
-
# data as a hash:
|
|
3813
|
-
#
|
|
3814
|
-
# {
|
|
3815
|
-
# max_results: 1,
|
|
3816
|
-
# next_token: "NextToken",
|
|
3817
|
-
# workflow_id: "WorkflowId", # required
|
|
3818
|
-
# }
|
|
3819
|
-
#
|
|
3820
3226
|
# @!attribute [rw] max_results
|
|
3821
3227
|
# Specifies the maximum number of executions to return.
|
|
3822
3228
|
# @return [Integer]
|
|
@@ -3894,15 +3300,6 @@ module Aws::Transfer
|
|
|
3894
3300
|
include Aws::Structure
|
|
3895
3301
|
end
|
|
3896
3302
|
|
|
3897
|
-
# @note When making an API call, you may pass ListHostKeysRequest
|
|
3898
|
-
# data as a hash:
|
|
3899
|
-
#
|
|
3900
|
-
# {
|
|
3901
|
-
# max_results: 1,
|
|
3902
|
-
# next_token: "NextToken",
|
|
3903
|
-
# server_id: "ServerId", # required
|
|
3904
|
-
# }
|
|
3905
|
-
#
|
|
3906
3303
|
# @!attribute [rw] max_results
|
|
3907
3304
|
# The maximum number of host keys to return.
|
|
3908
3305
|
# @return [Integer]
|
|
@@ -3952,15 +3349,6 @@ module Aws::Transfer
|
|
|
3952
3349
|
include Aws::Structure
|
|
3953
3350
|
end
|
|
3954
3351
|
|
|
3955
|
-
# @note When making an API call, you may pass ListProfilesRequest
|
|
3956
|
-
# data as a hash:
|
|
3957
|
-
#
|
|
3958
|
-
# {
|
|
3959
|
-
# max_results: 1,
|
|
3960
|
-
# next_token: "NextToken",
|
|
3961
|
-
# profile_type: "LOCAL", # accepts LOCAL, PARTNER
|
|
3962
|
-
# }
|
|
3963
|
-
#
|
|
3964
3352
|
# @!attribute [rw] max_results
|
|
3965
3353
|
# The maximum number of profiles to return.
|
|
3966
3354
|
# @return [Integer]
|
|
@@ -4005,14 +3393,6 @@ module Aws::Transfer
|
|
|
4005
3393
|
include Aws::Structure
|
|
4006
3394
|
end
|
|
4007
3395
|
|
|
4008
|
-
# @note When making an API call, you may pass ListSecurityPoliciesRequest
|
|
4009
|
-
# data as a hash:
|
|
4010
|
-
#
|
|
4011
|
-
# {
|
|
4012
|
-
# max_results: 1,
|
|
4013
|
-
# next_token: "NextToken",
|
|
4014
|
-
# }
|
|
4015
|
-
#
|
|
4016
3396
|
# @!attribute [rw] max_results
|
|
4017
3397
|
# Specifies the number of security policies to return as a response to
|
|
4018
3398
|
# the `ListSecurityPolicies` query.
|
|
@@ -4054,14 +3434,6 @@ module Aws::Transfer
|
|
|
4054
3434
|
include Aws::Structure
|
|
4055
3435
|
end
|
|
4056
3436
|
|
|
4057
|
-
# @note When making an API call, you may pass ListServersRequest
|
|
4058
|
-
# data as a hash:
|
|
4059
|
-
#
|
|
4060
|
-
# {
|
|
4061
|
-
# max_results: 1,
|
|
4062
|
-
# next_token: "NextToken",
|
|
4063
|
-
# }
|
|
4064
|
-
#
|
|
4065
3437
|
# @!attribute [rw] max_results
|
|
4066
3438
|
# Specifies the number of servers to return as a response to the
|
|
4067
3439
|
# `ListServers` query.
|
|
@@ -4103,15 +3475,6 @@ module Aws::Transfer
|
|
|
4103
3475
|
include Aws::Structure
|
|
4104
3476
|
end
|
|
4105
3477
|
|
|
4106
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
|
4107
|
-
# data as a hash:
|
|
4108
|
-
#
|
|
4109
|
-
# {
|
|
4110
|
-
# arn: "Arn", # required
|
|
4111
|
-
# max_results: 1,
|
|
4112
|
-
# next_token: "NextToken",
|
|
4113
|
-
# }
|
|
4114
|
-
#
|
|
4115
3478
|
# @!attribute [rw] arn
|
|
4116
3479
|
# Requests the tags associated with a particular Amazon Resource Name
|
|
4117
3480
|
# (ARN). An ARN is an identifier for a specific Amazon Web Services
|
|
@@ -4167,15 +3530,6 @@ module Aws::Transfer
|
|
|
4167
3530
|
include Aws::Structure
|
|
4168
3531
|
end
|
|
4169
3532
|
|
|
4170
|
-
# @note When making an API call, you may pass ListUsersRequest
|
|
4171
|
-
# data as a hash:
|
|
4172
|
-
#
|
|
4173
|
-
# {
|
|
4174
|
-
# max_results: 1,
|
|
4175
|
-
# next_token: "NextToken",
|
|
4176
|
-
# server_id: "ServerId", # required
|
|
4177
|
-
# }
|
|
4178
|
-
#
|
|
4179
3533
|
# @!attribute [rw] max_results
|
|
4180
3534
|
# Specifies the number of users to return as a response to the
|
|
4181
3535
|
# `ListUsers` request.
|
|
@@ -4230,14 +3584,6 @@ module Aws::Transfer
|
|
|
4230
3584
|
include Aws::Structure
|
|
4231
3585
|
end
|
|
4232
3586
|
|
|
4233
|
-
# @note When making an API call, you may pass ListWorkflowsRequest
|
|
4234
|
-
# data as a hash:
|
|
4235
|
-
#
|
|
4236
|
-
# {
|
|
4237
|
-
# max_results: 1,
|
|
4238
|
-
# next_token: "NextToken",
|
|
4239
|
-
# }
|
|
4240
|
-
#
|
|
4241
3587
|
# @!attribute [rw] max_results
|
|
4242
3588
|
# Specifies the maximum number of workflows to return.
|
|
4243
3589
|
# @return [Integer]
|
|
@@ -4801,15 +4147,6 @@ module Aws::Transfer
|
|
|
4801
4147
|
# the level of access your users get when transferring files into and
|
|
4802
4148
|
# out of your Amazon EFS file systems.
|
|
4803
4149
|
#
|
|
4804
|
-
# @note When making an API call, you may pass PosixProfile
|
|
4805
|
-
# data as a hash:
|
|
4806
|
-
#
|
|
4807
|
-
# {
|
|
4808
|
-
# uid: 1, # required
|
|
4809
|
-
# gid: 1, # required
|
|
4810
|
-
# secondary_gids: [1],
|
|
4811
|
-
# }
|
|
4812
|
-
#
|
|
4813
4150
|
# @!attribute [rw] uid
|
|
4814
4151
|
# The POSIX user ID used for all EFS operations by this user.
|
|
4815
4152
|
# @return [Integer]
|
|
@@ -4835,16 +4172,6 @@ module Aws::Transfer
|
|
|
4835
4172
|
|
|
4836
4173
|
# The protocol settings that are configured for your server.
|
|
4837
4174
|
#
|
|
4838
|
-
# @note When making an API call, you may pass ProtocolDetails
|
|
4839
|
-
# data as a hash:
|
|
4840
|
-
#
|
|
4841
|
-
# {
|
|
4842
|
-
# passive_ip: "PassiveIp",
|
|
4843
|
-
# tls_session_resumption_mode: "DISABLED", # accepts DISABLED, ENABLED, ENFORCED
|
|
4844
|
-
# set_stat_option: "DEFAULT", # accepts DEFAULT, ENABLE_NO_OP
|
|
4845
|
-
# as_2_transports: ["HTTP"], # accepts HTTP
|
|
4846
|
-
# }
|
|
4847
|
-
#
|
|
4848
4175
|
# @!attribute [rw] passive_ip
|
|
4849
4176
|
# Indicates passive mode, for FTP and FTPS protocols. Enter a single
|
|
4850
4177
|
# IPv4 address, such as the public IP address of a firewall, router,
|
|
@@ -5056,14 +4383,6 @@ module Aws::Transfer
|
|
|
5056
4383
|
# `shared-files` folder and named `today`\: each upload overwrites the
|
|
5057
4384
|
# previous version of the *bob* file.
|
|
5058
4385
|
#
|
|
5059
|
-
# @note When making an API call, you may pass S3InputFileLocation
|
|
5060
|
-
# data as a hash:
|
|
5061
|
-
#
|
|
5062
|
-
# {
|
|
5063
|
-
# bucket: "S3Bucket",
|
|
5064
|
-
# key: "S3Key",
|
|
5065
|
-
# }
|
|
5066
|
-
#
|
|
5067
4386
|
# @!attribute [rw] bucket
|
|
5068
4387
|
# Specifies the S3 bucket for the customer input file.
|
|
5069
4388
|
# @return [String]
|
|
@@ -5085,14 +4404,6 @@ module Aws::Transfer
|
|
|
5085
4404
|
# Specifies the key-value pair that are assigned to a file during the
|
|
5086
4405
|
# execution of a Tagging step.
|
|
5087
4406
|
#
|
|
5088
|
-
# @note When making an API call, you may pass S3Tag
|
|
5089
|
-
# data as a hash:
|
|
5090
|
-
#
|
|
5091
|
-
# {
|
|
5092
|
-
# key: "S3TagKey", # required
|
|
5093
|
-
# value: "S3TagValue", # required
|
|
5094
|
-
# }
|
|
5095
|
-
#
|
|
5096
4407
|
# @!attribute [rw] key
|
|
5097
4408
|
# The name assigned to the tag that you create.
|
|
5098
4409
|
# @return [String]
|
|
@@ -5110,16 +4421,6 @@ module Aws::Transfer
|
|
|
5110
4421
|
include Aws::Structure
|
|
5111
4422
|
end
|
|
5112
4423
|
|
|
5113
|
-
# @note When making an API call, you may pass SendWorkflowStepStateRequest
|
|
5114
|
-
# data as a hash:
|
|
5115
|
-
#
|
|
5116
|
-
# {
|
|
5117
|
-
# workflow_id: "WorkflowId", # required
|
|
5118
|
-
# execution_id: "ExecutionId", # required
|
|
5119
|
-
# token: "CallbackToken", # required
|
|
5120
|
-
# status: "SUCCESS", # required, accepts SUCCESS, FAILURE
|
|
5121
|
-
# }
|
|
5122
|
-
#
|
|
5123
4424
|
# @!attribute [rw] workflow_id
|
|
5124
4425
|
# A unique identifier for the workflow.
|
|
5125
4426
|
# @return [String]
|
|
@@ -5216,14 +4517,6 @@ module Aws::Transfer
|
|
|
5216
4517
|
include Aws::Structure
|
|
5217
4518
|
end
|
|
5218
4519
|
|
|
5219
|
-
# @note When making an API call, you may pass StartFileTransferRequest
|
|
5220
|
-
# data as a hash:
|
|
5221
|
-
#
|
|
5222
|
-
# {
|
|
5223
|
-
# connector_id: "ConnectorId", # required
|
|
5224
|
-
# send_file_paths: ["FilePath"], # required
|
|
5225
|
-
# }
|
|
5226
|
-
#
|
|
5227
4520
|
# @!attribute [rw] connector_id
|
|
5228
4521
|
# The unique identifier for the connector.
|
|
5229
4522
|
# @return [String]
|
|
@@ -5255,13 +4548,6 @@ module Aws::Transfer
|
|
|
5255
4548
|
include Aws::Structure
|
|
5256
4549
|
end
|
|
5257
4550
|
|
|
5258
|
-
# @note When making an API call, you may pass StartServerRequest
|
|
5259
|
-
# data as a hash:
|
|
5260
|
-
#
|
|
5261
|
-
# {
|
|
5262
|
-
# server_id: "ServerId", # required
|
|
5263
|
-
# }
|
|
5264
|
-
#
|
|
5265
4551
|
# @!attribute [rw] server_id
|
|
5266
4552
|
# A system-assigned unique identifier for a server that you start.
|
|
5267
4553
|
# @return [String]
|
|
@@ -5274,13 +4560,6 @@ module Aws::Transfer
|
|
|
5274
4560
|
include Aws::Structure
|
|
5275
4561
|
end
|
|
5276
4562
|
|
|
5277
|
-
# @note When making an API call, you may pass StopServerRequest
|
|
5278
|
-
# data as a hash:
|
|
5279
|
-
#
|
|
5280
|
-
# {
|
|
5281
|
-
# server_id: "ServerId", # required
|
|
5282
|
-
# }
|
|
5283
|
-
#
|
|
5284
4563
|
# @!attribute [rw] server_id
|
|
5285
4564
|
# A system-assigned unique identifier for a server that you stopped.
|
|
5286
4565
|
# @return [String]
|
|
@@ -5300,14 +4579,6 @@ module Aws::Transfer
|
|
|
5300
4579
|
# accounting purposes, you might create a tag called `Group` and assign
|
|
5301
4580
|
# the values `Research` and `Accounting` to that group.
|
|
5302
4581
|
#
|
|
5303
|
-
# @note When making an API call, you may pass Tag
|
|
5304
|
-
# data as a hash:
|
|
5305
|
-
#
|
|
5306
|
-
# {
|
|
5307
|
-
# key: "TagKey", # required
|
|
5308
|
-
# value: "TagValue", # required
|
|
5309
|
-
# }
|
|
5310
|
-
#
|
|
5311
4582
|
# @!attribute [rw] key
|
|
5312
4583
|
# The name assigned to the tag that you create.
|
|
5313
4584
|
# @return [String]
|
|
@@ -5326,19 +4597,6 @@ module Aws::Transfer
|
|
|
5326
4597
|
include Aws::Structure
|
|
5327
4598
|
end
|
|
5328
4599
|
|
|
5329
|
-
# @note When making an API call, you may pass TagResourceRequest
|
|
5330
|
-
# data as a hash:
|
|
5331
|
-
#
|
|
5332
|
-
# {
|
|
5333
|
-
# arn: "Arn", # required
|
|
5334
|
-
# tags: [ # required
|
|
5335
|
-
# {
|
|
5336
|
-
# key: "TagKey", # required
|
|
5337
|
-
# value: "TagValue", # required
|
|
5338
|
-
# },
|
|
5339
|
-
# ],
|
|
5340
|
-
# }
|
|
5341
|
-
#
|
|
5342
4600
|
# @!attribute [rw] arn
|
|
5343
4601
|
# An Amazon Resource Name (ARN) for a specific Amazon Web Services
|
|
5344
4602
|
# resource, such as a server, user, or role.
|
|
@@ -5364,20 +4622,6 @@ module Aws::Transfer
|
|
|
5364
4622
|
# The key/value pairs used to tag a file during the execution of a
|
|
5365
4623
|
# workflow step.
|
|
5366
4624
|
#
|
|
5367
|
-
# @note When making an API call, you may pass TagStepDetails
|
|
5368
|
-
# data as a hash:
|
|
5369
|
-
#
|
|
5370
|
-
# {
|
|
5371
|
-
# name: "WorkflowStepName",
|
|
5372
|
-
# tags: [
|
|
5373
|
-
# {
|
|
5374
|
-
# key: "S3TagKey", # required
|
|
5375
|
-
# value: "S3TagValue", # required
|
|
5376
|
-
# },
|
|
5377
|
-
# ],
|
|
5378
|
-
# source_file_location: "SourceFileLocation",
|
|
5379
|
-
# }
|
|
5380
|
-
#
|
|
5381
4625
|
# @!attribute [rw] name
|
|
5382
4626
|
# The name of the step, used as an identifier.
|
|
5383
4627
|
# @return [String]
|
|
@@ -5409,17 +4653,6 @@ module Aws::Transfer
|
|
|
5409
4653
|
include Aws::Structure
|
|
5410
4654
|
end
|
|
5411
4655
|
|
|
5412
|
-
# @note When making an API call, you may pass TestIdentityProviderRequest
|
|
5413
|
-
# data as a hash:
|
|
5414
|
-
#
|
|
5415
|
-
# {
|
|
5416
|
-
# server_id: "ServerId", # required
|
|
5417
|
-
# server_protocol: "SFTP", # accepts SFTP, FTP, FTPS, AS2
|
|
5418
|
-
# source_ip: "SourceIp",
|
|
5419
|
-
# user_name: "UserName", # required
|
|
5420
|
-
# user_password: "UserPassword",
|
|
5421
|
-
# }
|
|
5422
|
-
#
|
|
5423
4656
|
# @!attribute [rw] server_id
|
|
5424
4657
|
# A system-assigned identifier for a specific server. That server's
|
|
5425
4658
|
# user authentication method is tested with a user name and password.
|
|
@@ -5506,14 +4739,6 @@ module Aws::Transfer
|
|
|
5506
4739
|
include Aws::Structure
|
|
5507
4740
|
end
|
|
5508
4741
|
|
|
5509
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
|
5510
|
-
# data as a hash:
|
|
5511
|
-
#
|
|
5512
|
-
# {
|
|
5513
|
-
# arn: "Arn", # required
|
|
5514
|
-
# tag_keys: ["TagKey"], # required
|
|
5515
|
-
# }
|
|
5516
|
-
#
|
|
5517
4742
|
# @!attribute [rw] arn
|
|
5518
4743
|
# The value of the resource that will have the tag removed. An Amazon
|
|
5519
4744
|
# Resource Name (ARN) is an identifier for a specific Amazon Web
|
|
@@ -5535,29 +4760,6 @@ module Aws::Transfer
|
|
|
5535
4760
|
include Aws::Structure
|
|
5536
4761
|
end
|
|
5537
4762
|
|
|
5538
|
-
# @note When making an API call, you may pass UpdateAccessRequest
|
|
5539
|
-
# data as a hash:
|
|
5540
|
-
#
|
|
5541
|
-
# {
|
|
5542
|
-
# home_directory: "HomeDirectory",
|
|
5543
|
-
# home_directory_type: "PATH", # accepts PATH, LOGICAL
|
|
5544
|
-
# home_directory_mappings: [
|
|
5545
|
-
# {
|
|
5546
|
-
# entry: "MapEntry", # required
|
|
5547
|
-
# target: "MapTarget", # required
|
|
5548
|
-
# },
|
|
5549
|
-
# ],
|
|
5550
|
-
# policy: "Policy",
|
|
5551
|
-
# posix_profile: {
|
|
5552
|
-
# uid: 1, # required
|
|
5553
|
-
# gid: 1, # required
|
|
5554
|
-
# secondary_gids: [1],
|
|
5555
|
-
# },
|
|
5556
|
-
# role: "Role",
|
|
5557
|
-
# server_id: "ServerId", # required
|
|
5558
|
-
# external_id: "ExternalId", # required
|
|
5559
|
-
# }
|
|
5560
|
-
#
|
|
5561
4763
|
# @!attribute [rw] home_directory
|
|
5562
4764
|
# The landing directory (folder) for a user when they log in to the
|
|
5563
4765
|
# server using the client.
|
|
@@ -5708,20 +4910,6 @@ module Aws::Transfer
|
|
|
5708
4910
|
include Aws::Structure
|
|
5709
4911
|
end
|
|
5710
4912
|
|
|
5711
|
-
# @note When making an API call, you may pass UpdateAgreementRequest
|
|
5712
|
-
# data as a hash:
|
|
5713
|
-
#
|
|
5714
|
-
# {
|
|
5715
|
-
# agreement_id: "AgreementId", # required
|
|
5716
|
-
# server_id: "ServerId", # required
|
|
5717
|
-
# description: "Description",
|
|
5718
|
-
# status: "ACTIVE", # accepts ACTIVE, INACTIVE
|
|
5719
|
-
# local_profile_id: "ProfileId",
|
|
5720
|
-
# partner_profile_id: "ProfileId",
|
|
5721
|
-
# base_directory: "HomeDirectory",
|
|
5722
|
-
# access_role: "Role",
|
|
5723
|
-
# }
|
|
5724
|
-
#
|
|
5725
4913
|
# @!attribute [rw] agreement_id
|
|
5726
4914
|
# A unique identifier for the agreement. This identifier is returned
|
|
5727
4915
|
# when you create an agreement.
|
|
@@ -5802,16 +4990,6 @@ module Aws::Transfer
|
|
|
5802
4990
|
include Aws::Structure
|
|
5803
4991
|
end
|
|
5804
4992
|
|
|
5805
|
-
# @note When making an API call, you may pass UpdateCertificateRequest
|
|
5806
|
-
# data as a hash:
|
|
5807
|
-
#
|
|
5808
|
-
# {
|
|
5809
|
-
# certificate_id: "CertificateId", # required
|
|
5810
|
-
# active_date: Time.now,
|
|
5811
|
-
# inactive_date: Time.now,
|
|
5812
|
-
# description: "Description",
|
|
5813
|
-
# }
|
|
5814
|
-
#
|
|
5815
4993
|
# @!attribute [rw] certificate_id
|
|
5816
4994
|
# The identifier of the certificate object that you are updating.
|
|
5817
4995
|
# @return [String]
|
|
@@ -5853,26 +5031,6 @@ module Aws::Transfer
|
|
|
5853
5031
|
include Aws::Structure
|
|
5854
5032
|
end
|
|
5855
5033
|
|
|
5856
|
-
# @note When making an API call, you may pass UpdateConnectorRequest
|
|
5857
|
-
# data as a hash:
|
|
5858
|
-
#
|
|
5859
|
-
# {
|
|
5860
|
-
# connector_id: "ConnectorId", # required
|
|
5861
|
-
# url: "Url",
|
|
5862
|
-
# as_2_config: {
|
|
5863
|
-
# local_profile_id: "ProfileId",
|
|
5864
|
-
# partner_profile_id: "ProfileId",
|
|
5865
|
-
# message_subject: "MessageSubject",
|
|
5866
|
-
# compression: "ZLIB", # accepts ZLIB, DISABLED
|
|
5867
|
-
# encryption_algorithm: "AES128_CBC", # accepts AES128_CBC, AES192_CBC, AES256_CBC, NONE
|
|
5868
|
-
# signing_algorithm: "SHA256", # accepts SHA256, SHA384, SHA512, SHA1, NONE
|
|
5869
|
-
# mdn_signing_algorithm: "SHA256", # accepts SHA256, SHA384, SHA512, SHA1, NONE, DEFAULT
|
|
5870
|
-
# mdn_response: "SYNC", # accepts SYNC, NONE
|
|
5871
|
-
# },
|
|
5872
|
-
# access_role: "Role",
|
|
5873
|
-
# logging_role: "Role",
|
|
5874
|
-
# }
|
|
5875
|
-
#
|
|
5876
5034
|
# @!attribute [rw] connector_id
|
|
5877
5035
|
# The unique identifier for the connector.
|
|
5878
5036
|
# @return [String]
|
|
@@ -5932,15 +5090,6 @@ module Aws::Transfer
|
|
|
5932
5090
|
include Aws::Structure
|
|
5933
5091
|
end
|
|
5934
5092
|
|
|
5935
|
-
# @note When making an API call, you may pass UpdateHostKeyRequest
|
|
5936
|
-
# data as a hash:
|
|
5937
|
-
#
|
|
5938
|
-
# {
|
|
5939
|
-
# server_id: "ServerId", # required
|
|
5940
|
-
# host_key_id: "HostKeyId", # required
|
|
5941
|
-
# description: "HostKeyDescription", # required
|
|
5942
|
-
# }
|
|
5943
|
-
#
|
|
5944
5093
|
# @!attribute [rw] server_id
|
|
5945
5094
|
# The identifier of the server that contains the host key that you are
|
|
5946
5095
|
# updating.
|
|
@@ -5982,14 +5131,6 @@ module Aws::Transfer
|
|
|
5982
5131
|
include Aws::Structure
|
|
5983
5132
|
end
|
|
5984
5133
|
|
|
5985
|
-
# @note When making an API call, you may pass UpdateProfileRequest
|
|
5986
|
-
# data as a hash:
|
|
5987
|
-
#
|
|
5988
|
-
# {
|
|
5989
|
-
# profile_id: "ProfileId", # required
|
|
5990
|
-
# certificate_ids: ["CertificateId"],
|
|
5991
|
-
# }
|
|
5992
|
-
#
|
|
5993
5134
|
# @!attribute [rw] profile_id
|
|
5994
5135
|
# The identifier of the profile object that you are updating.
|
|
5995
5136
|
# @return [String]
|
|
@@ -6020,54 +5161,6 @@ module Aws::Transfer
|
|
|
6020
5161
|
include Aws::Structure
|
|
6021
5162
|
end
|
|
6022
5163
|
|
|
6023
|
-
# @note When making an API call, you may pass UpdateServerRequest
|
|
6024
|
-
# data as a hash:
|
|
6025
|
-
#
|
|
6026
|
-
# {
|
|
6027
|
-
# certificate: "Certificate",
|
|
6028
|
-
# protocol_details: {
|
|
6029
|
-
# passive_ip: "PassiveIp",
|
|
6030
|
-
# tls_session_resumption_mode: "DISABLED", # accepts DISABLED, ENABLED, ENFORCED
|
|
6031
|
-
# set_stat_option: "DEFAULT", # accepts DEFAULT, ENABLE_NO_OP
|
|
6032
|
-
# as_2_transports: ["HTTP"], # accepts HTTP
|
|
6033
|
-
# },
|
|
6034
|
-
# endpoint_details: {
|
|
6035
|
-
# address_allocation_ids: ["AddressAllocationId"],
|
|
6036
|
-
# subnet_ids: ["SubnetId"],
|
|
6037
|
-
# vpc_endpoint_id: "VpcEndpointId",
|
|
6038
|
-
# vpc_id: "VpcId",
|
|
6039
|
-
# security_group_ids: ["SecurityGroupId"],
|
|
6040
|
-
# },
|
|
6041
|
-
# endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
|
|
6042
|
-
# host_key: "HostKey",
|
|
6043
|
-
# identity_provider_details: {
|
|
6044
|
-
# url: "Url",
|
|
6045
|
-
# invocation_role: "Role",
|
|
6046
|
-
# directory_id: "DirectoryId",
|
|
6047
|
-
# function: "Function",
|
|
6048
|
-
# },
|
|
6049
|
-
# logging_role: "NullableRole",
|
|
6050
|
-
# post_authentication_login_banner: "PostAuthenticationLoginBanner",
|
|
6051
|
-
# pre_authentication_login_banner: "PreAuthenticationLoginBanner",
|
|
6052
|
-
# protocols: ["SFTP"], # accepts SFTP, FTP, FTPS, AS2
|
|
6053
|
-
# security_policy_name: "SecurityPolicyName",
|
|
6054
|
-
# server_id: "ServerId", # required
|
|
6055
|
-
# workflow_details: {
|
|
6056
|
-
# on_upload: [
|
|
6057
|
-
# {
|
|
6058
|
-
# workflow_id: "WorkflowId", # required
|
|
6059
|
-
# execution_role: "Role", # required
|
|
6060
|
-
# },
|
|
6061
|
-
# ],
|
|
6062
|
-
# on_partial_upload: [
|
|
6063
|
-
# {
|
|
6064
|
-
# workflow_id: "WorkflowId", # required
|
|
6065
|
-
# execution_role: "Role", # required
|
|
6066
|
-
# },
|
|
6067
|
-
# ],
|
|
6068
|
-
# },
|
|
6069
|
-
# }
|
|
6070
|
-
#
|
|
6071
5164
|
# @!attribute [rw] certificate
|
|
6072
5165
|
# The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate
|
|
6073
5166
|
# Manager (ACM) certificate. Required when `Protocols` is set to
|
|
@@ -6297,8 +5390,8 @@ module Aws::Transfer
|
|
|
6297
5390
|
# Specifies the workflow ID for the workflow to assign and the
|
|
6298
5391
|
# execution role that's used for executing the workflow.
|
|
6299
5392
|
#
|
|
6300
|
-
# In
|
|
6301
|
-
# completely, `
|
|
5393
|
+
# In additon to a workflow to execute when a file is uploaded
|
|
5394
|
+
# completely, `WorkflowDeatails` can also contain a workflow ID (and
|
|
6302
5395
|
# execution role) for a workflow to execute on partial upload. A
|
|
6303
5396
|
# partial upload occurs when a file is open when the session
|
|
6304
5397
|
# disconnects.
|
|
@@ -6343,29 +5436,6 @@ module Aws::Transfer
|
|
|
6343
5436
|
include Aws::Structure
|
|
6344
5437
|
end
|
|
6345
5438
|
|
|
6346
|
-
# @note When making an API call, you may pass UpdateUserRequest
|
|
6347
|
-
# data as a hash:
|
|
6348
|
-
#
|
|
6349
|
-
# {
|
|
6350
|
-
# home_directory: "HomeDirectory",
|
|
6351
|
-
# home_directory_type: "PATH", # accepts PATH, LOGICAL
|
|
6352
|
-
# home_directory_mappings: [
|
|
6353
|
-
# {
|
|
6354
|
-
# entry: "MapEntry", # required
|
|
6355
|
-
# target: "MapTarget", # required
|
|
6356
|
-
# },
|
|
6357
|
-
# ],
|
|
6358
|
-
# policy: "Policy",
|
|
6359
|
-
# posix_profile: {
|
|
6360
|
-
# uid: 1, # required
|
|
6361
|
-
# gid: 1, # required
|
|
6362
|
-
# secondary_gids: [1],
|
|
6363
|
-
# },
|
|
6364
|
-
# role: "Role",
|
|
6365
|
-
# server_id: "ServerId", # required
|
|
6366
|
-
# user_name: "UserName", # required
|
|
6367
|
-
# }
|
|
6368
|
-
#
|
|
6369
5439
|
# @!attribute [rw] home_directory
|
|
6370
5440
|
# The landing directory (folder) for a user when they log in to the
|
|
6371
5441
|
# server using the client.
|
|
@@ -6540,19 +5610,11 @@ module Aws::Transfer
|
|
|
6540
5610
|
# Specifies the workflow ID for the workflow to assign and the execution
|
|
6541
5611
|
# role that's used for executing the workflow.
|
|
6542
5612
|
#
|
|
6543
|
-
# In
|
|
6544
|
-
# completely, `
|
|
5613
|
+
# In additon to a workflow to execute when a file is uploaded
|
|
5614
|
+
# completely, `WorkflowDeatails` can also contain a workflow ID (and
|
|
6545
5615
|
# execution role) for a workflow to execute on partial upload. A partial
|
|
6546
5616
|
# upload occurs when a file is open when the session disconnects.
|
|
6547
5617
|
#
|
|
6548
|
-
# @note When making an API call, you may pass WorkflowDetail
|
|
6549
|
-
# data as a hash:
|
|
6550
|
-
#
|
|
6551
|
-
# {
|
|
6552
|
-
# workflow_id: "WorkflowId", # required
|
|
6553
|
-
# execution_role: "Role", # required
|
|
6554
|
-
# }
|
|
6555
|
-
#
|
|
6556
5618
|
# @!attribute [rw] workflow_id
|
|
6557
5619
|
# A unique identifier for the workflow.
|
|
6558
5620
|
# @return [String]
|
|
@@ -6575,24 +5637,6 @@ module Aws::Transfer
|
|
|
6575
5637
|
# Container for the `WorkflowDetail` data type. It is used by actions
|
|
6576
5638
|
# that trigger a workflow to begin execution.
|
|
6577
5639
|
#
|
|
6578
|
-
# @note When making an API call, you may pass WorkflowDetails
|
|
6579
|
-
# data as a hash:
|
|
6580
|
-
#
|
|
6581
|
-
# {
|
|
6582
|
-
# on_upload: [
|
|
6583
|
-
# {
|
|
6584
|
-
# workflow_id: "WorkflowId", # required
|
|
6585
|
-
# execution_role: "Role", # required
|
|
6586
|
-
# },
|
|
6587
|
-
# ],
|
|
6588
|
-
# on_partial_upload: [
|
|
6589
|
-
# {
|
|
6590
|
-
# workflow_id: "WorkflowId", # required
|
|
6591
|
-
# execution_role: "Role", # required
|
|
6592
|
-
# },
|
|
6593
|
-
# ],
|
|
6594
|
-
# }
|
|
6595
|
-
#
|
|
6596
5640
|
# @!attribute [rw] on_upload
|
|
6597
5641
|
# A trigger that starts a workflow: the workflow begins to execute
|
|
6598
5642
|
# after a file is uploaded.
|
|
@@ -6624,48 +5668,6 @@ module Aws::Transfer
|
|
|
6624
5668
|
|
|
6625
5669
|
# The basic building block of a workflow.
|
|
6626
5670
|
#
|
|
6627
|
-
# @note When making an API call, you may pass WorkflowStep
|
|
6628
|
-
# data as a hash:
|
|
6629
|
-
#
|
|
6630
|
-
# {
|
|
6631
|
-
# type: "COPY", # accepts COPY, CUSTOM, TAG, DELETE
|
|
6632
|
-
# copy_step_details: {
|
|
6633
|
-
# name: "WorkflowStepName",
|
|
6634
|
-
# destination_file_location: {
|
|
6635
|
-
# s3_file_location: {
|
|
6636
|
-
# bucket: "S3Bucket",
|
|
6637
|
-
# key: "S3Key",
|
|
6638
|
-
# },
|
|
6639
|
-
# efs_file_location: {
|
|
6640
|
-
# file_system_id: "EfsFileSystemId",
|
|
6641
|
-
# path: "EfsPath",
|
|
6642
|
-
# },
|
|
6643
|
-
# },
|
|
6644
|
-
# overwrite_existing: "TRUE", # accepts TRUE, FALSE
|
|
6645
|
-
# source_file_location: "SourceFileLocation",
|
|
6646
|
-
# },
|
|
6647
|
-
# custom_step_details: {
|
|
6648
|
-
# name: "WorkflowStepName",
|
|
6649
|
-
# target: "CustomStepTarget",
|
|
6650
|
-
# timeout_seconds: 1,
|
|
6651
|
-
# source_file_location: "SourceFileLocation",
|
|
6652
|
-
# },
|
|
6653
|
-
# delete_step_details: {
|
|
6654
|
-
# name: "WorkflowStepName",
|
|
6655
|
-
# source_file_location: "SourceFileLocation",
|
|
6656
|
-
# },
|
|
6657
|
-
# tag_step_details: {
|
|
6658
|
-
# name: "WorkflowStepName",
|
|
6659
|
-
# tags: [
|
|
6660
|
-
# {
|
|
6661
|
-
# key: "S3TagKey", # required
|
|
6662
|
-
# value: "S3TagValue", # required
|
|
6663
|
-
# },
|
|
6664
|
-
# ],
|
|
6665
|
-
# source_file_location: "SourceFileLocation",
|
|
6666
|
-
# },
|
|
6667
|
-
# }
|
|
6668
|
-
#
|
|
6669
5671
|
# @!attribute [rw] type
|
|
6670
5672
|
# Currently, the following step types are supported.
|
|
6671
5673
|
#
|
|
@@ -6708,6 +5710,9 @@ module Aws::Transfer
|
|
|
6708
5710
|
# You specify one or more tags: each tag contains a key/value pair.
|
|
6709
5711
|
# @return [Types::TagStepDetails]
|
|
6710
5712
|
#
|
|
5713
|
+
# @!attribute [rw] decrypt_step_details
|
|
5714
|
+
# @return [Types::DecryptStepDetails]
|
|
5715
|
+
#
|
|
6711
5716
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/WorkflowStep AWS API Documentation
|
|
6712
5717
|
#
|
|
6713
5718
|
class WorkflowStep < Struct.new(
|
|
@@ -6715,7 +5720,8 @@ module Aws::Transfer
|
|
|
6715
5720
|
:copy_step_details,
|
|
6716
5721
|
:custom_step_details,
|
|
6717
5722
|
:delete_step_details,
|
|
6718
|
-
:tag_step_details
|
|
5723
|
+
:tag_step_details,
|
|
5724
|
+
:decrypt_step_details)
|
|
6719
5725
|
SENSITIVE = []
|
|
6720
5726
|
include Aws::Structure
|
|
6721
5727
|
end
|