types-boto3-secretsmanager 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.
Files changed (24) hide show
  1. types_boto3_secretsmanager-1.35.93/LICENSE +21 -0
  2. types_boto3_secretsmanager-1.35.93/PKG-INFO +470 -0
  3. types_boto3_secretsmanager-1.35.93/README.md +436 -0
  4. types_boto3_secretsmanager-1.35.93/setup.cfg +4 -0
  5. types_boto3_secretsmanager-1.35.93/setup.py +54 -0
  6. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager/__init__.py +29 -0
  7. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager/__init__.pyi +28 -0
  8. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager/__main__.py +43 -0
  9. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager/client.py +391 -0
  10. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager/client.pyi +388 -0
  11. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager/literals.py +496 -0
  12. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager/literals.pyi +494 -0
  13. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager/paginator.py +61 -0
  14. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager/paginator.pyi +57 -0
  15. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager/py.typed +0 -0
  16. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager/type_defs.py +508 -0
  17. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager/type_defs.pyi +448 -0
  18. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager/version.py +7 -0
  19. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager.egg-info/PKG-INFO +470 -0
  20. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager.egg-info/SOURCES.txt +22 -0
  21. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager.egg-info/dependency_links.txt +1 -0
  22. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager.egg-info/not-zip-safe +1 -0
  23. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager.egg-info/requires.txt +3 -0
  24. types_boto3_secretsmanager-1.35.93/types_boto3_secretsmanager.egg-info/top_level.txt +1 -0
