Skip to content

UserNotificationsClient#

Index > UserNotifications > UserNotificationsClient

Auto-generated documentation for UserNotifications type annotations stubs module mypy-boto3-notifications.

UserNotificationsClient#

Type annotations and code completion for boto3.client("notifications"). boto3 documentation

# UserNotificationsClient usage example

from boto3.session import Session
from mypy_boto3_notifications.client import UserNotificationsClient

def get_notifications_client() -> UserNotificationsClient:
    return Session().client("notifications")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("notifications").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("notifications")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_notifications.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

associate_channel#

Associates a delivery Channel with a particular NotificationConfiguration.

Type annotations and code completion for boto3.client("notifications").associate_channel method. boto3 documentation

# associate_channel method definition

def associate_channel(
    self,
    *,
    arn: str,
    notificationConfigurationArn: str,
) -> Dict[str, Any]:
    ...
# associate_channel method usage example with argument unpacking

kwargs: AssociateChannelRequestRequestTypeDef = {  # (1)
    "arn": ...,
    "notificationConfigurationArn": ...,
}

parent.associate_channel(**kwargs)
  1. See AssociateChannelRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("notifications").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("notifications").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_event_rule#

Creates an EventRule that is associated with a specified Notification Configuration.

Type annotations and code completion for boto3.client("notifications").create_event_rule method. boto3 documentation

# create_event_rule method definition

def create_event_rule(
    self,
    *,
    notificationConfigurationArn: str,
    source: str,
    eventType: str,
    regions: Sequence[str],
    eventPattern: str = ...,
) -> CreateEventRuleResponseTypeDef:  # (1)
    ...
  1. See CreateEventRuleResponseTypeDef 
# create_event_rule method usage example with argument unpacking

kwargs: CreateEventRuleRequestRequestTypeDef = {  # (1)
    "notificationConfigurationArn": ...,
    "source": ...,
    "eventType": ...,
    "regions": ...,
}

parent.create_event_rule(**kwargs)
  1. See CreateEventRuleRequestRequestTypeDef

create_notification_configuration#

Creates a new NotificationConfiguration.

Type annotations and code completion for boto3.client("notifications").create_notification_configuration method. boto3 documentation

# create_notification_configuration method definition

