mypy-boto3-transfer 1.36.6__py3-none-any.whl → 1.37.24__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.
@@ -3,6 +3,8 @@ Type annotations for transfer service Client.
3
3
 
4
4
  [Documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/)
5
5
 
6
+ Copyright 2025 Vlad Emelianov
7
+
6
8
  Usage::
7
9
 
8
10
  ```python
@@ -12,8 +14,6 @@ Usage::
12
14
  session = Session()
13
15
  client: TransferClient = session.client("transfer")
14
16
  ```
15
-
16
- Copyright 2025 Vlad Emelianov
17
17
  """
18
18
 
19
19
  from __future__ import annotations
@@ -41,127 +41,127 @@ from .paginator import (
41
41
  ListWorkflowsPaginator,
42
42
  )
43
43
  from .type_defs import (
44
- CreateAccessRequestRequestTypeDef,
44
+ CreateAccessRequestTypeDef,
45
45
  CreateAccessResponseTypeDef,
46
- CreateAgreementRequestRequestTypeDef,
46
+ CreateAgreementRequestTypeDef,
47
47
  CreateAgreementResponseTypeDef,
48
- CreateConnectorRequestRequestTypeDef,
48
+ CreateConnectorRequestTypeDef,
49
49
  CreateConnectorResponseTypeDef,
50
- CreateProfileRequestRequestTypeDef,
50
+ CreateProfileRequestTypeDef,
51
51
  CreateProfileResponseTypeDef,
52
- CreateServerRequestRequestTypeDef,
52
+ CreateServerRequestTypeDef,
53
53
  CreateServerResponseTypeDef,
54
- CreateUserRequestRequestTypeDef,
54
+ CreateUserRequestTypeDef,
55
55
  CreateUserResponseTypeDef,
56
- CreateWebAppRequestRequestTypeDef,
56
+ CreateWebAppRequestTypeDef,
57
57
  CreateWebAppResponseTypeDef,
58
- CreateWorkflowRequestRequestTypeDef,
58
+ CreateWorkflowRequestTypeDef,
59
59
  CreateWorkflowResponseTypeDef,
60
- DeleteAccessRequestRequestTypeDef,
61
- DeleteAgreementRequestRequestTypeDef,
62
- DeleteCertificateRequestRequestTypeDef,
63
- DeleteConnectorRequestRequestTypeDef,
64
- DeleteHostKeyRequestRequestTypeDef,
65
- DeleteProfileRequestRequestTypeDef,
66
- DeleteServerRequestRequestTypeDef,
67
- DeleteSshPublicKeyRequestRequestTypeDef,
68
- DeleteUserRequestRequestTypeDef,
69
- DeleteWebAppCustomizationRequestRequestTypeDef,
70
- DeleteWebAppRequestRequestTypeDef,
71
- DeleteWorkflowRequestRequestTypeDef,
72
- DescribeAccessRequestRequestTypeDef,
60
+ DeleteAccessRequestTypeDef,
61
+ DeleteAgreementRequestTypeDef,
62
+ DeleteCertificateRequestTypeDef,
63
+ DeleteConnectorRequestTypeDef,
64
+ DeleteHostKeyRequestTypeDef,
65
+ DeleteProfileRequestTypeDef,
66
+ DeleteServerRequestTypeDef,
67
+ DeleteSshPublicKeyRequestTypeDef,
68
+ DeleteUserRequestTypeDef,
69
+ DeleteWebAppCustomizationRequestTypeDef,
70
+ DeleteWebAppRequestTypeDef,
71
+ DeleteWorkflowRequestTypeDef,
72
+ DescribeAccessRequestTypeDef,
73
73
  DescribeAccessResponseTypeDef,
74
- DescribeAgreementRequestRequestTypeDef,
74
+ DescribeAgreementRequestTypeDef,
75
75
  DescribeAgreementResponseTypeDef,
76
- DescribeCertificateRequestRequestTypeDef,
76
+ DescribeCertificateRequestTypeDef,
77
77
  DescribeCertificateResponseTypeDef,
78
- DescribeConnectorRequestRequestTypeDef,
78
+ DescribeConnectorRequestTypeDef,
79
79
  DescribeConnectorResponseTypeDef,
80
- DescribeExecutionRequestRequestTypeDef,
80
+ DescribeExecutionRequestTypeDef,
81
81
  DescribeExecutionResponseTypeDef,
82
- DescribeHostKeyRequestRequestTypeDef,
82
+ DescribeHostKeyRequestTypeDef,
83
83
  DescribeHostKeyResponseTypeDef,
84
- DescribeProfileRequestRequestTypeDef,
84
+ DescribeProfileRequestTypeDef,
85
85
  DescribeProfileResponseTypeDef,
86
- DescribeSecurityPolicyRequestRequestTypeDef,
86
+ DescribeSecurityPolicyRequestTypeDef,
87
87
  DescribeSecurityPolicyResponseTypeDef,
88
- DescribeServerRequestRequestTypeDef,
88
+ DescribeServerRequestTypeDef,
89
89
  DescribeServerResponseTypeDef,
90
- DescribeUserRequestRequestTypeDef,
90
+ DescribeUserRequestTypeDef,
91
91
  DescribeUserResponseTypeDef,
92
- DescribeWebAppCustomizationRequestRequestTypeDef,
92
+ DescribeWebAppCustomizationRequestTypeDef,
93
93
  DescribeWebAppCustomizationResponseTypeDef,
94
- DescribeWebAppRequestRequestTypeDef,
94
+ DescribeWebAppRequestTypeDef,
95
95
  DescribeWebAppResponseTypeDef,
96
- DescribeWorkflowRequestRequestTypeDef,
96
+ DescribeWorkflowRequestTypeDef,
97
97
  DescribeWorkflowResponseTypeDef,
98
98
  EmptyResponseMetadataTypeDef,
99
- ImportCertificateRequestRequestTypeDef,
99
+ ImportCertificateRequestTypeDef,
100
100
  ImportCertificateResponseTypeDef,
101
- ImportHostKeyRequestRequestTypeDef,
101
+ ImportHostKeyRequestTypeDef,
102
102
  ImportHostKeyResponseTypeDef,
103
- ImportSshPublicKeyRequestRequestTypeDef,
103
+ ImportSshPublicKeyRequestTypeDef,
104
104
  ImportSshPublicKeyResponseTypeDef,
105
- ListAccessesRequestRequestTypeDef,
105
+ ListAccessesRequestTypeDef,
106
106
  ListAccessesResponseTypeDef,
107
- ListAgreementsRequestRequestTypeDef,
107
+ ListAgreementsRequestTypeDef,
108
108
  ListAgreementsResponseTypeDef,
109
- ListCertificatesRequestRequestTypeDef,
109
+ ListCertificatesRequestTypeDef,
110
110
  ListCertificatesResponseTypeDef,
111
- ListConnectorsRequestRequestTypeDef,
111
+ ListConnectorsRequestTypeDef,
112
112
  ListConnectorsResponseTypeDef,
113
- ListExecutionsRequestRequestTypeDef,
113
+ ListExecutionsRequestTypeDef,
114
114
  ListExecutionsResponseTypeDef,
115
- ListFileTransferResultsRequestRequestTypeDef,
115
+ ListFileTransferResultsRequestTypeDef,
116
116
  ListFileTransferResultsResponseTypeDef,
117
- ListHostKeysRequestRequestTypeDef,
117
+ ListHostKeysRequestTypeDef,
118
118
  ListHostKeysResponseTypeDef,
119
- ListProfilesRequestRequestTypeDef,
119
+ ListProfilesRequestTypeDef,
120
120
  ListProfilesResponseTypeDef,
121
- ListSecurityPoliciesRequestRequestTypeDef,
121
+ ListSecurityPoliciesRequestTypeDef,
122
122
  ListSecurityPoliciesResponseTypeDef,
123
- ListServersRequestRequestTypeDef,
123
+ ListServersRequestTypeDef,
124
124
  ListServersResponseTypeDef,
125
- ListTagsForResourceRequestRequestTypeDef,
125
+ ListTagsForResourceRequestTypeDef,
126
126
  ListTagsForResourceResponseTypeDef,
127
- ListUsersRequestRequestTypeDef,
127
+ ListUsersRequestTypeDef,
128
128
  ListUsersResponseTypeDef,
129
- ListWebAppsRequestRequestTypeDef,
129
+ ListWebAppsRequestTypeDef,
130
130
  ListWebAppsResponseTypeDef,
131
- ListWorkflowsRequestRequestTypeDef,
131
+ ListWorkflowsRequestTypeDef,
132
132
  ListWorkflowsResponseTypeDef,
133
- SendWorkflowStepStateRequestRequestTypeDef,
134
- StartDirectoryListingRequestRequestTypeDef,
133
+ SendWorkflowStepStateRequestTypeDef,
134
+ StartDirectoryListingRequestTypeDef,
135
135
  StartDirectoryListingResponseTypeDef,
136
- StartFileTransferRequestRequestTypeDef,
136
+ StartFileTransferRequestTypeDef,
137
137
  StartFileTransferResponseTypeDef,
138
- StartServerRequestRequestTypeDef,
139
- StopServerRequestRequestTypeDef,
140
- TagResourceRequestRequestTypeDef,
141
- TestConnectionRequestRequestTypeDef,
138
+ StartServerRequestTypeDef,
139
+ StopServerRequestTypeDef,
140
+ TagResourceRequestTypeDef,
141
+ TestConnectionRequestTypeDef,
142
142
  TestConnectionResponseTypeDef,
143
- TestIdentityProviderRequestRequestTypeDef,
143
+ TestIdentityProviderRequestTypeDef,
144
144
  TestIdentityProviderResponseTypeDef,
145
- UntagResourceRequestRequestTypeDef,
146
- UpdateAccessRequestRequestTypeDef,
145
+ UntagResourceRequestTypeDef,
146
+ UpdateAccessRequestTypeDef,
147
147
  UpdateAccessResponseTypeDef,
148
- UpdateAgreementRequestRequestTypeDef,
148
+ UpdateAgreementRequestTypeDef,
149
149
  UpdateAgreementResponseTypeDef,
150
- UpdateCertificateRequestRequestTypeDef,
150
+ UpdateCertificateRequestTypeDef,
151
151
  UpdateCertificateResponseTypeDef,
152
- UpdateConnectorRequestRequestTypeDef,
152
+ UpdateConnectorRequestTypeDef,
153
153
  UpdateConnectorResponseTypeDef,
154
- UpdateHostKeyRequestRequestTypeDef,
154
+ UpdateHostKeyRequestTypeDef,
155
155
  UpdateHostKeyResponseTypeDef,
156
- UpdateProfileRequestRequestTypeDef,
156
+ UpdateProfileRequestTypeDef,
157
157
  UpdateProfileResponseTypeDef,
158
- UpdateServerRequestRequestTypeDef,
158
+ UpdateServerRequestTypeDef,
159
159
  UpdateServerResponseTypeDef,
160
- UpdateUserRequestRequestTypeDef,
160
+ UpdateUserRequestTypeDef,
161
161
  UpdateUserResponseTypeDef,
162
- UpdateWebAppCustomizationRequestRequestTypeDef,
162
+ UpdateWebAppCustomizationRequestTypeDef,
163
163
  UpdateWebAppCustomizationResponseTypeDef,
164
- UpdateWebAppRequestRequestTypeDef,
164
+ UpdateWebAppRequestTypeDef,
165
165
  UpdateWebAppResponseTypeDef,
166
166
  )
167
167
  from .waiter import ServerOfflineWaiter, ServerOnlineWaiter
@@ -227,7 +227,7 @@ class TransferClient(BaseClient):
227
227
  """
