@aws-sdk/client-notifications 3.698.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 (191) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +380 -0
  3. package/dist-cjs/Notifications.js +53 -0
  4. package/dist-cjs/NotificationsClient.js +50 -0
  5. package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
  6. package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
  7. package/dist-cjs/commands/AssociateChannelCommand.js +26 -0
  8. package/dist-cjs/commands/CreateEventRuleCommand.js +26 -0
  9. package/dist-cjs/commands/CreateNotificationConfigurationCommand.js +26 -0
  10. package/dist-cjs/commands/DeleteEventRuleCommand.js +26 -0
  11. package/dist-cjs/commands/DeleteNotificationConfigurationCommand.js +26 -0
  12. package/dist-cjs/commands/DeregisterNotificationHubCommand.js +26 -0
  13. package/dist-cjs/commands/DisassociateChannelCommand.js +26 -0
  14. package/dist-cjs/commands/GetEventRuleCommand.js +26 -0
  15. package/dist-cjs/commands/GetNotificationConfigurationCommand.js +26 -0
  16. package/dist-cjs/commands/GetNotificationEventCommand.js +26 -0
  17. package/dist-cjs/commands/ListChannelsCommand.js +26 -0
  18. package/dist-cjs/commands/ListEventRulesCommand.js +26 -0
  19. package/dist-cjs/commands/ListNotificationConfigurationsCommand.js +26 -0
  20. package/dist-cjs/commands/ListNotificationEventsCommand.js +26 -0
  21. package/dist-cjs/commands/ListNotificationHubsCommand.js +26 -0
  22. package/dist-cjs/commands/ListTagsForResourceCommand.js +26 -0
  23. package/dist-cjs/commands/RegisterNotificationHubCommand.js +26 -0
  24. package/dist-cjs/commands/TagResourceCommand.js +26 -0
  25. package/dist-cjs/commands/UntagResourceCommand.js +26 -0
  26. package/dist-cjs/commands/UpdateEventRuleCommand.js +26 -0
  27. package/dist-cjs/commands/UpdateNotificationConfigurationCommand.js +26 -0
  28. package/dist-cjs/commands/index.js +24 -0
  29. package/dist-cjs/endpoint/EndpointParameters.js +16 -0
  30. package/dist-cjs/endpoint/endpointResolver.js +18 -0
  31. package/dist-cjs/endpoint/ruleset.js +7 -0
  32. package/dist-cjs/extensionConfiguration.js +2 -0
  33. package/dist-cjs/index.js +11 -0
  34. package/dist-cjs/models/NotificationsServiceException.js +12 -0
  35. package/dist-cjs/models/index.js +4 -0
  36. package/dist-cjs/models/models_0.js +181 -0
  37. package/dist-cjs/pagination/Interfaces.js +2 -0
  38. package/dist-cjs/pagination/ListChannelsPaginator.js +7 -0
  39. package/dist-cjs/pagination/ListEventRulesPaginator.js +7 -0
  40. package/dist-cjs/pagination/ListNotificationConfigurationsPaginator.js +7 -0
  41. package/dist-cjs/pagination/ListNotificationEventsPaginator.js +7 -0
  42. package/dist-cjs/pagination/ListNotificationHubsPaginator.js +7 -0
  43. package/dist-cjs/pagination/index.js +9 -0
  44. package/dist-cjs/protocols/Aws_restJson1.js +885 -0
  45. package/dist-cjs/runtimeConfig.browser.js +39 -0
  46. package/dist-cjs/runtimeConfig.js +50 -0
  47. package/dist-cjs/runtimeConfig.native.js +15 -0
  48. package/dist-cjs/runtimeConfig.shared.js +34 -0
  49. package/dist-cjs/runtimeExtensions.js +25 -0
  50. package/dist-es/Notifications.js +49 -0
  51. package/dist-es/NotificationsClient.js +46 -0
  52. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  53. package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
  54. package/dist-es/commands/AssociateChannelCommand.js +22 -0
  55. package/dist-es/commands/CreateEventRuleCommand.js +22 -0
  56. package/dist-es/commands/CreateNotificationConfigurationCommand.js +22 -0
  57. package/dist-es/commands/DeleteEventRuleCommand.js +22 -0
  58. package/dist-es/commands/DeleteNotificationConfigurationCommand.js +22 -0
  59. package/dist-es/commands/DeregisterNotificationHubCommand.js +22 -0
  60. package/dist-es/commands/DisassociateChannelCommand.js +22 -0
  61. package/dist-es/commands/GetEventRuleCommand.js +22 -0
  62. package/dist-es/commands/GetNotificationConfigurationCommand.js +22 -0
  63. package/dist-es/commands/GetNotificationEventCommand.js +22 -0
  64. package/dist-es/commands/ListChannelsCommand.js +22 -0
  65. package/dist-es/commands/ListEventRulesCommand.js +22 -0
  66. package/dist-es/commands/ListNotificationConfigurationsCommand.js +22 -0
  67. package/dist-es/commands/ListNotificationEventsCommand.js +22 -0
  68. package/dist-es/commands/ListNotificationHubsCommand.js +22 -0
  69. package/dist-es/commands/ListTagsForResourceCommand.js +22 -0
  70. package/dist-es/commands/RegisterNotificationHubCommand.js +22 -0
  71. package/dist-es/commands/TagResourceCommand.js +22 -0
  72. package/dist-es/commands/UntagResourceCommand.js +22 -0
  73. package/dist-es/commands/UpdateEventRuleCommand.js +22 -0
  74. package/dist-es/commands/UpdateNotificationConfigurationCommand.js +22 -0
  75. package/dist-es/commands/index.js +21 -0
  76. package/dist-es/endpoint/EndpointParameters.js +12 -0
  77. package/dist-es/endpoint/endpointResolver.js +14 -0
  78. package/dist-es/endpoint/ruleset.js +4 -0
  79. package/dist-es/extensionConfiguration.js +1 -0
  80. package/dist-es/index.js +6 -0
  81. package/dist-es/models/NotificationsServiceException.js +8 -0
  82. package/dist-es/models/index.js +1 -0
  83. package/dist-es/models/models_0.js +171 -0
  84. package/dist-es/pagination/Interfaces.js +1 -0
  85. package/dist-es/pagination/ListChannelsPaginator.js +4 -0
  86. package/dist-es/pagination/ListEventRulesPaginator.js +4 -0
  87. package/dist-es/pagination/ListNotificationConfigurationsPaginator.js +4 -0
  88. package/dist-es/pagination/ListNotificationEventsPaginator.js +4 -0
  89. package/dist-es/pagination/ListNotificationHubsPaginator.js +4 -0
  90. package/dist-es/pagination/index.js +6 -0
  91. package/dist-es/protocols/Aws_restJson1.js +840 -0
  92. package/dist-es/runtimeConfig.browser.js +34 -0
  93. package/dist-es/runtimeConfig.js +45 -0
  94. package/dist-es/runtimeConfig.native.js +11 -0
  95. package/dist-es/runtimeConfig.shared.js +30 -0
  96. package/dist-es/runtimeExtensions.js +21 -0
  97. package/dist-types/Notifications.d.ts +167 -0
  98. package/dist-types/NotificationsClient.d.ts +197 -0
  99. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  100. package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
  101. package/dist-types/commands/AssociateChannelCommand.d.ts +92 -0
  102. package/dist-types/commands/CreateEventRuleCommand.d.ts +105 -0
  103. package/dist-types/commands/CreateNotificationConfigurationCommand.d.ts +95 -0
  104. package/dist-types/commands/DeleteEventRuleCommand.d.ts +87 -0
  105. package/dist-types/commands/DeleteNotificationConfigurationCommand.d.ts +87 -0
  106. package/dist-types/commands/DeregisterNotificationHubCommand.d.ts +96 -0
  107. package/dist-types/commands/DisassociateChannelCommand.d.ts +85 -0
  108. package/dist-types/commands/GetEventRuleCommand.d.ts +103 -0
  109. package/dist-types/commands/GetNotificationConfigurationCommand.d.ts +91 -0
  110. package/dist-types/commands/GetNotificationEventCommand.d.ts +154 -0
  111. package/dist-types/commands/ListChannelsCommand.d.ts +91 -0
  112. package/dist-types/commands/ListEventRulesCommand.d.ts +110 -0
  113. package/dist-types/commands/ListNotificationConfigurationsCommand.d.ts +97 -0
  114. package/dist-types/commands/ListNotificationEventsCommand.d.ts +118 -0
  115. package/dist-types/commands/ListNotificationHubsCommand.d.ts +95 -0
  116. package/dist-types/commands/ListTagsForResourceCommand.d.ts +92 -0
  117. package/dist-types/commands/RegisterNotificationHubCommand.d.ts +96 -0
  118. package/dist-types/commands/TagResourceCommand.d.ts +91 -0
  119. package/dist-types/commands/UntagResourceCommand.d.ts +88 -0
  120. package/dist-types/commands/UpdateEventRuleCommand.d.ts +100 -0
  121. package/dist-types/commands/UpdateNotificationConfigurationCommand.d.ts +92 -0
  122. package/dist-types/commands/index.d.ts +21 -0
  123. package/dist-types/endpoint/EndpointParameters.d.ts +34 -0
  124. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  125. package/dist-types/endpoint/ruleset.d.ts +2 -0
  126. package/dist-types/extensionConfiguration.d.ts +9 -0
  127. package/dist-types/index.d.ts +21 -0
  128. package/dist-types/models/NotificationsServiceException.d.ts +14 -0
  129. package/dist-types/models/index.d.ts +1 -0
  130. package/dist-types/models/models_0.d.ts +2354 -0
  131. package/dist-types/pagination/Interfaces.d.ts +8 -0
  132. package/dist-types/pagination/ListChannelsPaginator.d.ts +7 -0
  133. package/dist-types/pagination/ListEventRulesPaginator.d.ts +7 -0
  134. package/dist-types/pagination/ListNotificationConfigurationsPaginator.d.ts +7 -0
  135. package/dist-types/pagination/ListNotificationEventsPaginator.d.ts +7 -0
  136. package/dist-types/pagination/ListNotificationHubsPaginator.d.ts +7 -0
  137. package/dist-types/pagination/index.d.ts +6 -0
  138. package/dist-types/protocols/Aws_restJson1.d.ts +191 -0
  139. package/dist-types/runtimeConfig.browser.d.ts +48 -0
  140. package/dist-types/runtimeConfig.d.ts +48 -0
  141. package/dist-types/runtimeConfig.native.d.ts +47 -0
  142. package/dist-types/runtimeConfig.shared.d.ts +21 -0
  143. package/dist-types/runtimeExtensions.d.ts +17 -0
  144. package/dist-types/ts3.4/Notifications.d.ts +367 -0
  145. package/dist-types/ts3.4/NotificationsClient.d.ts +245 -0
  146. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  147. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
  148. package/dist-types/ts3.4/commands/AssociateChannelCommand.d.ts +50 -0
  149. package/dist-types/ts3.4/commands/CreateEventRuleCommand.d.ts +50 -0
  150. package/dist-types/ts3.4/commands/CreateNotificationConfigurationCommand.d.ts +51 -0
  151. package/dist-types/ts3.4/commands/DeleteEventRuleCommand.d.ts +50 -0
  152. package/dist-types/ts3.4/commands/DeleteNotificationConfigurationCommand.d.ts +51 -0
  153. package/dist-types/ts3.4/commands/DeregisterNotificationHubCommand.d.ts +51 -0
  154. package/dist-types/ts3.4/commands/DisassociateChannelCommand.d.ts +51 -0
  155. package/dist-types/ts3.4/commands/GetEventRuleCommand.d.ts +47 -0
  156. package/dist-types/ts3.4/commands/GetNotificationConfigurationCommand.d.ts +51 -0
  157. package/dist-types/ts3.4/commands/GetNotificationEventCommand.d.ts +51 -0
  158. package/dist-types/ts3.4/commands/ListChannelsCommand.d.ts +47 -0
  159. package/dist-types/ts3.4/commands/ListEventRulesCommand.d.ts +50 -0
  160. package/dist-types/ts3.4/commands/ListNotificationConfigurationsCommand.d.ts +51 -0
  161. package/dist-types/ts3.4/commands/ListNotificationEventsCommand.d.ts +51 -0
  162. package/dist-types/ts3.4/commands/ListNotificationHubsCommand.d.ts +51 -0
  163. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
  164. package/dist-types/ts3.4/commands/RegisterNotificationHubCommand.d.ts +51 -0
  165. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
  166. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +50 -0
  167. package/dist-types/ts3.4/commands/UpdateEventRuleCommand.d.ts +50 -0
  168. package/dist-types/ts3.4/commands/UpdateNotificationConfigurationCommand.d.ts +51 -0
  169. package/dist-types/ts3.4/commands/index.d.ts +21 -0
  170. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -0
  171. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  172. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  173. package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
  174. package/dist-types/ts3.4/index.d.ts +9 -0
  175. package/dist-types/ts3.4/models/NotificationsServiceException.d.ts +9 -0
  176. package/dist-types/ts3.4/models/index.d.ts +1 -0
  177. package/dist-types/ts3.4/models/models_0.d.ts +447 -0
  178. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  179. package/dist-types/ts3.4/pagination/ListChannelsPaginator.d.ts +11 -0
  180. package/dist-types/ts3.4/pagination/ListEventRulesPaginator.d.ts +11 -0
  181. package/dist-types/ts3.4/pagination/ListNotificationConfigurationsPaginator.d.ts +11 -0
  182. package/dist-types/ts3.4/pagination/ListNotificationEventsPaginator.d.ts +11 -0
  183. package/dist-types/ts3.4/pagination/ListNotificationHubsPaginator.d.ts +11 -0
  184. package/dist-types/ts3.4/pagination/index.d.ts +6 -0
  185. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +257 -0
  186. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +93 -0
  187. package/dist-types/ts3.4/runtimeConfig.d.ts +94 -0
  188. package/dist-types/ts3.4/runtimeConfig.native.d.ts +87 -0
  189. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +21 -0
  190. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  191. package/package.json +101 -0
