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