228
228
 
229
229
  def create_access(
230
- self, **kwargs: Unpack[CreateAccessRequestRequestTypeDef]
230
+ self, **kwargs: Unpack[CreateAccessRequestTypeDef]
231
231
  ) -> CreateAccessResponseTypeDef:
232
232
  """
233
233
  Used by administrators to choose which groups in the directory should have
@@ -239,7 +239,7 @@ class TransferClient(BaseClient):
239
239
  """
240
240
 
241
241
  def create_agreement(
242
- self, **kwargs: Unpack[CreateAgreementRequestRequestTypeDef]
242
+ self, **kwargs: Unpack[CreateAgreementRequestTypeDef]
243
243
  ) -> CreateAgreementResponseTypeDef:
244
244
  """
245
245
  Creates an agreement.
@@ -249,7 +249,7 @@ class TransferClient(BaseClient):
249
249
  """
250
250
 
251
251
  def create_connector(
252
- self, **kwargs: Unpack[CreateConnectorRequestRequestTypeDef]
252
+ self, **kwargs: Unpack[CreateConnectorRequestTypeDef]
253
253
  ) -> CreateConnectorResponseTypeDef:
254
254
  """
255
255
  Creates the connector, which captures the parameters for a connection for the
@@ -260,7 +260,7 @@ class TransferClient(BaseClient):
260
260
  """
