mypy-boto3-transfer 1.35.0__py3-none-any.whl → 1.35.40__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.
@@ -15,27 +15,17 @@ Usage::
15
15
  """
16
16
 
17
17
  import sys
18
- from typing import Any, Dict, Mapping, Sequence, Type, overload
18
+ from typing import Any, Dict, Mapping, Type, overload
19
19
 
20
20
  from botocore.client import BaseClient, ClientMeta
21
21
 
22
- from .literals import (
23
- AgreementStatusTypeType,
24
- CertificateUsageTypeType,
25
- CustomStepStatusType,
26
- DomainType,
27
- EndpointTypeType,
28
- HomeDirectoryTypeType,
29
- IdentityProviderTypeType,
30
- ProfileTypeType,
31
- ProtocolType,
32
- )
33
22
  from .paginator import (
34
23
  ListAccessesPaginator,
35
24
  ListAgreementsPaginator,
36
25
  ListCertificatesPaginator,
37
26
  ListConnectorsPaginator,
38
27
  ListExecutionsPaginator,
28
+ ListFileTransferResultsPaginator,
39
29
  ListProfilesPaginator,
40
30
  ListSecurityPoliciesPaginator,
41
31
  ListServersPaginator,
@@ -44,71 +34,121 @@ from .paginator import (
44
34
  ListWorkflowsPaginator,
45
35
  )
46
36
  from .type_defs import (
47
- As2ConnectorConfigTypeDef,
37
+ CreateAccessRequestRequestTypeDef,
48
38
  CreateAccessResponseTypeDef,
39
+ CreateAgreementRequestRequestTypeDef,
49
40
  CreateAgreementResponseTypeDef,
41
+ CreateConnectorRequestRequestTypeDef,
50
42
  CreateConnectorResponseTypeDef,
43
+ CreateProfileRequestRequestTypeDef,
51
44
  CreateProfileResponseTypeDef,
45
+ CreateServerRequestRequestTypeDef,
52
46
  CreateServerResponseTypeDef,
47
+ CreateUserRequestRequestTypeDef,
53
48
  CreateUserResponseTypeDef,
49
+ CreateWorkflowRequestRequestTypeDef,
54
50
  CreateWorkflowResponseTypeDef,
51
+ DeleteAccessRequestRequestTypeDef,
52
+ DeleteAgreementRequestRequestTypeDef,
53
+ DeleteCertificateRequestRequestTypeDef,
54
+ DeleteConnectorRequestRequestTypeDef,
55
+ DeleteHostKeyRequestRequestTypeDef,
56
+ DeleteProfileRequestRequestTypeDef,
57
+ DeleteServerRequestRequestTypeDef,
58
+ DeleteSshPublicKeyRequestRequestTypeDef,
59
+ DeleteUserRequestRequestTypeDef,
60
+ DeleteWorkflowRequestRequestTypeDef,
61
+ DescribeAccessRequestRequestTypeDef,
55
62
  DescribeAccessResponseTypeDef,
63
+ DescribeAgreementRequestRequestTypeDef,
56
64
  DescribeAgreementResponseTypeDef,
65
+ DescribeCertificateRequestRequestTypeDef,
57
66
  DescribeCertificateResponseTypeDef,
67
+ DescribeConnectorRequestRequestTypeDef,
58
68
  DescribeConnectorResponseTypeDef,
69
+ DescribeExecutionRequestRequestTypeDef,
59
70
  DescribeExecutionResponseTypeDef,
71
+ DescribeHostKeyRequestRequestTypeDef,
60
72
  DescribeHostKeyResponseTypeDef,
73
+ DescribeProfileRequestRequestTypeDef,
61
74
  DescribeProfileResponseTypeDef,
75
+ DescribeSecurityPolicyRequestRequestTypeDef,
62
76
  DescribeSecurityPolicyResponseTypeDef,
77
+ DescribeServerRequestRequestTypeDef,
63
78
  DescribeServerResponseTypeDef,
79
+ DescribeUserRequestRequestTypeDef,
64
80
  DescribeUserResponseTypeDef,
81
+ DescribeWorkflowRequestRequestTypeDef,
65
82
  DescribeWorkflowResponseTypeDef,
66
83
  EmptyResponseMetadataTypeDef,
67
- EndpointDetailsUnionTypeDef,
68
- HomeDirectoryMapEntryTypeDef,
69
- IdentityProviderDetailsTypeDef,
84
+ ImportCertificateRequestRequestTypeDef,
70
85
  ImportCertificateResponseTypeDef,
86
+ ImportHostKeyRequestRequestTypeDef,
71
87
  ImportHostKeyResponseTypeDef,
88
+ ImportSshPublicKeyRequestRequestTypeDef,
72
89
  ImportSshPublicKeyResponseTypeDef,
90
+ ListAccessesRequestRequestTypeDef,
73
91
  ListAccessesResponseTypeDef,
92
+ ListAgreementsRequestRequestTypeDef,
74
93
  ListAgreementsResponseTypeDef,
94
+ ListCertificatesRequestRequestTypeDef,
75
95
  ListCertificatesResponseTypeDef,
96
+ ListConnectorsRequestRequestTypeDef,
76
97
  ListConnectorsResponseTypeDef,
98
+ ListExecutionsRequestRequestTypeDef,
77
99
  ListExecutionsResponseTypeDef,
100
+ ListFileTransferResultsRequestRequestTypeDef,
101
+ ListFileTransferResultsResponseTypeDef,
102
+ ListHostKeysRequestRequestTypeDef,
78
103
  ListHostKeysResponseTypeDef,
104
+ ListProfilesRequestRequestTypeDef,
79
105
  ListProfilesResponseTypeDef,
106
+ ListSecurityPoliciesRequestRequestTypeDef,
80
107
  ListSecurityPoliciesResponseTypeDef,
108
+ ListServersRequestRequestTypeDef,
81
109
  ListServersResponseTypeDef,
110
+ ListTagsForResourceRequestRequestTypeDef,
82
111
  ListTagsForResourceResponseTypeDef,
112
+ ListUsersRequestRequestTypeDef,
83
113
  ListUsersResponseTypeDef,
114
+ ListWorkflowsRequestRequestTypeDef,
84
115
  ListWorkflowsResponseTypeDef,
85
- PosixProfileUnionTypeDef,
86
- ProtocolDetailsUnionTypeDef,
87
- S3StorageOptionsTypeDef,
88
- SftpConnectorConfigUnionTypeDef,
116
+ SendWorkflowStepStateRequestRequestTypeDef,
117
+ StartDirectoryListingRequestRequestTypeDef,
89
118
  StartDirectoryListingResponseTypeDef,
119
+ StartFileTransferRequestRequestTypeDef,
90
120
  StartFileTransferResponseTypeDef,
91
- TagTypeDef,
121
+ StartServerRequestRequestTypeDef,
122
+ StopServerRequestRequestTypeDef,
123
+ TagResourceRequestRequestTypeDef,
124
+ TestConnectionRequestRequestTypeDef,
92
125
  TestConnectionResponseTypeDef,
126
+ TestIdentityProviderRequestRequestTypeDef,
93
127
  TestIdentityProviderResponseTypeDef,
94
- TimestampTypeDef,
128
+ UntagResourceRequestRequestTypeDef,
129
+ UpdateAccessRequestRequestTypeDef,
95
130
  UpdateAccessResponseTypeDef,
131
+ UpdateAgreementRequestRequestTypeDef,
96
132
  UpdateAgreementResponseTypeDef,
133
+ UpdateCertificateRequestRequestTypeDef,
97
134
  UpdateCertificateResponseTypeDef,
135
+ UpdateConnectorRequestRequestTypeDef,
98
136
  UpdateConnectorResponseTypeDef,
137
+ UpdateHostKeyRequestRequestTypeDef,
99
138
  UpdateHostKeyResponseTypeDef,
139
+ UpdateProfileRequestRequestTypeDef,
100
140
  UpdateProfileResponseTypeDef,
141
+ UpdateServerRequestRequestTypeDef,
101
142
  UpdateServerResponseTypeDef,
143
+ UpdateUserRequestRequestTypeDef,
102
144
  UpdateUserResponseTypeDef,
103
- WorkflowDetailsUnionTypeDef,
104
- WorkflowStepUnionTypeDef,
105
145
  )
106
146
  from .waiter import ServerOfflineWaiter, ServerOnlineWaiter
107
147
 
108
148
  if sys.version_info >= (3, 12):
109
- from typing import Literal
149
+ from typing import Literal, Unpack
110
150
  else:
111
- from typing_extensions import Literal
151
+ from typing_extensions import Literal, Unpack
112
152
 
113
153
  __all__ = ("TransferClient",)
114
154
 
@@ -165,16 +205,7 @@ class TransferClient(BaseClient):
165
205
  """
