mypy-boto3-transfer 1.36.0__py3-none-any.whl → 1.37.0__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
@@ -230,7 +230,7 @@ class TransferClient(BaseClient):
230
230
  """
231
231
 
232
232
  def create_access(
233
- self, **kwargs: Unpack[CreateAccessRequestRequestTypeDef]
233
+ self, **kwargs: Unpack[CreateAccessRequestTypeDef]
234
234
  ) -> CreateAccessResponseTypeDef:
235
235
  """
236
236
  Used by administrators to choose which groups in the directory should have
@@ -242,7 +242,7 @@ class TransferClient(BaseClient):
242
242
  """
243
243
 
244
244
  def create_agreement(
245
- self, **kwargs: Unpack[CreateAgreementRequestRequestTypeDef]
245
+ self, **kwargs: Unpack[CreateAgreementRequestTypeDef]
246
246
  ) -> CreateAgreementResponseTypeDef:
247
247
  """
248
248
  Creates an agreement.
@@ -252,7 +252,7 @@ class TransferClient(BaseClient):
252
252
  """
253
253
 
254
254
  def create_connector(
255
- self, **kwargs: Unpack[CreateConnectorRequestRequestTypeDef]
255
+ self, **kwargs: Unpack[CreateConnectorRequestTypeDef]
256
256
  ) -> CreateConnectorResponseTypeDef:
257
257
  """
258
258
  Creates the connector, which captures the parameters for a connection for the
@@ -263,7 +263,7 @@ class TransferClient(BaseClient):
263
263
  """
264
264
 
265
265
  def create_profile(
266
- self, **kwargs: Unpack[CreateProfileRequestRequestTypeDef]
266
+ self, **kwargs: Unpack[CreateProfileRequestTypeDef]
267
267
  ) -> CreateProfileResponseTypeDef:
268
268
  """
269
269
  Creates the local or partner profile to use for AS2 transfers.
@@ -273,7 +273,7 @@ class TransferClient(BaseClient):
273
273
  """
274
274
 
275
275
  def create_server(
276
- self, **kwargs: Unpack[CreateServerRequestRequestTypeDef]
276
+ self, **kwargs: Unpack[CreateServerRequestTypeDef]
277
277
  ) -> CreateServerResponseTypeDef:
278
278
  """
279
279
  Instantiates an auto-scaling virtual server based on the selected file transfer
@@ -283,9 +283,7 @@ class TransferClient(BaseClient):
283
283
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_server)
284
284
  """
285
285
 
286
- def create_user(
287
- self, **kwargs: Unpack[CreateUserRequestRequestTypeDef]
288
- ) -> CreateUserResponseTypeDef:
286
+ def create_user(self, **kwargs: Unpack[CreateUserRequestTypeDef]) -> CreateUserResponseTypeDef:
289
287
  """
290
288
  Creates a user and associates them with an existing file transfer
291
289
  protocol-enabled server.
@@ -295,7 +293,7 @@ class TransferClient(BaseClient):
295
293
  """
296
294
 
297
295
  def create_web_app(
298
- self, **kwargs: Unpack[CreateWebAppRequestRequestTypeDef]
296
+ self, **kwargs: Unpack[CreateWebAppRequestTypeDef]
299
297
  ) -> CreateWebAppResponseTypeDef:
300
298
  """
301
299
  Creates a web app based on specified parameters, and returns the ID for the new
@@ -306,7 +304,7 @@ class TransferClient(BaseClient):
306
304
  """
307
305
 
308
306
  def create_workflow(
309
- self, **kwargs: Unpack[CreateWorkflowRequestRequestTypeDef]
307
+ self, **kwargs: Unpack[CreateWorkflowRequestTypeDef]
310
308
  ) -> CreateWorkflowResponseTypeDef:
311
309
  """
312
310
  Allows you to create a workflow with specified steps and step details the
@@ -317,7 +315,7 @@ class TransferClient(BaseClient):
317
315
  """
318
316
 
319
317
  def delete_access(
320
- self, **kwargs: Unpack[DeleteAccessRequestRequestTypeDef]
318
+ self, **kwargs: Unpack[DeleteAccessRequestTypeDef]
321
319
  ) -> EmptyResponseMetadataTypeDef:
322
320
  """