261
261
 
262
262
  def create_profile(
263
- self, **kwargs: Unpack[CreateProfileRequestRequestTypeDef]
263
+ self, **kwargs: Unpack[CreateProfileRequestTypeDef]
264
264
  ) -> CreateProfileResponseTypeDef:
265
265
  """
266
266
  Creates the local or partner profile to use for AS2 transfers.
@@ -270,7 +270,7 @@ class TransferClient(BaseClient):
270
270
  """
271
271
 
272
272
  def create_server(
273
- self, **kwargs: Unpack[CreateServerRequestRequestTypeDef]
273
+ self, **kwargs: Unpack[CreateServerRequestTypeDef]
274
274
  ) -> CreateServerResponseTypeDef:
275
275
  """
276
276
  Instantiates an auto-scaling virtual server based on the selected file transfer
@@ -280,9 +280,7 @@ class TransferClient(BaseClient):
280
280
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_server)
281
281
  """
282
282
 
283
- def create_user(
284
- self, **kwargs: Unpack[CreateUserRequestRequestTypeDef]
285
- ) -> CreateUserResponseTypeDef:
283
+ def create_user(self, **kwargs: Unpack[CreateUserRequestTypeDef]) -> CreateUserResponseTypeDef:
286
284
  """
287
285
  Creates a user and associates them with an existing file transfer
288
286
  protocol-enabled server.
@@ -292,7 +290,7 @@ class TransferClient(BaseClient):
292
290
  """
293
291
 
294
292
  def create_web_app(
295
- self, **kwargs: Unpack[CreateWebAppRequestRequestTypeDef]
293
+ self, **kwargs: Unpack[CreateWebAppRequestTypeDef]
296
294
  ) -> CreateWebAppResponseTypeDef:
297
295
  """
298
296
  Creates a web app based on specified parameters, and returns the ID for the new
@@ -303,7 +301,7 @@ class TransferClient(BaseClient):
303
301
  """
304
302
 
305
303
  def create_workflow(
306
- self, **kwargs: Unpack[CreateWorkflowRequestRequestTypeDef]
304
+ self, **kwargs: Unpack[CreateWorkflowRequestTypeDef]
307
305
  ) -> CreateWorkflowResponseTypeDef:
308
306
  """
309
307
  Allows you to create a workflow with specified steps and step details the
@@ -314,7 +312,7 @@ class TransferClient(BaseClient):
314
312
  """
315
313
 
316
314
  def delete_access(
317
- self, **kwargs: Unpack[DeleteAccessRequestRequestTypeDef]
315
+ self, **kwargs: Unpack[DeleteAccessRequestTypeDef]
318
316
  ) -> EmptyResponseMetadataTypeDef:
319
317
  """
320
318
  Allows you to delete the access specified in the <code>ServerID</code> and
@@ -325,7 +323,7 @@ class TransferClient(BaseClient):
325
323
  """
326
324
 
327
325
  def delete_agreement(
328
- self, **kwargs: Unpack[DeleteAgreementRequestRequestTypeDef]
326
+ self, **kwargs: Unpack[DeleteAgreementRequestTypeDef]
329
327
  ) -> EmptyResponseMetadataTypeDef:
330
328
  """
331
329
  Delete the agreement that's specified in the provided <code>AgreementId</code>.
@@ -335,7 +333,7 @@ class TransferClient(BaseClient):
335
333
  """
336
334
 
