UserNotifications module#
Index > UserNotifications
Auto-generated documentation for UserNotifications type annotations stubs module mypy-boto3-notifications.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.97' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
UserNotifications
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and UserNotifications
.
From PyPI with pip#
Install boto3-stubs
for UserNotifications
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[notifications]'
# 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[notifications]'
# standalone installation
python -m pip install mypy-boto3-notifications
How to uninstall#
python -m pip uninstall -y mypy-boto3-notifications
Usage#
Code samples can be found in Examples.
UserNotificationsClient#
Type annotations and code completion for boto3.client("notifications")
as UserNotificationsClient
boto3 documentation
# UserNotificationsClient usage example
from boto3.session import Session
from mypy_boto3_notifications.client import UserNotificationsClient
def get_client() -> UserNotificationsClient:
return Session().client("notifications")
Paginators#
Type annotations and code completion for paginators
from boto3.client("notifications").get_paginator("...")
.
# ListChannelsPaginator usage example
from boto3.session import Session
from mypy_boto3_notifications.paginator import ListChannelsPaginator
def get_list_channels_paginator() -> ListChannelsPaginator:
return Session().client("notifications").get_paginator("list_channels"))
- ListChannelsPaginator
- ListEventRulesPaginator
- ListNotificationConfigurationsPaginator
- ListNotificationEventsPaginator
- ListNotificationHubsPaginator
Literals#
Type annotations for literals used in methods and schema.
# AggregationDurationType usage example
from mypy_boto3_notifications.literals import AggregationDurationType
def get_value() -> AggregationDurationType:
return "LONG"