UserNotifications module#
Index > UserNotifications
Auto-generated documentation for UserNotifications type annotations stubs module types-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.86' mypy_boto3_builder
- Select
boto3
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 types-boto3
for UserNotifications
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[notifications]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[notifications]'
# standalone installation
python -m pip install types-boto3-notifications
How to uninstall#
python -m pip uninstall -y types-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 types_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 types_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 types_boto3_notifications.literals import AggregationDurationType
def get_value() -> AggregationDurationType:
return "LONG"
- AggregationDurationType
- AggregationEventTypeType
- EventRuleStatusType
- EventStatusType
- ListChannelsPaginatorName
- ListEventRulesPaginatorName
- ListNotificationConfigurationsPaginatorName
- ListNotificationEventsPaginatorName
- ListNotificationHubsPaginatorName
- LocaleCodeType
- MediaElementTypeType
- NotificationConfigurationStatusType
- NotificationHubStatusType
- NotificationTypeType
- SchemaVersionType
- TextPartTypeType
- UserNotificationsServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AssociateChannelRequestRequestTypeDef
- CreateEventRuleRequestRequestTypeDef
- EventRuleStatusSummaryTypeDef
- ResponseMetadataTypeDef
- CreateNotificationConfigurationRequestRequestTypeDef
- DeleteEventRuleRequestRequestTypeDef
- DeleteNotificationConfigurationRequestRequestTypeDef
- DeregisterNotificationHubRequestRequestTypeDef
- NotificationHubStatusSummaryTypeDef
- DimensionTypeDef
- DisassociateChannelRequestRequestTypeDef
- GetEventRuleRequestRequestTypeDef
- GetNotificationConfigurationRequestRequestTypeDef
- GetNotificationEventRequestRequestTypeDef
- PaginatorConfigTypeDef
- ListChannelsRequestRequestTypeDef
- ListEventRulesRequestRequestTypeDef
- ListNotificationConfigurationsRequestRequestTypeDef
- NotificationConfigurationStructureTypeDef
- TimestampTypeDef
- ListNotificationHubsRequestRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- MediaElementTypeDef
- MessageComponentsSummaryTypeDef
- SourceEventMetadataSummaryTypeDef
- TextPartValueTypeDef
- RegisterNotificationHubRequestRequestTypeDef
- ResourceTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateEventRuleRequestRequestTypeDef
- UpdateNotificationConfigurationRequestRequestTypeDef
- EventRuleStructureTypeDef
- CreateEventRuleResponseTypeDef
- CreateNotificationConfigurationResponseTypeDef
- GetEventRuleResponseTypeDef
- GetNotificationConfigurationResponseTypeDef
- ListChannelsResponseTypeDef
- ListTagsForResourceResponseTypeDef
- UpdateEventRuleResponseTypeDef
- UpdateNotificationConfigurationResponseTypeDef
- DeregisterNotificationHubResponseTypeDef
- NotificationHubOverviewTypeDef
- RegisterNotificationHubResponseTypeDef
- MessageComponentsTypeDef
- ListChannelsRequestPaginateTypeDef
- ListEventRulesRequestPaginateTypeDef
- ListNotificationConfigurationsRequestPaginateTypeDef
- ListNotificationHubsRequestPaginateTypeDef
- ListNotificationConfigurationsResponseTypeDef
- ListNotificationEventsRequestPaginateTypeDef
- ListNotificationEventsRequestRequestTypeDef
- NotificationEventSummaryTypeDef
- SourceEventMetadataTypeDef
- ListEventRulesResponseTypeDef
- ListNotificationHubsResponseTypeDef
- NotificationEventOverviewTypeDef
- NotificationEventTypeDef
- ListNotificationEventsResponseTypeDef
- GetNotificationEventResponseTypeDef