166
206
 
167
207
  def create_access(
168
- self,
169
- *,
170
- Role: str,
171
- ServerId: str,
172
- ExternalId: str,
173
- HomeDirectory: str = ...,
174
- HomeDirectoryType: HomeDirectoryTypeType = ...,
175
- HomeDirectoryMappings: Sequence[HomeDirectoryMapEntryTypeDef] = ...,
176
- Policy: str = ...,
177
- PosixProfile: PosixProfileUnionTypeDef = ...,
208
+ self, **kwargs: Unpack[CreateAccessRequestRequestTypeDef]
178
209
  ) -> CreateAccessResponseTypeDef:
179
210
  """
180
211
  Used by administrators to choose which groups in the directory should have
@@ -186,16 +217,7 @@ class TransferClient(BaseClient):
186
217
  """
187
218
 
188
219
  def create_agreement(
189
- self,
190
- *,
191
- ServerId: str,
192
- LocalProfileId: str,
193
- PartnerProfileId: str,
194
- BaseDirectory: str,
195
- AccessRole: str,
196
- Description: str = ...,
197
- Status: AgreementStatusTypeType = ...,
198
- Tags: Sequence[TagTypeDef] = ...,
220
+ self, **kwargs: Unpack[CreateAgreementRequestRequestTypeDef]
199
221
  ) -> CreateAgreementResponseTypeDef:
200
222
  """
201
223
  Creates an agreement.
@@ -205,15 +227,7 @@ class TransferClient(BaseClient):
205
227
  """
206
228
 
207
229
  def create_connector(
208
- self,
209
- *,
210
- Url: str,
211
- AccessRole: str,
212
- As2Config: As2ConnectorConfigTypeDef = ...,
213
- LoggingRole: str = ...,
214
- Tags: Sequence[TagTypeDef] = ...,
215
- SftpConfig: SftpConnectorConfigUnionTypeDef = ...,
216
- SecurityPolicyName: str = ...,
230
+ self, **kwargs: Unpack[CreateConnectorRequestRequestTypeDef]
217
231
  ) -> CreateConnectorResponseTypeDef:
218
232
  """
219
233
  Creates the connector, which captures the parameters for a connection for the
@@ -225,12 +239,7 @@ class TransferClient(BaseClient):
225
239
  """
226
240
 
