types-boto3-cloudformation 1.36.0__tar.gz

types_boto3_cloudformation-1.36.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Vlad Emelianov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

types_boto3_cloudformation-1.36.0/PKG-INFO

@@ -0,0 +1,651 @@
+Metadata-Version: 2.2
+Name: types-boto3-cloudformation
+Version: 1.36.0
+Summary: Type annotations for boto3 CloudFormation 1.36.0 service generated with mypy-boto3-builder 8.8.0
+Home-page: https://github.com/youtype/mypy_boto3_builder
+Author: Vlad Emelianov
+Author-email: vlad.emelianov.nz@gmail.com
+License: MIT License
+Project-URL: Documentation, https://youtype.github.io/types_boto3_docs/types_boto3_cloudformation/
+Project-URL: Source, https://github.com/youtype/mypy_boto3_builder
+Project-URL: Tracker, https://github.com/youtype/mypy_boto3_builder/issues
+Keywords: boto3 cloudformation boto3-stubs type-annotations mypy typeshed autocomplete
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Typing :: Stubs Only
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typing-extensions; python_version < "3.12"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+<a id="types-boto3-cloudformation"></a>
+
+# types-boto3-cloudformation
+
+[![PyPI - types-boto3-cloudformation](https://img.shields.io/pypi/v/types-boto3-cloudformation.svg?color=blue)](https://pypi.org/project/types-boto3-cloudformation/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-boto3-cloudformation.svg?color=blue)](https://pypi.org/project/types-boto3-cloudformation/)
+[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/types_boto3_docs/)
+[![PyPI - Downloads](https://static.pepy.tech/badge/types-boto3-cloudformation)](https://pypistats.org/packages/types-boto3-cloudformation)
+
+![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)
+
+Type annotations for
+[boto3 CloudFormation 1.36.0](https://pypi.org/project/boto3/) compatible with
+[VSCode](https://code.visualstudio.com/),
+[PyCharm](https://www.jetbrains.com/pycharm/),
+[Emacs](https://www.gnu.org/software/emacs/),
+[Sublime Text](https://www.sublimetext.com/),
+[mypy](https://github.com/python/mypy),
+[pyright](https://github.com/microsoft/pyright) and other tools.
+
+Generated with
+[mypy-boto3-builder 8.8.0](https://github.com/youtype/mypy_boto3_builder).
+
+More information can be found on
+[types-boto3](https://pypi.org/project/types-boto3/) page and in
+[types-boto3-cloudformation docs](https://youtype.github.io/types_boto3_docs/types_boto3_cloudformation/).
+
+See how it helps you find and fix potential bugs:
+
+![types-boto3 demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)
+
+- [types-boto3-cloudformation](#types-boto3-cloudformation)
+  - [How to install](#how-to-install)
+    - [Generate locally (recommended)](<#generate-locally-(recommended)>)
+    - [VSCode extension](#vscode-extension)
+    - [From PyPI with pip](#from-pypi-with-pip)
+  - [How to uninstall](#how-to-uninstall)
+  - [Usage](#usage)
+    - [VSCode](#vscode)
+    - [PyCharm](#pycharm)
+    - [Emacs](#emacs)
+    - [Sublime Text](#sublime-text)
+    - [Other IDEs](#other-ides)
+    - [mypy](#mypy)
+    - [pyright](#pyright)
+    - [Pylint compatibility](#pylint-compatibility)
+  - [Explicit type annotations](#explicit-type-annotations)
+    - [Client annotations](#client-annotations)
+    - [Paginators annotations](#paginators-annotations)
+    - [Waiters annotations](#waiters-annotations)
+    - [Service Resource annotations](#service-resource-annotations)
+    - [Other resources annotations](#other-resources-annotations)
+    - [Collections annotations](#collections-annotations)
+    - [Literals](#literals)
+    - [Type definitions](#type-definitions)
+  - [How it works](#how-it-works)
+  - [What's new](#what's-new)
+    - [Implemented features](#implemented-features)
+    - [Latest changes](#latest-changes)
+  - [Versioning](#versioning)
+  - [Thank you](#thank-you)
+  - [Documentation](#documentation)
+  - [Support and contributing](#support-and-contributing)
+
+<a id="how-to-install"></a>
+
+## How to install
+
+<a id="generate-locally-(recommended)"></a>
+
+### Generate locally (recommended)
+
+You can generate type annotations for `boto3` package locally with
+`mypy_boto3_builder`. Use
+[uv](https://docs.astral.sh/uv/getting-started/installation/) for build
+isolation.
+
+1. Run mypy-boto3-builder in your package root directory:
+   `uvx --with 'boto3==1.36.0' mypy_boto3_builder`
+2. Select `boto3` AWS SDK.
+3. Add `CloudFormation` service.
+4. Use provided commands to install generated packages.
+
+<a id="vscode-extension"></a>
+
+### VSCode extension
+
+Add
+[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
+extension to your VSCode and run `AWS boto3: Quick Start` command.
+
+Click `Modify` and select `boto3 common` and `CloudFormation`.
+
+<a id="from-pypi-with-pip"></a>
+
+### From PyPI with pip
+
+Install `types-boto3` for `CloudFormation` service.
+
+```bash
+# install with boto3 type annotations
+python -m pip install 'types-boto3[cloudformation]'
+
+# Lite version does not provide session.client/resource overloads
+# it is more RAM-friendly, but requires explicit type annotations
+python -m pip install 'types-boto3-lite[cloudformation]'
+
+# standalone installation
+python -m pip install types-boto3-cloudformation
+```
+
+<a id="how-to-uninstall"></a>
+
+## How to uninstall
+
+```bash
+python -m pip uninstall -y types-boto3-cloudformation
+```
+
+<a id="usage"></a>
+
+## Usage
+
+<a id="vscode"></a>
+
+### VSCode
+
+- Install
+  [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
+- Install
+  [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
+- Set `Pylance` as your Python Language Server
+- Install `types-boto3[cloudformation]` in your environment:
+
+```bash
+python -m pip install 'types-boto3[cloudformation]'
+```
+
+Both type checking and code completion should now work. No explicit type
+annotations required, write your `boto3` code as usual.
+
+<a id="pycharm"></a>
+
+### PyCharm
+
+> ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
+> [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
+> to use [types-boto3-lite](https://pypi.org/project/types-boto3-lite/) until
+> the issue is resolved.
+
+> ⚠️ If you experience slow performance and high CPU usage, try to disable
+> `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
+> [pyright](https://github.com/microsoft/pyright) instead.
+
+> ⚠️ To continue using `PyCharm` type checker, you can try to replace
+> `types-boto3` with
+> [types-boto3-lite](https://pypi.org/project/types-boto3-lite/):
+
+```bash
+pip uninstall types-boto3
+pip install types-boto3-lite
+```
+
+Install `types-boto3[cloudformation]` in your environment:
+
+```bash
+python -m pip install 'types-boto3[cloudformation]'
+```
+
+Both type checking and code completion should now work.
+
+<a id="emacs"></a>
+
+### Emacs
+
+- Install `types-boto3` with services you use in your environment:
+
+```bash
+python -m pip install 'types-boto3[cloudformation]'
+```
+
+- Install [use-package](https://github.com/jwiegley/use-package),
+  [lsp](https://github.com/emacs-lsp/lsp-mode/),
+  [company](https://github.com/company-mode/company-mode) and
+  [flycheck](https://github.com/flycheck/flycheck) packages
+- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
+
+```elisp
+(use-package lsp-pyright
+  :ensure t
+  :hook (python-mode . (lambda ()
+                          (require 'lsp-pyright)
+                          (lsp)))  ; or lsp-deferred
+  :init (when (executable-find "python3")
+          (setq lsp-pyright-python-executable-cmd "python3"))
+  )
+```
+
+- Make sure emacs uses the environment where you have installed `types-boto3`
+
+Type checking should now work. No explicit type annotations required, write
+your `boto3` code as usual.
+
+<a id="sublime-text"></a>
+
+### Sublime Text
+
+- Install `types-boto3[cloudformation]` with services you use in your
+  environment:
+
+```bash
+python -m pip install 'types-boto3[cloudformation]'
+```
+
+- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
+
+Type checking should now work. No explicit type annotations required, write
+your `boto3` code as usual.
+
+<a id="other-ides"></a>
+
+### Other IDEs
+
+Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
+should work.
+
+<a id="mypy"></a>
+
+### mypy
+
+- Install `mypy`: `python -m pip install mypy`
+- Install `types-boto3[cloudformation]` in your environment:
+
+```bash
+python -m pip install 'types-boto3[cloudformation]'
+```
+
+Type checking should now work. No explicit type annotations required, write
+your `boto3` code as usual.
+
+<a id="pyright"></a>
+
+### pyright
+
+- Install `pyright`: `npm i -g pyright`
+- Install `types-boto3[cloudformation]` in your environment:
+
+```bash
+python -m pip install 'types-boto3[cloudformation]'
+```
+
+Optionally, you can install `types-boto3` to `typings` directory.
+
+Type checking should now work. No explicit type annotations required, write
+your `boto3` code as usual.
+
+<a id="pylint-compatibility"></a>
+
+### Pylint compatibility
+
+It is totally safe to use `TYPE_CHECKING` flag in order to avoid
+`types-boto3-cloudformation` dependency in production. However, there is an
+issue in `pylint` that it complains about undefined variables. To fix it, set
+all types to `object` in non-`TYPE_CHECKING` mode.
+
+```python
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from types_boto3_ec2 import EC2Client, EC2ServiceResource
+    from types_boto3_ec2.waiters import BundleTaskCompleteWaiter
+    from types_boto3_ec2.paginators import DescribeVolumesPaginator
+else:
+    EC2Client = object
+    EC2ServiceResource = object
+    BundleTaskCompleteWaiter = object
+    DescribeVolumesPaginator = object
+
+...
+```
+
+<a id="explicit-type-annotations"></a>
+
+## Explicit type annotations
+
+<a id="client-annotations"></a>
+
+### Client annotations
+
+`CloudFormationClient` provides annotations for
+`boto3.client("cloudformation")`.
+
+```python
+from boto3.session import Session
+
+from types_boto3_cloudformation import CloudFormationClient
+
+client: CloudFormationClient = Session().client("cloudformation")
+
+# now client usage is checked by mypy and IDE should provide code completion
+```
+
+<a id="paginators-annotations"></a>
+
+### Paginators annotations
+
+`types_boto3_cloudformation.paginator` module contains type annotations for all
+paginators.
+
+```python
+from boto3.session import Session
+
+from types_boto3_cloudformation import CloudFormationClient
+from types_boto3_cloudformation.paginator import (
+    DescribeAccountLimitsPaginator,
+    DescribeChangeSetPaginator,
+    DescribeStackEventsPaginator,
+    DescribeStacksPaginator,
+    ListChangeSetsPaginator,
+    ListExportsPaginator,
+    ListGeneratedTemplatesPaginator,
+    ListImportsPaginator,
+    ListResourceScanRelatedResourcesPaginator,
+    ListResourceScanResourcesPaginator,
+    ListResourceScansPaginator,
+    ListStackInstancesPaginator,
+    ListStackResourcesPaginator,
+    ListStackSetOperationResultsPaginator,
+    ListStackSetOperationsPaginator,
+    ListStackSetsPaginator,
+    ListStacksPaginator,
+    ListTypesPaginator,
+)
+
+client: CloudFormationClient = Session().client("cloudformation")
+
+# Explicit type annotations are optional here
+# Types should be correctly discovered by mypy and IDEs
+describe_account_limits_paginator: DescribeAccountLimitsPaginator = client.get_paginator(
+    "describe_account_limits"
+)
+describe_change_set_paginator: DescribeChangeSetPaginator = client.get_paginator(
+    "describe_change_set"
+)
+describe_stack_events_paginator: DescribeStackEventsPaginator = client.get_paginator(
+    "describe_stack_events"
+)
+describe_stacks_paginator: DescribeStacksPaginator = client.get_paginator("describe_stacks")
+list_change_sets_paginator: ListChangeSetsPaginator = client.get_paginator("list_change_sets")
+list_exports_paginator: ListExportsPaginator = client.get_paginator("list_exports")
+list_generated_templates_paginator: ListGeneratedTemplatesPaginator = client.get_paginator(
+    "list_generated_templates"
+)
+list_imports_paginator: ListImportsPaginator = client.get_paginator("list_imports")
+list_resource_scan_related_resources_paginator: ListResourceScanRelatedResourcesPaginator = (
+    client.get_paginator("list_resource_scan_related_resources")
+)
+list_resource_scan_resources_paginator: ListResourceScanResourcesPaginator = client.get_paginator(
+    "list_resource_scan_resources"
+)
+list_resource_scans_paginator: ListResourceScansPaginator = client.get_paginator(
+    "list_resource_scans"
+)
+list_stack_instances_paginator: ListStackInstancesPaginator = client.get_paginator(
+    "list_stack_instances"
+)
+list_stack_resources_paginator: ListStackResourcesPaginator = client.get_paginator(
+    "list_stack_resources"
+)
+list_stack_set_operation_results_paginator: ListStackSetOperationResultsPaginator = (
+    client.get_paginator("list_stack_set_operation_results")
+)
+list_stack_set_operations_paginator: ListStackSetOperationsPaginator = client.get_paginator(
+    "list_stack_set_operations"
+)
+list_stack_sets_paginator: ListStackSetsPaginator = client.get_paginator("list_stack_sets")
+list_stacks_paginator: ListStacksPaginator = client.get_paginator("list_stacks")
+list_types_paginator: ListTypesPaginator = client.get_paginator("list_types")
+```
+
+<a id="waiters-annotations"></a>
+
+### Waiters annotations
+
+`types_boto3_cloudformation.waiter` module contains type annotations for all
+waiters.
+
+```python
+from boto3.session import Session
+
+from types_boto3_cloudformation import CloudFormationClient
+from types_boto3_cloudformation.waiter import (
+    ChangeSetCreateCompleteWaiter,
+    StackCreateCompleteWaiter,
+    StackDeleteCompleteWaiter,
+    StackExistsWaiter,
+    StackImportCompleteWaiter,
+    StackRollbackCompleteWaiter,
+    StackUpdateCompleteWaiter,
+    TypeRegistrationCompleteWaiter,
+)
+
+client: CloudFormationClient = Session().client("cloudformation")
+
+# Explicit type annotations are optional here
+# Types should be correctly discovered by mypy and IDEs
+change_set_create_complete_waiter: ChangeSetCreateCompleteWaiter = client.get_waiter(
+    "change_set_create_complete"
+)
+stack_create_complete_waiter: StackCreateCompleteWaiter = client.get_waiter("stack_create_complete")
+stack_delete_complete_waiter: StackDeleteCompleteWaiter = client.get_waiter("stack_delete_complete")
+stack_exists_waiter: StackExistsWaiter = client.get_waiter("stack_exists")
+stack_import_complete_waiter: StackImportCompleteWaiter = client.get_waiter("stack_import_complete")
+stack_rollback_complete_waiter: StackRollbackCompleteWaiter = client.get_waiter(
+    "stack_rollback_complete"
+)
+stack_update_complete_waiter: StackUpdateCompleteWaiter = client.get_waiter("stack_update_complete")
+type_registration_complete_waiter: TypeRegistrationCompleteWaiter = client.get_waiter(
+    "type_registration_complete"
+)
+```
+
+<a id="service-resource-annotations"></a>
+
+### Service Resource annotations
+
+`CloudFormationServiceResource` provides annotations for
+`boto3.resource("cloudformation")`.
+
+```python
+from boto3.session import Session
+
+from types_boto3_cloudformation import CloudFormationServiceResource
+
+resource: CloudFormationServiceResource = Session().resource("cloudformation")
+
+# now resource usage is checked by mypy and IDE should provide code completion
+```
+
+<a id="other-resources-annotations"></a>
+
+### Other resources annotations
+
+`types_boto3_cloudformation.service_resource` module contains type annotations
+for all resources.
+
+```python
+from boto3.session import Session
+
+from types_boto3_cloudformation import CloudFormationServiceResource
+from types_boto3_cloudformation.service_resource import (
+    Event,
+    Stack,
+    StackResource,
+    StackResourceSummary,
+)
+
+resource: CloudFormationServiceResource = Session().resource("cloudformation")
+
+# Explicit type annotations are optional here
+# Type should be correctly discovered by mypy and IDEs
+my_event: Event = resource.Event(...)
+my_stack: Stack = resource.Stack(...)
+my_stack_resource: StackResource = resource.StackResource(...)
+my_stack_resource_summary: StackResourceSummary = resource.StackResourceSummary(...)
+```
+
+<a id="collections-annotations"></a>
+
+### Collections annotations
+
+`types_boto3_cloudformation.service_resource` module contains type annotations
+for all `CloudFormationServiceResource` collections.
+
+```python
+from boto3.session import Session
+
+from types_boto3_cloudformation import CloudFormationServiceResource
+from types_boto3_cloudformation.service_resource import ServiceResourceStacksCollection
+
+resource: CloudFormationServiceResource = Session().resource("cloudformation")
+
+# Explicit type annotations are optional here
+# Type should be correctly discovered by mypy and IDEs
+stacks: cloudformation_resources.ServiceResourceStacksCollection = resource.stacks
+```
+
+<a id="literals"></a>
+
+### Literals
+
+`types_boto3_cloudformation.literals` module contains literals extracted from
+shapes that can be used in user code for type checking.
+
+Full list of `CloudFormation` Literals can be found in
+[docs](https://youtype.github.io/types_boto3_docs/types_boto3_cloudformation/literals/).
+
+```python
+from types_boto3_cloudformation.literals import AccountFilterTypeType
+
+
+def check_value(value: AccountFilterTypeType) -> bool: ...
+```
+
+<a id="type-definitions"></a>
+
+### Type definitions
+
+`types_boto3_cloudformation.type_defs` module contains structures and shapes
+assembled to typed dictionaries and unions for additional type checking.
+
+Full list of `CloudFormation` TypeDefs can be found in
+[docs](https://youtype.github.io/types_boto3_docs/types_boto3_cloudformation/type_defs/).
+
+```python
+from types_boto3_cloudformation.type_defs import AccountGateResultTypeDef
+
+
+def get_value() -> AccountGateResultTypeDef:
+    return {...}
+```
+
+<a id="how-it-works"></a>
+
+## How it works
+
+Fully automated
+[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
+generates type annotations for each service, patiently waiting for `boto3`
+updates. It delivers drop-in type annotations for you and makes sure that:
+
+- All available `boto3` services are covered.
+- Each public class and method of every `boto3` service gets valid type
+  annotations extracted from `botocore` schemas.
+- Type annotations include up-to-date documentation.
+- Link to documentation is provided for every method.
+- Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.
+
+<a id="what's-new"></a>
+
+## What's new
+
+<a id="implemented-features"></a>
+
+### Implemented features
+
+- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
+  libraries
+- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
+  compatibility
+- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
+  annotations for each service
+- Generated `TypeDefs` for each service
+- Generated `Literals` for each service
+- Auto discovery of types for `boto3.client` and `boto3.resource` calls
+- Auto discovery of types for `session.client` and `session.resource` calls
+- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
+  calls
+- Auto discovery of types for `ServiceResource` and `Resource` collections
+- Auto discovery of types for `aiobotocore.Session.create_client` calls
+
+<a id="latest-changes"></a>
+
+### Latest changes
+
+Builder changelog can be found in
+[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
+
+<a id="versioning"></a>
+
+## Versioning
+
+`types-boto3-cloudformation` version is the same as related `boto3` version and
+follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
+
+<a id="thank-you"></a>
+
+## Thank you
+
+- [Allie Fitter](https://github.com/alliefitter) for
+  [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
+  this package is based on top of his work
+- [black](https://github.com/psf/black) developers for an awesome formatting
+  tool
+- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
+  [isort](https://github.com/PyCQA/isort) and how flexible it is
+- [mypy](https://github.com/python/mypy) developers for doing all dirty work
+  for us
+- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
+  Python
+
+<a id="documentation"></a>
+
+## Documentation
+
+All services type annotations can be found in
+[boto3 docs](https://youtype.github.io/types_boto3_docs/types_boto3_cloudformation/)
+
+<a id="support-and-contributing"></a>
+
+## Support and contributing
+
+This package is auto-generated. Please reports any bugs or request new features
+in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
+repository.