types-aiobotocore-workspaces-instances 2.23.1__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.
@@ -0,0 +1,48 @@
1
+ """
2
+ Main interface for workspaces-instances service.
3
+
4
+ [Documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/)
5
+
6
+ Copyright 2025 Vlad Emelianov
7
+
8
+ Usage::
9
+
10
+ ```python
11
+ from aiobotocore.session import get_session
12
+ from types_aiobotocore_workspaces_instances import (
13
+ Client,
14
+ ListInstanceTypesPaginator,
15
+ ListRegionsPaginator,
16
+ ListWorkspaceInstancesPaginator,
17
+ WorkspacesInstancesClient,
18
+ )
19
+
20
+ session = get_session()
21
+ async with session.create_client("workspaces-instances") as client:
22
+ client: WorkspacesInstancesClient
23
+ ...
24
+
25
+
26
+ list_instance_types_paginator: ListInstanceTypesPaginator = client.get_paginator("list_instance_types")
27
+ list_regions_paginator: ListRegionsPaginator = client.get_paginator("list_regions")
28
+ list_workspace_instances_paginator: ListWorkspaceInstancesPaginator = client.get_paginator("list_workspace_instances")
29
+ ```
30
+ """
31
+
32
+ from .client import WorkspacesInstancesClient
33
+ from .paginator import (
34
+ ListInstanceTypesPaginator,
35
+ ListRegionsPaginator,
36
+ ListWorkspaceInstancesPaginator,
37
+ )
38
+
39
+ Client = WorkspacesInstancesClient
40
+
41
+
42
+ __all__ = (
43
+ "Client",
44
+ "ListInstanceTypesPaginator",
45
+ "ListRegionsPaginator",
46
+ "ListWorkspaceInstancesPaginator",
47
+ "WorkspacesInstancesClient",
48
+ )
@@ -0,0 +1,47 @@
1
+ """
2
+ Main interface for workspaces-instances service.
3
+
4
+ [Documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/)
5
+
6
+ Copyright 2025 Vlad Emelianov
7
+
8
+ Usage::
9
+
10
+ ```python
11
+ from aiobotocore.session import get_session
12
+ from types_aiobotocore_workspaces_instances import (
13
+ Client,
14
+ ListInstanceTypesPaginator,
15
+ ListRegionsPaginator,
16
+ ListWorkspaceInstancesPaginator,
17
+ WorkspacesInstancesClient,
18
+ )
19
+
20
+ session = get_session()
21
+ async with session.create_client("workspaces-instances") as client:
22
+ client: WorkspacesInstancesClient
23
+ ...
24
+
25
+
26
+ list_instance_types_paginator: ListInstanceTypesPaginator = client.get_paginator("list_instance_types")
27
+ list_regions_paginator: ListRegionsPaginator = client.get_paginator("list_regions")
28
+ list_workspace_instances_paginator: ListWorkspaceInstancesPaginator = client.get_paginator("list_workspace_instances")
29
+ ```
30
+ """
31
+
32
+ from .client import WorkspacesInstancesClient
33
+ from .paginator import (
34
+ ListInstanceTypesPaginator,
35
+ ListRegionsPaginator,
36
+ ListWorkspaceInstancesPaginator,
37
+ )
38
+
39
+ Client = WorkspacesInstancesClient
40
+
41
+ __all__ = (
42
+ "Client",
43
+ "ListInstanceTypesPaginator",
44
+ "ListRegionsPaginator",
45
+ "ListWorkspaceInstancesPaginator",
46
+ "WorkspacesInstancesClient",
47
+ )
@@ -0,0 +1,43 @@
1
+ """
2
+ Main CLI entrypoint.
3
+
4
+ Copyright 2025 Vlad Emelianov
5
+ """
6
+
7
+ import sys
8
+
9
+
10
+ def print_info() -> None:
11
+ """
12
+ Print package info to stdout.
13
+ """
14
+ sys.stdout.write(
15
+ "Type annotations for aiobotocore WorkspacesInstances 2.23.1\n"
16
+ "Version: 2.23.1\n"
17
+ "Builder version: 8.11.0\n"
18
+ "Docs: https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances//\n"
19
+ "Boto3 docs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances.html#workspacesinstances\n"
20
+ "Other services: https://pypi.org/project/boto3-stubs/\n"
21
+ "Changelog: https://github.com/youtype/mypy_boto3_builder/releases\n"
22
+ )
23
+
24
+
25
+ def print_version() -> None:
26
+ """
27
+ Print package version to stdout.
28
+ """
29
+ sys.stdout.write("2.23.1\n")
30
+
31
+
32
+ def main() -> None:
33
+ """
34
+ Main CLI entrypoint.
35
+ """
36
+ if "--version" in sys.argv:
37
+ print_version()
38
+ return
39
+ print_info()
40
+
41
+
42
+ if __name__ == "__main__":
43
+ main()
@@ -0,0 +1,295 @@
1
+ """
2
+ Type annotations for workspaces-instances service Client.
3
+
4
+ [Documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/)
5
+
6
+ Copyright 2025 Vlad Emelianov
7
+
8
+ Usage::
9
+
10
+ ```python
11
+ from aiobotocore.session import get_session
12
+ from types_aiobotocore_workspaces_instances.client import WorkspacesInstancesClient
13
+
14
+ session = get_session()
15
+ async with session.create_client("workspaces-instances") as client:
16
+ client: WorkspacesInstancesClient
17
+ ```
18
+ """
19
+
20
+ from __future__ import annotations
21
+
22
+ import sys
23
+ from types import TracebackType
24
+ from typing import Any, overload
25
+
26
+ from aiobotocore.client import AioBaseClient
27
+ from botocore.client import ClientMeta
28
+ from botocore.errorfactory import BaseClientExceptions
29
+ from botocore.exceptions import ClientError as BotocoreClientError
30
+
31
+ from .paginator import (
32
+ ListInstanceTypesPaginator,
33
+ ListRegionsPaginator,
34
+ ListWorkspaceInstancesPaginator,
35
+ )
36
+ from .type_defs import (
37
+ AssociateVolumeRequestTypeDef,
38
+ CreateVolumeRequestTypeDef,
39
+ CreateVolumeResponseTypeDef,
40
+ CreateWorkspaceInstanceRequestTypeDef,
41
+ CreateWorkspaceInstanceResponseTypeDef,
42
+ DeleteVolumeRequestTypeDef,
43
+ DeleteWorkspaceInstanceRequestTypeDef,
44
+ DisassociateVolumeRequestTypeDef,
45
+ GetWorkspaceInstanceRequestTypeDef,
46
+ GetWorkspaceInstanceResponseTypeDef,
47
+ ListInstanceTypesRequestTypeDef,
48
+ ListInstanceTypesResponseTypeDef,
49
+ ListRegionsRequestTypeDef,
50
+ ListRegionsResponseTypeDef,
51
+ ListTagsForResourceRequestTypeDef,
52
+ ListTagsForResourceResponseTypeDef,
53
+ ListWorkspaceInstancesRequestTypeDef,
54
+ ListWorkspaceInstancesResponseTypeDef,
55
+ TagResourceRequestTypeDef,
56
+ UntagResourceRequestTypeDef,
57
+ )
58
+
59
+ if sys.version_info >= (3, 9):
60
+ from builtins import dict as Dict
61
+ from builtins import type as Type
62
+ from collections.abc import Mapping
63
+ else:
64
+ from typing import Dict, Mapping, Type
65
+ if sys.version_info >= (3, 12):
66
+ from typing import Literal, Self, Unpack
67
+ else:
68
+ from typing_extensions import Literal, Self, Unpack
69
+
70
+
71
+ __all__ = ("WorkspacesInstancesClient",)
72
+
73
+
74
+ class Exceptions(BaseClientExceptions):
75
+ AccessDeniedException: Type[BotocoreClientError]
76
+ ClientError: Type[BotocoreClientError]
77
+ ConflictException: Type[BotocoreClientError]
78
+ InternalServerException: Type[BotocoreClientError]
79
+ ResourceNotFoundException: Type[BotocoreClientError]
80
+ ServiceQuotaExceededException: Type[BotocoreClientError]
81
+ ThrottlingException: Type[BotocoreClientError]
82
+ ValidationException: Type[BotocoreClientError]
83
+
84
+
85
+ class WorkspacesInstancesClient(AioBaseClient):
86
+ """
87
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances.html#WorkspacesInstances.Client)
88
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/)
89
+ """
90
+
91
+ meta: ClientMeta
92
+
93
+ @property
94
+ def exceptions(self) -> Exceptions:
95
+ """
96
+ WorkspacesInstancesClient exceptions.
97
+
98
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances.html#WorkspacesInstances.Client)
99
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#exceptions)
100
+ """
101
+
102
+ def can_paginate(self, operation_name: str) -> bool:
103
+ """
104
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/can_paginate.html)
105
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#can_paginate)
106
+ """
107
+
108
+ async def generate_presigned_url(
109
+ self,
110
+ ClientMethod: str,
111
+ Params: Mapping[str, Any] = ...,
112
+ ExpiresIn: int = 3600,
113
+ HttpMethod: str = ...,
114
+ ) -> str:
115
+ """
116
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/generate_presigned_url.html)
117
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#generate_presigned_url)
118
+ """
119
+
120
+ async def associate_volume(
121
+ self, **kwargs: Unpack[AssociateVolumeRequestTypeDef]
122
+ ) -> Dict[str, Any]:
123
+ """
124
+ Attaches a volume to a WorkSpace Instance.
125
+
126
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/associate_volume.html)
127
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#associate_volume)
128
+ """
129
+
130
+ async def create_volume(
131
+ self, **kwargs: Unpack[CreateVolumeRequestTypeDef]
132
+ ) -> CreateVolumeResponseTypeDef:
133
+ """
134
+ Creates a new volume for WorkSpace Instances.
135
+
136
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/create_volume.html)
137
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#create_volume)
138
+ """
139
+
140
+ async def create_workspace_instance(
141
+ self, **kwargs: Unpack[CreateWorkspaceInstanceRequestTypeDef]
142
+ ) -> CreateWorkspaceInstanceResponseTypeDef:
143
+ """
144
+ Launches a new WorkSpace Instance with specified configuration parameters,
145
+ enabling programmatic workspace deployment.
146
+
147
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/create_workspace_instance.html)
148
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#create_workspace_instance)
149
+ """
150
+
151
+ async def delete_volume(self, **kwargs: Unpack[DeleteVolumeRequestTypeDef]) -> Dict[str, Any]:
152
+ """
153
+ Deletes a specified volume.
154
+
155
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/delete_volume.html)
156
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#delete_volume)
157
+ """
158
+
159
+ async def delete_workspace_instance(
160
+ self, **kwargs: Unpack[DeleteWorkspaceInstanceRequestTypeDef]
161
+ ) -> Dict[str, Any]:
162
+ """
163
+ Deletes the specified WorkSpace.
164
+
165
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/delete_workspace_instance.html)
166
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#delete_workspace_instance)
167
+ """
168
+
169
+ async def disassociate_volume(
170
+ self, **kwargs: Unpack[DisassociateVolumeRequestTypeDef]
171
+ ) -> Dict[str, Any]:
172
+ """
173
+ Detaches a volume from a WorkSpace Instance.
174
+
175
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/disassociate_volume.html)
176
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#disassociate_volume)
177
+ """
178
+
179
+ async def get_workspace_instance(
180
+ self, **kwargs: Unpack[GetWorkspaceInstanceRequestTypeDef]
181
+ ) -> GetWorkspaceInstanceResponseTypeDef:
182
+ """
183
+ Retrieves detailed information about a specific WorkSpace Instance.
184
+
185
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/get_workspace_instance.html)
186
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#get_workspace_instance)
187
+ """
188
+
189
+ async def list_instance_types(
190
+ self, **kwargs: Unpack[ListInstanceTypesRequestTypeDef]
191
+ ) -> ListInstanceTypesResponseTypeDef:
192
+ """
193
+ Retrieves a list of instance types supported by Amazon WorkSpaces Instances,
194
+ enabling precise workspace infrastructure configuration.
195
+
196
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/list_instance_types.html)
197
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#list_instance_types)
198
+ """
199
+
200
+ async def list_regions(
201
+ self, **kwargs: Unpack[ListRegionsRequestTypeDef]
202
+ ) -> ListRegionsResponseTypeDef:
203
+ """
204
+ Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances,
205
+ enabling region discovery for workspace deployments.
206
+
207
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/list_regions.html)
208
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#list_regions)
209
+ """
210
+
211
+ async def list_tags_for_resource(
212
+ self, **kwargs: Unpack[ListTagsForResourceRequestTypeDef]
213
+ ) -> ListTagsForResourceResponseTypeDef:
214
+ """
215
+ Retrieves tags for a WorkSpace Instance.
216
+
217
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/list_tags_for_resource.html)
218
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#list_tags_for_resource)
219
+ """
220
+
221
+ async def list_workspace_instances(
222
+ self, **kwargs: Unpack[ListWorkspaceInstancesRequestTypeDef]
223
+ ) -> ListWorkspaceInstancesResponseTypeDef:
224
+ """
225
+ Retrieves a collection of WorkSpaces Instances based on specified filters.
226
+
227
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/list_workspace_instances.html)
228
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#list_workspace_instances)
229
+ """
230
+
231
+ async def tag_resource(self, **kwargs: Unpack[TagResourceRequestTypeDef]) -> Dict[str, Any]:
232
+ """
233
+ Adds tags to a WorkSpace Instance.
234
+
235
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/tag_resource.html)
236
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#tag_resource)
237
+ """
238
+
239
+ async def untag_resource(self, **kwargs: Unpack[UntagResourceRequestTypeDef]) -> Dict[str, Any]:
240
+ """
241
+ Removes tags from a WorkSpace Instance.
242
+
243
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/untag_resource.html)
244
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#untag_resource)
245
+ """
246
+
247
+ @overload # type: ignore[override]
248
+ def get_paginator( # type: ignore[override]
249
+ self, operation_name: Literal["list_instance_types"]
250
+ ) -> ListInstanceTypesPaginator:
251
+ """
252
+ Create a paginator for an operation.
253
+
254
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/get_paginator.html)
255
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#get_paginator)
256
+ """
257
+
258
+ @overload # type: ignore[override]
259
+ def get_paginator( # type: ignore[override]
260
+ self, operation_name: Literal["list_regions"]
261
+ ) -> ListRegionsPaginator:
262
+ """
263
+ Create a paginator for an operation.
264
+
265
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/get_paginator.html)
266
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#get_paginator)
267
+ """
268
+
269
+ @overload # type: ignore[override]
270
+ def get_paginator( # type: ignore[override]
271
+ self, operation_name: Literal["list_workspace_instances"]
272
+ ) -> ListWorkspaceInstancesPaginator:
273
+ """
274
+ Create a paginator for an operation.
275
+
276
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances/client/get_paginator.html)
277
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/#get_paginator)
278
+ """
279
+
280
+ async def __aenter__(self) -> Self:
281
+ """
282
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances.html#WorkspacesInstances.Client)
283
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/)
284
+ """
285
+
286
+ async def __aexit__(
287
+ self,
288
+ exc_type: Type[BaseException] | None,
289
+ exc_val: BaseException | None,
290
+ exc_tb: TracebackType | None,
291
+ ) -> None:
292
+ """
293
+ [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/workspaces-instances.html#WorkspacesInstances.Client)
294
+ [Show types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_instances/client/)
295
+ """