def create_notification_configuration(
    self,
    *,
    name: str,
    description: str,
    aggregationDuration: AggregationDurationType = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateNotificationConfigurationResponseTypeDef:  # (2)
    ...
  1. See AggregationDurationType
  2. See CreateNotificationConfigurationResponseTypeDef 
# create_notification_configuration method usage example with argument unpacking

kwargs: CreateNotificationConfigurationRequestRequestTypeDef = {  # (1)
    "name": ...,
    "description": ...,
}

parent.create_notification_configuration(**kwargs)
  1. See CreateNotificationConfigurationRequestRequestTypeDef

delete_event_rule#

Deletes an EventRule.

Type annotations and code completion for boto3.client("notifications").delete_event_rule method. boto3 documentation

# delete_event_rule method definition

def delete_event_rule(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...
# delete_event_rule method usage example with argument unpacking

kwargs: DeleteEventRuleRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_event_rule(**kwargs)
  1. See DeleteEventRuleRequestRequestTypeDef

delete_notification_configuration#

Deletes a NotificationConfiguration.

Type annotations and code completion for boto3.client("notifications").delete_notification_configuration method. boto3 documentation

# delete_notification_configuration method definition

def delete_notification_configuration(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...
# delete_notification_configuration method usage example with argument unpacking

kwargs: DeleteNotificationConfigurationRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_notification_configuration(**kwargs)
  1. See DeleteNotificationConfigurationRequestRequestTypeDef

deregister_notification_hub#

Deregisters a NotificationHub in the specified Region.

Type annotations and code completion for boto3.client("notifications").deregister_notification_hub method. boto3 documentation

# deregister_notification_hub method definition

def deregister_notification_hub(
    self,
    *,
    notificationHubRegion: str,
) -> DeregisterNotificationHubResponseTypeDef:  # (1)
    ...
  1. See DeregisterNotificationHubResponseTypeDef 
# deregister_notification_hub method usage example with argument unpacking

kwargs: DeregisterNotificationHubRequestRequestTypeDef = {  # (1)
    "notificationHubRegion": ...,
}

parent.deregister_notification_hub(**kwargs)
  1. See DeregisterNotificationHubRequestRequestTypeDef

disassociate_channel#

Disassociates a Channel from a specified NotificationConfiguration.

Type annotations and code completion for boto3.client("notifications").disassociate_channel method. boto3 documentation

# disassociate_channel method definition

def disassociate_channel(
    self,
    *,
    arn: str,
    notificationConfigurationArn: str,
) -> Dict[str, Any]:
    ...
# disassociate_channel method usage example with argument unpacking

kwargs: DisassociateChannelRequestRequestTypeDef = {  # (1)
    "arn": ...,
    "notificationConfigurationArn": ...,
}

parent.disassociate_channel(**kwargs)
  1. See DisassociateChannelRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("notifications").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_event_rule#

Returns a specified EventRule.

Type annotations and code completion for boto3.client("notifications").get_event_rule method. boto3 documentation

# get_event_rule method definition

def get_event_rule(
    self,
    *,
    arn: str,
) -> GetEventRuleResponseTypeDef:  # (1)
    ...
  1. See GetEventRuleResponseTypeDef 
# get_event_rule method usage example with argument unpacking

kwargs: GetEventRuleRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_event_rule(**kwargs)
  1. See GetEventRuleRequestRequestTypeDef

get_notification_configuration#

Returns a specified NotificationConfiguration.

Type annotations and code completion for boto3.client("notifications").get_notification_configuration method. boto3 documentation

# get_notification_configuration method definition

def get_notification_configuration(
    self,
    *,
    arn: str,
) -> GetNotificationConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetNotificationConfigurationResponseTypeDef 
# get_notification_configuration method usage example with argument unpacking

kwargs: GetNotificationConfigurationRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_notification_configuration(**kwargs)
  1. See GetNotificationConfigurationRequestRequestTypeDef

get_notification_event#

Returns a specified NotificationEvent.

Type annotations and code completion for boto3.client("notifications").get_notification_event method. boto3 documentation

# get_notification_event method definition

def get_notification_event(
    self,
    *,
    arn: str,
    locale: LocaleCodeType = ...,  # (1)
) -> GetNotificationEventResponseTypeDef:  # (2)
    ...
  1. See LocaleCodeType
  2. See GetNotificationEventResponseTypeDef 
# get_notification_event method usage example with argument unpacking

kwargs: GetNotificationEventRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_notification_event(**kwargs)
  1. See GetNotificationEventRequestRequestTypeDef

list_channels#

Returns a list of Channels for a NotificationConfiguration.

Type annotations and code completion for boto3.client("notifications").list_channels method. boto3 documentation

# list_channels method definition

def list_channels(
    self,
    *,
    notificationConfigurationArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListChannelsResponseTypeDef:  # (1)
    ...
  1. See ListChannelsResponseTypeDef 
# list_channels method usage example with argument unpacking

kwargs: ListChannelsRequestRequestTypeDef = {  # (1)
    "notificationConfigurationArn": ...,
}

parent.list_channels(**kwargs)
  1. See ListChannelsRequestRequestTypeDef

list_event_rules#

Returns a list of EventRules according to specified filters, in reverse chronological order (newest first).

Type annotations and code completion for boto3.client("notifications").list_event_rules method. boto3 documentation

# list_event_rules method definition

def list_event_rules(
    self,
    *,
    notificationConfigurationArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListEventRulesResponseTypeDef:  # (1)
    ...
  1. See ListEventRulesResponseTypeDef 
# list_event_rules method usage example with argument unpacking

kwargs: ListEventRulesRequestRequestTypeDef = {  # (1)
    "notificationConfigurationArn": ...,
}

parent.list_event_rules(**kwargs)
  1. See ListEventRulesRequestRequestTypeDef

list_notification_configurations#

Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).

Type annotations and code completion for boto3.client("notifications").list_notification_configurations method. boto3 documentation

# list_notification_configurations method definition

def list_notification_configurations(
    self,
    *,
    eventRuleSource: str = ...,
    channelArn: str = ...,
    status: NotificationConfigurationStatusType = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListNotificationConfigurationsResponseTypeDef:  # (2)
    ...
  1. See NotificationConfigurationStatusType
  2. See ListNotificationConfigurationsResponseTypeDef 
# list_notification_configurations method usage example with argument unpacking

kwargs: ListNotificationConfigurationsRequestRequestTypeDef = {  # (1)
    "eventRuleSource": ...,
}

parent.list_notification_configurations(**kwargs)
  1. See ListNotificationConfigurationsRequestRequestTypeDef

list_notification_events#

Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first).

Type annotations and code completion for boto3.client("notifications").list_notification_events method. boto3 documentation

# list_notification_events method definition

def list_notification_events(
    self,
    *,
    startTime: TimestampTypeDef = ...,
    endTime: TimestampTypeDef = ...,
    locale: LocaleCodeType = ...,  # (1)
    source: str = ...,
    includeChildEvents: bool = ...,
    aggregateNotificationEventArn: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListNotificationEventsResponseTypeDef:  # (2)
    ...
  1. See LocaleCodeType
  2. See ListNotificationEventsResponseTypeDef 
# list_notification_events method usage example with argument unpacking

kwargs: ListNotificationEventsRequestRequestTypeDef = {  # (1)
    "startTime": ...,
}

parent.list_notification_events(**kwargs)
  1. See ListNotificationEventsRequestRequestTypeDef

list_notification_hubs#

Returns a list of NotificationHubs.

Type annotations and code completion for boto3.client("notifications").list_notification_hubs method. boto3 documentation

# list_notification_hubs method definition

def list_notification_hubs(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListNotificationHubsResponseTypeDef:  # (1)
    ...
  1. See ListNotificationHubsResponseTypeDef 
# list_notification_hubs method usage example with argument unpacking

kwargs: ListNotificationHubsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_notification_hubs(**kwargs)
  1. See ListNotificationHubsRequestRequestTypeDef

list_tags_for_resource#

Returns a list of tags for a specified Amazon Resource Name (ARN).

Type annotations and code completion for boto3.client("notifications").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    arn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

register_notification_hub#

Registers a NotificationHub in the specified Region.

Type annotations and code completion for boto3.client("notifications").register_notification_hub method. boto3 documentation

# register_notification_hub method definition

def register_notification_hub(
    self,
    *,
    notificationHubRegion: str,
) -> RegisterNotificationHubResponseTypeDef:  # (1)
    ...
  1. See RegisterNotificationHubResponseTypeDef 
# register_notification_hub method usage example with argument unpacking

kwargs: RegisterNotificationHubRequestRequestTypeDef = {  # (1)
    "notificationHubRegion": ...,
}

parent.register_notification_hub(**kwargs)
  1. See RegisterNotificationHubRequestRequestTypeDef

tag_resource#

Tags the resource with a tag key and value.

Type annotations and code completion for boto3.client("notifications").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    arn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "arn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Untags a resource with a specified Amazon Resource Name (ARN).

Type annotations and code completion for boto3.client("notifications").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    arn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "arn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_event_rule#

Updates an existing EventRule.

Type annotations and code completion for boto3.client("notifications").update_event_rule method. boto3 documentation

# update_event_rule method definition

def update_event_rule(
    self,
    *,
    arn: str,
    eventPattern: str = ...,
    regions: Sequence[str] = ...,
) -> UpdateEventRuleResponseTypeDef:  # (1)
    ...
  1. See UpdateEventRuleResponseTypeDef 
# update_event_rule method usage example with argument unpacking

kwargs: UpdateEventRuleRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.update_event_rule(**kwargs)
  1. See UpdateEventRuleRequestRequestTypeDef

update_notification_configuration#

Updates a NotificationConfiguration.

Type annotations and code completion for boto3.client("notifications").update_notification_configuration method. boto3 documentation

# update_notification_configuration method definition

def update_notification_configuration(
    self,
    *,
    arn: str,
    name: str = ...,
    description: str = ...,
    aggregationDuration: AggregationDurationType = ...,  # (1)
) -> UpdateNotificationConfigurationResponseTypeDef:  # (2)
    ...
  1. See AggregationDurationType
  2. See UpdateNotificationConfigurationResponseTypeDef 
# update_notification_configuration method usage example with argument unpacking

kwargs: UpdateNotificationConfigurationRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.update_notification_configuration(**kwargs)
  1. See UpdateNotificationConfigurationRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("notifications").get_paginator method with overloads.