227
241
  def create_profile(
228
- self,
229
- *,
230
- As2Id: str,
231
- ProfileType: ProfileTypeType,
232
- CertificateIds: Sequence[str] = ...,
233
- Tags: Sequence[TagTypeDef] = ...,
242
+ self, **kwargs: Unpack[CreateProfileRequestRequestTypeDef]
234
243
  ) -> CreateProfileResponseTypeDef:
235
244
  """
236
245
  Creates the local or partner profile to use for AS2 transfers.
@@ -240,25 +249,7 @@ class TransferClient(BaseClient):
240
249
  """
241
250
 
242
251
  def create_server(
243
- self,
244
- *,
245
- Certificate: str = ...,
246
- Domain: DomainType = ...,
247
- EndpointDetails: EndpointDetailsUnionTypeDef = ...,
248
- EndpointType: EndpointTypeType = ...,
249
- HostKey: str = ...,
250
- IdentityProviderDetails: IdentityProviderDetailsTypeDef = ...,
251
- IdentityProviderType: IdentityProviderTypeType = ...,
252
- LoggingRole: str = ...,
253
- PostAuthenticationLoginBanner: str = ...,
254
- PreAuthenticationLoginBanner: str = ...,
255
- Protocols: Sequence[ProtocolType] = ...,
256
- ProtocolDetails: ProtocolDetailsUnionTypeDef = ...,
257
- SecurityPolicyName: str = ...,
258
- Tags: Sequence[TagTypeDef] = ...,
259
- WorkflowDetails: WorkflowDetailsUnionTypeDef = ...,
260
- StructuredLogDestinations: Sequence[str] = ...,
261
- S3StorageOptions: S3StorageOptionsTypeDef = ...,
252
+ self, **kwargs: Unpack[CreateServerRequestRequestTypeDef]
262
253
  ) -> CreateServerResponseTypeDef:
263
254
  """
264
255
  Instantiates an auto-scaling virtual server based on the selected file transfer
@@ -270,18 +261,7 @@ class TransferClient(BaseClient):
270
261
  """
271
262
 
272
263
  def create_user(
273
- self,
274
- *,
275
- Role: str,
276
- ServerId: str,
277
- UserName: str,
278
- HomeDirectory: str = ...,
279
- HomeDirectoryType: HomeDirectoryTypeType = ...,
280
- HomeDirectoryMappings: Sequence[HomeDirectoryMapEntryTypeDef] = ...,
281
- Policy: str = ...,
282
- PosixProfile: PosixProfileUnionTypeDef = ...,
283
- SshPublicKeyBody: str = ...,
284
- Tags: Sequence[TagTypeDef] = ...,
264
+ self, **kwargs: Unpack[CreateUserRequestRequestTypeDef]
285
265
  ) -> CreateUserResponseTypeDef:
286
266
  """
287
267
  Creates a user and associates them with an existing file transfer
@@ -293,12 +273,7 @@ class TransferClient(BaseClient):
293
273
  """
294
274
 
295
275
  def create_workflow(
296
- self,
297
- *,
298
- Steps: Sequence[WorkflowStepUnionTypeDef],
299
- Description: str = ...,
300
- OnExceptionSteps: Sequence[WorkflowStepUnionTypeDef] = ...,
301
- Tags: Sequence[TagTypeDef] = ...,
276
+ self, **kwargs: Unpack[CreateWorkflowRequestRequestTypeDef]
302
277
  ) -> CreateWorkflowResponseTypeDef:
303
278
  """
304
279
  Allows you to create a workflow with specified steps and step details the
@@ -309,7 +284,9 @@ class TransferClient(BaseClient):
309
284
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_workflow)
310
285
  """
311
286
 
312
- def delete_access(self, *, ServerId: str, ExternalId: str) -> EmptyResponseMetadataTypeDef:
287
+ def delete_access(
288
+ self, **kwargs: Unpack[DeleteAccessRequestRequestTypeDef]
289
+ ) -> EmptyResponseMetadataTypeDef:
313
290
  """
314
291
  Allows you to delete the access specified in the `ServerID` and `ExternalID`
315
292
  parameters.
@@ -318,7 +295,9 @@ class TransferClient(BaseClient):
318
295
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_access)
319
296
  """
320
297
 
321
- def delete_agreement(self, *, AgreementId: str, ServerId: str) -> EmptyResponseMetadataTypeDef:
298
+ def delete_agreement(
299
+ self, **kwargs: Unpack[DeleteAgreementRequestRequestTypeDef]
300
+ ) -> EmptyResponseMetadataTypeDef:
322
301
  """
323
302
  Delete the agreement that's specified in the provided `AgreementId`.
324
303
 
@@ -326,7 +305,9 @@ class TransferClient(BaseClient):
326
305
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_agreement)
327
306
  """
328
307
 
329
- def delete_certificate(self, *, CertificateId: str) -> EmptyResponseMetadataTypeDef:
308
+ def delete_certificate(
309
+ self, **kwargs: Unpack[DeleteCertificateRequestRequestTypeDef]
310
+ ) -> EmptyResponseMetadataTypeDef:
330
311
  """
331
312
  Deletes the certificate that's specified in the `CertificateId` parameter.
332
313
 
@@ -334,7 +315,9 @@ class TransferClient(BaseClient):
334
315
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_certificate)
335
316
  """
336
317
 
337
- def delete_connector(self, *, ConnectorId: str) -> EmptyResponseMetadataTypeDef:
318
+ def delete_connector(
319
+ self, **kwargs: Unpack[DeleteConnectorRequestRequestTypeDef]
320
+ ) -> EmptyResponseMetadataTypeDef:
338
321
  """
339
322
  Deletes the connector that's specified in the provided `ConnectorId`.
340
323
 
@@ -342,7 +325,9 @@ class TransferClient(BaseClient):
342
325
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_connector)
343
326
  """
