mypy-boto3-cloudformation 1.18.0

Type annotations for boto3.CloudFormation 1.18.0 service, generated by mypy-boto3-buider 5.0.0

mypy-boto3-cloudformation

Type annotations for boto3.CloudFormation 1.18.0 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated by mypy-boto3-buider 5.0.0.

More information can be found on boto3-stubs page and in mypy-boto3-cloudformation docs

See how it helps to find and fix potential bugs:

• mypy-boto3-cloudformation
  • How to install
  • Usage
    • VSCode
    • PyCharm
    • Other IDEs
    • mypy
    • pyright
  • Explicit type annotations
    • Client annotations
    • Paginators annotations
    • Waiters annotations
    • Service Resource annotations
    • Other resources annotations
    • Collections annotations
    • Literals
    • Typed dictionaries
  • Versioning
  • Documentation
  • Support and contributing

How to install

Install boto3-stubs for CloudFormation service.

python -m pip install boto3-stubs[cloudformation]

Usage

VSCode

• Install Python extension
• Install Pylance extension
• Set Pylance as your Python Language Server
• Install boto-stubs[cloudformation] in your environment: python -m pip install 'boto3-stubs[cloudformation]'

Both type checking and auto-complete should work for CloudFormation service. No explicit type annotations required, write your boto3 code as usual.

PyCharm

• Install boto-stubs[cloudformation] in your environment: python -m pip install 'boto3-stubs[cloudformation]'

Both type checking and auto-complete should work for CloudFormation service. No explicit type annotations required, write your boto3 code as usual. Auto-complete can be slow on big projects or if you have a lot of installed boto3-stubs submodules.

Other IDEs

Not tested, but as long as your IDE support mypy or pyright, everything should work.

mypy

• Install mypy: python -m pip install mypy
• Install boto-stubs[cloudformation] in your environment: python -m pip install 'boto3-stubs[cloudformation]'
• Run mypy as usual

Type checking should work for CloudFormation service. No explicit type annotations required, write your boto3 code as usual.

pyright

• Install pyright: yarn global add pyright
• Install boto-stubs[cloudformation] in your environment: python -m pip install 'boto3-stubs[cloudformation]'
• Optionally, you can install boto3-stubs to typings folder.

Type checking should work for CloudFormation service. No explicit type annotations required, write your boto3 code as usual.

Explicit type annotations

Client annotations

CloudFormationClient provides annotations for boto3.client("cloudformation").

import boto3

from mypy_boto3_cloudformation import CloudFormationClient

client: CloudFormationClient = boto3.client("cloudformation")

# now client usage is checked by mypy and IDE should provide code auto-complete

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: CloudFormationClient = session.client("cloudformation")

Paginators annotations

mypy_boto3_cloudformation.paginator module contains type annotations for all paginators.

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 = boto3.client("cloudformation")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
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.

from mypy_boto3_cloudformation import CloudFormationClient
from mypy_boto3_cloudformation.waiter import (
    ChangeSetCreateCompleteWaiter,
    StackCreateCompleteWaiter,
    StackDeleteCompleteWaiter,
    StackExistsWaiter,
    StackImportCompleteWaiter,
    StackRollbackCompleteWaiter,
    StackUpdateCompleteWaiter,
    TypeRegistrationCompleteWaiter,
)

client: CloudFormationClient = boto3.client("cloudformation")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
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").

from mypy_boto3_cloudformation import CloudFormationServiceResource

resource: CloudFormationServiceResource = boto3.resource("cloudformation")

# now resource usage is checked by mypy and IDE should provide code auto-complete

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_resource: CloudFormationServiceResource = session.resource("cloudformation")

Other resources annotations

mypy_boto3_cloudformation.service_resource module contains type annotations for all resources.

from mypy_boto3_cloudformation import CloudFormationServiceResource
from mypy_boto3_cloudformation.service_resource import (
    Event,
    Stack,
    StackResource,
    StackResourceSummary,
)

resource: CloudFormationServiceResource = boto3.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.

from mypy_boto3_cloudformation import CloudFormationServiceResource
from mypy_boto3_cloudformation.service_resource import (
    ServiceResourceStacksCollection,
)

resource: CloudFormationServiceResource = boto3.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.

from mypy_boto3_cloudformation.literals import (
    AccountGateStatusType,
    CallAsType,
    CapabilityType,
    CategoryType,
    ChangeActionType,
    ChangeSetCreateCompleteWaiterName,
    ChangeSetStatusType,
    ChangeSetTypeType,
    ChangeSourceType,
    ChangeTypeType,
    DeprecatedStatusType,
    DescribeAccountLimitsPaginatorName,
    DescribeChangeSetPaginatorName,
    DescribeStackEventsPaginatorName,
    DescribeStacksPaginatorName,
    DifferenceTypeType,
    EvaluationTypeType,
    ExecutionStatusType,
    HandlerErrorCodeType,
    IdentityProviderType,
    ListChangeSetsPaginatorName,
    ListExportsPaginatorName,
    ListImportsPaginatorName,
    ListStackInstancesPaginatorName,
    ListStackResourcesPaginatorName,
    ListStackSetOperationResultsPaginatorName,
    ListStackSetOperationsPaginatorName,
    ListStackSetsPaginatorName,
    ListStacksPaginatorName,
    ListTypesPaginatorName,
    OnFailureType,
    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,
)

