Amazon Web Services, Inc.

AWS User Notifications

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

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 .

Endpoints 40

Channel

  • POSTAssociate channel/channels/associate/:arnAssociates a delivery Channel with a particular NotificationConfiguration . Supported Channels include Amazon Q Developer in chat applications, the Console…
  • POSTDisassociate channel/channels/disassociate/:arnDisassociates a Channel from a specified NotificationConfiguration . Supported Channels include Amazon Q Developer in chat applications, the Console Mobile…
  • GETList channels/channels?notificationConfigurationArn=string&maxResults=0&nextToken=stringReturns a list of Channels for a NotificationConfiguration .

Managed notification account contact association

  • PUTAssociate managed notification account contact/contacts/associate-managed-notification/:contactIdentifierAssociates an Account Contact with a particular ManagedNotificationConfiguration .
  • PUTDisassociate managed notification account contact/contacts/disassociate-managed-notification/:contactIdentifierDisassociates an Account Contact with a particular ManagedNotificationConfiguration .

Managed notification additional channel association

  • PUTAssociate managed notification additional channel/channels/associate-managed-notification/:channelArnAssociates an additional Channel with a particular ManagedNotificationConfiguration . Supported Channels include Amazon Q Developer in chat applications, the…
  • PUTDisassociate managed notification additional channel/channels/disassociate-managed-notification/:channelArnDisassociates an additional Channel from a particular ManagedNotificationConfiguration . Supported Channels include Amazon Q Developer in chat applications,…

Organizational unit

  • POSTAssociate organizational unit/organizational-units/associate/:organizationalUnitIdAssociates an organizational unit with a notification configuration.
  • POSTDisassociate organizational unit/organizational-units/disassociate/:organizationalUnitIdRemoves the association between an organizational unit and a notification configuration.
  • GETList organizational units/organizational-units?notificationConfigurationArn=string&maxResults=0&nextToken=stringReturns a list of organizational units associated with a notification configuration.

Event rule

  • GETList event rules/event-rules?notificationConfigurationArn=string&maxResults=0&nextToken=stringReturns a list of EventRules according to specified filters, in reverse chronological order (newest first).
  • POSTCreate event rule/event-rulesCreates an EventRule that is associated with a specified NotificationConfiguration .
  • GETGet event rule/event-rules/:arnReturns a specified EventRule .
  • PUTUpdate event rule/event-rules/:arnUpdates an existing EventRule .
  • DELETEDelete event rule/event-rules/:arnDeletes an EventRule .

Notification configuration

  • GETList notification configurations/notification-configurations?eventRuleSource=string&channelArn=string&status=string&subtype=string&maxResults=0&nextToken=stringReturns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).
  • POSTCreate notification configuration/notification-configurationsCreates a new NotificationConfiguration .
  • GETGet notification configuration/notification-configurations/:arnReturns a specified NotificationConfiguration .
  • PUTUpdate notification configuration/notification-configurations/:arnUpdates a NotificationConfiguration .
  • DELETEDelete notification configuration/notification-configurations/:arnDeletes a NotificationConfiguration .

Notification hub

  • DELETEDeregister notification hub/notification-hubs/:notificationHubRegionDeregisters a NotificationHub in the specified Region. You can't deregister the last NotificationHub in the account. NotificationEvents stored in the…
  • GETList notification hubs/notification-hubs?maxResults=0&nextToken=stringReturns a list of NotificationHubs .
  • POSTRegister notification hub/notification-hubsRegisters a NotificationHub in the specified Region. There is a maximum of one NotificationHub per Region. You can have a maximum of 3 NotificationHub…

Organization access

  • GETGet notifications access for organization/organization/accessReturns the AccessStatus of Service Trust Enablement for User Notifications and Amazon Web Services Organizations.
  • POSTEnable notifications access for organization/organization/accessEnables service trust between User Notifications and Amazon Web Services Organizations.
  • DELETEDisable notifications access for organization/organization/accessDisables service trust between User Notifications and Amazon Web Services Organizations.

Managed notification child event

  • GETGet managed notification child event/managed-notification-child-events/:arn?locale=stringReturns the child event of a specific given ManagedNotificationEvent .
  • GETList managed notification child events/list-managed-notification-child-events/:aggregateManagedNotificationEventArn?startTime=string&endTime=string&locale=string&maxResults=0&relatedAccount=string&organizationalUnitId=string&nextToken=stringReturns a list of ManagedNotificationChildEvents for a specified aggregate ManagedNotificationEvent , ordered by creation time in reverse chronological order…

Managed notification configuration

  • GETGet managed notification configuration/managed-notification-configurations/:arnReturns a specified ManagedNotificationConfiguration .
  • GETList managed notification configurations/managed-notification-configurations?channelIdentifier=string&maxResults=0&nextToken=stringReturns a list of Managed Notification Configurations according to specified filters, ordered by creation time in reverse chronological order (newest first).

Managed notification event

  • GETGet managed notification event/managed-notification-events/:arn?locale=stringReturns a specified ManagedNotificationEvent .
  • GETList managed notification events/managed-notification-events?startTime=string&endTime=string&locale=string&source=string&maxResults=0&nextToken=string&organizationalUnitId=string&relatedAccount=string&includeSensitiveEvents=trueReturns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order (newest first).

Notification event

  • GETGet notification event/notification-events/:arn?locale=stringReturns a specified NotificationEvent . User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of…
  • GETList notification events/notification-events?startTime=string&endTime=string&locale=string&source=string&includeChildEvents=true&aggregateNotificationEventArn=string&maxResults=0&nextToken=string&organizationalUnitId=stringReturns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first). User Notifications stores notifications in…
  • GETList managed notification channel associations/channels/list-managed-notification-channel-associations?managedNotificationConfigurationArn=string&maxResults=0&nextToken=stringReturns a list of Account contacts and Channels associated with a ManagedNotificationConfiguration , in paginated format.
  • GETList member accounts/list-member-accounts?notificationConfigurationArn=string&maxResults=0&nextToken=string&memberAccount=string&status=string&organizationalUnitId=stringReturns a list of member accounts associated with a notification configuration.
  • GETList tags for resource/tags/:arnReturns 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…
  • POSTTag resource/tags/:arnTags 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…
  • DELETEUntag resource/tags/:arn?tagKeys=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…
  • PUTUpdate managed notification channel association/channels/update-managed-notification-channel-associationUpdates the isSensitiveEventsSubscribed property of a particular ManagedNotification channel association.

API details

Base URL
https://notifications.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
40 operations on 29 pathsGET 19POST 9PUT 7DELETE 5
Main resources
Event rule 5Notification configuration 5Channel 3Notification hub 3Organization access 3Organizational unit 3Managed notification account contact association 2Managed notification additional channel association 2Managed notification child event 2Managed notification configuration 2
Description format
AWS Smithy model, API version 2018-05-10

How to test the AWS User Notifications in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS User Notifications collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate channel” (POST /channels/associate/:arn), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS User Notifications?

The User Notifications API Reference provides descriptions, API request parameters, and the JSON response for each of the User Notifications API actions. User… It is listed under Communication and has 40 endpoints.

Who publishes the AWS User Notifications?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS User Notifications?

Requests go to https://notifications.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS User Notifications?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS User Notifications have?

40 operations on 29 paths (19 GET, 9 POST, 7 PUT, 5 DELETE). The largest groups are Event rule, Notification configuration, Channel, Notification hub.

Is forking the AWS User Notifications free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.