344
327
 
345
- def delete_host_key(self, *, ServerId: str, HostKeyId: str) -> EmptyResponseMetadataTypeDef:
328
+ def delete_host_key(
329
+ self, **kwargs: Unpack[DeleteHostKeyRequestRequestTypeDef]
330
+ ) -> EmptyResponseMetadataTypeDef:
346
331
  """
347
332
  Deletes the host key that's specified in the `HostKeyId` parameter.
348
333
 
@@ -350,7 +335,9 @@ class TransferClient(BaseClient):
350
335
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_host_key)
351
336
  """
352
337
 
353
- def delete_profile(self, *, ProfileId: str) -> EmptyResponseMetadataTypeDef:
338
+ def delete_profile(
339
+ self, **kwargs: Unpack[DeleteProfileRequestRequestTypeDef]
340
+ ) -> EmptyResponseMetadataTypeDef:
354
341
  """
355
342
  Deletes the profile that's specified in the `ProfileId` parameter.
356
343
 
@@ -358,7 +345,9 @@ class TransferClient(BaseClient):
358
345
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_profile)
359
346
  """
360
347
 
361
- def delete_server(self, *, ServerId: str) -> EmptyResponseMetadataTypeDef:
348
+ def delete_server(
349
+ self, **kwargs: Unpack[DeleteServerRequestRequestTypeDef]
350
+ ) -> EmptyResponseMetadataTypeDef:
362
351
  """
363
352
  Deletes the file transfer protocol-enabled server that you specify.
364
353
 
@@ -367,7 +356,7 @@ class TransferClient(BaseClient):
367
356
  """
368
357
 
369
358
  def delete_ssh_public_key(
370
- self, *, ServerId: str, SshPublicKeyId: str, UserName: str
359
+ self, **kwargs: Unpack[DeleteSshPublicKeyRequestRequestTypeDef]
371
360
  ) -> EmptyResponseMetadataTypeDef:
372
361
  """
373
362
  Deletes a user's Secure Shell (SSH) public key.
@@ -376,7 +365,9 @@ class TransferClient(BaseClient):
376
365
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_ssh_public_key)
377
366
  """
378
367
 
379
- def delete_user(self, *, ServerId: str, UserName: str) -> EmptyResponseMetadataTypeDef:
368
+ def delete_user(
369
+ self, **kwargs: Unpack[DeleteUserRequestRequestTypeDef]
370
+ ) -> EmptyResponseMetadataTypeDef:
380
371
  """
381
372
  Deletes the user belonging to a file transfer protocol-enabled server you
382
373
  specify.
@@ -385,7 +376,9 @@ class TransferClient(BaseClient):
385
376
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_user)
386
377
  """
387
378
 
388
- def delete_workflow(self, *, WorkflowId: str) -> EmptyResponseMetadataTypeDef:
379
+ def delete_workflow(
380
+ self, **kwargs: Unpack[DeleteWorkflowRequestRequestTypeDef]
381
+ ) -> EmptyResponseMetadataTypeDef:
389
382
  """
390
383
  Deletes the specified workflow.
391
384
 
@@ -393,7 +386,9 @@ class TransferClient(BaseClient):
393
386
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_workflow)
394
387
  """
395
388
 
396
- def describe_access(self, *, ServerId: str, ExternalId: str) -> DescribeAccessResponseTypeDef:
389
+ def describe_access(
390
+ self, **kwargs: Unpack[DescribeAccessRequestRequestTypeDef]
391
+ ) -> DescribeAccessResponseTypeDef:
397
392
  """
398
393
  Describes the access that is assigned to the specific file transfer
399
394
  protocol-enabled server, as identified by its `ServerId` property and its
@@ -404,7 +399,7 @@ class TransferClient(BaseClient):
404
399
  """
405
400
 
406
401
  def describe_agreement(
407
- self, *, AgreementId: str, ServerId: str
402
+ self, **kwargs: Unpack[DescribeAgreementRequestRequestTypeDef]
408
403
  ) -> DescribeAgreementResponseTypeDef:
409
404
  """
410
405
  Describes the agreement that's identified by the `AgreementId`.
@@ -413,7 +408,9 @@ class TransferClient(BaseClient):
413
408
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_agreement)
414
409
  """
415
410
 
416
- def describe_certificate(self, *, CertificateId: str) -> DescribeCertificateResponseTypeDef:
411
+ def describe_certificate(
412
+ self, **kwargs: Unpack[DescribeCertificateRequestRequestTypeDef]
413
+ ) -> DescribeCertificateResponseTypeDef:
417
414
  """
418
415
  Describes the certificate that's identified by the `CertificateId`.
419
416
 
@@ -421,7 +418,9 @@ class TransferClient(BaseClient):
421
418
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_certificate)
422
419
  """
423
420
 
424
- def describe_connector(self, *, ConnectorId: str) -> DescribeConnectorResponseTypeDef:
421
+ def describe_connector(
422
+ self, **kwargs: Unpack[DescribeConnectorRequestRequestTypeDef]
423
+ ) -> DescribeConnectorResponseTypeDef:
425
424
  """
426
425
  Describes the connector that's identified by the `ConnectorId.` See also: [AWS
427
426
  API
@@ -432,7 +431,7 @@ class TransferClient(BaseClient):
432
431
  """
433
432
 
434
433
  def describe_execution(
435
- self, *, ExecutionId: str, WorkflowId: str
434
+ self, **kwargs: Unpack[DescribeExecutionRequestRequestTypeDef]
436
435
  ) -> DescribeExecutionResponseTypeDef:
437
436
  """
438
437
  You can use `DescribeExecution` to check the details of the execution of the
@@ -443,7 +442,9 @@ class TransferClient(BaseClient):
443
442
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_execution)
444
443
  """
445
444
 
446
- def describe_host_key(self, *, ServerId: str, HostKeyId: str) -> DescribeHostKeyResponseTypeDef:
445
+ def describe_host_key(
446
+ self, **kwargs: Unpack[DescribeHostKeyRequestRequestTypeDef]
447
+ ) -> DescribeHostKeyResponseTypeDef:
447
448
  """
448
449
  Returns the details of the host key that's specified by the `HostKeyId` and
449
450
  `ServerId`.
@@ -452,7 +453,9 @@ class TransferClient(BaseClient):
452
453
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_host_key)
453
454
  """
454
455
 
455
- def describe_profile(self, *, ProfileId: str) -> DescribeProfileResponseTypeDef:
456
+ def describe_profile(
457
+ self, **kwargs: Unpack[DescribeProfileRequestRequestTypeDef]
458
+ ) -> DescribeProfileResponseTypeDef:
456
459
  """
457
460
  Returns the details of the profile that's specified by the `ProfileId`.
458
461
 
@@ -461,7 +464,7 @@ class TransferClient(BaseClient):
461
464
  """
462
465
 
463
466
  def describe_security_policy(
464
- self, *, SecurityPolicyName: str
467
+ self, **kwargs: Unpack[DescribeSecurityPolicyRequestRequestTypeDef]
465
468
  ) -> DescribeSecurityPolicyResponseTypeDef:
466
469
  """
467
470
  Describes the security policy that is attached to your server or SFTP connector.
@@ -470,7 +473,9 @@ class TransferClient(BaseClient):
470
473
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_security_policy)
471
474
  """
472
475
 
473
- def describe_server(self, *, ServerId: str) -> DescribeServerResponseTypeDef:
476
+ def describe_server(
477
+ self, **kwargs: Unpack[DescribeServerRequestRequestTypeDef]
478
+ ) -> DescribeServerResponseTypeDef:
474
479
  """
475
480
  Describes a file transfer protocol-enabled server that you specify by passing
476
481
  the `ServerId`
@@ -480,7 +485,9 @@ class TransferClient(BaseClient):
480
485
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_server)
481
486
  """
482
487
 
483
- def describe_user(self, *, ServerId: str, UserName: str) -> DescribeUserResponseTypeDef:
488
+ def describe_user(
489
+ self, **kwargs: Unpack[DescribeUserRequestRequestTypeDef]
490
+ ) -> DescribeUserResponseTypeDef:
484
491
  """
485
492
  Describes the user assigned to the specific file transfer protocol-enabled
486
493
  server, as identified by its `ServerId`
@@ -490,7 +497,9 @@ class TransferClient(BaseClient):
490
497
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_user)
491
498
  """
492
499
 
493
- def describe_workflow(self, *, WorkflowId: str) -> DescribeWorkflowResponseTypeDef:
500
+ def describe_workflow(
501
+ self, **kwargs: Unpack[DescribeWorkflowRequestRequestTypeDef]
502
+ ) -> DescribeWorkflowResponseTypeDef:
494
503
  """
495
504
  Describes the specified workflow.
496
505
 
@@ -513,16 +522,7 @@ class TransferClient(BaseClient):
513
522
  """
514
523
 
515
524
  def import_certificate(
516
- self,
517
- *,
518
- Usage: CertificateUsageTypeType,
519
- Certificate: str,
520
- CertificateChain: str = ...,
521
- PrivateKey: str = ...,
522
- ActiveDate: TimestampTypeDef = ...,
523
- InactiveDate: TimestampTypeDef = ...,
524
- Description: str = ...,
525
- Tags: Sequence[TagTypeDef] = ...,
525
+ self, **kwargs: Unpack[ImportCertificateRequestRequestTypeDef]
526
526
  ) -> ImportCertificateResponseTypeDef:
527
527
  """
528
528
  Imports the signing and encryption certificates that you need to create local
@@ -534,12 +534,7 @@ class TransferClient(BaseClient):
534
534
  """
535
535
 
536
536
  def import_host_key(
537
- self,
538
- *,
539
- ServerId: str,
540
- HostKeyBody: str,
541
- Description: str = ...,
542
- Tags: Sequence[TagTypeDef] = ...,
537
+ self, **kwargs: Unpack[ImportHostKeyRequestRequestTypeDef]
543
538
  ) -> ImportHostKeyResponseTypeDef:
544
539
  """
545
540
  Adds a host key to the server that's specified by the `ServerId` parameter.
@@ -549,7 +544,7 @@ class TransferClient(BaseClient):
549
544
  """
550
545
 
551
546
  def import_ssh_public_key(
552
- self, *, ServerId: str, SshPublicKeyBody: str, UserName: str
547
+ self, **kwargs: Unpack[ImportSshPublicKeyRequestRequestTypeDef]
553
548
  ) -> ImportSshPublicKeyResponseTypeDef:
554
549
  """
555
550
  Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a
@@ -562,7 +557,7 @@ class TransferClient(BaseClient):
562
557
  """
563
558
 
564
559
  def list_accesses(
565
- self, *, ServerId: str, MaxResults: int = ..., NextToken: str = ...
560
+ self, **kwargs: Unpack[ListAccessesRequestRequestTypeDef]
566
561
  ) -> ListAccessesResponseTypeDef:
567
562
  """
568
563
  Lists the details for all the accesses you have on your server.
@@ -572,7 +567,7 @@ class TransferClient(BaseClient):
572
567
  """
573
568
 