@@ -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,470 @@
1
+ Metadata-Version: 2.1
2
+ Name: types-boto3-secretsmanager
3
+ Version: 1.35.93
4
+ Summary: Type annotations for boto3 SecretsManager 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_secretsmanager/
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 secretsmanager 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-secretsmanager"></a>
36
+
37
+ # types-boto3-secretsmanager
38
+
39
+ [![PyPI - types-boto3-secretsmanager](https://img.shields.io/pypi/v/types-boto3-secretsmanager.svg?color=blue)](https://pypi.org/project/types-boto3-secretsmanager/)
40
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-boto3-secretsmanager.svg?color=blue)](https://pypi.org/project/types-boto3-secretsmanager/)
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-secretsmanager)](https://pypistats.org/packages/types-boto3-secretsmanager)
43
+
44
+ ![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
45
+
46
+ Type annotations for
47
+ [boto3 SecretsManager 1.35.93](https://pypi.org/project/boto3/) compatible with
48
+ [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-secretsmanager docs](https://youtype.github.io/types_boto3_docs/types_boto3_secretsmanager/).
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-secretsmanager](#types-boto3-secretsmanager)
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 `SecretsManager` 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 `SecretsManager`.
123
+
124
+ <a id="from-pypi-with-pip"></a>
125
+
126
+ ### From PyPI with pip
127
+
128
+ Install `types-boto3` for `SecretsManager` service.
129
+
130
+ ```bash
131
+ # install with boto3 type annotations
132
+ python -m pip install 'types-boto3[secretsmanager]'
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[secretsmanager]'
137
+
138
+ # standalone installation
139
+ python -m pip install types-boto3-secretsmanager
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-secretsmanager
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[secretsmanager]` in your environment:
164
+
165
+ ```bash
166
+ python -m pip install 'types-boto3[secretsmanager]'
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[secretsmanager]` in your environment:
195
+
196
+ ```bash
197
+ python -m pip install 'types-boto3[secretsmanager]'
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[secretsmanager]'
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[secretsmanager]` with services you use in your
239
+ environment:
240
+
241
+ ```bash
242
+ python -m pip install 'types-boto3[secretsmanager]'
243
+ ```
244
+
245
+ - Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
246
+
247
+ Type checking should now work. No explicit type annotations required, write
248
+ your `boto3` code as usual.
249
+
250
+ <a id="other-ides"></a>
251
+
252
+ ### Other IDEs
253
+
254
+ Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
255
+ should work.
256
+
257
+ <a id="mypy"></a>
258
+
259
+ ### mypy
260
+
261
+ - Install `mypy`: `python -m pip install mypy`
262
+ - Install `types-boto3[secretsmanager]` in your environment:
263
+
264
+ ```bash
265
+ python -m pip install 'types-boto3[secretsmanager]'
266
+ ```
267
+
268
+ Type checking should now work. No explicit type annotations required, write
269
+ your `boto3` code as usual.
270
+
271
+ <a id="pyright"></a>
272
+
273
+ ### pyright
274
+
275
+ - Install `pyright`: `npm i -g pyright`
276
+ - Install `types-boto3[secretsmanager]` in your environment:
277
+
278
+ ```bash
279
+ python -m pip install 'types-boto3[secretsmanager]'
280
+ ```
281
+
282
+ Optionally, you can install `types-boto3` to `typings` directory.
283
+
284
+ Type checking should now work. No explicit type annotations required, write
285
+ your `boto3` code as usual.
286
+
287
+ <a id="pylint-compatibility"></a>
288
+
289
+ ### Pylint compatibility
290
+
291
+ It is totally safe to use `TYPE_CHECKING` flag in order to avoid
292
+ `types-boto3-secretsmanager` dependency in production. However, there is an
293
+ issue in `pylint` that it complains about undefined variables. To fix it, set
294
+ all types to `object` in non-`TYPE_CHECKING` mode.
295
+
296
+ ```python
297
+ from typing import TYPE_CHECKING
298
+
299
+ if TYPE_CHECKING:
300
+ from types_boto3_ec2 import EC2Client, EC2ServiceResource
301
+ from types_boto3_ec2.waiters import BundleTaskCompleteWaiter
302
+ from types_boto3_ec2.paginators import DescribeVolumesPaginator
303
+ else:
304
+ EC2Client = object
305
+ EC2ServiceResource = object
306
+ BundleTaskCompleteWaiter = object
307
+ DescribeVolumesPaginator = object
308
+
309
+ ...
310
+ ```
311
+
312
+ <a id="explicit-type-annotations"></a>
313
+
314
+ ## Explicit type annotations
315
+
316
+ <a id="client-annotations"></a>
317
+
318
+ ### Client annotations
319
+
320
+ `SecretsManagerClient` provides annotations for
321
+ `boto3.client("secretsmanager")`.
322
+
323
+ ```python
324
+ from boto3.session import Session
325
+
326
+ from types_boto3_secretsmanager import SecretsManagerClient
327
+
328
+ client: SecretsManagerClient = Session().client("secretsmanager")
329
+
330
+ # now client usage is checked by mypy and IDE should provide code completion
331
+ ```
332
+
333
+ <a id="paginators-annotations"></a>
334
+
335
+ ### Paginators annotations
336
+
337
+ `types_boto3_secretsmanager.paginator` module contains type annotations for all
338
+ paginators.
339
+
340
+ ```python
341
+ from boto3.session import Session
342
+
343
+ from types_boto3_secretsmanager import SecretsManagerClient
344
+ from types_boto3_secretsmanager.paginator import ListSecretsPaginator
345
+
346
+ client: SecretsManagerClient = Session().client("secretsmanager")
347
+
348
+ # Explicit type annotations are optional here
349
+ # Types should be correctly discovered by mypy and IDEs
350
+ list_secrets_paginator: ListSecretsPaginator = client.get_paginator("list_secrets")
351
+ ```
352
+
353
+ <a id="literals"></a>
354
+
355
+ ### Literals
356
+
357
+ `types_boto3_secretsmanager.literals` module contains literals extracted from
358
+ shapes that can be used in user code for type checking.
359
+
360
+ Full list of `SecretsManager` Literals can be found in
361
+ [docs](https://youtype.github.io/types_boto3_docs/types_boto3_secretsmanager/literals/).
362
+
363
+ ```python
364
+ from types_boto3_secretsmanager.literals import FilterNameStringTypeType
365
+
366
+
367
+ def check_value(value: FilterNameStringTypeType) -> bool: ...
368
+ ```
369
+
370
+ <a id="type-definitions"></a>
371
+
372
+ ### Type definitions
373
+
374
+ `types_boto3_secretsmanager.type_defs` module contains structures and shapes
375
+ assembled to typed dictionaries and unions for additional type checking.
376
+
377
+ Full list of `SecretsManager` TypeDefs can be found in
378
+ [docs](https://youtype.github.io/types_boto3_docs/types_boto3_secretsmanager/type_defs/).
379
+
380
+ ```python
381
+ from types_boto3_secretsmanager.type_defs import APIErrorTypeTypeDef
382
+
383
+
384
+ def get_value() -> APIErrorTypeTypeDef:
385
+ return {...}
386
+ ```
387
+
388
+ <a id="how-it-works"></a>
389
+
390
+ ## How it works
391
+
392
+ Fully automated
393
+ [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
394
+ generates type annotations for each service, patiently waiting for `boto3`
395
+ updates. It delivers drop-in type annotations for you and makes sure that:
396
+
397
+ - All available `boto3` services are covered.
398
+ - Each public class and method of every `boto3` service gets valid type
399
+ annotations extracted from `botocore` schemas.
400
+ - Type annotations include up-to-date documentation.
401
+ - Link to documentation is provided for every method.
402
+ - Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.
403
+
404
+ <a id="what's-new"></a>
405
+
406
+ ## What's new
407
+
408
+ <a id="implemented-features"></a>
409
+
410
+ ### Implemented features
411
+
412
+ - Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
413
+ libraries
414
+ - `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
415
+ compatibility
416
+ - `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
417
+ annotations for each service
418
+ - Generated `TypeDefs` for each service
419
+ - Generated `Literals` for each service
420
+ - Auto discovery of types for `boto3.client` and `boto3.resource` calls
421
+ - Auto discovery of types for `session.client` and `session.resource` calls
422
+ - Auto discovery of types for `client.get_waiter` and `client.get_paginator`
423
+ calls
424
+ - Auto discovery of types for `ServiceResource` and `Resource` collections
425
+ - Auto discovery of types for `aiobotocore.Session.create_client` calls
426
+
427
+ <a id="latest-changes"></a>
428
+
429
+ ### Latest changes
430
+
431
+ Builder changelog can be found in
432
+ [Releases](https://github.com/youtype/mypy_boto3_builder/releases).
433
+
434
+ <a id="versioning"></a>
435
+
436
+ ## Versioning
437
+
438
+ `types-boto3-secretsmanager` version is the same as related `boto3` version and
439
+ follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
440
+
441
+ <a id="thank-you"></a>
442
+
443
+ ## Thank you
444
+
445
+ - [Allie Fitter](https://github.com/alliefitter) for
446
+ [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
447
+ this package is based on top of his work
448
+ - [black](https://github.com/psf/black) developers for an awesome formatting
449
+ tool
450
+ - [Timothy Edmund Crosley](https://github.com/timothycrosley) for
451
+ [isort](https://github.com/PyCQA/isort) and how flexible it is
452
+ - [mypy](https://github.com/python/mypy) developers for doing all dirty work
453
+ for us
454
+ - [pyright](https://github.com/microsoft/pyright) team for the new era of typed
455
+ Python
456
+
457
+ <a id="documentation"></a>
458
+
459
+ ## Documentation
460
+
461
+ All services type annotations can be found in
462
+ [boto3 docs](https://youtype.github.io/types_boto3_docs/types_boto3_secretsmanager/)
463
+
464
+ <a id="support-and-contributing"></a>
465
+
466
+ ## Support and contributing
467
+
468
+ This package is auto-generated. Please reports any bugs or request new features
469
+ in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
470
+ repository.