types-boto3-ds 1.35.93__tar.gz

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,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Vlad Emelianov
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,515 @@
1
+ Metadata-Version: 2.1
2
+ Name: types-boto3-ds
3
+ Version: 1.35.93
4
+ Summary: Type annotations for boto3 DirectoryService 1.35.93 service generated with mypy-boto3-builder 8.8.0
5
+ Home-page: https://github.com/youtype/mypy_boto3_builder
6
+ Author: Vlad Emelianov
7
+ Author-email: vlad.emelianov.nz@gmail.com
8
+ License: MIT License
9
+ Project-URL: Documentation, https://youtype.github.io/types_boto3_docs/types_boto3_ds/
10
+ Project-URL: Source, https://github.com/youtype/mypy_boto3_builder
11
+ Project-URL: Tracker, https://github.com/youtype/mypy_boto3_builder/issues
12
+ Keywords: boto3 ds boto3-stubs type-annotations mypy typeshed autocomplete
13
+ Classifier: Development Status :: 5 - Production/Stable
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: Environment :: Console
16
+ Classifier: License :: OSI Approved :: MIT License
17
+ Classifier: Natural Language :: English
18
+ Classifier: Operating System :: OS Independent
19
+ Classifier: Programming Language :: Python :: 3
20
+ Classifier: Programming Language :: Python :: 3.8
21
+ Classifier: Programming Language :: Python :: 3.9
22
+ Classifier: Programming Language :: Python :: 3.10
23
+ Classifier: Programming Language :: Python :: 3.11
24
+ Classifier: Programming Language :: Python :: 3.12
25
+ Classifier: Programming Language :: Python :: 3.13
26
+ Classifier: Programming Language :: Python :: 3.14
27
+ Classifier: Programming Language :: Python :: 3 :: Only
28
+ Classifier: Programming Language :: Python :: Implementation :: CPython
29
+ Classifier: Typing :: Stubs Only
30
+ Requires-Python: >=3.8
31
+ Description-Content-Type: text/markdown
32
+ License-File: LICENSE
33
+ Requires-Dist: typing-extensions; python_version < "3.12"
34
+
35
+ <a id="types-boto3-ds"></a>
36
+
37
+ # types-boto3-ds
38
+
39
+ [![PyPI - types-boto3-ds](https://img.shields.io/pypi/v/types-boto3-ds.svg?color=blue)](https://pypi.org/project/types-boto3-ds/)
40
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-boto3-ds.svg?color=blue)](https://pypi.org/project/types-boto3-ds/)
41
+ [![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/types_boto3_docs/)
42
+ [![PyPI - Downloads](https://static.pepy.tech/badge/types-boto3-ds)](https://pypistats.org/packages/types-boto3-ds)
43
+
44
+ ![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
45
+
46
+ Type annotations for
47
+ [boto3 DirectoryService 1.35.93](https://pypi.org/project/boto3/) compatible
48
+ with [VSCode](https://code.visualstudio.com/),
49
+ [PyCharm](https://www.jetbrains.com/pycharm/),
50
+ [Emacs](https://www.gnu.org/software/emacs/),
51
+ [Sublime Text](https://www.sublimetext.com/),
52
+ [mypy](https://github.com/python/mypy),
53
+ [pyright](https://github.com/microsoft/pyright) and other tools.
54
+
55
+ Generated with
56
+ [mypy-boto3-builder 8.8.0](https://github.com/youtype/mypy_boto3_builder).
57
+
58
+ More information can be found on
59
+ [types-boto3](https://pypi.org/project/types-boto3/) page and in
60
+ [types-boto3-ds docs](https://youtype.github.io/types_boto3_docs/types_boto3_ds/).
61
+
62
+ See how it helps you find and fix potential bugs:
63
+
64
+ ![types-boto3 demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
65
+
66
+ - [types-boto3-ds](#types-boto3-ds)
67
+ - [How to install](#how-to-install)
68
+ - [Generate locally (recommended)](<#generate-locally-(recommended)>)
69
+ - [VSCode extension](#vscode-extension)
70
+ - [From PyPI with pip](#from-pypi-with-pip)
71
+ - [How to uninstall](#how-to-uninstall)
72
+ - [Usage](#usage)
73
+ - [VSCode](#vscode)
74
+ - [PyCharm](#pycharm)
75
+ - [Emacs](#emacs)
76
+ - [Sublime Text](#sublime-text)
77
+ - [Other IDEs](#other-ides)
78
+ - [mypy](#mypy)
79
+ - [pyright](#pyright)
80
+ - [Pylint compatibility](#pylint-compatibility)
81
+ - [Explicit type annotations](#explicit-type-annotations)
82
+ - [Client annotations](#client-annotations)
83
+ - [Paginators annotations](#paginators-annotations)
84
+ - [Literals](#literals)
85
+ - [Type definitions](#type-definitions)
86
+ - [How it works](#how-it-works)
87
+ - [What's new](#what's-new)
88
+ - [Implemented features](#implemented-features)
89
+ - [Latest changes](#latest-changes)
90
+ - [Versioning](#versioning)
91
+ - [Thank you](#thank-you)
92
+ - [Documentation](#documentation)
93
+ - [Support and contributing](#support-and-contributing)
94
+
95
+ <a id="how-to-install"></a>
96
+
97
+ ## How to install
98
+
99
+ <a id="generate-locally-(recommended)"></a>
100
+
101
+ ### Generate locally (recommended)
102
+
103
+ You can generate type annotations for `boto3` package locally with
104
+ `mypy_boto3_builder`. Use
105
+ [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
106
+ isolation.
107
+
108
+ 1. Run mypy-boto3-builder in your package root directory:
109
+ `uvx --with 'boto3==1.35.93' mypy_boto3_builder`
110
+ 2. Select `boto3` AWS SDK.
111
+ 3. Add `DirectoryService` service.
112
+ 4. Use provided commands to install generated packages.
113
+
114
+ <a id="vscode-extension"></a>
115
+
116
+ ### VSCode extension
117
+
118
+ Add
119
+ [AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
120
+ extension to your VSCode and run `AWS boto3: Quick Start` command.
121
+
122
+ Click `Modify` and select `boto3 common` and `DirectoryService`.
123
+
124
+ <a id="from-pypi-with-pip"></a>
125
+
126
+ ### From PyPI with pip
127
+
128
+ Install `types-boto3` for `DirectoryService` service.
129
+
130
+ ```bash
131
+ # install with boto3 type annotations
132
+ python -m pip install 'types-boto3[ds]'
133
+
134
+ # Lite version does not provide session.client/resource overloads
135
+ # it is more RAM-friendly, but requires explicit type annotations
136
+ python -m pip install 'types-boto3-lite[ds]'
137
+
138
+ # standalone installation
139
+ python -m pip install types-boto3-ds
140
+ ```
141
+
142
+ <a id="how-to-uninstall"></a>
143
+
144
+ ## How to uninstall
145
+
146
+ ```bash
147
+ python -m pip uninstall -y types-boto3-ds
148
+ ```
149
+
150
+ <a id="usage"></a>
151
+
152
+ ## Usage
153
+
154
+ <a id="vscode"></a>
155
+
156
+ ### VSCode
157
+
158
+ - Install
159
+ [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
160
+ - Install
161
+ [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
162
+ - Set `Pylance` as your Python Language Server
163
+ - Install `types-boto3[ds]` in your environment:
164
+
165
+ ```bash
166
+ python -m pip install 'types-boto3[ds]'
167
+ ```
168
+
169
+ Both type checking and code completion should now work. No explicit type
170
+ annotations required, write your `boto3` code as usual.
171
+
172
+ <a id="pycharm"></a>
173
+
174
+ ### PyCharm
175
+
176
+ > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
177
+ > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
178
+ > to use [types-boto3-lite](https://pypi.org/project/types-boto3-lite/) until
179
+ > the issue is resolved.
180
+
181
+ > ⚠️ If you experience slow performance and high CPU usage, try to disable
182
+ > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
183
+ > [pyright](https://github.com/microsoft/pyright) instead.
184
+
185
+ > ⚠️ To continue using `PyCharm` type checker, you can try to replace
186
+ > `types-boto3` with
187
+ > [types-boto3-lite](https://pypi.org/project/types-boto3-lite/):
188
+
189
+ ```bash
190
+ pip uninstall types-boto3
191
+ pip install types-boto3-lite
192
+ ```
193
+
194
+ Install `types-boto3[ds]` in your environment:
195
+
196
+ ```bash
197
+ python -m pip install 'types-boto3[ds]'
198
+ ```
199
+
200
+ Both type checking and code completion should now work.
201
+
202
+ <a id="emacs"></a>
203
+
204
+ ### Emacs
205
+
206
+ - Install `types-boto3` with services you use in your environment:
207
+
208
+ ```bash
209
+ python -m pip install 'types-boto3[ds]'
210
+ ```
211
+
212
+ - Install [use-package](https://github.com/jwiegley/use-package),
213
+ [lsp](https://github.com/emacs-lsp/lsp-mode/),
214
+ [company](https://github.com/company-mode/company-mode) and
215
+ [flycheck](https://github.com/flycheck/flycheck) packages
216
+ - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
217
+
218
+ ```elisp
219
+ (use-package lsp-pyright
220
+ :ensure t
221
+ :hook (python-mode . (lambda ()
222
+ (require 'lsp-pyright)
223
+ (lsp))) ; or lsp-deferred
224
+ :init (when (executable-find "python3")
225
+ (setq lsp-pyright-python-executable-cmd "python3"))
226
+ )
227
+ ```
228
+
229
+ - Make sure emacs uses the environment where you have installed `types-boto3`
230
+
231
+ Type checking should now work. No explicit type annotations required, write
232
+ your `boto3` code as usual.
233
+
234
+ <a id="sublime-text"></a>
235
+
236
+ ### Sublime Text
237
+
238
+ - Install `types-boto3[ds]` with services you use in your environment:
239
+
240
+ ```bash
241
+ python -m pip install 'types-boto3[ds]'
242
+ ```
243
+
244
+ - Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
245
+
246
+ Type checking should now work. No explicit type annotations required, write
247
+ your `boto3` code as usual.
248
+
249
+ <a id="other-ides"></a>
250
+
251
+ ### Other IDEs
252
+
253
+ Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
254
+ should work.
255
+
256
+ <a id="mypy"></a>
257
+
258
+ ### mypy
259
+
260
+ - Install `mypy`: `python -m pip install mypy`
261
+ - Install `types-boto3[ds]` in your environment:
262
+
263
+ ```bash
264
+ python -m pip install 'types-boto3[ds]'
265
+ ```
266
+
267
+ Type checking should now work. No explicit type annotations required, write
268
+ your `boto3` code as usual.
269
+
270
+ <a id="pyright"></a>
271
+
272
+ ### pyright
273
+
274
+ - Install `pyright`: `npm i -g pyright`
275
+ - Install `types-boto3[ds]` in your environment:
276
+
277
+ ```bash
278
+ python -m pip install 'types-boto3[ds]'
279
+ ```
280
+
281
+ Optionally, you can install `types-boto3` to `typings` directory.
282
+
283
+ Type checking should now work. No explicit type annotations required, write
284
+ your `boto3` code as usual.
285
+
286
+ <a id="pylint-compatibility"></a>
287
+
288
+ ### Pylint compatibility
289
+
290
+ It is totally safe to use `TYPE_CHECKING` flag in order to avoid
291
+ `types-boto3-ds` dependency in production. However, there is an issue in
292
+ `pylint` that it complains about undefined variables. To fix it, set all types
293
+ to `object` in non-`TYPE_CHECKING` mode.
294
+
295
+ ```python
296
+ from typing import TYPE_CHECKING
297
+
298
+ if TYPE_CHECKING:
299
+ from types_boto3_ec2 import EC2Client, EC2ServiceResource
300
+ from types_boto3_ec2.waiters import BundleTaskCompleteWaiter
301
+ from types_boto3_ec2.paginators import DescribeVolumesPaginator
302
+ else:
303
+ EC2Client = object
304
+ EC2ServiceResource = object
305
+ BundleTaskCompleteWaiter = object
306
+ DescribeVolumesPaginator = object
307
+
308
+ ...
309
+ ```
310
+
311
+ <a id="explicit-type-annotations"></a>
312
+
313
+ ## Explicit type annotations
314
+
315
+ <a id="client-annotations"></a>
316
+
317
+ ### Client annotations
318
+
319
+ `DirectoryServiceClient` provides annotations for `boto3.client("ds")`.
320
+
321
+ ```python
322
+ from boto3.session import Session
323
+
324
+ from types_boto3_ds import DirectoryServiceClient
325
+
326
+ client: DirectoryServiceClient = Session().client("ds")
327
+
328
+ # now client usage is checked by mypy and IDE should provide code completion
329
+ ```
330
+
331
+ <a id="paginators-annotations"></a>
332
+
333
+ ### Paginators annotations
334
+
335
+ `types_boto3_ds.paginator` module contains type annotations for all paginators.
336
+
337
+ ```python
338
+ from boto3.session import Session
339
+
340
+ from types_boto3_ds import DirectoryServiceClient
341
+ from types_boto3_ds.paginator import (
342
+ DescribeClientAuthenticationSettingsPaginator,
343
+ DescribeDirectoriesPaginator,
344
+ DescribeDomainControllersPaginator,
345
+ DescribeLDAPSSettingsPaginator,
346
+ DescribeRegionsPaginator,
347
+ DescribeSharedDirectoriesPaginator,
348
+ DescribeSnapshotsPaginator,
349
+ DescribeTrustsPaginator,
350
+ DescribeUpdateDirectoryPaginator,
351
+ ListCertificatesPaginator,
352
+ ListIpRoutesPaginator,
353
+ ListLogSubscriptionsPaginator,
354
+ ListSchemaExtensionsPaginator,
355
+ ListTagsForResourcePaginator,
356
+ )
357
+
358
+ client: DirectoryServiceClient = Session().client("ds")
359
+
360
+ # Explicit type annotations are optional here
361
+ # Types should be correctly discovered by mypy and IDEs
362
+ describe_client_authentication_settings_paginator: DescribeClientAuthenticationSettingsPaginator = (
363
+ client.get_paginator("describe_client_authentication_settings")
364
+ )
365
+ describe_directories_paginator: DescribeDirectoriesPaginator = client.get_paginator(
366
+ "describe_directories"
367
+ )
368
+ describe_domain_controllers_paginator: DescribeDomainControllersPaginator = client.get_paginator(
369
+ "describe_domain_controllers"
370
+ )
371
+ describe_ldaps_settings_paginator: DescribeLDAPSSettingsPaginator = client.get_paginator(
372
+ "describe_ldaps_settings"
373
+ )
374
+ describe_regions_paginator: DescribeRegionsPaginator = client.get_paginator("describe_regions")
375
+ describe_shared_directories_paginator: DescribeSharedDirectoriesPaginator = client.get_paginator(
376
+ "describe_shared_directories"
377
+ )
378
+ describe_snapshots_paginator: DescribeSnapshotsPaginator = client.get_paginator(
379
+ "describe_snapshots"
380
+ )
381
+ describe_trusts_paginator: DescribeTrustsPaginator = client.get_paginator("describe_trusts")
382
+ describe_update_directory_paginator: DescribeUpdateDirectoryPaginator = client.get_paginator(
383
+ "describe_update_directory"
384
+ )
385
+ list_certificates_paginator: ListCertificatesPaginator = client.get_paginator("list_certificates")
386
+ list_ip_routes_paginator: ListIpRoutesPaginator = client.get_paginator("list_ip_routes")
387
+ list_log_subscriptions_paginator: ListLogSubscriptionsPaginator = client.get_paginator(
388
+ "list_log_subscriptions"
389
+ )
390
+ list_schema_extensions_paginator: ListSchemaExtensionsPaginator = client.get_paginator(
391
+ "list_schema_extensions"
392
+ )
393
+ list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(
394
+ "list_tags_for_resource"
395
+ )
396
+ ```
397
+
398
+ <a id="literals"></a>
399
+
400
+ ### Literals
401
+
402
+ `types_boto3_ds.literals` module contains literals extracted from shapes that
403
+ can be used in user code for type checking.
404
+
405
+ Full list of `DirectoryService` Literals can be found in
406
+ [docs](https://youtype.github.io/types_boto3_docs/types_boto3_ds/literals/).
407
+
408
+ ```python
409
+ from types_boto3_ds.literals import CertificateStateType
410
+
411
+
412
+ def check_value(value: CertificateStateType) -> bool: ...
413
+ ```
414
+
415
+ <a id="type-definitions"></a>
416
+
417
+ ### Type definitions
418
+
419
+ `types_boto3_ds.type_defs` module contains structures and shapes assembled to
420
+ typed dictionaries and unions for additional type checking.
421
+
422
+ Full list of `DirectoryService` TypeDefs can be found in
423
+ [docs](https://youtype.github.io/types_boto3_docs/types_boto3_ds/type_defs/).
424
+
425
+ ```python
426
+ from types_boto3_ds.type_defs import AcceptSharedDirectoryRequestRequestTypeDef
427
+
428
+
429
+ def get_value() -> AcceptSharedDirectoryRequestRequestTypeDef:
430
+ return {...}
431
+ ```
432
+
433
+ <a id="how-it-works"></a>
434
+
435
+ ## How it works
436
+
437
+ Fully automated
438
+ [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
439
+ generates type annotations for each service, patiently waiting for `boto3`
440
+ updates. It delivers drop-in type annotations for you and makes sure that:
441
+
442
+ - All available `boto3` services are covered.
443
+ - Each public class and method of every `boto3` service gets valid type
444
+ annotations extracted from `botocore` schemas.
445
+ - Type annotations include up-to-date documentation.
446
+ - Link to documentation is provided for every method.
447
+ - Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.
448
+
449
+ <a id="what's-new"></a>
450
+
451
+ ## What's new
452
+
453
+ <a id="implemented-features"></a>
454
+
455
+ ### Implemented features
456
+
457
+ - Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
458
+ libraries
459
+ - `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
460
+ compatibility
461
+ - `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
462
+ annotations for each service
463
+ - Generated `TypeDefs` for each service
464
+ - Generated `Literals` for each service
465
+ - Auto discovery of types for `boto3.client` and `boto3.resource` calls
466
+ - Auto discovery of types for `session.client` and `session.resource` calls
467
+ - Auto discovery of types for `client.get_waiter` and `client.get_paginator`
468
+ calls
469
+ - Auto discovery of types for `ServiceResource` and `Resource` collections
470
+ - Auto discovery of types for `aiobotocore.Session.create_client` calls
471
+
472
+ <a id="latest-changes"></a>
473
+
474
+ ### Latest changes
475
+
476
+ Builder changelog can be found in
477
+ [Releases](https://github.com/youtype/mypy_boto3_builder/releases).
478
+
479
+ <a id="versioning"></a>
480
+
481
+ ## Versioning
482
+
483
+ `types-boto3-ds` version is the same as related `boto3` version and follows
484
+ [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
485
+
486
+ <a id="thank-you"></a>
487
+
488
+ ## Thank you
489
+
490
+ - [Allie Fitter](https://github.com/alliefitter) for
491
+ [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
492
+ this package is based on top of his work
493
+ - [black](https://github.com/psf/black) developers for an awesome formatting
494
+ tool
495
+ - [Timothy Edmund Crosley](https://github.com/timothycrosley) for
496
+ [isort](https://github.com/PyCQA/isort) and how flexible it is
497
+ - [mypy](https://github.com/python/mypy) developers for doing all dirty work
498
+ for us
499
+ - [pyright](https://github.com/microsoft/pyright) team for the new era of typed
500
+ Python
501
+
502
+ <a id="documentation"></a>
503
+
504
+ ## Documentation
505
+
506
+ All services type annotations can be found in
507
+ [boto3 docs](https://youtype.github.io/types_boto3_docs/types_boto3_ds/)
508
+
509
+ <a id="support-and-contributing"></a>
510
+
511
+ ## Support and contributing
512
+
513
+ This package is auto-generated. Please reports any bugs or request new features
514
+ in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
515
+ repository.