574
569
  def list_agreements(
575
- self, *, ServerId: str, MaxResults: int = ..., NextToken: str = ...
570
+ self, **kwargs: Unpack[ListAgreementsRequestRequestTypeDef]
576
571
  ) -> ListAgreementsResponseTypeDef:
577
572
  """
578
573
  Returns a list of the agreements for the server that's identified by the
@@ -584,7 +579,7 @@ class TransferClient(BaseClient):
584
579
  """
585
580
 
586
581
  def list_certificates(
587
- self, *, MaxResults: int = ..., NextToken: str = ...
582
+ self, **kwargs: Unpack[ListCertificatesRequestRequestTypeDef]
588
583
  ) -> ListCertificatesResponseTypeDef:
589
584
  """
590
585
  Returns a list of the current certificates that have been imported into
@@ -596,7 +591,7 @@ class TransferClient(BaseClient):
596
591
  """
597
592
 
598
593
  def list_connectors(
599
- self, *, MaxResults: int = ..., NextToken: str = ...
594
+ self, **kwargs: Unpack[ListConnectorsRequestRequestTypeDef]
600
595
  ) -> ListConnectorsResponseTypeDef:
601
596
  """
602
597
  Lists the connectors for the specified Region.
@@ -606,7 +601,7 @@ class TransferClient(BaseClient):
606
601
  """
607
602
 
608
603
  def list_executions(
609
- self, *, WorkflowId: str, MaxResults: int = ..., NextToken: str = ...
604
+ self, **kwargs: Unpack[ListExecutionsRequestRequestTypeDef]
610
605
  ) -> ListExecutionsResponseTypeDef:
611
606
  """
612
607
  Lists all in-progress executions for the specified workflow.
@@ -615,8 +610,20 @@ class TransferClient(BaseClient):
615
610
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_executions)
616
611
  """
617
612
 
613
+ def list_file_transfer_results(
614
+ self, **kwargs: Unpack[ListFileTransferResultsRequestRequestTypeDef]
615
+ ) -> ListFileTransferResultsResponseTypeDef:
616
+ """
617
+ Returns real-time updates and detailed information on the status of each
618
+ individual file being transferred in a specific file transfer
619
+ operation.
620
+
621
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.list_file_transfer_results)
622
+ [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_file_transfer_results)
623
+ """
624
+
618
625
  def list_host_keys(
619
- self, *, ServerId: str, MaxResults: int = ..., NextToken: str = ...
626
+ self, **kwargs: Unpack[ListHostKeysRequestRequestTypeDef]
620
627
  ) -> ListHostKeysResponseTypeDef:
621
628
  """
622
629
  Returns a list of host keys for the server that's specified by the `ServerId`
@@ -627,7 +634,7 @@ class TransferClient(BaseClient):
627
634
  """
628
635
 
629
636
  def list_profiles(
630
- self, *, MaxResults: int = ..., NextToken: str = ..., ProfileType: ProfileTypeType = ...
637
+ self, **kwargs: Unpack[ListProfilesRequestRequestTypeDef]
631
638
  ) -> ListProfilesResponseTypeDef:
632
639
  """
633
640
  Returns a list of the profiles for your system.
@@ -637,7 +644,7 @@ class TransferClient(BaseClient):
637
644
  """
638
645
 
639
646
  def list_security_policies(
640
- self, *, MaxResults: int = ..., NextToken: str = ...
647
+ self, **kwargs: Unpack[ListSecurityPoliciesRequestRequestTypeDef]
641
648
  ) -> ListSecurityPoliciesResponseTypeDef:
642
649
  """
643
650
  Lists the security policies that are attached to your servers and SFTP
@@ -648,7 +655,7 @@ class TransferClient(BaseClient):
648
655
  """
649
656
 
650
657
  def list_servers(
651
- self, *, MaxResults: int = ..., NextToken: str = ...
658
+ self, **kwargs: Unpack[ListServersRequestRequestTypeDef]
652
659
  ) -> ListServersResponseTypeDef:
653
660
  """
654
661
  Lists the file transfer protocol-enabled servers that are associated with your
@@ -660,7 +667,7 @@ class TransferClient(BaseClient):
660
667
  """
661
668
 
662
669
  def list_tags_for_resource(
663
- self, *, Arn: str, MaxResults: int = ..., NextToken: str = ...
670
+ self, **kwargs: Unpack[ListTagsForResourceRequestRequestTypeDef]
664
671
  ) -> ListTagsForResourceResponseTypeDef:
665
672
  """
666
673
  Lists all of the tags associated with the Amazon Resource Name (ARN) that you
@@ -671,7 +678,7 @@ class TransferClient(BaseClient):
671
678
  """
672
679
 
673
680
  def list_users(
674
- self, *, ServerId: str, MaxResults: int = ..., NextToken: str = ...
681
+ self, **kwargs: Unpack[ListUsersRequestRequestTypeDef]
675
682
  ) -> ListUsersResponseTypeDef:
676
683
  """
677
684
  Lists the users for a file transfer protocol-enabled server that you specify by
@@ -683,7 +690,7 @@ class TransferClient(BaseClient):
683
690
  """
684
691
 
685
692
  def list_workflows(
686
- self, *, MaxResults: int = ..., NextToken: str = ...
693
+ self, **kwargs: Unpack[ListWorkflowsRequestRequestTypeDef]
687
694
  ) -> ListWorkflowsResponseTypeDef:
688
695
  """
689
696
  Lists all workflows associated with your Amazon Web Services account for your
@@ -695,7 +702,7 @@ class TransferClient(BaseClient):
695
702
  """
696
703
 
697
704
  def send_workflow_step_state(
698
- self, *, WorkflowId: str, ExecutionId: str, Token: str, Status: CustomStepStatusType
705
+ self, **kwargs: Unpack[SendWorkflowStepStateRequestRequestTypeDef]
699
706
  ) -> Dict[str, Any]:
700
707
  """
701
708
  Sends a callback for asynchronous custom steps.
@@ -705,12 +712,7 @@ class TransferClient(BaseClient):
705
712
  """
706
713
 
707
714
  def start_directory_listing(
708
- self,
709
- *,
710
- ConnectorId: str,
711
- RemoteDirectoryPath: str,
712
- OutputDirectoryPath: str,
713
- MaxItems: int = ...,
715
+ self, **kwargs: Unpack[StartDirectoryListingRequestRequestTypeDef]
714
716
  ) -> StartDirectoryListingResponseTypeDef:
715
717
  """
716
718
  Retrieves a list of the contents of a directory from a remote SFTP server.
@@ -720,13 +722,7 @@ class TransferClient(BaseClient):
720
722
  """
721
723
 
722
724
  def start_file_transfer(
723
- self,
724
- *,
725
- ConnectorId: str,
726
- SendFilePaths: Sequence[str] = ...,
727
- RetrieveFilePaths: Sequence[str] = ...,
728
- LocalDirectoryPath: str = ...,
729
- RemoteDirectoryPath: str = ...,
725
+ self, **kwargs: Unpack[StartFileTransferRequestRequestTypeDef]
730
726
  ) -> StartFileTransferResponseTypeDef:
731
727
  """
732
728
  Begins a file transfer between local Amazon Web Services storage and a remote
@@ -737,7 +733,9 @@ class TransferClient(BaseClient):
737
733
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#start_file_transfer)
738
734
  """
739
735
 
740
- def start_server(self, *, ServerId: str) -> EmptyResponseMetadataTypeDef:
736
+ def start_server(
737
+ self, **kwargs: Unpack[StartServerRequestRequestTypeDef]
738
+ ) -> EmptyResponseMetadataTypeDef:
741
739
  """
742
740
  Changes the state of a file transfer protocol-enabled server from `OFFLINE` to
743
741
  `ONLINE`.
@@ -746,7 +744,9 @@ class TransferClient(BaseClient):
746
744
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#start_server)
747
745
  """
748
746
 
749
- def stop_server(self, *, ServerId: str) -> EmptyResponseMetadataTypeDef:
747
+ def stop_server(
748
+ self, **kwargs: Unpack[StopServerRequestRequestTypeDef]
749
+ ) -> EmptyResponseMetadataTypeDef:
750
750
  """
751
751
  Changes the state of a file transfer protocol-enabled server from `ONLINE` to
752
752
  `OFFLINE`.
@@ -755,7 +755,9 @@ class TransferClient(BaseClient):
755
755
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#stop_server)
756
756
  """
757
757
 
758
- def tag_resource(self, *, Arn: str, Tags: Sequence[TagTypeDef]) -> EmptyResponseMetadataTypeDef:
758
+ def tag_resource(
759
+ self, **kwargs: Unpack[TagResourceRequestRequestTypeDef]
760
+ ) -> EmptyResponseMetadataTypeDef:
759
761
  """
760
762
  Attaches a key-value pair to a resource, as identified by its Amazon Resource
761
763
  Name
@@ -765,7 +767,9 @@ class TransferClient(BaseClient):
765
767
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#tag_resource)
766
768
  """
767
769
 
768
- def test_connection(self, *, ConnectorId: str) -> TestConnectionResponseTypeDef:
770
+ def test_connection(
771
+ self, **kwargs: Unpack[TestConnectionRequestRequestTypeDef]
772
+ ) -> TestConnectionResponseTypeDef:
769
773
  """
770
774
  Tests whether your SFTP connector is set up successfully.
771
775
 
@@ -774,13 +778,7 @@ class TransferClient(BaseClient):
774
778
  """
775
779
 
776
780
  def test_identity_provider(
777
- self,
778
- *,
779
- ServerId: str,
780
- UserName: str,
781
- ServerProtocol: ProtocolType = ...,
782
- SourceIp: str = ...,
783
- UserPassword: str = ...,
781
+ self, **kwargs: Unpack[TestIdentityProviderRequestRequestTypeDef]
784
782
  ) -> TestIdentityProviderResponseTypeDef:
785
783
  """
786
784
  If the `IdentityProviderType` of a file transfer protocol-enabled server is
@@ -792,7 +790,9 @@ class TransferClient(BaseClient):
792
790
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#test_identity_provider)
793
791
  """
794
792
 
795
- def untag_resource(self, *, Arn: str, TagKeys: Sequence[str]) -> EmptyResponseMetadataTypeDef:
793
+ def untag_resource(
794
+ self, **kwargs: Unpack[UntagResourceRequestRequestTypeDef]
795
+ ) -> EmptyResponseMetadataTypeDef:
796
796
  """
797
797
  Detaches a key-value pair from a resource, as identified by its Amazon Resource
798
798
  Name
@@ -803,16 +803,7 @@ class TransferClient(BaseClient):
803
803
  """
804
804
 
805
805
  def update_access(
806
- self,
807
- *,
808
- ServerId: str,
809
- ExternalId: str,
810
- HomeDirectory: str = ...,
811
- HomeDirectoryType: HomeDirectoryTypeType = ...,
812
- HomeDirectoryMappings: Sequence[HomeDirectoryMapEntryTypeDef] = ...,
813
- Policy: str = ...,
814
- PosixProfile: PosixProfileUnionTypeDef = ...,
815
- Role: str = ...,
806
+ self, **kwargs: Unpack[UpdateAccessRequestRequestTypeDef]
816
807
  ) -> UpdateAccessResponseTypeDef:
817
808
  """
818
809
  Allows you to update parameters for the access specified in the `ServerID` and
@@ -824,16 +815,7 @@ class TransferClient(BaseClient):
824
815
  """
825
816
 
826
817
  def update_agreement(
827
- self,
828
- *,
829
- AgreementId: str,
830
- ServerId: str,
831
- Description: str = ...,
832
- Status: AgreementStatusTypeType = ...,
833
- LocalProfileId: str = ...,
834
- PartnerProfileId: str = ...,
835
- BaseDirectory: str = ...,
836
- AccessRole: str = ...,
818
+ self, **kwargs: Unpack[UpdateAgreementRequestRequestTypeDef]
837
819
  ) -> UpdateAgreementResponseTypeDef:
838
820
  """
839
821
  Updates some of the parameters for an existing agreement.
@@ -843,12 +825,7 @@ class TransferClient(BaseClient):
843
825
  """
844
826
 
845
827
  def update_certificate(
846
- self,
847
- *,
848
- CertificateId: str,
849
- ActiveDate: TimestampTypeDef = ...,
850
- InactiveDate: TimestampTypeDef = ...,
851
- Description: str = ...,
828
+ self, **kwargs: Unpack[UpdateCertificateRequestRequestTypeDef]
852
829
  ) -> UpdateCertificateResponseTypeDef:
853
830
  """
854
831
  Updates the active and inactive dates for a certificate.
@@ -858,15 +835,7 @@ class TransferClient(BaseClient):
858
835
  """
859
836
 
860
837
  def update_connector(
861
- self,
862
- *,
863
- ConnectorId: str,
864
- Url: str = ...,
865
- As2Config: As2ConnectorConfigTypeDef = ...,
866
- AccessRole: str = ...,
867
- LoggingRole: str = ...,
868
- SftpConfig: SftpConnectorConfigUnionTypeDef = ...,
869
- SecurityPolicyName: str = ...,
838
+ self, **kwargs: Unpack[UpdateConnectorRequestRequestTypeDef]
870
839
  ) -> UpdateConnectorResponseTypeDef:
871
840
  """
872
841
  Updates some of the parameters for an existing connector.
@@ -876,7 +845,7 @@ class TransferClient(BaseClient):
876
845
  """
877
846
 
878
847
  def update_host_key(
879
- self, *, ServerId: str, HostKeyId: str, Description: str
848
+ self, **kwargs: Unpack[UpdateHostKeyRequestRequestTypeDef]
880
849
  ) -> UpdateHostKeyResponseTypeDef:
881
850
  """
882
851
  Updates the description for the host key that's specified by the `ServerId` and
@@ -888,7 +857,7 @@ class TransferClient(BaseClient):
888
857
  """
889
858
 
890
859
  def update_profile(
891
- self, *, ProfileId: str, CertificateIds: Sequence[str] = ...
860
+ self, **kwargs: Unpack[UpdateProfileRequestRequestTypeDef]
892
861
  ) -> UpdateProfileResponseTypeDef:
893
862
  """
894
863
  Updates some of the parameters for an existing profile.
@@ -898,23 +867,7 @@ class TransferClient(BaseClient):
898
867
  """
899
868
 
900
869
  def update_server(
901
- self,
902
- *,
903
- ServerId: str,
904
- Certificate: str = ...,
905
- ProtocolDetails: ProtocolDetailsUnionTypeDef = ...,
906
- EndpointDetails: EndpointDetailsUnionTypeDef = ...,
907
- EndpointType: EndpointTypeType = ...,
908
- HostKey: str = ...,
909
- IdentityProviderDetails: IdentityProviderDetailsTypeDef = ...,
910
- LoggingRole: str = ...,
911
- PostAuthenticationLoginBanner: str = ...,
912
- PreAuthenticationLoginBanner: str = ...,
913
- Protocols: Sequence[ProtocolType] = ...,
914
- SecurityPolicyName: str = ...,
915
- WorkflowDetails: WorkflowDetailsUnionTypeDef = ...,
916
- StructuredLogDestinations: Sequence[str] = ...,
917
- S3StorageOptions: S3StorageOptionsTypeDef = ...,
870
+ self, **kwargs: Unpack[UpdateServerRequestRequestTypeDef]
918
871
  ) -> UpdateServerResponseTypeDef:
919
872
  """
920
873
  Updates the file transfer protocol-enabled server's properties after that
@@ -926,16 +879,7 @@ class TransferClient(BaseClient):
926
879
  """
927
880
 
928
881
  def update_user(
929
- self,
930
- *,
931
- ServerId: str,
932
- UserName: str,
933
- HomeDirectory: str = ...,
934
- HomeDirectoryType: HomeDirectoryTypeType = ...,
935
- HomeDirectoryMappings: Sequence[HomeDirectoryMapEntryTypeDef] = ...,
936
- Policy: str = ...,
937
- PosixProfile: PosixProfileUnionTypeDef = ...,
938
- Role: str = ...,
882
+ self, **kwargs: Unpack[UpdateUserRequestRequestTypeDef]
939
883
  ) -> UpdateUserResponseTypeDef:
940
884
  """
941
885
  Assigns new properties to a user.
@@ -981,6 +925,15 @@ class TransferClient(BaseClient):
981
925
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
982
926
  """
983
927
 
928
+ @overload
929
+ def get_paginator(
930
+ self, operation_name: Literal["list_file_transfer_results"]
931
+ ) -> ListFileTransferResultsPaginator:
932
+ """
933
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.get_paginator)
934
+ [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
935
+ """
936
+
984
937
  @overload
985
938
  def get_paginator(self, operation_name: Literal["list_profiles"]) -> ListProfilesPaginator:
986
939
  """