aws-elixir v1.0.10

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

The User Notifications API Reference provides descriptions, API request parameters, and the JSON response for each of the User Notifications 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).

For information about descriptions, API request parameters, and the JSON response for email contact related API actions, see the User Notifications Contacts API Reference Guide.

Link to this section Summary

Functions

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

Associates a delivery Channel with a particular NotificationConfiguration.

associate_managed_notification_account_contact(client, contact_identifier, input, options \\ [])

Associates an Account Contact with a particular ManagedNotificationConfiguration.

associate_managed_notification_additional_channel(client, channel_arn, input, options \\ [])

Associates an additional Channel with a particular ManagedNotificationConfiguration.

associate_organizational_unit(client, organizational_unit_id, input, options \\ [])

Associates an organizational unit with a notification configuration.

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

Creates an EventRule that is associated with a specified NotificationConfiguration.

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 NotificationConfiguration in the specified Region.

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

Disables service trust between User Notifications and Amazon Web Services Organizations.

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

Disassociates a Channel from a specified NotificationConfiguration.

disassociate_managed_notification_account_contact(client, contact_identifier, input, options \\ [])

Disassociates an Account Contact with a particular ManagedNotificationConfiguration.

disassociate_managed_notification_additional_channel(client, channel_arn, input, options \\ [])

Disassociates an additional Channel from a particular ManagedNotificationConfiguration.

disassociate_organizational_unit(client, organizational_unit_id, input, options \\ [])

Removes the association between an organizational unit and a notification configuration.

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

Enables service trust between User Notifications and Amazon Web Services Organizations.

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

Returns a specified EventRule.

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

Returns the child event of a specific given ManagedNotificationEvent.

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

Returns a specified ManagedNotificationConfiguration.

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

Returns a specified ManagedNotificationEvent.

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

Returns a specified NotificationConfiguration.

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

Returns a specified NotificationEvent.

get_notifications_access_for_organization(client, options \\ [])

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

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_managed_notification_channel_associations(client, managed_notification_configuration_arn, max_results \\ nil, next_token \\ nil, options \\ [])

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

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

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

Returns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order (newest first).

list_member_accounts(client, max_results \\ nil, member_account \\ nil, next_token \\ nil, notification_configuration_arn, organizational_unit_id \\ nil, status \\ nil, options \\ [])

Returns a list of member accounts associated with a notification configuration.

list_notification_configurations(client, channel_arn \\ nil, event_rule_source \\ nil, max_results \\ nil, next_token \\ nil, status \\ nil, subtype \\ 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, organizational_unit_id \\ 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_organizational_units(client, max_results \\ nil, next_token \\ nil, notification_configuration_arn, options \\ [])

Returns a list of organizational units associated with a notification configuration.

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 NotificationConfiguration 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

Link to this function

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

View Source

Associates a delivery Channel with a particular NotificationConfiguration.

Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

Link to this function

associate_managed_notification_account_contact(client, contact_identifier, input, options \\ [])

View Source

Associates an Account Contact with a particular ManagedNotificationConfiguration.

Link to this function

associate_managed_notification_additional_channel(client, channel_arn, input, options \\ [])

View Source

Associates an additional Channel with a particular ManagedNotificationConfiguration.

Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

Link to this function

associate_organizational_unit(client, organizational_unit_id, input, options \\ [])

View Source

Associates an organizational unit with a notification configuration.

Link to this function

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

View Source

Creates an EventRule that is associated with a specified NotificationConfiguration.

Link to this function

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

View Source

Creates a new NotificationConfiguration.

Link to this function

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

View Source

Deletes an EventRule.

Link to this function

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

View Source

Deletes a NotificationConfiguration.

Link to this function

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

View Source

Deregisters 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.

Link to this function

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

View Source

Disables service trust between User Notifications and Amazon Web Services Organizations.

Link to this function

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

View Source

Disassociates a Channel from a specified NotificationConfiguration.

Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

Link to this function

disassociate_managed_notification_account_contact(client, contact_identifier, input, options \\ [])

View Source

Disassociates an Account Contact with a particular ManagedNotificationConfiguration.

Link to this function

disassociate_managed_notification_additional_channel(client, channel_arn, input, options \\ [])

View Source

Disassociates an additional Channel from a particular ManagedNotificationConfiguration.

Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

Link to this function

disassociate_organizational_unit(client, organizational_unit_id, input, options \\ [])

View Source

Removes the association between an organizational unit and a notification configuration.

Link to this function

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

View Source

Enables service trust between User Notifications and Amazon Web Services Organizations.

Link to this function

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

View Source

Returns a specified EventRule.

Link to this function

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

View Source

Returns the child event of a specific given ManagedNotificationEvent.

Link to this function

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

View Source

Returns a specified ManagedNotificationConfiguration.

Link to this function

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

View Source

Returns a specified ManagedNotificationEvent.

Link to this function

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

View Source

Returns a specified NotificationConfiguration.

Link to this function

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

View Source

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.

Link to this function

get_notifications_access_for_organization(client, options \\ [])

View Source

Returns the AccessStatus of Service Trust Enablement for User Notifications and Amazon Web Services Organizations.

Link to this function

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

View Source

Returns a list of Channels for a NotificationConfiguration.

Link to this function

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

View Source

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

Link to this function

list_managed_notification_channel_associations(client, managed_notification_configuration_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of Account contacts and Channels associated with a ManagedNotificationConfiguration, in paginated format.

Link to this function

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 Source

Returns a list of ManagedNotificationChildEvents for a specified aggregate ManagedNotificationEvent, ordered by creation time in reverse chronological order (newest first).

Link to this function

list_managed_notification_configurations(client, channel_identifier \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of Managed Notification Configurations according to specified filters, ordered by creation time in reverse chronological order (newest first).

Link to this function

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 Source

Returns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order (newest first).

Link to this function

list_member_accounts(client, max_results \\ nil, member_account \\ nil, next_token \\ nil, notification_configuration_arn, organizational_unit_id \\ nil, status \\ nil, options \\ [])

View Source

Returns a list of member accounts associated with a notification configuration.

Link to this function

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

View Source

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

Link to this function

list_notification_events(client, aggregate_notification_event_arn \\ nil, end_time \\ nil, include_child_events \\ nil, locale \\ nil, max_results \\ nil, next_token \\ nil, organizational_unit_id \\ nil, source \\ nil, start_time \\ nil, options \\ [])

View Source

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 Amazon Web Services User Notifications User Guide.

Link to this function

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

View Source

Returns a list of NotificationHubs.

Link to this function

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

View Source

Returns a list of organizational units associated with a notification configuration.

Link to this function

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

View Source

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.

Link to this function

metadata()

View Source
Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Updates an existing EventRule.

Link to this function

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

View Source

Updates a NotificationConfiguration.