323
321
  Allows you to delete the access specified in the <code>ServerID</code> and
@@ -328,7 +326,7 @@ class TransferClient(BaseClient):
328
326
  """
329
327
 
330
328
  def delete_agreement(
331
- self, **kwargs: Unpack[DeleteAgreementRequestRequestTypeDef]
329
+ self, **kwargs: Unpack[DeleteAgreementRequestTypeDef]
332
330
  ) -> EmptyResponseMetadataTypeDef:
333
331
  """
334
332
  Delete the agreement that's specified in the provided <code>AgreementId</code>.
@@ -338,7 +336,7 @@ class TransferClient(BaseClient):
338
336
  """
339
337
 
340
338
  def delete_certificate(
341
- self, **kwargs: Unpack[DeleteCertificateRequestRequestTypeDef]
339
+ self, **kwargs: Unpack[DeleteCertificateRequestTypeDef]
342
340
  ) -> EmptyResponseMetadataTypeDef:
343
341
  """
344
342
  Deletes the certificate that's specified in the <code>CertificateId</code>
@@ -349,7 +347,7 @@ class TransferClient(BaseClient):
349
347
  """
350
348
 
351
349
  def delete_connector(
352
- self, **kwargs: Unpack[DeleteConnectorRequestRequestTypeDef]
350
+ self, **kwargs: Unpack[DeleteConnectorRequestTypeDef]
353
351
  ) -> EmptyResponseMetadataTypeDef:
354
352
  """
355
353
  Deletes the connector that's specified in the provided <code>ConnectorId</code>.
@@ -359,7 +357,7 @@ class TransferClient(BaseClient):
359
357
  """
360
358
 
361
359
  def delete_host_key(
362
- self, **kwargs: Unpack[DeleteHostKeyRequestRequestTypeDef]
360
+ self, **kwargs: Unpack[DeleteHostKeyRequestTypeDef]
363
361
  ) -> EmptyResponseMetadataTypeDef:
364
362
  """
365
363
  Deletes the host key that's specified in the <code>HostKeyId</code> parameter.
@@ -369,7 +367,7 @@ class TransferClient(BaseClient):
369
367
  """
370
368
 
371
369
  def delete_profile(
372
- self, **kwargs: Unpack[DeleteProfileRequestRequestTypeDef]
370
+ self, **kwargs: Unpack[DeleteProfileRequestTypeDef]
373
371
  ) -> EmptyResponseMetadataTypeDef:
374
372
  """
375
373
  Deletes the profile that's specified in the <code>ProfileId</code> parameter.
@@ -379,7 +377,7 @@ class TransferClient(BaseClient):
379
377
  """
380
378
 
381
379
  def delete_server(
382
- self, **kwargs: Unpack[DeleteServerRequestRequestTypeDef]
380
+ self, **kwargs: Unpack[DeleteServerRequestTypeDef]
383
381
  ) -> EmptyResponseMetadataTypeDef:
384
382
  """
385
383
  Deletes the file transfer protocol-enabled server that you specify.
@@ -389,7 +387,7 @@ class TransferClient(BaseClient):
389
387
  """
390
388
 
391
389
  def delete_ssh_public_key(
392
- self, **kwargs: Unpack[DeleteSshPublicKeyRequestRequestTypeDef]
390
+ self, **kwargs: Unpack[DeleteSshPublicKeyRequestTypeDef]
393
391
  ) -> EmptyResponseMetadataTypeDef:
394
392
  """
395
393
  Deletes a user's Secure Shell (SSH) public key.
@@ -399,7 +397,7 @@ class TransferClient(BaseClient):
399
397
  """
400
398
 
401
399
  def delete_user(
402
- self, **kwargs: Unpack[DeleteUserRequestRequestTypeDef]
400
+ self, **kwargs: Unpack[DeleteUserRequestTypeDef]
403
401
  ) -> EmptyResponseMetadataTypeDef:
404
402
  """
405
403
  Deletes the user belonging to a file transfer protocol-enabled server you