337
335
  def delete_certificate(
338
- self, **kwargs: Unpack[DeleteCertificateRequestRequestTypeDef]
336
+ self, **kwargs: Unpack[DeleteCertificateRequestTypeDef]
339
337
  ) -> EmptyResponseMetadataTypeDef:
340
338
  """
341
339
  Deletes the certificate that's specified in the <code>CertificateId</code>
@@ -346,7 +344,7 @@ class TransferClient(BaseClient):
346
344
  """
347
345
 
348
346
  def delete_connector(
349
- self, **kwargs: Unpack[DeleteConnectorRequestRequestTypeDef]
347
+ self, **kwargs: Unpack[DeleteConnectorRequestTypeDef]
350
348
  ) -> EmptyResponseMetadataTypeDef:
351
349
  """
352
350
  Deletes the connector that's specified in the provided <code>ConnectorId</code>.
@@ -356,7 +354,7 @@ class TransferClient(BaseClient):
356
354
  """
357
355
 
358
356
  def delete_host_key(
359
- self, **kwargs: Unpack[DeleteHostKeyRequestRequestTypeDef]
357
+ self, **kwargs: Unpack[DeleteHostKeyRequestTypeDef]
360
358
  ) -> EmptyResponseMetadataTypeDef:
361
359
  """
362
360
  Deletes the host key that's specified in the <code>HostKeyId</code> parameter.
@@ -366,7 +364,7 @@ class TransferClient(BaseClient):
366
364
  """
367
365
 
368
366
  def delete_profile(
369
- self, **kwargs: Unpack[DeleteProfileRequestRequestTypeDef]
367
+ self, **kwargs: Unpack[DeleteProfileRequestTypeDef]
370
368
  ) -> EmptyResponseMetadataTypeDef:
371
369
  """
372
370
  Deletes the profile that's specified in the <code>ProfileId</code> parameter.
@@ -376,7 +374,7 @@ class TransferClient(BaseClient):
376
374
  """
377
375
 
378
376
  def delete_server(
379
- self, **kwargs: Unpack[DeleteServerRequestRequestTypeDef]
377
+ self, **kwargs: Unpack[DeleteServerRequestTypeDef]
380
378
  ) -> EmptyResponseMetadataTypeDef:
381
379
  """
382
380
  Deletes the file transfer protocol-enabled server that you specify.
@@ -386,7 +384,7 @@ class TransferClient(BaseClient):
386
384
  """
387
385
 
388
386
  def delete_ssh_public_key(
389
- self, **kwargs: Unpack[DeleteSshPublicKeyRequestRequestTypeDef]
387
+ self, **kwargs: Unpack[DeleteSshPublicKeyRequestTypeDef]
390
388
  ) -> EmptyResponseMetadataTypeDef:
391
389
  """
392
390
  Deletes a user's Secure Shell (SSH) public key.
@@ -396,7 +394,7 @@ class TransferClient(BaseClient):
396
394
  """
397
395
 
398
396
  def delete_user(
399
- self, **kwargs: Unpack[DeleteUserRequestRequestTypeDef]
397
+ self, **kwargs: Unpack[DeleteUserRequestTypeDef]
400
398
  ) -> EmptyResponseMetadataTypeDef:
401
399
  """
402
400
  Deletes the user belonging to a file transfer protocol-enabled server you
@@ -407,7 +405,7 @@ class TransferClient(BaseClient):
407
405
  """
408
406
 
409
407
  def delete_web_app(
410
- self, **kwargs: Unpack[DeleteWebAppRequestRequestTypeDef]
408
+ self, **kwargs: Unpack[DeleteWebAppRequestTypeDef]
411
409
  ) -> EmptyResponseMetadataTypeDef:
412
410
  """
413
411
  Deletes the specified web app.
@@ -417,7 +415,7 @@ class TransferClient(BaseClient):
417
415
  """
418
416
 
419
417
  def delete_web_app_customization(
420
- self, **kwargs: Unpack[DeleteWebAppCustomizationRequestRequestTypeDef]
418
+ self, **kwargs: Unpack[DeleteWebAppCustomizationRequestTypeDef]
421
419
  ) -> EmptyResponseMetadataTypeDef:
422
420
  """
423
421
  Deletes the <code>WebAppCustomization</code> object that corresponds to the web
@@ -428,7 +426,7 @@ class TransferClient(BaseClient):
428
426
  """
429
427
 
430
428
  def delete_workflow(
431
- self, **kwargs: Unpack[DeleteWorkflowRequestRequestTypeDef]
429
+ self, **kwargs: Unpack[DeleteWorkflowRequestTypeDef]
432
430
  ) -> EmptyResponseMetadataTypeDef:
433
431
  """
434
432
  Deletes the specified workflow.
@@ -438,7 +436,7 @@ class TransferClient(BaseClient):
438
436
  """
439
437
 
440
438
  def describe_access(
441
- self, **kwargs: Unpack[DescribeAccessRequestRequestTypeDef]
439
+ self, **kwargs: Unpack[DescribeAccessRequestTypeDef]
442
440
  ) -> DescribeAccessResponseTypeDef:
443
441
  """
444
442
  Describes the access that is assigned to the specific file transfer
@@ -450,7 +448,7 @@ class TransferClient(BaseClient):
450
448
  """
451
449
 
452
450
  def describe_agreement(
453
- self, **kwargs: Unpack[DescribeAgreementRequestRequestTypeDef]
451
+ self, **kwargs: Unpack[DescribeAgreementRequestTypeDef]
454
452
  ) -> DescribeAgreementResponseTypeDef:
