You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat(client-notifications): Added support for Managed Notifications, integration with AWS Organization and added aggregation summaries for Aggregate Notifications
Copy file name to clipboardExpand all lines: clients/client-notifications/README.md
+115-3
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,14 @@
6
6
7
7
AWS SDK for JavaScript Notifications Client for Node.js, Browser and React Native.
8
8
9
-
<p>The <i>AWS User Notifications API Reference</i> provides descriptions, API request parameters, and the JSON response for each of the User Notification API actions.</p>
10
-
<p>User Notification control APIs are currently available in US East (Virginia) - <code>us-east-1</code>.</p>
9
+
<p>The <i>Amazon Web Services User Notifications API Reference</i> provides descriptions, API request parameters, and the JSON response for each of the User Notification API actions.</p>
10
+
<p>User Notification control plane APIs are currently available in US East (Virginia) - <code>us-east-1</code>.</p>
and <ahref="https://docs.aws.amazon.com/notifications/latest/APIReference/API_ListNotificationEvents.html">ListNotificationEvents</a> APIs are currently available in
14
14
<ahref="https://docs.aws.amazon.com/notifications/latest/userguide/supported-regions.html">commercial partition Regions</a> and only return notifications stored in the same Region in which they're called.</p>
15
15
<p>The User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a
16
-
<ahref="https://docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html>">notification hub</a> in addition to US East (Virginia).</p>
16
+
<ahref="https://docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html">notification hub</a> in addition to US East (Virginia).</p>
17
17
18
18
## Installing
19
19
@@ -217,6 +217,22 @@ AssociateChannel
217
217
218
218
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/AssociateChannelCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/AssociateChannelCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/AssociateChannelCommandOutput/)
219
219
220
+
</details>
221
+
<details>
222
+
<summary>
223
+
AssociateManagedNotificationAccountContact
224
+
</summary>
225
+
226
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/AssociateManagedNotificationAccountContactCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/AssociateManagedNotificationAccountContactCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/AssociateManagedNotificationAccountContactCommandOutput/)
227
+
228
+
</details>
229
+
<details>
230
+
<summary>
231
+
AssociateManagedNotificationAdditionalChannel
232
+
</summary>
233
+
234
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/AssociateManagedNotificationAdditionalChannelCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/AssociateManagedNotificationAdditionalChannelCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/AssociateManagedNotificationAdditionalChannelCommandOutput/)
235
+
220
236
</details>
221
237
<details>
222
238
<summary>
@@ -257,6 +273,14 @@ DeregisterNotificationHub
257
273
258
274
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/DeregisterNotificationHubCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/DeregisterNotificationHubCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/DeregisterNotificationHubCommandOutput/)
259
275
276
+
</details>
277
+
<details>
278
+
<summary>
279
+
DisableNotificationsAccessForOrganization
280
+
</summary>
281
+
282
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/DisableNotificationsAccessForOrganizationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/DisableNotificationsAccessForOrganizationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/DisableNotificationsAccessForOrganizationCommandOutput/)
283
+
260
284
</details>
261
285
<details>
262
286
<summary>
@@ -265,6 +289,30 @@ DisassociateChannel
265
289
266
290
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/DisassociateChannelCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/DisassociateChannelCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/DisassociateChannelCommandOutput/)
267
291
292
+
</details>
293
+
<details>
294
+
<summary>
295
+
DisassociateManagedNotificationAccountContact
296
+
</summary>
297
+
298
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/DisassociateManagedNotificationAccountContactCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/DisassociateManagedNotificationAccountContactCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/DisassociateManagedNotificationAccountContactCommandOutput/)
299
+
300
+
</details>
301
+
<details>
302
+
<summary>
303
+
DisassociateManagedNotificationAdditionalChannel
304
+
</summary>
305
+
306
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/DisassociateManagedNotificationAdditionalChannelCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/DisassociateManagedNotificationAdditionalChannelCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/DisassociateManagedNotificationAdditionalChannelCommandOutput/)
307
+
308
+
</details>
309
+
<details>
310
+
<summary>
311
+
EnableNotificationsAccessForOrganization
312
+
</summary>
313
+
314
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/EnableNotificationsAccessForOrganizationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/EnableNotificationsAccessForOrganizationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/EnableNotificationsAccessForOrganizationCommandOutput/)
315
+
268
316
</details>
269
317
<details>
270
318
<summary>
@@ -273,6 +321,30 @@ GetEventRule
273
321
274
322
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/GetEventRuleCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/GetEventRuleCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/GetEventRuleCommandOutput/)
275
323
324
+
</details>
325
+
<details>
326
+
<summary>
327
+
GetManagedNotificationChildEvent
328
+
</summary>
329
+
330
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/GetManagedNotificationChildEventCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/GetManagedNotificationChildEventCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/GetManagedNotificationChildEventCommandOutput/)
331
+
332
+
</details>
333
+
<details>
334
+
<summary>
335
+
GetManagedNotificationConfiguration
336
+
</summary>
337
+
338
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/GetManagedNotificationConfigurationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/GetManagedNotificationConfigurationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/GetManagedNotificationConfigurationCommandOutput/)
339
+
340
+
</details>
341
+
<details>
342
+
<summary>
343
+
GetManagedNotificationEvent
344
+
</summary>
345
+
346
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/GetManagedNotificationEventCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/GetManagedNotificationEventCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/GetManagedNotificationEventCommandOutput/)
347
+
276
348
</details>
277
349
<details>
278
350
<summary>
@@ -289,6 +361,14 @@ GetNotificationEvent
289
361
290
362
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/GetNotificationEventCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/GetNotificationEventCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/GetNotificationEventCommandOutput/)
291
363
364
+
</details>
365
+
<details>
366
+
<summary>
367
+
GetNotificationsAccessForOrganization
368
+
</summary>
369
+
370
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/GetNotificationsAccessForOrganizationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/GetNotificationsAccessForOrganizationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/GetNotificationsAccessForOrganizationCommandOutput/)
371
+
292
372
</details>
293
373
<details>
294
374
<summary>
@@ -305,6 +385,38 @@ ListEventRules
305
385
306
386
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/ListEventRulesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/ListEventRulesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/ListEventRulesCommandOutput/)
307
387
388
+
</details>
389
+
<details>
390
+
<summary>
391
+
ListManagedNotificationChannelAssociations
392
+
</summary>
393
+
394
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/ListManagedNotificationChannelAssociationsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/ListManagedNotificationChannelAssociationsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/ListManagedNotificationChannelAssociationsCommandOutput/)
395
+
396
+
</details>
397
+
<details>
398
+
<summary>
399
+
ListManagedNotificationChildEvents
400
+
</summary>
401
+
402
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/ListManagedNotificationChildEventsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/ListManagedNotificationChildEventsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/ListManagedNotificationChildEventsCommandOutput/)
403
+
404
+
</details>
405
+
<details>
406
+
<summary>
407
+
ListManagedNotificationConfigurations
408
+
</summary>
409
+
410
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/ListManagedNotificationConfigurationsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/ListManagedNotificationConfigurationsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/ListManagedNotificationConfigurationsCommandOutput/)
411
+
412
+
</details>
413
+
<details>
414
+
<summary>
415
+
ListManagedNotificationEvents
416
+
</summary>
417
+
418
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/notifications/command/ListManagedNotificationEventsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/ListManagedNotificationEventsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-notifications/Interface/ListManagedNotificationEventsCommandOutput/)
0 commit comments