@@ -410,7 +408,7 @@ class TransferClient(BaseClient):
410
408
  """
411
409
 
412
410
  def delete_web_app(
413
- self, **kwargs: Unpack[DeleteWebAppRequestRequestTypeDef]
411
+ self, **kwargs: Unpack[DeleteWebAppRequestTypeDef]
414
412
  ) -> EmptyResponseMetadataTypeDef:
415
413
  """
416
414
  Deletes the specified web app.
@@ -420,7 +418,7 @@ class TransferClient(BaseClient):
420
418
  """
421
419
 
422
420
  def delete_web_app_customization(
423
- self, **kwargs: Unpack[DeleteWebAppCustomizationRequestRequestTypeDef]
421
+ self, **kwargs: Unpack[DeleteWebAppCustomizationRequestTypeDef]
424
422
  ) -> EmptyResponseMetadataTypeDef:
425
423
  """
426
424
  Deletes the <code>WebAppCustomization</code> object that corresponds to the web
@@ -431,7 +429,7 @@ class TransferClient(BaseClient):
431
429
  """
432
430
 
433
431
  def delete_workflow(
434
- self, **kwargs: Unpack[DeleteWorkflowRequestRequestTypeDef]
432
+ self, **kwargs: Unpack[DeleteWorkflowRequestTypeDef]
435
433
  ) -> EmptyResponseMetadataTypeDef:
436
434
  """
437
435
  Deletes the specified workflow.
@@ -441,7 +439,7 @@ class TransferClient(BaseClient):
441
439
  """
442
440
 
443
441
  def describe_access(
444
- self, **kwargs: Unpack[DescribeAccessRequestRequestTypeDef]
442
+ self, **kwargs: Unpack[DescribeAccessRequestTypeDef]
445
443
  ) -> DescribeAccessResponseTypeDef:
446
444
  """
447
445
  Describes the access that is assigned to the specific file transfer
@@ -453,7 +451,7 @@ class TransferClient(BaseClient):
453
451
  """
454
452
 
455
453
  def describe_agreement(
456
- self, **kwargs: Unpack[DescribeAgreementRequestRequestTypeDef]
454
+ self, **kwargs: Unpack[DescribeAgreementRequestTypeDef]
457
455
  ) -> DescribeAgreementResponseTypeDef:
458
456
  """
459
457
  Describes the agreement that's identified by the <code>AgreementId</code>.
@@ -463,7 +461,7 @@ class TransferClient(BaseClient):
463
461
  """
464
462
 
465
463
  def describe_certificate(
466
- self, **kwargs: Unpack[DescribeCertificateRequestRequestTypeDef]
464
+ self, **kwargs: Unpack[DescribeCertificateRequestTypeDef]
467
465
  ) -> DescribeCertificateResponseTypeDef:
468
466
  """
469
467
  Describes the certificate that's identified by the <code>CertificateId</code>.
@@ -473,7 +471,7 @@ class TransferClient(BaseClient):
473
471
  """
474
472
 
475
473
  def describe_connector(
476
- self, **kwargs: Unpack[DescribeConnectorRequestRequestTypeDef]
474
+ self, **kwargs: Unpack[DescribeConnectorRequestTypeDef]
477
475
  ) -> DescribeConnectorResponseTypeDef:
478
476
  """
479
477
  Describes the connector that's identified by the <code>ConnectorId.</code>.
@@ -483,7 +481,7 @@ class TransferClient(BaseClient):
483
481
  """
484
482
 
485
483
  def describe_execution(
486
- self, **kwargs: Unpack[DescribeExecutionRequestRequestTypeDef]
484
+ self, **kwargs: Unpack[DescribeExecutionRequestTypeDef]
487
485
  ) -> DescribeExecutionResponseTypeDef:
488
486
  """
489
487
  You can use <code>DescribeExecution</code> to check the details of the
@@ -494,7 +492,7 @@ class TransferClient(BaseClient):
494
492
  """
495
493
 
496
494
  def describe_host_key(
497
- self, **kwargs: Unpack[DescribeHostKeyRequestRequestTypeDef]
495
+ self, **kwargs: Unpack[DescribeHostKeyRequestTypeDef]
498
496
  ) -> DescribeHostKeyResponseTypeDef:
499
497
  """
