aws-sdk-transfer 1.87.0 → 1.88.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 +1 -1
- data/lib/aws-sdk-transfer/plugins/endpoints.rb +1 -0
- data/lib/aws-sdk-transfer.rb +1 -1
- data/sig/client.rbs +1090 -0
- data/sig/errors.rbs +47 -0
- data/sig/resource.rbs +80 -0
- data/sig/types.rbs +1216 -0
- data/sig/waiters.rbs +33 -0
- metadata +9 -4
data/sig/client.rbs
ADDED
|
@@ -0,0 +1,1090 @@
|
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
|
2
|
+
#
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
5
|
+
#
|
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
|
7
|
+
|
|
8
|
+
module Aws
|
|
9
|
+
module Transfer
|
|
10
|
+
class Client < ::Seahorse::Client::Base
|
|
11
|
+
include ::Aws::ClientStubs
|
|
12
|
+
|
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#initialize-instance_method
|
|
14
|
+
def self.new: (
|
|
15
|
+
?credentials: untyped,
|
|
16
|
+
?region: String,
|
|
17
|
+
?access_key_id: String,
|
|
18
|
+
?active_endpoint_cache: bool,
|
|
19
|
+
?adaptive_retry_wait_to_fill: bool,
|
|
20
|
+
?client_side_monitoring: bool,
|
|
21
|
+
?client_side_monitoring_client_id: String,
|
|
22
|
+
?client_side_monitoring_host: String,
|
|
23
|
+
?client_side_monitoring_port: Integer,
|
|
24
|
+
?client_side_monitoring_publisher: untyped,
|
|
25
|
+
?convert_params: bool,
|
|
26
|
+
?correct_clock_skew: bool,
|
|
27
|
+
?defaults_mode: String,
|
|
28
|
+
?disable_host_prefix_injection: bool,
|
|
29
|
+
?disable_request_compression: bool,
|
|
30
|
+
?endpoint: String,
|
|
31
|
+
?endpoint_cache_max_entries: Integer,
|
|
32
|
+
?endpoint_cache_max_threads: Integer,
|
|
33
|
+
?endpoint_cache_poll_interval: Integer,
|
|
34
|
+
?endpoint_discovery: bool,
|
|
35
|
+
?ignore_configured_endpoint_urls: bool,
|
|
36
|
+
?log_formatter: untyped,
|
|
37
|
+
?log_level: Symbol,
|
|
38
|
+
?logger: untyped,
|
|
39
|
+
?max_attempts: Integer,
|
|
40
|
+
?profile: String,
|
|
41
|
+
?request_min_compression_size_bytes: Integer,
|
|
42
|
+
?retry_backoff: Proc,
|
|
43
|
+
?retry_base_delay: Float,
|
|
44
|
+
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
|
45
|
+
?retry_limit: Integer,
|
|
46
|
+
?retry_max_delay: Integer,
|
|
47
|
+
?retry_mode: ("legacy" | "standard" | "adaptive"),
|
|
48
|
+
?sdk_ua_app_id: String,
|
|
49
|
+
?secret_access_key: String,
|
|
50
|
+
?session_token: String,
|
|
51
|
+
?simple_json: bool,
|
|
52
|
+
?stub_responses: untyped,
|
|
53
|
+
?token_provider: untyped,
|
|
54
|
+
?use_dualstack_endpoint: bool,
|
|
55
|
+
?use_fips_endpoint: bool,
|
|
56
|
+
?validate_params: bool,
|
|
57
|
+
?endpoint_provider: untyped,
|
|
58
|
+
?http_proxy: String,
|
|
59
|
+
?http_open_timeout: (Float | Integer),
|
|
60
|
+
?http_read_timeout: (Float | Integer),
|
|
61
|
+
?http_idle_timeout: (Float | Integer),
|
|
62
|
+
?http_continue_timeout: (Float | Integer),
|
|
63
|
+
?ssl_timeout: (Float | Integer | nil),
|
|
64
|
+
?http_wire_trace: bool,
|
|
65
|
+
?ssl_verify_peer: bool,
|
|
66
|
+
?ssl_ca_bundle: String,
|
|
67
|
+
?ssl_ca_directory: String,
|
|
68
|
+
?ssl_ca_store: String,
|
|
69
|
+
?on_chunk_received: Proc,
|
|
70
|
+
?on_chunk_sent: Proc,
|
|
71
|
+
?raise_response_errors: bool
|
|
72
|
+
) -> instance
|
|
73
|
+
| (?Hash[Symbol, untyped]) -> instance
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
interface _CreateAccessResponseSuccess
|
|
77
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateAccessResponse]
|
|
78
|
+
def server_id: () -> ::String
|
|
79
|
+
def external_id: () -> ::String
|
|
80
|
+
end
|
|
81
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#create_access-instance_method
|
|
82
|
+
def create_access: (
|
|
83
|
+
?home_directory: ::String,
|
|
84
|
+
?home_directory_type: ("PATH" | "LOGICAL"),
|
|
85
|
+
?home_directory_mappings: Array[
|
|
86
|
+
{
|
|
87
|
+
entry: ::String,
|
|
88
|
+
target: ::String,
|
|
89
|
+
type: ("FILE" | "DIRECTORY")?
|
|
90
|
+
},
|
|
91
|
+
],
|
|
92
|
+
?policy: ::String,
|
|
93
|
+
?posix_profile: {
|
|
94
|
+
uid: ::Integer,
|
|
95
|
+
gid: ::Integer,
|
|
96
|
+
secondary_gids: Array[::Integer]?
|
|
97
|
+
},
|
|
98
|
+
role: ::String,
|
|
99
|
+
server_id: ::String,
|
|
100
|
+
external_id: ::String
|
|
101
|
+
) -> _CreateAccessResponseSuccess
|
|
102
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAccessResponseSuccess
|
|
103
|
+
|
|
104
|
+
interface _CreateAgreementResponseSuccess
|
|
105
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateAgreementResponse]
|
|
106
|
+
def agreement_id: () -> ::String
|
|
107
|
+
end
|
|
108
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#create_agreement-instance_method
|
|
109
|
+
def create_agreement: (
|
|
110
|
+
?description: ::String,
|
|
111
|
+
server_id: ::String,
|
|
112
|
+
local_profile_id: ::String,
|
|
113
|
+
partner_profile_id: ::String,
|
|
114
|
+
base_directory: ::String,
|
|
115
|
+
access_role: ::String,
|
|
116
|
+
?status: ("ACTIVE" | "INACTIVE"),
|
|
117
|
+
?tags: Array[
|
|
118
|
+
{
|
|
119
|
+
key: ::String,
|
|
120
|
+
value: ::String
|
|
121
|
+
},
|
|
122
|
+
]
|
|
123
|
+
) -> _CreateAgreementResponseSuccess
|
|
124
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAgreementResponseSuccess
|
|
125
|
+
|
|
126
|
+
interface _CreateConnectorResponseSuccess
|
|
127
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateConnectorResponse]
|
|
128
|
+
def connector_id: () -> ::String
|
|
129
|
+
end
|
|
130
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#create_connector-instance_method
|
|
131
|
+
def create_connector: (
|
|
132
|
+
url: ::String,
|
|
133
|
+
?as_2_config: {
|
|
134
|
+
local_profile_id: ::String?,
|
|
135
|
+
partner_profile_id: ::String?,
|
|
136
|
+
message_subject: ::String?,
|
|
137
|
+
compression: ("ZLIB" | "DISABLED")?,
|
|
138
|
+
encryption_algorithm: ("AES128_CBC" | "AES192_CBC" | "AES256_CBC" | "NONE")?,
|
|
139
|
+
signing_algorithm: ("SHA256" | "SHA384" | "SHA512" | "SHA1" | "NONE")?,
|
|
140
|
+
mdn_signing_algorithm: ("SHA256" | "SHA384" | "SHA512" | "SHA1" | "NONE" | "DEFAULT")?,
|
|
141
|
+
mdn_response: ("SYNC" | "NONE")?,
|
|
142
|
+
basic_auth_secret_id: ::String?
|
|
143
|
+
},
|
|
144
|
+
access_role: ::String,
|
|
145
|
+
?logging_role: ::String,
|
|
146
|
+
?tags: Array[
|
|
147
|
+
{
|
|
148
|
+
key: ::String,
|
|
149
|
+
value: ::String
|
|
150
|
+
},
|
|
151
|
+
],
|
|
152
|
+
?sftp_config: {
|
|
153
|
+
user_secret_id: ::String?,
|
|
154
|
+
trusted_host_keys: Array[::String]?
|
|
155
|
+
}
|
|
156
|
+
) -> _CreateConnectorResponseSuccess
|
|
157
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateConnectorResponseSuccess
|
|
158
|
+
|
|
159
|
+
interface _CreateProfileResponseSuccess
|
|
160
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateProfileResponse]
|
|
161
|
+
def profile_id: () -> ::String
|
|
162
|
+
end
|
|
163
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#create_profile-instance_method
|
|
164
|
+
def create_profile: (
|
|
165
|
+
as_2_id: ::String,
|
|
166
|
+
profile_type: ("LOCAL" | "PARTNER"),
|
|
167
|
+
?certificate_ids: Array[::String],
|
|
168
|
+
?tags: Array[
|
|
169
|
+
{
|
|
170
|
+
key: ::String,
|
|
171
|
+
value: ::String
|
|
172
|
+
},
|
|
173
|
+
]
|
|
174
|
+
) -> _CreateProfileResponseSuccess
|
|
175
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateProfileResponseSuccess
|
|
176
|
+
|
|
177
|
+
interface _CreateServerResponseSuccess
|
|
178
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateServerResponse]
|
|
179
|
+
def server_id: () -> ::String
|
|
180
|
+
end
|
|
181
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#create_server-instance_method
|
|
182
|
+
def create_server: (
|
|
183
|
+
?certificate: ::String,
|
|
184
|
+
?domain: ("S3" | "EFS"),
|
|
185
|
+
?endpoint_details: {
|
|
186
|
+
address_allocation_ids: Array[::String]?,
|
|
187
|
+
subnet_ids: Array[::String]?,
|
|
188
|
+
vpc_endpoint_id: ::String?,
|
|
189
|
+
vpc_id: ::String?,
|
|
190
|
+
security_group_ids: Array[::String]?
|
|
191
|
+
},
|
|
192
|
+
?endpoint_type: ("PUBLIC" | "VPC" | "VPC_ENDPOINT"),
|
|
193
|
+
?host_key: ::String,
|
|
194
|
+
?identity_provider_details: {
|
|
195
|
+
url: ::String?,
|
|
196
|
+
invocation_role: ::String?,
|
|
197
|
+
directory_id: ::String?,
|
|
198
|
+
function: ::String?,
|
|
199
|
+
sftp_authentication_methods: ("PASSWORD" | "PUBLIC_KEY" | "PUBLIC_KEY_OR_PASSWORD" | "PUBLIC_KEY_AND_PASSWORD")?
|
|
200
|
+
},
|
|
201
|
+
?identity_provider_type: ("SERVICE_MANAGED" | "API_GATEWAY" | "AWS_DIRECTORY_SERVICE" | "AWS_LAMBDA"),
|
|
202
|
+
?logging_role: ::String,
|
|
203
|
+
?post_authentication_login_banner: ::String,
|
|
204
|
+
?pre_authentication_login_banner: ::String,
|
|
205
|
+
?protocols: Array[("SFTP" | "FTP" | "FTPS" | "AS2")],
|
|
206
|
+
?protocol_details: {
|
|
207
|
+
passive_ip: ::String?,
|
|
208
|
+
tls_session_resumption_mode: ("DISABLED" | "ENABLED" | "ENFORCED")?,
|
|
209
|
+
set_stat_option: ("DEFAULT" | "ENABLE_NO_OP")?,
|
|
210
|
+
as_2_transports: Array[("HTTP")]?
|
|
211
|
+
},
|
|
212
|
+
?security_policy_name: ::String,
|
|
213
|
+
?tags: Array[
|
|
214
|
+
{
|
|
215
|
+
key: ::String,
|
|
216
|
+
value: ::String
|
|
217
|
+
},
|
|
218
|
+
],
|
|
219
|
+
?workflow_details: {
|
|
220
|
+
on_upload: Array[
|
|
221
|
+
{
|
|
222
|
+
workflow_id: ::String,
|
|
223
|
+
execution_role: ::String
|
|
224
|
+
},
|
|
225
|
+
]?,
|
|
226
|
+
on_partial_upload: Array[
|
|
227
|
+
{
|
|
228
|
+
workflow_id: ::String,
|
|
229
|
+
execution_role: ::String
|
|
230
|
+
},
|
|
231
|
+
]?
|
|
232
|
+
},
|
|
233
|
+
?structured_log_destinations: Array[::String],
|
|
234
|
+
?s3_storage_options: {
|
|
235
|
+
directory_listing_optimization: ("ENABLED" | "DISABLED")?
|
|
236
|
+
}
|
|
237
|
+
) -> _CreateServerResponseSuccess
|
|
238
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateServerResponseSuccess
|
|
239
|
+
|
|
240
|
+
interface _CreateUserResponseSuccess
|
|
241
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateUserResponse]
|
|
242
|
+
def server_id: () -> ::String
|
|
243
|
+
def user_name: () -> ::String
|
|
244
|
+
end
|
|
245
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#create_user-instance_method
|
|
246
|
+
def create_user: (
|
|
247
|
+
?home_directory: ::String,
|
|
248
|
+
?home_directory_type: ("PATH" | "LOGICAL"),
|
|
249
|
+
?home_directory_mappings: Array[
|
|
250
|
+
{
|
|
251
|
+
entry: ::String,
|
|
252
|
+
target: ::String,
|
|
253
|
+
type: ("FILE" | "DIRECTORY")?
|
|
254
|
+
},
|
|
255
|
+
],
|
|
256
|
+
?policy: ::String,
|
|
257
|
+
?posix_profile: {
|
|
258
|
+
uid: ::Integer,
|
|
259
|
+
gid: ::Integer,
|
|
260
|
+
secondary_gids: Array[::Integer]?
|
|
261
|
+
},
|
|
262
|
+
role: ::String,
|
|
263
|
+
server_id: ::String,
|
|
264
|
+
?ssh_public_key_body: ::String,
|
|
265
|
+
?tags: Array[
|
|
266
|
+
{
|
|
267
|
+
key: ::String,
|
|
268
|
+
value: ::String
|
|
269
|
+
},
|
|
270
|
+
],
|
|
271
|
+
user_name: ::String
|
|
272
|
+
) -> _CreateUserResponseSuccess
|
|
273
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateUserResponseSuccess
|
|
274
|
+
|
|
275
|
+
interface _CreateWorkflowResponseSuccess
|
|
276
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateWorkflowResponse]
|
|
277
|
+
def workflow_id: () -> ::String
|
|
278
|
+
end
|
|
279
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#create_workflow-instance_method
|
|
280
|
+
def create_workflow: (
|
|
281
|
+
?description: ::String,
|
|
282
|
+
steps: Array[
|
|
283
|
+
{
|
|
284
|
+
type: ("COPY" | "CUSTOM" | "TAG" | "DELETE" | "DECRYPT")?,
|
|
285
|
+
copy_step_details: {
|
|
286
|
+
name: ::String?,
|
|
287
|
+
destination_file_location: {
|
|
288
|
+
s3_file_location: {
|
|
289
|
+
bucket: ::String?,
|
|
290
|
+
key: ::String?
|
|
291
|
+
}?,
|
|
292
|
+
efs_file_location: {
|
|
293
|
+
file_system_id: ::String?,
|
|
294
|
+
path: ::String?
|
|
295
|
+
}?
|
|
296
|
+
}?,
|
|
297
|
+
overwrite_existing: ("TRUE" | "FALSE")?,
|
|
298
|
+
source_file_location: ::String?
|
|
299
|
+
}?,
|
|
300
|
+
custom_step_details: {
|
|
301
|
+
name: ::String?,
|
|
302
|
+
target: ::String?,
|
|
303
|
+
timeout_seconds: ::Integer?,
|
|
304
|
+
source_file_location: ::String?
|
|
305
|
+
}?,
|
|
306
|
+
delete_step_details: {
|
|
307
|
+
name: ::String?,
|
|
308
|
+
source_file_location: ::String?
|
|
309
|
+
}?,
|
|
310
|
+
tag_step_details: {
|
|
311
|
+
name: ::String?,
|
|
312
|
+
tags: Array[
|
|
313
|
+
{
|
|
314
|
+
key: ::String,
|
|
315
|
+
value: ::String
|
|
316
|
+
},
|
|
317
|
+
]?,
|
|
318
|
+
source_file_location: ::String?
|
|
319
|
+
}?,
|
|
320
|
+
decrypt_step_details: {
|
|
321
|
+
name: ::String?,
|
|
322
|
+
type: ("PGP"),
|
|
323
|
+
source_file_location: ::String?,
|
|
324
|
+
overwrite_existing: ("TRUE" | "FALSE")?,
|
|
325
|
+
destination_file_location: {
|
|
326
|
+
s3_file_location: {
|
|
327
|
+
bucket: ::String?,
|
|
328
|
+
key: ::String?
|
|
329
|
+
}?,
|
|
330
|
+
efs_file_location: {
|
|
331
|
+
file_system_id: ::String?,
|
|
332
|
+
path: ::String?
|
|
333
|
+
}?
|
|
334
|
+
}
|
|
335
|
+
}?
|
|
336
|
+
},
|
|
337
|
+
],
|
|
338
|
+
?on_exception_steps: Array[
|
|
339
|
+
{
|
|
340
|
+
type: ("COPY" | "CUSTOM" | "TAG" | "DELETE" | "DECRYPT")?,
|
|
341
|
+
copy_step_details: {
|
|
342
|
+
name: ::String?,
|
|
343
|
+
destination_file_location: {
|
|
344
|
+
s3_file_location: {
|
|
345
|
+
bucket: ::String?,
|
|
346
|
+
key: ::String?
|
|
347
|
+
}?,
|
|
348
|
+
efs_file_location: {
|
|
349
|
+
file_system_id: ::String?,
|
|
350
|
+
path: ::String?
|
|
351
|
+
}?
|
|
352
|
+
}?,
|
|
353
|
+
overwrite_existing: ("TRUE" | "FALSE")?,
|
|
354
|
+
source_file_location: ::String?
|
|
355
|
+
}?,
|
|
356
|
+
custom_step_details: {
|
|
357
|
+
name: ::String?,
|
|
358
|
+
target: ::String?,
|
|
359
|
+
timeout_seconds: ::Integer?,
|
|
360
|
+
source_file_location: ::String?
|
|
361
|
+
}?,
|
|
362
|
+
delete_step_details: {
|
|
363
|
+
name: ::String?,
|
|
364
|
+
source_file_location: ::String?
|
|
365
|
+
}?,
|
|
366
|
+
tag_step_details: {
|
|
367
|
+
name: ::String?,
|
|
368
|
+
tags: Array[
|
|
369
|
+
{
|
|
370
|
+
key: ::String,
|
|
371
|
+
value: ::String
|
|
372
|
+
},
|
|
373
|
+
]?,
|
|
374
|
+
source_file_location: ::String?
|
|
375
|
+
}?,
|
|
376
|
+
decrypt_step_details: {
|
|
377
|
+
name: ::String?,
|
|
378
|
+
type: ("PGP"),
|
|
379
|
+
source_file_location: ::String?,
|
|
380
|
+
overwrite_existing: ("TRUE" | "FALSE")?,
|
|
381
|
+
destination_file_location: {
|
|
382
|
+
s3_file_location: {
|
|
383
|
+
bucket: ::String?,
|
|
384
|
+
key: ::String?
|
|
385
|
+
}?,
|
|
386
|
+
efs_file_location: {
|
|
387
|
+
file_system_id: ::String?,
|
|
388
|
+
path: ::String?
|
|
389
|
+
}?
|
|
390
|
+
}
|
|
391
|
+
}?
|
|
392
|
+
},
|
|
393
|
+
],
|
|
394
|
+
?tags: Array[
|
|
395
|
+
{
|
|
396
|
+
key: ::String,
|
|
397
|
+
value: ::String
|
|
398
|
+
},
|
|
399
|
+
]
|
|
400
|
+
) -> _CreateWorkflowResponseSuccess
|
|
401
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateWorkflowResponseSuccess
|
|
402
|
+
|
|
403
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#delete_access-instance_method
|
|
404
|
+
def delete_access: (
|
|
405
|
+
server_id: ::String,
|
|
406
|
+
external_id: ::String
|
|
407
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
408
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
409
|
+
|
|
410
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#delete_agreement-instance_method
|
|
411
|
+
def delete_agreement: (
|
|
412
|
+
agreement_id: ::String,
|
|
413
|
+
server_id: ::String
|
|
414
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
415
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
416
|
+
|
|
417
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#delete_certificate-instance_method
|
|
418
|
+
def delete_certificate: (
|
|
419
|
+
certificate_id: ::String
|
|
420
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
421
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
422
|
+
|
|
423
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#delete_connector-instance_method
|
|
424
|
+
def delete_connector: (
|
|
425
|
+
connector_id: ::String
|
|
426
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
427
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
428
|
+
|
|
429
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#delete_host_key-instance_method
|
|
430
|
+
def delete_host_key: (
|
|
431
|
+
server_id: ::String,
|
|
432
|
+
host_key_id: ::String
|
|
433
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
434
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
435
|
+
|
|
436
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#delete_profile-instance_method
|
|
437
|
+
def delete_profile: (
|
|
438
|
+
profile_id: ::String
|
|
439
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
440
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
441
|
+
|
|
442
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#delete_server-instance_method
|
|
443
|
+
def delete_server: (
|
|
444
|
+
server_id: ::String
|
|
445
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
446
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
447
|
+
|
|
448
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#delete_ssh_public_key-instance_method
|
|
449
|
+
def delete_ssh_public_key: (
|
|
450
|
+
server_id: ::String,
|
|
451
|
+
ssh_public_key_id: ::String,
|
|
452
|
+
user_name: ::String
|
|
453
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
454
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
455
|
+
|
|
456
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#delete_user-instance_method
|
|
457
|
+
def delete_user: (
|
|
458
|
+
server_id: ::String,
|
|
459
|
+
user_name: ::String
|
|
460
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
461
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
462
|
+
|
|
463
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#delete_workflow-instance_method
|
|
464
|
+
def delete_workflow: (
|
|
465
|
+
workflow_id: ::String
|
|
466
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
467
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
468
|
+
|
|
469
|
+
interface _DescribeAccessResponseSuccess
|
|
470
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeAccessResponse]
|
|
471
|
+
def server_id: () -> ::String
|
|
472
|
+
def access: () -> Types::DescribedAccess
|
|
473
|
+
end
|
|
474
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#describe_access-instance_method
|
|
475
|
+
def describe_access: (
|
|
476
|
+
server_id: ::String,
|
|
477
|
+
external_id: ::String
|
|
478
|
+
) -> _DescribeAccessResponseSuccess
|
|
479
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeAccessResponseSuccess
|
|
480
|
+
|
|
481
|
+
interface _DescribeAgreementResponseSuccess
|
|
482
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeAgreementResponse]
|
|
483
|
+
def agreement: () -> Types::DescribedAgreement
|
|
484
|
+
end
|
|
485
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#describe_agreement-instance_method
|
|
486
|
+
def describe_agreement: (
|
|
487
|
+
agreement_id: ::String,
|
|
488
|
+
server_id: ::String
|
|
489
|
+
) -> _DescribeAgreementResponseSuccess
|
|
490
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeAgreementResponseSuccess
|
|
491
|
+
|
|
492
|
+
interface _DescribeCertificateResponseSuccess
|
|
493
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeCertificateResponse]
|
|
494
|
+
def certificate: () -> Types::DescribedCertificate
|
|
495
|
+
end
|
|
496
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#describe_certificate-instance_method
|
|
497
|
+
def describe_certificate: (
|
|
498
|
+
certificate_id: ::String
|
|
499
|
+
) -> _DescribeCertificateResponseSuccess
|
|
500
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeCertificateResponseSuccess
|
|
501
|
+
|
|
502
|
+
interface _DescribeConnectorResponseSuccess
|
|
503
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeConnectorResponse]
|
|
504
|
+
def connector: () -> Types::DescribedConnector
|
|
505
|
+
end
|
|
506
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#describe_connector-instance_method
|
|
507
|
+
def describe_connector: (
|
|
508
|
+
connector_id: ::String
|
|
509
|
+
) -> _DescribeConnectorResponseSuccess
|
|
510
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeConnectorResponseSuccess
|
|
511
|
+
|
|
512
|
+
interface _DescribeExecutionResponseSuccess
|
|
513
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeExecutionResponse]
|
|
514
|
+
def workflow_id: () -> ::String
|
|
515
|
+
def execution: () -> Types::DescribedExecution
|
|
516
|
+
end
|
|
517
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#describe_execution-instance_method
|
|
518
|
+
def describe_execution: (
|
|
519
|
+
execution_id: ::String,
|
|
520
|
+
workflow_id: ::String
|
|
521
|
+
) -> _DescribeExecutionResponseSuccess
|
|
522
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeExecutionResponseSuccess
|
|
523
|
+
|
|
524
|
+
interface _DescribeHostKeyResponseSuccess
|
|
525
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeHostKeyResponse]
|
|
526
|
+
def host_key: () -> Types::DescribedHostKey
|
|
527
|
+
end
|
|
528
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#describe_host_key-instance_method
|
|
529
|
+
def describe_host_key: (
|
|
530
|
+
server_id: ::String,
|
|
531
|
+
host_key_id: ::String
|
|
532
|
+
) -> _DescribeHostKeyResponseSuccess
|
|
533
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeHostKeyResponseSuccess
|
|
534
|
+
|
|
535
|
+
interface _DescribeProfileResponseSuccess
|
|
536
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeProfileResponse]
|
|
537
|
+
def profile: () -> Types::DescribedProfile
|
|
538
|
+
end
|
|
539
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#describe_profile-instance_method
|
|
540
|
+
def describe_profile: (
|
|
541
|
+
profile_id: ::String
|
|
542
|
+
) -> _DescribeProfileResponseSuccess
|
|
543
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeProfileResponseSuccess
|
|
544
|
+
|
|
545
|
+
interface _DescribeSecurityPolicyResponseSuccess
|
|
546
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeSecurityPolicyResponse]
|
|
547
|
+
def security_policy: () -> Types::DescribedSecurityPolicy
|
|
548
|
+
end
|
|
549
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#describe_security_policy-instance_method
|
|
550
|
+
def describe_security_policy: (
|
|
551
|
+
security_policy_name: ::String
|
|
552
|
+
) -> _DescribeSecurityPolicyResponseSuccess
|
|
553
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeSecurityPolicyResponseSuccess
|
|
554
|
+
|
|
555
|
+
interface _DescribeServerResponseSuccess
|
|
556
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeServerResponse]
|
|
557
|
+
def server: () -> Types::DescribedServer
|
|
558
|
+
end
|
|
559
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#describe_server-instance_method
|
|
560
|
+
def describe_server: (
|
|
561
|
+
server_id: ::String
|
|
562
|
+
) -> _DescribeServerResponseSuccess
|
|
563
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeServerResponseSuccess
|
|
564
|
+
|
|
565
|
+
interface _DescribeUserResponseSuccess
|
|
566
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeUserResponse]
|
|
567
|
+
def server_id: () -> ::String
|
|
568
|
+
def user: () -> Types::DescribedUser
|
|
569
|
+
end
|
|
570
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#describe_user-instance_method
|
|
571
|
+
def describe_user: (
|
|
572
|
+
server_id: ::String,
|
|
573
|
+
user_name: ::String
|
|
574
|
+
) -> _DescribeUserResponseSuccess
|
|
575
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeUserResponseSuccess
|
|
576
|
+
|
|
577
|
+
interface _DescribeWorkflowResponseSuccess
|
|
578
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeWorkflowResponse]
|
|
579
|
+
def workflow: () -> Types::DescribedWorkflow
|
|
580
|
+
end
|
|
581
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#describe_workflow-instance_method
|
|
582
|
+
def describe_workflow: (
|
|
583
|
+
workflow_id: ::String
|
|
584
|
+
) -> _DescribeWorkflowResponseSuccess
|
|
585
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeWorkflowResponseSuccess
|
|
586
|
+
|
|
587
|
+
interface _ImportCertificateResponseSuccess
|
|
588
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ImportCertificateResponse]
|
|
589
|
+
def certificate_id: () -> ::String
|
|
590
|
+
end
|
|
591
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#import_certificate-instance_method
|
|
592
|
+
def import_certificate: (
|
|
593
|
+
usage: ("SIGNING" | "ENCRYPTION"),
|
|
594
|
+
certificate: ::String,
|
|
595
|
+
?certificate_chain: ::String,
|
|
596
|
+
?private_key: ::String,
|
|
597
|
+
?active_date: ::Time,
|
|
598
|
+
?inactive_date: ::Time,
|
|
599
|
+
?description: ::String,
|
|
600
|
+
?tags: Array[
|
|
601
|
+
{
|
|
602
|
+
key: ::String,
|
|
603
|
+
value: ::String
|
|
604
|
+
},
|
|
605
|
+
]
|
|
606
|
+
) -> _ImportCertificateResponseSuccess
|
|
607
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ImportCertificateResponseSuccess
|
|
608
|
+
|
|
609
|
+
interface _ImportHostKeyResponseSuccess
|
|
610
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ImportHostKeyResponse]
|
|
611
|
+
def server_id: () -> ::String
|
|
612
|
+
def host_key_id: () -> ::String
|
|
613
|
+
end
|
|
614
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#import_host_key-instance_method
|
|
615
|
+
def import_host_key: (
|
|
616
|
+
server_id: ::String,
|
|
617
|
+
host_key_body: ::String,
|
|
618
|
+
?description: ::String,
|
|
619
|
+
?tags: Array[
|
|
620
|
+
{
|
|
621
|
+
key: ::String,
|
|
622
|
+
value: ::String
|
|
623
|
+
},
|
|
624
|
+
]
|
|
625
|
+
) -> _ImportHostKeyResponseSuccess
|
|
626
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ImportHostKeyResponseSuccess
|
|
627
|
+
|
|
628
|
+
interface _ImportSshPublicKeyResponseSuccess
|
|
629
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ImportSshPublicKeyResponse]
|
|
630
|
+
def server_id: () -> ::String
|
|
631
|
+
def ssh_public_key_id: () -> ::String
|
|
632
|
+
def user_name: () -> ::String
|
|
633
|
+
end
|
|
634
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#import_ssh_public_key-instance_method
|
|
635
|
+
def import_ssh_public_key: (
|
|
636
|
+
server_id: ::String,
|
|
637
|
+
ssh_public_key_body: ::String,
|
|
638
|
+
user_name: ::String
|
|
639
|
+
) -> _ImportSshPublicKeyResponseSuccess
|
|
640
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ImportSshPublicKeyResponseSuccess
|
|
641
|
+
|
|
642
|
+
interface _ListAccessesResponseSuccess
|
|
643
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListAccessesResponse]
|
|
644
|
+
def next_token: () -> ::String
|
|
645
|
+
def server_id: () -> ::String
|
|
646
|
+
def accesses: () -> ::Array[Types::ListedAccess]
|
|
647
|
+
end
|
|
648
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#list_accesses-instance_method
|
|
649
|
+
def list_accesses: (
|
|
650
|
+
?max_results: ::Integer,
|
|
651
|
+
?next_token: ::String,
|
|
652
|
+
server_id: ::String
|
|
653
|
+
) -> _ListAccessesResponseSuccess
|
|
654
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAccessesResponseSuccess
|
|
655
|
+
|
|
656
|
+
interface _ListAgreementsResponseSuccess
|
|
657
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListAgreementsResponse]
|
|
658
|
+
def next_token: () -> ::String
|
|
659
|
+
def agreements: () -> ::Array[Types::ListedAgreement]
|
|
660
|
+
end
|
|
661
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#list_agreements-instance_method
|
|
662
|
+
def list_agreements: (
|
|
663
|
+
?max_results: ::Integer,
|
|
664
|
+
?next_token: ::String,
|
|
665
|
+
server_id: ::String
|
|
666
|
+
) -> _ListAgreementsResponseSuccess
|
|
667
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAgreementsResponseSuccess
|
|
668
|
+
|
|
669
|
+
interface _ListCertificatesResponseSuccess
|
|
670
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListCertificatesResponse]
|
|
671
|
+
def next_token: () -> ::String
|
|
672
|
+
def certificates: () -> ::Array[Types::ListedCertificate]
|
|
673
|
+
end
|
|
674
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#list_certificates-instance_method
|
|
675
|
+
def list_certificates: (
|
|
676
|
+
?max_results: ::Integer,
|
|
677
|
+
?next_token: ::String
|
|
678
|
+
) -> _ListCertificatesResponseSuccess
|
|
679
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListCertificatesResponseSuccess
|
|
680
|
+
|
|
681
|
+
interface _ListConnectorsResponseSuccess
|
|
682
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListConnectorsResponse]
|
|
683
|
+
def next_token: () -> ::String
|
|
684
|
+
def connectors: () -> ::Array[Types::ListedConnector]
|
|
685
|
+
end
|
|
686
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#list_connectors-instance_method
|
|
687
|
+
def list_connectors: (
|
|
688
|
+
?max_results: ::Integer,
|
|
689
|
+
?next_token: ::String
|
|
690
|
+
) -> _ListConnectorsResponseSuccess
|
|
691
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListConnectorsResponseSuccess
|
|
692
|
+
|
|
693
|
+
interface _ListExecutionsResponseSuccess
|
|
694
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListExecutionsResponse]
|
|
695
|
+
def next_token: () -> ::String
|
|
696
|
+
def workflow_id: () -> ::String
|
|
697
|
+
def executions: () -> ::Array[Types::ListedExecution]
|
|
698
|
+
end
|
|
699
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#list_executions-instance_method
|
|
700
|
+
def list_executions: (
|
|
701
|
+
?max_results: ::Integer,
|
|
702
|
+
?next_token: ::String,
|
|
703
|
+
workflow_id: ::String
|
|
704
|
+
) -> _ListExecutionsResponseSuccess
|
|
705
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListExecutionsResponseSuccess
|
|
706
|
+
|
|
707
|
+
interface _ListHostKeysResponseSuccess
|
|
708
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListHostKeysResponse]
|
|
709
|
+
def next_token: () -> ::String
|
|
710
|
+
def server_id: () -> ::String
|
|
711
|
+
def host_keys: () -> ::Array[Types::ListedHostKey]
|
|
712
|
+
end
|
|
713
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#list_host_keys-instance_method
|
|
714
|
+
def list_host_keys: (
|
|
715
|
+
?max_results: ::Integer,
|
|
716
|
+
?next_token: ::String,
|
|
717
|
+
server_id: ::String
|
|
718
|
+
) -> _ListHostKeysResponseSuccess
|
|
719
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListHostKeysResponseSuccess
|
|
720
|
+
|
|
721
|
+
interface _ListProfilesResponseSuccess
|
|
722
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListProfilesResponse]
|
|
723
|
+
def next_token: () -> ::String
|
|
724
|
+
def profiles: () -> ::Array[Types::ListedProfile]
|
|
725
|
+
end
|
|
726
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#list_profiles-instance_method
|
|
727
|
+
def list_profiles: (
|
|
728
|
+
?max_results: ::Integer,
|
|
729
|
+
?next_token: ::String,
|
|
730
|
+
?profile_type: ("LOCAL" | "PARTNER")
|
|
731
|
+
) -> _ListProfilesResponseSuccess
|
|
732
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListProfilesResponseSuccess
|
|
733
|
+
|
|
734
|
+
interface _ListSecurityPoliciesResponseSuccess
|
|
735
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListSecurityPoliciesResponse]
|
|
736
|
+
def next_token: () -> ::String
|
|
737
|
+
def security_policy_names: () -> ::Array[::String]
|
|
738
|
+
end
|
|
739
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#list_security_policies-instance_method
|
|
740
|
+
def list_security_policies: (
|
|
741
|
+
?max_results: ::Integer,
|
|
742
|
+
?next_token: ::String
|
|
743
|
+
) -> _ListSecurityPoliciesResponseSuccess
|
|
744
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListSecurityPoliciesResponseSuccess
|
|
745
|
+
|
|
746
|
+
interface _ListServersResponseSuccess
|
|
747
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListServersResponse]
|
|
748
|
+
def next_token: () -> ::String
|
|
749
|
+
def servers: () -> ::Array[Types::ListedServer]
|
|
750
|
+
end
|
|
751
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#list_servers-instance_method
|
|
752
|
+
def list_servers: (
|
|
753
|
+
?max_results: ::Integer,
|
|
754
|
+
?next_token: ::String
|
|
755
|
+
) -> _ListServersResponseSuccess
|
|
756
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListServersResponseSuccess
|
|
757
|
+
|
|
758
|
+
interface _ListTagsForResourceResponseSuccess
|
|
759
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
|
|
760
|
+
def arn: () -> ::String
|
|
761
|
+
def next_token: () -> ::String
|
|
762
|
+
def tags: () -> ::Array[Types::Tag]
|
|
763
|
+
end
|
|
764
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#list_tags_for_resource-instance_method
|
|
765
|
+
def list_tags_for_resource: (
|
|
766
|
+
arn: ::String,
|
|
767
|
+
?max_results: ::Integer,
|
|
768
|
+
?next_token: ::String
|
|
769
|
+
) -> _ListTagsForResourceResponseSuccess
|
|
770
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
|
|
771
|
+
|
|
772
|
+
interface _ListUsersResponseSuccess
|
|
773
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListUsersResponse]
|
|
774
|
+
def next_token: () -> ::String
|
|
775
|
+
def server_id: () -> ::String
|
|
776
|
+
def users: () -> ::Array[Types::ListedUser]
|
|
777
|
+
end
|
|
778
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#list_users-instance_method
|
|
779
|
+
def list_users: (
|
|
780
|
+
?max_results: ::Integer,
|
|
781
|
+
?next_token: ::String,
|
|
782
|
+
server_id: ::String
|
|
783
|
+
) -> _ListUsersResponseSuccess
|
|
784
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListUsersResponseSuccess
|
|
785
|
+
|
|
786
|
+
interface _ListWorkflowsResponseSuccess
|
|
787
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListWorkflowsResponse]
|
|
788
|
+
def next_token: () -> ::String
|
|
789
|
+
def workflows: () -> ::Array[Types::ListedWorkflow]
|
|
790
|
+
end
|
|
791
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#list_workflows-instance_method
|
|
792
|
+
def list_workflows: (
|
|
793
|
+
?max_results: ::Integer,
|
|
794
|
+
?next_token: ::String
|
|
795
|
+
) -> _ListWorkflowsResponseSuccess
|
|
796
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListWorkflowsResponseSuccess
|
|
797
|
+
|
|
798
|
+
interface _SendWorkflowStepStateResponseSuccess
|
|
799
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SendWorkflowStepStateResponse]
|
|
800
|
+
end
|
|
801
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#send_workflow_step_state-instance_method
|
|
802
|
+
def send_workflow_step_state: (
|
|
803
|
+
workflow_id: ::String,
|
|
804
|
+
execution_id: ::String,
|
|
805
|
+
token: ::String,
|
|
806
|
+
status: ("SUCCESS" | "FAILURE")
|
|
807
|
+
) -> _SendWorkflowStepStateResponseSuccess
|
|
808
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SendWorkflowStepStateResponseSuccess
|
|
809
|
+
|
|
810
|
+
interface _StartFileTransferResponseSuccess
|
|
811
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartFileTransferResponse]
|
|
812
|
+
def transfer_id: () -> ::String
|
|
813
|
+
end
|
|
814
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#start_file_transfer-instance_method
|
|
815
|
+
def start_file_transfer: (
|
|
816
|
+
connector_id: ::String,
|
|
817
|
+
?send_file_paths: Array[::String],
|
|
818
|
+
?retrieve_file_paths: Array[::String],
|
|
819
|
+
?local_directory_path: ::String,
|
|
820
|
+
?remote_directory_path: ::String
|
|
821
|
+
) -> _StartFileTransferResponseSuccess
|
|
822
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartFileTransferResponseSuccess
|
|
823
|
+
|
|
824
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#start_server-instance_method
|
|
825
|
+
def start_server: (
|
|
826
|
+
server_id: ::String
|
|
827
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
828
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
829
|
+
|
|
830
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#stop_server-instance_method
|
|
831
|
+
def stop_server: (
|
|
832
|
+
server_id: ::String
|
|
833
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
834
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
835
|
+
|
|
836
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#tag_resource-instance_method
|
|
837
|
+
def tag_resource: (
|
|
838
|
+
arn: ::String,
|
|
839
|
+
tags: Array[
|
|
840
|
+
{
|
|
841
|
+
key: ::String,
|
|
842
|
+
value: ::String
|
|
843
|
+
},
|
|
844
|
+
]
|
|
845
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
846
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
847
|
+
|
|
848
|
+
interface _TestConnectionResponseSuccess
|
|
849
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TestConnectionResponse]
|
|
850
|
+
def connector_id: () -> ::String
|
|
851
|
+
def status: () -> ::String
|
|
852
|
+
def status_message: () -> ::String
|
|
853
|
+
end
|
|
854
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#test_connection-instance_method
|
|
855
|
+
def test_connection: (
|
|
856
|
+
connector_id: ::String
|
|
857
|
+
) -> _TestConnectionResponseSuccess
|
|
858
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TestConnectionResponseSuccess
|
|
859
|
+
|
|
860
|
+
interface _TestIdentityProviderResponseSuccess
|
|
861
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TestIdentityProviderResponse]
|
|
862
|
+
def response: () -> ::String
|
|
863
|
+
def status_code: () -> ::Integer
|
|
864
|
+
def message: () -> ::String
|
|
865
|
+
def url: () -> ::String
|
|
866
|
+
end
|
|
867
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#test_identity_provider-instance_method
|
|
868
|
+
def test_identity_provider: (
|
|
869
|
+
server_id: ::String,
|
|
870
|
+
?server_protocol: ("SFTP" | "FTP" | "FTPS" | "AS2"),
|
|
871
|
+
?source_ip: ::String,
|
|
872
|
+
user_name: ::String,
|
|
873
|
+
?user_password: ::String
|
|
874
|
+
) -> _TestIdentityProviderResponseSuccess
|
|
875
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TestIdentityProviderResponseSuccess
|
|
876
|
+
|
|
877
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#untag_resource-instance_method
|
|
878
|
+
def untag_resource: (
|
|
879
|
+
arn: ::String,
|
|
880
|
+
tag_keys: Array[::String]
|
|
881
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
882
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
883
|
+
|
|
884
|
+
interface _UpdateAccessResponseSuccess
|
|
885
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateAccessResponse]
|
|
886
|
+
def server_id: () -> ::String
|
|
887
|
+
def external_id: () -> ::String
|
|
888
|
+
end
|
|
889
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#update_access-instance_method
|
|
890
|
+
def update_access: (
|
|
891
|
+
?home_directory: ::String,
|
|
892
|
+
?home_directory_type: ("PATH" | "LOGICAL"),
|
|
893
|
+
?home_directory_mappings: Array[
|
|
894
|
+
{
|
|
895
|
+
entry: ::String,
|
|
896
|
+
target: ::String,
|
|
897
|
+
type: ("FILE" | "DIRECTORY")?
|
|
898
|
+
},
|
|
899
|
+
],
|
|
900
|
+
?policy: ::String,
|
|
901
|
+
?posix_profile: {
|
|
902
|
+
uid: ::Integer,
|
|
903
|
+
gid: ::Integer,
|
|
904
|
+
secondary_gids: Array[::Integer]?
|
|
905
|
+
},
|
|
906
|
+
?role: ::String,
|
|
907
|
+
server_id: ::String,
|
|
908
|
+
external_id: ::String
|
|
909
|
+
) -> _UpdateAccessResponseSuccess
|
|
910
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAccessResponseSuccess
|
|
911
|
+
|
|
912
|
+
interface _UpdateAgreementResponseSuccess
|
|
913
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateAgreementResponse]
|
|
914
|
+
def agreement_id: () -> ::String
|
|
915
|
+
end
|
|
916
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#update_agreement-instance_method
|
|
917
|
+
def update_agreement: (
|
|
918
|
+
agreement_id: ::String,
|
|
919
|
+
server_id: ::String,
|
|
920
|
+
?description: ::String,
|
|
921
|
+
?status: ("ACTIVE" | "INACTIVE"),
|
|
922
|
+
?local_profile_id: ::String,
|
|
923
|
+
?partner_profile_id: ::String,
|
|
924
|
+
?base_directory: ::String,
|
|
925
|
+
?access_role: ::String
|
|
926
|
+
) -> _UpdateAgreementResponseSuccess
|
|
927
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAgreementResponseSuccess
|
|
928
|
+
|
|
929
|
+
interface _UpdateCertificateResponseSuccess
|
|
930
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateCertificateResponse]
|
|
931
|
+
def certificate_id: () -> ::String
|
|
932
|
+
end
|
|
933
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#update_certificate-instance_method
|
|
934
|
+
def update_certificate: (
|
|
935
|
+
certificate_id: ::String,
|
|
936
|
+
?active_date: ::Time,
|
|
937
|
+
?inactive_date: ::Time,
|
|
938
|
+
?description: ::String
|
|
939
|
+
) -> _UpdateCertificateResponseSuccess
|
|
940
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateCertificateResponseSuccess
|
|
941
|
+
|
|
942
|
+
interface _UpdateConnectorResponseSuccess
|
|
943
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateConnectorResponse]
|
|
944
|
+
def connector_id: () -> ::String
|
|
945
|
+
end
|
|
946
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#update_connector-instance_method
|
|
947
|
+
def update_connector: (
|
|
948
|
+
connector_id: ::String,
|
|
949
|
+
?url: ::String,
|
|
950
|
+
?as_2_config: {
|
|
951
|
+
local_profile_id: ::String?,
|
|
952
|
+
partner_profile_id: ::String?,
|
|
953
|
+
message_subject: ::String?,
|
|
954
|
+
compression: ("ZLIB" | "DISABLED")?,
|
|
955
|
+
encryption_algorithm: ("AES128_CBC" | "AES192_CBC" | "AES256_CBC" | "NONE")?,
|
|
956
|
+
signing_algorithm: ("SHA256" | "SHA384" | "SHA512" | "SHA1" | "NONE")?,
|
|
957
|
+
mdn_signing_algorithm: ("SHA256" | "SHA384" | "SHA512" | "SHA1" | "NONE" | "DEFAULT")?,
|
|
958
|
+
mdn_response: ("SYNC" | "NONE")?,
|
|
959
|
+
basic_auth_secret_id: ::String?
|
|
960
|
+
},
|
|
961
|
+
?access_role: ::String,
|
|
962
|
+
?logging_role: ::String,
|
|
963
|
+
?sftp_config: {
|
|
964
|
+
user_secret_id: ::String?,
|
|
965
|
+
trusted_host_keys: Array[::String]?
|
|
966
|
+
}
|
|
967
|
+
) -> _UpdateConnectorResponseSuccess
|
|
968
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateConnectorResponseSuccess
|
|
969
|
+
|
|
970
|
+
interface _UpdateHostKeyResponseSuccess
|
|
971
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateHostKeyResponse]
|
|
972
|
+
def server_id: () -> ::String
|
|
973
|
+
def host_key_id: () -> ::String
|
|
974
|
+
end
|
|
975
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#update_host_key-instance_method
|
|
976
|
+
def update_host_key: (
|
|
977
|
+
server_id: ::String,
|
|
978
|
+
host_key_id: ::String,
|
|
979
|
+
description: ::String
|
|
980
|
+
) -> _UpdateHostKeyResponseSuccess
|
|
981
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateHostKeyResponseSuccess
|
|
982
|
+
|
|
983
|
+
interface _UpdateProfileResponseSuccess
|
|
984
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateProfileResponse]
|
|
985
|
+
def profile_id: () -> ::String
|
|
986
|
+
end
|
|
987
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#update_profile-instance_method
|
|
988
|
+
def update_profile: (
|
|
989
|
+
profile_id: ::String,
|
|
990
|
+
?certificate_ids: Array[::String]
|
|
991
|
+
) -> _UpdateProfileResponseSuccess
|
|
992
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateProfileResponseSuccess
|
|
993
|
+
|
|
994
|
+
interface _UpdateServerResponseSuccess
|
|
995
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateServerResponse]
|
|
996
|
+
def server_id: () -> ::String
|
|
997
|
+
end
|
|
998
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#update_server-instance_method
|
|
999
|
+
def update_server: (
|
|
1000
|
+
?certificate: ::String,
|
|
1001
|
+
?protocol_details: {
|
|
1002
|
+
passive_ip: ::String?,
|
|
1003
|
+
tls_session_resumption_mode: ("DISABLED" | "ENABLED" | "ENFORCED")?,
|
|
1004
|
+
set_stat_option: ("DEFAULT" | "ENABLE_NO_OP")?,
|
|
1005
|
+
as_2_transports: Array[("HTTP")]?
|
|
1006
|
+
},
|
|
1007
|
+
?endpoint_details: {
|
|
1008
|
+
address_allocation_ids: Array[::String]?,
|
|
1009
|
+
subnet_ids: Array[::String]?,
|
|
1010
|
+
vpc_endpoint_id: ::String?,
|
|
1011
|
+
vpc_id: ::String?,
|
|
1012
|
+
security_group_ids: Array[::String]?
|
|
1013
|
+
},
|
|
1014
|
+
?endpoint_type: ("PUBLIC" | "VPC" | "VPC_ENDPOINT"),
|
|
1015
|
+
?host_key: ::String,
|
|
1016
|
+
?identity_provider_details: {
|
|
1017
|
+
url: ::String?,
|
|
1018
|
+
invocation_role: ::String?,
|
|
1019
|
+
directory_id: ::String?,
|
|
1020
|
+
function: ::String?,
|
|
1021
|
+
sftp_authentication_methods: ("PASSWORD" | "PUBLIC_KEY" | "PUBLIC_KEY_OR_PASSWORD" | "PUBLIC_KEY_AND_PASSWORD")?
|
|
1022
|
+
},
|
|
1023
|
+
?logging_role: ::String,
|
|
1024
|
+
?post_authentication_login_banner: ::String,
|
|
1025
|
+
?pre_authentication_login_banner: ::String,
|
|
1026
|
+
?protocols: Array[("SFTP" | "FTP" | "FTPS" | "AS2")],
|
|
1027
|
+
?security_policy_name: ::String,
|
|
1028
|
+
server_id: ::String,
|
|
1029
|
+
?workflow_details: {
|
|
1030
|
+
on_upload: Array[
|
|
1031
|
+
{
|
|
1032
|
+
workflow_id: ::String,
|
|
1033
|
+
execution_role: ::String
|
|
1034
|
+
},
|
|
1035
|
+
]?,
|
|
1036
|
+
on_partial_upload: Array[
|
|
1037
|
+
{
|
|
1038
|
+
workflow_id: ::String,
|
|
1039
|
+
execution_role: ::String
|
|
1040
|
+
},
|
|
1041
|
+
]?
|
|
1042
|
+
},
|
|
1043
|
+
?structured_log_destinations: Array[::String],
|
|
1044
|
+
?s3_storage_options: {
|
|
1045
|
+
directory_listing_optimization: ("ENABLED" | "DISABLED")?
|
|
1046
|
+
}
|
|
1047
|
+
) -> _UpdateServerResponseSuccess
|
|
1048
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateServerResponseSuccess
|
|
1049
|
+
|
|
1050
|
+
interface _UpdateUserResponseSuccess
|
|
1051
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateUserResponse]
|
|
1052
|
+
def server_id: () -> ::String
|
|
1053
|
+
def user_name: () -> ::String
|
|
1054
|
+
end
|
|
1055
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#update_user-instance_method
|
|
1056
|
+
def update_user: (
|
|
1057
|
+
?home_directory: ::String,
|
|
1058
|
+
?home_directory_type: ("PATH" | "LOGICAL"),
|
|
1059
|
+
?home_directory_mappings: Array[
|
|
1060
|
+
{
|
|
1061
|
+
entry: ::String,
|
|
1062
|
+
target: ::String,
|
|
1063
|
+
type: ("FILE" | "DIRECTORY")?
|
|
1064
|
+
},
|
|
1065
|
+
],
|
|
1066
|
+
?policy: ::String,
|
|
1067
|
+
?posix_profile: {
|
|
1068
|
+
uid: ::Integer,
|
|
1069
|
+
gid: ::Integer,
|
|
1070
|
+
secondary_gids: Array[::Integer]?
|
|
1071
|
+
},
|
|
1072
|
+
?role: ::String,
|
|
1073
|
+
server_id: ::String,
|
|
1074
|
+
user_name: ::String
|
|
1075
|
+
) -> _UpdateUserResponseSuccess
|
|
1076
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateUserResponseSuccess
|
|
1077
|
+
|
|
1078
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Transfer/Client.html#wait_until-instance_method
|
|
1079
|
+
def wait_until: (:server_offline waiter_name,
|
|
1080
|
+
server_id: ::String
|
|
1081
|
+
) -> Client::_DescribeServerResponseSuccess
|
|
1082
|
+
| (:server_offline waiter_name, Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> Client::_DescribeServerResponseSuccess
|
|
1083
|
+
| (:server_online waiter_name,
|
|
1084
|
+
server_id: ::String
|
|
1085
|
+
) -> Client::_DescribeServerResponseSuccess
|
|
1086
|
+
| (:server_online waiter_name, Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> Client::_DescribeServerResponseSuccess
|
|
1087
|
+
end
|
|
1088
|
+
end
|
|
1089
|
+
end
|
|
1090
|
+
|