@aws-sdk/client-notifications 3.730.0 → 3.731.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (118) hide show
  1. package/README.md +115 -3
  2. package/dist-cjs/Notifications.js +28 -0
  3. package/dist-cjs/commands/AssociateManagedNotificationAccountContactCommand.js +26 -0
  4. package/dist-cjs/commands/AssociateManagedNotificationAdditionalChannelCommand.js +26 -0
  5. package/dist-cjs/commands/DisableNotificationsAccessForOrganizationCommand.js +26 -0
  6. package/dist-cjs/commands/DisassociateManagedNotificationAccountContactCommand.js +26 -0
  7. package/dist-cjs/commands/DisassociateManagedNotificationAdditionalChannelCommand.js +26 -0
  8. package/dist-cjs/commands/EnableNotificationsAccessForOrganizationCommand.js +26 -0
  9. package/dist-cjs/commands/GetManagedNotificationChildEventCommand.js +26 -0
  10. package/dist-cjs/commands/GetManagedNotificationConfigurationCommand.js +26 -0
  11. package/dist-cjs/commands/GetManagedNotificationEventCommand.js +26 -0
  12. package/dist-cjs/commands/GetNotificationsAccessForOrganizationCommand.js +26 -0
  13. package/dist-cjs/commands/ListManagedNotificationChannelAssociationsCommand.js +26 -0
  14. package/dist-cjs/commands/ListManagedNotificationChildEventsCommand.js +26 -0
  15. package/dist-cjs/commands/ListManagedNotificationConfigurationsCommand.js +26 -0
  16. package/dist-cjs/commands/ListManagedNotificationEventsCommand.js +26 -0
  17. package/dist-cjs/commands/index.js +14 -0
  18. package/dist-cjs/models/models_0.js +25 -4
  19. package/dist-cjs/pagination/ListManagedNotificationChannelAssociationsPaginator.js +7 -0
  20. package/dist-cjs/pagination/ListManagedNotificationChildEventsPaginator.js +7 -0
  21. package/dist-cjs/pagination/ListManagedNotificationConfigurationsPaginator.js +7 -0
  22. package/dist-cjs/pagination/ListManagedNotificationEventsPaginator.js +7 -0
  23. package/dist-cjs/pagination/index.js +4 -0
  24. package/dist-cjs/protocols/Aws_restJson1.js +475 -5
  25. package/dist-es/Notifications.js +28 -0
  26. package/dist-es/commands/AssociateManagedNotificationAccountContactCommand.js +22 -0
  27. package/dist-es/commands/AssociateManagedNotificationAdditionalChannelCommand.js +22 -0
  28. package/dist-es/commands/DisableNotificationsAccessForOrganizationCommand.js +22 -0
  29. package/dist-es/commands/DisassociateManagedNotificationAccountContactCommand.js +22 -0
  30. package/dist-es/commands/DisassociateManagedNotificationAdditionalChannelCommand.js +22 -0
  31. package/dist-es/commands/EnableNotificationsAccessForOrganizationCommand.js +22 -0
  32. package/dist-es/commands/GetManagedNotificationChildEventCommand.js +22 -0
  33. package/dist-es/commands/GetManagedNotificationConfigurationCommand.js +22 -0
  34. package/dist-es/commands/GetManagedNotificationEventCommand.js +22 -0
  35. package/dist-es/commands/GetNotificationsAccessForOrganizationCommand.js +22 -0
  36. package/dist-es/commands/ListManagedNotificationChannelAssociationsCommand.js +22 -0
  37. package/dist-es/commands/ListManagedNotificationChildEventsCommand.js +22 -0
  38. package/dist-es/commands/ListManagedNotificationConfigurationsCommand.js +22 -0
  39. package/dist-es/commands/ListManagedNotificationEventsCommand.js +22 -0
  40. package/dist-es/commands/index.js +14 -0
  41. package/dist-es/models/models_0.js +24 -3
  42. package/dist-es/pagination/ListManagedNotificationChannelAssociationsPaginator.js +4 -0
  43. package/dist-es/pagination/ListManagedNotificationChildEventsPaginator.js +4 -0
  44. package/dist-es/pagination/ListManagedNotificationConfigurationsPaginator.js +4 -0
  45. package/dist-es/pagination/ListManagedNotificationEventsPaginator.js +4 -0
  46. package/dist-es/pagination/index.js +4 -0
  47. package/dist-es/protocols/Aws_restJson1.js +445 -4
  48. package/dist-types/Notifications.d.ts +106 -3
  49. package/dist-types/NotificationsClient.d.ts +19 -5
  50. package/dist-types/commands/AssociateChannelCommand.d.ts +2 -2
  51. package/dist-types/commands/AssociateManagedNotificationAccountContactCommand.d.ts +91 -0
  52. package/dist-types/commands/AssociateManagedNotificationAdditionalChannelCommand.d.ts +92 -0
  53. package/dist-types/commands/CreateEventRuleCommand.d.ts +4 -1
  54. package/dist-types/commands/CreateNotificationConfigurationCommand.d.ts +1 -1
  55. package/dist-types/commands/DeleteEventRuleCommand.d.ts +1 -1
  56. package/dist-types/commands/DeleteNotificationConfigurationCommand.d.ts +1 -1
  57. package/dist-types/commands/DeregisterNotificationHubCommand.d.ts +5 -2
  58. package/dist-types/commands/DisableNotificationsAccessForOrganizationCommand.d.ts +88 -0
  59. package/dist-types/commands/DisassociateChannelCommand.d.ts +1 -1
  60. package/dist-types/commands/DisassociateManagedNotificationAccountContactCommand.d.ts +88 -0
  61. package/dist-types/commands/DisassociateManagedNotificationAdditionalChannelCommand.d.ts +86 -0
  62. package/dist-types/commands/EnableNotificationsAccessForOrganizationCommand.d.ts +88 -0
  63. package/dist-types/commands/GetEventRuleCommand.d.ts +1 -1
  64. package/dist-types/commands/GetManagedNotificationChildEventCommand.d.ts +130 -0
  65. package/dist-types/commands/GetManagedNotificationConfigurationCommand.d.ts +90 -0
  66. package/dist-types/commands/GetManagedNotificationEventCommand.d.ts +161 -0
  67. package/dist-types/commands/GetNotificationConfigurationCommand.d.ts +1 -1
  68. package/dist-types/commands/GetNotificationEventCommand.d.ts +42 -3
  69. package/dist-types/commands/GetNotificationsAccessForOrganizationCommand.d.ts +83 -0
  70. package/dist-types/commands/ListChannelsCommand.d.ts +1 -1
  71. package/dist-types/commands/ListEventRulesCommand.d.ts +1 -1
  72. package/dist-types/commands/ListManagedNotificationChannelAssociationsCommand.d.ts +95 -0
  73. package/dist-types/commands/ListManagedNotificationChildEventsCommand.d.ts +121 -0
  74. package/dist-types/commands/ListManagedNotificationConfigurationsCommand.d.ts +92 -0
  75. package/dist-types/commands/ListManagedNotificationEventsCommand.d.ts +155 -0
  76. package/dist-types/commands/ListNotificationConfigurationsCommand.d.ts +2 -1
  77. package/dist-types/commands/ListNotificationEventsCommand.d.ts +41 -2
  78. package/dist-types/commands/ListNotificationHubsCommand.d.ts +1 -1
  79. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
  80. package/dist-types/commands/RegisterNotificationHubCommand.d.ts +3 -2
  81. package/dist-types/commands/TagResourceCommand.d.ts +2 -2
  82. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  83. package/dist-types/commands/UpdateEventRuleCommand.d.ts +1 -1
  84. package/dist-types/commands/UpdateNotificationConfigurationCommand.d.ts +1 -1
  85. package/dist-types/commands/index.d.ts +14 -0
  86. package/dist-types/index.d.ts +3 -3
  87. package/dist-types/models/models_0.d.ts +1830 -578
  88. package/dist-types/pagination/ListManagedNotificationChannelAssociationsPaginator.d.ts +7 -0
  89. package/dist-types/pagination/ListManagedNotificationChildEventsPaginator.d.ts +7 -0
  90. package/dist-types/pagination/ListManagedNotificationConfigurationsPaginator.d.ts +7 -0
  91. package/dist-types/pagination/ListManagedNotificationEventsPaginator.d.ts +7 -0
  92. package/dist-types/pagination/index.d.ts +4 -0
  93. package/dist-types/protocols/Aws_restJson1.d.ts +126 -0
  94. package/dist-types/ts3.4/Notifications.d.ts +309 -0
  95. package/dist-types/ts3.4/NotificationsClient.d.ts +84 -0
  96. package/dist-types/ts3.4/commands/AssociateManagedNotificationAccountContactCommand.d.ts +51 -0
  97. package/dist-types/ts3.4/commands/AssociateManagedNotificationAdditionalChannelCommand.d.ts +51 -0
  98. package/dist-types/ts3.4/commands/DisableNotificationsAccessForOrganizationCommand.d.ts +51 -0
  99. package/dist-types/ts3.4/commands/DisassociateManagedNotificationAccountContactCommand.d.ts +51 -0
  100. package/dist-types/ts3.4/commands/DisassociateManagedNotificationAdditionalChannelCommand.d.ts +51 -0
  101. package/dist-types/ts3.4/commands/EnableNotificationsAccessForOrganizationCommand.d.ts +51 -0
  102. package/dist-types/ts3.4/commands/GetManagedNotificationChildEventCommand.d.ts +51 -0
  103. package/dist-types/ts3.4/commands/GetManagedNotificationConfigurationCommand.d.ts +51 -0
  104. package/dist-types/ts3.4/commands/GetManagedNotificationEventCommand.d.ts +51 -0
  105. package/dist-types/ts3.4/commands/GetNotificationsAccessForOrganizationCommand.d.ts +51 -0
  106. package/dist-types/ts3.4/commands/ListManagedNotificationChannelAssociationsCommand.d.ts +51 -0
  107. package/dist-types/ts3.4/commands/ListManagedNotificationChildEventsCommand.d.ts +51 -0
  108. package/dist-types/ts3.4/commands/ListManagedNotificationConfigurationsCommand.d.ts +51 -0
  109. package/dist-types/ts3.4/commands/ListManagedNotificationEventsCommand.d.ts +51 -0
  110. package/dist-types/ts3.4/commands/index.d.ts +14 -0
  111. package/dist-types/ts3.4/models/models_0.d.ts +288 -38
  112. package/dist-types/ts3.4/pagination/ListManagedNotificationChannelAssociationsPaginator.d.ts +11 -0
  113. package/dist-types/ts3.4/pagination/ListManagedNotificationChildEventsPaginator.d.ts +11 -0
  114. package/dist-types/ts3.4/pagination/ListManagedNotificationConfigurationsPaginator.d.ts +11 -0
  115. package/dist-types/ts3.4/pagination/ListManagedNotificationEventsPaginator.d.ts +11 -0
  116. package/dist-types/ts3.4/pagination/index.d.ts +4 -0
  117. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +168 -0
  118. package/package.json +12 -12