455
453
  """
456
454
  Describes the agreement that's identified by the <code>AgreementId</code>.
@@ -460,7 +458,7 @@ class TransferClient(BaseClient):
460
458
  """
461
459
 
462
460
  def describe_certificate(
463
- self, **kwargs: Unpack[DescribeCertificateRequestRequestTypeDef]
461
+ self, **kwargs: Unpack[DescribeCertificateRequestTypeDef]
464
462
  ) -> DescribeCertificateResponseTypeDef:
465
463
  """
466
464
  Describes the certificate that's identified by the <code>CertificateId</code>.
@@ -470,7 +468,7 @@ class TransferClient(BaseClient):
470
468
  """
471
469
 
472
470
  def describe_connector(
473
- self, **kwargs: Unpack[DescribeConnectorRequestRequestTypeDef]
471
+ self, **kwargs: Unpack[DescribeConnectorRequestTypeDef]
474
472
  ) -> DescribeConnectorResponseTypeDef:
475
473
  """
476
474
  Describes the connector that's identified by the <code>ConnectorId.</code>.
@@ -480,7 +478,7 @@ class TransferClient(BaseClient):
480
478
  """
481
479
 
482
480
  def describe_execution(
483
- self, **kwargs: Unpack[DescribeExecutionRequestRequestTypeDef]
481
+ self, **kwargs: Unpack[DescribeExecutionRequestTypeDef]
484
482
  ) -> DescribeExecutionResponseTypeDef:
485
483
  """
486
484
  You can use <code>DescribeExecution</code> to check the details of the
@@ -491,7 +489,7 @@ class TransferClient(BaseClient):
491
489
  """
492
490
 
493
491
  def describe_host_key(
494
- self, **kwargs: Unpack[DescribeHostKeyRequestRequestTypeDef]
492
+ self, **kwargs: Unpack[DescribeHostKeyRequestTypeDef]
495
493
  ) -> DescribeHostKeyResponseTypeDef:
496
494
  """
497
495
  Returns the details of the host key that's specified by the
@@ -502,7 +500,7 @@ class TransferClient(BaseClient):
502
500
  """
503
501
 
504
502
  def describe_profile(
505
- self, **kwargs: Unpack[DescribeProfileRequestRequestTypeDef]
503
+ self, **kwargs: Unpack[DescribeProfileRequestTypeDef]
506
504
  ) -> DescribeProfileResponseTypeDef:
507
505
  """
508
506
  Returns the details of the profile that's specified by the
@@ -513,7 +511,7 @@ class TransferClient(BaseClient):
513
511
  """
514
512
 
515
513
  def describe_security_policy(
516
- self, **kwargs: Unpack[DescribeSecurityPolicyRequestRequestTypeDef]
514
+ self, **kwargs: Unpack[DescribeSecurityPolicyRequestTypeDef]
517
515
  ) -> DescribeSecurityPolicyResponseTypeDef:
518
516
  """
519
517
  Describes the security policy that is attached to your server or SFTP connector.
@@ -523,7 +521,7 @@ class TransferClient(BaseClient):
523
521
  """
524
522
 
525
523
  def describe_server(
526
- self, **kwargs: Unpack[DescribeServerRequestRequestTypeDef]
524
+ self, **kwargs: Unpack[DescribeServerRequestTypeDef]
527
525
  ) -> DescribeServerResponseTypeDef:
528
526
  """
529
527
  Describes a file transfer protocol-enabled server that you specify by passing
@@ -534,7 +532,7 @@ class TransferClient(BaseClient):
534
532
  """
535
533
 
536
534
  def describe_user(
537
- self, **kwargs: Unpack[DescribeUserRequestRequestTypeDef]
535
+ self, **kwargs: Unpack[DescribeUserRequestTypeDef]
538
536
  ) -> DescribeUserResponseTypeDef:
539
537
  """
540
538
  Describes the user assigned to the specific file transfer protocol-enabled
@@ -545,7 +543,7 @@ class TransferClient(BaseClient):
545
543
  """
546
544
 
547
545
  def describe_web_app(
548
- self, **kwargs: Unpack[DescribeWebAppRequestRequestTypeDef]
546
+ self, **kwargs: Unpack[DescribeWebAppRequestTypeDef]
549
547
  ) -> DescribeWebAppResponseTypeDef:
550
548
  """
551
549
  Describes the web app that's identified by <code>WebAppId</code>.
@@ -555,7 +553,7 @@ class TransferClient(BaseClient):
555
553
  """
556
554
 
557
555
  def describe_web_app_customization(
558
- self, **kwargs: Unpack[DescribeWebAppCustomizationRequestRequestTypeDef]
556
+ self, **kwargs: Unpack[DescribeWebAppCustomizationRequestTypeDef]
559
557
  ) -> DescribeWebAppCustomizationResponseTypeDef:
560
558
  """
561
559
  Describes the web app customization object that's identified by
@@ -566,7 +564,7 @@ class TransferClient(BaseClient):
566
564
  """
567
565
 
568
566
  def describe_workflow(
569
- self, **kwargs: Unpack[DescribeWorkflowRequestRequestTypeDef]
567
+ self, **kwargs: Unpack[DescribeWorkflowRequestTypeDef]
570
568
  ) -> DescribeWorkflowResponseTypeDef:
571
569
  """
572
570
  Describes the specified workflow.
@@ -576,7 +574,7 @@ class TransferClient(BaseClient):
576
574
  """
577
575
 
578
576
  def import_certificate(
579
- self, **kwargs: Unpack[ImportCertificateRequestRequestTypeDef]
577
+ self, **kwargs: Unpack[ImportCertificateRequestTypeDef]
580
578
  ) -> ImportCertificateResponseTypeDef:
581
579
  """
582
580
  Imports the signing and encryption certificates that you need to create local
@@ -587,7 +585,7 @@ class TransferClient(BaseClient):
587
585
  """
588
586
 
589
587
  def import_host_key(
590
- self, **kwargs: Unpack[ImportHostKeyRequestRequestTypeDef]
588
+ self, **kwargs: Unpack[ImportHostKeyRequestTypeDef]
591
589
  ) -> ImportHostKeyResponseTypeDef:
592
590
  """
593
591
  Adds a host key to the server that's specified by the <code>ServerId</code>
@@ -598,7 +596,7 @@ class TransferClient(BaseClient):
598
596
  """
599
597
 
600
598
  def import_ssh_public_key(
601
- self, **kwargs: Unpack[ImportSshPublicKeyRequestRequestTypeDef]
599
+ self, **kwargs: Unpack[ImportSshPublicKeyRequestTypeDef]
602
600
  ) -> ImportSshPublicKeyResponseTypeDef:
603
601
  """
604
602
  Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a
@@ -610,7 +608,7 @@ class TransferClient(BaseClient):
610
608
  """
611
609
 
612
610
  def list_accesses(
613
- self, **kwargs: Unpack[ListAccessesRequestRequestTypeDef]
611
+ self, **kwargs: Unpack[ListAccessesRequestTypeDef]
614
612
  ) -> ListAccessesResponseTypeDef:
615
613
  """
616
614
  Lists the details for all the accesses you have on your server.
@@ -620,7 +618,7 @@ class TransferClient(BaseClient):
620
618
  """
621
619
 
622
620
  def list_agreements(
623
- self, **kwargs: Unpack[ListAgreementsRequestRequestTypeDef]
621
+ self, **kwargs: Unpack[ListAgreementsRequestTypeDef]
624
622
  ) -> ListAgreementsResponseTypeDef:
625
623
  """
626
624
  Returns a list of the agreements for the server that's identified by the
@@ -631,7 +629,7 @@ class TransferClient(BaseClient):
631
629
  """
632
630
 
633
631
  def list_certificates(
634
- self, **kwargs: Unpack[ListCertificatesRequestRequestTypeDef]
632
+ self, **kwargs: Unpack[ListCertificatesRequestTypeDef]
635
633
  ) -> ListCertificatesResponseTypeDef:
636
634
  """
637
635
  Returns a list of the current certificates that have been imported into
@@ -642,7 +640,7 @@ class TransferClient(BaseClient):
642
640
  """
643
641
 
644
642
  def list_connectors(
645
- self, **kwargs: Unpack[ListConnectorsRequestRequestTypeDef]
643
+ self, **kwargs: Unpack[ListConnectorsRequestTypeDef]
646
644
  ) -> ListConnectorsResponseTypeDef:
647
645
  """
648
646
  Lists the connectors for the specified Region.
@@ -652,7 +650,7 @@ class TransferClient(BaseClient):
652
650
  """
653
651
 
654
652
  def list_executions(
655
- self, **kwargs: Unpack[ListExecutionsRequestRequestTypeDef]
653
+ self, **kwargs: Unpack[ListExecutionsRequestTypeDef]
656
654
  ) -> ListExecutionsResponseTypeDef:
657
655
  """
658
656
  Lists all in-progress executions for the specified workflow.
@@ -662,7 +660,7 @@ class TransferClient(BaseClient):
662
660
  """
663
661
 
664
662
  def list_file_transfer_results(
665
- self, **kwargs: Unpack[ListFileTransferResultsRequestRequestTypeDef]
663
+ self, **kwargs: Unpack[ListFileTransferResultsRequestTypeDef]
666
664
  ) -> ListFileTransferResultsResponseTypeDef:
667
665
  """
668
666
  Returns real-time updates and detailed information on the status of each
@@ -673,7 +671,7 @@ class TransferClient(BaseClient):
673
671
  """
674
672
 
675
673
  def list_host_keys(
676
- self, **kwargs: Unpack[ListHostKeysRequestRequestTypeDef]
674
+ self, **kwargs: Unpack[ListHostKeysRequestTypeDef]
677
675
  ) -> ListHostKeysResponseTypeDef:
678
676
  """
679
677
  Returns a list of host keys for the server that's specified by the
@@ -684,7 +682,7 @@ class TransferClient(BaseClient):
684
682
  """
685
683
 
686
684
  def list_profiles(
687
- self, **kwargs: Unpack[ListProfilesRequestRequestTypeDef]
685
+ self, **kwargs: Unpack[ListProfilesRequestTypeDef]
688
686
  ) -> ListProfilesResponseTypeDef:
689
687
  """
690
688
  Returns a list of the profiles for your system.
@@ -694,7 +692,7 @@ class TransferClient(BaseClient):
694
692
  """
695
693
 
696
694
  def list_security_policies(
697
- self, **kwargs: Unpack[ListSecurityPoliciesRequestRequestTypeDef]
695
+ self, **kwargs: Unpack[ListSecurityPoliciesRequestTypeDef]
698
696
  ) -> ListSecurityPoliciesResponseTypeDef:
699
697
  """
700
698
  Lists the security policies that are attached to your servers and SFTP
@@ -705,7 +703,7 @@ class TransferClient(BaseClient):
705
703
  """
706
704
 
707
705
  def list_servers(
708
- self, **kwargs: Unpack[ListServersRequestRequestTypeDef]
706
+ self, **kwargs: Unpack[ListServersRequestTypeDef]
709
707
  ) -> ListServersResponseTypeDef:
