mypy-boto3-application-signals Type Stubs

1.42.76 · active · verified Sat Apr 11

mypy-boto3-application-signals provides static type annotations for the `boto3` AWS SDK specifically for the CloudWatchApplicationSignals service, currently at version 1.42.76. It is generated by `mypy-boto3-builder` and receives frequent updates, often aligning with `boto3` releases and `mypy-boto3-builder` enhancements, to ensure up-to-date type information for improved code quality and IDE support.

Warnings

breaking Support for Python 3.8 has been removed across all `mypy-boto3` packages with builder version 8.12.0. Users must use Python 3.9 or higher.
Fix: Upgrade your Python environment to 3.9 or newer.
breaking All `mypy-boto3` packages migrated to PEP 561, impacting how stubs are distributed and potentially how some build systems or explicit import paths behave.
Fix: Ensure your project's build and dependency management systems are compatible with PEP 561 stub packages. Verify imports if you were relying on internal package structures.
gotcha PyCharm users might experience slow performance or high CPU usage due to `Literal` overloads. It's recommended to use `boto3-stubs-lite` (if applicable for the service), or disable PyCharm's internal type checker and rely on `mypy` or `pyright`.
Fix: Consider `pip install boto3-stubs-lite[application-signals]` or configure PyCharm to use external type checkers like `mypy` or `pyright`.
breaking General `mypy-boto3` `TypeDef` naming conventions changed in builder version 8.9.0. `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`, and conflicting `Extra` postfixes moved to the end (e.g., `CreateDistributionExtraRequestTypeDef` to `CreateDistributionRequestExtraTypeDef`).
Fix: Review and update `TypedDict` references in your code to match the new naming conventions.
deprecated The `sms-voice` service was deprecated and removed from `mypy-boto3` builds in builder version 8.11.0. Users should migrate to `pinpoint-sms-voice` instead. While this specific package is for `application-signals`, this indicates potential breaking changes for other services in the `mypy-boto3` ecosystem.
Fix: For the `sms-voice` service, migrate to `pinpoint-sms-voice`. Always check release notes for changes to specific services you use.

Install

pip install mypy-boto3-application-signals Install service-specific stubs
pip install boto3-stubs[application-signals] Install as part of boto3-stubs

Imports

ApplicationSignalsClient
```
from mypy_boto3_application_signals.client import ApplicationSignalsClient
```
Used for type-hinting the boto3 client for CloudWatchApplicationSignals.
CloudWatchEventSourceType
```
from mypy_boto3_application_signals.literals import CloudWatchEventSourceType
```
Example of importing a service-specific Literal type.
ServiceResource
```
from mypy_boto3_application_signals.service_resource import ApplicationSignalsServiceResource
```
Used for type-hinting the boto3 service resource (if applicable for the service).

Quickstart

This quickstart demonstrates how to obtain a type-hinted `CloudWatchApplicationSignalsClient` instance using `mypy-boto3-application-signals`. The `TYPE_CHECKING` guard is a common pattern to ensure `mypy-boto3` packages are only used during type checking, avoiding potential runtime dependencies.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_application_signals.client import ApplicationSignalsClient

def get_application_signals_client() -> ApplicationSignalsClient:
    """Provides a type-hinted CloudWatchApplicationSignals client."""
    # boto3.client will be correctly type-hinted by mypy when mypy-boto3-application-signals is installed.
    return boto3.client("application-signals")

client = get_application_signals_client()
# Example usage with type-hinted client (methods and parameters will autocomplete)
response = client.list_service_dependencies(
    StartTime=1678886400, # Example timestamp
    EndTime=1678886400 + 3600 # Example timestamp
)

print(response)

view raw JSON →