@@ -27,11 +27,11 @@ declare const ListNotificationEventsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first).</p>
30
+ * <p>Returns a list of <code>NotificationEvents</code> according to specified filters, in reverse chronological order (newest first).</p>
31
31
  * <important>
32
32
  * <p>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.
33
33
  * 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.
34
- * For more information, see <a href="https://docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html">Notification hubs</a> in the <i>AWS User Notifications User Guide</i>.</p>
34
+ * For more information, see <a href="https://docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html">Notification hubs</a> in the <i>Amazon Web Services User Notifications User Guide</i>.</p>
35
35
  * </important>
36
36
  * @example
37
37
  * Use a bare-bones client and the command you need to make an API call.
@@ -74,6 +74,45 @@ declare const ListNotificationEventsCommand_base: {
74
74
  * // },
75
75
  * // aggregationEventType: "STRING_VALUE",
76
76
  * // aggregateNotificationEventArn: "STRING_VALUE",
77
+ * // aggregationSummary: { // AggregationSummary
78
+ * // eventCount: Number("int"), // required
79
+ * // aggregatedBy: [ // AggregationKeys // required
80
+ * // { // AggregationKey
81
+ * // name: "STRING_VALUE", // required
82
+ * // value: "STRING_VALUE", // required
83
+ * // },
84
+ * // ],
85
+ * // aggregatedAccounts: { // SummarizationDimensionOverview
86
+ * // name: "STRING_VALUE", // required
87
+ * // count: Number("int"), // required
88
+ * // sampleValues: [ // SampleAggregationDimensionValues
89
+ * // "STRING_VALUE",
90
+ * // ],
91
+ * // },
92
+ * // aggregatedRegions: {
93
+ * // name: "STRING_VALUE", // required
94
+ * // count: Number("int"), // required
95
+ * // sampleValues: [
96
+ * // "STRING_VALUE",
97
+ * // ],
98
+ * // },
99
+ * // aggregatedOrganizationalUnits: {
100
+ * // name: "STRING_VALUE", // required
101
+ * // count: Number("int"), // required
102
+ * // sampleValues: [
103
+ * // "STRING_VALUE",
104
+ * // ],
105
+ * // },
106
+ * // additionalSummarizationDimensions: [ // SummarizationDimensionOverviews
107
+ * // {
108
+ * // name: "STRING_VALUE", // required
109
+ * // count: Number("int"), // required
110
+ * // sampleValues: [
111
+ * // "STRING_VALUE",
112
+ * // ],
113
+ * // },
114
+ * // ],
115
+ * // },
77
116
  * // },
78
117
  * // ],
79
118
  * // };
@@ -27,7 +27,7 @@ declare const ListNotificationHubsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of NotificationHubs.</p>
30
+ * <p>Returns a list of <code>NotificationHubs</code>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -28,9 +28,9 @@ declare const ListTagsForResourceCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Returns a list of tags for a specified Amazon Resource Name (ARN).</p>
31
- * <p>For more information, see <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html">Tagging your AWS resources</a> in the <i>Tagging AWS Resources User Guide</i>.</p>
31
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html">Tagging your Amazon Web Services resources</a> in the <i>Tagging Amazon Web Services Resources User Guide</i>.</p>
32
32
  * <note>
33
- * <p>This is only supported for NotificationConfigurations.</p>
33
+ * <p>This is only supported for <code>NotificationConfigurations</code>.</p>
34
34
  * </note>
35
35
  * @example
36
36
  * Use a bare-bones client and the command you need to make an API call.
@@ -27,8 +27,9 @@ declare const RegisterNotificationHubCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Registers a NotificationHub in the specified Region.</p>
31
- * <p>There is a maximum of one NotificationHub per Region. You can have a maximum of 3 NotificationHubs at a time.</p>
30
+ * <p>Registers a <code>NotificationConfiguration</code> in the specified Region.</p>
31
+ * <p>There is a maximum of one <code>NotificationConfiguration</code> per Region. You can have a
32
+ * maximum of 3 <code>NotificationHub</code> resources at a time.</p>
32
33
  * @example
33
34
  * Use a bare-bones client and the command you need to make an API call.
34
35
  * ```javascript
@@ -28,9 +28,9 @@ declare const TagResourceCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Tags the resource with a tag key and value.</p>
31
- * <p>For more information, see <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html">Tagging your AWS resources</a> in the <i>Tagging AWS Resources User Guide</i>.</p>
31
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html">Tagging your Amazon Web Services resources</a> in the <i>Tagging Amazon Web Services Resources User Guide</i>.</p>
32
32
  * <note>
33
- * <p>This is only supported for NotificationConfigurations.</p>
33
+ * <p>This is only supported for <code>NotificationConfigurations</code>.</p>
34
34
  * </note>
35
35
  * @example
36
36
  * Use a bare-bones client and the command you need to make an API call.
@@ -28,7 +28,7 @@ declare const UntagResourceCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Untags a resource with a specified Amazon Resource Name (ARN).</p>
31
- * <p>For more information, see <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html">Tagging your AWS resources</a> in the <i>Tagging AWS Resources User Guide</i>.</p>
31
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html">Tagging your Amazon Web Services resources</a> in the <i>Tagging Amazon Web Services Resources User Guide</i>.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -27,7 +27,7 @@ declare const UpdateEventRuleCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates an existing EventRule.</p>
30
+ * <p>Updates an existing <code>EventRule</code>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,7 +27,7 @@ declare const UpdateNotificationConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates a NotificationConfiguration.</p>
30
+ * <p>Updates a <code>NotificationConfiguration</code>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -1,15 +1,29 @@
1
1
  export * from "./AssociateChannelCommand";
2
+ export * from "./AssociateManagedNotificationAccountContactCommand";
3
+ export * from "./AssociateManagedNotificationAdditionalChannelCommand";
2
4
  export * from "./CreateEventRuleCommand";
3
5
  export * from "./CreateNotificationConfigurationCommand";
4
6
  export * from "./DeleteEventRuleCommand";
5
7
  export * from "./DeleteNotificationConfigurationCommand";
6
8
  export * from "./DeregisterNotificationHubCommand";
9
+ export * from "./DisableNotificationsAccessForOrganizationCommand";
7
10
  export * from "./DisassociateChannelCommand";
11
+ export * from "./DisassociateManagedNotificationAccountContactCommand";
12
+ export * from "./DisassociateManagedNotificationAdditionalChannelCommand";
13
+ export * from "./EnableNotificationsAccessForOrganizationCommand";
8
14
  export * from "./GetEventRuleCommand";
15
+ export * from "./GetManagedNotificationChildEventCommand";
16
+ export * from "./GetManagedNotificationConfigurationCommand";
17
+ export * from "./GetManagedNotificationEventCommand";
9
18
  export * from "./GetNotificationConfigurationCommand";
10
19
  export * from "./GetNotificationEventCommand";
20
+ export * from "./GetNotificationsAccessForOrganizationCommand";
11
21
  export * from "./ListChannelsCommand";
12
22
  export * from "./ListEventRulesCommand";
23
+ export * from "./ListManagedNotificationChannelAssociationsCommand";
24
+ export * from "./ListManagedNotificationChildEventsCommand";
25
+ export * from "./ListManagedNotificationConfigurationsCommand";
26
+ export * from "./ListManagedNotificationEventsCommand";
13
27
  export * from "./ListNotificationConfigurationsCommand";
14
28
  export * from "./ListNotificationEventsCommand";
15
29
  export * from "./ListNotificationHubsCommand";
@@ -1,12 +1,12 @@
1
1
  /**
2
- * <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>
3
- * <p>User Notification control APIs are currently available in US East (Virginia) - <code>us-east-1</code>.</p>
2
+ * <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>
3
+ * <p>User Notification control plane APIs are currently available in US East (Virginia) - <code>us-east-1</code>.</p>
4
4
  * <p>
5
5
  * <a href="https://docs.aws.amazon.com/notifications/latest/APIReference/API_GetNotificationEvent.html">GetNotificationEvent</a>
6
6
  * and <a href="https://docs.aws.amazon.com/notifications/latest/APIReference/API_ListNotificationEvents.html">ListNotificationEvents</a> APIs are currently available in
7
7
  * <a href="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>
8
8
  * <p>The User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a
9
- * <a href="https://docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html&gt;">notification hub</a> in addition to US East (Virginia).</p>
9
+ * <a href="https://docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html">notification hub</a> in addition to US East (Virginia).</p>
10
10
  *
11
11
  * @packageDocumentation
12
12
  */