@@ -0,0 +1,103 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { GetEventRuleRequest, GetEventRuleResponse } from "../models/models_0";
4
+ import { NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NotificationsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetEventRuleCommand}.
14
+ */
15
+ export interface GetEventRuleCommandInput extends GetEventRuleRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetEventRuleCommand}.
21
+ */
22
+ export interface GetEventRuleCommandOutput extends GetEventRuleResponse, __MetadataBearer {
23
+ }
24
+ declare const GetEventRuleCommand_base: {
25
+ new (input: GetEventRuleCommandInput): import("@smithy/smithy-client").CommandImpl<GetEventRuleCommandInput, GetEventRuleCommandOutput, NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetEventRuleCommandInput): import("@smithy/smithy-client").CommandImpl<GetEventRuleCommandInput, GetEventRuleCommandOutput, NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns a specified EventRule.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { NotificationsClient, GetEventRuleCommand } from "@aws-sdk/client-notifications"; // ES Modules import
35
+ * // const { NotificationsClient, GetEventRuleCommand } = require("@aws-sdk/client-notifications"); // CommonJS import
36
+ * const client = new NotificationsClient(config);
37
+ * const input = { // GetEventRuleRequest
38
+ * arn: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new GetEventRuleCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetEventRuleResponse
43
+ * // arn: "STRING_VALUE", // required
44
+ * // notificationConfigurationArn: "STRING_VALUE", // required
45
+ * // creationTime: new Date("TIMESTAMP"), // required
46
+ * // source: "STRING_VALUE", // required
47
+ * // eventType: "STRING_VALUE", // required
48
+ * // eventPattern: "STRING_VALUE", // required
49
+ * // regions: [ // Regions // required
50
+ * // "STRING_VALUE",
51
+ * // ],
52
+ * // managedRules: [ // ManagedRuleArns // required
53
+ * // "STRING_VALUE",
54
+ * // ],
55
+ * // statusSummaryByRegion: { // StatusSummaryByRegion // required
56
+ * // "<keys>": { // EventRuleStatusSummary
57
+ * // status: "STRING_VALUE", // required
58
+ * // reason: "STRING_VALUE", // required
59
+ * // },
60
+ * // },
61
+ * // };
62
+ *
63
+ * ```
64
+ *
65
+ * @param GetEventRuleCommandInput - {@link GetEventRuleCommandInput}
66
+ * @returns {@link GetEventRuleCommandOutput}
67
+ * @see {@link GetEventRuleCommandInput} for command's `input` shape.
68
+ * @see {@link GetEventRuleCommandOutput} for command's `response` shape.
69
+ * @see {@link NotificationsClientResolvedConfig | config} for NotificationsClient's `config` shape.
70
+ *
71
+ * @throws {@link AccessDeniedException} (client fault)
72
+ * <p>User does not have sufficient access to perform this action.</p>
73
+ *
74
+ * @throws {@link InternalServerException} (server fault)
75
+ * <p>Unexpected error during processing of request.</p>
76
+ *
77
+ * @throws {@link ResourceNotFoundException} (client fault)
78
+ * <p>Request references a resource which does not exist. </p>
79
+ *
80
+ * @throws {@link ThrottlingException} (client fault)
81
+ * <p>Request was denied due to request throttling. </p>
82
+ *
83
+ * @throws {@link ValidationException} (client fault)
84
+ * <p>This exception is thrown when the notification event fails validation.</p>
85
+ *
86
+ * @throws {@link NotificationsServiceException}
87
+ * <p>Base exception class for all service exceptions from Notifications service.</p>
88
+ *
89
+ * @public
90
+ */
91
+ export declare class GetEventRuleCommand extends GetEventRuleCommand_base {
92
+ /** @internal type navigation helper, not in runtime. */
93
+ protected static __types: {
94
+ api: {
95
+ input: GetEventRuleRequest;
96
+ output: GetEventRuleResponse;
97
+ };
98
+ sdk: {
99
+ input: GetEventRuleCommandInput;
100
+ output: GetEventRuleCommandOutput;
101
+ };
102
+ };
103
+ }
@@ -0,0 +1,91 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { GetNotificationConfigurationRequest, GetNotificationConfigurationResponse } from "../models/models_0";
4
+ import { NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NotificationsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetNotificationConfigurationCommand}.
14
+ */
15
+ export interface GetNotificationConfigurationCommandInput extends GetNotificationConfigurationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetNotificationConfigurationCommand}.
21
+ */
22
+ export interface GetNotificationConfigurationCommandOutput extends GetNotificationConfigurationResponse, __MetadataBearer {
23
+ }
24
+ declare const GetNotificationConfigurationCommand_base: {
25
+ new (input: GetNotificationConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetNotificationConfigurationCommandInput, GetNotificationConfigurationCommandOutput, NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetNotificationConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetNotificationConfigurationCommandInput, GetNotificationConfigurationCommandOutput, NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns a specified NotificationConfiguration.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { NotificationsClient, GetNotificationConfigurationCommand } from "@aws-sdk/client-notifications"; // ES Modules import
35
+ * // const { NotificationsClient, GetNotificationConfigurationCommand } = require("@aws-sdk/client-notifications"); // CommonJS import
36
+ * const client = new NotificationsClient(config);
37
+ * const input = { // GetNotificationConfigurationRequest
38
+ * arn: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new GetNotificationConfigurationCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetNotificationConfigurationResponse
43
+ * // arn: "STRING_VALUE", // required
44
+ * // name: "STRING_VALUE", // required
45
+ * // description: "STRING_VALUE", // required
46
+ * // status: "STRING_VALUE", // required
47
+ * // creationTime: new Date("TIMESTAMP"), // required
48
+ * // aggregationDuration: "STRING_VALUE",
49
+ * // };
50
+ *
51
+ * ```
52
+ *
53
+ * @param GetNotificationConfigurationCommandInput - {@link GetNotificationConfigurationCommandInput}
54
+ * @returns {@link GetNotificationConfigurationCommandOutput}
55
+ * @see {@link GetNotificationConfigurationCommandInput} for command's `input` shape.
56
+ * @see {@link GetNotificationConfigurationCommandOutput} for command's `response` shape.
57
+ * @see {@link NotificationsClientResolvedConfig | config} for NotificationsClient's `config` shape.
58
+ *
59
+ * @throws {@link AccessDeniedException} (client fault)
60
+ * <p>User does not have sufficient access to perform this action.</p>
61
+ *
62
+ * @throws {@link InternalServerException} (server fault)
63
+ * <p>Unexpected error during processing of request.</p>
64
+ *
65
+ * @throws {@link ResourceNotFoundException} (client fault)
66
+ * <p>Request references a resource which does not exist. </p>
67
+ *
68
+ * @throws {@link ThrottlingException} (client fault)
69
+ * <p>Request was denied due to request throttling. </p>
70
+ *
71
+ * @throws {@link ValidationException} (client fault)
72
+ * <p>This exception is thrown when the notification event fails validation.</p>
73
+ *
74
+ * @throws {@link NotificationsServiceException}
75
+ * <p>Base exception class for all service exceptions from Notifications service.</p>
76
+ *
77
+ * @public
78
+ */
79
+ export declare class GetNotificationConfigurationCommand extends GetNotificationConfigurationCommand_base {
80
+ /** @internal type navigation helper, not in runtime. */
81
+ protected static __types: {
82
+ api: {
83
+ input: GetNotificationConfigurationRequest;
84
+ output: GetNotificationConfigurationResponse;
85
+ };
86
+ sdk: {
87
+ input: GetNotificationConfigurationCommandInput;
88
+ output: GetNotificationConfigurationCommandOutput;
89
+ };
90
+ };
91
+ }
@@ -0,0 +1,154 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { GetNotificationEventRequest, GetNotificationEventResponse } from "../models/models_0";
4
+ import { NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NotificationsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetNotificationEventCommand}.
14
+ */
15
+ export interface GetNotificationEventCommandInput extends GetNotificationEventRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetNotificationEventCommand}.
21
+ */
22
+ export interface GetNotificationEventCommandOutput extends GetNotificationEventResponse, __MetadataBearer {
23
+ }
24
+ declare const GetNotificationEventCommand_base: {
25
+ new (input: GetNotificationEventCommandInput): import("@smithy/smithy-client").CommandImpl<GetNotificationEventCommandInput, GetNotificationEventCommandOutput, NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetNotificationEventCommandInput): import("@smithy/smithy-client").CommandImpl<GetNotificationEventCommandInput, GetNotificationEventCommandOutput, NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns a specified NotificationEvent.</p>
31
+ * <important>
32
+ * <p>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.
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>
35
+ * </important>
36
+ * @example
37
+ * Use a bare-bones client and the command you need to make an API call.
38
+ * ```javascript
39
+ * import { NotificationsClient, GetNotificationEventCommand } from "@aws-sdk/client-notifications"; // ES Modules import
40
+ * // const { NotificationsClient, GetNotificationEventCommand } = require("@aws-sdk/client-notifications"); // CommonJS import
41
+ * const client = new NotificationsClient(config);
42
+ * const input = { // GetNotificationEventRequest
43
+ * arn: "STRING_VALUE", // required
44
+ * locale: "STRING_VALUE",
45
+ * };
46
+ * const command = new GetNotificationEventCommand(input);
47
+ * const response = await client.send(command);
48
+ * // { // GetNotificationEventResponse
49
+ * // arn: "STRING_VALUE", // required
50
+ * // notificationConfigurationArn: "STRING_VALUE", // required
51
+ * // creationTime: new Date("TIMESTAMP"), // required
52
+ * // content: { // NotificationEventSchema
53
+ * // schemaVersion: "STRING_VALUE", // required
54
+ * // id: "STRING_VALUE", // required
55
+ * // sourceEventMetadata: { // SourceEventMetadata
56
+ * // eventTypeVersion: "STRING_VALUE", // required
57
+ * // sourceEventId: "STRING_VALUE", // required
58
+ * // eventOriginRegion: "STRING_VALUE",
59
+ * // relatedAccount: "STRING_VALUE", // required
60
+ * // source: "STRING_VALUE", // required
61
+ * // eventOccurrenceTime: new Date("TIMESTAMP"), // required
62
+ * // eventType: "STRING_VALUE", // required
63
+ * // relatedResources: [ // Resources // required
64
+ * // { // Resource
65
+ * // id: "STRING_VALUE",
66
+ * // arn: "STRING_VALUE",
67
+ * // detailUrl: "STRING_VALUE",
68
+ * // tags: [ // Tags
69
+ * // "STRING_VALUE",
70
+ * // ],
71
+ * // },
72
+ * // ],
73
+ * // },
74
+ * // messageComponents: { // MessageComponents
75
+ * // headline: "STRING_VALUE",
76
+ * // paragraphSummary: "STRING_VALUE",
77
+ * // completeDescription: "STRING_VALUE",
78
+ * // dimensions: [ // Dimensions
79
+ * // { // Dimension
80
+ * // name: "STRING_VALUE", // required
81
+ * // value: "STRING_VALUE", // required
82
+ * // },
83
+ * // ],
84
+ * // },
85
+ * // sourceEventDetailUrl: "STRING_VALUE",
86
+ * // sourceEventDetailUrlDisplayText: "STRING_VALUE",
87
+ * // notificationType: "STRING_VALUE", // required
88
+ * // eventStatus: "STRING_VALUE",
89
+ * // aggregationEventType: "STRING_VALUE",
90
+ * // aggregateNotificationEventArn: "STRING_VALUE",
91
+ * // startTime: new Date("TIMESTAMP"),
92
+ * // endTime: new Date("TIMESTAMP"),
93
+ * // textParts: { // TextParts // required
94
+ * // "<keys>": { // TextPartValue
95
+ * // type: "STRING_VALUE", // required
96
+ * // displayText: "STRING_VALUE",
97
+ * // textByLocale: { // TextByLocale
98
+ * // "<keys>": "STRING_VALUE",
99
+ * // },
100
+ * // url: "STRING_VALUE",
101
+ * // },
102
+ * // },
103
+ * // media: [ // Media // required
104
+ * // { // MediaElement
105
+ * // mediaId: "STRING_VALUE", // required
106
+ * // type: "STRING_VALUE", // required
107
+ * // url: "STRING_VALUE", // required
108
+ * // caption: "STRING_VALUE", // required
109
+ * // },
110
+ * // ],
111
+ * // },
112
+ * // };
113
+ *
114
+ * ```
115
+ *
116
+ * @param GetNotificationEventCommandInput - {@link GetNotificationEventCommandInput}
117
+ * @returns {@link GetNotificationEventCommandOutput}
118
+ * @see {@link GetNotificationEventCommandInput} for command's `input` shape.
119
+ * @see {@link GetNotificationEventCommandOutput} for command's `response` shape.
120
+ * @see {@link NotificationsClientResolvedConfig | config} for NotificationsClient's `config` shape.
121
+ *
122
+ * @throws {@link AccessDeniedException} (client fault)
123
+ * <p>User does not have sufficient access to perform this action.</p>
124
+ *
125
+ * @throws {@link InternalServerException} (server fault)
126
+ * <p>Unexpected error during processing of request.</p>
127
+ *
128
+ * @throws {@link ResourceNotFoundException} (client fault)
129
+ * <p>Request references a resource which does not exist. </p>
130
+ *
131
+ * @throws {@link ThrottlingException} (client fault)
132
+ * <p>Request was denied due to request throttling. </p>
133
+ *
134
+ * @throws {@link ValidationException} (client fault)
135
+ * <p>This exception is thrown when the notification event fails validation.</p>
136
+ *
137
+ * @throws {@link NotificationsServiceException}
138
+ * <p>Base exception class for all service exceptions from Notifications service.</p>
139
+ *
140
+ * @public
141
+ */
142
+ export declare class GetNotificationEventCommand extends GetNotificationEventCommand_base {
143
+ /** @internal type navigation helper, not in runtime. */
144
+ protected static __types: {
145
+ api: {
146
+ input: GetNotificationEventRequest;
147
+ output: GetNotificationEventResponse;
148
+ };
149
+ sdk: {
150
+ input: GetNotificationEventCommandInput;
151
+ output: GetNotificationEventCommandOutput;
152
+ };
153
+ };
154
+ }
@@ -0,0 +1,91 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ListChannelsRequest, ListChannelsResponse } from "../models/models_0";
4
+ import { NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NotificationsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListChannelsCommand}.
14
+ */
15
+ export interface ListChannelsCommandInput extends ListChannelsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListChannelsCommand}.
21
+ */
22
+ export interface ListChannelsCommandOutput extends ListChannelsResponse, __MetadataBearer {
23
+ }
24
+ declare const ListChannelsCommand_base: {
25
+ new (input: ListChannelsCommandInput): import("@smithy/smithy-client").CommandImpl<ListChannelsCommandInput, ListChannelsCommandOutput, NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ListChannelsCommandInput): import("@smithy/smithy-client").CommandImpl<ListChannelsCommandInput, ListChannelsCommandOutput, NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns a list of Channels for a NotificationConfiguration.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { NotificationsClient, ListChannelsCommand } from "@aws-sdk/client-notifications"; // ES Modules import
35
+ * // const { NotificationsClient, ListChannelsCommand } = require("@aws-sdk/client-notifications"); // CommonJS import
36
+ * const client = new NotificationsClient(config);
37
+ * const input = { // ListChannelsRequest
38
+ * notificationConfigurationArn: "STRING_VALUE", // required
39
+ * maxResults: Number("int"),
40
+ * nextToken: "STRING_VALUE",
41
+ * };
42
+ * const command = new ListChannelsCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // ListChannelsResponse
45
+ * // nextToken: "STRING_VALUE",
46
+ * // channels: [ // Channels // required
47
+ * // "STRING_VALUE",
48
+ * // ],
49
+ * // };
50
+ *
51
+ * ```
52
+ *
53
+ * @param ListChannelsCommandInput - {@link ListChannelsCommandInput}
54
+ * @returns {@link ListChannelsCommandOutput}
55
+ * @see {@link ListChannelsCommandInput} for command's `input` shape.
56
+ * @see {@link ListChannelsCommandOutput} for command's `response` shape.
57
+ * @see {@link NotificationsClientResolvedConfig | config} for NotificationsClient's `config` shape.
58
+ *
59
+ * @throws {@link AccessDeniedException} (client fault)
60
+ * <p>User does not have sufficient access to perform this action.</p>
61
+ *
62
+ * @throws {@link InternalServerException} (server fault)
63
+ * <p>Unexpected error during processing of request.</p>
64
+ *
65
+ * @throws {@link ResourceNotFoundException} (client fault)
66
+ * <p>Request references a resource which does not exist. </p>
67
+ *
68
+ * @throws {@link ThrottlingException} (client fault)
69
+ * <p>Request was denied due to request throttling. </p>
70
+ *
71
+ * @throws {@link ValidationException} (client fault)
72
+ * <p>This exception is thrown when the notification event fails validation.</p>
73
+ *
74
+ * @throws {@link NotificationsServiceException}
75
+ * <p>Base exception class for all service exceptions from Notifications service.</p>
76
+ *
77
+ * @public
78
+ */
79
+ export declare class ListChannelsCommand extends ListChannelsCommand_base {
80
+ /** @internal type navigation helper, not in runtime. */
81
+ protected static __types: {
82
+ api: {
83
+ input: ListChannelsRequest;
84
+ output: ListChannelsResponse;
85
+ };
86
+ sdk: {
87
+ input: ListChannelsCommandInput;
88
+ output: ListChannelsCommandOutput;
89
+ };
90
+ };
91
+ }
@@ -0,0 +1,110 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ListEventRulesRequest, ListEventRulesResponse } from "../models/models_0";
4
+ import { NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NotificationsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListEventRulesCommand}.
14
+ */
15
+ export interface ListEventRulesCommandInput extends ListEventRulesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListEventRulesCommand}.
21
+ */
22
+ export interface ListEventRulesCommandOutput extends ListEventRulesResponse, __MetadataBearer {
23
+ }
24
+ declare const ListEventRulesCommand_base: {
25
+ new (input: ListEventRulesCommandInput): import("@smithy/smithy-client").CommandImpl<ListEventRulesCommandInput, ListEventRulesCommandOutput, NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ListEventRulesCommandInput): import("@smithy/smithy-client").CommandImpl<ListEventRulesCommandInput, ListEventRulesCommandOutput, NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns a list of EventRules according to specified filters, in reverse chronological order (newest first).</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { NotificationsClient, ListEventRulesCommand } from "@aws-sdk/client-notifications"; // ES Modules import
35
+ * // const { NotificationsClient, ListEventRulesCommand } = require("@aws-sdk/client-notifications"); // CommonJS import
36
+ * const client = new NotificationsClient(config);
37
+ * const input = { // ListEventRulesRequest
38
+ * notificationConfigurationArn: "STRING_VALUE", // required
39
+ * maxResults: Number("int"),
40
+ * nextToken: "STRING_VALUE",
41
+ * };
42
+ * const command = new ListEventRulesCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // ListEventRulesResponse
45
+ * // nextToken: "STRING_VALUE",
46
+ * // eventRules: [ // EventRules // required
47
+ * // { // EventRuleStructure
48
+ * // arn: "STRING_VALUE", // required
49
+ * // notificationConfigurationArn: "STRING_VALUE", // required
50
+ * // creationTime: new Date("TIMESTAMP"), // required
51
+ * // source: "STRING_VALUE", // required
52
+ * // eventType: "STRING_VALUE", // required
53
+ * // eventPattern: "STRING_VALUE", // required
54
+ * // regions: [ // Regions // required
55
+ * // "STRING_VALUE",
56
+ * // ],
57
+ * // managedRules: [ // ManagedRuleArns // required
58
+ * // "STRING_VALUE",
59
+ * // ],
60
+ * // statusSummaryByRegion: { // StatusSummaryByRegion // required
61
+ * // "<keys>": { // EventRuleStatusSummary
62
+ * // status: "STRING_VALUE", // required
63
+ * // reason: "STRING_VALUE", // required
64
+ * // },
65
+ * // },
66
+ * // },
67
+ * // ],
68
+ * // };
69
+ *
70
+ * ```
71
+ *
72
+ * @param ListEventRulesCommandInput - {@link ListEventRulesCommandInput}
73
+ * @returns {@link ListEventRulesCommandOutput}
74
+ * @see {@link ListEventRulesCommandInput} for command's `input` shape.
75
+ * @see {@link ListEventRulesCommandOutput} for command's `response` shape.
76
+ * @see {@link NotificationsClientResolvedConfig | config} for NotificationsClient's `config` shape.
77
+ *
78
+ * @throws {@link AccessDeniedException} (client fault)
79
+ * <p>User does not have sufficient access to perform this action.</p>
80
+ *
81
+ * @throws {@link InternalServerException} (server fault)
82
+ * <p>Unexpected error during processing of request.</p>
83
+ *
84
+ * @throws {@link ResourceNotFoundException} (client fault)
85
+ * <p>Request references a resource which does not exist. </p>
86
+ *
87
+ * @throws {@link ThrottlingException} (client fault)
88
+ * <p>Request was denied due to request throttling. </p>
89
+ *
90
+ * @throws {@link ValidationException} (client fault)
91
+ * <p>This exception is thrown when the notification event fails validation.</p>
92
+ *
93
+ * @throws {@link NotificationsServiceException}
94
+ * <p>Base exception class for all service exceptions from Notifications service.</p>
95
+ *
96
+ * @public
97
+ */
98
+ export declare class ListEventRulesCommand extends ListEventRulesCommand_base {
99
+ /** @internal type navigation helper, not in runtime. */
100
+ protected static __types: {
101
+ api: {
102
+ input: ListEventRulesRequest;
103
+ output: ListEventRulesResponse;
104
+ };
105
+ sdk: {
106
+ input: ListEventRulesCommandInput;
107
+ output: ListEventRulesCommandOutput;
108
+ };
109
+ };
110
+ }
@@ -0,0 +1,97 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ListNotificationConfigurationsRequest, ListNotificationConfigurationsResponse } from "../models/models_0";
4
+ import { NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NotificationsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListNotificationConfigurationsCommand}.
14
+ */
15
+ export interface ListNotificationConfigurationsCommandInput extends ListNotificationConfigurationsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListNotificationConfigurationsCommand}.
21
+ */
22
+ export interface ListNotificationConfigurationsCommandOutput extends ListNotificationConfigurationsResponse, __MetadataBearer {
23
+ }
24
+ declare const ListNotificationConfigurationsCommand_base: {
25
+ new (input: ListNotificationConfigurationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListNotificationConfigurationsCommandInput, ListNotificationConfigurationsCommandOutput, NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [ListNotificationConfigurationsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListNotificationConfigurationsCommandInput, ListNotificationConfigurationsCommandOutput, NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { NotificationsClient, ListNotificationConfigurationsCommand } from "@aws-sdk/client-notifications"; // ES Modules import
35
+ * // const { NotificationsClient, ListNotificationConfigurationsCommand } = require("@aws-sdk/client-notifications"); // CommonJS import
36
+ * const client = new NotificationsClient(config);
37
+ * const input = { // ListNotificationConfigurationsRequest
38
+ * eventRuleSource: "STRING_VALUE",
39
+ * channelArn: "STRING_VALUE",
40
+ * status: "STRING_VALUE",
41
+ * maxResults: Number("int"),
42
+ * nextToken: "STRING_VALUE",
43
+ * };
44
+ * const command = new ListNotificationConfigurationsCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // ListNotificationConfigurationsResponse
47
+ * // nextToken: "STRING_VALUE",
48
+ * // notificationConfigurations: [ // NotificationConfigurations // required
49
+ * // { // NotificationConfigurationStructure
50
+ * // arn: "STRING_VALUE", // required
51
+ * // name: "STRING_VALUE", // required
52
+ * // description: "STRING_VALUE", // required
53
+ * // status: "STRING_VALUE", // required
54
+ * // creationTime: new Date("TIMESTAMP"), // required
55
+ * // aggregationDuration: "STRING_VALUE",
56
+ * // },
57
+ * // ],
58
+ * // };
59
+ *
60
+ * ```
61
+ *
62
+ * @param ListNotificationConfigurationsCommandInput - {@link ListNotificationConfigurationsCommandInput}
63
+ * @returns {@link ListNotificationConfigurationsCommandOutput}
64
+ * @see {@link ListNotificationConfigurationsCommandInput} for command's `input` shape.
65
+ * @see {@link ListNotificationConfigurationsCommandOutput} for command's `response` shape.
66
+ * @see {@link NotificationsClientResolvedConfig | config} for NotificationsClient's `config` shape.
67
+ *
68
+ * @throws {@link AccessDeniedException} (client fault)
69
+ * <p>User does not have sufficient access to perform this action.</p>
70
+ *
71
+ * @throws {@link InternalServerException} (server fault)
72
+ * <p>Unexpected error during processing of request.</p>
73
+ *
74
+ * @throws {@link ThrottlingException} (client fault)
75
+ * <p>Request was denied due to request throttling. </p>
76
+ *
77
+ * @throws {@link ValidationException} (client fault)
78
+ * <p>This exception is thrown when the notification event fails validation.</p>
79
+ *
80
+ * @throws {@link NotificationsServiceException}
81
+ * <p>Base exception class for all service exceptions from Notifications service.</p>
82
+ *
83
+ * @public
84
+ */
85
+ export declare class ListNotificationConfigurationsCommand extends ListNotificationConfigurationsCommand_base {
86
+ /** @internal type navigation helper, not in runtime. */
87
+ protected static __types: {
88
+ api: {
89
+ input: ListNotificationConfigurationsRequest;
90
+ output: ListNotificationConfigurationsResponse;
91
+ };
92
+ sdk: {
93
+ input: ListNotificationConfigurationsCommandInput;
94
+ output: ListNotificationConfigurationsCommandOutput;
95
+ };
96
+ };
97
+ }