710
708
  """
711
709
  Lists the file transfer protocol-enabled servers that are associated with your
@@ -716,7 +714,7 @@ class TransferClient(BaseClient):
716
714
  """
717
715
 
718
716
  def list_tags_for_resource(
719
- self, **kwargs: Unpack[ListTagsForResourceRequestRequestTypeDef]
717
+ self, **kwargs: Unpack[ListTagsForResourceRequestTypeDef]
720
718
  ) -> ListTagsForResourceResponseTypeDef:
721
719
  """
722
720
  Lists all of the tags associated with the Amazon Resource Name (ARN) that you
@@ -726,9 +724,7 @@ class TransferClient(BaseClient):
726
724
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_tags_for_resource)
727
725
  """
728
726
 
729
- def list_users(
730
- self, **kwargs: Unpack[ListUsersRequestRequestTypeDef]
731
- ) -> ListUsersResponseTypeDef:
727
+ def list_users(self, **kwargs: Unpack[ListUsersRequestTypeDef]) -> ListUsersResponseTypeDef:
732
728
  """
733
729
  Lists the users for a file transfer protocol-enabled server that you specify by
734
730
  passing the <code>ServerId</code> parameter.
@@ -738,7 +734,7 @@ class TransferClient(BaseClient):
738
734
  """
739
735
 
740
736
  def list_web_apps(
741
- self, **kwargs: Unpack[ListWebAppsRequestRequestTypeDef]
737
+ self, **kwargs: Unpack[ListWebAppsRequestTypeDef]
742
738
  ) -> ListWebAppsResponseTypeDef:
743
739
  """
744
740
  Lists all web apps associated with your Amazon Web Services account for your
@@ -749,7 +745,7 @@ class TransferClient(BaseClient):
749
745
  """
750
746
 
751
747
  def list_workflows(
752
- self, **kwargs: Unpack[ListWorkflowsRequestRequestTypeDef]
748
+ self, **kwargs: Unpack[ListWorkflowsRequestTypeDef]
753
749
  ) -> ListWorkflowsResponseTypeDef:
754
750
  """
755
751
  Lists all workflows associated with your Amazon Web Services account for your
@@ -760,7 +756,7 @@ class TransferClient(BaseClient):
760
756
  """
761
757
 
762
758
  def send_workflow_step_state(
763
- self, **kwargs: Unpack[SendWorkflowStepStateRequestRequestTypeDef]
759
+ self, **kwargs: Unpack[SendWorkflowStepStateRequestTypeDef]
764
760
  ) -> Dict[str, Any]:
765
761
  """
766
762
  Sends a callback for asynchronous custom steps.
@@ -770,7 +766,7 @@ class TransferClient(BaseClient):
770
766
  """
771
767
 
772
768
  def start_directory_listing(
773
- self, **kwargs: Unpack[StartDirectoryListingRequestRequestTypeDef]
769
+ self, **kwargs: Unpack[StartDirectoryListingRequestTypeDef]
774
770
  ) -> StartDirectoryListingResponseTypeDef:
775
771
  """
776
772
  Retrieves a list of the contents of a directory from a remote SFTP server.
@@ -780,7 +776,7 @@ class TransferClient(BaseClient):
780
776
  """
781
777
 
782
778
  def start_file_transfer(
783
- self, **kwargs: Unpack[StartFileTransferRequestRequestTypeDef]
779
+ self, **kwargs: Unpack[StartFileTransferRequestTypeDef]
784
780
  ) -> StartFileTransferResponseTypeDef:
785
781
  """
786
782
  Begins a file transfer between local Amazon Web Services storage and a remote
@@ -791,7 +787,7 @@ class TransferClient(BaseClient):
791
787
  """
792
788
 
793
789
  def start_server(
794
- self, **kwargs: Unpack[StartServerRequestRequestTypeDef]
790
+ self, **kwargs: Unpack[StartServerRequestTypeDef]
795
791
  ) -> EmptyResponseMetadataTypeDef:
796
792
  """
797
793
  Changes the state of a file transfer protocol-enabled server from
@@ -802,7 +798,7 @@ class TransferClient(BaseClient):
802
798
  """
803
799
 
804
800
  def stop_server(
805
- self, **kwargs: Unpack[StopServerRequestRequestTypeDef]
801
+ self, **kwargs: Unpack[StopServerRequestTypeDef]
806
802
  ) -> EmptyResponseMetadataTypeDef:
807
803
  """
808
804
  Changes the state of a file transfer protocol-enabled server from
@@ -813,7 +809,7 @@ class TransferClient(BaseClient):
813
809
  """
814
810
 
815
811
  def tag_resource(
816
- self, **kwargs: Unpack[TagResourceRequestRequestTypeDef]
812
+ self, **kwargs: Unpack[TagResourceRequestTypeDef]
817
813
  ) -> EmptyResponseMetadataTypeDef:
818
814
  """
819
815
  Attaches a key-value pair to a resource, as identified by its Amazon Resource
@@ -824,7 +820,7 @@ class TransferClient(BaseClient):
824
820
  """
825
821
 
826
822
  def test_connection(
827
- self, **kwargs: Unpack[TestConnectionRequestRequestTypeDef]
823
+ self, **kwargs: Unpack[TestConnectionRequestTypeDef]
828
824
  ) -> TestConnectionResponseTypeDef:
829
825
  """
830
826
  Tests whether your SFTP connector is set up successfully.
@@ -834,7 +830,7 @@ class TransferClient(BaseClient):
834
830
  """
