mypy-boto3-transfer 1.35.40__py3-none-any.whl → 1.35.72__py3-none-any.whl
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.
- mypy_boto3_transfer/__init__.py +6 -0
- mypy_boto3_transfer/__init__.pyi +6 -0
- mypy_boto3_transfer/__main__.py +7 -5
- mypy_boto3_transfer/client.py +281 -170
- mypy_boto3_transfer/client.pyi +281 -170
- mypy_boto3_transfer/literals.py +25 -7
- mypy_boto3_transfer/literals.pyi +25 -7
- mypy_boto3_transfer/paginator.py +47 -25
- mypy_boto3_transfer/paginator.pyi +45 -25
- mypy_boto3_transfer/type_defs.py +1463 -1626
- mypy_boto3_transfer/type_defs.pyi +1267 -1640
- mypy_boto3_transfer/version.py +3 -1
- mypy_boto3_transfer/waiter.py +6 -4
- mypy_boto3_transfer/waiter.pyi +6 -4
- {mypy_boto3_transfer-1.35.40.dist-info → mypy_boto3_transfer-1.35.72.dist-info}/METADATA +61 -18
- mypy_boto3_transfer-1.35.72.dist-info/RECORD +20 -0
- {mypy_boto3_transfer-1.35.40.dist-info → mypy_boto3_transfer-1.35.72.dist-info}/WHEEL +1 -1
- mypy_boto3_transfer-1.35.40.dist-info/RECORD +0 -20
- {mypy_boto3_transfer-1.35.40.dist-info → mypy_boto3_transfer-1.35.72.dist-info}/LICENSE +0 -0
- {mypy_boto3_transfer-1.35.40.dist-info → mypy_boto3_transfer-1.35.72.dist-info}/top_level.txt +0 -0
mypy_boto3_transfer/client.py
CHANGED
|
@@ -12,6 +12,8 @@ Usage::
|
|
|
12
12
|
session = Session()
|
|
13
13
|
client: TransferClient = session.client("transfer")
|
|
14
14
|
```
|
|
15
|
+
|
|
16
|
+
Copyright 2024 Vlad Emelianov
|
|
15
17
|
"""
|
|
16
18
|
|
|
17
19
|
import sys
|
|
@@ -31,6 +33,7 @@ from .paginator import (
|
|
|
31
33
|
ListServersPaginator,
|
|
32
34
|
ListTagsForResourcePaginator,
|
|
33
35
|
ListUsersPaginator,
|
|
36
|
+
ListWebAppsPaginator,
|
|
34
37
|
ListWorkflowsPaginator,
|
|
35
38
|
)
|
|
36
39
|
from .type_defs import (
|
|
@@ -46,6 +49,8 @@ from .type_defs import (
|
|
|
46
49
|
CreateServerResponseTypeDef,
|
|
47
50
|
CreateUserRequestRequestTypeDef,
|
|
48
51
|
CreateUserResponseTypeDef,
|
|
52
|
+
CreateWebAppRequestRequestTypeDef,
|
|
53
|
+
CreateWebAppResponseTypeDef,
|
|
49
54
|
CreateWorkflowRequestRequestTypeDef,
|
|
50
55
|
CreateWorkflowResponseTypeDef,
|
|
51
56
|
DeleteAccessRequestRequestTypeDef,
|
|
@@ -57,6 +62,8 @@ from .type_defs import (
|
|
|
57
62
|
DeleteServerRequestRequestTypeDef,
|
|
58
63
|
DeleteSshPublicKeyRequestRequestTypeDef,
|
|
59
64
|
DeleteUserRequestRequestTypeDef,
|
|
65
|
+
DeleteWebAppCustomizationRequestRequestTypeDef,
|
|
66
|
+
DeleteWebAppRequestRequestTypeDef,
|
|
60
67
|
DeleteWorkflowRequestRequestTypeDef,
|
|
61
68
|
DescribeAccessRequestRequestTypeDef,
|
|
62
69
|
DescribeAccessResponseTypeDef,
|
|
@@ -78,6 +85,10 @@ from .type_defs import (
|
|
|
78
85
|
DescribeServerResponseTypeDef,
|
|
79
86
|
DescribeUserRequestRequestTypeDef,
|
|
80
87
|
DescribeUserResponseTypeDef,
|
|
88
|
+
DescribeWebAppCustomizationRequestRequestTypeDef,
|
|
89
|
+
DescribeWebAppCustomizationResponseTypeDef,
|
|
90
|
+
DescribeWebAppRequestRequestTypeDef,
|
|
91
|
+
DescribeWebAppResponseTypeDef,
|
|
81
92
|
DescribeWorkflowRequestRequestTypeDef,
|
|
82
93
|
DescribeWorkflowResponseTypeDef,
|
|
83
94
|
EmptyResponseMetadataTypeDef,
|
|
@@ -111,6 +122,8 @@ from .type_defs import (
|
|
|
111
122
|
ListTagsForResourceResponseTypeDef,
|
|
112
123
|
ListUsersRequestRequestTypeDef,
|
|
113
124
|
ListUsersResponseTypeDef,
|
|
125
|
+
ListWebAppsRequestRequestTypeDef,
|
|
126
|
+
ListWebAppsResponseTypeDef,
|
|
114
127
|
ListWorkflowsRequestRequestTypeDef,
|
|
115
128
|
ListWorkflowsResponseTypeDef,
|
|
116
129
|
SendWorkflowStepStateRequestRequestTypeDef,
|
|
@@ -142,6 +155,10 @@ from .type_defs import (
|
|
|
142
155
|
UpdateServerResponseTypeDef,
|
|
143
156
|
UpdateUserRequestRequestTypeDef,
|
|
144
157
|
UpdateUserResponseTypeDef,
|
|
158
|
+
UpdateWebAppCustomizationRequestRequestTypeDef,
|
|
159
|
+
UpdateWebAppCustomizationResponseTypeDef,
|
|
160
|
+
UpdateWebAppRequestRequestTypeDef,
|
|
161
|
+
UpdateWebAppResponseTypeDef,
|
|
145
162
|
)
|
|
146
163
|
from .waiter import ServerOfflineWaiter, ServerOnlineWaiter
|
|
147
164
|
|
|
@@ -188,23 +205,31 @@ class TransferClient(BaseClient):
|
|
|
188
205
|
"""
|
|
189
206
|
TransferClient exceptions.
|
|
190
207
|
|
|
191
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client
|
|
208
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client)
|
|
192
209
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#exceptions)
|
|
193
210
|
"""
|
|
194
211
|
|
|
195
212
|
def can_paginate(self, operation_name: str) -> bool:
|
|
196
213
|
"""
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.can_paginate)
|
|
214
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/can_paginate.html)
|
|
200
215
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#can_paginate)
|
|
201
216
|
"""
|
|
202
217
|
|
|
203
|
-
def
|
|
218
|
+
def generate_presigned_url(
|
|
219
|
+
self,
|
|
220
|
+
ClientMethod: str,
|
|
221
|
+
Params: Mapping[str, Any] = ...,
|
|
222
|
+
ExpiresIn: int = 3600,
|
|
223
|
+
HttpMethod: str = ...,
|
|
224
|
+
) -> str:
|
|
225
|
+
"""
|
|
226
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/generate_presigned_url.html)
|
|
227
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#generate_presigned_url)
|
|
204
228
|
"""
|
|
205
|
-
Closes underlying endpoint connections.
|
|
206
229
|
|
|
207
|
-
|
|
230
|
+
def close(self) -> None:
|
|
231
|
+
"""
|
|
232
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/close.html)
|
|
208
233
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#close)
|
|
209
234
|
"""
|
|
210
235
|
|
|
@@ -216,7 +241,7 @@ class TransferClient(BaseClient):
|
|
|
216
241
|
access to upload and download files over the enabled protocols using Transfer
|
|
217
242
|
Family.
|
|
218
243
|
|
|
219
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
244
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/create_access.html)
|
|
220
245
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_access)
|
|
221
246
|
"""
|
|
222
247
|
|
|
@@ -226,7 +251,7 @@ class TransferClient(BaseClient):
|
|
|
226
251
|
"""
|
|
227
252
|
Creates an agreement.
|
|
228
253
|
|
|
229
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
254
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/create_agreement.html)
|
|
230
255
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_agreement)
|
|
231
256
|
"""
|
|
232
257
|
|
|
@@ -235,10 +260,9 @@ class TransferClient(BaseClient):
|
|
|
235
260
|
) -> CreateConnectorResponseTypeDef:
|
|
236
261
|
"""
|
|
237
262
|
Creates the connector, which captures the parameters for a connection for the
|
|
238
|
-
AS2 or SFTP
|
|
239
|
-
protocol.
|
|
263
|
+
AS2 or SFTP protocol.
|
|
240
264
|
|
|
241
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
265
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/create_connector.html)
|
|
242
266
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_connector)
|
|
243
267
|
"""
|
|
244
268
|
|
|
@@ -248,7 +272,7 @@ class TransferClient(BaseClient):
|
|
|
248
272
|
"""
|
|
249
273
|
Creates the local or partner profile to use for AS2 transfers.
|
|
250
274
|
|
|
251
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
275
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/create_profile.html)
|
|
252
276
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_profile)
|
|
253
277
|
"""
|
|
254
278
|
|
|
@@ -257,10 +281,9 @@ class TransferClient(BaseClient):
|
|
|
257
281
|
) -> CreateServerResponseTypeDef:
|
|
258
282
|
"""
|
|
259
283
|
Instantiates an auto-scaling virtual server based on the selected file transfer
|
|
260
|
-
protocol in Amazon Web
|
|
261
|
-
Services.
|
|
284
|
+
protocol in Amazon Web Services.
|
|
262
285
|
|
|
263
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
286
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/create_server.html)
|
|
264
287
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_server)
|
|
265
288
|
"""
|
|
266
289
|
|
|
@@ -269,22 +292,31 @@ class TransferClient(BaseClient):
|
|
|
269
292
|
) -> CreateUserResponseTypeDef:
|
|
270
293
|
"""
|
|
271
294
|
Creates a user and associates them with an existing file transfer
|
|
272
|
-
protocol-enabled
|
|
273
|
-
server.
|
|
295
|
+
protocol-enabled server.
|
|
274
296
|
|
|
275
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
297
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/create_user.html)
|
|
276
298
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_user)
|
|
277
299
|
"""
|
|
278
300
|
|
|
301
|
+
def create_web_app(
|
|
302
|
+
self, **kwargs: Unpack[CreateWebAppRequestRequestTypeDef]
|
|
303
|
+
) -> CreateWebAppResponseTypeDef:
|
|
304
|
+
"""
|
|
305
|
+
Creates a web app based on specified parameters, and returns the ID for the new
|
|
306
|
+
web app.
|
|
307
|
+
|
|
308
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/create_web_app.html)
|
|
309
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_web_app)
|
|
310
|
+
"""
|
|
311
|
+
|
|
279
312
|
def create_workflow(
|
|
280
313
|
self, **kwargs: Unpack[CreateWorkflowRequestRequestTypeDef]
|
|
281
314
|
) -> CreateWorkflowResponseTypeDef:
|
|
282
315
|
"""
|
|
283
316
|
Allows you to create a workflow with specified steps and step details the
|
|
284
|
-
workflow invokes after file transfer
|
|
285
|
-
completes.
|
|
317
|
+
workflow invokes after file transfer completes.
|
|
286
318
|
|
|
287
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
319
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/create_workflow.html)
|
|
288
320
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_workflow)
|
|
289
321
|
"""
|
|
290
322
|
|
|
@@ -292,10 +324,10 @@ class TransferClient(BaseClient):
|
|
|
292
324
|
self, **kwargs: Unpack[DeleteAccessRequestRequestTypeDef]
|
|
293
325
|
) -> EmptyResponseMetadataTypeDef:
|
|
294
326
|
"""
|
|
295
|
-
Allows you to delete the access specified in the
|
|
296
|
-
parameters.
|
|
327
|
+
Allows you to delete the access specified in the <code>ServerID</code> and
|
|
328
|
+
<code>ExternalID</code> parameters.
|
|
297
329
|
|
|
298
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
330
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_access.html)
|
|
299
331
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_access)
|
|
300
332
|
"""
|
|
301
333
|
|
|
@@ -303,9 +335,9 @@ class TransferClient(BaseClient):
|
|
|
303
335
|
self, **kwargs: Unpack[DeleteAgreementRequestRequestTypeDef]
|
|
304
336
|
) -> EmptyResponseMetadataTypeDef:
|
|
305
337
|
"""
|
|
306
|
-
Delete the agreement that's specified in the provided
|
|
338
|
+
Delete the agreement that's specified in the provided <code>AgreementId</code>.
|
|
307
339
|
|
|
308
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
340
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_agreement.html)
|
|
309
341
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_agreement)
|
|
310
342
|
"""
|
|
311
343
|
|
|
@@ -313,9 +345,10 @@ class TransferClient(BaseClient):
|
|
|
313
345
|
self, **kwargs: Unpack[DeleteCertificateRequestRequestTypeDef]
|
|
314
346
|
) -> EmptyResponseMetadataTypeDef:
|
|
315
347
|
"""
|
|
316
|
-
Deletes the certificate that's specified in the
|
|
348
|
+
Deletes the certificate that's specified in the <code>CertificateId</code>
|
|
349
|
+
parameter.
|
|
317
350
|
|
|
318
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
351
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_certificate.html)
|
|
319
352
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_certificate)
|
|
320
353
|
"""
|
|
321
354
|
|
|
@@ -323,9 +356,9 @@ class TransferClient(BaseClient):
|
|
|
323
356
|
self, **kwargs: Unpack[DeleteConnectorRequestRequestTypeDef]
|
|
324
357
|
) -> EmptyResponseMetadataTypeDef:
|
|
325
358
|
"""
|
|
326
|
-
Deletes the connector that's specified in the provided
|
|
359
|
+
Deletes the connector that's specified in the provided <code>ConnectorId</code>.
|
|
327
360
|
|
|
328
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
361
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_connector.html)
|
|
329
362
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_connector)
|
|
330
363
|
"""
|
|
331
364
|
|
|
@@ -333,9 +366,9 @@ class TransferClient(BaseClient):
|
|
|
333
366
|
self, **kwargs: Unpack[DeleteHostKeyRequestRequestTypeDef]
|
|
334
367
|
) -> EmptyResponseMetadataTypeDef:
|
|
335
368
|
"""
|
|
336
|
-
Deletes the host key that's specified in the
|
|
369
|
+
Deletes the host key that's specified in the <code>HostKeyId</code> parameter.
|
|
337
370
|
|
|
338
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
371
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_host_key.html)
|
|
339
372
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_host_key)
|
|
340
373
|
"""
|
|
341
374
|
|
|
@@ -343,9 +376,9 @@ class TransferClient(BaseClient):
|
|
|
343
376
|
self, **kwargs: Unpack[DeleteProfileRequestRequestTypeDef]
|
|
344
377
|
) -> EmptyResponseMetadataTypeDef:
|
|
345
378
|
"""
|
|
346
|
-
Deletes the profile that's specified in the
|
|
379
|
+
Deletes the profile that's specified in the <code>ProfileId</code> parameter.
|
|
347
380
|
|
|
348
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
381
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_profile.html)
|
|
349
382
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_profile)
|
|
350
383
|
"""
|
|
351
384
|
|
|
@@ -355,7 +388,7 @@ class TransferClient(BaseClient):
|
|
|
355
388
|
"""
|
|
356
389
|
Deletes the file transfer protocol-enabled server that you specify.
|
|
357
390
|
|
|
358
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
391
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_server.html)
|
|
359
392
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_server)
|
|
360
393
|
"""
|
|
361
394
|
|
|
@@ -365,7 +398,7 @@ class TransferClient(BaseClient):
|
|
|
365
398
|
"""
|
|
366
399
|
Deletes a user's Secure Shell (SSH) public key.
|
|
367
400
|
|
|
368
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
401
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_ssh_public_key.html)
|
|
369
402
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_ssh_public_key)
|
|
370
403
|
"""
|
|
371
404
|
|
|
@@ -376,17 +409,38 @@ class TransferClient(BaseClient):
|
|
|
376
409
|
Deletes the user belonging to a file transfer protocol-enabled server you
|
|
377
410
|
specify.
|
|
378
411
|
|
|
379
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
412
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_user.html)
|
|
380
413
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_user)
|
|
381
414
|
"""
|
|
382
415
|
|
|
416
|
+
def delete_web_app(
|
|
417
|
+
self, **kwargs: Unpack[DeleteWebAppRequestRequestTypeDef]
|
|
418
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
419
|
+
"""
|
|
420
|
+
Deletes the specified web app.
|
|
421
|
+
|
|
422
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_web_app.html)
|
|
423
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_web_app)
|
|
424
|
+
"""
|
|
425
|
+
|
|
426
|
+
def delete_web_app_customization(
|
|
427
|
+
self, **kwargs: Unpack[DeleteWebAppCustomizationRequestRequestTypeDef]
|
|
428
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
429
|
+
"""
|
|
430
|
+
Deletes the <code>WebAppCustomization</code> object that corresponds to the web
|
|
431
|
+
app ID specified.
|
|
432
|
+
|
|
433
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_web_app_customization.html)
|
|
434
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_web_app_customization)
|
|
435
|
+
"""
|
|
436
|
+
|
|
383
437
|
def delete_workflow(
|
|
384
438
|
self, **kwargs: Unpack[DeleteWorkflowRequestRequestTypeDef]
|
|
385
439
|
) -> EmptyResponseMetadataTypeDef:
|
|
386
440
|
"""
|
|
387
441
|
Deletes the specified workflow.
|
|
388
442
|
|
|
389
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
443
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_workflow.html)
|
|
390
444
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_workflow)
|
|
391
445
|
"""
|
|
392
446
|
|
|
@@ -395,10 +449,10 @@ class TransferClient(BaseClient):
|
|
|
395
449
|
) -> DescribeAccessResponseTypeDef:
|
|
396
450
|
"""
|
|
397
451
|
Describes the access that is assigned to the specific file transfer
|
|
398
|
-
protocol-enabled server, as identified by its
|
|
399
|
-
|
|
452
|
+
protocol-enabled server, as identified by its <code>ServerId</code> property
|
|
453
|
+
and its <code>ExternalId</code>.
|
|
400
454
|
|
|
401
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
455
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_access.html)
|
|
402
456
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_access)
|
|
403
457
|
"""
|
|
404
458
|
|
|
@@ -406,9 +460,9 @@ class TransferClient(BaseClient):
|
|
|
406
460
|
self, **kwargs: Unpack[DescribeAgreementRequestRequestTypeDef]
|
|
407
461
|
) -> DescribeAgreementResponseTypeDef:
|
|
408
462
|
"""
|
|
409
|
-
Describes the agreement that's identified by the
|
|
463
|
+
Describes the agreement that's identified by the <code>AgreementId</code>.
|
|
410
464
|
|
|
411
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
465
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_agreement.html)
|
|
412
466
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_agreement)
|
|
413
467
|
"""
|
|
414
468
|
|
|
@@ -416,9 +470,9 @@ class TransferClient(BaseClient):
|
|
|
416
470
|
self, **kwargs: Unpack[DescribeCertificateRequestRequestTypeDef]
|
|
417
471
|
) -> DescribeCertificateResponseTypeDef:
|
|
418
472
|
"""
|
|
419
|
-
Describes the certificate that's identified by the
|
|
473
|
+
Describes the certificate that's identified by the <code>CertificateId</code>.
|
|
420
474
|
|
|
421
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
475
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_certificate.html)
|
|
422
476
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_certificate)
|
|
423
477
|
"""
|
|
424
478
|
|
|
@@ -426,11 +480,9 @@ class TransferClient(BaseClient):
|
|
|
426
480
|
self, **kwargs: Unpack[DescribeConnectorRequestRequestTypeDef]
|
|
427
481
|
) -> DescribeConnectorResponseTypeDef:
|
|
428
482
|
"""
|
|
429
|
-
Describes the connector that's identified by the
|
|
430
|
-
API
|
|
431
|
-
Documentation](https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeConnector).
|
|
483
|
+
Describes the connector that's identified by the <code>ConnectorId.</code>.
|
|
432
484
|
|
|
433
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
485
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_connector.html)
|
|
434
486
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_connector)
|
|
435
487
|
"""
|
|
436
488
|
|
|
@@ -438,11 +490,10 @@ class TransferClient(BaseClient):
|
|
|
438
490
|
self, **kwargs: Unpack[DescribeExecutionRequestRequestTypeDef]
|
|
439
491
|
) -> DescribeExecutionResponseTypeDef:
|
|
440
492
|
"""
|
|
441
|
-
You can use
|
|
442
|
-
specified
|
|
443
|
-
workflow.
|
|
493
|
+
You can use <code>DescribeExecution</code> to check the details of the
|
|
494
|
+
execution of the specified workflow.
|
|
444
495
|
|
|
445
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
496
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_execution.html)
|
|
446
497
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_execution)
|
|
447
498
|
"""
|
|
448
499
|
|
|
@@ -450,10 +501,10 @@ class TransferClient(BaseClient):
|
|
|
450
501
|
self, **kwargs: Unpack[DescribeHostKeyRequestRequestTypeDef]
|
|
451
502
|
) -> DescribeHostKeyResponseTypeDef:
|
|
452
503
|
"""
|
|
453
|
-
Returns the details of the host key that's specified by the
|
|
454
|
-
|
|
504
|
+
Returns the details of the host key that's specified by the
|
|
505
|
+
<code>HostKeyId</code> and <code>ServerId</code>.
|
|
455
506
|
|
|
456
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
507
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_host_key.html)
|
|
457
508
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_host_key)
|
|
458
509
|
"""
|
|
459
510
|
|
|
@@ -461,9 +512,10 @@ class TransferClient(BaseClient):
|
|
|
461
512
|
self, **kwargs: Unpack[DescribeProfileRequestRequestTypeDef]
|
|
462
513
|
) -> DescribeProfileResponseTypeDef:
|
|
463
514
|
"""
|
|
464
|
-
Returns the details of the profile that's specified by the
|
|
515
|
+
Returns the details of the profile that's specified by the
|
|
516
|
+
<code>ProfileId</code>.
|
|
465
517
|
|
|
466
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
518
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_profile.html)
|
|
467
519
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_profile)
|
|
468
520
|
"""
|
|
469
521
|
|
|
@@ -473,7 +525,7 @@ class TransferClient(BaseClient):
|
|
|
473
525
|
"""
|
|
474
526
|
Describes the security policy that is attached to your server or SFTP connector.
|
|
475
527
|
|
|
476
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
528
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_security_policy.html)
|
|
477
529
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_security_policy)
|
|
478
530
|
"""
|
|
479
531
|
|
|
@@ -482,10 +534,9 @@ class TransferClient(BaseClient):
|
|
|
482
534
|
) -> DescribeServerResponseTypeDef:
|
|
483
535
|
"""
|
|
484
536
|
Describes a file transfer protocol-enabled server that you specify by passing
|
|
485
|
-
the
|
|
486
|
-
parameter.
|
|
537
|
+
the <code>ServerId</code> parameter.
|
|
487
538
|
|
|
488
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
539
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_server.html)
|
|
489
540
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_server)
|
|
490
541
|
"""
|
|
491
542
|
|
|
@@ -494,46 +545,51 @@ class TransferClient(BaseClient):
|
|
|
494
545
|
) -> DescribeUserResponseTypeDef:
|
|
495
546
|
"""
|
|
496
547
|
Describes the user assigned to the specific file transfer protocol-enabled
|
|
497
|
-
server, as identified by its
|
|
498
|
-
property.
|
|
548
|
+
server, as identified by its <code>ServerId</code> property.
|
|
499
549
|
|
|
500
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
550
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_user.html)
|
|
501
551
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_user)
|
|
502
552
|
"""
|
|
503
553
|
|
|
554
|
+
def describe_web_app(
|
|
555
|
+
self, **kwargs: Unpack[DescribeWebAppRequestRequestTypeDef]
|
|
556
|
+
) -> DescribeWebAppResponseTypeDef:
|
|
557
|
+
"""
|
|
558
|
+
Describes the web app that's identified by <code>WebAppId</code>.
|
|
559
|
+
|
|
560
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_web_app.html)
|
|
561
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_web_app)
|
|
562
|
+
"""
|
|
563
|
+
|
|
564
|
+
def describe_web_app_customization(
|
|
565
|
+
self, **kwargs: Unpack[DescribeWebAppCustomizationRequestRequestTypeDef]
|
|
566
|
+
) -> DescribeWebAppCustomizationResponseTypeDef:
|
|
567
|
+
"""
|
|
568
|
+
Describes the web app customization object that's identified by
|
|
569
|
+
<code>WebAppId</code>.
|
|
570
|
+
|
|
571
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_web_app_customization.html)
|
|
572
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_web_app_customization)
|
|
573
|
+
"""
|
|
574
|
+
|
|
504
575
|
def describe_workflow(
|
|
505
576
|
self, **kwargs: Unpack[DescribeWorkflowRequestRequestTypeDef]
|
|
506
577
|
) -> DescribeWorkflowResponseTypeDef:
|
|
507
578
|
"""
|
|
508
579
|
Describes the specified workflow.
|
|
509
580
|
|
|
510
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
581
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_workflow.html)
|
|
511
582
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_workflow)
|
|
512
583
|
"""
|
|
513
584
|
|
|
514
|
-
def generate_presigned_url(
|
|
515
|
-
self,
|
|
516
|
-
ClientMethod: str,
|
|
517
|
-
Params: Mapping[str, Any] = ...,
|
|
518
|
-
ExpiresIn: int = 3600,
|
|
519
|
-
HttpMethod: str = ...,
|
|
520
|
-
) -> str:
|
|
521
|
-
"""
|
|
522
|
-
Generate a presigned url given a client, its method, and arguments.
|
|
523
|
-
|
|
524
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.generate_presigned_url)
|
|
525
|
-
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#generate_presigned_url)
|
|
526
|
-
"""
|
|
527
|
-
|
|
528
585
|
def import_certificate(
|
|
529
586
|
self, **kwargs: Unpack[ImportCertificateRequestRequestTypeDef]
|
|
530
587
|
) -> ImportCertificateResponseTypeDef:
|
|
531
588
|
"""
|
|
532
589
|
Imports the signing and encryption certificates that you need to create local
|
|
533
|
-
(AS2) profiles and partner
|
|
534
|
-
profiles.
|
|
590
|
+
(AS2) profiles and partner profiles.
|
|
535
591
|
|
|
536
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
592
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/import_certificate.html)
|
|
537
593
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#import_certificate)
|
|
538
594
|
"""
|
|
539
595
|
|
|
@@ -541,9 +597,10 @@ class TransferClient(BaseClient):
|
|
|
541
597
|
self, **kwargs: Unpack[ImportHostKeyRequestRequestTypeDef]
|
|
542
598
|
) -> ImportHostKeyResponseTypeDef:
|
|
543
599
|
"""
|
|
544
|
-
Adds a host key to the server that's specified by the
|
|
600
|
+
Adds a host key to the server that's specified by the <code>ServerId</code>
|
|
601
|
+
parameter.
|
|
545
602
|
|
|
546
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
603
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/import_host_key.html)
|
|
547
604
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#import_host_key)
|
|
548
605
|
"""
|
|
549
606
|
|
|
@@ -552,11 +609,10 @@ class TransferClient(BaseClient):
|
|
|
552
609
|
) -> ImportSshPublicKeyResponseTypeDef:
|
|
553
610
|
"""
|
|
554
611
|
Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a
|
|
555
|
-
|
|
556
|
-
server, identified by
|
|
557
|
-
`ServerId`.
|
|
612
|
+
<code>UserName</code> value assigned to the specific file transfer
|
|
613
|
+
protocol-enabled server, identified by <code>ServerId</code>.
|
|
558
614
|
|
|
559
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
615
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/import_ssh_public_key.html)
|
|
560
616
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#import_ssh_public_key)
|
|
561
617
|
"""
|
|
562
618
|
|
|
@@ -566,7 +622,7 @@ class TransferClient(BaseClient):
|
|
|
566
622
|
"""
|
|
567
623
|
Lists the details for all the accesses you have on your server.
|
|
568
624
|
|
|
569
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
625
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_accesses.html)
|
|
570
626
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_accesses)
|
|
571
627
|
"""
|
|
572
628
|
|
|
@@ -575,10 +631,9 @@ class TransferClient(BaseClient):
|
|
|
575
631
|
) -> ListAgreementsResponseTypeDef:
|
|
576
632
|
"""
|
|
577
633
|
Returns a list of the agreements for the server that's identified by the
|
|
578
|
-
|
|
579
|
-
supply.
|
|
634
|
+
<code>ServerId</code> that you supply.
|
|
580
635
|
|
|
581
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
636
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_agreements.html)
|
|
582
637
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_agreements)
|
|
583
638
|
"""
|
|
584
639
|
|
|
@@ -587,10 +642,9 @@ class TransferClient(BaseClient):
|
|
|
587
642
|
) -> ListCertificatesResponseTypeDef:
|
|
588
643
|
"""
|
|
589
644
|
Returns a list of the current certificates that have been imported into
|
|
590
|
-
Transfer
|
|
591
|
-
Family.
|
|
645
|
+
Transfer Family.
|
|
592
646
|
|
|
593
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
647
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_certificates.html)
|
|
594
648
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_certificates)
|
|
595
649
|
"""
|
|
596
650
|
|
|
@@ -600,7 +654,7 @@ class TransferClient(BaseClient):
|
|
|
600
654
|
"""
|
|
601
655
|
Lists the connectors for the specified Region.
|
|
602
656
|
|
|
603
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
657
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_connectors.html)
|
|
604
658
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_connectors)
|
|
605
659
|
"""
|
|
606
660
|
|
|
@@ -610,7 +664,7 @@ class TransferClient(BaseClient):
|
|
|
610
664
|
"""
|
|
611
665
|
Lists all in-progress executions for the specified workflow.
|
|
612
666
|
|
|
613
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
667
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_executions.html)
|
|
614
668
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_executions)
|
|
615
669
|
"""
|
|
616
670
|
|
|
@@ -619,10 +673,9 @@ class TransferClient(BaseClient):
|
|
|
619
673
|
) -> ListFileTransferResultsResponseTypeDef:
|
|
620
674
|
"""
|
|
621
675
|
Returns real-time updates and detailed information on the status of each
|
|
622
|
-
individual file being transferred in a specific file transfer
|
|
623
|
-
operation.
|
|
676
|
+
individual file being transferred in a specific file transfer operation.
|
|
624
677
|
|
|
625
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
678
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_file_transfer_results.html)
|
|
626
679
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_file_transfer_results)
|
|
627
680
|
"""
|
|
628
681
|
|
|
@@ -630,10 +683,10 @@ class TransferClient(BaseClient):
|
|
|
630
683
|
self, **kwargs: Unpack[ListHostKeysRequestRequestTypeDef]
|
|
631
684
|
) -> ListHostKeysResponseTypeDef:
|
|
632
685
|
"""
|
|
633
|
-
Returns a list of host keys for the server that's specified by the
|
|
634
|
-
parameter.
|
|
686
|
+
Returns a list of host keys for the server that's specified by the
|
|
687
|
+
<code>ServerId</code> parameter.
|
|
635
688
|
|
|
636
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
689
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_host_keys.html)
|
|
637
690
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_host_keys)
|
|
638
691
|
"""
|
|
639
692
|
|
|
@@ -643,7 +696,7 @@ class TransferClient(BaseClient):
|
|
|
643
696
|
"""
|
|
644
697
|
Returns a list of the profiles for your system.
|
|
645
698
|
|
|
646
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
699
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_profiles.html)
|
|
647
700
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_profiles)
|
|
648
701
|
"""
|
|
649
702
|
|
|
@@ -654,7 +707,7 @@ class TransferClient(BaseClient):
|
|
|
654
707
|
Lists the security policies that are attached to your servers and SFTP
|
|
655
708
|
connectors.
|
|
656
709
|
|
|
657
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
710
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_security_policies.html)
|
|
658
711
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_security_policies)
|
|
659
712
|
"""
|
|
660
713
|
|
|
@@ -663,10 +716,9 @@ class TransferClient(BaseClient):
|
|
|
663
716
|
) -> ListServersResponseTypeDef:
|
|
664
717
|
"""
|
|
665
718
|
Lists the file transfer protocol-enabled servers that are associated with your
|
|
666
|
-
Amazon Web Services
|
|
667
|
-
account.
|
|
719
|
+
Amazon Web Services account.
|
|
668
720
|
|
|
669
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
721
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_servers.html)
|
|
670
722
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_servers)
|
|
671
723
|
"""
|
|
672
724
|
|
|
@@ -677,7 +729,7 @@ class TransferClient(BaseClient):
|
|
|
677
729
|
Lists all of the tags associated with the Amazon Resource Name (ARN) that you
|
|
678
730
|
specify.
|
|
679
731
|
|
|
680
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
732
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_tags_for_resource.html)
|
|
681
733
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_tags_for_resource)
|
|
682
734
|
"""
|
|
683
735
|
|
|
@@ -686,22 +738,31 @@ class TransferClient(BaseClient):
|
|
|
686
738
|
) -> ListUsersResponseTypeDef:
|
|
687
739
|
"""
|
|
688
740
|
Lists the users for a file transfer protocol-enabled server that you specify by
|
|
689
|
-
passing the
|
|
690
|
-
parameter.
|
|
741
|
+
passing the <code>ServerId</code> parameter.
|
|
691
742
|
|
|
692
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
743
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_users.html)
|
|
693
744
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_users)
|
|
694
745
|
"""
|
|
695
746
|
|
|
747
|
+
def list_web_apps(
|
|
748
|
+
self, **kwargs: Unpack[ListWebAppsRequestRequestTypeDef]
|
|
749
|
+
) -> ListWebAppsResponseTypeDef:
|
|
750
|
+
"""
|
|
751
|
+
Lists all web apps associated with your Amazon Web Services account for your
|
|
752
|
+
current region.
|
|
753
|
+
|
|
754
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_web_apps.html)
|
|
755
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_web_apps)
|
|
756
|
+
"""
|
|
757
|
+
|
|
696
758
|
def list_workflows(
|
|
697
759
|
self, **kwargs: Unpack[ListWorkflowsRequestRequestTypeDef]
|
|
698
760
|
) -> ListWorkflowsResponseTypeDef:
|
|
699
761
|
"""
|
|
700
762
|
Lists all workflows associated with your Amazon Web Services account for your
|
|
701
|
-
current
|
|
702
|
-
region.
|
|
763
|
+
current region.
|
|
703
764
|
|
|
704
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
765
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_workflows.html)
|
|
705
766
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_workflows)
|
|
706
767
|
"""
|
|
707
768
|
|
|
@@ -711,7 +772,7 @@ class TransferClient(BaseClient):
|
|
|
711
772
|
"""
|
|
712
773
|
Sends a callback for asynchronous custom steps.
|
|
713
774
|
|
|
714
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
775
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/send_workflow_step_state.html)
|
|
715
776
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#send_workflow_step_state)
|
|
716
777
|
"""
|
|
717
778
|
|
|
@@ -721,7 +782,7 @@ class TransferClient(BaseClient):
|
|
|
721
782
|
"""
|
|
722
783
|
Retrieves a list of the contents of a directory from a remote SFTP server.
|
|
723
784
|
|
|
724
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
785
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/start_directory_listing.html)
|
|
725
786
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#start_directory_listing)
|
|
726
787
|
"""
|
|
727
788
|
|
|
@@ -730,10 +791,9 @@ class TransferClient(BaseClient):
|
|
|
730
791
|
) -> StartFileTransferResponseTypeDef:
|
|
731
792
|
"""
|
|
732
793
|
Begins a file transfer between local Amazon Web Services storage and a remote
|
|
733
|
-
AS2 or SFTP
|
|
734
|
-
server.
|
|
794
|
+
AS2 or SFTP server.
|
|
735
795
|
|
|
736
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
796
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/start_file_transfer.html)
|
|
737
797
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#start_file_transfer)
|
|
738
798
|
"""
|
|
739
799
|
|
|
@@ -741,10 +801,10 @@ class TransferClient(BaseClient):
|
|
|
741
801
|
self, **kwargs: Unpack[StartServerRequestRequestTypeDef]
|
|
742
802
|
) -> EmptyResponseMetadataTypeDef:
|
|
743
803
|
"""
|
|
744
|
-
Changes the state of a file transfer protocol-enabled server from
|
|
745
|
-
|
|
804
|
+
Changes the state of a file transfer protocol-enabled server from
|
|
805
|
+
<code>OFFLINE</code> to <code>ONLINE</code>.
|
|
746
806
|
|
|
747
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
807
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/start_server.html)
|
|
748
808
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#start_server)
|
|
749
809
|
"""
|
|
750
810
|
|
|
@@ -752,10 +812,10 @@ class TransferClient(BaseClient):
|
|
|
752
812
|
self, **kwargs: Unpack[StopServerRequestRequestTypeDef]
|
|
753
813
|
) -> EmptyResponseMetadataTypeDef:
|
|
754
814
|
"""
|
|
755
|
-
Changes the state of a file transfer protocol-enabled server from
|
|
756
|
-
|
|
815
|
+
Changes the state of a file transfer protocol-enabled server from
|
|
816
|
+
<code>ONLINE</code> to <code>OFFLINE</code>.
|
|
757
817
|
|
|
758
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
818
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/stop_server.html)
|
|
759
819
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#stop_server)
|
|
760
820
|
"""
|
|
761
821
|
|
|
@@ -764,10 +824,9 @@ class TransferClient(BaseClient):
|
|
|
764
824
|
) -> EmptyResponseMetadataTypeDef:
|
|
765
825
|
"""
|
|
766
826
|
Attaches a key-value pair to a resource, as identified by its Amazon Resource
|
|
767
|
-
Name
|
|
768
|
-
(ARN).
|
|
827
|
+
Name (ARN).
|
|
769
828
|
|
|
770
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
829
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/tag_resource.html)
|
|
771
830
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#tag_resource)
|
|
772
831
|
"""
|
|
773
832
|
|
|
@@ -777,7 +836,7 @@ class TransferClient(BaseClient):
|
|
|
777
836
|
"""
|
|
778
837
|
Tests whether your SFTP connector is set up successfully.
|
|
779
838
|
|
|
780
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
839
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/test_connection.html)
|
|
781
840
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#test_connection)
|
|
782
841
|
"""
|
|
783
842
|
|
|
@@ -785,12 +844,11 @@ class TransferClient(BaseClient):
|
|
|
785
844
|
self, **kwargs: Unpack[TestIdentityProviderRequestRequestTypeDef]
|
|
786
845
|
) -> TestIdentityProviderResponseTypeDef:
|
|
787
846
|
"""
|
|
788
|
-
If the
|
|
789
|
-
|
|
790
|
-
is set up
|
|
791
|
-
successfully.
|
|
847
|
+
If the <code>IdentityProviderType</code> of a file transfer protocol-enabled
|
|
848
|
+
server is <code>AWS_DIRECTORY_SERVICE</code> or <code>API_Gateway</code>, tests
|
|
849
|
+
whether your identity provider is set up successfully.
|
|
792
850
|
|
|
793
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
851
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/test_identity_provider.html)
|
|
794
852
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#test_identity_provider)
|
|
795
853
|
"""
|
|
796
854
|
|
|
@@ -799,10 +857,9 @@ class TransferClient(BaseClient):
|
|
|
799
857
|
) -> EmptyResponseMetadataTypeDef:
|
|
800
858
|
"""
|
|
801
859
|
Detaches a key-value pair from a resource, as identified by its Amazon Resource
|
|
802
|
-
Name
|
|
803
|
-
(ARN).
|
|
860
|
+
Name (ARN).
|
|
804
861
|
|
|
805
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
862
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/untag_resource.html)
|
|
806
863
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#untag_resource)
|
|
807
864
|
"""
|
|
808
865
|
|
|
@@ -810,11 +867,10 @@ class TransferClient(BaseClient):
|
|
|
810
867
|
self, **kwargs: Unpack[UpdateAccessRequestRequestTypeDef]
|
|
811
868
|
) -> UpdateAccessResponseTypeDef:
|
|
812
869
|
"""
|
|
813
|
-
Allows you to update parameters for the access specified in the
|
|
814
|
-
|
|
815
|
-
parameters.
|
|
870
|
+
Allows you to update parameters for the access specified in the
|
|
871
|
+
<code>ServerID</code> and <code>ExternalID</code> parameters.
|
|
816
872
|
|
|
817
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
873
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_access.html)
|
|
818
874
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_access)
|
|
819
875
|
"""
|
|
820
876
|
|
|
@@ -824,7 +880,7 @@ class TransferClient(BaseClient):
|
|
|
824
880
|
"""
|
|
825
881
|
Updates some of the parameters for an existing agreement.
|
|
826
882
|
|
|
827
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
883
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_agreement.html)
|
|
828
884
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_agreement)
|
|
829
885
|
"""
|
|
830
886
|
|
|
@@ -834,7 +890,7 @@ class TransferClient(BaseClient):
|
|
|
834
890
|
"""
|
|
835
891
|
Updates the active and inactive dates for a certificate.
|
|
836
892
|
|
|
837
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
893
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_certificate.html)
|
|
838
894
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_certificate)
|
|
839
895
|
"""
|
|
840
896
|
|
|
@@ -844,7 +900,7 @@ class TransferClient(BaseClient):
|
|
|
844
900
|
"""
|
|
845
901
|
Updates some of the parameters for an existing connector.
|
|
846
902
|
|
|
847
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
903
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_connector.html)
|
|
848
904
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_connector)
|
|
849
905
|
"""
|
|
850
906
|
|
|
@@ -852,11 +908,10 @@ class TransferClient(BaseClient):
|
|
|
852
908
|
self, **kwargs: Unpack[UpdateHostKeyRequestRequestTypeDef]
|
|
853
909
|
) -> UpdateHostKeyResponseTypeDef:
|
|
854
910
|
"""
|
|
855
|
-
Updates the description for the host key that's specified by the
|
|
856
|
-
|
|
857
|
-
parameters.
|
|
911
|
+
Updates the description for the host key that's specified by the
|
|
912
|
+
<code>ServerId</code> and <code>HostKeyId</code> parameters.
|
|
858
913
|
|
|
859
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
914
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_host_key.html)
|
|
860
915
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_host_key)
|
|
861
916
|
"""
|
|
862
917
|
|
|
@@ -866,7 +921,7 @@ class TransferClient(BaseClient):
|
|
|
866
921
|
"""
|
|
867
922
|
Updates some of the parameters for an existing profile.
|
|
868
923
|
|
|
869
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
924
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_profile.html)
|
|
870
925
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_profile)
|
|
871
926
|
"""
|
|
872
927
|
|
|
@@ -875,10 +930,9 @@ class TransferClient(BaseClient):
|
|
|
875
930
|
) -> UpdateServerResponseTypeDef:
|
|
876
931
|
"""
|
|
877
932
|
Updates the file transfer protocol-enabled server's properties after that
|
|
878
|
-
server has been
|
|
879
|
-
created.
|
|
933
|
+
server has been created.
|
|
880
934
|
|
|
881
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
935
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_server.html)
|
|
882
936
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_server)
|
|
883
937
|
"""
|
|
884
938
|
|
|
@@ -888,21 +942,45 @@ class TransferClient(BaseClient):
|
|
|
888
942
|
"""
|
|
889
943
|
Assigns new properties to a user.
|
|
890
944
|
|
|
891
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html
|
|
945
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_user.html)
|
|
892
946
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_user)
|
|
893
947
|
"""
|
|
894
948
|
|
|
949
|
+
def update_web_app(
|
|
950
|
+
self, **kwargs: Unpack[UpdateWebAppRequestRequestTypeDef]
|
|
951
|
+
) -> UpdateWebAppResponseTypeDef:
|
|
952
|
+
"""
|
|
953
|
+
Assigns new properties to a web app.
|
|
954
|
+
|
|
955
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_web_app.html)
|
|
956
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_web_app)
|
|
957
|
+
"""
|
|
958
|
+
|
|
959
|
+
def update_web_app_customization(
|
|
960
|
+
self, **kwargs: Unpack[UpdateWebAppCustomizationRequestRequestTypeDef]
|
|
961
|
+
) -> UpdateWebAppCustomizationResponseTypeDef:
|
|
962
|
+
"""
|
|
963
|
+
Assigns new customization properties to a web app.
|
|
964
|
+
|
|
965
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_web_app_customization.html)
|
|
966
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_web_app_customization)
|
|
967
|
+
"""
|
|
968
|
+
|
|
895
969
|
@overload
|
|
896
970
|
def get_paginator(self, operation_name: Literal["list_accesses"]) -> ListAccessesPaginator:
|
|
897
971
|
"""
|
|
898
|
-
|
|
972
|
+
Create a paginator for an operation.
|
|
973
|
+
|
|
974
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
|
|
899
975
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
|
|
900
976
|
"""
|
|
901
977
|
|
|
902
978
|
@overload
|
|
903
979
|
def get_paginator(self, operation_name: Literal["list_agreements"]) -> ListAgreementsPaginator:
|
|
904
980
|
"""
|
|
905
|
-
|
|
981
|
+
Create a paginator for an operation.
|
|
982
|
+
|
|
983
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
|
|
906
984
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
|
|
907
985
|
"""
|
|
908
986
|
|
|
@@ -911,21 +989,27 @@ class TransferClient(BaseClient):
|
|
|
911
989
|
self, operation_name: Literal["list_certificates"]
|
|
912
990
|
) -> ListCertificatesPaginator:
|
|
913
991
|
"""
|
|
914
|
-
|
|
992
|
+
Create a paginator for an operation.
|
|
993
|
+
|
|
994
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
|
|
915
995
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
|
|
916
996
|
"""
|
|
917
997
|
|
|
918
998
|
@overload
|
|
919
999
|
def get_paginator(self, operation_name: Literal["list_connectors"]) -> ListConnectorsPaginator:
|
|
920
1000
|
"""
|
|
921
|
-
|
|
1001
|
+
Create a paginator for an operation.
|
|
1002
|
+
|
|
1003
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
|
|
922
1004
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
|
|
923
1005
|
"""
|
|
924
1006
|
|
|
925
1007
|
@overload
|
|
926
1008
|
def get_paginator(self, operation_name: Literal["list_executions"]) -> ListExecutionsPaginator:
|
|
927
1009
|
"""
|
|
928
|
-
|
|
1010
|
+
Create a paginator for an operation.
|
|
1011
|
+
|
|
1012
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
|
|
929
1013
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
|
|
930
1014
|
"""
|
|
931
1015
|
|
|
@@ -934,14 +1018,18 @@ class TransferClient(BaseClient):
|
|
|
934
1018
|
self, operation_name: Literal["list_file_transfer_results"]
|
|
935
1019
|
) -> ListFileTransferResultsPaginator:
|
|
936
1020
|
"""
|
|
937
|
-
|
|
1021
|
+
Create a paginator for an operation.
|
|
1022
|
+
|
|
1023
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
|
|
938
1024
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
|
|
939
1025
|
"""
|
|
940
1026
|
|
|
941
1027
|
@overload
|
|
942
1028
|
def get_paginator(self, operation_name: Literal["list_profiles"]) -> ListProfilesPaginator:
|
|
943
1029
|
"""
|
|
944
|
-
|
|
1030
|
+
Create a paginator for an operation.
|
|
1031
|
+
|
|
1032
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
|
|
945
1033
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
|
|
946
1034
|
"""
|
|
947
1035
|
|
|
@@ -950,14 +1038,18 @@ class TransferClient(BaseClient):
|
|
|
950
1038
|
self, operation_name: Literal["list_security_policies"]
|
|
951
1039
|
) -> ListSecurityPoliciesPaginator:
|
|
952
1040
|
"""
|
|
953
|
-
|
|
1041
|
+
Create a paginator for an operation.
|
|
1042
|
+
|
|
1043
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
|
|
954
1044
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
|
|
955
1045
|
"""
|
|
956
1046
|
|
|
957
1047
|
@overload
|
|
958
1048
|
def get_paginator(self, operation_name: Literal["list_servers"]) -> ListServersPaginator:
|
|
959
1049
|
"""
|
|
960
|
-
|
|
1050
|
+
Create a paginator for an operation.
|
|
1051
|
+
|
|
1052
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
|
|
961
1053
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
|
|
962
1054
|
"""
|
|
963
1055
|
|
|
@@ -966,34 +1058,53 @@ class TransferClient(BaseClient):
|
|
|
966
1058
|
self, operation_name: Literal["list_tags_for_resource"]
|
|
967
1059
|
) -> ListTagsForResourcePaginator:
|
|
968
1060
|
"""
|
|
969
|
-
|
|
1061
|
+
Create a paginator for an operation.
|
|
1062
|
+
|
|
1063
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
|
|
970
1064
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
|
|
971
1065
|
"""
|
|
972
1066
|
|
|
973
1067
|
@overload
|
|
974
1068
|
def get_paginator(self, operation_name: Literal["list_users"]) -> ListUsersPaginator:
|
|
975
1069
|
"""
|
|
976
|
-
|
|
1070
|
+
Create a paginator for an operation.
|
|
1071
|
+
|
|
1072
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
|
|
1073
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
|
|
1074
|
+
"""
|
|
1075
|
+
|
|
1076
|
+
@overload
|
|
1077
|
+
def get_paginator(self, operation_name: Literal["list_web_apps"]) -> ListWebAppsPaginator:
|
|
1078
|
+
"""
|
|
1079
|
+
Create a paginator for an operation.
|
|
1080
|
+
|
|
1081
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
|
|
977
1082
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
|
|
978
1083
|
"""
|
|
979
1084
|
|
|
980
1085
|
@overload
|
|
981
1086
|
def get_paginator(self, operation_name: Literal["list_workflows"]) -> ListWorkflowsPaginator:
|
|
982
1087
|
"""
|
|
983
|
-
|
|
1088
|
+
Create a paginator for an operation.
|
|
1089
|
+
|
|
1090
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
|
|
984
1091
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
|
|
985
1092
|
"""
|
|
986
1093
|
|
|
987
1094
|
@overload
|
|
988
1095
|
def get_waiter(self, waiter_name: Literal["server_offline"]) -> ServerOfflineWaiter:
|
|
989
1096
|
"""
|
|
990
|
-
|
|
1097
|
+
Returns an object that can wait for some condition.
|
|
1098
|
+
|
|
1099
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_waiter.html)
|
|
991
1100
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_waiter)
|
|
992
1101
|
"""
|
|
993
1102
|
|
|
994
1103
|
@overload
|
|
995
1104
|
def get_waiter(self, waiter_name: Literal["server_online"]) -> ServerOnlineWaiter:
|
|
996
1105
|
"""
|
|
997
|
-
|
|
1106
|
+
Returns an object that can wait for some condition.
|
|
1107
|
+
|
|
1108
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_waiter.html)
|
|
998
1109
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_waiter)
|
|
999
1110
|
"""
|