500
498
  Returns the details of the host key that's specified by the
@@ -505,7 +503,7 @@ class TransferClient(BaseClient):
505
503
  """
506
504
 
507
505
  def describe_profile(
508
- self, **kwargs: Unpack[DescribeProfileRequestRequestTypeDef]
506
+ self, **kwargs: Unpack[DescribeProfileRequestTypeDef]
509
507
  ) -> DescribeProfileResponseTypeDef:
510
508
  """
511
509
  Returns the details of the profile that's specified by the
@@ -516,7 +514,7 @@ class TransferClient(BaseClient):
516
514
  """
517
515
 
518
516
  def describe_security_policy(
519
- self, **kwargs: Unpack[DescribeSecurityPolicyRequestRequestTypeDef]
517
+ self, **kwargs: Unpack[DescribeSecurityPolicyRequestTypeDef]
520
518
  ) -> DescribeSecurityPolicyResponseTypeDef:
521
519
  """
522
520
  Describes the security policy that is attached to your server or SFTP connector.
@@ -526,7 +524,7 @@ class TransferClient(BaseClient):
526
524
  """
527
525
 
528
526
  def describe_server(
529
- self, **kwargs: Unpack[DescribeServerRequestRequestTypeDef]
527
+ self, **kwargs: Unpack[DescribeServerRequestTypeDef]
530
528
  ) -> DescribeServerResponseTypeDef:
531
529
  """
532
530
  Describes a file transfer protocol-enabled server that you specify by passing
@@ -537,7 +535,7 @@ class TransferClient(BaseClient):
537
535
  """
538
536
 
539
537
  def describe_user(
540
- self, **kwargs: Unpack[DescribeUserRequestRequestTypeDef]
538
+ self, **kwargs: Unpack[DescribeUserRequestTypeDef]
541
539
  ) -> DescribeUserResponseTypeDef:
542
540
  """
543
541
  Describes the user assigned to the specific file transfer protocol-enabled
@@ -548,7 +546,7 @@ class TransferClient(BaseClient):
548
546
  """
549
547
 
550
548
  def describe_web_app(
551
- self, **kwargs: Unpack[DescribeWebAppRequestRequestTypeDef]
549
+ self, **kwargs: Unpack[DescribeWebAppRequestTypeDef]
552
550
  ) -> DescribeWebAppResponseTypeDef:
553
551
  """
554
552
  Describes the web app that's identified by <code>WebAppId</code>.
@@ -558,7 +556,7 @@ class TransferClient(BaseClient):
558
556
  """
559
557
 
560
558
  def describe_web_app_customization(
561
- self, **kwargs: Unpack[DescribeWebAppCustomizationRequestRequestTypeDef]
559
+ self, **kwargs: Unpack[DescribeWebAppCustomizationRequestTypeDef]
562
560
  ) -> DescribeWebAppCustomizationResponseTypeDef:
563
561
  """
564
562
  Describes the web app customization object that's identified by
@@ -569,7 +567,7 @@ class TransferClient(BaseClient):
569
567
  """
570
568
 
571
569
  def describe_workflow(
572
- self, **kwargs: Unpack[DescribeWorkflowRequestRequestTypeDef]
570
+ self, **kwargs: Unpack[DescribeWorkflowRequestTypeDef]
573
571
  ) -> DescribeWorkflowResponseTypeDef:
574
572
  """
575
573
  Describes the specified workflow.
@@ -579,7 +577,7 @@ class TransferClient(BaseClient):
579
577
  """
580
578
 
581
579
  def import_certificate(
582
- self, **kwargs: Unpack[ImportCertificateRequestRequestTypeDef]
580
+ self, **kwargs: Unpack[ImportCertificateRequestTypeDef]
583
581
  ) -> ImportCertificateResponseTypeDef:
584
582
  """
585
583
  Imports the signing and encryption certificates that you need to create local
