Type definitions#
Index > UserNotifications > Type definitions
Auto-generated documentation for UserNotifications type annotations stubs module mypy-boto3-notifications.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
AssociateChannelRequestRequestTypeDef#
# AssociateChannelRequestRequestTypeDef definition
class AssociateChannelRequestRequestTypeDef(TypedDict):
arn: str,
notificationConfigurationArn: str,
CreateEventRuleRequestRequestTypeDef#
# CreateEventRuleRequestRequestTypeDef definition
class CreateEventRuleRequestRequestTypeDef(TypedDict):
notificationConfigurationArn: str,
source: str,
eventType: str,
regions: Sequence[str],
eventPattern: NotRequired[str],
EventRuleStatusSummaryTypeDef#
# EventRuleStatusSummaryTypeDef definition
class EventRuleStatusSummaryTypeDef(TypedDict):
status: EventRuleStatusType, # (1)
reason: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
CreateNotificationConfigurationRequestRequestTypeDef#
# CreateNotificationConfigurationRequestRequestTypeDef definition
class CreateNotificationConfigurationRequestRequestTypeDef(TypedDict):
name: str,
description: str,
aggregationDuration: NotRequired[AggregationDurationType], # (1)
tags: NotRequired[Mapping[str, str]],
DeleteEventRuleRequestRequestTypeDef#
# DeleteEventRuleRequestRequestTypeDef definition
class DeleteEventRuleRequestRequestTypeDef(TypedDict):
arn: str,
DeleteNotificationConfigurationRequestRequestTypeDef#
# DeleteNotificationConfigurationRequestRequestTypeDef definition
class DeleteNotificationConfigurationRequestRequestTypeDef(TypedDict):
arn: str,
DeregisterNotificationHubRequestRequestTypeDef#
# DeregisterNotificationHubRequestRequestTypeDef definition
class DeregisterNotificationHubRequestRequestTypeDef(TypedDict):
notificationHubRegion: str,
NotificationHubStatusSummaryTypeDef#
# NotificationHubStatusSummaryTypeDef definition
class NotificationHubStatusSummaryTypeDef(TypedDict):
status: NotificationHubStatusType, # (1)
reason: str,
DimensionTypeDef#
# DimensionTypeDef definition
class DimensionTypeDef(TypedDict):
name: str,
value: str,
DisassociateChannelRequestRequestTypeDef#
# DisassociateChannelRequestRequestTypeDef definition
class DisassociateChannelRequestRequestTypeDef(TypedDict):
arn: str,
notificationConfigurationArn: str,
GetEventRuleRequestRequestTypeDef#
# GetEventRuleRequestRequestTypeDef definition
class GetEventRuleRequestRequestTypeDef(TypedDict):
arn: str,
GetNotificationConfigurationRequestRequestTypeDef#
# GetNotificationConfigurationRequestRequestTypeDef definition
class GetNotificationConfigurationRequestRequestTypeDef(TypedDict):
arn: str,
GetNotificationEventRequestRequestTypeDef#
# GetNotificationEventRequestRequestTypeDef definition
class GetNotificationEventRequestRequestTypeDef(TypedDict):
arn: str,
locale: NotRequired[LocaleCodeType], # (1)
- See LocaleCodeType
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListChannelsRequestRequestTypeDef#
# ListChannelsRequestRequestTypeDef definition
class ListChannelsRequestRequestTypeDef(TypedDict):
notificationConfigurationArn: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListEventRulesRequestRequestTypeDef#
# ListEventRulesRequestRequestTypeDef definition
class ListEventRulesRequestRequestTypeDef(TypedDict):
notificationConfigurationArn: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListNotificationConfigurationsRequestRequestTypeDef#
# ListNotificationConfigurationsRequestRequestTypeDef definition
class ListNotificationConfigurationsRequestRequestTypeDef(TypedDict):
eventRuleSource: NotRequired[str],
channelArn: NotRequired[str],
status: NotRequired[NotificationConfigurationStatusType], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
NotificationConfigurationStructureTypeDef#
# NotificationConfigurationStructureTypeDef definition
class NotificationConfigurationStructureTypeDef(TypedDict):
arn: str,
name: str,
description: str,
status: NotificationConfigurationStatusType, # (1)
creationTime: datetime,
aggregationDuration: NotRequired[AggregationDurationType], # (2)
ListNotificationHubsRequestRequestTypeDef#
# ListNotificationHubsRequestRequestTypeDef definition
class ListNotificationHubsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
arn: str,
MediaElementTypeDef#
# MediaElementTypeDef definition
class MediaElementTypeDef(TypedDict):
mediaId: str,
type: MediaElementTypeType, # (1)
url: str,
caption: str,
MessageComponentsSummaryTypeDef#
# MessageComponentsSummaryTypeDef definition
class MessageComponentsSummaryTypeDef(TypedDict):
headline: str,
SourceEventMetadataSummaryTypeDef#
# SourceEventMetadataSummaryTypeDef definition
class SourceEventMetadataSummaryTypeDef(TypedDict):
source: str,
eventType: str,
eventOriginRegion: NotRequired[str],
TextPartValueTypeDef#
# TextPartValueTypeDef definition
class TextPartValueTypeDef(TypedDict):
type: TextPartTypeType, # (1)
displayText: NotRequired[str],
textByLocale: NotRequired[dict[LocaleCodeType, str]], # (2)
url: NotRequired[str],
- See TextPartTypeType
- See LocaleCodeType
RegisterNotificationHubRequestRequestTypeDef#
# RegisterNotificationHubRequestRequestTypeDef definition
class RegisterNotificationHubRequestRequestTypeDef(TypedDict):
notificationHubRegion: str,
ResourceTypeDef#
# ResourceTypeDef definition
class ResourceTypeDef(TypedDict):
id: NotRequired[str],
arn: NotRequired[str],
detailUrl: NotRequired[str],
tags: NotRequired[list[str]],
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
arn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
arn: str,
tagKeys: Sequence[str],
UpdateEventRuleRequestRequestTypeDef#
# UpdateEventRuleRequestRequestTypeDef definition
class UpdateEventRuleRequestRequestTypeDef(TypedDict):
arn: str,
eventPattern: NotRequired[str],
regions: NotRequired[Sequence[str]],
UpdateNotificationConfigurationRequestRequestTypeDef#
# UpdateNotificationConfigurationRequestRequestTypeDef definition
class UpdateNotificationConfigurationRequestRequestTypeDef(TypedDict):
arn: str,
name: NotRequired[str],
description: NotRequired[str],
aggregationDuration: NotRequired[AggregationDurationType], # (1)
EventRuleStructureTypeDef#
# EventRuleStructureTypeDef definition
class EventRuleStructureTypeDef(TypedDict):
arn: str,
notificationConfigurationArn: str,
creationTime: datetime,
source: str,
eventType: str,
eventPattern: str,
regions: list[str],
managedRules: list[str],
statusSummaryByRegion: dict[str, EventRuleStatusSummaryTypeDef], # (1)
CreateEventRuleResponseTypeDef#
# CreateEventRuleResponseTypeDef definition
class CreateEventRuleResponseTypeDef(TypedDict):
arn: str,
notificationConfigurationArn: str,
statusSummaryByRegion: dict[str, EventRuleStatusSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateNotificationConfigurationResponseTypeDef#
# CreateNotificationConfigurationResponseTypeDef definition
class CreateNotificationConfigurationResponseTypeDef(TypedDict):
arn: str,
status: NotificationConfigurationStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetEventRuleResponseTypeDef#
# GetEventRuleResponseTypeDef definition
class GetEventRuleResponseTypeDef(TypedDict):
arn: str,
notificationConfigurationArn: str,
creationTime: datetime,
source: str,
eventType: str,
eventPattern: str,
regions: list[str],
managedRules: list[str],
statusSummaryByRegion: dict[str, EventRuleStatusSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetNotificationConfigurationResponseTypeDef#
# GetNotificationConfigurationResponseTypeDef definition
class GetNotificationConfigurationResponseTypeDef(TypedDict):
arn: str,
name: str,
description: str,
status: NotificationConfigurationStatusType, # (1)
creationTime: datetime,
aggregationDuration: AggregationDurationType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ListChannelsResponseTypeDef#
# ListChannelsResponseTypeDef definition
class ListChannelsResponseTypeDef(TypedDict):
channels: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
nextToken: NotRequired[str],
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateEventRuleResponseTypeDef#
# UpdateEventRuleResponseTypeDef definition
class UpdateEventRuleResponseTypeDef(TypedDict):
arn: str,
notificationConfigurationArn: str,
statusSummaryByRegion: dict[str, EventRuleStatusSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateNotificationConfigurationResponseTypeDef#
# UpdateNotificationConfigurationResponseTypeDef definition
class UpdateNotificationConfigurationResponseTypeDef(TypedDict):
arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeregisterNotificationHubResponseTypeDef#
# DeregisterNotificationHubResponseTypeDef definition
class DeregisterNotificationHubResponseTypeDef(TypedDict):
notificationHubRegion: str,
statusSummary: NotificationHubStatusSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NotificationHubOverviewTypeDef#
# NotificationHubOverviewTypeDef definition
class NotificationHubOverviewTypeDef(TypedDict):
notificationHubRegion: str,
statusSummary: NotificationHubStatusSummaryTypeDef, # (1)
creationTime: datetime,
lastActivationTime: NotRequired[datetime],
RegisterNotificationHubResponseTypeDef#
# RegisterNotificationHubResponseTypeDef definition
class RegisterNotificationHubResponseTypeDef(TypedDict):
notificationHubRegion: str,
statusSummary: NotificationHubStatusSummaryTypeDef, # (1)
creationTime: datetime,
lastActivationTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
MessageComponentsTypeDef#
# MessageComponentsTypeDef definition
class MessageComponentsTypeDef(TypedDict):
headline: NotRequired[str],
paragraphSummary: NotRequired[str],
completeDescription: NotRequired[str],
dimensions: NotRequired[list[DimensionTypeDef]], # (1)
- See DimensionTypeDef
ListChannelsRequestPaginateTypeDef#
# ListChannelsRequestPaginateTypeDef definition
class ListChannelsRequestPaginateTypeDef(TypedDict):
notificationConfigurationArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListEventRulesRequestPaginateTypeDef#
# ListEventRulesRequestPaginateTypeDef definition
class ListEventRulesRequestPaginateTypeDef(TypedDict):
notificationConfigurationArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListNotificationConfigurationsRequestPaginateTypeDef#
# ListNotificationConfigurationsRequestPaginateTypeDef definition
class ListNotificationConfigurationsRequestPaginateTypeDef(TypedDict):
eventRuleSource: NotRequired[str],
channelArn: NotRequired[str],
status: NotRequired[NotificationConfigurationStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListNotificationHubsRequestPaginateTypeDef#
# ListNotificationHubsRequestPaginateTypeDef definition
class ListNotificationHubsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListNotificationConfigurationsResponseTypeDef#
# ListNotificationConfigurationsResponseTypeDef definition
class ListNotificationConfigurationsResponseTypeDef(TypedDict):
notificationConfigurations: list[NotificationConfigurationStructureTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListNotificationEventsRequestPaginateTypeDef#
# ListNotificationEventsRequestPaginateTypeDef definition
class ListNotificationEventsRequestPaginateTypeDef(TypedDict):
startTime: NotRequired[TimestampTypeDef],
endTime: NotRequired[TimestampTypeDef],
locale: NotRequired[LocaleCodeType], # (1)
source: NotRequired[str],
includeChildEvents: NotRequired[bool],
aggregateNotificationEventArn: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See LocaleCodeType
- See PaginatorConfigTypeDef
ListNotificationEventsRequestRequestTypeDef#
# ListNotificationEventsRequestRequestTypeDef definition
class ListNotificationEventsRequestRequestTypeDef(TypedDict):
startTime: NotRequired[TimestampTypeDef],
endTime: NotRequired[TimestampTypeDef],
locale: NotRequired[LocaleCodeType], # (1)
source: NotRequired[str],
includeChildEvents: NotRequired[bool],
aggregateNotificationEventArn: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
- See LocaleCodeType
NotificationEventSummaryTypeDef#
# NotificationEventSummaryTypeDef definition
class NotificationEventSummaryTypeDef(TypedDict):
schemaVersion: SchemaVersionType, # (1)
sourceEventMetadata: SourceEventMetadataSummaryTypeDef, # (2)
messageComponents: MessageComponentsSummaryTypeDef, # (3)
eventStatus: EventStatusType, # (4)
notificationType: NotificationTypeType, # (5)
- See SchemaVersionType
- See SourceEventMetadataSummaryTypeDef
- See MessageComponentsSummaryTypeDef
- See EventStatusType
- See NotificationTypeType
SourceEventMetadataTypeDef#
# SourceEventMetadataTypeDef definition
class SourceEventMetadataTypeDef(TypedDict):
eventTypeVersion: str,
sourceEventId: str,
relatedAccount: str,
source: str,
eventOccurrenceTime: datetime,
eventType: str,
relatedResources: list[ResourceTypeDef], # (1)
eventOriginRegion: NotRequired[str],
- See ResourceTypeDef
ListEventRulesResponseTypeDef#
# ListEventRulesResponseTypeDef definition
class ListEventRulesResponseTypeDef(TypedDict):
eventRules: list[EventRuleStructureTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListNotificationHubsResponseTypeDef#
# ListNotificationHubsResponseTypeDef definition
class ListNotificationHubsResponseTypeDef(TypedDict):
notificationHubs: list[NotificationHubOverviewTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
NotificationEventOverviewTypeDef#
# NotificationEventOverviewTypeDef definition
class NotificationEventOverviewTypeDef(TypedDict):
arn: str,
notificationConfigurationArn: str,
relatedAccount: str,
creationTime: datetime,
notificationEvent: NotificationEventSummaryTypeDef, # (1)
aggregationEventType: NotRequired[AggregationEventTypeType], # (2)
aggregateNotificationEventArn: NotRequired[str],
NotificationEventTypeDef#
# NotificationEventTypeDef definition
class NotificationEventTypeDef(TypedDict):
schemaVersion: SchemaVersionType, # (1)
id: str,
sourceEventMetadata: SourceEventMetadataTypeDef, # (2)
messageComponents: MessageComponentsTypeDef, # (3)
notificationType: NotificationTypeType, # (4)
textParts: dict[str, TextPartValueTypeDef], # (7)
media: list[MediaElementTypeDef], # (8)
sourceEventDetailUrl: NotRequired[str],
sourceEventDetailUrlDisplayText: NotRequired[str],
eventStatus: NotRequired[EventStatusType], # (5)
aggregationEventType: NotRequired[AggregationEventTypeType], # (6)
aggregateNotificationEventArn: NotRequired[str],
startTime: NotRequired[datetime],
endTime: NotRequired[datetime],
- See SchemaVersionType
- See SourceEventMetadataTypeDef
- See MessageComponentsTypeDef
- See NotificationTypeType
- See EventStatusType
- See AggregationEventTypeType
- See TextPartValueTypeDef
- See MediaElementTypeDef
ListNotificationEventsResponseTypeDef#
# ListNotificationEventsResponseTypeDef definition
class ListNotificationEventsResponseTypeDef(TypedDict):
notificationEvents: list[NotificationEventOverviewTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
GetNotificationEventResponseTypeDef#
# GetNotificationEventResponseTypeDef definition
class GetNotificationEventResponseTypeDef(TypedDict):
arn: str,
notificationConfigurationArn: str,
creationTime: datetime,
content: NotificationEventTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)