View Source AWS.Notifications (aws-elixir v1.0.4)

The AWS User Notifications API Reference provides descriptions, API request parameters, and the JSON response for each of the User Notification API actions.

User Notification control 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

associate_channel(client, arn, input, options \\ [])

Associates a delivery Channel with a particular NotificationConfiguration.

create_event_rule(client, input, options \\ [])

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

create_notification_configuration(client, input, options \\ [])

Creates a new NotificationConfiguration.

delete_event_rule(client, arn, input, options \\ [])

Deletes an EventRule.

delete_notification_configuration(client, arn, input, options \\ [])

Deletes a NotificationConfiguration.

deregister_notification_hub(client, notification_hub_region, input, options \\ [])

Deregisters a NotificationHub in the specified Region.

disassociate_channel(client, arn, input, options \\ [])

Disassociates a Channel from a specified NotificationConfiguration.

get_event_rule(client, arn, options \\ [])

Returns a specified EventRule.

get_notification_configuration(client, arn, options \\ [])

Returns a specified NotificationConfiguration.

get_notification_event(client, arn, locale \\ nil, options \\ [])

Returns a specified NotificationEvent.

list_channels(client, max_results \\ nil, next_token \\ nil, notification_configuration_arn, options \\ [])

Returns a list of Channels for a NotificationConfiguration.

list_event_rules(client, max_results \\ nil, next_token \\ nil, notification_configuration_arn, options \\ [])

Returns a list of EventRules according to specified filters, 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 \\ [])

Returns 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 \\ [])

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

list_notification_hubs(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of NotificationHubs.

list_tags_for_resource(client, arn, options \\ [])

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

metadata()

register_notification_hub(client, input, options \\ [])

Registers a NotificationHub in the specified Region.

tag_resource(client, arn, input, options \\ [])

Tags the resource with a tag key and value.

untag_resource(client, arn, input, options \\ [])

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

update_event_rule(client, arn, input, options \\ [])

Updates an existing EventRule.

update_notification_configuration(client, arn, input, options \\ [])

Updates a NotificationConfiguration.

Link to this section Functions

associate_channel(client, arn, input, options \\ [])

Associates a delivery Channel with a particular NotificationConfiguration.

Supported Channels include AWS Chatbot, the AWS Console Mobile Application, and emails (notifications-contacts).

create_event_rule(client, input, options \\ [])

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

create_notification_configuration(client, input, options \\ [])

Creates a new NotificationConfiguration.

delete_event_rule(client, arn, input, options \\ [])

Deletes an EventRule.

delete_notification_configuration(client, arn, input, options \\ [])

Deletes a NotificationConfiguration.

deregister_notification_hub(client, notification_hub_region, input, options \\ [])

Deregisters a NotificationHub in the specified Region.

You can't deregister the last NotificationHub in the account. NotificationEvents stored in the deregistered NotificationHub are no longer be visible. Recreating a new NotificationHub in the same Region restores access to those NotificationEvents.

disassociate_channel(client, arn, input, options \\ [])

Disassociates a Channel from a specified NotificationConfiguration.

Supported Channels include AWS Chatbot, the AWS Console Mobile Application, and emails (notifications-contacts).

get_event_rule(client, arn, options \\ [])

Returns a specified EventRule.

get_notification_configuration(client, arn, options \\ [])

Returns a specified NotificationConfiguration.

get_notification_event(client, arn, locale \\ nil, options \\ [])

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 AWS User Notifications User Guide.

list_channels(client, max_results \\ nil, next_token \\ nil, notification_configuration_arn, options \\ [])

Returns a list of Channels for a NotificationConfiguration.

list_event_rules(client, max_results \\ nil, next_token \\ nil, notification_configuration_arn, options \\ [])

Returns a list of EventRules according to specified filters, 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 \\ [])

Returns 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 \\ [])

Returns 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 AWS User Notifications User Guide.

list_notification_hubs(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of NotificationHubs.

list_tags_for_resource(client, arn, options \\ [])

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

For more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.

This is only supported for NotificationConfigurations.

metadata()

register_notification_hub(client, input, options \\ [])

Registers a NotificationHub in the specified Region.

There is a maximum of one NotificationHub per Region. You can have a maximum of 3 NotificationHubs at a time.

tag_resource(client, arn, input, options \\ [])

Tags the resource with a tag key and value.

For more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.

This is only supported for NotificationConfigurations.

untag_resource(client, arn, input, options \\ [])

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

For more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.

update_event_rule(client, arn, input, options \\ [])

Updates an existing EventRule.

update_notification_configuration(client, arn, input, options \\ [])

Updates a NotificationConfiguration.

Settings View Source AWS.Notifications (aws-elixir v1.0.4)

Link to this section Summary

Functions

Link to this section Functions

associate_channel(client, arn, input, options \\ [])

create_event_rule(client, input, options \\ [])

create_notification_configuration(client, input, options \\ [])

delete_event_rule(client, arn, input, options \\ [])

delete_notification_configuration(client, arn, input, options \\ [])

deregister_notification_hub(client, notification_hub_region, input, options \\ [])

disassociate_channel(client, arn, input, options \\ [])

get_event_rule(client, arn, options \\ [])

get_notification_configuration(client, arn, options \\ [])

get_notification_event(client, arn, locale \\ nil, options \\ [])

list_channels(client, max_results \\ nil, next_token \\ nil, notification_configuration_arn, options \\ [])

list_event_rules(client, max_results \\ nil, next_token \\ nil, notification_configuration_arn, options \\ [])

list_notification_configurations(client, channel_arn \\ nil, event_rule_source \\ nil, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

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 \\ [])

list_notification_hubs(client, max_results \\ nil, next_token \\ nil, options \\ [])

list_tags_for_resource(client, arn, options \\ [])

metadata()

register_notification_hub(client, input, options \\ [])

tag_resource(client, arn, input, options \\ [])

untag_resource(client, arn, input, options \\ [])

update_event_rule(client, arn, input, options \\ [])

update_notification_configuration(client, arn, input, options \\ [])

View Source AWS.Notifications (aws-elixir v1.0.4)