@@ -590,7 +588,7 @@ class TransferClient(BaseClient):
590
588
  """
591
589
 
592
590
  def import_host_key(
593
- self, **kwargs: Unpack[ImportHostKeyRequestRequestTypeDef]
591
+ self, **kwargs: Unpack[ImportHostKeyRequestTypeDef]
594
592
  ) -> ImportHostKeyResponseTypeDef:
595
593
  """
596
594
  Adds a host key to the server that's specified by the <code>ServerId</code>
@@ -601,7 +599,7 @@ class TransferClient(BaseClient):
601
599
  """
602
600
 
603
601
  def import_ssh_public_key(
604
- self, **kwargs: Unpack[ImportSshPublicKeyRequestRequestTypeDef]
602
+ self, **kwargs: Unpack[ImportSshPublicKeyRequestTypeDef]
605
603
  ) -> ImportSshPublicKeyResponseTypeDef:
606
604
  """
607
605
  Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a
@@ -613,7 +611,7 @@ class TransferClient(BaseClient):
613
611
  """
614
612
 
615
613
  def list_accesses(
616
- self, **kwargs: Unpack[ListAccessesRequestRequestTypeDef]
614
+ self, **kwargs: Unpack[ListAccessesRequestTypeDef]
617
615
  ) -> ListAccessesResponseTypeDef:
618
616
  """
619
617
  Lists the details for all the accesses you have on your server.
@@ -623,7 +621,7 @@ class TransferClient(BaseClient):
623
621
  """
624
622
 
625
623
  def list_agreements(
626
- self, **kwargs: Unpack[ListAgreementsRequestRequestTypeDef]
624
+ self, **kwargs: Unpack[ListAgreementsRequestTypeDef]
627
625
  ) -> ListAgreementsResponseTypeDef:
628
626
  """
629
627
  Returns a list of the agreements for the server that's identified by the
@@ -634,7 +632,7 @@ class TransferClient(BaseClient):
634
632
  """
635
633
 
636
634
  def list_certificates(
637
- self, **kwargs: Unpack[ListCertificatesRequestRequestTypeDef]
635
+ self, **kwargs: Unpack[ListCertificatesRequestTypeDef]
638
636
  ) -> ListCertificatesResponseTypeDef:
639
637
  """
640
638
  Returns a list of the current certificates that have been imported into
@@ -645,7 +643,7 @@ class TransferClient(BaseClient):
645
643
  """
646
644
 
647
645
  def list_connectors(
648
- self, **kwargs: Unpack[ListConnectorsRequestRequestTypeDef]
646
+ self, **kwargs: Unpack[ListConnectorsRequestTypeDef]
649
647
  ) -> ListConnectorsResponseTypeDef:
650
648
  """
651
649
  Lists the connectors for the specified Region.
@@ -655,7 +653,7 @@ class TransferClient(BaseClient):
655
653
  """
656
654
 
657
655
  def list_executions(
658
- self, **kwargs: Unpack[ListExecutionsRequestRequestTypeDef]
656
+ self, **kwargs: Unpack[ListExecutionsRequestTypeDef]
659
657
  ) -> ListExecutionsResponseTypeDef:
660
658
  """
661
659
  Lists all in-progress executions for the specified workflow.
@@ -665,7 +663,7 @@ class TransferClient(BaseClient):
665
663
  """
666
664
 
667
665
  def list_file_transfer_results(
668
- self, **kwargs: Unpack[ListFileTransferResultsRequestRequestTypeDef]
666
+ self, **kwargs: Unpack[ListFileTransferResultsRequestTypeDef]
669
667
  ) -> ListFileTransferResultsResponseTypeDef:
670
668
  """
671
669
  Returns real-time updates and detailed information on the status of each
@@ -676,7 +674,7 @@ class TransferClient(BaseClient):
676
674
  """
677
675
 
678
676
  def list_host_keys(
679
- self, **kwargs: Unpack[ListHostKeysRequestRequestTypeDef]
677
+ self, **kwargs: Unpack[ListHostKeysRequestTypeDef]
680
678
  ) -> ListHostKeysResponseTypeDef:
681
679
  """
682
680
  Returns a list of host keys for the server that's specified by the
