View Source AWS.Notifications (aws-elixir v1.0.7)
The Amazon Web Services User Notifications API Reference provides descriptions, API request parameters, and the JSON response for each of the User Notification API actions.
User Notification control plane APIs are currently available in US East
(Virginia) - us-east-1
.
GetNotificationEvent and ListNotificationEvents APIs are currently available in commercial partition Regions and only return notifications stored in the same Region in which they're called.
The User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a notification hub in addition to US East (Virginia).
Link to this section Summary
Functions
Associates a delivery
Channel
with a particular NotificationConfiguration
.
Associates an Account Contact with a particular
ManagedNotificationConfiguration
.
Associates an additional Channel with a particular
ManagedNotificationConfiguration
.
Creates an
EventRule
that
is associated with a specified NotificationConfiguration
.
Creates a new NotificationConfiguration
.
Deletes an EventRule
.
Deletes a NotificationConfiguration
.
Deregisters a NotificationConfiguration
in the specified Region.
Disables service trust between User Notifications and Amazon Web Services Organizations.
Disassociates a Channel from a specified NotificationConfiguration
.
Disassociates an Account Contact with a particular
ManagedNotificationConfiguration
.
Disassociates an additional Channel from a particular
ManagedNotificationConfiguration
.
Enables service trust between User Notifications and Amazon Web Services Organizations.
Returns a specified EventRule
.
Returns the child event of a specific given ManagedNotificationEvent
.
Returns a specified ManagedNotificationConfiguration
.
Returns a specified ManagedNotificationEvent
.
Returns a specified NotificationConfiguration
.
Returns a specified NotificationEvent
.
Returns the AccessStatus of Service Trust Enablement for User Notifications and Amazon Web Services Organizations.
Returns a list of Channels for a NotificationConfiguration
.
Returns a list of EventRules
according to specified filters, in reverse
chronological order (newest first).
Returns a list of Account contacts and Channels associated with a
ManagedNotificationConfiguration
, in paginated format.
Returns a list of ManagedNotificationChildEvents
for a specified aggregate
ManagedNotificationEvent
, ordered by creation time in reverse chronological
order (newest first).
Returns a list of Managed Notification Configurations according to specified filters, ordered by creation time in reverse chronological order (newest first).
Returns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order (newest first).
Returns a list of abbreviated NotificationConfigurations
according to
specified filters, in reverse chronological order (newest first).
Returns a list of NotificationEvents
according to specified filters, in
reverse chronological order (newest first).
Returns a list of NotificationHubs
.
Returns a list of tags for a specified Amazon Resource Name (ARN).
Registers a NotificationConfiguration
in the specified Region.
Tags the resource with a tag key and value.
Untags a resource with a specified Amazon Resource Name (ARN).
Updates an existing EventRule
.
Updates a NotificationConfiguration
.
Link to this section Functions
Associates a delivery
Channel
with a particular NotificationConfiguration
.
Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).
associate_managed_notification_account_contact(client, contact_identifier, input, options \\ [])
View SourceAssociates an Account Contact with a particular
ManagedNotificationConfiguration
.
associate_managed_notification_additional_channel(client, channel_arn, input, options \\ [])
View SourceAssociates an additional Channel with a particular
ManagedNotificationConfiguration
.
Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).
Creates an
EventRule
that
is associated with a specified NotificationConfiguration
.
Creates a new NotificationConfiguration
.
Deletes an EventRule
.
delete_notification_configuration(client, arn, input, options \\ [])
View SourceDeletes a NotificationConfiguration
.
deregister_notification_hub(client, notification_hub_region, input, options \\ [])
View SourceDeregisters a NotificationConfiguration
in the specified Region.
You can't deregister the last NotificationHub
in the account.
NotificationEvents
stored in the deregistered NotificationConfiguration
are
no
longer be visible. Recreating a new NotificationConfiguration
in the same
Region restores access
to those NotificationEvents
.
disable_notifications_access_for_organization(client, input, options \\ [])
View SourceDisables service trust between User Notifications and Amazon Web Services Organizations.
Disassociates a Channel from a specified NotificationConfiguration
.
Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).
disassociate_managed_notification_account_contact(client, contact_identifier, input, options \\ [])
View SourceDisassociates an Account Contact with a particular
ManagedNotificationConfiguration
.
disassociate_managed_notification_additional_channel(client, channel_arn, input, options \\ [])
View SourceDisassociates an additional Channel from a particular
ManagedNotificationConfiguration
.
Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).
enable_notifications_access_for_organization(client, input, options \\ [])
View SourceEnables service trust between User Notifications and Amazon Web Services Organizations.
Returns a specified EventRule
.
get_managed_notification_child_event(client, arn, locale \\ nil, options \\ [])
View SourceReturns the child event of a specific given ManagedNotificationEvent
.
get_managed_notification_configuration(client, arn, options \\ [])
View SourceReturns a specified ManagedNotificationConfiguration
.
get_managed_notification_event(client, arn, locale \\ nil, options \\ [])
View SourceReturns a specified ManagedNotificationEvent
.
Returns a specified NotificationConfiguration
.
Returns a specified NotificationEvent
.
User Notifications stores notifications in the individual Regions you register
as notification hubs and the Region of the source event rule.
GetNotificationEvent
only returns notifications stored in the same Region in
which the action is called.
User Notifications doesn't backfill notifications to new Regions selected as
notification hubs. For this reason, we recommend that you make calls in your
oldest registered notification hub.
For more information, see Notification hubs
in the Amazon Web Services User Notifications User Guide.
Returns the AccessStatus of Service Trust Enablement for User Notifications and Amazon Web Services Organizations.
list_channels(client, max_results \\ nil, next_token \\ nil, notification_configuration_arn, options \\ [])
View SourceReturns a list of Channels for a NotificationConfiguration
.
list_event_rules(client, max_results \\ nil, next_token \\ nil, notification_configuration_arn, options \\ [])
View SourceReturns a list of EventRules
according to specified filters, in reverse
chronological order (newest first).
list_managed_notification_channel_associations(client, managed_notification_configuration_arn, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of Account contacts and Channels associated with a
ManagedNotificationConfiguration
, in paginated format.
list_managed_notification_child_events(client, aggregate_managed_notification_event_arn, end_time \\ nil, locale \\ nil, max_results \\ nil, next_token \\ nil, organizational_unit_id \\ nil, related_account \\ nil, start_time \\ nil, options \\ [])
View SourceReturns a list of ManagedNotificationChildEvents
for a specified aggregate
ManagedNotificationEvent
, ordered by creation time in reverse chronological
order (newest first).
list_managed_notification_configurations(client, channel_identifier \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of Managed Notification Configurations according to specified filters, ordered by creation time in reverse chronological order (newest first).
list_managed_notification_events(client, end_time \\ nil, locale \\ nil, max_results \\ nil, next_token \\ nil, organizational_unit_id \\ nil, related_account \\ nil, source \\ nil, start_time \\ nil, options \\ [])
View SourceReturns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order (newest first).
list_notification_configurations(client, channel_arn \\ nil, event_rule_source \\ nil, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])
View SourceReturns a list of abbreviated NotificationConfigurations
according to
specified filters, in reverse chronological order (newest first).
list_notification_events(client, aggregate_notification_event_arn \\ nil, end_time \\ nil, include_child_events \\ nil, locale \\ nil, max_results \\ nil, next_token \\ nil, source \\ nil, start_time \\ nil, options \\ [])
View SourceReturns a list of NotificationEvents
according to specified filters, in
reverse chronological order (newest first).
User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ListNotificationEvents only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the Amazon Web Services User Notifications User Guide.
list_notification_hubs(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of NotificationHubs
.
Returns a list of tags for a specified Amazon Resource Name (ARN).
For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.
This is only supported for NotificationConfigurations
.
Registers a NotificationConfiguration
in the specified Region.
There is a maximum of one NotificationConfiguration
per Region. You can have a
maximum of 3 NotificationHub
resources at a time.
Tags the resource with a tag key and value.
For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.
This is only supported for NotificationConfigurations
.
Untags a resource with a specified Amazon Resource Name (ARN).
For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.
Updates an existing EventRule
.
update_notification_configuration(client, arn, input, options \\ [])
View SourceUpdates a NotificationConfiguration
.