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