@@ -687,7 +685,7 @@ class TransferClient(BaseClient):
687
685
  """
688
686
 
689
687
  def list_profiles(
690
- self, **kwargs: Unpack[ListProfilesRequestRequestTypeDef]
688
+ self, **kwargs: Unpack[ListProfilesRequestTypeDef]
691
689
  ) -> ListProfilesResponseTypeDef:
692
690
  """
693
691
  Returns a list of the profiles for your system.
@@ -697,7 +695,7 @@ class TransferClient(BaseClient):
697
695
  """
698
696
 
699
697
  def list_security_policies(
700
- self, **kwargs: Unpack[ListSecurityPoliciesRequestRequestTypeDef]
698
+ self, **kwargs: Unpack[ListSecurityPoliciesRequestTypeDef]
701
699
  ) -> ListSecurityPoliciesResponseTypeDef:
702
700
  """
703
701
  Lists the security policies that are attached to your servers and SFTP
@@ -708,7 +706,7 @@ class TransferClient(BaseClient):
708
706
  """
709
707
 
710
708
  def list_servers(
711
- self, **kwargs: Unpack[ListServersRequestRequestTypeDef]
709
+ self, **kwargs: Unpack[ListServersRequestTypeDef]
712
710
  ) -> ListServersResponseTypeDef:
713
711
  """
714
712
  Lists the file transfer protocol-enabled servers that are associated with your
@@ -719,7 +717,7 @@ class TransferClient(BaseClient):
719
717
  """
720
718
 
721
719
  def list_tags_for_resource(
722
- self, **kwargs: Unpack[ListTagsForResourceRequestRequestTypeDef]
720
+ self, **kwargs: Unpack[ListTagsForResourceRequestTypeDef]
723
721
  ) -> ListTagsForResourceResponseTypeDef:
724
722
  """
725
723
  Lists all of the tags associated with the Amazon Resource Name (ARN) that you
@@ -729,9 +727,7 @@ class TransferClient(BaseClient):
729
727
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_tags_for_resource)
730
728
  """
731
729
 
732
- def list_users(
733
- self, **kwargs: Unpack[ListUsersRequestRequestTypeDef]
734
- ) -> ListUsersResponseTypeDef:
730
+ def list_users(self, **kwargs: Unpack[ListUsersRequestTypeDef]) -> ListUsersResponseTypeDef:
735
731
  """
736
732
  Lists the users for a file transfer protocol-enabled server that you specify by
737
733
  passing the <code>ServerId</code> parameter.
@@ -741,7 +737,7 @@ class TransferClient(BaseClient):
741
737
  """
742
738
 
743
739
  def list_web_apps(
744
- self, **kwargs: Unpack[ListWebAppsRequestRequestTypeDef]
740
+ self, **kwargs: Unpack[ListWebAppsRequestTypeDef]
745
741
  ) -> ListWebAppsResponseTypeDef:
746
742
  """
747
743
  Lists all web apps associated with your Amazon Web Services account for your
@@ -752,7 +748,7 @@ class TransferClient(BaseClient):
752
748
  """
753
749
 
754
750
  def list_workflows(
755
- self, **kwargs: Unpack[ListWorkflowsRequestRequestTypeDef]
751
+ self, **kwargs: Unpack[ListWorkflowsRequestTypeDef]
756
752
  ) -> ListWorkflowsResponseTypeDef:
757
753
  """
758
754
  Lists all workflows associated with your Amazon Web Services account for your
@@ -763,7 +759,7 @@ class TransferClient(BaseClient):
763
759
  """
764
760
 
765
761
  def send_workflow_step_state(
766
- self, **kwargs: Unpack[SendWorkflowStepStateRequestRequestTypeDef]
762
+ self, **kwargs: Unpack[SendWorkflowStepStateRequestTypeDef]
767
763
  ) -> Dict[str, Any]:
768
764
  """
769
765
  Sends a callback for asynchronous custom steps.
@@ -773,7 +769,7 @@ class TransferClient(BaseClient):
773
769
  """
774
770
 
775
771
  def start_directory_listing(
776
- self, **kwargs: Unpack[StartDirectoryListingRequestRequestTypeDef]
772
+ self, **kwargs: Unpack[StartDirectoryListingRequestTypeDef]
777
773
  ) -> StartDirectoryListingResponseTypeDef:
778
774
  """