def check_value(value: AccountGateStatusType) -> bool:
    ...

Typed dictionaries

mypy_boto3_cloudformation.type_defs module contains structures and shapes assembled to typed dictionaries for additional type checking.

from mypy_boto3_cloudformation.type_defs import (
    AccountGateResultTypeDef,
    AccountLimitTypeDef,
    ActivateTypeInputRequestTypeDef,
    ActivateTypeOutputTypeDef,
    AutoDeploymentTypeDef,
    BatchDescribeTypeConfigurationsErrorTypeDef,
    BatchDescribeTypeConfigurationsInputRequestTypeDef,
    BatchDescribeTypeConfigurationsOutputTypeDef,
    CancelUpdateStackInputRequestTypeDef,
    CancelUpdateStackInputStackTypeDef,
    ChangeSetSummaryTypeDef,
    ChangeTypeDef,
    ContinueUpdateRollbackInputRequestTypeDef,
    CreateChangeSetInputRequestTypeDef,
    CreateChangeSetOutputTypeDef,
    CreateStackInputRequestTypeDef,
    CreateStackInputServiceResourceTypeDef,
    CreateStackInstancesInputRequestTypeDef,
    CreateStackInstancesOutputTypeDef,
    CreateStackOutputTypeDef,
    CreateStackSetInputRequestTypeDef,
    CreateStackSetOutputTypeDef,
    DeactivateTypeInputRequestTypeDef,
    DeleteChangeSetInputRequestTypeDef,
    DeleteStackInputRequestTypeDef,
    DeleteStackInputStackTypeDef,
    DeleteStackInstancesInputRequestTypeDef,
    DeleteStackInstancesOutputTypeDef,
    DeleteStackSetInputRequestTypeDef,
    DeploymentTargetsTypeDef,
    DeregisterTypeInputRequestTypeDef,
    DescribeAccountLimitsInputRequestTypeDef,
    DescribeAccountLimitsOutputTypeDef,
    DescribeChangeSetInputRequestTypeDef,
    DescribeChangeSetOutputTypeDef,
    DescribePublisherInputRequestTypeDef,
    DescribePublisherOutputTypeDef,
    DescribeStackDriftDetectionStatusInputRequestTypeDef,
    DescribeStackDriftDetectionStatusOutputTypeDef,
    DescribeStackEventsInputRequestTypeDef,
    DescribeStackEventsOutputTypeDef,
    DescribeStackInstanceInputRequestTypeDef,
    DescribeStackInstanceOutputTypeDef,
    DescribeStackResourceDriftsInputRequestTypeDef,
    DescribeStackResourceDriftsOutputTypeDef,
    DescribeStackResourceInputRequestTypeDef,
    DescribeStackResourceOutputTypeDef,
    DescribeStackResourcesInputRequestTypeDef,
    DescribeStackResourcesOutputTypeDef,
    DescribeStackSetInputRequestTypeDef,
    DescribeStackSetOperationInputRequestTypeDef,
    DescribeStackSetOperationOutputTypeDef,
    DescribeStackSetOutputTypeDef,
    DescribeStacksInputRequestTypeDef,
    DescribeStacksOutputTypeDef,
    DescribeTypeInputRequestTypeDef,
    DescribeTypeOutputTypeDef,
    DescribeTypeRegistrationInputRequestTypeDef,
    DescribeTypeRegistrationOutputTypeDef,
    DetectStackDriftInputRequestTypeDef,
    DetectStackDriftOutputTypeDef,
    DetectStackResourceDriftInputRequestTypeDef,
    DetectStackResourceDriftOutputTypeDef,
    DetectStackSetDriftInputRequestTypeDef,
    DetectStackSetDriftOutputTypeDef,
    EstimateTemplateCostInputRequestTypeDef,
    EstimateTemplateCostOutputTypeDef,
    ExecuteChangeSetInputRequestTypeDef,
    ExportTypeDef,
    GetStackPolicyInputRequestTypeDef,
    GetStackPolicyOutputTypeDef,
    GetTemplateInputRequestTypeDef,
    GetTemplateOutputTypeDef,
    GetTemplateSummaryInputRequestTypeDef,
    GetTemplateSummaryOutputTypeDef,
    ListChangeSetsInputRequestTypeDef,
    ListChangeSetsOutputTypeDef,
    ListExportsInputRequestTypeDef,
    ListExportsOutputTypeDef,
    ListImportsInputRequestTypeDef,
    ListImportsOutputTypeDef,
    ListStackInstancesInputRequestTypeDef,
    ListStackInstancesOutputTypeDef,
    ListStackResourcesInputRequestTypeDef,
    ListStackResourcesOutputTypeDef,
    ListStackSetOperationResultsInputRequestTypeDef,
    ListStackSetOperationResultsOutputTypeDef,
    ListStackSetOperationsInputRequestTypeDef,
    ListStackSetOperationsOutputTypeDef,
    ListStackSetsInputRequestTypeDef,
    ListStackSetsOutputTypeDef,
    ListStacksInputRequestTypeDef,
    ListStacksOutputTypeDef,
    ListTypeRegistrationsInputRequestTypeDef,
    ListTypeRegistrationsOutputTypeDef,
    ListTypeVersionsInputRequestTypeDef,
    ListTypeVersionsOutputTypeDef,
    ListTypesInputRequestTypeDef,
    ListTypesOutputTypeDef,
    LoggingConfigTypeDef,
    ModuleInfoTypeDef,
    OutputTypeDef,
    PaginatorConfigTypeDef,
    ParameterConstraintsTypeDef,
    ParameterDeclarationTypeDef,
    ParameterTypeDef,
    PhysicalResourceIdContextKeyValuePairTypeDef,
    PropertyDifferenceTypeDef,
    PublishTypeInputRequestTypeDef,
    PublishTypeOutputTypeDef,
    RecordHandlerProgressInputRequestTypeDef,
    RegisterPublisherInputRequestTypeDef,
    RegisterPublisherOutputTypeDef,
    RegisterTypeInputRequestTypeDef,
    RegisterTypeOutputTypeDef,
    RequiredActivatedTypeTypeDef,
    ResourceChangeDetailTypeDef,
    ResourceChangeTypeDef,
    ResourceIdentifierSummaryTypeDef,
    ResourceTargetDefinitionTypeDef,
    ResourceToImportTypeDef,
    ResponseMetadataTypeDef,
    RollbackConfigurationTypeDef,
    RollbackTriggerTypeDef,
    ServiceResourceEventRequestTypeDef,
    ServiceResourceStackRequestTypeDef,
    ServiceResourceStackResourceRequestTypeDef,
    ServiceResourceStackResourceSummaryRequestTypeDef,
    SetStackPolicyInputRequestTypeDef,
    SetTypeConfigurationInputRequestTypeDef,
    SetTypeConfigurationOutputTypeDef,
    SetTypeDefaultVersionInputRequestTypeDef,
    SignalResourceInputRequestTypeDef,
    StackDriftInformationSummaryTypeDef,
    StackDriftInformationTypeDef,
    StackEventTypeDef,
    StackInstanceComprehensiveStatusTypeDef,
    StackInstanceFilterTypeDef,
    StackInstanceSummaryTypeDef,
    StackInstanceTypeDef,
    StackResourceDetailTypeDef,
    StackResourceDriftInformationSummaryTypeDef,
    StackResourceDriftInformationTypeDef,
    StackResourceDriftTypeDef,
    StackResourceRequestTypeDef,
    StackResourceSummaryTypeDef,
    StackResourceTypeDef,
    StackSetDriftDetectionDetailsTypeDef,
    StackSetOperationPreferencesTypeDef,
    StackSetOperationResultSummaryTypeDef,
    StackSetOperationSummaryTypeDef,
    StackSetOperationTypeDef,
    StackSetSummaryTypeDef,
    StackSetTypeDef,
    StackSummaryTypeDef,
    StackTypeDef,
    StopStackSetOperationInputRequestTypeDef,
    TagTypeDef,
    TemplateParameterTypeDef,
    TestTypeInputRequestTypeDef,
    TestTypeOutputTypeDef,
    TypeConfigurationDetailsTypeDef,
    TypeConfigurationIdentifierTypeDef,
    TypeFiltersTypeDef,
    TypeSummaryTypeDef,
    TypeVersionSummaryTypeDef,
    UpdateStackInputRequestTypeDef,
    UpdateStackInputStackTypeDef,
    UpdateStackInstancesInputRequestTypeDef,
    UpdateStackInstancesOutputTypeDef,
    UpdateStackOutputTypeDef,
    UpdateStackSetInputRequestTypeDef,
    UpdateStackSetOutputTypeDef,
    UpdateTerminationProtectionInputRequestTypeDef,
    UpdateTerminationProtectionOutputTypeDef,
    ValidateTemplateInputRequestTypeDef,
    ValidateTemplateOutputTypeDef,
    WaiterConfigTypeDef,
)

def get_structure() -> AccountGateResultTypeDef:
    return {
      ...
    }

Versioning

mypy-boto3-cloudformation version is the same as related boto3 version and follows PEP 440 format.

Documentation

All type annotations can be found in mypy-boto3-cloudformation docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.