835
831
 
836
832
  def test_identity_provider(
837
- self, **kwargs: Unpack[TestIdentityProviderRequestRequestTypeDef]
833
+ self, **kwargs: Unpack[TestIdentityProviderRequestTypeDef]
838
834
  ) -> TestIdentityProviderResponseTypeDef:
839
835
  """
840
836
  If the <code>IdentityProviderType</code> of a file transfer protocol-enabled
@@ -846,7 +842,7 @@ class TransferClient(BaseClient):
846
842
  """
847
843
 
848
844
  def untag_resource(
849
- self, **kwargs: Unpack[UntagResourceRequestRequestTypeDef]
845
+ self, **kwargs: Unpack[UntagResourceRequestTypeDef]
850
846
  ) -> EmptyResponseMetadataTypeDef:
851
847
  """
852
848
  Detaches a key-value pair from a resource, as identified by its Amazon Resource
@@ -857,7 +853,7 @@ class TransferClient(BaseClient):
857
853
  """
858
854
 
859
855
  def update_access(
860
- self, **kwargs: Unpack[UpdateAccessRequestRequestTypeDef]
856
+ self, **kwargs: Unpack[UpdateAccessRequestTypeDef]
861
857
  ) -> UpdateAccessResponseTypeDef:
862
858
  """
863
859
  Allows you to update parameters for the access specified in the
@@ -868,7 +864,7 @@ class TransferClient(BaseClient):
868
864
  """
869
865
 
870
866
  def update_agreement(
871
- self, **kwargs: Unpack[UpdateAgreementRequestRequestTypeDef]
867
+ self, **kwargs: Unpack[UpdateAgreementRequestTypeDef]
872
868
  ) -> UpdateAgreementResponseTypeDef:
873
869
  """
874
870
  Updates some of the parameters for an existing agreement.
@@ -878,7 +874,7 @@ class TransferClient(BaseClient):
878
874
  """
879
875
 
880
876
  def update_certificate(
881
- self, **kwargs: Unpack[UpdateCertificateRequestRequestTypeDef]
877
+ self, **kwargs: Unpack[UpdateCertificateRequestTypeDef]
882
878
  ) -> UpdateCertificateResponseTypeDef:
883
879
  """
884
880
  Updates the active and inactive dates for a certificate.
@@ -888,7 +884,7 @@ class TransferClient(BaseClient):
888
884
  """
889
885
 
890
886
  def update_connector(
891
- self, **kwargs: Unpack[UpdateConnectorRequestRequestTypeDef]
887
+ self, **kwargs: Unpack[UpdateConnectorRequestTypeDef]
892
888
  ) -> UpdateConnectorResponseTypeDef:
893
889
  """
894
890
  Updates some of the parameters for an existing connector.
@@ -898,7 +894,7 @@ class TransferClient(BaseClient):
898
894
  """
899
895
 
900
896
  def update_host_key(
901
- self, **kwargs: Unpack[UpdateHostKeyRequestRequestTypeDef]
897
+ self, **kwargs: Unpack[UpdateHostKeyRequestTypeDef]
902
898
  ) -> UpdateHostKeyResponseTypeDef:
903
899
  """
904
900
  Updates the description for the host key that's specified by the
@@ -909,7 +905,7 @@ class TransferClient(BaseClient):
909
905
  """
910
906
 
911
907
  def update_profile(
912
- self, **kwargs: Unpack[UpdateProfileRequestRequestTypeDef]
908
+ self, **kwargs: Unpack[UpdateProfileRequestTypeDef]
913
909
  ) -> UpdateProfileResponseTypeDef:
914
910
  """
915
911
  Updates some of the parameters for an existing profile.
@@ -919,7 +915,7 @@ class TransferClient(BaseClient):
919
915
  """
920
916
 
921
917
  def update_server(
922
- self, **kwargs: Unpack[UpdateServerRequestRequestTypeDef]
918
+ self, **kwargs: Unpack[UpdateServerRequestTypeDef]
923
919
  ) -> UpdateServerResponseTypeDef:
924
920
  """
925
921
  Updates the file transfer protocol-enabled server's properties after that
@@ -929,9 +925,7 @@ class TransferClient(BaseClient):
929
925
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_server)
930
926
  """
931
927
 
932
- def update_user(
933
- self, **kwargs: Unpack[UpdateUserRequestRequestTypeDef]
934
- ) -> UpdateUserResponseTypeDef:
928
+ def update_user(self, **kwargs: Unpack[UpdateUserRequestTypeDef]) -> UpdateUserResponseTypeDef:
935
929
  """
936
930
  Assigns new properties to a user.
937
931
 
@@ -940,7 +934,7 @@ class TransferClient(BaseClient):
940
934
  """
941
935
 
942
936
  def update_web_app(
943
- self, **kwargs: Unpack[UpdateWebAppRequestRequestTypeDef]
937
+ self, **kwargs: Unpack[UpdateWebAppRequestTypeDef]
944
938
  ) -> UpdateWebAppResponseTypeDef:
945
939
  """
946
940
  Assigns new properties to a web app.
@@ -950,7 +944,7 @@ class TransferClient(BaseClient):
950
944
  """
951
945
 
952
946
  def update_web_app_customization(
953
- self, **kwargs: Unpack[UpdateWebAppCustomizationRequestRequestTypeDef]
947
+ self, **kwargs: Unpack[UpdateWebAppCustomizationRequestTypeDef]
954
948
  ) -> UpdateWebAppCustomizationResponseTypeDef:
955
949
  """
956
950
  Assigns new customization properties to a web app.