779
775
  Retrieves a list of the contents of a directory from a remote SFTP server.
@@ -783,7 +779,7 @@ class TransferClient(BaseClient):
783
779
  """
784
780
 
785
781
  def start_file_transfer(
786
- self, **kwargs: Unpack[StartFileTransferRequestRequestTypeDef]
782
+ self, **kwargs: Unpack[StartFileTransferRequestTypeDef]
787
783
  ) -> StartFileTransferResponseTypeDef:
788
784
  """
789
785
  Begins a file transfer between local Amazon Web Services storage and a remote
@@ -794,7 +790,7 @@ class TransferClient(BaseClient):
794
790
  """
795
791
 
796
792
  def start_server(
797
- self, **kwargs: Unpack[StartServerRequestRequestTypeDef]
793
+ self, **kwargs: Unpack[StartServerRequestTypeDef]
798
794
  ) -> EmptyResponseMetadataTypeDef:
799
795
  """
800
796
  Changes the state of a file transfer protocol-enabled server from
@@ -805,7 +801,7 @@ class TransferClient(BaseClient):
805
801
  """
806
802
 
807
803
  def stop_server(
808
- self, **kwargs: Unpack[StopServerRequestRequestTypeDef]
804
+ self, **kwargs: Unpack[StopServerRequestTypeDef]
809
805
  ) -> EmptyResponseMetadataTypeDef:
810
806
  """
811
807
  Changes the state of a file transfer protocol-enabled server from
@@ -816,7 +812,7 @@ class TransferClient(BaseClient):
816
812
  """
817
813
 
818
814
  def tag_resource(
819
- self, **kwargs: Unpack[TagResourceRequestRequestTypeDef]
815
+ self, **kwargs: Unpack[TagResourceRequestTypeDef]
820
816
  ) -> EmptyResponseMetadataTypeDef:
821
817
  """
822
818
  Attaches a key-value pair to a resource, as identified by its Amazon Resource
@@ -827,7 +823,7 @@ class TransferClient(BaseClient):
827
823
  """
828
824
 
829
825
  def test_connection(
830
- self, **kwargs: Unpack[TestConnectionRequestRequestTypeDef]
826
+ self, **kwargs: Unpack[TestConnectionRequestTypeDef]
831
827
  ) -> TestConnectionResponseTypeDef:
832
828
  """
833
829
  Tests whether your SFTP connector is set up successfully.
@@ -837,7 +833,7 @@ class TransferClient(BaseClient):
837
833
  """
838
834
 
839
835
  def test_identity_provider(
840
- self, **kwargs: Unpack[TestIdentityProviderRequestRequestTypeDef]
836
+ self, **kwargs: Unpack[TestIdentityProviderRequestTypeDef]
841
837
  ) -> TestIdentityProviderResponseTypeDef:
842
838
  """
843
839
  If the <code>IdentityProviderType</code> of a file transfer protocol-enabled
@@ -849,7 +845,7 @@ class TransferClient(BaseClient):
849
845
  """
850
846
 
851
847
  def untag_resource(
852
- self, **kwargs: Unpack[UntagResourceRequestRequestTypeDef]
848
+ self, **kwargs: Unpack[UntagResourceRequestTypeDef]
853
849
  ) -> EmptyResponseMetadataTypeDef:
854
850
  """
855
851
  Detaches a key-value pair from a resource, as identified by its Amazon Resource
@@ -860,7 +856,7 @@ class TransferClient(BaseClient):
860
856
  """
861
857
 
862
858
  def update_access(
863
- self, **kwargs: Unpack[UpdateAccessRequestRequestTypeDef]
859
+ self, **kwargs: Unpack[UpdateAccessRequestTypeDef]
864
860
  ) -> UpdateAccessResponseTypeDef:
865
861
  """
866
862
  Allows you to update parameters for the access specified in the
