%global _empty_manifest_terminate_build 0
Name: python-mypy-boto3-cloudformation
Version: 1.26.108
Release: 1
Summary: Type annotations for boto3.CloudFormation 1.26.108 service generated with mypy-boto3-builder 7.14.5
License: MIT License
URL: https://github.com/youtype/mypy_boto3_builder
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/cf/2b/f610c75c3be3fab2e0ecf1f0469c32d11634506a2464497e11b2075e29c8/mypy-boto3-cloudformation-1.26.108.tar.gz
BuildArch: noarch
Requires: python3-typing-extensions
%description
# mypy-boto3-cloudformation
[](https://pypi.org/project/mypy-boto3-cloudformation)
[](https://pypi.org/project/mypy-boto3-cloudformation)
[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudformation/)
[](https://pypistats.org/packages/mypy-boto3-cloudformation)
Type annotations for
[boto3.CloudFormation 1.26.108](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation.html#CloudFormation)
service 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 by
[mypy-boto3-builder 7.14.5](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-cloudformation docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudformation/).
See how it helps to find and fix potential bugs:
- [mypy-boto3-cloudformation](#mypy-boto3-cloudformation)
- [How to install](#how-to-install)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [From conda-forge](#from-conda-forge)
- [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)
- [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)
- [Typed dictionaries](#typed-dictionaries)
- [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)
## How to install
### 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`.
### From PyPI with pip
Install `boto3-stubs` for `CloudFormation` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[cloudformation]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[cloudformation]'
# standalone installation
python -m pip install mypy-boto3-cloudformation
```
### From conda-forge
Installing `mypy-boto3-cloudformation` from the `conda-forge` channel can be
achieved by adding `conda-forge` to your channels with:
```bash
conda config --add channels conda-forge
conda config --set channel_priority strict
```
Once the `conda-forge` channel has been enabled, `mypy-boto3-cloudformation`
can be installed with:
```bash
conda install mypy-boto3-cloudformation
```
It is possible to list all of the versions of `mypy-boto3-cloudformation`
available on your platform with:
```bash
conda search mypy-boto3-cloudformation --channel conda-forge
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-cloudformation
```
## Usage
### 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 `boto3-stubs[cloudformation]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudformation]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
### PyCharm
Install `boto3-stubs-lite[cloudformation]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[cloudformation]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[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 `boto3-stubs`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Sublime Text
- Install `boto3-stubs[cloudformation]` with services you use in your
environment:
```bash
python -m pip install 'boto3-stubs[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.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[cloudformation]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudformation]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[cloudformation]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudformation]'
```
Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`CloudFormationClient` provides annotations for
`boto3.client("cloudformation")`.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationClient
client: CloudFormationClient = Session().client("cloudformation")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_cloudformation.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationClient
from mypy_boto3_cloudformation.paginator import (
DescribeAccountLimitsPaginator,
DescribeChangeSetPaginator,
DescribeStackEventsPaginator,
DescribeStacksPaginator,
ListChangeSetsPaginator,
ListExportsPaginator,
ListImportsPaginator,
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_imports_paginator: ListImportsPaginator = client.get_paginator("list_imports")
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")
```
### Waiters annotations
`mypy_boto3_cloudformation.waiter` module contains type annotations for all
waiters.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationClient
from mypy_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"
)
```
### Service Resource annotations
`CloudFormationServiceResource` provides annotations for
`boto3.resource("cloudformation")`.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationServiceResource
resource: CloudFormationServiceResource = Session().resource("cloudformation")
# now resource usage is checked by mypy and IDE should provide code completion
```
### Other resources annotations
`mypy_boto3_cloudformation.service_resource` module contains type annotations
for all resources.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationServiceResource
from mypy_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(...)
```
### Collections annotations
`mypy_boto3_cloudformation.service_resource` module contains type annotations
for all `CloudFormationServiceResource` collections.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationServiceResource
from mypy_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
```
### Literals
`mypy_boto3_cloudformation.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_cloudformation.literals import (
AccountFilterTypeType,
AccountGateStatusType,
CallAsType,
CapabilityType,
CategoryType,
ChangeActionType,
ChangeSetCreateCompleteWaiterName,
ChangeSetHooksStatusType,
ChangeSetStatusType,
ChangeSetTypeType,
ChangeSourceType,
ChangeTypeType,
DeprecatedStatusType,
DescribeAccountLimitsPaginatorName,
DescribeChangeSetPaginatorName,
DescribeStackEventsPaginatorName,
DescribeStacksPaginatorName,
DifferenceTypeType,
EvaluationTypeType,
ExecutionStatusType,
HandlerErrorCodeType,
HookFailureModeType,
HookInvocationPointType,
HookStatusType,
HookTargetTypeType,
IdentityProviderType,
ListChangeSetsPaginatorName,
ListExportsPaginatorName,
ListImportsPaginatorName,
ListStackInstancesPaginatorName,
ListStackResourcesPaginatorName,
ListStackSetOperationResultsPaginatorName,
ListStackSetOperationsPaginatorName,
ListStackSetsPaginatorName,
ListStacksPaginatorName,
ListTypesPaginatorName,
OnFailureType,
OperationResultFilterNameType,
OperationStatusType,
PermissionModelsType,
ProvisioningTypeType,
PublisherStatusType,
RegionConcurrencyTypeType,
RegistrationStatusType,
RegistryTypeType,
ReplacementType,
RequiresRecreationType,
ResourceAttributeType,
ResourceSignalStatusType,
ResourceStatusType,
StackCreateCompleteWaiterName,
StackDeleteCompleteWaiterName,
StackDriftDetectionStatusType,
StackDriftStatusType,
StackExistsWaiterName,
StackImportCompleteWaiterName,
StackInstanceDetailedStatusType,
StackInstanceFilterNameType,
StackInstanceStatusType,
StackResourceDriftStatusType,
StackRollbackCompleteWaiterName,
StackSetDriftDetectionStatusType,
StackSetDriftStatusType,
StackSetOperationActionType,
StackSetOperationResultStatusType,
StackSetOperationStatusType,
StackSetStatusType,
StackStatusType,
StackUpdateCompleteWaiterName,
TemplateStageType,
ThirdPartyTypeType,
TypeRegistrationCompleteWaiterName,
TypeTestsStatusType,
VersionBumpType,
VisibilityType,
CloudFormationServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: AccountFilterTypeType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_cloudformation.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_cloudformation.type_defs import (
AccountGateResultTypeDef,
AccountLimitTypeDef,
LoggingConfigTypeDef,
ResponseMetadataTypeDef,
AutoDeploymentTypeDef,
TypeConfigurationIdentifierTypeDef,
TypeConfigurationDetailsTypeDef,
CancelUpdateStackInputRequestTypeDef,
CancelUpdateStackInputStackCancelUpdateTypeDef,
ChangeSetHookResourceTargetDetailsTypeDef,
ChangeSetSummaryTypeDef,
ContinueUpdateRollbackInputRequestTypeDef,
ParameterTypeDef,
ResourceToImportTypeDef,
TagTypeDef,
DeploymentTargetsTypeDef,
StackSetOperationPreferencesTypeDef,
ManagedExecutionTypeDef,
DeactivateTypeInputRequestTypeDef,
DeleteChangeSetInputRequestTypeDef,
DeleteStackInputRequestTypeDef,
DeleteStackInputStackDeleteTypeDef,
DeleteStackSetInputRequestTypeDef,
DeregisterTypeInputRequestTypeDef,
PaginatorConfigTypeDef,
DescribeAccountLimitsInputRequestTypeDef,
DescribeChangeSetHooksInputRequestTypeDef,
WaiterConfigTypeDef,
DescribeChangeSetInputRequestTypeDef,
DescribePublisherInputRequestTypeDef,
DescribeStackDriftDetectionStatusInputRequestTypeDef,
DescribeStackEventsInputRequestTypeDef,
StackEventTypeDef,
DescribeStackInstanceInputRequestTypeDef,
DescribeStackResourceDriftsInputRequestTypeDef,
DescribeStackResourceInputRequestTypeDef,
DescribeStackResourcesInputRequestTypeDef,
DescribeStackSetInputRequestTypeDef,
DescribeStackSetOperationInputRequestTypeDef,
DescribeStacksInputRequestTypeDef,
DescribeTypeInputRequestTypeDef,
RequiredActivatedTypeTypeDef,
DescribeTypeRegistrationInputRequestTypeDef,
DetectStackDriftInputRequestTypeDef,
DetectStackResourceDriftInputRequestTypeDef,
ExecuteChangeSetInputRequestTypeDef,
ExportTypeDef,
GetStackPolicyInputRequestTypeDef,
GetTemplateInputRequestTypeDef,
GetTemplateSummaryInputRequestTypeDef,
ResourceIdentifierSummaryTypeDef,
ListChangeSetsInputRequestTypeDef,
ListExportsInputRequestTypeDef,
ListImportsInputRequestTypeDef,
StackInstanceFilterTypeDef,
ListStackResourcesInputRequestTypeDef,
OperationResultFilterTypeDef,
ListStackSetOperationsInputRequestTypeDef,
ListStackSetsInputRequestTypeDef,
ListStacksInputRequestTypeDef,
ListTypeRegistrationsInputRequestTypeDef,
ListTypeVersionsInputRequestTypeDef,
TypeVersionSummaryTypeDef,
TypeFiltersTypeDef,
TypeSummaryTypeDef,
ModuleInfoTypeDef,
OutputTypeDef,
ParameterConstraintsTypeDef,
PhysicalResourceIdContextKeyValuePairTypeDef,
PropertyDifferenceTypeDef,
PublishTypeInputRequestTypeDef,
RecordHandlerProgressInputRequestTypeDef,
RegisterPublisherInputRequestTypeDef,
ResourceTargetDefinitionTypeDef,
RollbackTriggerTypeDef,
RollbackStackInputRequestTypeDef,
SetStackPolicyInputRequestTypeDef,
SetTypeConfigurationInputRequestTypeDef,
SetTypeDefaultVersionInputRequestTypeDef,
SignalResourceInputRequestTypeDef,
StackDriftInformationSummaryTypeDef,
StackDriftInformationTypeDef,
StackInstanceComprehensiveStatusTypeDef,
StackResourceDriftInformationTypeDef,
StackResourceDriftInformationSummaryTypeDef,
StackSetDriftDetectionDetailsTypeDef,
StackSetOperationStatusDetailsTypeDef,
StopStackSetOperationInputRequestTypeDef,
TemplateParameterTypeDef,
TestTypeInputRequestTypeDef,
UpdateTerminationProtectionInputRequestTypeDef,
ValidateTemplateInputRequestTypeDef,
StackSetOperationResultSummaryTypeDef,
ActivateTypeInputRequestTypeDef,
RegisterTypeInputRequestTypeDef,
ActivateTypeOutputTypeDef,
CreateChangeSetOutputTypeDef,
CreateStackInstancesOutputTypeDef,
CreateStackOutputTypeDef,
CreateStackSetOutputTypeDef,
DeleteStackInstancesOutputTypeDef,
DescribeAccountLimitsOutputTypeDef,
DescribePublisherOutputTypeDef,
DescribeStackDriftDetectionStatusOutputTypeDef,
DescribeTypeRegistrationOutputTypeDef,
DetectStackDriftOutputTypeDef,
DetectStackSetDriftOutputTypeDef,
EmptyResponseMetadataTypeDef,
EstimateTemplateCostOutputTypeDef,
GetStackPolicyOutputTypeDef,
GetTemplateOutputTypeDef,
ImportStacksToStackSetOutputTypeDef,
ListImportsOutputTypeDef,
ListTypeRegistrationsOutputTypeDef,
ModuleInfoResponseMetadataTypeDef,
PublishTypeOutputTypeDef,
RegisterPublisherOutputTypeDef,
RegisterTypeOutputTypeDef,
RollbackStackOutputTypeDef,
SetTypeConfigurationOutputTypeDef,
StackDriftInformationResponseMetadataTypeDef,
StackResourceDriftInformationResponseMetadataTypeDef,
StackResourceDriftInformationSummaryResponseMetadataTypeDef,
TestTypeOutputTypeDef,
UpdateStackInstancesOutputTypeDef,
UpdateStackOutputTypeDef,
UpdateStackSetOutputTypeDef,
UpdateTerminationProtectionOutputTypeDef,
BatchDescribeTypeConfigurationsErrorTypeDef,
BatchDescribeTypeConfigurationsInputRequestTypeDef,
ChangeSetHookTargetDetailsTypeDef,
ListChangeSetsOutputTypeDef,
EstimateTemplateCostInputRequestTypeDef,
CreateStackInstancesInputRequestTypeDef,
DeleteStackInstancesInputRequestTypeDef,
DetectStackSetDriftInputRequestTypeDef,
ImportStacksToStackSetInputRequestTypeDef,
UpdateStackInstancesInputRequestTypeDef,
CreateStackSetInputRequestTypeDef,
StackSetSummaryTypeDef,
UpdateStackSetInputRequestTypeDef,
DescribeAccountLimitsInputDescribeAccountLimitsPaginateTypeDef,
DescribeChangeSetInputDescribeChangeSetPaginateTypeDef,
DescribeStackEventsInputDescribeStackEventsPaginateTypeDef,
DescribeStacksInputDescribeStacksPaginateTypeDef,
ListChangeSetsInputListChangeSetsPaginateTypeDef,
ListExportsInputListExportsPaginateTypeDef,
ListImportsInputListImportsPaginateTypeDef,
ListStackResourcesInputListStackResourcesPaginateTypeDef,
ListStackSetOperationsInputListStackSetOperationsPaginateTypeDef,
ListStackSetsInputListStackSetsPaginateTypeDef,
ListStacksInputListStacksPaginateTypeDef,
DescribeChangeSetInputChangeSetCreateCompleteWaitTypeDef,
DescribeStacksInputStackCreateCompleteWaitTypeDef,
DescribeStacksInputStackDeleteCompleteWaitTypeDef,
DescribeStacksInputStackExistsWaitTypeDef,
DescribeStacksInputStackImportCompleteWaitTypeDef,
DescribeStacksInputStackRollbackCompleteWaitTypeDef,
DescribeStacksInputStackUpdateCompleteWaitTypeDef,
DescribeTypeRegistrationInputTypeRegistrationCompleteWaitTypeDef,
DescribeStackEventsOutputTypeDef,
DescribeTypeOutputTypeDef,
ListExportsOutputTypeDef,
ListStackInstancesInputListStackInstancesPaginateTypeDef,
ListStackInstancesInputRequestTypeDef,
ListStackSetOperationResultsInputListStackSetOperationResultsPaginateTypeDef,
ListStackSetOperationResultsInputRequestTypeDef,
ListTypeVersionsOutputTypeDef,
ListTypesInputListTypesPaginateTypeDef,
ListTypesInputRequestTypeDef,
ListTypesOutputTypeDef,
ParameterDeclarationTypeDef,
StackResourceDriftTypeDef,
ResourceChangeDetailTypeDef,
RollbackConfigurationResponseMetadataTypeDef,
RollbackConfigurationTypeDef,
StackSummaryTypeDef,
StackInstanceSummaryTypeDef,
StackInstanceTypeDef,
StackResourceDetailTypeDef,
StackResourceTypeDef,
StackResourceSummaryTypeDef,
StackSetTypeDef,
StackSetOperationSummaryTypeDef,
StackSetOperationTypeDef,
ValidateTemplateOutputTypeDef,
ListStackSetOperationResultsOutputTypeDef,
BatchDescribeTypeConfigurationsOutputTypeDef,
ChangeSetHookTypeDef,
ListStackSetsOutputTypeDef,
GetTemplateSummaryOutputTypeDef,
DescribeStackResourceDriftsOutputTypeDef,
DetectStackResourceDriftOutputTypeDef,
ResourceChangeTypeDef,
CreateChangeSetInputRequestTypeDef,
CreateStackInputRequestTypeDef,
CreateStackInputServiceResourceCreateStackTypeDef,
StackTypeDef,
UpdateStackInputRequestTypeDef,
UpdateStackInputStackUpdateTypeDef,
ListStacksOutputTypeDef,
ListStackInstancesOutputTypeDef,
DescribeStackInstanceOutputTypeDef,
DescribeStackResourceOutputTypeDef,
DescribeStackResourcesOutputTypeDef,
ListStackResourcesOutputTypeDef,
DescribeStackSetOutputTypeDef,
ListStackSetOperationsOutputTypeDef,
DescribeStackSetOperationOutputTypeDef,
DescribeChangeSetHooksOutputTypeDef,
ChangeTypeDef,
DescribeStacksOutputTypeDef,
DescribeChangeSetOutputTypeDef,
)
def get_structure() -> AccountGateResultTypeDef:
return {...}
```
## 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 [black](https://github.com/psf/black) and
[isort](https://github.com/PyCQA/isort) for readability.
## What's new
### 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
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-cloudformation` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## 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
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudformation/)
## 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.
%package -n python3-mypy-boto3-cloudformation
Summary: Type annotations for boto3.CloudFormation 1.26.108 service generated with mypy-boto3-builder 7.14.5
Provides: python-mypy-boto3-cloudformation
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-mypy-boto3-cloudformation
# mypy-boto3-cloudformation
[](https://pypi.org/project/mypy-boto3-cloudformation)
[](https://pypi.org/project/mypy-boto3-cloudformation)
[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudformation/)
[](https://pypistats.org/packages/mypy-boto3-cloudformation)
Type annotations for
[boto3.CloudFormation 1.26.108](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation.html#CloudFormation)
service 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 by
[mypy-boto3-builder 7.14.5](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-cloudformation docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudformation/).
See how it helps to find and fix potential bugs:
- [mypy-boto3-cloudformation](#mypy-boto3-cloudformation)
- [How to install](#how-to-install)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [From conda-forge](#from-conda-forge)
- [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)
- [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)
- [Typed dictionaries](#typed-dictionaries)
- [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)
## How to install
### 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`.
### From PyPI with pip
Install `boto3-stubs` for `CloudFormation` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[cloudformation]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[cloudformation]'
# standalone installation
python -m pip install mypy-boto3-cloudformation
```
### From conda-forge
Installing `mypy-boto3-cloudformation` from the `conda-forge` channel can be
achieved by adding `conda-forge` to your channels with:
```bash
conda config --add channels conda-forge
conda config --set channel_priority strict
```
Once the `conda-forge` channel has been enabled, `mypy-boto3-cloudformation`
can be installed with:
```bash
conda install mypy-boto3-cloudformation
```
It is possible to list all of the versions of `mypy-boto3-cloudformation`
available on your platform with:
```bash
conda search mypy-boto3-cloudformation --channel conda-forge
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-cloudformation
```
## Usage
### 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 `boto3-stubs[cloudformation]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudformation]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
### PyCharm
Install `boto3-stubs-lite[cloudformation]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[cloudformation]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[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 `boto3-stubs`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Sublime Text
- Install `boto3-stubs[cloudformation]` with services you use in your
environment:
```bash
python -m pip install 'boto3-stubs[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.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[cloudformation]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudformation]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[cloudformation]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudformation]'
```
Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`CloudFormationClient` provides annotations for
`boto3.client("cloudformation")`.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationClient
client: CloudFormationClient = Session().client("cloudformation")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_cloudformation.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationClient
from mypy_boto3_cloudformation.paginator import (
DescribeAccountLimitsPaginator,
DescribeChangeSetPaginator,
DescribeStackEventsPaginator,
DescribeStacksPaginator,
ListChangeSetsPaginator,
ListExportsPaginator,
ListImportsPaginator,
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_imports_paginator: ListImportsPaginator = client.get_paginator("list_imports")
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")
```
### Waiters annotations
`mypy_boto3_cloudformation.waiter` module contains type annotations for all
waiters.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationClient
from mypy_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"
)
```
### Service Resource annotations
`CloudFormationServiceResource` provides annotations for
`boto3.resource("cloudformation")`.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationServiceResource
resource: CloudFormationServiceResource = Session().resource("cloudformation")
# now resource usage is checked by mypy and IDE should provide code completion
```
### Other resources annotations
`mypy_boto3_cloudformation.service_resource` module contains type annotations
for all resources.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationServiceResource
from mypy_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(...)
```
### Collections annotations
`mypy_boto3_cloudformation.service_resource` module contains type annotations
for all `CloudFormationServiceResource` collections.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationServiceResource
from mypy_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
```
### Literals
`mypy_boto3_cloudformation.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_cloudformation.literals import (
AccountFilterTypeType,
AccountGateStatusType,
CallAsType,
CapabilityType,
CategoryType,
ChangeActionType,
ChangeSetCreateCompleteWaiterName,
ChangeSetHooksStatusType,
ChangeSetStatusType,
ChangeSetTypeType,
ChangeSourceType,
ChangeTypeType,
DeprecatedStatusType,
DescribeAccountLimitsPaginatorName,
DescribeChangeSetPaginatorName,
DescribeStackEventsPaginatorName,
DescribeStacksPaginatorName,
DifferenceTypeType,
EvaluationTypeType,
ExecutionStatusType,
HandlerErrorCodeType,
HookFailureModeType,
HookInvocationPointType,
HookStatusType,
HookTargetTypeType,
IdentityProviderType,
ListChangeSetsPaginatorName,
ListExportsPaginatorName,
ListImportsPaginatorName,
ListStackInstancesPaginatorName,
ListStackResourcesPaginatorName,
ListStackSetOperationResultsPaginatorName,
ListStackSetOperationsPaginatorName,
ListStackSetsPaginatorName,
ListStacksPaginatorName,
ListTypesPaginatorName,
OnFailureType,
OperationResultFilterNameType,
OperationStatusType,
PermissionModelsType,
ProvisioningTypeType,
PublisherStatusType,
RegionConcurrencyTypeType,
RegistrationStatusType,
RegistryTypeType,
ReplacementType,
RequiresRecreationType,
ResourceAttributeType,
ResourceSignalStatusType,
ResourceStatusType,
StackCreateCompleteWaiterName,
StackDeleteCompleteWaiterName,
StackDriftDetectionStatusType,
StackDriftStatusType,
StackExistsWaiterName,
StackImportCompleteWaiterName,
StackInstanceDetailedStatusType,
StackInstanceFilterNameType,
StackInstanceStatusType,
StackResourceDriftStatusType,
StackRollbackCompleteWaiterName,
StackSetDriftDetectionStatusType,
StackSetDriftStatusType,
StackSetOperationActionType,
StackSetOperationResultStatusType,
StackSetOperationStatusType,
StackSetStatusType,
StackStatusType,
StackUpdateCompleteWaiterName,
TemplateStageType,
ThirdPartyTypeType,
TypeRegistrationCompleteWaiterName,
TypeTestsStatusType,
VersionBumpType,
VisibilityType,
CloudFormationServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: AccountFilterTypeType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_cloudformation.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_cloudformation.type_defs import (
AccountGateResultTypeDef,
AccountLimitTypeDef,
LoggingConfigTypeDef,
ResponseMetadataTypeDef,
AutoDeploymentTypeDef,
TypeConfigurationIdentifierTypeDef,
TypeConfigurationDetailsTypeDef,
CancelUpdateStackInputRequestTypeDef,
CancelUpdateStackInputStackCancelUpdateTypeDef,
ChangeSetHookResourceTargetDetailsTypeDef,
ChangeSetSummaryTypeDef,
ContinueUpdateRollbackInputRequestTypeDef,
ParameterTypeDef,
ResourceToImportTypeDef,
TagTypeDef,
DeploymentTargetsTypeDef,
StackSetOperationPreferencesTypeDef,
ManagedExecutionTypeDef,
DeactivateTypeInputRequestTypeDef,
DeleteChangeSetInputRequestTypeDef,
DeleteStackInputRequestTypeDef,
DeleteStackInputStackDeleteTypeDef,
DeleteStackSetInputRequestTypeDef,
DeregisterTypeInputRequestTypeDef,
PaginatorConfigTypeDef,
DescribeAccountLimitsInputRequestTypeDef,
DescribeChangeSetHooksInputRequestTypeDef,
WaiterConfigTypeDef,
DescribeChangeSetInputRequestTypeDef,
DescribePublisherInputRequestTypeDef,
DescribeStackDriftDetectionStatusInputRequestTypeDef,
DescribeStackEventsInputRequestTypeDef,
StackEventTypeDef,
DescribeStackInstanceInputRequestTypeDef,
DescribeStackResourceDriftsInputRequestTypeDef,
DescribeStackResourceInputRequestTypeDef,
DescribeStackResourcesInputRequestTypeDef,
DescribeStackSetInputRequestTypeDef,
DescribeStackSetOperationInputRequestTypeDef,
DescribeStacksInputRequestTypeDef,
DescribeTypeInputRequestTypeDef,
RequiredActivatedTypeTypeDef,
DescribeTypeRegistrationInputRequestTypeDef,
DetectStackDriftInputRequestTypeDef,
DetectStackResourceDriftInputRequestTypeDef,
ExecuteChangeSetInputRequestTypeDef,
ExportTypeDef,
GetStackPolicyInputRequestTypeDef,
GetTemplateInputRequestTypeDef,
GetTemplateSummaryInputRequestTypeDef,
ResourceIdentifierSummaryTypeDef,
ListChangeSetsInputRequestTypeDef,
ListExportsInputRequestTypeDef,
ListImportsInputRequestTypeDef,
StackInstanceFilterTypeDef,
ListStackResourcesInputRequestTypeDef,
OperationResultFilterTypeDef,
ListStackSetOperationsInputRequestTypeDef,
ListStackSetsInputRequestTypeDef,
ListStacksInputRequestTypeDef,
ListTypeRegistrationsInputRequestTypeDef,
ListTypeVersionsInputRequestTypeDef,
TypeVersionSummaryTypeDef,
TypeFiltersTypeDef,
TypeSummaryTypeDef,
ModuleInfoTypeDef,
OutputTypeDef,
ParameterConstraintsTypeDef,
PhysicalResourceIdContextKeyValuePairTypeDef,
PropertyDifferenceTypeDef,
PublishTypeInputRequestTypeDef,
RecordHandlerProgressInputRequestTypeDef,
RegisterPublisherInputRequestTypeDef,
ResourceTargetDefinitionTypeDef,
RollbackTriggerTypeDef,
RollbackStackInputRequestTypeDef,
SetStackPolicyInputRequestTypeDef,
SetTypeConfigurationInputRequestTypeDef,
SetTypeDefaultVersionInputRequestTypeDef,
SignalResourceInputRequestTypeDef,
StackDriftInformationSummaryTypeDef,
StackDriftInformationTypeDef,
StackInstanceComprehensiveStatusTypeDef,
StackResourceDriftInformationTypeDef,
StackResourceDriftInformationSummaryTypeDef,
StackSetDriftDetectionDetailsTypeDef,
StackSetOperationStatusDetailsTypeDef,
StopStackSetOperationInputRequestTypeDef,
TemplateParameterTypeDef,
TestTypeInputRequestTypeDef,
UpdateTerminationProtectionInputRequestTypeDef,
ValidateTemplateInputRequestTypeDef,
StackSetOperationResultSummaryTypeDef,
ActivateTypeInputRequestTypeDef,
RegisterTypeInputRequestTypeDef,
ActivateTypeOutputTypeDef,
CreateChangeSetOutputTypeDef,
CreateStackInstancesOutputTypeDef,
CreateStackOutputTypeDef,
CreateStackSetOutputTypeDef,
DeleteStackInstancesOutputTypeDef,
DescribeAccountLimitsOutputTypeDef,
DescribePublisherOutputTypeDef,
DescribeStackDriftDetectionStatusOutputTypeDef,
DescribeTypeRegistrationOutputTypeDef,
DetectStackDriftOutputTypeDef,
DetectStackSetDriftOutputTypeDef,
EmptyResponseMetadataTypeDef,
EstimateTemplateCostOutputTypeDef,
GetStackPolicyOutputTypeDef,
GetTemplateOutputTypeDef,
ImportStacksToStackSetOutputTypeDef,
ListImportsOutputTypeDef,
ListTypeRegistrationsOutputTypeDef,
ModuleInfoResponseMetadataTypeDef,
PublishTypeOutputTypeDef,
RegisterPublisherOutputTypeDef,
RegisterTypeOutputTypeDef,
RollbackStackOutputTypeDef,
SetTypeConfigurationOutputTypeDef,
StackDriftInformationResponseMetadataTypeDef,
StackResourceDriftInformationResponseMetadataTypeDef,
StackResourceDriftInformationSummaryResponseMetadataTypeDef,
TestTypeOutputTypeDef,
UpdateStackInstancesOutputTypeDef,
UpdateStackOutputTypeDef,
UpdateStackSetOutputTypeDef,
UpdateTerminationProtectionOutputTypeDef,
BatchDescribeTypeConfigurationsErrorTypeDef,
BatchDescribeTypeConfigurationsInputRequestTypeDef,
ChangeSetHookTargetDetailsTypeDef,
ListChangeSetsOutputTypeDef,
EstimateTemplateCostInputRequestTypeDef,
CreateStackInstancesInputRequestTypeDef,
DeleteStackInstancesInputRequestTypeDef,
DetectStackSetDriftInputRequestTypeDef,
ImportStacksToStackSetInputRequestTypeDef,
UpdateStackInstancesInputRequestTypeDef,
CreateStackSetInputRequestTypeDef,
StackSetSummaryTypeDef,
UpdateStackSetInputRequestTypeDef,
DescribeAccountLimitsInputDescribeAccountLimitsPaginateTypeDef,
DescribeChangeSetInputDescribeChangeSetPaginateTypeDef,
DescribeStackEventsInputDescribeStackEventsPaginateTypeDef,
DescribeStacksInputDescribeStacksPaginateTypeDef,
ListChangeSetsInputListChangeSetsPaginateTypeDef,
ListExportsInputListExportsPaginateTypeDef,
ListImportsInputListImportsPaginateTypeDef,
ListStackResourcesInputListStackResourcesPaginateTypeDef,
ListStackSetOperationsInputListStackSetOperationsPaginateTypeDef,
ListStackSetsInputListStackSetsPaginateTypeDef,
ListStacksInputListStacksPaginateTypeDef,
DescribeChangeSetInputChangeSetCreateCompleteWaitTypeDef,
DescribeStacksInputStackCreateCompleteWaitTypeDef,
DescribeStacksInputStackDeleteCompleteWaitTypeDef,
DescribeStacksInputStackExistsWaitTypeDef,
DescribeStacksInputStackImportCompleteWaitTypeDef,
DescribeStacksInputStackRollbackCompleteWaitTypeDef,
DescribeStacksInputStackUpdateCompleteWaitTypeDef,
DescribeTypeRegistrationInputTypeRegistrationCompleteWaitTypeDef,
DescribeStackEventsOutputTypeDef,
DescribeTypeOutputTypeDef,
ListExportsOutputTypeDef,
ListStackInstancesInputListStackInstancesPaginateTypeDef,
ListStackInstancesInputRequestTypeDef,
ListStackSetOperationResultsInputListStackSetOperationResultsPaginateTypeDef,
ListStackSetOperationResultsInputRequestTypeDef,
ListTypeVersionsOutputTypeDef,
ListTypesInputListTypesPaginateTypeDef,
ListTypesInputRequestTypeDef,
ListTypesOutputTypeDef,
ParameterDeclarationTypeDef,
StackResourceDriftTypeDef,
ResourceChangeDetailTypeDef,
RollbackConfigurationResponseMetadataTypeDef,
RollbackConfigurationTypeDef,
StackSummaryTypeDef,
StackInstanceSummaryTypeDef,
StackInstanceTypeDef,
StackResourceDetailTypeDef,
StackResourceTypeDef,
StackResourceSummaryTypeDef,
StackSetTypeDef,
StackSetOperationSummaryTypeDef,
StackSetOperationTypeDef,
ValidateTemplateOutputTypeDef,
ListStackSetOperationResultsOutputTypeDef,
BatchDescribeTypeConfigurationsOutputTypeDef,
ChangeSetHookTypeDef,
ListStackSetsOutputTypeDef,
GetTemplateSummaryOutputTypeDef,
DescribeStackResourceDriftsOutputTypeDef,
DetectStackResourceDriftOutputTypeDef,
ResourceChangeTypeDef,
CreateChangeSetInputRequestTypeDef,
CreateStackInputRequestTypeDef,
CreateStackInputServiceResourceCreateStackTypeDef,
StackTypeDef,
UpdateStackInputRequestTypeDef,
UpdateStackInputStackUpdateTypeDef,
ListStacksOutputTypeDef,
ListStackInstancesOutputTypeDef,
DescribeStackInstanceOutputTypeDef,
DescribeStackResourceOutputTypeDef,
DescribeStackResourcesOutputTypeDef,
ListStackResourcesOutputTypeDef,
DescribeStackSetOutputTypeDef,
ListStackSetOperationsOutputTypeDef,
DescribeStackSetOperationOutputTypeDef,
DescribeChangeSetHooksOutputTypeDef,
ChangeTypeDef,
DescribeStacksOutputTypeDef,
DescribeChangeSetOutputTypeDef,
)
def get_structure() -> AccountGateResultTypeDef:
return {...}
```
## 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 [black](https://github.com/psf/black) and
[isort](https://github.com/PyCQA/isort) for readability.
## What's new
### 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
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-cloudformation` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## 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
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudformation/)
## 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.
%package help
Summary: Development documents and examples for mypy-boto3-cloudformation
Provides: python3-mypy-boto3-cloudformation-doc
%description help
# mypy-boto3-cloudformation
[](https://pypi.org/project/mypy-boto3-cloudformation)
[](https://pypi.org/project/mypy-boto3-cloudformation)
[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudformation/)
[](https://pypistats.org/packages/mypy-boto3-cloudformation)
Type annotations for
[boto3.CloudFormation 1.26.108](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation.html#CloudFormation)
service 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 by
[mypy-boto3-builder 7.14.5](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-cloudformation docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudformation/).
See how it helps to find and fix potential bugs:
- [mypy-boto3-cloudformation](#mypy-boto3-cloudformation)
- [How to install](#how-to-install)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [From conda-forge](#from-conda-forge)
- [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)
- [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)
- [Typed dictionaries](#typed-dictionaries)
- [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)
## How to install
### 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`.
### From PyPI with pip
Install `boto3-stubs` for `CloudFormation` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[cloudformation]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[cloudformation]'
# standalone installation
python -m pip install mypy-boto3-cloudformation
```
### From conda-forge
Installing `mypy-boto3-cloudformation` from the `conda-forge` channel can be
achieved by adding `conda-forge` to your channels with:
```bash
conda config --add channels conda-forge
conda config --set channel_priority strict
```
Once the `conda-forge` channel has been enabled, `mypy-boto3-cloudformation`
can be installed with:
```bash
conda install mypy-boto3-cloudformation
```
It is possible to list all of the versions of `mypy-boto3-cloudformation`
available on your platform with:
```bash
conda search mypy-boto3-cloudformation --channel conda-forge
```
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-cloudformation
```
## Usage
### 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 `boto3-stubs[cloudformation]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudformation]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
### PyCharm
Install `boto3-stubs-lite[cloudformation]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[cloudformation]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[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 `boto3-stubs`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### Sublime Text
- Install `boto3-stubs[cloudformation]` with services you use in your
environment:
```bash
python -m pip install 'boto3-stubs[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.
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[cloudformation]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudformation]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[cloudformation]` in your environment:
```bash
python -m pip install 'boto3-stubs[cloudformation]'
```
Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`CloudFormationClient` provides annotations for
`boto3.client("cloudformation")`.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationClient
client: CloudFormationClient = Session().client("cloudformation")
# now client usage is checked by mypy and IDE should provide code completion
```
### Paginators annotations
`mypy_boto3_cloudformation.paginator` module contains type annotations for all
paginators.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationClient
from mypy_boto3_cloudformation.paginator import (
DescribeAccountLimitsPaginator,
DescribeChangeSetPaginator,
DescribeStackEventsPaginator,
DescribeStacksPaginator,
ListChangeSetsPaginator,
ListExportsPaginator,
ListImportsPaginator,
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_imports_paginator: ListImportsPaginator = client.get_paginator("list_imports")
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")
```
### Waiters annotations
`mypy_boto3_cloudformation.waiter` module contains type annotations for all
waiters.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationClient
from mypy_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"
)
```
### Service Resource annotations
`CloudFormationServiceResource` provides annotations for
`boto3.resource("cloudformation")`.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationServiceResource
resource: CloudFormationServiceResource = Session().resource("cloudformation")
# now resource usage is checked by mypy and IDE should provide code completion
```
### Other resources annotations
`mypy_boto3_cloudformation.service_resource` module contains type annotations
for all resources.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationServiceResource
from mypy_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(...)
```
### Collections annotations
`mypy_boto3_cloudformation.service_resource` module contains type annotations
for all `CloudFormationServiceResource` collections.
```python
from boto3.session import Session
from mypy_boto3_cloudformation import CloudFormationServiceResource
from mypy_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
```
### Literals
`mypy_boto3_cloudformation.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_cloudformation.literals import (
AccountFilterTypeType,
AccountGateStatusType,
CallAsType,
CapabilityType,
CategoryType,
ChangeActionType,
ChangeSetCreateCompleteWaiterName,
ChangeSetHooksStatusType,
ChangeSetStatusType,
ChangeSetTypeType,
ChangeSourceType,
ChangeTypeType,
DeprecatedStatusType,
DescribeAccountLimitsPaginatorName,
DescribeChangeSetPaginatorName,
DescribeStackEventsPaginatorName,
DescribeStacksPaginatorName,
DifferenceTypeType,
EvaluationTypeType,
ExecutionStatusType,
HandlerErrorCodeType,
HookFailureModeType,
HookInvocationPointType,
HookStatusType,
HookTargetTypeType,
IdentityProviderType,
ListChangeSetsPaginatorName,
ListExportsPaginatorName,
ListImportsPaginatorName,
ListStackInstancesPaginatorName,
ListStackResourcesPaginatorName,
ListStackSetOperationResultsPaginatorName,
ListStackSetOperationsPaginatorName,
ListStackSetsPaginatorName,
ListStacksPaginatorName,
ListTypesPaginatorName,
OnFailureType,
OperationResultFilterNameType,
OperationStatusType,
PermissionModelsType,
ProvisioningTypeType,
PublisherStatusType,
RegionConcurrencyTypeType,
RegistrationStatusType,
RegistryTypeType,
ReplacementType,
RequiresRecreationType,
ResourceAttributeType,
ResourceSignalStatusType,
ResourceStatusType,
StackCreateCompleteWaiterName,
StackDeleteCompleteWaiterName,
StackDriftDetectionStatusType,
StackDriftStatusType,
StackExistsWaiterName,
StackImportCompleteWaiterName,
StackInstanceDetailedStatusType,
StackInstanceFilterNameType,
StackInstanceStatusType,
StackResourceDriftStatusType,
StackRollbackCompleteWaiterName,
StackSetDriftDetectionStatusType,
StackSetDriftStatusType,
StackSetOperationActionType,
StackSetOperationResultStatusType,
StackSetOperationStatusType,
StackSetStatusType,
StackStatusType,
StackUpdateCompleteWaiterName,
TemplateStageType,
ThirdPartyTypeType,
TypeRegistrationCompleteWaiterName,
TypeTestsStatusType,
VersionBumpType,
VisibilityType,
CloudFormationServiceName,
ServiceName,
ResourceServiceName,
PaginatorName,
WaiterName,
RegionName,
)
def check_value(value: AccountFilterTypeType) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_cloudformation.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_cloudformation.type_defs import (
AccountGateResultTypeDef,
AccountLimitTypeDef,
LoggingConfigTypeDef,
ResponseMetadataTypeDef,
AutoDeploymentTypeDef,
TypeConfigurationIdentifierTypeDef,
TypeConfigurationDetailsTypeDef,
CancelUpdateStackInputRequestTypeDef,
CancelUpdateStackInputStackCancelUpdateTypeDef,
ChangeSetHookResourceTargetDetailsTypeDef,
ChangeSetSummaryTypeDef,
ContinueUpdateRollbackInputRequestTypeDef,
ParameterTypeDef,
ResourceToImportTypeDef,
TagTypeDef,
DeploymentTargetsTypeDef,
StackSetOperationPreferencesTypeDef,
ManagedExecutionTypeDef,
DeactivateTypeInputRequestTypeDef,
DeleteChangeSetInputRequestTypeDef,
DeleteStackInputRequestTypeDef,
DeleteStackInputStackDeleteTypeDef,
DeleteStackSetInputRequestTypeDef,
DeregisterTypeInputRequestTypeDef,
PaginatorConfigTypeDef,
DescribeAccountLimitsInputRequestTypeDef,
DescribeChangeSetHooksInputRequestTypeDef,
WaiterConfigTypeDef,
DescribeChangeSetInputRequestTypeDef,
DescribePublisherInputRequestTypeDef,
DescribeStackDriftDetectionStatusInputRequestTypeDef,
DescribeStackEventsInputRequestTypeDef,
StackEventTypeDef,
DescribeStackInstanceInputRequestTypeDef,
DescribeStackResourceDriftsInputRequestTypeDef,
DescribeStackResourceInputRequestTypeDef,
DescribeStackResourcesInputRequestTypeDef,
DescribeStackSetInputRequestTypeDef,
DescribeStackSetOperationInputRequestTypeDef,
DescribeStacksInputRequestTypeDef,
DescribeTypeInputRequestTypeDef,
RequiredActivatedTypeTypeDef,
DescribeTypeRegistrationInputRequestTypeDef,
DetectStackDriftInputRequestTypeDef,
DetectStackResourceDriftInputRequestTypeDef,
ExecuteChangeSetInputRequestTypeDef,
ExportTypeDef,
GetStackPolicyInputRequestTypeDef,
GetTemplateInputRequestTypeDef,
GetTemplateSummaryInputRequestTypeDef,
ResourceIdentifierSummaryTypeDef,
ListChangeSetsInputRequestTypeDef,
ListExportsInputRequestTypeDef,
ListImportsInputRequestTypeDef,
StackInstanceFilterTypeDef,
ListStackResourcesInputRequestTypeDef,
OperationResultFilterTypeDef,
ListStackSetOperationsInputRequestTypeDef,
ListStackSetsInputRequestTypeDef,
ListStacksInputRequestTypeDef,
ListTypeRegistrationsInputRequestTypeDef,
ListTypeVersionsInputRequestTypeDef,
TypeVersionSummaryTypeDef,
TypeFiltersTypeDef,
TypeSummaryTypeDef,
ModuleInfoTypeDef,
OutputTypeDef,
ParameterConstraintsTypeDef,
PhysicalResourceIdContextKeyValuePairTypeDef,
PropertyDifferenceTypeDef,
PublishTypeInputRequestTypeDef,
RecordHandlerProgressInputRequestTypeDef,
RegisterPublisherInputRequestTypeDef,
ResourceTargetDefinitionTypeDef,
RollbackTriggerTypeDef,
RollbackStackInputRequestTypeDef,
SetStackPolicyInputRequestTypeDef,
SetTypeConfigurationInputRequestTypeDef,
SetTypeDefaultVersionInputRequestTypeDef,
SignalResourceInputRequestTypeDef,
StackDriftInformationSummaryTypeDef,
StackDriftInformationTypeDef,
StackInstanceComprehensiveStatusTypeDef,
StackResourceDriftInformationTypeDef,
StackResourceDriftInformationSummaryTypeDef,
StackSetDriftDetectionDetailsTypeDef,
StackSetOperationStatusDetailsTypeDef,
StopStackSetOperationInputRequestTypeDef,
TemplateParameterTypeDef,
TestTypeInputRequestTypeDef,
UpdateTerminationProtectionInputRequestTypeDef,
ValidateTemplateInputRequestTypeDef,
StackSetOperationResultSummaryTypeDef,
ActivateTypeInputRequestTypeDef,
RegisterTypeInputRequestTypeDef,
ActivateTypeOutputTypeDef,
CreateChangeSetOutputTypeDef,
CreateStackInstancesOutputTypeDef,
CreateStackOutputTypeDef,
CreateStackSetOutputTypeDef,
DeleteStackInstancesOutputTypeDef,
DescribeAccountLimitsOutputTypeDef,
DescribePublisherOutputTypeDef,
DescribeStackDriftDetectionStatusOutputTypeDef,
DescribeTypeRegistrationOutputTypeDef,
DetectStackDriftOutputTypeDef,
DetectStackSetDriftOutputTypeDef,
EmptyResponseMetadataTypeDef,
EstimateTemplateCostOutputTypeDef,
GetStackPolicyOutputTypeDef,
GetTemplateOutputTypeDef,
ImportStacksToStackSetOutputTypeDef,
ListImportsOutputTypeDef,
ListTypeRegistrationsOutputTypeDef,
ModuleInfoResponseMetadataTypeDef,
PublishTypeOutputTypeDef,
RegisterPublisherOutputTypeDef,
RegisterTypeOutputTypeDef,
RollbackStackOutputTypeDef,
SetTypeConfigurationOutputTypeDef,
StackDriftInformationResponseMetadataTypeDef,
StackResourceDriftInformationResponseMetadataTypeDef,
StackResourceDriftInformationSummaryResponseMetadataTypeDef,
TestTypeOutputTypeDef,
UpdateStackInstancesOutputTypeDef,
UpdateStackOutputTypeDef,
UpdateStackSetOutputTypeDef,
UpdateTerminationProtectionOutputTypeDef,
BatchDescribeTypeConfigurationsErrorTypeDef,
BatchDescribeTypeConfigurationsInputRequestTypeDef,
ChangeSetHookTargetDetailsTypeDef,
ListChangeSetsOutputTypeDef,
EstimateTemplateCostInputRequestTypeDef,
CreateStackInstancesInputRequestTypeDef,
DeleteStackInstancesInputRequestTypeDef,
DetectStackSetDriftInputRequestTypeDef,
ImportStacksToStackSetInputRequestTypeDef,
UpdateStackInstancesInputRequestTypeDef,
CreateStackSetInputRequestTypeDef,
StackSetSummaryTypeDef,
UpdateStackSetInputRequestTypeDef,
DescribeAccountLimitsInputDescribeAccountLimitsPaginateTypeDef,
DescribeChangeSetInputDescribeChangeSetPaginateTypeDef,
DescribeStackEventsInputDescribeStackEventsPaginateTypeDef,
DescribeStacksInputDescribeStacksPaginateTypeDef,
ListChangeSetsInputListChangeSetsPaginateTypeDef,
ListExportsInputListExportsPaginateTypeDef,
ListImportsInputListImportsPaginateTypeDef,
ListStackResourcesInputListStackResourcesPaginateTypeDef,
ListStackSetOperationsInputListStackSetOperationsPaginateTypeDef,
ListStackSetsInputListStackSetsPaginateTypeDef,
ListStacksInputListStacksPaginateTypeDef,
DescribeChangeSetInputChangeSetCreateCompleteWaitTypeDef,
DescribeStacksInputStackCreateCompleteWaitTypeDef,
DescribeStacksInputStackDeleteCompleteWaitTypeDef,
DescribeStacksInputStackExistsWaitTypeDef,
DescribeStacksInputStackImportCompleteWaitTypeDef,
DescribeStacksInputStackRollbackCompleteWaitTypeDef,
DescribeStacksInputStackUpdateCompleteWaitTypeDef,
DescribeTypeRegistrationInputTypeRegistrationCompleteWaitTypeDef,
DescribeStackEventsOutputTypeDef,
DescribeTypeOutputTypeDef,
ListExportsOutputTypeDef,
ListStackInstancesInputListStackInstancesPaginateTypeDef,
ListStackInstancesInputRequestTypeDef,
ListStackSetOperationResultsInputListStackSetOperationResultsPaginateTypeDef,
ListStackSetOperationResultsInputRequestTypeDef,
ListTypeVersionsOutputTypeDef,
ListTypesInputListTypesPaginateTypeDef,
ListTypesInputRequestTypeDef,
ListTypesOutputTypeDef,
ParameterDeclarationTypeDef,
StackResourceDriftTypeDef,
ResourceChangeDetailTypeDef,
RollbackConfigurationResponseMetadataTypeDef,
RollbackConfigurationTypeDef,
StackSummaryTypeDef,
StackInstanceSummaryTypeDef,
StackInstanceTypeDef,
StackResourceDetailTypeDef,
StackResourceTypeDef,
StackResourceSummaryTypeDef,
StackSetTypeDef,
StackSetOperationSummaryTypeDef,
StackSetOperationTypeDef,
ValidateTemplateOutputTypeDef,
ListStackSetOperationResultsOutputTypeDef,
BatchDescribeTypeConfigurationsOutputTypeDef,
ChangeSetHookTypeDef,
ListStackSetsOutputTypeDef,
GetTemplateSummaryOutputTypeDef,
DescribeStackResourceDriftsOutputTypeDef,
DetectStackResourceDriftOutputTypeDef,
ResourceChangeTypeDef,
CreateChangeSetInputRequestTypeDef,
CreateStackInputRequestTypeDef,
CreateStackInputServiceResourceCreateStackTypeDef,
StackTypeDef,
UpdateStackInputRequestTypeDef,
UpdateStackInputStackUpdateTypeDef,
ListStacksOutputTypeDef,
ListStackInstancesOutputTypeDef,
DescribeStackInstanceOutputTypeDef,
DescribeStackResourceOutputTypeDef,
DescribeStackResourcesOutputTypeDef,
ListStackResourcesOutputTypeDef,
DescribeStackSetOutputTypeDef,
ListStackSetOperationsOutputTypeDef,
DescribeStackSetOperationOutputTypeDef,
DescribeChangeSetHooksOutputTypeDef,
ChangeTypeDef,
DescribeStacksOutputTypeDef,
DescribeChangeSetOutputTypeDef,
)
def get_structure() -> AccountGateResultTypeDef:
return {...}
```
## 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 [black](https://github.com/psf/black) and
[isort](https://github.com/PyCQA/isort) for readability.
## What's new
### 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
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`mypy-boto3-cloudformation` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## 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
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudformation/)
## 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.
%prep
%autosetup -n mypy-boto3-cloudformation-1.26.108
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-mypy-boto3-cloudformation -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Mon Apr 10 2023 Python_Bot - 1.26.108-1
- Package Spec generated