mypy-boto3-transfer 1.35.0__py3-none-any.whl → 1.35.72__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12,103 +12,161 @@ Usage::
12
12
  session = Session()
13
13
  client: TransferClient = session.client("transfer")
14
14
  ```
15
+
16
+ Copyright 2024 Vlad Emelianov
15
17
  """
16
18
 
17
19
  import sys
18
- from typing import Any, Dict, Mapping, Sequence, Type, overload
20
+ from typing import Any, Dict, Mapping, Type, overload
19
21
 
20
22
  from botocore.client import BaseClient, ClientMeta
21
23
 
22
- from .literals import (
23
- AgreementStatusTypeType,
24
- CertificateUsageTypeType,
25
- CustomStepStatusType,
26
- DomainType,
27
- EndpointTypeType,
28
- HomeDirectoryTypeType,
29
- IdentityProviderTypeType,
30
- ProfileTypeType,
31
- ProtocolType,
32
- )
33
24
  from .paginator import (
34
25
  ListAccessesPaginator,
35
26
  ListAgreementsPaginator,
36
27
  ListCertificatesPaginator,
37
28
  ListConnectorsPaginator,
38
29
  ListExecutionsPaginator,
30
+ ListFileTransferResultsPaginator,
39
31
  ListProfilesPaginator,
40
32
  ListSecurityPoliciesPaginator,
41
33
  ListServersPaginator,
42
34
  ListTagsForResourcePaginator,
43
35
  ListUsersPaginator,
36
+ ListWebAppsPaginator,
44
37
  ListWorkflowsPaginator,
45
38
  )
46
39
  from .type_defs import (
47
- As2ConnectorConfigTypeDef,
40
+ CreateAccessRequestRequestTypeDef,
48
41
  CreateAccessResponseTypeDef,
42
+ CreateAgreementRequestRequestTypeDef,
49
43
  CreateAgreementResponseTypeDef,
44
+ CreateConnectorRequestRequestTypeDef,
50
45
  CreateConnectorResponseTypeDef,
46
+ CreateProfileRequestRequestTypeDef,
51
47
  CreateProfileResponseTypeDef,
48
+ CreateServerRequestRequestTypeDef,
52
49
  CreateServerResponseTypeDef,
50
+ CreateUserRequestRequestTypeDef,
53
51
  CreateUserResponseTypeDef,
52
+ CreateWebAppRequestRequestTypeDef,
53
+ CreateWebAppResponseTypeDef,
54
+ CreateWorkflowRequestRequestTypeDef,
54
55
  CreateWorkflowResponseTypeDef,
56
+ DeleteAccessRequestRequestTypeDef,
57
+ DeleteAgreementRequestRequestTypeDef,
58
+ DeleteCertificateRequestRequestTypeDef,
59
+ DeleteConnectorRequestRequestTypeDef,
60
+ DeleteHostKeyRequestRequestTypeDef,
61
+ DeleteProfileRequestRequestTypeDef,
62
+ DeleteServerRequestRequestTypeDef,
63
+ DeleteSshPublicKeyRequestRequestTypeDef,
64
+ DeleteUserRequestRequestTypeDef,
65
+ DeleteWebAppCustomizationRequestRequestTypeDef,
66
+ DeleteWebAppRequestRequestTypeDef,
67
+ DeleteWorkflowRequestRequestTypeDef,
68
+ DescribeAccessRequestRequestTypeDef,
55
69
  DescribeAccessResponseTypeDef,
70
+ DescribeAgreementRequestRequestTypeDef,
56
71
  DescribeAgreementResponseTypeDef,
72
+ DescribeCertificateRequestRequestTypeDef,
57
73
  DescribeCertificateResponseTypeDef,
74
+ DescribeConnectorRequestRequestTypeDef,
58
75
  DescribeConnectorResponseTypeDef,
76
+ DescribeExecutionRequestRequestTypeDef,
59
77
  DescribeExecutionResponseTypeDef,
78
+ DescribeHostKeyRequestRequestTypeDef,
60
79
  DescribeHostKeyResponseTypeDef,
80
+ DescribeProfileRequestRequestTypeDef,
61
81
  DescribeProfileResponseTypeDef,
82
+ DescribeSecurityPolicyRequestRequestTypeDef,
62
83
  DescribeSecurityPolicyResponseTypeDef,
84
+ DescribeServerRequestRequestTypeDef,
63
85
  DescribeServerResponseTypeDef,
86
+ DescribeUserRequestRequestTypeDef,
64
87
  DescribeUserResponseTypeDef,
88
+ DescribeWebAppCustomizationRequestRequestTypeDef,
89
+ DescribeWebAppCustomizationResponseTypeDef,
90
+ DescribeWebAppRequestRequestTypeDef,
91
+ DescribeWebAppResponseTypeDef,
92
+ DescribeWorkflowRequestRequestTypeDef,
65
93
  DescribeWorkflowResponseTypeDef,
66
94
  EmptyResponseMetadataTypeDef,
67
- EndpointDetailsUnionTypeDef,
68
- HomeDirectoryMapEntryTypeDef,
69
- IdentityProviderDetailsTypeDef,
95
+ ImportCertificateRequestRequestTypeDef,
70
96
  ImportCertificateResponseTypeDef,
97
+ ImportHostKeyRequestRequestTypeDef,
71
98
  ImportHostKeyResponseTypeDef,
99
+ ImportSshPublicKeyRequestRequestTypeDef,
72
100
  ImportSshPublicKeyResponseTypeDef,
101
+ ListAccessesRequestRequestTypeDef,
73
102
  ListAccessesResponseTypeDef,
103
+ ListAgreementsRequestRequestTypeDef,
74
104
  ListAgreementsResponseTypeDef,
105
+ ListCertificatesRequestRequestTypeDef,
75
106
  ListCertificatesResponseTypeDef,
107
+ ListConnectorsRequestRequestTypeDef,
76
108
  ListConnectorsResponseTypeDef,
109
+ ListExecutionsRequestRequestTypeDef,
77
110
  ListExecutionsResponseTypeDef,
111
+ ListFileTransferResultsRequestRequestTypeDef,
112
+ ListFileTransferResultsResponseTypeDef,
113
+ ListHostKeysRequestRequestTypeDef,
78
114
  ListHostKeysResponseTypeDef,
115
+ ListProfilesRequestRequestTypeDef,
79
116
  ListProfilesResponseTypeDef,
117
+ ListSecurityPoliciesRequestRequestTypeDef,
80
118
  ListSecurityPoliciesResponseTypeDef,
119
+ ListServersRequestRequestTypeDef,
81
120
  ListServersResponseTypeDef,
121
+ ListTagsForResourceRequestRequestTypeDef,
82
122
  ListTagsForResourceResponseTypeDef,
123
+ ListUsersRequestRequestTypeDef,
83
124
  ListUsersResponseTypeDef,
125
+ ListWebAppsRequestRequestTypeDef,
126
+ ListWebAppsResponseTypeDef,
127
+ ListWorkflowsRequestRequestTypeDef,
84
128
  ListWorkflowsResponseTypeDef,
85
- PosixProfileUnionTypeDef,
86
- ProtocolDetailsUnionTypeDef,
87
- S3StorageOptionsTypeDef,
88
- SftpConnectorConfigUnionTypeDef,
129
+ SendWorkflowStepStateRequestRequestTypeDef,
130
+ StartDirectoryListingRequestRequestTypeDef,
89
131
  StartDirectoryListingResponseTypeDef,
132
+ StartFileTransferRequestRequestTypeDef,
90
133
  StartFileTransferResponseTypeDef,
91
- TagTypeDef,
134
+ StartServerRequestRequestTypeDef,
135
+ StopServerRequestRequestTypeDef,
136
+ TagResourceRequestRequestTypeDef,
137
+ TestConnectionRequestRequestTypeDef,
92
138
  TestConnectionResponseTypeDef,
139
+ TestIdentityProviderRequestRequestTypeDef,
93
140
  TestIdentityProviderResponseTypeDef,
94
- TimestampTypeDef,
141
+ UntagResourceRequestRequestTypeDef,
142
+ UpdateAccessRequestRequestTypeDef,
95
143
  UpdateAccessResponseTypeDef,
144
+ UpdateAgreementRequestRequestTypeDef,
96
145
  UpdateAgreementResponseTypeDef,
146
+ UpdateCertificateRequestRequestTypeDef,
97
147
  UpdateCertificateResponseTypeDef,
148
+ UpdateConnectorRequestRequestTypeDef,
98
149
  UpdateConnectorResponseTypeDef,
150
+ UpdateHostKeyRequestRequestTypeDef,
99
151
  UpdateHostKeyResponseTypeDef,
152
+ UpdateProfileRequestRequestTypeDef,
100
153
  UpdateProfileResponseTypeDef,
154
+ UpdateServerRequestRequestTypeDef,
101
155
  UpdateServerResponseTypeDef,
156
+ UpdateUserRequestRequestTypeDef,
102
157
  UpdateUserResponseTypeDef,
103
- WorkflowDetailsUnionTypeDef,
104
- WorkflowStepUnionTypeDef,
158
+ UpdateWebAppCustomizationRequestRequestTypeDef,
159
+ UpdateWebAppCustomizationResponseTypeDef,
160
+ UpdateWebAppRequestRequestTypeDef,
161
+ UpdateWebAppResponseTypeDef,
105
162
  )
106
163
  from .waiter import ServerOfflineWaiter, ServerOnlineWaiter
107
164
 
108
165
  if sys.version_info >= (3, 12):
109
- from typing import Literal
166
+ from typing import Literal, Unpack
110
167
  else:
111
- from typing_extensions import Literal
168
+ from typing_extensions import Literal, Unpack
169
+
112
170
 
113
171
  __all__ = ("TransferClient",)
114
172
 
@@ -147,817 +205,782 @@ class TransferClient(BaseClient):
147
205
  """
148
206
  TransferClient exceptions.
149
207
 
150
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.exceptions)
208
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client)
151
209
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#exceptions)
152
210
  """
153
211
 
154
212
  def can_paginate(self, operation_name: str) -> bool:
155
213
  """
156
- Check if an operation can be paginated.
157
-
158
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.can_paginate)
214
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/can_paginate.html)
159
215
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#can_paginate)
160
216
  """
161
217
 
162
- def close(self) -> None:
218
+ def generate_presigned_url(
219
+ self,
220
+ ClientMethod: str,
221
+ Params: Mapping[str, Any] = ...,
222
+ ExpiresIn: int = 3600,
223
+ HttpMethod: str = ...,
224
+ ) -> str:
225
+ """
226
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/generate_presigned_url.html)
227
+ [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#generate_presigned_url)
163
228
  """
164
- Closes underlying endpoint connections.
165
229
 
166
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.close)
230
+ def close(self) -> None:
231
+ """
232
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/close.html)
167
233
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#close)
168
234
  """
169
235
 
170
236
  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 = ...,
237
+ self, **kwargs: Unpack[CreateAccessRequestRequestTypeDef]
181
238
  ) -> CreateAccessResponseTypeDef:
182
239
  """
183
240
  Used by administrators to choose which groups in the directory should have
184
241
  access to upload and download files over the enabled protocols using Transfer
185
242
  Family.
186
243
 
187
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.create_access)
244
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/create_access.html)
188
245
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_access)
189
246
  """
190
247
 
191
248
  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] = ...,
249
+ self, **kwargs: Unpack[CreateAgreementRequestRequestTypeDef]
202
250
  ) -> CreateAgreementResponseTypeDef:
203
251
  """
204
252
  Creates an agreement.
205
253
 
206
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.create_agreement)
254
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/create_agreement.html)
207
255
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_agreement)
208
256
  """
209
257
 
210
258
  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 = ...,
259
+ self, **kwargs: Unpack[CreateConnectorRequestRequestTypeDef]
220
260
  ) -> CreateConnectorResponseTypeDef:
221
261
  """
222
262
  Creates the connector, which captures the parameters for a connection for the
223
- AS2 or SFTP
224
- protocol.
263
+ AS2 or SFTP protocol.
225
264
 
226
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.create_connector)
265
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/create_connector.html)
227
266
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_connector)
228
267
  """
229
268
 
230
269
  def create_profile(
231
- self,
232
- *,
233
- As2Id: str,
234
- ProfileType: ProfileTypeType,
235
- CertificateIds: Sequence[str] = ...,
236
- Tags: Sequence[TagTypeDef] = ...,
270
+ self, **kwargs: Unpack[CreateProfileRequestRequestTypeDef]
237
271
  ) -> CreateProfileResponseTypeDef:
238
272
  """
239
273
  Creates the local or partner profile to use for AS2 transfers.
240
274
 
241
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.create_profile)
275
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/create_profile.html)
242
276
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_profile)
243
277
  """
244
278
 
245
279
  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 = ...,
280
+ self, **kwargs: Unpack[CreateServerRequestRequestTypeDef]
265
281
  ) -> CreateServerResponseTypeDef:
266
282
  """
267
283
  Instantiates an auto-scaling virtual server based on the selected file transfer
268
- protocol in Amazon Web
269
- Services.
284
+ protocol in Amazon Web Services.
270
285
 
271
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.create_server)
286
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/create_server.html)
272
287
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_server)
273
288
  """
274
289
 
275
290
  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] = ...,
291
+ self, **kwargs: Unpack[CreateUserRequestRequestTypeDef]
288
292
  ) -> CreateUserResponseTypeDef:
289
293
  """
290
294
  Creates a user and associates them with an existing file transfer
291
- protocol-enabled
292
- server.
295
+ protocol-enabled server.
293
296
 
294
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.create_user)
297
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/create_user.html)
295
298
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_user)
296
299
  """
297
300
 
301
+ def create_web_app(
302
+ self, **kwargs: Unpack[CreateWebAppRequestRequestTypeDef]
303
+ ) -> CreateWebAppResponseTypeDef:
304
+ """
305
+ Creates a web app based on specified parameters, and returns the ID for the new
306
+ web app.
307
+
308
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/create_web_app.html)
309
+ [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_web_app)
310
+ """
311
+
298
312
  def create_workflow(
299
- self,
300
- *,
301
- Steps: Sequence[WorkflowStepUnionTypeDef],
302
- Description: str = ...,
303
- OnExceptionSteps: Sequence[WorkflowStepUnionTypeDef] = ...,
304
- Tags: Sequence[TagTypeDef] = ...,
313
+ self, **kwargs: Unpack[CreateWorkflowRequestRequestTypeDef]
305
314
  ) -> CreateWorkflowResponseTypeDef:
306
315
  """
307
316
  Allows you to create a workflow with specified steps and step details the
308
- workflow invokes after file transfer
309
- completes.
317
+ workflow invokes after file transfer completes.
310
318
 
311
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.create_workflow)
319
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/create_workflow.html)
312
320
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#create_workflow)
313
321
  """
314
322
 
315
- def delete_access(self, *, ServerId: str, ExternalId: str) -> EmptyResponseMetadataTypeDef:
323
+ def delete_access(
324
+ self, **kwargs: Unpack[DeleteAccessRequestRequestTypeDef]
325
+ ) -> EmptyResponseMetadataTypeDef:
316
326
  """
317
- Allows you to delete the access specified in the `ServerID` and `ExternalID`
318
- parameters.
327
+ Allows you to delete the access specified in the <code>ServerID</code> and
328
+ <code>ExternalID</code> parameters.
319
329
 
320
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.delete_access)
330
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_access.html)
321
331
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_access)
322
332
  """
323
333
 
324
- def delete_agreement(self, *, AgreementId: str, ServerId: str) -> EmptyResponseMetadataTypeDef:
334
+ def delete_agreement(
335
+ self, **kwargs: Unpack[DeleteAgreementRequestRequestTypeDef]
336
+ ) -> EmptyResponseMetadataTypeDef:
325
337
  """
326
- Delete the agreement that's specified in the provided `AgreementId`.
338
+ Delete the agreement that's specified in the provided <code>AgreementId</code>.
327
339
 
328
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.delete_agreement)
340
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_agreement.html)
329
341
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_agreement)
330
342
  """
331
343
 
332
- def delete_certificate(self, *, CertificateId: str) -> EmptyResponseMetadataTypeDef:
344
+ def delete_certificate(
345
+ self, **kwargs: Unpack[DeleteCertificateRequestRequestTypeDef]
346
+ ) -> EmptyResponseMetadataTypeDef:
333
347
  """
334
- Deletes the certificate that's specified in the `CertificateId` parameter.
348
+ Deletes the certificate that's specified in the <code>CertificateId</code>
349
+ parameter.
335
350
 
336
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.delete_certificate)
351
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_certificate.html)
337
352
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_certificate)
338
353
  """
339
354
 
340
- def delete_connector(self, *, ConnectorId: str) -> EmptyResponseMetadataTypeDef:
355
+ def delete_connector(
356
+ self, **kwargs: Unpack[DeleteConnectorRequestRequestTypeDef]
357
+ ) -> EmptyResponseMetadataTypeDef:
341
358
  """
342
- Deletes the connector that's specified in the provided `ConnectorId`.
359
+ Deletes the connector that's specified in the provided <code>ConnectorId</code>.
343
360
 
344
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.delete_connector)
361
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_connector.html)
345
362
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_connector)
346
363
  """
347
364
 
348
- def delete_host_key(self, *, ServerId: str, HostKeyId: str) -> EmptyResponseMetadataTypeDef:
365
+ def delete_host_key(
366
+ self, **kwargs: Unpack[DeleteHostKeyRequestRequestTypeDef]
367
+ ) -> EmptyResponseMetadataTypeDef:
349
368
  """
350
- Deletes the host key that's specified in the `HostKeyId` parameter.
369
+ Deletes the host key that's specified in the <code>HostKeyId</code> parameter.
351
370
 
352
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.delete_host_key)
371
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_host_key.html)
353
372
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_host_key)
354
373
  """
355
374
 
356
- def delete_profile(self, *, ProfileId: str) -> EmptyResponseMetadataTypeDef:
375
+ def delete_profile(
376
+ self, **kwargs: Unpack[DeleteProfileRequestRequestTypeDef]
377
+ ) -> EmptyResponseMetadataTypeDef:
357
378
  """
358
- Deletes the profile that's specified in the `ProfileId` parameter.
379
+ Deletes the profile that's specified in the <code>ProfileId</code> parameter.
359
380
 
360
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.delete_profile)
381
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_profile.html)
361
382
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_profile)
362
383
  """
363
384
 
364
- def delete_server(self, *, ServerId: str) -> EmptyResponseMetadataTypeDef:
385
+ def delete_server(
386
+ self, **kwargs: Unpack[DeleteServerRequestRequestTypeDef]
387
+ ) -> EmptyResponseMetadataTypeDef:
365
388
  """
366
389
  Deletes the file transfer protocol-enabled server that you specify.
367
390
 
368
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.delete_server)
391
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_server.html)
369
392
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_server)
370
393
  """
371
394
 
372
395
  def delete_ssh_public_key(
373
- self, *, ServerId: str, SshPublicKeyId: str, UserName: str
396
+ self, **kwargs: Unpack[DeleteSshPublicKeyRequestRequestTypeDef]
374
397
  ) -> EmptyResponseMetadataTypeDef:
375
398
  """
376
399
  Deletes a user's Secure Shell (SSH) public key.
377
400
 
378
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.delete_ssh_public_key)
401
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_ssh_public_key.html)
379
402
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_ssh_public_key)
380
403
  """
381
404
 
382
- def delete_user(self, *, ServerId: str, UserName: str) -> EmptyResponseMetadataTypeDef:
405
+ def delete_user(
406
+ self, **kwargs: Unpack[DeleteUserRequestRequestTypeDef]
407
+ ) -> EmptyResponseMetadataTypeDef:
383
408
  """
384
409
  Deletes the user belonging to a file transfer protocol-enabled server you
385
410
  specify.
386
411
 
387
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.delete_user)
412
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_user.html)
388
413
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_user)
389
414
  """
390
415
 
391
- def delete_workflow(self, *, WorkflowId: str) -> EmptyResponseMetadataTypeDef:
416
+ def delete_web_app(
417
+ self, **kwargs: Unpack[DeleteWebAppRequestRequestTypeDef]
418
+ ) -> EmptyResponseMetadataTypeDef:
419
+ """
420
+ Deletes the specified web app.
421
+
422
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_web_app.html)
423
+ [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_web_app)
424
+ """
425
+
426
+ def delete_web_app_customization(
427
+ self, **kwargs: Unpack[DeleteWebAppCustomizationRequestRequestTypeDef]
428
+ ) -> EmptyResponseMetadataTypeDef:
429
+ """
430
+ Deletes the <code>WebAppCustomization</code> object that corresponds to the web
431
+ app ID specified.
432
+
433
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_web_app_customization.html)
434
+ [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_web_app_customization)
435
+ """
436
+
437
+ def delete_workflow(
438
+ self, **kwargs: Unpack[DeleteWorkflowRequestRequestTypeDef]
439
+ ) -> EmptyResponseMetadataTypeDef:
392
440
  """
393
441
  Deletes the specified workflow.
394
442
 
395
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.delete_workflow)
443
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/delete_workflow.html)
396
444
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#delete_workflow)
397
445
  """
398
446
 
399
- def describe_access(self, *, ServerId: str, ExternalId: str) -> DescribeAccessResponseTypeDef:
447
+ def describe_access(
448
+ self, **kwargs: Unpack[DescribeAccessRequestRequestTypeDef]
449
+ ) -> DescribeAccessResponseTypeDef:
400
450
  """
401
451
  Describes the access that is assigned to the specific file transfer
402
- protocol-enabled server, as identified by its `ServerId` property and its
403
- `ExternalId`.
452
+ protocol-enabled server, as identified by its <code>ServerId</code> property
453
+ and its <code>ExternalId</code>.
404
454
 
405
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.describe_access)
455
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_access.html)
406
456
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_access)
407
457
  """
408
458
 
409
459
  def describe_agreement(
410
- self, *, AgreementId: str, ServerId: str
460
+ self, **kwargs: Unpack[DescribeAgreementRequestRequestTypeDef]
411
461
  ) -> DescribeAgreementResponseTypeDef:
412
462
  """
413
- Describes the agreement that's identified by the `AgreementId`.
463
+ Describes the agreement that's identified by the <code>AgreementId</code>.
414
464
 
415
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.describe_agreement)
465
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_agreement.html)
416
466
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_agreement)
417
467
  """
418
468
 
419
- def describe_certificate(self, *, CertificateId: str) -> DescribeCertificateResponseTypeDef:
469
+ def describe_certificate(
470
+ self, **kwargs: Unpack[DescribeCertificateRequestRequestTypeDef]
471
+ ) -> DescribeCertificateResponseTypeDef:
420
472
  """
421
- Describes the certificate that's identified by the `CertificateId`.
473
+ Describes the certificate that's identified by the <code>CertificateId</code>.
422
474
 
423
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.describe_certificate)
475
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_certificate.html)
424
476
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_certificate)
425
477
  """
426
478
 
427
- def describe_connector(self, *, ConnectorId: str) -> DescribeConnectorResponseTypeDef:
479
+ def describe_connector(
480
+ self, **kwargs: Unpack[DescribeConnectorRequestRequestTypeDef]
481
+ ) -> DescribeConnectorResponseTypeDef:
428
482
  """
429
- Describes the connector that's identified by the `ConnectorId.` See also: [AWS
430
- API
431
- Documentation](https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeConnector).
483
+ Describes the connector that's identified by the <code>ConnectorId.</code>.
432
484
 
433
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.describe_connector)
485
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_connector.html)
434
486
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_connector)
435
487
  """
436
488
 
437
489
  def describe_execution(
438
- self, *, ExecutionId: str, WorkflowId: str
490
+ self, **kwargs: Unpack[DescribeExecutionRequestRequestTypeDef]
439
491
  ) -> DescribeExecutionResponseTypeDef:
440
492
  """
441
- You can use `DescribeExecution` to check the details of the execution of the
442
- specified
443
- workflow.
493
+ You can use <code>DescribeExecution</code> to check the details of the
494
+ execution of the specified workflow.
444
495
 
445
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.describe_execution)
496
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_execution.html)
446
497
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_execution)
447
498
  """
448
499
 
449
- def describe_host_key(self, *, ServerId: str, HostKeyId: str) -> DescribeHostKeyResponseTypeDef:
500
+ def describe_host_key(
501
+ self, **kwargs: Unpack[DescribeHostKeyRequestRequestTypeDef]
502
+ ) -> DescribeHostKeyResponseTypeDef:
450
503
  """
451
- Returns the details of the host key that's specified by the `HostKeyId` and
452
- `ServerId`.
504
+ Returns the details of the host key that's specified by the
505
+ <code>HostKeyId</code> and <code>ServerId</code>.
453
506
 
454
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.describe_host_key)
507
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_host_key.html)
455
508
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_host_key)
456
509
  """
457
510
 
458
- def describe_profile(self, *, ProfileId: str) -> DescribeProfileResponseTypeDef:
511
+ def describe_profile(
512
+ self, **kwargs: Unpack[DescribeProfileRequestRequestTypeDef]
513
+ ) -> DescribeProfileResponseTypeDef:
459
514
  """
460
- Returns the details of the profile that's specified by the `ProfileId`.
515
+ Returns the details of the profile that's specified by the
516
+ <code>ProfileId</code>.
461
517
 
462
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.describe_profile)
518
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_profile.html)
463
519
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_profile)
464
520
  """
465
521
 
466
522
  def describe_security_policy(
467
- self, *, SecurityPolicyName: str
523
+ self, **kwargs: Unpack[DescribeSecurityPolicyRequestRequestTypeDef]
468
524
  ) -> DescribeSecurityPolicyResponseTypeDef:
469
525
  """
470
526
  Describes the security policy that is attached to your server or SFTP connector.
471
527
 
472
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.describe_security_policy)
528
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_security_policy.html)
473
529
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_security_policy)
474
530
  """
475
531
 
476
- def describe_server(self, *, ServerId: str) -> DescribeServerResponseTypeDef:
532
+ def describe_server(
533
+ self, **kwargs: Unpack[DescribeServerRequestRequestTypeDef]
534
+ ) -> DescribeServerResponseTypeDef:
477
535
  """
478
536
  Describes a file transfer protocol-enabled server that you specify by passing
479
- the `ServerId`
480
- parameter.
537
+ the <code>ServerId</code> parameter.
481
538
 
482
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.describe_server)
539
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_server.html)
483
540
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_server)
484
541
  """
485
542
 
486
- def describe_user(self, *, ServerId: str, UserName: str) -> DescribeUserResponseTypeDef:
543
+ def describe_user(
544
+ self, **kwargs: Unpack[DescribeUserRequestRequestTypeDef]
545
+ ) -> DescribeUserResponseTypeDef:
487
546
  """
488
547
  Describes the user assigned to the specific file transfer protocol-enabled
489
- server, as identified by its `ServerId`
490
- property.
548
+ server, as identified by its <code>ServerId</code> property.
491
549
 
492
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.describe_user)
550
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_user.html)
493
551
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_user)
494
552
  """
495
553
 
496
- def describe_workflow(self, *, WorkflowId: str) -> DescribeWorkflowResponseTypeDef:
554
+ def describe_web_app(
555
+ self, **kwargs: Unpack[DescribeWebAppRequestRequestTypeDef]
556
+ ) -> DescribeWebAppResponseTypeDef:
497
557
  """
498
- Describes the specified workflow.
558
+ Describes the web app that's identified by <code>WebAppId</code>.
499
559
 
500
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.describe_workflow)
501
- [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_workflow)
560
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_web_app.html)
561
+ [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_web_app)
502
562
  """
503
563
 
504
- def generate_presigned_url(
505
- self,
506
- ClientMethod: str,
507
- Params: Mapping[str, Any] = ...,
508
- ExpiresIn: int = 3600,
509
- HttpMethod: str = ...,
510
- ) -> str:
564
+ def describe_web_app_customization(
565
+ self, **kwargs: Unpack[DescribeWebAppCustomizationRequestRequestTypeDef]
566
+ ) -> DescribeWebAppCustomizationResponseTypeDef:
511
567
  """
512
- Generate a presigned url given a client, its method, and arguments.
568
+ Describes the web app customization object that's identified by
569
+ <code>WebAppId</code>.
513
570
 
514
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.generate_presigned_url)
515
- [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#generate_presigned_url)
571
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_web_app_customization.html)
572
+ [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_web_app_customization)
573
+ """
574
+
575
+ def describe_workflow(
576
+ self, **kwargs: Unpack[DescribeWorkflowRequestRequestTypeDef]
577
+ ) -> DescribeWorkflowResponseTypeDef:
578
+ """
579
+ Describes the specified workflow.
580
+
581
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/describe_workflow.html)
582
+ [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#describe_workflow)
516
583
  """
517
584
 
518
585
  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] = ...,
586
+ self, **kwargs: Unpack[ImportCertificateRequestRequestTypeDef]
529
587
  ) -> ImportCertificateResponseTypeDef:
530
588
  """
531
589
  Imports the signing and encryption certificates that you need to create local
532
- (AS2) profiles and partner
533
- profiles.
590
+ (AS2) profiles and partner profiles.
534
591
 
535
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.import_certificate)
592
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/import_certificate.html)
536
593
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#import_certificate)
537
594
  """
538
595
 
539
596
  def import_host_key(
540
- self,
541
- *,
542
- ServerId: str,
543
- HostKeyBody: str,
544
- Description: str = ...,
545
- Tags: Sequence[TagTypeDef] = ...,
597
+ self, **kwargs: Unpack[ImportHostKeyRequestRequestTypeDef]
546
598
  ) -> ImportHostKeyResponseTypeDef:
547
599
  """
548
- Adds a host key to the server that's specified by the `ServerId` parameter.
600
+ Adds a host key to the server that's specified by the <code>ServerId</code>
601
+ parameter.
549
602
 
550
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.import_host_key)
603
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/import_host_key.html)
551
604
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#import_host_key)
552
605
  """
553
606
 
554
607
  def import_ssh_public_key(
555
- self, *, ServerId: str, SshPublicKeyBody: str, UserName: str
608
+ self, **kwargs: Unpack[ImportSshPublicKeyRequestRequestTypeDef]
556
609
  ) -> ImportSshPublicKeyResponseTypeDef:
557
610
  """
558
611
  Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a
559
- `UserName` value assigned to the specific file transfer protocol-enabled
560
- server, identified by
561
- `ServerId`.
612
+ <code>UserName</code> value assigned to the specific file transfer
613
+ protocol-enabled server, identified by <code>ServerId</code>.
562
614
 
563
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.import_ssh_public_key)
615
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/import_ssh_public_key.html)
564
616
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#import_ssh_public_key)
565
617
  """
566
618
 
567
619
  def list_accesses(
568
- self, *, ServerId: str, MaxResults: int = ..., NextToken: str = ...
620
+ self, **kwargs: Unpack[ListAccessesRequestRequestTypeDef]
569
621
  ) -> ListAccessesResponseTypeDef:
570
622
  """
571
623
  Lists the details for all the accesses you have on your server.
572
624
 
573
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.list_accesses)
625
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_accesses.html)
574
626
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_accesses)
575
627
  """
576
628
 
577
629
  def list_agreements(
578
- self, *, ServerId: str, MaxResults: int = ..., NextToken: str = ...
630
+ self, **kwargs: Unpack[ListAgreementsRequestRequestTypeDef]
579
631
  ) -> ListAgreementsResponseTypeDef:
580
632
  """
581
633
  Returns a list of the agreements for the server that's identified by the
582
- `ServerId` that you
583
- supply.
634
+ <code>ServerId</code> that you supply.
584
635
 
585
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.list_agreements)
636
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_agreements.html)
586
637
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_agreements)
587
638
  """
588
639
 
589
640
  def list_certificates(
590
- self, *, MaxResults: int = ..., NextToken: str = ...
641
+ self, **kwargs: Unpack[ListCertificatesRequestRequestTypeDef]
591
642
  ) -> ListCertificatesResponseTypeDef:
592
643
  """
593
644
  Returns a list of the current certificates that have been imported into
594
- Transfer
595
- Family.
645
+ Transfer Family.
596
646
 
597
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.list_certificates)
647
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_certificates.html)
598
648
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_certificates)
599
649
  """
600
650
 
601
651
  def list_connectors(
602
- self, *, MaxResults: int = ..., NextToken: str = ...
652
+ self, **kwargs: Unpack[ListConnectorsRequestRequestTypeDef]
603
653
  ) -> ListConnectorsResponseTypeDef:
604
654
  """
605
655
  Lists the connectors for the specified Region.
606
656
 
607
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.list_connectors)
657
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_connectors.html)
608
658
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_connectors)
609
659
  """
610
660
 
611
661
  def list_executions(
612
- self, *, WorkflowId: str, MaxResults: int = ..., NextToken: str = ...
662
+ self, **kwargs: Unpack[ListExecutionsRequestRequestTypeDef]
613
663
  ) -> ListExecutionsResponseTypeDef:
614
664
  """
615
665
  Lists all in-progress executions for the specified workflow.
616
666
 
617
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.list_executions)
667
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_executions.html)
618
668
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_executions)
619
669
  """
620
670
 
671
+ def list_file_transfer_results(
672
+ self, **kwargs: Unpack[ListFileTransferResultsRequestRequestTypeDef]
673
+ ) -> ListFileTransferResultsResponseTypeDef:
674
+ """
675
+ Returns real-time updates and detailed information on the status of each
676
+ individual file being transferred in a specific file transfer operation.
677
+
678
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_file_transfer_results.html)
679
+ [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_file_transfer_results)
680
+ """
681
+
621
682
  def list_host_keys(
622
- self, *, ServerId: str, MaxResults: int = ..., NextToken: str = ...
683
+ self, **kwargs: Unpack[ListHostKeysRequestRequestTypeDef]
623
684
  ) -> ListHostKeysResponseTypeDef:
624
685
  """
625
- Returns a list of host keys for the server that's specified by the `ServerId`
626
- parameter.
686
+ Returns a list of host keys for the server that's specified by the
687
+ <code>ServerId</code> parameter.
627
688
 
628
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.list_host_keys)
689
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_host_keys.html)
629
690
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_host_keys)
630
691
  """
631
692
 
632
693
  def list_profiles(
633
- self, *, MaxResults: int = ..., NextToken: str = ..., ProfileType: ProfileTypeType = ...
694
+ self, **kwargs: Unpack[ListProfilesRequestRequestTypeDef]
634
695
  ) -> ListProfilesResponseTypeDef:
635
696
  """
636
697
  Returns a list of the profiles for your system.
637
698
 
638
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.list_profiles)
699
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_profiles.html)
639
700
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_profiles)
640
701
  """
641
702
 
642
703
  def list_security_policies(
643
- self, *, MaxResults: int = ..., NextToken: str = ...
704
+ self, **kwargs: Unpack[ListSecurityPoliciesRequestRequestTypeDef]
644
705
  ) -> ListSecurityPoliciesResponseTypeDef:
645
706
  """
646
707
  Lists the security policies that are attached to your servers and SFTP
647
708
  connectors.
648
709
 
649
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.list_security_policies)
710
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_security_policies.html)
650
711
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_security_policies)
651
712
  """
652
713
 
653
714
  def list_servers(
654
- self, *, MaxResults: int = ..., NextToken: str = ...
715
+ self, **kwargs: Unpack[ListServersRequestRequestTypeDef]
655
716
  ) -> ListServersResponseTypeDef:
656
717
  """
657
718
  Lists the file transfer protocol-enabled servers that are associated with your
658
- Amazon Web Services
659
- account.
719
+ Amazon Web Services account.
660
720
 
661
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.list_servers)
721
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_servers.html)
662
722
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_servers)
663
723
  """
664
724
 
665
725
  def list_tags_for_resource(
666
- self, *, Arn: str, MaxResults: int = ..., NextToken: str = ...
726
+ self, **kwargs: Unpack[ListTagsForResourceRequestRequestTypeDef]
667
727
  ) -> ListTagsForResourceResponseTypeDef:
668
728
  """
669
729
  Lists all of the tags associated with the Amazon Resource Name (ARN) that you
670
730
  specify.
671
731
 
672
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.list_tags_for_resource)
732
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_tags_for_resource.html)
673
733
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_tags_for_resource)
674
734
  """
675
735
 
676
736
  def list_users(
677
- self, *, ServerId: str, MaxResults: int = ..., NextToken: str = ...
737
+ self, **kwargs: Unpack[ListUsersRequestRequestTypeDef]
678
738
  ) -> ListUsersResponseTypeDef:
679
739
  """
680
740
  Lists the users for a file transfer protocol-enabled server that you specify by
681
- passing the `ServerId`
682
- parameter.
741
+ passing the <code>ServerId</code> parameter.
683
742
 
684
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.list_users)
743
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_users.html)
685
744
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_users)
686
745
  """
687
746
 
747
+ def list_web_apps(
748
+ self, **kwargs: Unpack[ListWebAppsRequestRequestTypeDef]
749
+ ) -> ListWebAppsResponseTypeDef:
750
+ """
751
+ Lists all web apps associated with your Amazon Web Services account for your
752
+ current region.
753
+
754
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_web_apps.html)
755
+ [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_web_apps)
756
+ """
757
+
688
758
  def list_workflows(
689
- self, *, MaxResults: int = ..., NextToken: str = ...
759
+ self, **kwargs: Unpack[ListWorkflowsRequestRequestTypeDef]
690
760
  ) -> ListWorkflowsResponseTypeDef:
691
761
  """
692
762
  Lists all workflows associated with your Amazon Web Services account for your
693
- current
694
- region.
763
+ current region.
695
764
 
696
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.list_workflows)
765
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/list_workflows.html)
697
766
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#list_workflows)
698
767
  """
699
768
 
700
769
  def send_workflow_step_state(
701
- self, *, WorkflowId: str, ExecutionId: str, Token: str, Status: CustomStepStatusType
770
+ self, **kwargs: Unpack[SendWorkflowStepStateRequestRequestTypeDef]
702
771
  ) -> Dict[str, Any]:
703
772
  """
704
773
  Sends a callback for asynchronous custom steps.
705
774
 
706
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.send_workflow_step_state)
775
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/send_workflow_step_state.html)
707
776
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#send_workflow_step_state)
708
777
  """
709
778
 
710
779
  def start_directory_listing(
711
- self,
712
- *,
713
- ConnectorId: str,
714
- RemoteDirectoryPath: str,
715
- OutputDirectoryPath: str,
716
- MaxItems: int = ...,
780
+ self, **kwargs: Unpack[StartDirectoryListingRequestRequestTypeDef]
717
781
  ) -> StartDirectoryListingResponseTypeDef:
718
782
  """
719
783
  Retrieves a list of the contents of a directory from a remote SFTP server.
720
784
 
721
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.start_directory_listing)
785
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/start_directory_listing.html)
722
786
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#start_directory_listing)
723
787
  """
724
788
 
725
789
  def start_file_transfer(
726
- self,
727
- *,
728
- ConnectorId: str,
729
- SendFilePaths: Sequence[str] = ...,
730
- RetrieveFilePaths: Sequence[str] = ...,
731
- LocalDirectoryPath: str = ...,
732
- RemoteDirectoryPath: str = ...,
790
+ self, **kwargs: Unpack[StartFileTransferRequestRequestTypeDef]
733
791
  ) -> StartFileTransferResponseTypeDef:
734
792
  """
735
793
  Begins a file transfer between local Amazon Web Services storage and a remote
736
- AS2 or SFTP
737
- server.
794
+ AS2 or SFTP server.
738
795
 
739
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.start_file_transfer)
796
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/start_file_transfer.html)
740
797
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#start_file_transfer)
741
798
  """
742
799
 
743
- def start_server(self, *, ServerId: str) -> EmptyResponseMetadataTypeDef:
800
+ def start_server(
801
+ self, **kwargs: Unpack[StartServerRequestRequestTypeDef]
802
+ ) -> EmptyResponseMetadataTypeDef:
744
803
  """
745
- Changes the state of a file transfer protocol-enabled server from `OFFLINE` to
746
- `ONLINE`.
804
+ Changes the state of a file transfer protocol-enabled server from
805
+ <code>OFFLINE</code> to <code>ONLINE</code>.
747
806
 
748
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.start_server)
807
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/start_server.html)
749
808
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#start_server)
750
809
  """
751
810
 
752
- def stop_server(self, *, ServerId: str) -> EmptyResponseMetadataTypeDef:
811
+ def stop_server(
812
+ self, **kwargs: Unpack[StopServerRequestRequestTypeDef]
813
+ ) -> EmptyResponseMetadataTypeDef:
753
814
  """
754
- Changes the state of a file transfer protocol-enabled server from `ONLINE` to
755
- `OFFLINE`.
815
+ Changes the state of a file transfer protocol-enabled server from
816
+ <code>ONLINE</code> to <code>OFFLINE</code>.
756
817
 
757
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.stop_server)
818
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/stop_server.html)
758
819
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#stop_server)
759
820
  """
760
821
 
761
- def tag_resource(self, *, Arn: str, Tags: Sequence[TagTypeDef]) -> EmptyResponseMetadataTypeDef:
822
+ def tag_resource(
823
+ self, **kwargs: Unpack[TagResourceRequestRequestTypeDef]
824
+ ) -> EmptyResponseMetadataTypeDef:
762
825
  """
763
826
  Attaches a key-value pair to a resource, as identified by its Amazon Resource
764
- Name
765
- (ARN).
827
+ Name (ARN).
766
828
 
767
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.tag_resource)
829
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/tag_resource.html)
768
830
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#tag_resource)
769
831
  """
770
832
 
771
- def test_connection(self, *, ConnectorId: str) -> TestConnectionResponseTypeDef:
833
+ def test_connection(
834
+ self, **kwargs: Unpack[TestConnectionRequestRequestTypeDef]
835
+ ) -> TestConnectionResponseTypeDef:
772
836
  """
773
837
  Tests whether your SFTP connector is set up successfully.
774
838
 
775
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.test_connection)
839
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/test_connection.html)
776
840
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#test_connection)
777
841
  """
778
842
 
779
843
  def test_identity_provider(
780
- self,
781
- *,
782
- ServerId: str,
783
- UserName: str,
784
- ServerProtocol: ProtocolType = ...,
785
- SourceIp: str = ...,
786
- UserPassword: str = ...,
844
+ self, **kwargs: Unpack[TestIdentityProviderRequestRequestTypeDef]
787
845
  ) -> TestIdentityProviderResponseTypeDef:
788
846
  """
789
- If the `IdentityProviderType` of a file transfer protocol-enabled server is
790
- `AWS_DIRECTORY_SERVICE` or `API_Gateway`, tests whether your identity provider
791
- is set up
792
- successfully.
847
+ If the <code>IdentityProviderType</code> of a file transfer protocol-enabled
848
+ server is <code>AWS_DIRECTORY_SERVICE</code> or <code>API_Gateway</code>, tests
849
+ whether your identity provider is set up successfully.
793
850
 
794
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.test_identity_provider)
851
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/test_identity_provider.html)
795
852
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#test_identity_provider)
796
853
  """
797
854
 
798
- def untag_resource(self, *, Arn: str, TagKeys: Sequence[str]) -> EmptyResponseMetadataTypeDef:
855
+ def untag_resource(
856
+ self, **kwargs: Unpack[UntagResourceRequestRequestTypeDef]
857
+ ) -> EmptyResponseMetadataTypeDef:
799
858
  """
800
859
  Detaches a key-value pair from a resource, as identified by its Amazon Resource
801
- Name
802
- (ARN).
860
+ Name (ARN).
803
861
 
804
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.untag_resource)
862
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/untag_resource.html)
805
863
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#untag_resource)
806
864
  """
807
865
 
808
866
  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 = ...,
867
+ self, **kwargs: Unpack[UpdateAccessRequestRequestTypeDef]
819
868
  ) -> UpdateAccessResponseTypeDef:
820
869
  """
821
- Allows you to update parameters for the access specified in the `ServerID` and
822
- `ExternalID`
823
- parameters.
870
+ Allows you to update parameters for the access specified in the
871
+ <code>ServerID</code> and <code>ExternalID</code> parameters.
824
872
 
825
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.update_access)
873
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_access.html)
826
874
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_access)
827
875
  """
828
876
 
829
877
  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 = ...,
878
+ self, **kwargs: Unpack[UpdateAgreementRequestRequestTypeDef]
840
879
  ) -> UpdateAgreementResponseTypeDef:
841
880
  """
842
881
  Updates some of the parameters for an existing agreement.
843
882
 
844
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.update_agreement)
883
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_agreement.html)
845
884
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_agreement)
846
885
  """
847
886
 
848
887
  def update_certificate(
849
- self,
850
- *,
851
- CertificateId: str,
852
- ActiveDate: TimestampTypeDef = ...,
853
- InactiveDate: TimestampTypeDef = ...,
854
- Description: str = ...,
888
+ self, **kwargs: Unpack[UpdateCertificateRequestRequestTypeDef]
855
889
  ) -> UpdateCertificateResponseTypeDef:
856
890
  """
857
891
  Updates the active and inactive dates for a certificate.
858
892
 
859
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.update_certificate)
893
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_certificate.html)
860
894
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_certificate)
861
895
  """
862
896
 
863
897
  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 = ...,
898
+ self, **kwargs: Unpack[UpdateConnectorRequestRequestTypeDef]
873
899
  ) -> UpdateConnectorResponseTypeDef:
874
900
  """
875
901
  Updates some of the parameters for an existing connector.
876
902
 
877
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.update_connector)
903
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_connector.html)
878
904
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_connector)
879
905
  """
880
906
 
881
907
  def update_host_key(
882
- self, *, ServerId: str, HostKeyId: str, Description: str
908
+ self, **kwargs: Unpack[UpdateHostKeyRequestRequestTypeDef]
883
909
  ) -> UpdateHostKeyResponseTypeDef:
884
910
  """
885
- Updates the description for the host key that's specified by the `ServerId` and
886
- `HostKeyId`
887
- parameters.
911
+ Updates the description for the host key that's specified by the
912
+ <code>ServerId</code> and <code>HostKeyId</code> parameters.
888
913
 
889
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.update_host_key)
914
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_host_key.html)
890
915
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_host_key)
891
916
  """
892
917
 
893
918
  def update_profile(
894
- self, *, ProfileId: str, CertificateIds: Sequence[str] = ...
919
+ self, **kwargs: Unpack[UpdateProfileRequestRequestTypeDef]
895
920
  ) -> UpdateProfileResponseTypeDef:
896
921
  """
897
922
  Updates some of the parameters for an existing profile.
898
923
 
899
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.update_profile)
924
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_profile.html)
900
925
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_profile)
901
926
  """
902
927
 
903
928
  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 = ...,
929
+ self, **kwargs: Unpack[UpdateServerRequestRequestTypeDef]
921
930
  ) -> UpdateServerResponseTypeDef:
922
931
  """
923
932
  Updates the file transfer protocol-enabled server's properties after that
924
- server has been
925
- created.
933
+ server has been created.
926
934
 
927
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.update_server)
935
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_server.html)
928
936
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_server)
929
937
  """
930
938
 
931
939
  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 = ...,
940
+ self, **kwargs: Unpack[UpdateUserRequestRequestTypeDef]
942
941
  ) -> UpdateUserResponseTypeDef:
943
942
  """
944
943
  Assigns new properties to a user.
945
944
 
946
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.update_user)
945
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_user.html)
947
946
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_user)
948
947
  """
949
948
 
949
+ def update_web_app(
950
+ self, **kwargs: Unpack[UpdateWebAppRequestRequestTypeDef]
951
+ ) -> UpdateWebAppResponseTypeDef:
952
+ """
953
+ Assigns new properties to a web app.
954
+
955
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_web_app.html)
956
+ [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_web_app)
957
+ """
958
+
959
+ def update_web_app_customization(
960
+ self, **kwargs: Unpack[UpdateWebAppCustomizationRequestRequestTypeDef]
961
+ ) -> UpdateWebAppCustomizationResponseTypeDef:
962
+ """
963
+ Assigns new customization properties to a web app.
964
+
965
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/update_web_app_customization.html)
966
+ [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#update_web_app_customization)
967
+ """
968
+
950
969
  @overload
951
970
  def get_paginator(self, operation_name: Literal["list_accesses"]) -> ListAccessesPaginator:
952
971
  """
953
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.get_paginator)
972
+ Create a paginator for an operation.
973
+
974
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
954
975
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
955
976
  """
956
977
 
957
978
  @overload
958
979
  def get_paginator(self, operation_name: Literal["list_agreements"]) -> ListAgreementsPaginator:
959
980
  """
960
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.get_paginator)
981
+ Create a paginator for an operation.
982
+
983
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
961
984
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
962
985
  """
963
986
 
@@ -966,28 +989,47 @@ class TransferClient(BaseClient):
966
989
  self, operation_name: Literal["list_certificates"]
967
990
  ) -> ListCertificatesPaginator:
968
991
  """
969
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.get_paginator)
992
+ Create a paginator for an operation.
993
+
994
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
970
995
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
971
996
  """
972
997
 
973
998
  @overload
974
999
  def get_paginator(self, operation_name: Literal["list_connectors"]) -> ListConnectorsPaginator:
975
1000
  """
976
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.get_paginator)
1001
+ Create a paginator for an operation.
1002
+
1003
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
977
1004
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
978
1005
  """
979
1006
 
980
1007
  @overload
981
1008
  def get_paginator(self, operation_name: Literal["list_executions"]) -> ListExecutionsPaginator:
982
1009
  """
983
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.get_paginator)
1010
+ Create a paginator for an operation.
1011
+
1012
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
1013
+ [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
1014
+ """
1015
+
1016
+ @overload
1017
+ def get_paginator(
1018
+ self, operation_name: Literal["list_file_transfer_results"]
1019
+ ) -> ListFileTransferResultsPaginator:
1020
+ """
1021
+ Create a paginator for an operation.
1022
+
1023
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
984
1024
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
985
1025
  """
986
1026
 
987
1027
  @overload
988
1028
  def get_paginator(self, operation_name: Literal["list_profiles"]) -> ListProfilesPaginator:
989
1029
  """
990
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.get_paginator)
1030
+ Create a paginator for an operation.
1031
+
1032
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
991
1033
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
992
1034
  """
993
1035
 
@@ -996,14 +1038,18 @@ class TransferClient(BaseClient):
996
1038
  self, operation_name: Literal["list_security_policies"]
997
1039
  ) -> ListSecurityPoliciesPaginator:
998
1040
  """
999
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.get_paginator)
1041
+ Create a paginator for an operation.
1042
+
1043
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
1000
1044
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
1001
1045
  """
1002
1046
 
1003
1047
  @overload
1004
1048
  def get_paginator(self, operation_name: Literal["list_servers"]) -> ListServersPaginator:
1005
1049
  """
1006
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.get_paginator)
1050
+ Create a paginator for an operation.
1051
+
1052
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
1007
1053
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
1008
1054
  """
1009
1055
 
@@ -1012,34 +1058,53 @@ class TransferClient(BaseClient):
1012
1058
  self, operation_name: Literal["list_tags_for_resource"]
1013
1059
  ) -> ListTagsForResourcePaginator:
1014
1060
  """
1015
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.get_paginator)
1061
+ Create a paginator for an operation.
1062
+
1063
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
1016
1064
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
1017
1065
  """
1018
1066
 
1019
1067
  @overload
1020
1068
  def get_paginator(self, operation_name: Literal["list_users"]) -> ListUsersPaginator:
1021
1069
  """
1022
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.get_paginator)
1070
+ Create a paginator for an operation.
1071
+
1072
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
1073
+ [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
1074
+ """
1075
+
1076
+ @overload
1077
+ def get_paginator(self, operation_name: Literal["list_web_apps"]) -> ListWebAppsPaginator:
1078
+ """
1079
+ Create a paginator for an operation.
1080
+
1081
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
1023
1082
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
1024
1083
  """
1025
1084
 
1026
1085
  @overload
1027
1086
  def get_paginator(self, operation_name: Literal["list_workflows"]) -> ListWorkflowsPaginator:
1028
1087
  """
1029
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.get_paginator)
1088
+ Create a paginator for an operation.
1089
+
1090
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_paginator.html)
1030
1091
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_paginator)
1031
1092
  """
1032
1093
 
1033
1094
  @overload
1034
1095
  def get_waiter(self, waiter_name: Literal["server_offline"]) -> ServerOfflineWaiter:
1035
1096
  """
1036
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.get_waiter)
1097
+ Returns an object that can wait for some condition.
1098
+
1099
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_waiter.html)
1037
1100
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_waiter)
1038
1101
  """
1039
1102
 
1040
1103
  @overload
1041
1104
  def get_waiter(self, waiter_name: Literal["server_online"]) -> ServerOnlineWaiter:
1042
1105
  """
1043
- [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer.html#Transfer.Client.get_waiter)
1106
+ Returns an object that can wait for some condition.
1107
+
1108
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/transfer/client/get_waiter.html)
1044
1109
  [Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_transfer/client/#get_waiter)
1045
1110
  """