@@ -871,7 +867,7 @@ class TransferClient(BaseClient):
871
867
  """
872
868
 
873
869
  def update_agreement(
874
- self, **kwargs: Unpack[UpdateAgreementRequestRequestTypeDef]
870
+ self, **kwargs: Unpack[UpdateAgreementRequestTypeDef]
875
871
  ) -> UpdateAgreementResponseTypeDef:
876
872
  """
877
873
  Updates some of the parameters for an existing agreement.
@@ -881,7 +877,7 @@ class TransferClient(BaseClient):
881
877
  """
882
878
 
883
879
  def update_certificate(
884
- self, **kwargs: Unpack[UpdateCertificateRequestRequestTypeDef]
880
+ self, **kwargs: Unpack[UpdateCertificateRequestTypeDef]
885
881
  ) -> UpdateCertificateResponseTypeDef:
886
882
  """
887
883
  Updates the active and inactive dates for a certificate.
@@ -891,7 +887,7 @@ class TransferClient(BaseClient):
891
887
  """
892
888
 
893
889
  def update_connector(
894
- self, **kwargs: Unpack[UpdateConnectorRequestRequestTypeDef]
890
+ self, **kwargs: Unpack[UpdateConnectorRequestTypeDef]
895
891
  ) -> UpdateConnectorResponseTypeDef:
896
892
  """
897
893
  Updates some of the parameters for an existing connector.
@@ -901,7 +897,7 @@ class TransferClient(BaseClient):
901
897
  """
902
898
 
903
899
  def update_host_key(
904
- self, **kwargs: Unpack[UpdateHostKeyRequestRequestTypeDef]
900
+ self, **kwargs: Unpack[UpdateHostKeyRequestTypeDef]
905
901
  ) -> UpdateHostKeyResponseTypeDef:
906
902
  """
907
903
  Updates the description for the host key that's specified by the
@@ -912,7 +908,7 @@ class TransferClient(BaseClient):
912
908
  """
913
909
 
914
910
  def update_profile(
915
- self, **kwargs: Unpack[UpdateProfileRequestRequestTypeDef]
911
+ self, **kwargs: Unpack[UpdateProfileRequestTypeDef]
916
912
  ) -> UpdateProfileResponseTypeDef:
917
913
  """
918
914
  Updates some of the parameters for an existing profile.
@@ -922,7 +918,7 @@ class TransferClient(BaseClient):
922
918
  """
923
919
 
924
920
  def update_server(
925
- self, **kwargs: Unpack[UpdateServerRequestRequestTypeDef]
921
+ self, **kwargs: Unpack[UpdateServerRequestTypeDef]
926
922
  ) -> UpdateServerResponseTypeDef:
927
923
  """
928
924
  Updates the file transfer protocol-enabled server's properties after that
@@ -932,9 +928,7 @@ class TransferClient(BaseClient):
932
928
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_server)
933
929
  """
934
930
 
935
- def update_user(
936
- self, **kwargs: Unpack[UpdateUserRequestRequestTypeDef]
937
- ) -> UpdateUserResponseTypeDef:
931
+ def update_user(self, **kwargs: Unpack[UpdateUserRequestTypeDef]) -> UpdateUserResponseTypeDef:
938
932
  """
939
933
  Assigns new properties to a user.
940
934
 
@@ -943,7 +937,7 @@ class TransferClient(BaseClient):
943
937
  """
944
938
 
945
939
  def update_web_app(
946
- self, **kwargs: Unpack[UpdateWebAppRequestRequestTypeDef]
940
+ self, **kwargs: Unpack[UpdateWebAppRequestTypeDef]
947
941
  ) -> UpdateWebAppResponseTypeDef:
948
942
  """
949
943
  Assigns new properties to a web app.
@@ -953,7 +947,7 @@ class TransferClient(BaseClient):
953
947
  """
954
948
 
955
949
  def update_web_app_customization(
956
- self, **kwargs: Unpack[UpdateWebAppCustomizationRequestRequestTypeDef]
950
+ self, **kwargs: Unpack[UpdateWebAppCustomizationRequestTypeDef]
957
951
  ) -> UpdateWebAppCustomizationResponseTypeDef:
958
952
  """
959
953
  Assigns new customization properties to a web app.