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