@aws-sdk/client-notifications 3.730.0 → 3.731.1
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.
- package/README.md +115 -3
- package/dist-cjs/Notifications.js +28 -0
- package/dist-cjs/commands/AssociateManagedNotificationAccountContactCommand.js +26 -0
- package/dist-cjs/commands/AssociateManagedNotificationAdditionalChannelCommand.js +26 -0
- package/dist-cjs/commands/DisableNotificationsAccessForOrganizationCommand.js +26 -0
- package/dist-cjs/commands/DisassociateManagedNotificationAccountContactCommand.js +26 -0
- package/dist-cjs/commands/DisassociateManagedNotificationAdditionalChannelCommand.js +26 -0
- package/dist-cjs/commands/EnableNotificationsAccessForOrganizationCommand.js +26 -0
- package/dist-cjs/commands/GetManagedNotificationChildEventCommand.js +26 -0
- package/dist-cjs/commands/GetManagedNotificationConfigurationCommand.js +26 -0
- package/dist-cjs/commands/GetManagedNotificationEventCommand.js +26 -0
- package/dist-cjs/commands/GetNotificationsAccessForOrganizationCommand.js +26 -0
- package/dist-cjs/commands/ListManagedNotificationChannelAssociationsCommand.js +26 -0
- package/dist-cjs/commands/ListManagedNotificationChildEventsCommand.js +26 -0
- package/dist-cjs/commands/ListManagedNotificationConfigurationsCommand.js +26 -0
- package/dist-cjs/commands/ListManagedNotificationEventsCommand.js +26 -0
- package/dist-cjs/commands/index.js +14 -0
- package/dist-cjs/models/models_0.js +25 -4
- package/dist-cjs/pagination/ListManagedNotificationChannelAssociationsPaginator.js +7 -0
- package/dist-cjs/pagination/ListManagedNotificationChildEventsPaginator.js +7 -0
- package/dist-cjs/pagination/ListManagedNotificationConfigurationsPaginator.js +7 -0
- package/dist-cjs/pagination/ListManagedNotificationEventsPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +4 -0
- package/dist-cjs/protocols/Aws_restJson1.js +475 -5
- package/dist-es/Notifications.js +28 -0
- package/dist-es/commands/AssociateManagedNotificationAccountContactCommand.js +22 -0
- package/dist-es/commands/AssociateManagedNotificationAdditionalChannelCommand.js +22 -0
- package/dist-es/commands/DisableNotificationsAccessForOrganizationCommand.js +22 -0
- package/dist-es/commands/DisassociateManagedNotificationAccountContactCommand.js +22 -0
- package/dist-es/commands/DisassociateManagedNotificationAdditionalChannelCommand.js +22 -0
- package/dist-es/commands/EnableNotificationsAccessForOrganizationCommand.js +22 -0
- package/dist-es/commands/GetManagedNotificationChildEventCommand.js +22 -0
- package/dist-es/commands/GetManagedNotificationConfigurationCommand.js +22 -0
- package/dist-es/commands/GetManagedNotificationEventCommand.js +22 -0
- package/dist-es/commands/GetNotificationsAccessForOrganizationCommand.js +22 -0
- package/dist-es/commands/ListManagedNotificationChannelAssociationsCommand.js +22 -0
- package/dist-es/commands/ListManagedNotificationChildEventsCommand.js +22 -0
- package/dist-es/commands/ListManagedNotificationConfigurationsCommand.js +22 -0
- package/dist-es/commands/ListManagedNotificationEventsCommand.js +22 -0
- package/dist-es/commands/index.js +14 -0
- package/dist-es/models/models_0.js +24 -3
- package/dist-es/pagination/ListManagedNotificationChannelAssociationsPaginator.js +4 -0
- package/dist-es/pagination/ListManagedNotificationChildEventsPaginator.js +4 -0
- package/dist-es/pagination/ListManagedNotificationConfigurationsPaginator.js +4 -0
- package/dist-es/pagination/ListManagedNotificationEventsPaginator.js +4 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +445 -4
- package/dist-types/Notifications.d.ts +106 -3
- package/dist-types/NotificationsClient.d.ts +19 -5
- package/dist-types/commands/AssociateChannelCommand.d.ts +2 -2
- package/dist-types/commands/AssociateManagedNotificationAccountContactCommand.d.ts +91 -0
- package/dist-types/commands/AssociateManagedNotificationAdditionalChannelCommand.d.ts +92 -0
- package/dist-types/commands/CreateEventRuleCommand.d.ts +4 -1
- package/dist-types/commands/CreateNotificationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEventRuleCommand.d.ts +1 -1
- package/dist-types/commands/DeleteNotificationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterNotificationHubCommand.d.ts +5 -2
- package/dist-types/commands/DisableNotificationsAccessForOrganizationCommand.d.ts +88 -0
- package/dist-types/commands/DisassociateChannelCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateManagedNotificationAccountContactCommand.d.ts +88 -0
- package/dist-types/commands/DisassociateManagedNotificationAdditionalChannelCommand.d.ts +86 -0
- package/dist-types/commands/EnableNotificationsAccessForOrganizationCommand.d.ts +88 -0
- package/dist-types/commands/GetEventRuleCommand.d.ts +1 -1
- package/dist-types/commands/GetManagedNotificationChildEventCommand.d.ts +130 -0
- package/dist-types/commands/GetManagedNotificationConfigurationCommand.d.ts +90 -0
- package/dist-types/commands/GetManagedNotificationEventCommand.d.ts +161 -0
- package/dist-types/commands/GetNotificationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetNotificationEventCommand.d.ts +42 -3
- package/dist-types/commands/GetNotificationsAccessForOrganizationCommand.d.ts +83 -0
- package/dist-types/commands/ListChannelsCommand.d.ts +1 -1
- package/dist-types/commands/ListEventRulesCommand.d.ts +1 -1
- package/dist-types/commands/ListManagedNotificationChannelAssociationsCommand.d.ts +95 -0
- package/dist-types/commands/ListManagedNotificationChildEventsCommand.d.ts +121 -0
- package/dist-types/commands/ListManagedNotificationConfigurationsCommand.d.ts +92 -0
- package/dist-types/commands/ListManagedNotificationEventsCommand.d.ts +155 -0
- package/dist-types/commands/ListNotificationConfigurationsCommand.d.ts +2 -1
- package/dist-types/commands/ListNotificationEventsCommand.d.ts +41 -2
- package/dist-types/commands/ListNotificationHubsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
- package/dist-types/commands/RegisterNotificationHubCommand.d.ts +3 -2
- package/dist-types/commands/TagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEventRuleCommand.d.ts +1 -1
- package/dist-types/commands/UpdateNotificationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +14 -0
- package/dist-types/index.d.ts +3 -3
- package/dist-types/models/models_0.d.ts +1830 -578
- package/dist-types/pagination/ListManagedNotificationChannelAssociationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListManagedNotificationChildEventsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListManagedNotificationConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListManagedNotificationEventsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +126 -0
- package/dist-types/ts3.4/Notifications.d.ts +309 -0
- package/dist-types/ts3.4/NotificationsClient.d.ts +84 -0
- package/dist-types/ts3.4/commands/AssociateManagedNotificationAccountContactCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/AssociateManagedNotificationAdditionalChannelCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DisableNotificationsAccessForOrganizationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DisassociateManagedNotificationAccountContactCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DisassociateManagedNotificationAdditionalChannelCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/EnableNotificationsAccessForOrganizationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetManagedNotificationChildEventCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetManagedNotificationConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetManagedNotificationEventCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetNotificationsAccessForOrganizationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListManagedNotificationChannelAssociationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListManagedNotificationChildEventsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListManagedNotificationConfigurationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListManagedNotificationEventsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +14 -0
- package/dist-types/ts3.4/models/models_0.d.ts +288 -38
- package/dist-types/ts3.4/pagination/ListManagedNotificationChannelAssociationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListManagedNotificationChildEventsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListManagedNotificationConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListManagedNotificationEventsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +168 -0
- package/package.json +12 -12
|
@@ -12,6 +12,76 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
12
12
|
*/
|
|
13
13
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
14
|
}
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
* @enum
|
|
18
|
+
*/
|
|
19
|
+
export declare const AccessStatus: {
|
|
20
|
+
readonly DISABLED: "DISABLED";
|
|
21
|
+
readonly ENABLED: "ENABLED";
|
|
22
|
+
readonly PENDING: "PENDING";
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
*/
|
|
27
|
+
export type AccessStatus = (typeof AccessStatus)[keyof typeof AccessStatus];
|
|
28
|
+
/**
|
|
29
|
+
* @public
|
|
30
|
+
* @enum
|
|
31
|
+
*/
|
|
32
|
+
export declare const AccountContactType: {
|
|
33
|
+
/**
|
|
34
|
+
* Alternate Billing Contact managed by AWS Account Management Service.
|
|
35
|
+
*
|
|
36
|
+
*/
|
|
37
|
+
readonly ACCOUNT_ALTERNATE_BILLING: "ACCOUNT_ALTERNATE_BILLING";
|
|
38
|
+
/**
|
|
39
|
+
* Alternate Operations Contact managed by AWS Account Management Service.
|
|
40
|
+
*
|
|
41
|
+
*/
|
|
42
|
+
readonly ACCOUNT_ALTERNATE_OPERATIONS: "ACCOUNT_ALTERNATE_OPERATIONS";
|
|
43
|
+
/**
|
|
44
|
+
* Alternate Security Contact managed by AWS Account Management Service.
|
|
45
|
+
*
|
|
46
|
+
*/
|
|
47
|
+
readonly ACCOUNT_ALTERNATE_SECURITY: "ACCOUNT_ALTERNATE_SECURITY";
|
|
48
|
+
/**
|
|
49
|
+
* Primary Contact managed by AWS Account Management Service.
|
|
50
|
+
*
|
|
51
|
+
*/
|
|
52
|
+
readonly ACCOUNT_PRIMARY: "ACCOUNT_PRIMARY";
|
|
53
|
+
};
|
|
54
|
+
/**
|
|
55
|
+
* @public
|
|
56
|
+
*/
|
|
57
|
+
export type AccountContactType = (typeof AccountContactType)[keyof typeof AccountContactType];
|
|
58
|
+
/**
|
|
59
|
+
* <p>Provides detailed information about the dimensions used for event summarization and aggregation.</p>
|
|
60
|
+
* @public
|
|
61
|
+
*/
|
|
62
|
+
export interface SummarizationDimensionDetail {
|
|
63
|
+
/**
|
|
64
|
+
* <p>The name of the SummarizationDimensionDetail.</p>
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
67
|
+
name: string | undefined;
|
|
68
|
+
/**
|
|
69
|
+
* <p>Value of the property used to summarize aggregated events.</p>
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
value: string | undefined;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* <p>Provides detailed information about the dimensions used for aggregation.</p>
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
export interface AggregationDetail {
|
|
79
|
+
/**
|
|
80
|
+
* <p>Properties used to summarize aggregated events.</p>
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
summarizationDimensions?: SummarizationDimensionDetail[] | undefined;
|
|
84
|
+
}
|
|
15
85
|
/**
|
|
16
86
|
* @public
|
|
17
87
|
* @enum
|
|
@@ -47,18 +117,92 @@ export declare const AggregationEventType: {
|
|
|
47
117
|
* @public
|
|
48
118
|
*/
|
|
49
119
|
export type AggregationEventType = (typeof AggregationEventType)[keyof typeof AggregationEventType];
|
|
120
|
+
/**
|
|
121
|
+
* <p>Key-value collection that indicate how notifications are grouped.</p>
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
export interface AggregationKey {
|
|
125
|
+
/**
|
|
126
|
+
* <p>Indicates the type of aggregation key.</p>
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
129
|
+
name: string | undefined;
|
|
130
|
+
/**
|
|
131
|
+
* <p>Indicates the value associated with the aggregation key name.</p>
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
value: string | undefined;
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
* <p>Provides an overview of how data is summarized across different dimensions.</p>
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
export interface SummarizationDimensionOverview {
|
|
141
|
+
/**
|
|
142
|
+
* <p>Name of the summarization dimension.</p>
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
name: string | undefined;
|
|
146
|
+
/**
|
|
147
|
+
* <p>Total number of occurrences for this dimension.</p>
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
count: number | undefined;
|
|
151
|
+
/**
|
|
152
|
+
* <p>Indicates the sample values found within the dimension.</p>
|
|
153
|
+
* @public
|
|
154
|
+
*/
|
|
155
|
+
sampleValues?: string[] | undefined;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* <p>Provides additional information about the aggregation key.</p>
|
|
159
|
+
* @public
|
|
160
|
+
*/
|
|
161
|
+
export interface AggregationSummary {
|
|
162
|
+
/**
|
|
163
|
+
* <p>Indicates the number of events associated with the aggregation key.</p>
|
|
164
|
+
* @public
|
|
165
|
+
*/
|
|
166
|
+
eventCount: number | undefined;
|
|
167
|
+
/**
|
|
168
|
+
* <p>Indicates the criteria or rules by which notifications have been grouped together.</p>
|
|
169
|
+
* @public
|
|
170
|
+
*/
|
|
171
|
+
aggregatedBy: AggregationKey[] | undefined;
|
|
172
|
+
/**
|
|
173
|
+
* <p>Indicates the Amazon Web Services accounts in the aggregation key.</p>
|
|
174
|
+
* @public
|
|
175
|
+
*/
|
|
176
|
+
aggregatedAccounts: SummarizationDimensionOverview | undefined;
|
|
177
|
+
/**
|
|
178
|
+
* <p>Indicates the Amazon Web Services Regions in the aggregation key.</p>
|
|
179
|
+
* @public
|
|
180
|
+
*/
|
|
181
|
+
aggregatedRegions: SummarizationDimensionOverview | undefined;
|
|
182
|
+
/**
|
|
183
|
+
* <p>Indicates the collection of organizational units that are involved in the aggregation key.</p>
|
|
184
|
+
* @public
|
|
185
|
+
*/
|
|
186
|
+
aggregatedOrganizationalUnits?: SummarizationDimensionOverview | undefined;
|
|
187
|
+
/**
|
|
188
|
+
* <p>List of additional dimensions used to group and summarize data.</p>
|
|
189
|
+
* @public
|
|
190
|
+
*/
|
|
191
|
+
additionalSummarizationDimensions?: SummarizationDimensionOverview[] | undefined;
|
|
192
|
+
}
|
|
50
193
|
/**
|
|
51
194
|
* @public
|
|
52
195
|
*/
|
|
53
196
|
export interface AssociateChannelRequest {
|
|
54
197
|
/**
|
|
55
|
-
* <p>The Amazon Resource Name (ARN) of the Channel to associate with the NotificationConfiguration
|
|
56
|
-
* <p>Supported ARNs include
|
|
198
|
+
* <p>The Amazon Resource Name (ARN) of the Channel to associate with the <code>NotificationConfiguration</code>.</p>
|
|
199
|
+
* <p>Supported ARNs include Chatbot, the Console Mobile Application, and notifications-contacts.</p>
|
|
57
200
|
* @public
|
|
58
201
|
*/
|
|
59
202
|
arn: string | undefined;
|
|
60
203
|
/**
|
|
61
|
-
* <p>The ARN of the NotificationConfiguration to associate with the
|
|
204
|
+
* <p>The ARN of the <code>NotificationConfiguration</code> to associate with the
|
|
205
|
+
* Channel.</p>
|
|
62
206
|
* @public
|
|
63
207
|
*/
|
|
64
208
|
notificationConfigurationArn: string | undefined;
|
|
@@ -227,6 +371,47 @@ export declare class ValidationException extends __BaseException {
|
|
|
227
371
|
*/
|
|
228
372
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
229
373
|
}
|
|
374
|
+
/**
|
|
375
|
+
* @public
|
|
376
|
+
*/
|
|
377
|
+
export interface AssociateManagedNotificationAccountContactRequest {
|
|
378
|
+
/**
|
|
379
|
+
* <p>A unique value of an Account Contact Type to associate with the <code>ManagedNotificationConfiguration</code>.</p>
|
|
380
|
+
* @public
|
|
381
|
+
*/
|
|
382
|
+
contactIdentifier: AccountContactType | undefined;
|
|
383
|
+
/**
|
|
384
|
+
* <p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code> to associate with the Account Contact.</p>
|
|
385
|
+
* @public
|
|
386
|
+
*/
|
|
387
|
+
managedNotificationConfigurationArn: string | undefined;
|
|
388
|
+
}
|
|
389
|
+
/**
|
|
390
|
+
* @public
|
|
391
|
+
*/
|
|
392
|
+
export interface AssociateManagedNotificationAccountContactResponse {
|
|
393
|
+
}
|
|
394
|
+
/**
|
|
395
|
+
* @public
|
|
396
|
+
*/
|
|
397
|
+
export interface AssociateManagedNotificationAdditionalChannelRequest {
|
|
398
|
+
/**
|
|
399
|
+
* <p>The Amazon Resource Name (ARN) of the Channel to associate with the <code>ManagedNotificationConfiguration</code>.</p>
|
|
400
|
+
* <p>Supported ARNs include Chatbot, the Console Mobile Application, and email (notifications-contacts).</p>
|
|
401
|
+
* @public
|
|
402
|
+
*/
|
|
403
|
+
channelArn: string | undefined;
|
|
404
|
+
/**
|
|
405
|
+
* <p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code> to associate with the additional Channel.</p>
|
|
406
|
+
* @public
|
|
407
|
+
*/
|
|
408
|
+
managedNotificationConfigurationArn: string | undefined;
|
|
409
|
+
}
|
|
410
|
+
/**
|
|
411
|
+
* @public
|
|
412
|
+
*/
|
|
413
|
+
export interface AssociateManagedNotificationAdditionalChannelResponse {
|
|
414
|
+
}
|
|
230
415
|
/**
|
|
231
416
|
* @public
|
|
232
417
|
*/
|
|
@@ -237,7 +422,7 @@ export interface DisassociateChannelRequest {
|
|
|
237
422
|
*/
|
|
238
423
|
arn: string | undefined;
|
|
239
424
|
/**
|
|
240
|
-
* <p>The ARN of the NotificationConfiguration to disassociate.</p>
|
|
425
|
+
* <p>The ARN of the <code>NotificationConfiguration</code> to disassociate.</p>
|
|
241
426
|
* @public
|
|
242
427
|
*/
|
|
243
428
|
notificationConfigurationArn: string | undefined;
|
|
@@ -252,7 +437,7 @@ export interface DisassociateChannelResponse {
|
|
|
252
437
|
*/
|
|
253
438
|
export interface ListChannelsRequest {
|
|
254
439
|
/**
|
|
255
|
-
* <p>The Amazon Resource Name (ARN) of the NotificationConfiguration
|
|
440
|
+
* <p>The Amazon Resource Name (ARN) of the <code>NotificationConfiguration</code>.</p>
|
|
256
441
|
* @public
|
|
257
442
|
*/
|
|
258
443
|
notificationConfigurationArn: string | undefined;
|
|
@@ -262,7 +447,8 @@ export interface ListChannelsRequest {
|
|
|
262
447
|
*/
|
|
263
448
|
maxResults?: number | undefined;
|
|
264
449
|
/**
|
|
265
|
-
* <p>The start token for paginated calls. Retrieved from the response of a previous
|
|
450
|
+
* <p>The start token for paginated calls. Retrieved from the response of a previous
|
|
451
|
+
* ListNotificationEvents call. <code>NextToken</code> uses Base64 encoding.</p>
|
|
266
452
|
* @public
|
|
267
453
|
*/
|
|
268
454
|
nextToken?: string | undefined;
|
|
@@ -282,36 +468,89 @@ export interface ListChannelsResponse {
|
|
|
282
468
|
*/
|
|
283
469
|
channels: string[] | undefined;
|
|
284
470
|
}
|
|
471
|
+
/**
|
|
472
|
+
* @public
|
|
473
|
+
* @enum
|
|
474
|
+
*/
|
|
475
|
+
export declare const ChannelAssociationOverrideOption: {
|
|
476
|
+
/**
|
|
477
|
+
* AWS User Notification service users can not associate or disassociate a Channel with a notification configuration.
|
|
478
|
+
*
|
|
479
|
+
*/
|
|
480
|
+
readonly DISABLED: "DISABLED";
|
|
481
|
+
/**
|
|
482
|
+
* AWS User Notification service users can associate or disassociate a Channel with a notification configuration.
|
|
483
|
+
*
|
|
484
|
+
*/
|
|
485
|
+
readonly ENABLED: "ENABLED";
|
|
486
|
+
};
|
|
487
|
+
/**
|
|
488
|
+
* @public
|
|
489
|
+
*/
|
|
490
|
+
export type ChannelAssociationOverrideOption = (typeof ChannelAssociationOverrideOption)[keyof typeof ChannelAssociationOverrideOption];
|
|
491
|
+
/**
|
|
492
|
+
* @public
|
|
493
|
+
* @enum
|
|
494
|
+
*/
|
|
495
|
+
export declare const ChannelType: {
|
|
496
|
+
/**
|
|
497
|
+
* User Notification Service sends notifications to Account Managed contacts.
|
|
498
|
+
*
|
|
499
|
+
*/
|
|
500
|
+
readonly ACCOUNT_CONTACT: "ACCOUNT_CONTACT";
|
|
501
|
+
/**
|
|
502
|
+
* Chatbot sends notifications to group platforms, like Slack or Chime. Link:https://aws.amazon.com/chatbot/
|
|
503
|
+
*
|
|
504
|
+
*/
|
|
505
|
+
readonly CHATBOT: "CHATBOT";
|
|
506
|
+
/**
|
|
507
|
+
* Email sends notifications to email addresses.
|
|
508
|
+
*
|
|
509
|
+
*/
|
|
510
|
+
readonly EMAIL: "EMAIL";
|
|
511
|
+
/**
|
|
512
|
+
* AWS Console Mobile App sends notifications to mobile devices. Link:https://aws.amazon.com/console/mobile/
|
|
513
|
+
*
|
|
514
|
+
*/
|
|
515
|
+
readonly MOBILE: "MOBILE";
|
|
516
|
+
};
|
|
517
|
+
/**
|
|
518
|
+
* @public
|
|
519
|
+
*/
|
|
520
|
+
export type ChannelType = (typeof ChannelType)[keyof typeof ChannelType];
|
|
285
521
|
/**
|
|
286
522
|
* @public
|
|
287
523
|
*/
|
|
288
524
|
export interface CreateEventRuleRequest {
|
|
289
525
|
/**
|
|
290
|
-
* <p>The Amazon Resource Name (ARN) of the NotificationConfiguration associated
|
|
526
|
+
* <p>The Amazon Resource Name (ARN) of the <code>NotificationConfiguration</code> associated
|
|
527
|
+
* with this <code>EventRule</code>.</p>
|
|
291
528
|
* @public
|
|
292
529
|
*/
|
|
293
530
|
notificationConfigurationArn: string | undefined;
|
|
294
531
|
/**
|
|
295
532
|
* <p>The matched event source.</p>
|
|
296
|
-
* <p>Must match one of the valid EventBridge sources. Only
|
|
533
|
+
* <p>Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
297
534
|
* @public
|
|
298
535
|
*/
|
|
299
536
|
source: string | undefined;
|
|
300
537
|
/**
|
|
301
538
|
* <p>The event type to match.</p>
|
|
302
|
-
* <p>Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and
|
|
539
|
+
* <p>Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
303
540
|
* @public
|
|
304
541
|
*/
|
|
305
542
|
eventType: string | undefined;
|
|
306
543
|
/**
|
|
307
|
-
* <p>An additional event pattern used to further filter the events this
|
|
544
|
+
* <p>An additional event pattern used to further filter the events this
|
|
545
|
+
* <code>EventRule</code> receives.</p>
|
|
308
546
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html">Amazon EventBridge event patterns</a> in the <i>Amazon EventBridge User Guide.</i>
|
|
309
547
|
* </p>
|
|
310
548
|
* @public
|
|
311
549
|
*/
|
|
312
550
|
eventPattern?: string | undefined;
|
|
313
551
|
/**
|
|
314
|
-
* <p>A list of
|
|
552
|
+
* <p>A list of Amazon Web Services Regions that send events to this
|
|
553
|
+
* <code>EventRule</code>.</p>
|
|
315
554
|
* @public
|
|
316
555
|
*/
|
|
317
556
|
regions: string[] | undefined;
|
|
@@ -347,12 +586,12 @@ export declare const EventRuleStatus: {
|
|
|
347
586
|
*/
|
|
348
587
|
export type EventRuleStatus = (typeof EventRuleStatus)[keyof typeof EventRuleStatus];
|
|
349
588
|
/**
|
|
350
|
-
* <p>
|
|
589
|
+
* <p>Provides additional information about the current <code>EventRule</code> status.</p>
|
|
351
590
|
* @public
|
|
352
591
|
*/
|
|
353
592
|
export interface EventRuleStatusSummary {
|
|
354
593
|
/**
|
|
355
|
-
* <p>The status of the EventRule
|
|
594
|
+
* <p>The status of the <code>EventRule</code>.</p>
|
|
356
595
|
* <ul>
|
|
357
596
|
* <li>
|
|
358
597
|
* <p>Values:</p>
|
|
@@ -363,7 +602,7 @@ export interface EventRuleStatusSummary {
|
|
|
363
602
|
* </p>
|
|
364
603
|
* <ul>
|
|
365
604
|
* <li>
|
|
366
|
-
* <p>The EventRule can process events.</p>
|
|
605
|
+
* <p>The <code>EventRule</code> can process events.</p>
|
|
367
606
|
* </li>
|
|
368
607
|
* </ul>
|
|
369
608
|
* </li>
|
|
@@ -373,7 +612,7 @@ export interface EventRuleStatusSummary {
|
|
|
373
612
|
* </p>
|
|
374
613
|
* <ul>
|
|
375
614
|
* <li>
|
|
376
|
-
* <p>The EventRule may be unable to process events.</p>
|
|
615
|
+
* <p>The <code>EventRule</code> may be unable to process events.</p>
|
|
377
616
|
* </li>
|
|
378
617
|
* </ul>
|
|
379
618
|
* </li>
|
|
@@ -383,7 +622,7 @@ export interface EventRuleStatusSummary {
|
|
|
383
622
|
* </p>
|
|
384
623
|
* <ul>
|
|
385
624
|
* <li>
|
|
386
|
-
* <p>The EventRule is being created.</p>
|
|
625
|
+
* <p>The <code>EventRule</code> is being created.</p>
|
|
387
626
|
* <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p>
|
|
388
627
|
* </li>
|
|
389
628
|
* </ul>
|
|
@@ -394,7 +633,7 @@ export interface EventRuleStatusSummary {
|
|
|
394
633
|
* </p>
|
|
395
634
|
* <ul>
|
|
396
635
|
* <li>
|
|
397
|
-
* <p>The EventRule is being updated.</p>
|
|
636
|
+
* <p>The <code>EventRule</code> is being updated.</p>
|
|
398
637
|
* <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p>
|
|
399
638
|
* </li>
|
|
400
639
|
* </ul>
|
|
@@ -405,7 +644,7 @@ export interface EventRuleStatusSummary {
|
|
|
405
644
|
* </p>
|
|
406
645
|
* <ul>
|
|
407
646
|
* <li>
|
|
408
|
-
* <p>The EventRule is being deleted.</p>
|
|
647
|
+
* <p>The <code>EventRule</code> is being deleted.</p>
|
|
409
648
|
* <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p>
|
|
410
649
|
* </li>
|
|
411
650
|
* </ul>
|
|
@@ -417,7 +656,7 @@ export interface EventRuleStatusSummary {
|
|
|
417
656
|
*/
|
|
418
657
|
status: EventRuleStatus | undefined;
|
|
419
658
|
/**
|
|
420
|
-
* <p>A human-readable reason for EventRuleStatus
|
|
659
|
+
* <p>A human-readable reason for <code>EventRuleStatus</code>.</p>
|
|
421
660
|
* @public
|
|
422
661
|
*/
|
|
423
662
|
reason: string | undefined;
|
|
@@ -432,12 +671,12 @@ export interface CreateEventRuleResponse {
|
|
|
432
671
|
*/
|
|
433
672
|
arn: string | undefined;
|
|
434
673
|
/**
|
|
435
|
-
* <p>The ARN of a NotificationConfiguration
|
|
674
|
+
* <p>The ARN of a <code>NotificationConfiguration</code>.</p>
|
|
436
675
|
* @public
|
|
437
676
|
*/
|
|
438
677
|
notificationConfigurationArn: string | undefined;
|
|
439
678
|
/**
|
|
440
|
-
* <p>A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary
|
|
679
|
+
* <p>A list of an <code>EventRule</code>'s status by Region. Regions are mapped to <code>EventRuleStatusSummary</code>.</p>
|
|
441
680
|
* @public
|
|
442
681
|
*/
|
|
443
682
|
statusSummaryByRegion: Record<string, EventRuleStatusSummary> | undefined;
|
|
@@ -447,17 +686,17 @@ export interface CreateEventRuleResponse {
|
|
|
447
686
|
*/
|
|
448
687
|
export interface CreateNotificationConfigurationRequest {
|
|
449
688
|
/**
|
|
450
|
-
* <p>The name of the NotificationConfiguration
|
|
689
|
+
* <p>The name of the <code>NotificationConfiguration</code>. Supports RFC 3986's unreserved characters.</p>
|
|
451
690
|
* @public
|
|
452
691
|
*/
|
|
453
692
|
name: string | undefined;
|
|
454
693
|
/**
|
|
455
|
-
* <p>The description of the NotificationConfiguration
|
|
694
|
+
* <p>The description of the <code>NotificationConfiguration</code>.</p>
|
|
456
695
|
* @public
|
|
457
696
|
*/
|
|
458
697
|
description: string | undefined;
|
|
459
698
|
/**
|
|
460
|
-
* <p>The aggregation preference of the NotificationConfiguration
|
|
699
|
+
* <p>The aggregation preference of the <code>NotificationConfiguration</code>.</p>
|
|
461
700
|
* <ul>
|
|
462
701
|
* <li>
|
|
463
702
|
* <p>Values:</p>
|
|
@@ -489,7 +728,6 @@ export interface CreateNotificationConfigurationRequest {
|
|
|
489
728
|
* <ul>
|
|
490
729
|
* <li>
|
|
491
730
|
* <p>Don't aggregate notifications.</p>
|
|
492
|
-
* <p>No delay in delivery.</p>
|
|
493
731
|
* </li>
|
|
494
732
|
* </ul>
|
|
495
733
|
* </li>
|
|
@@ -536,66 +774,12 @@ export type NotificationConfigurationStatus = (typeof NotificationConfigurationS
|
|
|
536
774
|
*/
|
|
537
775
|
export interface CreateNotificationConfigurationResponse {
|
|
538
776
|
/**
|
|
539
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
777
|
+
* <p>The Amazon Resource Name (ARN) of the <code>NotificationConfiguration</code>.</p>
|
|
540
778
|
* @public
|
|
541
779
|
*/
|
|
542
780
|
arn: string | undefined;
|
|
543
781
|
/**
|
|
544
|
-
* <p>The status of this NotificationConfiguration
|
|
545
|
-
* <p>The status should always be <code>INACTIVE</code> when part of the CreateNotificationConfiguration response.</p>
|
|
546
|
-
* <ul>
|
|
547
|
-
* <li>
|
|
548
|
-
* <p>Values:</p>
|
|
549
|
-
* <ul>
|
|
550
|
-
* <li>
|
|
551
|
-
* <p>
|
|
552
|
-
* <code>ACTIVE</code>
|
|
553
|
-
* </p>
|
|
554
|
-
* <ul>
|
|
555
|
-
* <li>
|
|
556
|
-
* <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p>
|
|
557
|
-
* </li>
|
|
558
|
-
* </ul>
|
|
559
|
-
* </li>
|
|
560
|
-
* <li>
|
|
561
|
-
* <p>
|
|
562
|
-
* <code>PARTIALLY_ACTIVE</code>
|
|
563
|
-
* </p>
|
|
564
|
-
* <ul>
|
|
565
|
-
* <li>
|
|
566
|
-
* <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>.</p>
|
|
567
|
-
* </li>
|
|
568
|
-
* <li>
|
|
569
|
-
* <p>Any call can be run.</p>
|
|
570
|
-
* </li>
|
|
571
|
-
* </ul>
|
|
572
|
-
* </li>
|
|
573
|
-
* <li>
|
|
574
|
-
* <p>
|
|
575
|
-
* <code>INACTIVE</code>
|
|
576
|
-
* </p>
|
|
577
|
-
* <ul>
|
|
578
|
-
* <li>
|
|
579
|
-
* <p>All EventRules are <code>INACTIVE</code> and any call can be run.</p>
|
|
580
|
-
* </li>
|
|
581
|
-
* </ul>
|
|
582
|
-
* </li>
|
|
583
|
-
* <li>
|
|
584
|
-
* <p>
|
|
585
|
-
* <code>DELETING</code>
|
|
586
|
-
* </p>
|
|
587
|
-
* <ul>
|
|
588
|
-
* <li>
|
|
589
|
-
* <p>This NotificationConfiguration is being deleted.</p>
|
|
590
|
-
* </li>
|
|
591
|
-
* <li>
|
|
592
|
-
* <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p>
|
|
593
|
-
* </li>
|
|
594
|
-
* </ul>
|
|
595
|
-
* </li>
|
|
596
|
-
* </ul>
|
|
597
|
-
* </li>
|
|
598
|
-
* </ul>
|
|
782
|
+
* <p>The current status of this <code>NotificationConfiguration</code>.</p>
|
|
599
783
|
* @public
|
|
600
784
|
*/
|
|
601
785
|
status: NotificationConfigurationStatus | undefined;
|
|
@@ -605,7 +789,7 @@ export interface CreateNotificationConfigurationResponse {
|
|
|
605
789
|
*/
|
|
606
790
|
export interface DeleteEventRuleRequest {
|
|
607
791
|
/**
|
|
608
|
-
* <p>The Amazon Resource Name (ARN) of the EventRule to delete.</p>
|
|
792
|
+
* <p>The Amazon Resource Name (ARN) of the <code>EventRule</code> to delete.</p>
|
|
609
793
|
* @public
|
|
610
794
|
*/
|
|
611
795
|
arn: string | undefined;
|
|
@@ -620,7 +804,8 @@ export interface DeleteEventRuleResponse {
|
|
|
620
804
|
*/
|
|
621
805
|
export interface DeleteNotificationConfigurationRequest {
|
|
622
806
|
/**
|
|
623
|
-
* <p>The Amazon Resource Name (ARN) of the NotificationConfiguration to
|
|
807
|
+
* <p>The Amazon Resource Name (ARN) of the <code>NotificationConfiguration</code> to
|
|
808
|
+
* delete.</p>
|
|
624
809
|
* @public
|
|
625
810
|
*/
|
|
626
811
|
arn: string | undefined;
|
|
@@ -635,7 +820,7 @@ export interface DeleteNotificationConfigurationResponse {
|
|
|
635
820
|
*/
|
|
636
821
|
export interface DeregisterNotificationHubRequest {
|
|
637
822
|
/**
|
|
638
|
-
* <p>The
|
|
823
|
+
* <p>The <code>NotificationConfiguration</code> Region.</p>
|
|
639
824
|
* @public
|
|
640
825
|
*/
|
|
641
826
|
notificationHubRegion: string | undefined;
|
|
@@ -667,12 +852,12 @@ export declare const NotificationHubStatus: {
|
|
|
667
852
|
*/
|
|
668
853
|
export type NotificationHubStatus = (typeof NotificationHubStatus)[keyof typeof NotificationHubStatus];
|
|
669
854
|
/**
|
|
670
|
-
* <p>NotificationHub status
|
|
855
|
+
* <p>Provides additional information about the current <code>NotificationHub</code> status.</p>
|
|
671
856
|
* @public
|
|
672
857
|
*/
|
|
673
858
|
export interface NotificationHubStatusSummary {
|
|
674
859
|
/**
|
|
675
|
-
* <p>Status information about the NotificationHub
|
|
860
|
+
* <p>Status information about the <code>NotificationHub</code>.</p>
|
|
676
861
|
* <ul>
|
|
677
862
|
* <li>
|
|
678
863
|
* <p>Values:</p>
|
|
@@ -683,7 +868,8 @@ export interface NotificationHubStatusSummary {
|
|
|
683
868
|
* </p>
|
|
684
869
|
* <ul>
|
|
685
870
|
* <li>
|
|
686
|
-
* <p>Incoming NotificationEvents are replicated to this
|
|
871
|
+
* <p>Incoming <code>NotificationEvents</code> are replicated to this
|
|
872
|
+
* <code>NotificationHub</code>.</p>
|
|
687
873
|
* </li>
|
|
688
874
|
* </ul>
|
|
689
875
|
* </li>
|
|
@@ -693,7 +879,7 @@ export interface NotificationHubStatusSummary {
|
|
|
693
879
|
* </p>
|
|
694
880
|
* <ul>
|
|
695
881
|
* <li>
|
|
696
|
-
* <p>The
|
|
882
|
+
* <p>The <code>NotificationConfiguration</code> is initializing. A <code>NotificationConfiguration</code> with this status can't be deregistered.</p>
|
|
697
883
|
* </li>
|
|
698
884
|
* </ul>
|
|
699
885
|
* </li>
|
|
@@ -703,7 +889,9 @@ export interface NotificationHubStatusSummary {
|
|
|
703
889
|
* </p>
|
|
704
890
|
* <ul>
|
|
705
891
|
* <li>
|
|
706
|
-
* <p>The
|
|
892
|
+
* <p>The <code>NotificationConfiguration</code> is being deleted. You can't register additional
|
|
893
|
+
* <code>NotificationHubs</code> in the same Region as a
|
|
894
|
+
* <code>NotificationConfiguration</code> with this status.</p>
|
|
707
895
|
* </li>
|
|
708
896
|
* </ul>
|
|
709
897
|
* </li>
|
|
@@ -714,7 +902,7 @@ export interface NotificationHubStatusSummary {
|
|
|
714
902
|
*/
|
|
715
903
|
status: NotificationHubStatus | undefined;
|
|
716
904
|
/**
|
|
717
|
-
* <p>An
|
|
905
|
+
* <p>An explanation for the current status.</p>
|
|
718
906
|
* @public
|
|
719
907
|
*/
|
|
720
908
|
reason: string | undefined;
|
|
@@ -724,12 +912,13 @@ export interface NotificationHubStatusSummary {
|
|
|
724
912
|
*/
|
|
725
913
|
export interface DeregisterNotificationHubResponse {
|
|
726
914
|
/**
|
|
727
|
-
* <p>The
|
|
915
|
+
* <p>The <code>NotificationConfiguration</code> Region.</p>
|
|
728
916
|
* @public
|
|
729
917
|
*/
|
|
730
918
|
notificationHubRegion: string | undefined;
|
|
731
919
|
/**
|
|
732
|
-
* <p>
|
|
920
|
+
* <p>
|
|
921
|
+
* <code>NotificationConfiguration</code> status information.</p>
|
|
733
922
|
* @public
|
|
734
923
|
*/
|
|
735
924
|
statusSummary: NotificationHubStatusSummary | undefined;
|
|
@@ -750,12 +939,72 @@ export interface Dimension {
|
|
|
750
939
|
*/
|
|
751
940
|
value: string | undefined;
|
|
752
941
|
}
|
|
942
|
+
/**
|
|
943
|
+
* @public
|
|
944
|
+
*/
|
|
945
|
+
export interface DisableNotificationsAccessForOrganizationRequest {
|
|
946
|
+
}
|
|
947
|
+
/**
|
|
948
|
+
* @public
|
|
949
|
+
*/
|
|
950
|
+
export interface DisableNotificationsAccessForOrganizationResponse {
|
|
951
|
+
}
|
|
952
|
+
/**
|
|
953
|
+
* @public
|
|
954
|
+
*/
|
|
955
|
+
export interface DisassociateManagedNotificationAccountContactRequest {
|
|
956
|
+
/**
|
|
957
|
+
* <p>The unique value of an Account Contact Type to associate with the <code>ManagedNotificationConfiguration</code>.</p>
|
|
958
|
+
* @public
|
|
959
|
+
*/
|
|
960
|
+
contactIdentifier: AccountContactType | undefined;
|
|
961
|
+
/**
|
|
962
|
+
* <p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code> to associate with the Account Contact.</p>
|
|
963
|
+
* @public
|
|
964
|
+
*/
|
|
965
|
+
managedNotificationConfigurationArn: string | undefined;
|
|
966
|
+
}
|
|
967
|
+
/**
|
|
968
|
+
* @public
|
|
969
|
+
*/
|
|
970
|
+
export interface DisassociateManagedNotificationAccountContactResponse {
|
|
971
|
+
}
|
|
972
|
+
/**
|
|
973
|
+
* @public
|
|
974
|
+
*/
|
|
975
|
+
export interface DisassociateManagedNotificationAdditionalChannelRequest {
|
|
976
|
+
/**
|
|
977
|
+
* <p>The Amazon Resource Name (ARN) of the Channel to associate with the <code>ManagedNotificationConfiguration</code>.</p>
|
|
978
|
+
* @public
|
|
979
|
+
*/
|
|
980
|
+
channelArn: string | undefined;
|
|
981
|
+
/**
|
|
982
|
+
* <p>The Amazon Resource Name (ARN) of the Managed Notification Configuration to associate with the additional Channel.</p>
|
|
983
|
+
* @public
|
|
984
|
+
*/
|
|
985
|
+
managedNotificationConfigurationArn: string | undefined;
|
|
986
|
+
}
|
|
987
|
+
/**
|
|
988
|
+
* @public
|
|
989
|
+
*/
|
|
990
|
+
export interface DisassociateManagedNotificationAdditionalChannelResponse {
|
|
991
|
+
}
|
|
992
|
+
/**
|
|
993
|
+
* @public
|
|
994
|
+
*/
|
|
995
|
+
export interface EnableNotificationsAccessForOrganizationRequest {
|
|
996
|
+
}
|
|
997
|
+
/**
|
|
998
|
+
* @public
|
|
999
|
+
*/
|
|
1000
|
+
export interface EnableNotificationsAccessForOrganizationResponse {
|
|
1001
|
+
}
|
|
753
1002
|
/**
|
|
754
1003
|
* @public
|
|
755
1004
|
*/
|
|
756
1005
|
export interface GetEventRuleRequest {
|
|
757
1006
|
/**
|
|
758
|
-
* <p>The Amazon Resource Name (ARN) of the EventRule to return.</p>
|
|
1007
|
+
* <p>The Amazon Resource Name (ARN) of the <code>EventRule</code> to return.</p>
|
|
759
1008
|
* @public
|
|
760
1009
|
*/
|
|
761
1010
|
arn: string | undefined;
|
|
@@ -770,49 +1019,50 @@ export interface GetEventRuleResponse {
|
|
|
770
1019
|
*/
|
|
771
1020
|
arn: string | undefined;
|
|
772
1021
|
/**
|
|
773
|
-
* <p>The ARN of a NotificationConfiguration
|
|
1022
|
+
* <p>The ARN of a <code>NotificationConfiguration</code>.</p>
|
|
774
1023
|
* @public
|
|
775
1024
|
*/
|
|
776
1025
|
notificationConfigurationArn: string | undefined;
|
|
777
1026
|
/**
|
|
778
|
-
* <p>The date when the EventRule was created.</p>
|
|
1027
|
+
* <p>The date when the <code>EventRule</code> was created.</p>
|
|
779
1028
|
* @public
|
|
780
1029
|
*/
|
|
781
1030
|
creationTime: Date | undefined;
|
|
782
1031
|
/**
|
|
783
1032
|
* <p>The matched event source.</p>
|
|
784
|
-
* <p>Must match one of the valid EventBridge sources. Only
|
|
1033
|
+
* <p>Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
785
1034
|
* @public
|
|
786
1035
|
*/
|
|
787
1036
|
source: string | undefined;
|
|
788
1037
|
/**
|
|
789
1038
|
* <p>The event type to match.</p>
|
|
790
|
-
* <p>Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and
|
|
1039
|
+
* <p>Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
791
1040
|
* @public
|
|
792
1041
|
*/
|
|
793
1042
|
eventType: string | undefined;
|
|
794
1043
|
/**
|
|
795
|
-
* <p>An additional event pattern used to further filter the events this EventRule receives.</p>
|
|
1044
|
+
* <p>An additional event pattern used to further filter the events this <code>EventRule</code> receives.</p>
|
|
796
1045
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html">Amazon EventBridge event patterns</a> in the <i>Amazon EventBridge User Guide.</i>
|
|
797
1046
|
* </p>
|
|
798
1047
|
* @public
|
|
799
1048
|
*/
|
|
800
1049
|
eventPattern: string | undefined;
|
|
801
1050
|
/**
|
|
802
|
-
* <p>A list of
|
|
1051
|
+
* <p>A list of Amazon Web Services Regions that send events to this <code>EventRule</code>.</p>
|
|
803
1052
|
* @public
|
|
804
1053
|
*/
|
|
805
1054
|
regions: string[] | undefined;
|
|
806
1055
|
/**
|
|
807
|
-
* <p>A list of managed rules from EventBridge that are
|
|
1056
|
+
* <p>A list of managed rules from EventBridge that are associated with this
|
|
1057
|
+
* <code>EventRule</code>.</p>
|
|
808
1058
|
* <note>
|
|
809
|
-
* <p>These are created by
|
|
1059
|
+
* <p>These are created by User Notifications within your account so this <code>EventRule</code> functions.</p>
|
|
810
1060
|
* </note>
|
|
811
1061
|
* @public
|
|
812
1062
|
*/
|
|
813
1063
|
managedRules: string[] | undefined;
|
|
814
1064
|
/**
|
|
815
|
-
* <p>A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary
|
|
1065
|
+
* <p>A list of an <code>EventRule</code>'s status by Region. Regions are mapped to <code>EventRuleStatusSummary</code>.</p>
|
|
816
1066
|
* @public
|
|
817
1067
|
*/
|
|
818
1068
|
statusSummaryByRegion: Record<string, EventRuleStatusSummary> | undefined;
|
|
@@ -822,7 +1072,7 @@ export interface GetEventRuleResponse {
|
|
|
822
1072
|
*/
|
|
823
1073
|
export interface ListEventRulesRequest {
|
|
824
1074
|
/**
|
|
825
|
-
* <p>The Amazon Resource Name (ARN) of the NotificationConfiguration
|
|
1075
|
+
* <p>The Amazon Resource Name (ARN) of the <code>NotificationConfiguration</code>.</p>
|
|
826
1076
|
* @public
|
|
827
1077
|
*/
|
|
828
1078
|
notificationConfigurationArn: string | undefined;
|
|
@@ -832,65 +1082,68 @@ export interface ListEventRulesRequest {
|
|
|
832
1082
|
*/
|
|
833
1083
|
maxResults?: number | undefined;
|
|
834
1084
|
/**
|
|
835
|
-
* <p>The start token for paginated calls. Retrieved from the response of a previous
|
|
1085
|
+
* <p>The start token for paginated calls. Retrieved from the response of a previous
|
|
1086
|
+
* <code>ListEventRules</code> call. Next token uses Base64 encoding.</p>
|
|
836
1087
|
* @public
|
|
837
1088
|
*/
|
|
838
1089
|
nextToken?: string | undefined;
|
|
839
1090
|
}
|
|
840
1091
|
/**
|
|
841
|
-
* <p>Contains a complete list of fields related to an EventRule
|
|
1092
|
+
* <p>Contains a complete list of fields related to an <code>EventRule</code>.</p>
|
|
842
1093
|
* @public
|
|
843
1094
|
*/
|
|
844
1095
|
export interface EventRuleStructure {
|
|
845
1096
|
/**
|
|
846
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
1097
|
+
* <p>The Amazon Resource Name (ARN) of the <code>EventRule</code>. CloudFormation stack generates this ARN and
|
|
1098
|
+
* then uses this ARN to associate with the <code>NotificationConfiguration</code>.</p>
|
|
847
1099
|
* @public
|
|
848
1100
|
*/
|
|
849
1101
|
arn: string | undefined;
|
|
850
1102
|
/**
|
|
851
|
-
* <p>The ARN for the NotificationConfiguration associated with this EventRule
|
|
1103
|
+
* <p>The ARN for the <code>NotificationConfiguration</code> associated with this <code>EventRule</code>.</p>
|
|
852
1104
|
* @public
|
|
853
1105
|
*/
|
|
854
1106
|
notificationConfigurationArn: string | undefined;
|
|
855
1107
|
/**
|
|
856
|
-
* <p>The creation time of the
|
|
1108
|
+
* <p>The creation time of the <code>EventRule</code>.</p>
|
|
857
1109
|
* @public
|
|
858
1110
|
*/
|
|
859
1111
|
creationTime: Date | undefined;
|
|
860
1112
|
/**
|
|
861
|
-
* <p>The
|
|
862
|
-
*
|
|
1113
|
+
* <p>The event source this rule should match with the EventBridge event sources. It must match with atleast one of the valid EventBridge event sources. Only Amazon Web Services service sourced events are supported.
|
|
1114
|
+
* For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level">Event delivery from Amazon Web Services services</a> in the <i>
|
|
1115
|
+
* Amazon EventBridge User Guide</i>.</p>
|
|
863
1116
|
* @public
|
|
864
1117
|
*/
|
|
865
1118
|
source: string | undefined;
|
|
866
1119
|
/**
|
|
867
|
-
* <p>The event type
|
|
868
|
-
*
|
|
1120
|
+
* <p>The event type this rule should match with the EventBridge events. It must match with atleast one of the valid EventBridge event types. For example, Amazon EC2 Instance State change Notification and Amazon CloudWatch State Change. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level">Event delivery from Amazon Web Services services</a> in the <i>
|
|
1121
|
+
* Amazon EventBridge User Guide</i>.</p>
|
|
869
1122
|
* @public
|
|
870
1123
|
*/
|
|
871
1124
|
eventType: string | undefined;
|
|
872
1125
|
/**
|
|
873
|
-
* <p>An additional event pattern used to further filter the events this EventRule receives.</p>
|
|
1126
|
+
* <p>An additional event pattern used to further filter the events this <code>EventRule</code> receives.</p>
|
|
874
1127
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html">Amazon EventBridge event patterns</a> in the <i>Amazon EventBridge User Guide.</i>
|
|
875
1128
|
* </p>
|
|
876
1129
|
* @public
|
|
877
1130
|
*/
|
|
878
1131
|
eventPattern: string | undefined;
|
|
879
1132
|
/**
|
|
880
|
-
* <p>A list of
|
|
1133
|
+
* <p>A list of Amazon Web Services Regions that send events to this <code>EventRule</code>.</p>
|
|
881
1134
|
* @public
|
|
882
1135
|
*/
|
|
883
1136
|
regions: string[] | undefined;
|
|
884
1137
|
/**
|
|
885
|
-
* <p>A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule
|
|
1138
|
+
* <p>A list of Amazon EventBridge Managed Rule ARNs associated with this <code>EventRule</code>.</p>
|
|
886
1139
|
* <note>
|
|
887
|
-
* <p>These are created by
|
|
1140
|
+
* <p>These are created by User Notifications within your account so your <code>EventRules</code> can function.</p>
|
|
888
1141
|
* </note>
|
|
889
1142
|
* @public
|
|
890
1143
|
*/
|
|
891
1144
|
managedRules: string[] | undefined;
|
|
892
1145
|
/**
|
|
893
|
-
* <p>A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary
|
|
1146
|
+
* <p>A list of an <code>EventRule</code>'s status by Region. Regions are mapped to <code>EventRuleStatusSummary</code>.</p>
|
|
894
1147
|
* @public
|
|
895
1148
|
*/
|
|
896
1149
|
statusSummaryByRegion: Record<string, EventRuleStatusSummary> | undefined;
|
|
@@ -905,7 +1158,7 @@ export interface ListEventRulesResponse {
|
|
|
905
1158
|
*/
|
|
906
1159
|
nextToken?: string | undefined;
|
|
907
1160
|
/**
|
|
908
|
-
* <p>A list of EventRules
|
|
1161
|
+
* <p>A list of <code>EventRules</code>.</p>
|
|
909
1162
|
* @public
|
|
910
1163
|
*/
|
|
911
1164
|
eventRules: EventRuleStructure[] | undefined;
|
|
@@ -915,19 +1168,19 @@ export interface ListEventRulesResponse {
|
|
|
915
1168
|
*/
|
|
916
1169
|
export interface UpdateEventRuleRequest {
|
|
917
1170
|
/**
|
|
918
|
-
* <p>The Amazon Resource Name (ARN) to use to update the EventRule
|
|
1171
|
+
* <p>The Amazon Resource Name (ARN) to use to update the <code>EventRule</code>.</p>
|
|
919
1172
|
* @public
|
|
920
1173
|
*/
|
|
921
1174
|
arn: string | undefined;
|
|
922
1175
|
/**
|
|
923
|
-
* <p>An additional event pattern used to further filter the events this EventRule receives.</p>
|
|
1176
|
+
* <p>An additional event pattern used to further filter the events this <code>EventRule</code> receives.</p>
|
|
924
1177
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html">Amazon EventBridge event patterns</a> in the <i>Amazon EventBridge User Guide.</i>
|
|
925
1178
|
* </p>
|
|
926
1179
|
* @public
|
|
927
1180
|
*/
|
|
928
1181
|
eventPattern?: string | undefined;
|
|
929
1182
|
/**
|
|
930
|
-
* <p>A list of
|
|
1183
|
+
* <p>A list of Amazon Web Services Regions that sends events to this <code>EventRule</code>.</p>
|
|
931
1184
|
* @public
|
|
932
1185
|
*/
|
|
933
1186
|
regions?: string[] | undefined;
|
|
@@ -937,12 +1190,12 @@ export interface UpdateEventRuleRequest {
|
|
|
937
1190
|
*/
|
|
938
1191
|
export interface UpdateEventRuleResponse {
|
|
939
1192
|
/**
|
|
940
|
-
* <p>The Amazon Resource Name (ARN) to use to update the EventRule
|
|
1193
|
+
* <p>The Amazon Resource Name (ARN) to use to update the <code>EventRule</code>.</p>
|
|
941
1194
|
* @public
|
|
942
1195
|
*/
|
|
943
1196
|
arn: string | undefined;
|
|
944
1197
|
/**
|
|
945
|
-
* <p>The ARN of the NotificationConfiguration
|
|
1198
|
+
* <p>The ARN of the <code>NotificationConfiguration</code>.</p>
|
|
946
1199
|
* @public
|
|
947
1200
|
*/
|
|
948
1201
|
notificationConfigurationArn: string | undefined;
|
|
@@ -966,150 +1219,13 @@ export declare const EventStatus: {
|
|
|
966
1219
|
export type EventStatus = (typeof EventStatus)[keyof typeof EventStatus];
|
|
967
1220
|
/**
|
|
968
1221
|
* @public
|
|
1222
|
+
* @enum
|
|
969
1223
|
*/
|
|
970
|
-
export
|
|
1224
|
+
export declare const LocaleCode: {
|
|
971
1225
|
/**
|
|
972
|
-
*
|
|
973
|
-
* @public
|
|
1226
|
+
* German (Germany)
|
|
974
1227
|
*/
|
|
975
|
-
|
|
976
|
-
}
|
|
977
|
-
/**
|
|
978
|
-
* @public
|
|
979
|
-
*/
|
|
980
|
-
export interface GetNotificationConfigurationResponse {
|
|
981
|
-
/**
|
|
982
|
-
* <p>The ARN of the resource.</p>
|
|
983
|
-
* @public
|
|
984
|
-
*/
|
|
985
|
-
arn: string | undefined;
|
|
986
|
-
/**
|
|
987
|
-
* <p>The name of the NotificationConfiguration.</p>
|
|
988
|
-
* @public
|
|
989
|
-
*/
|
|
990
|
-
name: string | undefined;
|
|
991
|
-
/**
|
|
992
|
-
* <p>The description of the NotificationConfiguration.</p>
|
|
993
|
-
* @public
|
|
994
|
-
*/
|
|
995
|
-
description: string | undefined;
|
|
996
|
-
/**
|
|
997
|
-
* <p>The status of this NotificationConfiguration.</p>
|
|
998
|
-
* <p>The status should always be <code>INACTIVE</code> when part of the CreateNotificationConfiguration response.</p>
|
|
999
|
-
* <ul>
|
|
1000
|
-
* <li>
|
|
1001
|
-
* <p>Values:</p>
|
|
1002
|
-
* <ul>
|
|
1003
|
-
* <li>
|
|
1004
|
-
* <p>
|
|
1005
|
-
* <code>ACTIVE</code>
|
|
1006
|
-
* </p>
|
|
1007
|
-
* <ul>
|
|
1008
|
-
* <li>
|
|
1009
|
-
* <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p>
|
|
1010
|
-
* </li>
|
|
1011
|
-
* </ul>
|
|
1012
|
-
* </li>
|
|
1013
|
-
* <li>
|
|
1014
|
-
* <p>
|
|
1015
|
-
* <code>PARTIALLY_ACTIVE</code>
|
|
1016
|
-
* </p>
|
|
1017
|
-
* <ul>
|
|
1018
|
-
* <li>
|
|
1019
|
-
* <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>.</p>
|
|
1020
|
-
* </li>
|
|
1021
|
-
* <li>
|
|
1022
|
-
* <p>Any call can be run.</p>
|
|
1023
|
-
* </li>
|
|
1024
|
-
* </ul>
|
|
1025
|
-
* </li>
|
|
1026
|
-
* <li>
|
|
1027
|
-
* <p>
|
|
1028
|
-
* <code>INACTIVE</code>
|
|
1029
|
-
* </p>
|
|
1030
|
-
* <ul>
|
|
1031
|
-
* <li>
|
|
1032
|
-
* <p>All EventRules are <code>INACTIVE</code> and any call can be run.</p>
|
|
1033
|
-
* </li>
|
|
1034
|
-
* </ul>
|
|
1035
|
-
* </li>
|
|
1036
|
-
* <li>
|
|
1037
|
-
* <p>
|
|
1038
|
-
* <code>DELETING</code>
|
|
1039
|
-
* </p>
|
|
1040
|
-
* <ul>
|
|
1041
|
-
* <li>
|
|
1042
|
-
* <p>This NotificationConfiguration is being deleted. Only <code>GET</code> and <code>LIST</code> calls can be run.</p>
|
|
1043
|
-
* </li>
|
|
1044
|
-
* <li>
|
|
1045
|
-
* <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p>
|
|
1046
|
-
* </li>
|
|
1047
|
-
* </ul>
|
|
1048
|
-
* </li>
|
|
1049
|
-
* </ul>
|
|
1050
|
-
* </li>
|
|
1051
|
-
* </ul>
|
|
1052
|
-
* @public
|
|
1053
|
-
*/
|
|
1054
|
-
status: NotificationConfigurationStatus | undefined;
|
|
1055
|
-
/**
|
|
1056
|
-
* <p>The creation time of the NotificationConfiguration.</p>
|
|
1057
|
-
* @public
|
|
1058
|
-
*/
|
|
1059
|
-
creationTime: Date | undefined;
|
|
1060
|
-
/**
|
|
1061
|
-
* <p>The aggregation preference of the NotificationConfiguration.</p>
|
|
1062
|
-
* <ul>
|
|
1063
|
-
* <li>
|
|
1064
|
-
* <p>Values:</p>
|
|
1065
|
-
* <ul>
|
|
1066
|
-
* <li>
|
|
1067
|
-
* <p>
|
|
1068
|
-
* <code>LONG</code>
|
|
1069
|
-
* </p>
|
|
1070
|
-
* <ul>
|
|
1071
|
-
* <li>
|
|
1072
|
-
* <p>Aggregate notifications for long periods of time (12 hours).</p>
|
|
1073
|
-
* </li>
|
|
1074
|
-
* </ul>
|
|
1075
|
-
* </li>
|
|
1076
|
-
* <li>
|
|
1077
|
-
* <p>
|
|
1078
|
-
* <code>SHORT</code>
|
|
1079
|
-
* </p>
|
|
1080
|
-
* <ul>
|
|
1081
|
-
* <li>
|
|
1082
|
-
* <p>Aggregate notifications for short periods of time (5 minutes).</p>
|
|
1083
|
-
* </li>
|
|
1084
|
-
* </ul>
|
|
1085
|
-
* </li>
|
|
1086
|
-
* <li>
|
|
1087
|
-
* <p>
|
|
1088
|
-
* <code>NONE</code>
|
|
1089
|
-
* </p>
|
|
1090
|
-
* <ul>
|
|
1091
|
-
* <li>
|
|
1092
|
-
* <p>Don't aggregate notifications.</p>
|
|
1093
|
-
* <p>No delay in delivery.</p>
|
|
1094
|
-
* </li>
|
|
1095
|
-
* </ul>
|
|
1096
|
-
* </li>
|
|
1097
|
-
* </ul>
|
|
1098
|
-
* </li>
|
|
1099
|
-
* </ul>
|
|
1100
|
-
* @public
|
|
1101
|
-
*/
|
|
1102
|
-
aggregationDuration?: AggregationDuration | undefined;
|
|
1103
|
-
}
|
|
1104
|
-
/**
|
|
1105
|
-
* @public
|
|
1106
|
-
* @enum
|
|
1107
|
-
*/
|
|
1108
|
-
export declare const LocaleCode: {
|
|
1109
|
-
/**
|
|
1110
|
-
* German (Germany)
|
|
1111
|
-
*/
|
|
1112
|
-
readonly de_DE: "de_DE";
|
|
1228
|
+
readonly de_DE: "de_DE";
|
|
1113
1229
|
/**
|
|
1114
1230
|
* English (Canada)
|
|
1115
1231
|
*/
|
|
@@ -1174,55 +1290,18 @@ export type LocaleCode = (typeof LocaleCode)[keyof typeof LocaleCode];
|
|
|
1174
1290
|
/**
|
|
1175
1291
|
* @public
|
|
1176
1292
|
*/
|
|
1177
|
-
export interface
|
|
1293
|
+
export interface GetManagedNotificationChildEventRequest {
|
|
1178
1294
|
/**
|
|
1179
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
1295
|
+
* <p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationChildEvent</code> to return.</p>
|
|
1180
1296
|
* @public
|
|
1181
1297
|
*/
|
|
1182
1298
|
arn: string | undefined;
|
|
1183
1299
|
/**
|
|
1184
|
-
* <p>The locale code of the language used for the retrieved
|
|
1300
|
+
* <p>The locale code of the language used for the retrieved <code>ManagedNotificationChildEvent</code>. The default locale is English <code>en_US</code>.</p>
|
|
1185
1301
|
* @public
|
|
1186
1302
|
*/
|
|
1187
1303
|
locale?: LocaleCode | undefined;
|
|
1188
1304
|
}
|
|
1189
|
-
/**
|
|
1190
|
-
* @public
|
|
1191
|
-
* @enum
|
|
1192
|
-
*/
|
|
1193
|
-
export declare const MediaElementType: {
|
|
1194
|
-
readonly IMAGE: "IMAGE";
|
|
1195
|
-
};
|
|
1196
|
-
/**
|
|
1197
|
-
* @public
|
|
1198
|
-
*/
|
|
1199
|
-
export type MediaElementType = (typeof MediaElementType)[keyof typeof MediaElementType];
|
|
1200
|
-
/**
|
|
1201
|
-
* <p>Describes a media element.</p>
|
|
1202
|
-
* @public
|
|
1203
|
-
*/
|
|
1204
|
-
export interface MediaElement {
|
|
1205
|
-
/**
|
|
1206
|
-
* <p>The unique ID for the media.</p>
|
|
1207
|
-
* @public
|
|
1208
|
-
*/
|
|
1209
|
-
mediaId: string | undefined;
|
|
1210
|
-
/**
|
|
1211
|
-
* <p>The type of media.</p>
|
|
1212
|
-
* @public
|
|
1213
|
-
*/
|
|
1214
|
-
type: MediaElementType | undefined;
|
|
1215
|
-
/**
|
|
1216
|
-
* <p>The url of the media.</p>
|
|
1217
|
-
* @public
|
|
1218
|
-
*/
|
|
1219
|
-
url: string | undefined;
|
|
1220
|
-
/**
|
|
1221
|
-
* <p>The caption of the media.</p>
|
|
1222
|
-
* @public
|
|
1223
|
-
*/
|
|
1224
|
-
caption: string | undefined;
|
|
1225
|
-
}
|
|
1226
1305
|
/**
|
|
1227
1306
|
* <p>Describes the components of a notification message.</p>
|
|
1228
1307
|
* @public
|
|
@@ -1234,7 +1313,7 @@ export interface MessageComponents {
|
|
|
1234
1313
|
*/
|
|
1235
1314
|
headline?: string | undefined;
|
|
1236
1315
|
/**
|
|
1237
|
-
* <p>A paragraph long or multiple sentence summary. For example,
|
|
1316
|
+
* <p>A paragraph long or multiple sentence summary. For example, Chatbot notifications.</p>
|
|
1238
1317
|
* @public
|
|
1239
1318
|
*/
|
|
1240
1319
|
paragraphSummary?: string | undefined;
|
|
@@ -1278,229 +1357,1463 @@ export declare const SchemaVersion: {
|
|
|
1278
1357
|
*/
|
|
1279
1358
|
export type SchemaVersion = (typeof SchemaVersion)[keyof typeof SchemaVersion];
|
|
1280
1359
|
/**
|
|
1281
|
-
* <p>A resource affected by or closely linked to an event.</p>
|
|
1282
1360
|
* @public
|
|
1361
|
+
* @enum
|
|
1283
1362
|
*/
|
|
1284
|
-
export
|
|
1363
|
+
export declare const TextPartType: {
|
|
1364
|
+
readonly LOCALIZED_TEXT: "LOCALIZED_TEXT";
|
|
1365
|
+
readonly PLAIN_TEXT: "PLAIN_TEXT";
|
|
1366
|
+
readonly URL: "URL";
|
|
1367
|
+
};
|
|
1368
|
+
/**
|
|
1369
|
+
* @public
|
|
1370
|
+
*/
|
|
1371
|
+
export type TextPartType = (typeof TextPartType)[keyof typeof TextPartType];
|
|
1372
|
+
/**
|
|
1373
|
+
* <p>Describes text information objects containing fields that determine how text part objects are composed.</p>
|
|
1374
|
+
* @public
|
|
1375
|
+
*/
|
|
1376
|
+
export interface TextPartValue {
|
|
1285
1377
|
/**
|
|
1286
|
-
* <p>The
|
|
1287
|
-
* <p>At least one id or ARN is required.</p>
|
|
1378
|
+
* <p>The type of text part. Determines the usage of all other fields and whether or not they're required.</p>
|
|
1288
1379
|
* @public
|
|
1289
1380
|
*/
|
|
1290
|
-
|
|
1381
|
+
type: TextPartType | undefined;
|
|
1291
1382
|
/**
|
|
1292
|
-
* <p>
|
|
1383
|
+
* <p>A short single line description of the link. Must be hyper-linked with the URL itself. </p>
|
|
1384
|
+
* <p>Used for text parts with the type <code>URL</code>.</p>
|
|
1293
1385
|
* @public
|
|
1294
1386
|
*/
|
|
1295
|
-
|
|
1387
|
+
displayText?: string | undefined;
|
|
1296
1388
|
/**
|
|
1297
|
-
* <p>
|
|
1389
|
+
* <p>A map of locales to the text in that locale.</p>
|
|
1298
1390
|
* @public
|
|
1299
1391
|
*/
|
|
1300
|
-
|
|
1392
|
+
textByLocale?: Partial<Record<LocaleCode, string>> | undefined;
|
|
1301
1393
|
/**
|
|
1302
|
-
* <p>
|
|
1394
|
+
* <p>The URL itself.</p>
|
|
1303
1395
|
* @public
|
|
1304
1396
|
*/
|
|
1305
|
-
|
|
1397
|
+
url?: string | undefined;
|
|
1306
1398
|
}
|
|
1307
1399
|
/**
|
|
1308
|
-
* <p>
|
|
1309
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events-structure.html">Event structure reference</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1400
|
+
* <p>A ManagedNotificationChildEvent is a notification-focused representation of an event. They contain semantic information used to create aggregated or non-aggregated end-user notifications.</p>
|
|
1310
1401
|
* @public
|
|
1311
1402
|
*/
|
|
1312
|
-
export interface
|
|
1313
|
-
/**
|
|
1314
|
-
* <p>The version of the type of event.</p>
|
|
1315
|
-
* @public
|
|
1316
|
-
*/
|
|
1317
|
-
eventTypeVersion: string | undefined;
|
|
1403
|
+
export interface ManagedNotificationChildEvent {
|
|
1318
1404
|
/**
|
|
1319
|
-
* <p>The
|
|
1405
|
+
* <p>The schema version of the Managed Notification Child Event.</p>
|
|
1320
1406
|
* @public
|
|
1321
1407
|
*/
|
|
1322
|
-
|
|
1408
|
+
schemaVersion: SchemaVersion | undefined;
|
|
1323
1409
|
/**
|
|
1324
|
-
* <p>The
|
|
1410
|
+
* <p>The unique identifier for a Managed Notification Child Event.</p>
|
|
1325
1411
|
* @public
|
|
1326
1412
|
*/
|
|
1327
|
-
|
|
1413
|
+
id: string | undefined;
|
|
1328
1414
|
/**
|
|
1329
|
-
* <p>
|
|
1415
|
+
* <p>Describes the components of a notification message.</p>
|
|
1330
1416
|
* @public
|
|
1331
1417
|
*/
|
|
1332
|
-
|
|
1418
|
+
messageComponents: MessageComponents | undefined;
|
|
1333
1419
|
/**
|
|
1334
|
-
* <p>The
|
|
1420
|
+
* <p>The source event URL.</p>
|
|
1335
1421
|
* @public
|
|
1336
1422
|
*/
|
|
1337
|
-
|
|
1423
|
+
sourceEventDetailUrl?: string | undefined;
|
|
1338
1424
|
/**
|
|
1339
|
-
* <p>The
|
|
1425
|
+
* <p>The detailed URL for the source event.</p>
|
|
1340
1426
|
* @public
|
|
1341
1427
|
*/
|
|
1342
|
-
|
|
1428
|
+
sourceEventDetailUrlDisplayText?: string | undefined;
|
|
1343
1429
|
/**
|
|
1344
|
-
* <p>The type of event
|
|
1345
|
-
*
|
|
1346
|
-
|
|
1347
|
-
|
|
1430
|
+
* <p>The type of event causing the notification.</p>
|
|
1431
|
+
* <ul>
|
|
1432
|
+
* <li>
|
|
1433
|
+
* <p>Values:</p>
|
|
1434
|
+
* <ul>
|
|
1435
|
+
* <li>
|
|
1436
|
+
* <p>
|
|
1437
|
+
* <code>ALERT</code>
|
|
1438
|
+
* </p>
|
|
1439
|
+
* <ul>
|
|
1440
|
+
* <li>
|
|
1441
|
+
* <p>A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.</p>
|
|
1442
|
+
* </li>
|
|
1443
|
+
* </ul>
|
|
1444
|
+
* </li>
|
|
1445
|
+
* <li>
|
|
1446
|
+
* <p>
|
|
1447
|
+
* <code>WARNING</code>
|
|
1448
|
+
* </p>
|
|
1449
|
+
* <ul>
|
|
1450
|
+
* <li>
|
|
1451
|
+
* <p>A notification about an event where an issue is about to arise. For example, something is approaching a threshold.</p>
|
|
1452
|
+
* </li>
|
|
1453
|
+
* </ul>
|
|
1454
|
+
* </li>
|
|
1455
|
+
* <li>
|
|
1456
|
+
* <p>
|
|
1457
|
+
* <code>ANNOUNCEMENT</code>
|
|
1458
|
+
* </p>
|
|
1459
|
+
* <ul>
|
|
1460
|
+
* <li>
|
|
1461
|
+
* <p>A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.</p>
|
|
1462
|
+
* </li>
|
|
1463
|
+
* </ul>
|
|
1464
|
+
* </li>
|
|
1465
|
+
* <li>
|
|
1466
|
+
* <p>
|
|
1467
|
+
* <code>INFORMATIONAL</code>
|
|
1468
|
+
* </p>
|
|
1469
|
+
* <ul>
|
|
1470
|
+
* <li>
|
|
1471
|
+
* <p>A notification about informational messages. For example, recommendations, service announcements, or reminders.</p>
|
|
1472
|
+
* </li>
|
|
1473
|
+
* </ul>
|
|
1474
|
+
* </li>
|
|
1475
|
+
* </ul>
|
|
1476
|
+
* </li>
|
|
1477
|
+
* </ul>
|
|
1478
|
+
* @public
|
|
1479
|
+
*/
|
|
1480
|
+
notificationType: NotificationType | undefined;
|
|
1481
|
+
/**
|
|
1482
|
+
* <p>The assesed nature of the event.</p>
|
|
1483
|
+
* <ul>
|
|
1484
|
+
* <li>
|
|
1485
|
+
* <p>Values:</p>
|
|
1486
|
+
* <ul>
|
|
1487
|
+
* <li>
|
|
1488
|
+
* <p>
|
|
1489
|
+
* <code>HEALTHY</code>
|
|
1490
|
+
* </p>
|
|
1491
|
+
* <ul>
|
|
1492
|
+
* <li>
|
|
1493
|
+
* <p>All <code>EventRules</code> are <code>ACTIVE</code>.</p>
|
|
1494
|
+
* </li>
|
|
1495
|
+
* </ul>
|
|
1496
|
+
* </li>
|
|
1497
|
+
* <li>
|
|
1498
|
+
* <p>
|
|
1499
|
+
* <code>UNHEALTHY</code>
|
|
1500
|
+
* </p>
|
|
1501
|
+
* <ul>
|
|
1502
|
+
* <li>
|
|
1503
|
+
* <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>.</p>
|
|
1504
|
+
* </li>
|
|
1505
|
+
* </ul>
|
|
1506
|
+
* </li>
|
|
1507
|
+
* </ul>
|
|
1508
|
+
* </li>
|
|
1509
|
+
* </ul>
|
|
1510
|
+
* @public
|
|
1511
|
+
*/
|
|
1512
|
+
eventStatus?: EventStatus | undefined;
|
|
1513
|
+
/**
|
|
1514
|
+
* <p>The Amazon Resource Name (ARN) of the ManagedNotificationEvent that is associated with this Managed Notification Child Event.</p>
|
|
1515
|
+
* @public
|
|
1516
|
+
*/
|
|
1517
|
+
aggregateManagedNotificationEventArn: string | undefined;
|
|
1518
|
+
/**
|
|
1519
|
+
* <p>The notification event start time.</p>
|
|
1520
|
+
* @public
|
|
1521
|
+
*/
|
|
1522
|
+
startTime?: Date | undefined;
|
|
1523
|
+
/**
|
|
1524
|
+
* <p>The end time of the event.</p>
|
|
1525
|
+
* @public
|
|
1526
|
+
*/
|
|
1527
|
+
endTime?: Date | undefined;
|
|
1528
|
+
/**
|
|
1529
|
+
* <p>A list of text values.</p>
|
|
1530
|
+
* @public
|
|
1531
|
+
*/
|
|
1532
|
+
textParts: Record<string, TextPartValue> | undefined;
|
|
1533
|
+
/**
|
|
1534
|
+
* <p>The Organizational Unit Id that an Amazon Web Services account belongs to.</p>
|
|
1535
|
+
* @public
|
|
1536
|
+
*/
|
|
1537
|
+
organizationalUnitId?: string | undefined;
|
|
1538
|
+
/**
|
|
1539
|
+
* <p>Provides detailed information about the dimensions used for event summarization and aggregation.</p>
|
|
1540
|
+
* @public
|
|
1541
|
+
*/
|
|
1542
|
+
aggregationDetail?: AggregationDetail | undefined;
|
|
1543
|
+
}
|
|
1544
|
+
/**
|
|
1545
|
+
* @public
|
|
1546
|
+
*/
|
|
1547
|
+
export interface GetManagedNotificationChildEventResponse {
|
|
1548
|
+
/**
|
|
1549
|
+
* <p>The ARN of the resource.</p>
|
|
1550
|
+
* @public
|
|
1551
|
+
*/
|
|
1552
|
+
arn: string | undefined;
|
|
1553
|
+
/**
|
|
1554
|
+
* <p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code> associated with the <code>ManagedNotificationChildEvent</code>.</p>
|
|
1555
|
+
* @public
|
|
1556
|
+
*/
|
|
1557
|
+
managedNotificationConfigurationArn: string | undefined;
|
|
1558
|
+
/**
|
|
1559
|
+
* <p>The creation time of the <code>ManagedNotificationChildEvent</code>.</p>
|
|
1560
|
+
* @public
|
|
1561
|
+
*/
|
|
1562
|
+
creationTime: Date | undefined;
|
|
1563
|
+
/**
|
|
1564
|
+
* <p>The content of the <code>ManagedNotificationChildEvent</code>.</p>
|
|
1565
|
+
* @public
|
|
1566
|
+
*/
|
|
1567
|
+
content: ManagedNotificationChildEvent | undefined;
|
|
1568
|
+
}
|
|
1569
|
+
/**
|
|
1570
|
+
* @public
|
|
1571
|
+
*/
|
|
1572
|
+
export interface GetManagedNotificationConfigurationRequest {
|
|
1573
|
+
/**
|
|
1574
|
+
* <p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code> to return.</p>
|
|
1575
|
+
* @public
|
|
1576
|
+
*/
|
|
1577
|
+
arn: string | undefined;
|
|
1578
|
+
}
|
|
1579
|
+
/**
|
|
1580
|
+
* @public
|
|
1581
|
+
*/
|
|
1582
|
+
export interface GetManagedNotificationConfigurationResponse {
|
|
1583
|
+
/**
|
|
1584
|
+
* <p>The ARN of the <code>ManagedNotificationConfiguration</code> resource.</p>
|
|
1585
|
+
* @public
|
|
1586
|
+
*/
|
|
1587
|
+
arn: string | undefined;
|
|
1588
|
+
/**
|
|
1589
|
+
* <p>The name of the <code>ManagedNotificationConfiguration</code>.</p>
|
|
1590
|
+
* @public
|
|
1591
|
+
*/
|
|
1592
|
+
name: string | undefined;
|
|
1593
|
+
/**
|
|
1594
|
+
* <p>The description of the <code>ManagedNotificationConfiguration</code>.</p>
|
|
1595
|
+
* @public
|
|
1596
|
+
*/
|
|
1597
|
+
description: string | undefined;
|
|
1598
|
+
/**
|
|
1599
|
+
* <p>The category of the <code>ManagedNotificationConfiguration</code>.</p>
|
|
1600
|
+
* @public
|
|
1601
|
+
*/
|
|
1602
|
+
category: string | undefined;
|
|
1603
|
+
/**
|
|
1604
|
+
* <p>The subCategory of the <code>ManagedNotificationConfiguration</code>.</p>
|
|
1605
|
+
* @public
|
|
1606
|
+
*/
|
|
1607
|
+
subCategory: string | undefined;
|
|
1608
|
+
}
|
|
1609
|
+
/**
|
|
1610
|
+
* @public
|
|
1611
|
+
*/
|
|
1612
|
+
export interface GetManagedNotificationEventRequest {
|
|
1613
|
+
/**
|
|
1614
|
+
* <p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationEvent</code> to return.</p>
|
|
1615
|
+
* @public
|
|
1616
|
+
*/
|
|
1617
|
+
arn: string | undefined;
|
|
1618
|
+
/**
|
|
1619
|
+
* <p>The locale code of the language used for the retrieved <code>ManagedNotificationEvent</code>. The default locale is English <code>(en_US)</code>.</p>
|
|
1620
|
+
* @public
|
|
1621
|
+
*/
|
|
1622
|
+
locale?: LocaleCode | undefined;
|
|
1623
|
+
}
|
|
1624
|
+
/**
|
|
1625
|
+
* <p>A notification-focused representation of an event. They contain semantic information used by AccountContacts or Additional Channels to create end-user notifications.</p>
|
|
1626
|
+
* @public
|
|
1627
|
+
*/
|
|
1628
|
+
export interface ManagedNotificationEvent {
|
|
1629
|
+
/**
|
|
1630
|
+
* <p>Version of the <code>ManagedNotificationEvent</code> schema.</p>
|
|
1631
|
+
* @public
|
|
1632
|
+
*/
|
|
1633
|
+
schemaVersion: SchemaVersion | undefined;
|
|
1634
|
+
/**
|
|
1635
|
+
* <p>Unique identifier for a <code>ManagedNotificationEvent</code>.</p>
|
|
1636
|
+
* @public
|
|
1637
|
+
*/
|
|
1638
|
+
id: string | undefined;
|
|
1639
|
+
/**
|
|
1640
|
+
* <p>Describes the components of a notification message.</p>
|
|
1641
|
+
* @public
|
|
1642
|
+
*/
|
|
1643
|
+
messageComponents: MessageComponents | undefined;
|
|
1644
|
+
/**
|
|
1645
|
+
* <p>URL defined by Source Service to be used by notification consumers to get additional information about event.</p>
|
|
1646
|
+
* @public
|
|
1647
|
+
*/
|
|
1648
|
+
sourceEventDetailUrl?: string | undefined;
|
|
1649
|
+
/**
|
|
1650
|
+
* <p>Text that needs to be hyperlinked with the sourceEventDetailUrl. For example, the description of the sourceEventDetailUrl.</p>
|
|
1651
|
+
* @public
|
|
1652
|
+
*/
|
|
1653
|
+
sourceEventDetailUrlDisplayText?: string | undefined;
|
|
1654
|
+
/**
|
|
1655
|
+
* <p>The nature of the event causing this notification.</p>
|
|
1656
|
+
* <ul>
|
|
1657
|
+
* <li>
|
|
1658
|
+
* <p>Values:</p>
|
|
1659
|
+
* <ul>
|
|
1660
|
+
* <li>
|
|
1661
|
+
* <p>
|
|
1662
|
+
* <code>ALERT</code>
|
|
1663
|
+
* </p>
|
|
1664
|
+
* <ul>
|
|
1665
|
+
* <li>
|
|
1666
|
+
* <p>A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.</p>
|
|
1667
|
+
* </li>
|
|
1668
|
+
* </ul>
|
|
1669
|
+
* </li>
|
|
1670
|
+
* <li>
|
|
1671
|
+
* <p>
|
|
1672
|
+
* <code>WARNING</code>
|
|
1673
|
+
* </p>
|
|
1674
|
+
* <ul>
|
|
1675
|
+
* <li>
|
|
1676
|
+
* <p>A notification about an event where an issue is about to arise. For example, something is approaching a threshold.</p>
|
|
1677
|
+
* </li>
|
|
1678
|
+
* </ul>
|
|
1679
|
+
* </li>
|
|
1680
|
+
* <li>
|
|
1681
|
+
* <p>
|
|
1682
|
+
* <code>ANNOUNCEMENT</code>
|
|
1683
|
+
* </p>
|
|
1684
|
+
* <ul>
|
|
1685
|
+
* <li>
|
|
1686
|
+
* <p>A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.</p>
|
|
1687
|
+
* </li>
|
|
1688
|
+
* </ul>
|
|
1689
|
+
* </li>
|
|
1690
|
+
* <li>
|
|
1691
|
+
* <p>
|
|
1692
|
+
* <code>INFORMATIONAL</code>
|
|
1693
|
+
* </p>
|
|
1694
|
+
* <ul>
|
|
1695
|
+
* <li>
|
|
1696
|
+
* <p>A notification about informational messages. For example, recommendations, service announcements, or reminders.</p>
|
|
1697
|
+
* </li>
|
|
1698
|
+
* </ul>
|
|
1699
|
+
* </li>
|
|
1700
|
+
* </ul>
|
|
1701
|
+
* </li>
|
|
1702
|
+
* </ul>
|
|
1703
|
+
* @public
|
|
1704
|
+
*/
|
|
1705
|
+
notificationType: NotificationType | undefined;
|
|
1706
|
+
/**
|
|
1707
|
+
* <p>The status of an event.</p>
|
|
1708
|
+
* <ul>
|
|
1709
|
+
* <li>
|
|
1710
|
+
* <p>Values:</p>
|
|
1711
|
+
* <ul>
|
|
1712
|
+
* <li>
|
|
1713
|
+
* <p>
|
|
1714
|
+
* <code>HEALTHY</code>
|
|
1715
|
+
* </p>
|
|
1716
|
+
* <ul>
|
|
1717
|
+
* <li>
|
|
1718
|
+
* <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p>
|
|
1719
|
+
* </li>
|
|
1720
|
+
* </ul>
|
|
1721
|
+
* </li>
|
|
1722
|
+
* <li>
|
|
1723
|
+
* <p>
|
|
1724
|
+
* <code>UNHEALTHY</code>
|
|
1725
|
+
* </p>
|
|
1726
|
+
* <ul>
|
|
1727
|
+
* <li>
|
|
1728
|
+
* <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p>
|
|
1729
|
+
* </li>
|
|
1730
|
+
* </ul>
|
|
1731
|
+
* </li>
|
|
1732
|
+
* </ul>
|
|
1733
|
+
* </li>
|
|
1734
|
+
* </ul>
|
|
1735
|
+
* @public
|
|
1736
|
+
*/
|
|
1737
|
+
eventStatus?: EventStatus | undefined;
|
|
1738
|
+
/**
|
|
1739
|
+
* <p>The notifications aggregation type.</p>
|
|
1740
|
+
* @public
|
|
1741
|
+
*/
|
|
1742
|
+
aggregationEventType?: AggregationEventType | undefined;
|
|
1743
|
+
/**
|
|
1744
|
+
* <p>Provides additional information about the aggregation key.</p>
|
|
1745
|
+
* @public
|
|
1746
|
+
*/
|
|
1747
|
+
aggregationSummary?: AggregationSummary | undefined;
|
|
1748
|
+
/**
|
|
1749
|
+
* <p>The earliest time of events to return from this call.</p>
|
|
1750
|
+
* @public
|
|
1751
|
+
*/
|
|
1752
|
+
startTime?: Date | undefined;
|
|
1753
|
+
/**
|
|
1754
|
+
* <p>The end time of the notification event.</p>
|
|
1755
|
+
* @public
|
|
1756
|
+
*/
|
|
1757
|
+
endTime?: Date | undefined;
|
|
1758
|
+
/**
|
|
1759
|
+
* <p>A list of text values.</p>
|
|
1760
|
+
* @public
|
|
1761
|
+
*/
|
|
1762
|
+
textParts: Record<string, TextPartValue> | undefined;
|
|
1763
|
+
/**
|
|
1764
|
+
* <p>The Organizational Unit Id that an Amazon Web Services account belongs to.</p>
|
|
1765
|
+
* @public
|
|
1766
|
+
*/
|
|
1767
|
+
organizationalUnitId?: string | undefined;
|
|
1768
|
+
}
|
|
1769
|
+
/**
|
|
1770
|
+
* @public
|
|
1771
|
+
*/
|
|
1772
|
+
export interface GetManagedNotificationEventResponse {
|
|
1773
|
+
/**
|
|
1774
|
+
* <p>The ARN of the resource.</p>
|
|
1775
|
+
* @public
|
|
1776
|
+
*/
|
|
1777
|
+
arn: string | undefined;
|
|
1778
|
+
/**
|
|
1779
|
+
* <p>The ARN of the <code>ManagedNotificationConfiguration</code>.</p>
|
|
1780
|
+
* @public
|
|
1781
|
+
*/
|
|
1782
|
+
managedNotificationConfigurationArn: string | undefined;
|
|
1783
|
+
/**
|
|
1784
|
+
* <p>The creation time of the <code>ManagedNotificationEvent</code>.</p>
|
|
1785
|
+
* @public
|
|
1786
|
+
*/
|
|
1787
|
+
creationTime: Date | undefined;
|
|
1788
|
+
/**
|
|
1789
|
+
* <p>The content of the <code>ManagedNotificationEvent</code>.</p>
|
|
1790
|
+
* @public
|
|
1791
|
+
*/
|
|
1792
|
+
content: ManagedNotificationEvent | undefined;
|
|
1793
|
+
}
|
|
1794
|
+
/**
|
|
1795
|
+
* @public
|
|
1796
|
+
*/
|
|
1797
|
+
export interface GetNotificationConfigurationRequest {
|
|
1798
|
+
/**
|
|
1799
|
+
* <p>The Amazon Resource Name (ARN) of the <code>NotificationConfiguration</code> to return.</p>
|
|
1800
|
+
* @public
|
|
1801
|
+
*/
|
|
1802
|
+
arn: string | undefined;
|
|
1803
|
+
}
|
|
1804
|
+
/**
|
|
1805
|
+
* @public
|
|
1806
|
+
*/
|
|
1807
|
+
export interface GetNotificationConfigurationResponse {
|
|
1808
|
+
/**
|
|
1809
|
+
* <p>The ARN of the resource.</p>
|
|
1810
|
+
* @public
|
|
1811
|
+
*/
|
|
1812
|
+
arn: string | undefined;
|
|
1813
|
+
/**
|
|
1814
|
+
* <p>The name of the <code>NotificationConfiguration</code>.</p>
|
|
1815
|
+
* @public
|
|
1816
|
+
*/
|
|
1817
|
+
name: string | undefined;
|
|
1818
|
+
/**
|
|
1819
|
+
* <p>The description of the <code>NotificationConfiguration</code>.</p>
|
|
1820
|
+
* @public
|
|
1821
|
+
*/
|
|
1822
|
+
description: string | undefined;
|
|
1823
|
+
/**
|
|
1824
|
+
* <p>The status of this <code>NotificationConfiguration</code>.</p>
|
|
1825
|
+
* @public
|
|
1826
|
+
*/
|
|
1827
|
+
status: NotificationConfigurationStatus | undefined;
|
|
1828
|
+
/**
|
|
1829
|
+
* <p>The creation time of the <code>NotificationConfiguration</code>.</p>
|
|
1830
|
+
* @public
|
|
1831
|
+
*/
|
|
1832
|
+
creationTime: Date | undefined;
|
|
1833
|
+
/**
|
|
1834
|
+
* <p>The aggregation preference of the <code>NotificationConfiguration</code>.</p>
|
|
1835
|
+
* <ul>
|
|
1836
|
+
* <li>
|
|
1837
|
+
* <p>Values:</p>
|
|
1838
|
+
* <ul>
|
|
1839
|
+
* <li>
|
|
1840
|
+
* <p>
|
|
1841
|
+
* <code>LONG</code>
|
|
1842
|
+
* </p>
|
|
1843
|
+
* <ul>
|
|
1844
|
+
* <li>
|
|
1845
|
+
* <p>Aggregate notifications for long periods of time (12 hours).</p>
|
|
1846
|
+
* </li>
|
|
1847
|
+
* </ul>
|
|
1848
|
+
* </li>
|
|
1849
|
+
* <li>
|
|
1850
|
+
* <p>
|
|
1851
|
+
* <code>SHORT</code>
|
|
1852
|
+
* </p>
|
|
1853
|
+
* <ul>
|
|
1854
|
+
* <li>
|
|
1855
|
+
* <p>Aggregate notifications for short periods of time (5 minutes).</p>
|
|
1856
|
+
* </li>
|
|
1857
|
+
* </ul>
|
|
1858
|
+
* </li>
|
|
1859
|
+
* <li>
|
|
1860
|
+
* <p>
|
|
1861
|
+
* <code>NONE</code>
|
|
1862
|
+
* </p>
|
|
1863
|
+
* <ul>
|
|
1864
|
+
* <li>
|
|
1865
|
+
* <p>Don't aggregate notifications.</p>
|
|
1866
|
+
* </li>
|
|
1867
|
+
* </ul>
|
|
1868
|
+
* </li>
|
|
1869
|
+
* </ul>
|
|
1870
|
+
* </li>
|
|
1871
|
+
* </ul>
|
|
1872
|
+
* @public
|
|
1873
|
+
*/
|
|
1874
|
+
aggregationDuration?: AggregationDuration | undefined;
|
|
1875
|
+
}
|
|
1876
|
+
/**
|
|
1877
|
+
* @public
|
|
1878
|
+
*/
|
|
1879
|
+
export interface GetNotificationEventRequest {
|
|
1880
|
+
/**
|
|
1881
|
+
* <p>The Amazon Resource Name (ARN) of the <code>NotificationEvent</code> to return.</p>
|
|
1882
|
+
* @public
|
|
1883
|
+
*/
|
|
1884
|
+
arn: string | undefined;
|
|
1885
|
+
/**
|
|
1886
|
+
* <p>The locale code of the language used for the retrieved <code>NotificationEvent</code>. The default locale is English <code>en_US</code>.</p>
|
|
1887
|
+
* @public
|
|
1888
|
+
*/
|
|
1889
|
+
locale?: LocaleCode | undefined;
|
|
1890
|
+
}
|
|
1891
|
+
/**
|
|
1892
|
+
* @public
|
|
1893
|
+
* @enum
|
|
1894
|
+
*/
|
|
1895
|
+
export declare const MediaElementType: {
|
|
1896
|
+
readonly IMAGE: "IMAGE";
|
|
1897
|
+
};
|
|
1898
|
+
/**
|
|
1899
|
+
* @public
|
|
1900
|
+
*/
|
|
1901
|
+
export type MediaElementType = (typeof MediaElementType)[keyof typeof MediaElementType];
|
|
1902
|
+
/**
|
|
1903
|
+
* <p>Describes a media element.</p>
|
|
1904
|
+
* @public
|
|
1905
|
+
*/
|
|
1906
|
+
export interface MediaElement {
|
|
1907
|
+
/**
|
|
1908
|
+
* <p>The unique ID for the media.</p>
|
|
1909
|
+
* @public
|
|
1910
|
+
*/
|
|
1911
|
+
mediaId: string | undefined;
|
|
1912
|
+
/**
|
|
1913
|
+
* <p>The type of media.</p>
|
|
1914
|
+
* @public
|
|
1915
|
+
*/
|
|
1916
|
+
type: MediaElementType | undefined;
|
|
1917
|
+
/**
|
|
1918
|
+
* <p>The URL of the media.</p>
|
|
1919
|
+
* @public
|
|
1920
|
+
*/
|
|
1921
|
+
url: string | undefined;
|
|
1922
|
+
/**
|
|
1923
|
+
* <p>The caption of the media.</p>
|
|
1924
|
+
* @public
|
|
1925
|
+
*/
|
|
1926
|
+
caption: string | undefined;
|
|
1927
|
+
}
|
|
1928
|
+
/**
|
|
1929
|
+
* <p>A resource affected by or closely linked to an event.</p>
|
|
1930
|
+
* @public
|
|
1931
|
+
*/
|
|
1932
|
+
export interface Resource {
|
|
1933
|
+
/**
|
|
1934
|
+
* <p>The unique identifier for the resource.</p>
|
|
1935
|
+
* <p>At least one id or ARN is required.</p>
|
|
1936
|
+
* @public
|
|
1937
|
+
*/
|
|
1938
|
+
id?: string | undefined;
|
|
1939
|
+
/**
|
|
1940
|
+
* <p>The Amazon Resource Name (ARN) of the resource. At least one id or ARN is required.</p>
|
|
1941
|
+
* @public
|
|
1942
|
+
*/
|
|
1943
|
+
arn?: string | undefined;
|
|
1944
|
+
/**
|
|
1945
|
+
* <p>The URL to the resource's detail page. If a detail page URL is unavailable, it is the URL to an informational page that describes the resource's type.</p>
|
|
1946
|
+
* @public
|
|
1947
|
+
*/
|
|
1948
|
+
detailUrl?: string | undefined;
|
|
1949
|
+
/**
|
|
1950
|
+
* <p>A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.</p>
|
|
1951
|
+
* @public
|
|
1952
|
+
*/
|
|
1953
|
+
tags?: string[] | undefined;
|
|
1954
|
+
}
|
|
1955
|
+
/**
|
|
1956
|
+
* <p>Describes the metadata for a source event.</p>
|
|
1957
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events-structure.html">Event structure reference</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1958
|
+
* @public
|
|
1959
|
+
*/
|
|
1960
|
+
export interface SourceEventMetadata {
|
|
1961
|
+
/**
|
|
1962
|
+
* <p>The version of the type of event.</p>
|
|
1963
|
+
* @public
|
|
1964
|
+
*/
|
|
1965
|
+
eventTypeVersion: string | undefined;
|
|
1966
|
+
/**
|
|
1967
|
+
* <p>The source event id.</p>
|
|
1968
|
+
* @public
|
|
1969
|
+
*/
|
|
1970
|
+
sourceEventId: string | undefined;
|
|
1971
|
+
/**
|
|
1972
|
+
* <p>The Region the event originated from.</p>
|
|
1973
|
+
* @public
|
|
1974
|
+
*/
|
|
1975
|
+
eventOriginRegion?: string | undefined;
|
|
1976
|
+
/**
|
|
1977
|
+
* <p>The primary Amazon Web Services account of <code>SourceEvent</code>.</p>
|
|
1978
|
+
* @public
|
|
1979
|
+
*/
|
|
1980
|
+
relatedAccount: string | undefined;
|
|
1981
|
+
/**
|
|
1982
|
+
* <p>The Amazon Web Services service the event originates from. For example <code>aws.cloudwatch</code>.</p>
|
|
1983
|
+
* @public
|
|
1984
|
+
*/
|
|
1985
|
+
source: string | undefined;
|
|
1986
|
+
/**
|
|
1987
|
+
* <p>The date and time the source event occurred. This is based on the Source Event.</p>
|
|
1988
|
+
* @public
|
|
1989
|
+
*/
|
|
1990
|
+
eventOccurrenceTime: Date | undefined;
|
|
1991
|
+
/**
|
|
1992
|
+
* <p>The type of event. For example, an Amazon CloudWatch state change.</p>
|
|
1993
|
+
* @public
|
|
1994
|
+
*/
|
|
1995
|
+
eventType: string | undefined;
|
|
1996
|
+
/**
|
|
1997
|
+
* <p>A list of resources related to this <code>NotificationEvent</code>.</p>
|
|
1998
|
+
* @public
|
|
1999
|
+
*/
|
|
2000
|
+
relatedResources: Resource[] | undefined;
|
|
2001
|
+
}
|
|
2002
|
+
/**
|
|
2003
|
+
* <p>A <code>NotificationEvent</code> is a notification-focused representation of an event. They contain semantic information used by Channels to create end-user notifications.</p>
|
|
2004
|
+
* @public
|
|
2005
|
+
*/
|
|
2006
|
+
export interface NotificationEventSchema {
|
|
2007
|
+
/**
|
|
2008
|
+
* <p>The schema version of the Notification Event.</p>
|
|
2009
|
+
* @public
|
|
2010
|
+
*/
|
|
2011
|
+
schemaVersion: SchemaVersion | undefined;
|
|
2012
|
+
/**
|
|
2013
|
+
* <p>The unique identifier for a <code>NotificationEvent</code>.</p>
|
|
2014
|
+
* @public
|
|
2015
|
+
*/
|
|
2016
|
+
id: string | undefined;
|
|
2017
|
+
/**
|
|
2018
|
+
* <p>The source event metadata.</p>
|
|
2019
|
+
* @public
|
|
2020
|
+
*/
|
|
2021
|
+
sourceEventMetadata: SourceEventMetadata | undefined;
|
|
2022
|
+
/**
|
|
2023
|
+
* <p>Describes the components of a notification message.</p>
|
|
2024
|
+
* @public
|
|
2025
|
+
*/
|
|
2026
|
+
messageComponents: MessageComponents | undefined;
|
|
2027
|
+
/**
|
|
2028
|
+
* <p>The source event URL.</p>
|
|
2029
|
+
* @public
|
|
2030
|
+
*/
|
|
2031
|
+
sourceEventDetailUrl?: string | undefined;
|
|
2032
|
+
/**
|
|
2033
|
+
* <p>The detailed URL for the source event.</p>
|
|
2034
|
+
* @public
|
|
2035
|
+
*/
|
|
2036
|
+
sourceEventDetailUrlDisplayText?: string | undefined;
|
|
2037
|
+
/**
|
|
2038
|
+
* <p>The type of event causing the notification.</p>
|
|
2039
|
+
* <ul>
|
|
2040
|
+
* <li>
|
|
2041
|
+
* <p>Values:</p>
|
|
2042
|
+
* <ul>
|
|
2043
|
+
* <li>
|
|
2044
|
+
* <p>
|
|
2045
|
+
* <code>ALERT</code>
|
|
2046
|
+
* </p>
|
|
2047
|
+
* <ul>
|
|
2048
|
+
* <li>
|
|
2049
|
+
* <p>A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.</p>
|
|
2050
|
+
* </li>
|
|
2051
|
+
* </ul>
|
|
2052
|
+
* </li>
|
|
2053
|
+
* <li>
|
|
2054
|
+
* <p>
|
|
2055
|
+
* <code>WARNING</code>
|
|
2056
|
+
* </p>
|
|
2057
|
+
* <ul>
|
|
2058
|
+
* <li>
|
|
2059
|
+
* <p>A notification about an event where an issue is about to arise. For example, something is approaching a threshold.</p>
|
|
2060
|
+
* </li>
|
|
2061
|
+
* </ul>
|
|
2062
|
+
* </li>
|
|
2063
|
+
* <li>
|
|
2064
|
+
* <p>
|
|
2065
|
+
* <code>ANNOUNCEMENT</code>
|
|
2066
|
+
* </p>
|
|
2067
|
+
* <ul>
|
|
2068
|
+
* <li>
|
|
2069
|
+
* <p>A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.</p>
|
|
2070
|
+
* </li>
|
|
2071
|
+
* </ul>
|
|
2072
|
+
* </li>
|
|
2073
|
+
* <li>
|
|
2074
|
+
* <p>
|
|
2075
|
+
* <code>INFORMATIONAL</code>
|
|
2076
|
+
* </p>
|
|
2077
|
+
* <ul>
|
|
2078
|
+
* <li>
|
|
2079
|
+
* <p>A notification about informational messages. For example, recommendations, service announcements, or reminders.</p>
|
|
2080
|
+
* </li>
|
|
2081
|
+
* </ul>
|
|
2082
|
+
* </li>
|
|
2083
|
+
* </ul>
|
|
2084
|
+
* </li>
|
|
2085
|
+
* </ul>
|
|
2086
|
+
* @public
|
|
2087
|
+
*/
|
|
2088
|
+
notificationType: NotificationType | undefined;
|
|
2089
|
+
/**
|
|
2090
|
+
* <p>The assessed nature of the event.</p>
|
|
2091
|
+
* <ul>
|
|
2092
|
+
* <li>
|
|
2093
|
+
* <p>Values:</p>
|
|
2094
|
+
* <ul>
|
|
2095
|
+
* <li>
|
|
2096
|
+
* <p>
|
|
2097
|
+
* <code>HEALTHY</code>
|
|
2098
|
+
* </p>
|
|
2099
|
+
* <ul>
|
|
2100
|
+
* <li>
|
|
2101
|
+
* <p>All <code>EventRules</code> are <code>ACTIVE</code> and any call can be run.</p>
|
|
2102
|
+
* </li>
|
|
2103
|
+
* </ul>
|
|
2104
|
+
* </li>
|
|
2105
|
+
* <li>
|
|
2106
|
+
* <p>
|
|
2107
|
+
* <code>UNHEALTHY</code>
|
|
2108
|
+
* </p>
|
|
2109
|
+
* <ul>
|
|
2110
|
+
* <li>
|
|
2111
|
+
* <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p>
|
|
2112
|
+
* </li>
|
|
2113
|
+
* </ul>
|
|
2114
|
+
* </li>
|
|
2115
|
+
* </ul>
|
|
2116
|
+
* </li>
|
|
2117
|
+
* </ul>
|
|
2118
|
+
* @public
|
|
2119
|
+
*/
|
|
2120
|
+
eventStatus?: EventStatus | undefined;
|
|
2121
|
+
/**
|
|
2122
|
+
* <p>The aggregation type of the <code>NotificationConfiguration</code>.</p>
|
|
2123
|
+
* <ul>
|
|
2124
|
+
* <li>
|
|
2125
|
+
* <p>Values:</p>
|
|
2126
|
+
* <ul>
|
|
2127
|
+
* <li>
|
|
2128
|
+
* <p>
|
|
2129
|
+
* <code>AGGREGATE</code>
|
|
2130
|
+
* </p>
|
|
2131
|
+
* <ul>
|
|
2132
|
+
* <li>
|
|
2133
|
+
* <p>The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.</p>
|
|
2134
|
+
* </li>
|
|
2135
|
+
* </ul>
|
|
2136
|
+
* </li>
|
|
2137
|
+
* <li>
|
|
2138
|
+
* <p>
|
|
2139
|
+
* <code>CHILD</code>
|
|
2140
|
+
* </p>
|
|
2141
|
+
* <ul>
|
|
2142
|
+
* <li>
|
|
2143
|
+
* <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p>
|
|
2144
|
+
* </li>
|
|
2145
|
+
* </ul>
|
|
2146
|
+
* </li>
|
|
2147
|
+
* <li>
|
|
2148
|
+
* <p>
|
|
2149
|
+
* <code>NONE</code>
|
|
2150
|
+
* </p>
|
|
2151
|
+
* <ul>
|
|
2152
|
+
* <li>
|
|
2153
|
+
* <p>The notification isn't aggregated.</p>
|
|
2154
|
+
* </li>
|
|
2155
|
+
* </ul>
|
|
2156
|
+
* </li>
|
|
2157
|
+
* </ul>
|
|
2158
|
+
* </li>
|
|
2159
|
+
* </ul>
|
|
2160
|
+
* @public
|
|
2161
|
+
*/
|
|
2162
|
+
aggregationEventType?: AggregationEventType | undefined;
|
|
2163
|
+
/**
|
|
2164
|
+
* <p>If the value of <code>aggregationEventType</code> is not <code>NONE</code>, this is the
|
|
2165
|
+
* Amazon Resource Event (ARN) of the parent aggregate notification.</p>
|
|
2166
|
+
* <p>This is omitted if notification isn't aggregated.</p>
|
|
2167
|
+
* @public
|
|
2168
|
+
*/
|
|
2169
|
+
aggregateNotificationEventArn?: string | undefined;
|
|
2170
|
+
/**
|
|
2171
|
+
* <p>Provides additional information about how multiple notifications are grouped.</p>
|
|
2172
|
+
* @public
|
|
2173
|
+
*/
|
|
2174
|
+
aggregationSummary?: AggregationSummary | undefined;
|
|
2175
|
+
/**
|
|
2176
|
+
* <p>The notification event start time.</p>
|
|
2177
|
+
* @public
|
|
2178
|
+
*/
|
|
2179
|
+
startTime?: Date | undefined;
|
|
2180
|
+
/**
|
|
2181
|
+
* <p>The end time of the event.</p>
|
|
2182
|
+
* @public
|
|
2183
|
+
*/
|
|
2184
|
+
endTime?: Date | undefined;
|
|
2185
|
+
/**
|
|
2186
|
+
* <p>A list of text values.</p>
|
|
2187
|
+
* @public
|
|
2188
|
+
*/
|
|
2189
|
+
textParts: Record<string, TextPartValue> | undefined;
|
|
2190
|
+
/**
|
|
2191
|
+
* <p>A list of media elements.</p>
|
|
2192
|
+
* @public
|
|
2193
|
+
*/
|
|
2194
|
+
media: MediaElement[] | undefined;
|
|
2195
|
+
}
|
|
2196
|
+
/**
|
|
2197
|
+
* @public
|
|
2198
|
+
*/
|
|
2199
|
+
export interface GetNotificationEventResponse {
|
|
2200
|
+
/**
|
|
2201
|
+
* <p>The ARN of the resource.</p>
|
|
2202
|
+
* @public
|
|
2203
|
+
*/
|
|
2204
|
+
arn: string | undefined;
|
|
2205
|
+
/**
|
|
2206
|
+
* <p>The ARN of the <code>NotificationConfiguration</code>.</p>
|
|
2207
|
+
* @public
|
|
2208
|
+
*/
|
|
2209
|
+
notificationConfigurationArn: string | undefined;
|
|
2210
|
+
/**
|
|
2211
|
+
* <p>The creation time of the <code>NotificationEvent</code>.</p>
|
|
2212
|
+
* @public
|
|
2213
|
+
*/
|
|
2214
|
+
creationTime: Date | undefined;
|
|
2215
|
+
/**
|
|
2216
|
+
* <p>The content of the <code>NotificationEvent</code>.</p>
|
|
2217
|
+
* @public
|
|
2218
|
+
*/
|
|
2219
|
+
content: NotificationEventSchema | undefined;
|
|
2220
|
+
}
|
|
2221
|
+
/**
|
|
2222
|
+
* @public
|
|
2223
|
+
*/
|
|
2224
|
+
export interface GetNotificationsAccessForOrganizationRequest {
|
|
2225
|
+
}
|
|
2226
|
+
/**
|
|
2227
|
+
* <p>Orgs Service trust for User Notifications.</p>
|
|
2228
|
+
* @public
|
|
2229
|
+
*/
|
|
2230
|
+
export interface NotificationsAccessForOrganization {
|
|
2231
|
+
/**
|
|
2232
|
+
* <p>Access Status for the Orgs Service.</p>
|
|
2233
|
+
* @public
|
|
2234
|
+
*/
|
|
2235
|
+
accessStatus: AccessStatus | undefined;
|
|
2236
|
+
}
|
|
2237
|
+
/**
|
|
2238
|
+
* @public
|
|
2239
|
+
*/
|
|
2240
|
+
export interface GetNotificationsAccessForOrganizationResponse {
|
|
2241
|
+
/**
|
|
2242
|
+
* <p>The <code>AccessStatus</code> of Service Trust Enablement for User Notifications to Amazon Web Services Organizations.</p>
|
|
2243
|
+
* @public
|
|
2244
|
+
*/
|
|
2245
|
+
notificationsAccessForOrganization: NotificationsAccessForOrganization | undefined;
|
|
2246
|
+
}
|
|
2247
|
+
/**
|
|
2248
|
+
* @public
|
|
2249
|
+
*/
|
|
2250
|
+
export interface ListManagedNotificationChannelAssociationsRequest {
|
|
2251
|
+
/**
|
|
2252
|
+
* <p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code> to match.</p>
|
|
2253
|
+
* @public
|
|
2254
|
+
*/
|
|
2255
|
+
managedNotificationConfigurationArn: string | undefined;
|
|
2256
|
+
/**
|
|
2257
|
+
* <p>The maximum number of results to be returned in this call. Defaults to 20.</p>
|
|
2258
|
+
* @public
|
|
2259
|
+
*/
|
|
2260
|
+
maxResults?: number | undefined;
|
|
2261
|
+
/**
|
|
2262
|
+
* <p>The start token for paginated calls. Retrieved from the response of a previous <code>ListManagedNotificationChannelAssociations</code> call.</p>
|
|
2263
|
+
* @public
|
|
2264
|
+
*/
|
|
2265
|
+
nextToken?: string | undefined;
|
|
2266
|
+
}
|
|
2267
|
+
/**
|
|
2268
|
+
* <p>Provides a summary of channel associations for a managed notification configuration.</p>
|
|
2269
|
+
* @public
|
|
2270
|
+
*/
|
|
2271
|
+
export interface ManagedNotificationChannelAssociationSummary {
|
|
2272
|
+
/**
|
|
2273
|
+
* <p>The unique identifier for the notification channel.</p>
|
|
2274
|
+
* @public
|
|
2275
|
+
*/
|
|
2276
|
+
channelIdentifier: string | undefined;
|
|
2277
|
+
/**
|
|
2278
|
+
* <p>The type of notification channel used for message delivery.</p>
|
|
2279
|
+
* <ul>
|
|
2280
|
+
* <li>
|
|
2281
|
+
* <p>Values:</p>
|
|
2282
|
+
* <ul>
|
|
2283
|
+
* <li>
|
|
2284
|
+
* <p>
|
|
2285
|
+
* <code>ACCOUNT_CONTACT</code>
|
|
2286
|
+
* </p>
|
|
2287
|
+
* <ul>
|
|
2288
|
+
* <li>
|
|
2289
|
+
* <p>Delivers notifications to Account Managed contacts through the User Notification Service.</p>
|
|
2290
|
+
* </li>
|
|
2291
|
+
* </ul>
|
|
2292
|
+
* </li>
|
|
2293
|
+
* <li>
|
|
2294
|
+
* <p>
|
|
2295
|
+
* <code>MOBILE</code>
|
|
2296
|
+
* </p>
|
|
2297
|
+
* <ul>
|
|
2298
|
+
* <li>
|
|
2299
|
+
* <p>Delivers notifications through the Amazon Web Services Console Mobile Application to mobile devices.</p>
|
|
2300
|
+
* </li>
|
|
2301
|
+
* </ul>
|
|
2302
|
+
* </li>
|
|
2303
|
+
* <li>
|
|
2304
|
+
* <p>
|
|
2305
|
+
* <code>CHATBOT</code>
|
|
2306
|
+
* </p>
|
|
2307
|
+
* <ul>
|
|
2308
|
+
* <li>
|
|
2309
|
+
* <p>Delivers notifications through Chatbot to collaboration platforms (Slack, Chime).</p>
|
|
2310
|
+
* </li>
|
|
2311
|
+
* </ul>
|
|
2312
|
+
* </li>
|
|
2313
|
+
* <li>
|
|
2314
|
+
* <p>
|
|
2315
|
+
* <code>EMAIL</code>
|
|
2316
|
+
* </p>
|
|
2317
|
+
* <ul>
|
|
2318
|
+
* <li>
|
|
2319
|
+
* <p>Delivers notifications to email addresses.</p>
|
|
2320
|
+
* </li>
|
|
2321
|
+
* </ul>
|
|
2322
|
+
* </li>
|
|
2323
|
+
* </ul>
|
|
2324
|
+
* </li>
|
|
2325
|
+
* </ul>
|
|
2326
|
+
* @public
|
|
2327
|
+
*/
|
|
2328
|
+
channelType: ChannelType | undefined;
|
|
2329
|
+
/**
|
|
2330
|
+
* <p>Controls whether users can modify channel associations for a notification configuration.</p>
|
|
2331
|
+
* <ul>
|
|
2332
|
+
* <li>
|
|
2333
|
+
* <p>Values:</p>
|
|
2334
|
+
* <ul>
|
|
2335
|
+
* <li>
|
|
2336
|
+
* <p>
|
|
2337
|
+
* <code>ENABLED</code>
|
|
2338
|
+
* </p>
|
|
2339
|
+
* <ul>
|
|
2340
|
+
* <li>
|
|
2341
|
+
* <p>Users can associate or disassociate channels with the notification configuration.</p>
|
|
2342
|
+
* </li>
|
|
2343
|
+
* </ul>
|
|
2344
|
+
* </li>
|
|
2345
|
+
* <li>
|
|
2346
|
+
* <p>
|
|
2347
|
+
* <code>DISABLED</code>
|
|
2348
|
+
* </p>
|
|
2349
|
+
* <ul>
|
|
2350
|
+
* <li>
|
|
2351
|
+
* <p>Users cannot associate or disassociate channels with the notification configuration.</p>
|
|
2352
|
+
* </li>
|
|
2353
|
+
* </ul>
|
|
2354
|
+
* </li>
|
|
2355
|
+
* </ul>
|
|
2356
|
+
* </li>
|
|
2357
|
+
* </ul>
|
|
2358
|
+
* @public
|
|
2359
|
+
*/
|
|
2360
|
+
overrideOption?: ChannelAssociationOverrideOption | undefined;
|
|
2361
|
+
}
|
|
2362
|
+
/**
|
|
2363
|
+
* @public
|
|
2364
|
+
*/
|
|
2365
|
+
export interface ListManagedNotificationChannelAssociationsResponse {
|
|
2366
|
+
/**
|
|
2367
|
+
* <p>A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.</p>
|
|
2368
|
+
* @public
|
|
2369
|
+
*/
|
|
2370
|
+
nextToken?: string | undefined;
|
|
2371
|
+
/**
|
|
2372
|
+
* <p>A list that contains the following information about a channel association.</p>
|
|
2373
|
+
* @public
|
|
2374
|
+
*/
|
|
2375
|
+
channelAssociations: ManagedNotificationChannelAssociationSummary[] | undefined;
|
|
2376
|
+
}
|
|
2377
|
+
/**
|
|
2378
|
+
* @public
|
|
2379
|
+
*/
|
|
2380
|
+
export interface ListManagedNotificationChildEventsRequest {
|
|
2381
|
+
/**
|
|
2382
|
+
* <p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationEvent</code>.</p>
|
|
2383
|
+
* @public
|
|
2384
|
+
*/
|
|
2385
|
+
aggregateManagedNotificationEventArn: string | undefined;
|
|
2386
|
+
/**
|
|
2387
|
+
* <p>The earliest time of events to return from this call.</p>
|
|
2388
|
+
* @public
|
|
2389
|
+
*/
|
|
2390
|
+
startTime?: Date | undefined;
|
|
2391
|
+
/**
|
|
2392
|
+
* <p>Latest time of events to return from this call.</p>
|
|
2393
|
+
* @public
|
|
2394
|
+
*/
|
|
2395
|
+
endTime?: Date | undefined;
|
|
2396
|
+
/**
|
|
2397
|
+
* <p>The locale code of the language used for the retrieved <code>NotificationEvent</code>. The default locale is English.<code>en_US</code>.</p>
|
|
2398
|
+
* @public
|
|
2399
|
+
*/
|
|
2400
|
+
locale?: LocaleCode | undefined;
|
|
2401
|
+
/**
|
|
2402
|
+
* <p>The maximum number of results to be returned in this call. Defaults to 20.</p>
|
|
2403
|
+
* @public
|
|
2404
|
+
*/
|
|
2405
|
+
maxResults?: number | undefined;
|
|
2406
|
+
/**
|
|
2407
|
+
* <p>The Amazon Web Services account ID associated with the Managed Notification Child Events.</p>
|
|
2408
|
+
* @public
|
|
2409
|
+
*/
|
|
2410
|
+
relatedAccount?: string | undefined;
|
|
2411
|
+
/**
|
|
2412
|
+
* <p>The identifier of the Amazon Web Services Organizations organizational unit (OU) associated with the Managed Notification Child Events.</p>
|
|
2413
|
+
* @public
|
|
2414
|
+
*/
|
|
2415
|
+
organizationalUnitId?: string | undefined;
|
|
2416
|
+
/**
|
|
2417
|
+
* <p>The start token for paginated calls. Retrieved from the response of a previous ListManagedNotificationChannelAssociations call. Next token uses Base64 encoding.</p>
|
|
2418
|
+
* @public
|
|
2419
|
+
*/
|
|
2420
|
+
nextToken?: string | undefined;
|
|
2421
|
+
}
|
|
2422
|
+
/**
|
|
2423
|
+
* <p>Contains the headline message component.</p>
|
|
2424
|
+
* @public
|
|
2425
|
+
*/
|
|
2426
|
+
export interface MessageComponentsSummary {
|
|
2427
|
+
/**
|
|
2428
|
+
* <p>A sentence long summary. For example, titles or an email subject line.</p>
|
|
2429
|
+
* @public
|
|
2430
|
+
*/
|
|
2431
|
+
headline: string | undefined;
|
|
2432
|
+
}
|
|
2433
|
+
/**
|
|
2434
|
+
* <p>A short summary and metadata for a managed notification event.</p>
|
|
2435
|
+
* @public
|
|
2436
|
+
*/
|
|
2437
|
+
export interface ManagedSourceEventMetadataSummary {
|
|
2438
|
+
/**
|
|
2439
|
+
* <p>The Region where the notification originated.</p>
|
|
2440
|
+
* @public
|
|
2441
|
+
*/
|
|
2442
|
+
eventOriginRegion?: string | undefined;
|
|
2443
|
+
/**
|
|
2444
|
+
* <p>The source service of the notification.</p>
|
|
2445
|
+
* <p>Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
2446
|
+
* @public
|
|
2447
|
+
*/
|
|
2448
|
+
source: string | undefined;
|
|
2449
|
+
/**
|
|
2450
|
+
* <p>The event Type of the notification.</p>
|
|
2451
|
+
* @public
|
|
2452
|
+
*/
|
|
2453
|
+
eventType: string | undefined;
|
|
2454
|
+
}
|
|
2455
|
+
/**
|
|
2456
|
+
* <p>Describes a short summary and metadata for a <code>ManagedNotificationChildEvent</code>.</p>
|
|
2457
|
+
* @public
|
|
2458
|
+
*/
|
|
2459
|
+
export interface ManagedNotificationChildEventSummary {
|
|
2460
|
+
/**
|
|
2461
|
+
* <p>The schema version of the <code>ManagedNotificationChildEvent</code>.</p>
|
|
2462
|
+
* @public
|
|
2463
|
+
*/
|
|
2464
|
+
schemaVersion: SchemaVersion | undefined;
|
|
2465
|
+
/**
|
|
2466
|
+
* <p>Contains all event metadata present identically across all <code>NotificationEvents</code>. All fields are present in Source Events via Eventbridge.</p>
|
|
2467
|
+
* @public
|
|
2468
|
+
*/
|
|
2469
|
+
sourceEventMetadata: ManagedSourceEventMetadataSummary | undefined;
|
|
2470
|
+
/**
|
|
2471
|
+
* <p>Contains the headline message component.</p>
|
|
2472
|
+
* @public
|
|
2473
|
+
*/
|
|
2474
|
+
messageComponents: MessageComponentsSummary | undefined;
|
|
2475
|
+
/**
|
|
2476
|
+
* <p>Provides detailed information about the dimensions used for event summarization and aggregation.</p>
|
|
2477
|
+
* @public
|
|
2478
|
+
*/
|
|
2479
|
+
aggregationDetail: AggregationDetail | undefined;
|
|
2480
|
+
/**
|
|
2481
|
+
* <p>The perceived nature of the event.</p>
|
|
2482
|
+
* <ul>
|
|
2483
|
+
* <li>
|
|
2484
|
+
* <p>Values:</p>
|
|
2485
|
+
* <ul>
|
|
2486
|
+
* <li>
|
|
2487
|
+
* <p>
|
|
2488
|
+
* <code>HEALTHY</code>
|
|
2489
|
+
* </p>
|
|
2490
|
+
* <ul>
|
|
2491
|
+
* <li>
|
|
2492
|
+
* <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p>
|
|
2493
|
+
* </li>
|
|
2494
|
+
* </ul>
|
|
2495
|
+
* </li>
|
|
2496
|
+
* <li>
|
|
2497
|
+
* <p>
|
|
2498
|
+
* <code>UNHEALTHY</code>
|
|
2499
|
+
* </p>
|
|
2500
|
+
* <ul>
|
|
2501
|
+
* <li>
|
|
2502
|
+
* <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p>
|
|
2503
|
+
* </li>
|
|
2504
|
+
* </ul>
|
|
2505
|
+
* </li>
|
|
2506
|
+
* </ul>
|
|
2507
|
+
* </li>
|
|
2508
|
+
* </ul>
|
|
2509
|
+
* @public
|
|
2510
|
+
*/
|
|
2511
|
+
eventStatus: EventStatus | undefined;
|
|
2512
|
+
/**
|
|
2513
|
+
* <p>The Type of the event causing this notification.</p>
|
|
2514
|
+
* <ul>
|
|
2515
|
+
* <li>
|
|
2516
|
+
* <p>Values:</p>
|
|
2517
|
+
* <ul>
|
|
2518
|
+
* <li>
|
|
2519
|
+
* <p>
|
|
2520
|
+
* <code>ALERT</code>
|
|
2521
|
+
* </p>
|
|
2522
|
+
* <ul>
|
|
2523
|
+
* <li>
|
|
2524
|
+
* <p>A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.</p>
|
|
2525
|
+
* </li>
|
|
2526
|
+
* </ul>
|
|
2527
|
+
* </li>
|
|
2528
|
+
* <li>
|
|
2529
|
+
* <p>
|
|
2530
|
+
* <code>WARNING</code>
|
|
2531
|
+
* </p>
|
|
2532
|
+
* <ul>
|
|
2533
|
+
* <li>
|
|
2534
|
+
* <p>A notification about an event where an issue is about to arise. For example, something is approaching a threshold.</p>
|
|
2535
|
+
* </li>
|
|
2536
|
+
* </ul>
|
|
2537
|
+
* </li>
|
|
2538
|
+
* <li>
|
|
2539
|
+
* <p>
|
|
2540
|
+
* <code>ANNOUNCEMENT</code>
|
|
2541
|
+
* </p>
|
|
2542
|
+
* <ul>
|
|
2543
|
+
* <li>
|
|
2544
|
+
* <p>A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.</p>
|
|
2545
|
+
* </li>
|
|
2546
|
+
* </ul>
|
|
2547
|
+
* </li>
|
|
2548
|
+
* <li>
|
|
2549
|
+
* <p>
|
|
2550
|
+
* <code>INFORMATIONAL</code>
|
|
2551
|
+
* </p>
|
|
2552
|
+
* <ul>
|
|
2553
|
+
* <li>
|
|
2554
|
+
* <p>A notification about informational messages. For example, recommendations, service announcements, or reminders.</p>
|
|
2555
|
+
* </li>
|
|
2556
|
+
* </ul>
|
|
2557
|
+
* </li>
|
|
2558
|
+
* </ul>
|
|
2559
|
+
* </li>
|
|
2560
|
+
* </ul>
|
|
2561
|
+
* @public
|
|
2562
|
+
*/
|
|
2563
|
+
notificationType: NotificationType | undefined;
|
|
2564
|
+
}
|
|
2565
|
+
/**
|
|
2566
|
+
* <p>Describes an overview and metadata for a <code>ManagedNotificationChildEvent</code>.</p>
|
|
2567
|
+
* @public
|
|
2568
|
+
*/
|
|
2569
|
+
export interface ManagedNotificationChildEventOverview {
|
|
2570
|
+
/**
|
|
2571
|
+
* <p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationChildEvent</code>.</p>
|
|
2572
|
+
* @public
|
|
2573
|
+
*/
|
|
2574
|
+
arn: string | undefined;
|
|
2575
|
+
/**
|
|
2576
|
+
* <p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code>.</p>
|
|
2577
|
+
* @public
|
|
2578
|
+
*/
|
|
2579
|
+
managedNotificationConfigurationArn: string | undefined;
|
|
2580
|
+
/**
|
|
2581
|
+
* <p>The account that related to the <code>ManagedNotificationChildEvent</code>.</p>
|
|
2582
|
+
* @public
|
|
2583
|
+
*/
|
|
2584
|
+
relatedAccount: string | undefined;
|
|
2585
|
+
/**
|
|
2586
|
+
* <p>The creation time of the <code>ManagedNotificationChildEvent</code>.</p>
|
|
2587
|
+
* @public
|
|
2588
|
+
*/
|
|
2589
|
+
creationTime: Date | undefined;
|
|
2590
|
+
/**
|
|
2591
|
+
* <p>The content of the <code>ManagedNotificationChildEvent</code>.</p>
|
|
2592
|
+
* @public
|
|
2593
|
+
*/
|
|
2594
|
+
childEvent: ManagedNotificationChildEventSummary | undefined;
|
|
2595
|
+
/**
|
|
2596
|
+
* <p>The Amazon Resource Name (ARN) of the ManagedNotificationEvent that is associated with this <code>ManagedNotificationChildEvent</code>.</p>
|
|
2597
|
+
* @public
|
|
2598
|
+
*/
|
|
2599
|
+
aggregateManagedNotificationEventArn: string | undefined;
|
|
2600
|
+
/**
|
|
2601
|
+
* <p>The Organizational Unit Id that an AWS account belongs to.</p>
|
|
2602
|
+
* @public
|
|
2603
|
+
*/
|
|
2604
|
+
organizationalUnitId?: string | undefined;
|
|
2605
|
+
}
|
|
2606
|
+
/**
|
|
2607
|
+
* @public
|
|
2608
|
+
*/
|
|
2609
|
+
export interface ListManagedNotificationChildEventsResponse {
|
|
2610
|
+
/**
|
|
2611
|
+
* <p>A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.</p>
|
|
2612
|
+
* @public
|
|
2613
|
+
*/
|
|
2614
|
+
nextToken?: string | undefined;
|
|
2615
|
+
/**
|
|
2616
|
+
* <p>A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.</p>
|
|
2617
|
+
* @public
|
|
2618
|
+
*/
|
|
2619
|
+
managedNotificationChildEvents: ManagedNotificationChildEventOverview[] | undefined;
|
|
2620
|
+
}
|
|
2621
|
+
/**
|
|
2622
|
+
* @public
|
|
2623
|
+
*/
|
|
2624
|
+
export interface ListManagedNotificationConfigurationsRequest {
|
|
2625
|
+
/**
|
|
2626
|
+
* <p>The identifier or ARN of the notification channel to filter configurations by.</p>
|
|
2627
|
+
* @public
|
|
2628
|
+
*/
|
|
2629
|
+
channelIdentifier?: string | undefined;
|
|
2630
|
+
/**
|
|
2631
|
+
* <p>The maximum number of results to be returned in this call. Defaults to 20.</p>
|
|
2632
|
+
* @public
|
|
2633
|
+
*/
|
|
2634
|
+
maxResults?: number | undefined;
|
|
2635
|
+
/**
|
|
2636
|
+
* <p>The start token for paginated calls. Retrieved from the response of a previous ListManagedNotificationChannelAssociations call. Next token uses Base64 encoding.</p>
|
|
2637
|
+
* @public
|
|
2638
|
+
*/
|
|
2639
|
+
nextToken?: string | undefined;
|
|
2640
|
+
}
|
|
2641
|
+
/**
|
|
2642
|
+
* <p>Describes the basic structure and properties of a <code>ManagedNotificationConfiguration</code>.</p>
|
|
2643
|
+
* @public
|
|
2644
|
+
*/
|
|
2645
|
+
export interface ManagedNotificationConfigurationStructure {
|
|
2646
|
+
/**
|
|
2647
|
+
* <p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code>.</p>
|
|
2648
|
+
* @public
|
|
2649
|
+
*/
|
|
2650
|
+
arn: string | undefined;
|
|
2651
|
+
/**
|
|
2652
|
+
* <p>The name of the <code>ManagedNotificationConfiguration</code>.</p>
|
|
2653
|
+
* @public
|
|
2654
|
+
*/
|
|
2655
|
+
name: string | undefined;
|
|
2656
|
+
/**
|
|
2657
|
+
* <p>The description of the <code>ManagedNotificationConfiguration</code>.</p>
|
|
2658
|
+
* @public
|
|
2659
|
+
*/
|
|
2660
|
+
description: string | undefined;
|
|
2661
|
+
}
|
|
2662
|
+
/**
|
|
2663
|
+
* @public
|
|
2664
|
+
*/
|
|
2665
|
+
export interface ListManagedNotificationConfigurationsResponse {
|
|
2666
|
+
/**
|
|
2667
|
+
* <p>A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.</p>
|
|
2668
|
+
* @public
|
|
2669
|
+
*/
|
|
2670
|
+
nextToken?: string | undefined;
|
|
1348
2671
|
/**
|
|
1349
|
-
* <p>A list of
|
|
2672
|
+
* <p>A list of Managed Notification Configurations matching the request criteria.</p>
|
|
1350
2673
|
* @public
|
|
1351
2674
|
*/
|
|
1352
|
-
|
|
2675
|
+
managedNotificationConfigurations: ManagedNotificationConfigurationStructure[] | undefined;
|
|
1353
2676
|
}
|
|
1354
2677
|
/**
|
|
1355
|
-
* @public
|
|
1356
|
-
* @enum
|
|
1357
|
-
*/
|
|
1358
|
-
export declare const TextPartType: {
|
|
1359
|
-
readonly LOCALIZED_TEXT: "LOCALIZED_TEXT";
|
|
1360
|
-
readonly PLAIN_TEXT: "PLAIN_TEXT";
|
|
1361
|
-
readonly URL: "URL";
|
|
1362
|
-
};
|
|
1363
|
-
/**
|
|
1364
|
-
* @public
|
|
1365
|
-
*/
|
|
1366
|
-
export type TextPartType = (typeof TextPartType)[keyof typeof TextPartType];
|
|
1367
|
-
/**
|
|
1368
|
-
* <p>Describes text information objects containing fields that determine how text part objects are composed.</p>
|
|
1369
2678
|
* @public
|
|
1370
2679
|
*/
|
|
1371
|
-
export interface
|
|
2680
|
+
export interface ListManagedNotificationEventsRequest {
|
|
1372
2681
|
/**
|
|
1373
|
-
* <p>The
|
|
2682
|
+
* <p>The earliest time of events to return from this call.</p>
|
|
1374
2683
|
* @public
|
|
1375
2684
|
*/
|
|
1376
|
-
|
|
2685
|
+
startTime?: Date | undefined;
|
|
1377
2686
|
/**
|
|
1378
|
-
* <p>
|
|
1379
|
-
* <p>Used for text parts with the type <code>URL</code>.</p>
|
|
2687
|
+
* <p>Latest time of events to return from this call.</p>
|
|
1380
2688
|
* @public
|
|
1381
2689
|
*/
|
|
1382
|
-
|
|
2690
|
+
endTime?: Date | undefined;
|
|
1383
2691
|
/**
|
|
1384
|
-
* <p>
|
|
2692
|
+
* <p>The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US).</p>
|
|
1385
2693
|
* @public
|
|
1386
2694
|
*/
|
|
1387
|
-
|
|
2695
|
+
locale?: LocaleCode | undefined;
|
|
1388
2696
|
/**
|
|
1389
|
-
* <p>The
|
|
2697
|
+
* <p>The Amazon Web Services service the event originates from. For example aws.cloudwatch.</p>
|
|
1390
2698
|
* @public
|
|
1391
2699
|
*/
|
|
1392
|
-
|
|
1393
|
-
}
|
|
1394
|
-
/**
|
|
1395
|
-
* <p>A NotificationEvent is a notification-focused representation of an event. They contain semantic information used by Channels to create end-user notifications.</p>
|
|
1396
|
-
* @public
|
|
1397
|
-
*/
|
|
1398
|
-
export interface NotificationEventSchema {
|
|
2700
|
+
source?: string | undefined;
|
|
1399
2701
|
/**
|
|
1400
|
-
* <p>The
|
|
2702
|
+
* <p>The maximum number of results to be returned in this call. Defaults to 20.</p>
|
|
1401
2703
|
* @public
|
|
1402
2704
|
*/
|
|
1403
|
-
|
|
2705
|
+
maxResults?: number | undefined;
|
|
1404
2706
|
/**
|
|
1405
|
-
* <p>The
|
|
2707
|
+
* <p>The start token for paginated calls. Retrieved from the response of a previous <code>ListManagedNotificationChannelAssociations</code> call. Next token uses Base64 encoding.</p>
|
|
1406
2708
|
* @public
|
|
1407
2709
|
*/
|
|
1408
|
-
|
|
2710
|
+
nextToken?: string | undefined;
|
|
1409
2711
|
/**
|
|
1410
|
-
* <p>The
|
|
2712
|
+
* <p>The Organizational Unit Id that an Amazon Web Services account belongs to.</p>
|
|
1411
2713
|
* @public
|
|
1412
2714
|
*/
|
|
1413
|
-
|
|
2715
|
+
organizationalUnitId?: string | undefined;
|
|
1414
2716
|
/**
|
|
1415
|
-
* <p>
|
|
2717
|
+
* <p>The Amazon Web Services account ID associated with the Managed Notification Events.</p>
|
|
1416
2718
|
* @public
|
|
1417
2719
|
*/
|
|
1418
|
-
|
|
2720
|
+
relatedAccount?: string | undefined;
|
|
2721
|
+
}
|
|
2722
|
+
/**
|
|
2723
|
+
* <p>A short summary of a <code>ManagedNotificationEvent</code>. This is only used when listing managed notification events.</p>
|
|
2724
|
+
* @public
|
|
2725
|
+
*/
|
|
2726
|
+
export interface ManagedNotificationEventSummary {
|
|
1419
2727
|
/**
|
|
1420
|
-
* <p>The
|
|
2728
|
+
* <p>The schema version of the <code>ManagedNotificationEvent</code>.</p>
|
|
1421
2729
|
* @public
|
|
1422
2730
|
*/
|
|
1423
|
-
|
|
2731
|
+
schemaVersion: SchemaVersion | undefined;
|
|
1424
2732
|
/**
|
|
1425
|
-
* <p>
|
|
2733
|
+
* <p>Contains metadata about the event that caused the <code>ManagedNotificationEvent</code>.</p>
|
|
1426
2734
|
* @public
|
|
1427
2735
|
*/
|
|
1428
|
-
|
|
2736
|
+
sourceEventMetadata: ManagedSourceEventMetadataSummary | undefined;
|
|
1429
2737
|
/**
|
|
1430
|
-
* <p>
|
|
2738
|
+
* <p>Contains the headline message component.</p>
|
|
2739
|
+
* @public
|
|
2740
|
+
*/
|
|
2741
|
+
messageComponents: MessageComponentsSummary | undefined;
|
|
2742
|
+
/**
|
|
2743
|
+
* <p>The managed notification event status.</p>
|
|
1431
2744
|
* <ul>
|
|
1432
2745
|
* <li>
|
|
1433
2746
|
* <p>Values:</p>
|
|
1434
2747
|
* <ul>
|
|
1435
2748
|
* <li>
|
|
1436
2749
|
* <p>
|
|
1437
|
-
* <code>
|
|
2750
|
+
* <code>HEALTHY</code>
|
|
1438
2751
|
* </p>
|
|
1439
2752
|
* <ul>
|
|
1440
2753
|
* <li>
|
|
1441
|
-
* <p>
|
|
2754
|
+
* <p>All <code>EventRules</code> are <code>ACTIVE</code>.</p>
|
|
1442
2755
|
* </li>
|
|
1443
2756
|
* </ul>
|
|
1444
2757
|
* </li>
|
|
1445
2758
|
* <li>
|
|
1446
2759
|
* <p>
|
|
1447
|
-
* <code>
|
|
2760
|
+
* <code>UNHEALTHY</code>
|
|
1448
2761
|
* </p>
|
|
1449
2762
|
* <ul>
|
|
1450
2763
|
* <li>
|
|
1451
|
-
* <p>
|
|
2764
|
+
* <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>.</p>
|
|
1452
2765
|
* </li>
|
|
1453
2766
|
* </ul>
|
|
1454
2767
|
* </li>
|
|
2768
|
+
* </ul>
|
|
2769
|
+
* </li>
|
|
2770
|
+
* </ul>
|
|
2771
|
+
* @public
|
|
2772
|
+
*/
|
|
2773
|
+
eventStatus: EventStatus | undefined;
|
|
2774
|
+
/**
|
|
2775
|
+
* <p>The Type of event causing the notification.</p>
|
|
2776
|
+
* <ul>
|
|
2777
|
+
* <li>
|
|
2778
|
+
* <p>Values:</p>
|
|
2779
|
+
* <ul>
|
|
1455
2780
|
* <li>
|
|
1456
2781
|
* <p>
|
|
1457
|
-
* <code>
|
|
2782
|
+
* <code>ALERT</code>
|
|
1458
2783
|
* </p>
|
|
1459
2784
|
* <ul>
|
|
1460
2785
|
* <li>
|
|
1461
|
-
* <p>A notification about an
|
|
2786
|
+
* <p>A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.</p>
|
|
1462
2787
|
* </li>
|
|
1463
2788
|
* </ul>
|
|
1464
2789
|
* </li>
|
|
1465
2790
|
* <li>
|
|
1466
2791
|
* <p>
|
|
1467
|
-
* <code>
|
|
2792
|
+
* <code>WARNING</code>
|
|
1468
2793
|
* </p>
|
|
1469
2794
|
* <ul>
|
|
1470
2795
|
* <li>
|
|
1471
|
-
* <p>A notification about
|
|
2796
|
+
* <p>A notification about an event where an issue is about to arise. For example, something is approaching a threshold.</p>
|
|
1472
2797
|
* </li>
|
|
1473
2798
|
* </ul>
|
|
1474
2799
|
* </li>
|
|
1475
|
-
* </ul>
|
|
1476
|
-
* </li>
|
|
1477
|
-
* </ul>
|
|
1478
|
-
* @public
|
|
1479
|
-
*/
|
|
1480
|
-
notificationType: NotificationType | undefined;
|
|
1481
|
-
/**
|
|
1482
|
-
* <p>The assesed nature of the event.</p>
|
|
1483
|
-
* <ul>
|
|
1484
|
-
* <li>
|
|
1485
|
-
* <p>Values:</p>
|
|
1486
|
-
* <ul>
|
|
1487
2800
|
* <li>
|
|
1488
2801
|
* <p>
|
|
1489
|
-
* <code>
|
|
2802
|
+
* <code>ANNOUNCEMENT</code>
|
|
1490
2803
|
* </p>
|
|
1491
2804
|
* <ul>
|
|
1492
2805
|
* <li>
|
|
1493
|
-
* <p>
|
|
2806
|
+
* <p>A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.</p>
|
|
1494
2807
|
* </li>
|
|
1495
2808
|
* </ul>
|
|
1496
2809
|
* </li>
|
|
1497
2810
|
* <li>
|
|
1498
2811
|
* <p>
|
|
1499
|
-
* <code>
|
|
2812
|
+
* <code>INFORMATIONAL</code>
|
|
1500
2813
|
* </p>
|
|
1501
2814
|
* <ul>
|
|
1502
2815
|
* <li>
|
|
1503
|
-
* <p>
|
|
2816
|
+
* <p>A notification about informational messages. For example, recommendations, service announcements, or reminders.</p>
|
|
1504
2817
|
* </li>
|
|
1505
2818
|
* </ul>
|
|
1506
2819
|
* </li>
|
|
@@ -1509,9 +2822,40 @@ export interface NotificationEventSchema {
|
|
|
1509
2822
|
* </ul>
|
|
1510
2823
|
* @public
|
|
1511
2824
|
*/
|
|
1512
|
-
|
|
2825
|
+
notificationType: NotificationType | undefined;
|
|
2826
|
+
}
|
|
2827
|
+
/**
|
|
2828
|
+
* <p>Describes an overview and metadata for a ManagedNotificationEvent.</p>
|
|
2829
|
+
* @public
|
|
2830
|
+
*/
|
|
2831
|
+
export interface ManagedNotificationEventOverview {
|
|
2832
|
+
/**
|
|
2833
|
+
* <p>The Amazon Resource Name (ARN) of the ManagedNotificationEvent.</p>
|
|
2834
|
+
* @public
|
|
2835
|
+
*/
|
|
2836
|
+
arn: string | undefined;
|
|
2837
|
+
/**
|
|
2838
|
+
* <p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code>.</p>
|
|
2839
|
+
* @public
|
|
2840
|
+
*/
|
|
2841
|
+
managedNotificationConfigurationArn: string | undefined;
|
|
2842
|
+
/**
|
|
2843
|
+
* <p>The account that related to the <code>ManagedNotificationEvent</code>.</p>
|
|
2844
|
+
* @public
|
|
2845
|
+
*/
|
|
2846
|
+
relatedAccount: string | undefined;
|
|
2847
|
+
/**
|
|
2848
|
+
* <p>The creation time of the <code>ManagedNotificationEvent</code>.</p>
|
|
2849
|
+
* @public
|
|
2850
|
+
*/
|
|
2851
|
+
creationTime: Date | undefined;
|
|
2852
|
+
/**
|
|
2853
|
+
* <p>A short summary of a <code>ManagedNotificationEvent</code>. This is only used when listing managed notification events.</p>
|
|
2854
|
+
* @public
|
|
2855
|
+
*/
|
|
2856
|
+
notificationEvent: ManagedNotificationEventSummary | undefined;
|
|
1513
2857
|
/**
|
|
1514
|
-
* <p>The
|
|
2858
|
+
* <p>The notifications aggregation type.</p>
|
|
1515
2859
|
* <ul>
|
|
1516
2860
|
* <li>
|
|
1517
2861
|
* <p>Values:</p>
|
|
@@ -1532,7 +2876,7 @@ export interface NotificationEventSchema {
|
|
|
1532
2876
|
* </p>
|
|
1533
2877
|
* <ul>
|
|
1534
2878
|
* <li>
|
|
1535
|
-
* <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p>
|
|
2879
|
+
* <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p>
|
|
1536
2880
|
* </li>
|
|
1537
2881
|
* </ul>
|
|
1538
2882
|
* </li>
|
|
@@ -1553,56 +2897,35 @@ export interface NotificationEventSchema {
|
|
|
1553
2897
|
*/
|
|
1554
2898
|
aggregationEventType?: AggregationEventType | undefined;
|
|
1555
2899
|
/**
|
|
1556
|
-
* <p>
|
|
1557
|
-
* <p>This is omitted if notification isn't aggregated.</p>
|
|
1558
|
-
* @public
|
|
1559
|
-
*/
|
|
1560
|
-
aggregateNotificationEventArn?: string | undefined;
|
|
1561
|
-
/**
|
|
1562
|
-
* <p>The notification event start time.</p>
|
|
1563
|
-
* @public
|
|
1564
|
-
*/
|
|
1565
|
-
startTime?: Date | undefined;
|
|
1566
|
-
/**
|
|
1567
|
-
* <p>The end time of the event.</p>
|
|
2900
|
+
* <p>The Organizational Unit Id that an Amazon Web Services account belongs to.</p>
|
|
1568
2901
|
* @public
|
|
1569
2902
|
*/
|
|
1570
|
-
|
|
2903
|
+
organizationalUnitId?: string | undefined;
|
|
1571
2904
|
/**
|
|
1572
|
-
* <p>
|
|
2905
|
+
* <p>Provides additional information about the aggregation key.</p>
|
|
1573
2906
|
* @public
|
|
1574
2907
|
*/
|
|
1575
|
-
|
|
2908
|
+
aggregationSummary?: AggregationSummary | undefined;
|
|
1576
2909
|
/**
|
|
1577
|
-
* <p>
|
|
2910
|
+
* <p>The list of the regions where the aggregated notifications in this <code>NotificationEvent</code> originated.</p>
|
|
1578
2911
|
* @public
|
|
1579
2912
|
*/
|
|
1580
|
-
|
|
2913
|
+
aggregatedNotificationRegions?: string[] | undefined;
|
|
1581
2914
|
}
|
|
1582
2915
|
/**
|
|
1583
2916
|
* @public
|
|
1584
2917
|
*/
|
|
1585
|
-
export interface
|
|
1586
|
-
/**
|
|
1587
|
-
* <p>The ARN of the resource.</p>
|
|
1588
|
-
* @public
|
|
1589
|
-
*/
|
|
1590
|
-
arn: string | undefined;
|
|
2918
|
+
export interface ListManagedNotificationEventsResponse {
|
|
1591
2919
|
/**
|
|
1592
|
-
* <p>
|
|
1593
|
-
* @public
|
|
1594
|
-
*/
|
|
1595
|
-
notificationConfigurationArn: string | undefined;
|
|
1596
|
-
/**
|
|
1597
|
-
* <p>The creation time of the NotificationEvent.</p>
|
|
2920
|
+
* <p>A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.</p>
|
|
1598
2921
|
* @public
|
|
1599
2922
|
*/
|
|
1600
|
-
|
|
2923
|
+
nextToken?: string | undefined;
|
|
1601
2924
|
/**
|
|
1602
|
-
* <p>
|
|
2925
|
+
* <p>A list of Managed Notification Events matching the request criteria.</p>
|
|
1603
2926
|
* @public
|
|
1604
2927
|
*/
|
|
1605
|
-
|
|
2928
|
+
managedNotificationEvents: ManagedNotificationEventOverview[] | undefined;
|
|
1606
2929
|
}
|
|
1607
2930
|
/**
|
|
1608
2931
|
* @public
|
|
@@ -1610,7 +2933,7 @@ export interface GetNotificationEventResponse {
|
|
|
1610
2933
|
export interface ListNotificationConfigurationsRequest {
|
|
1611
2934
|
/**
|
|
1612
2935
|
* <p>The matched event source.</p>
|
|
1613
|
-
* <p>Must match one of the valid EventBridge sources. Only
|
|
2936
|
+
* <p>Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1614
2937
|
* @public
|
|
1615
2938
|
*/
|
|
1616
2939
|
eventRuleSource?: string | undefined;
|
|
@@ -1620,7 +2943,7 @@ export interface ListNotificationConfigurationsRequest {
|
|
|
1620
2943
|
*/
|
|
1621
2944
|
channelArn?: string | undefined;
|
|
1622
2945
|
/**
|
|
1623
|
-
* <p>The NotificationConfiguration status to match.</p>
|
|
2946
|
+
* <p>The <code>NotificationConfiguration</code> status to match.</p>
|
|
1624
2947
|
* <ul>
|
|
1625
2948
|
* <li>
|
|
1626
2949
|
* <p>Values:</p>
|
|
@@ -1631,7 +2954,7 @@ export interface ListNotificationConfigurationsRequest {
|
|
|
1631
2954
|
* </p>
|
|
1632
2955
|
* <ul>
|
|
1633
2956
|
* <li>
|
|
1634
|
-
* <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p>
|
|
2957
|
+
* <p>All <code>EventRules</code> are <code>ACTIVE</code> and any call can be run.</p>
|
|
1635
2958
|
* </li>
|
|
1636
2959
|
* </ul>
|
|
1637
2960
|
* </li>
|
|
@@ -1641,7 +2964,7 @@ export interface ListNotificationConfigurationsRequest {
|
|
|
1641
2964
|
* </p>
|
|
1642
2965
|
* <ul>
|
|
1643
2966
|
* <li>
|
|
1644
|
-
* <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p>
|
|
2967
|
+
* <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p>
|
|
1645
2968
|
* </li>
|
|
1646
2969
|
* <li>
|
|
1647
2970
|
* <p>Any call can be run.</p>
|
|
@@ -1654,7 +2977,7 @@ export interface ListNotificationConfigurationsRequest {
|
|
|
1654
2977
|
* </p>
|
|
1655
2978
|
* <ul>
|
|
1656
2979
|
* <li>
|
|
1657
|
-
* <p>All EventRules are <code>INACTIVE</code> and any call can be run.</p>
|
|
2980
|
+
* <p>All <code>EventRules</code> are <code>INACTIVE</code> and any call can be run.</p>
|
|
1658
2981
|
* </li>
|
|
1659
2982
|
* </ul>
|
|
1660
2983
|
* </li>
|
|
@@ -1664,7 +2987,7 @@ export interface ListNotificationConfigurationsRequest {
|
|
|
1664
2987
|
* </p>
|
|
1665
2988
|
* <ul>
|
|
1666
2989
|
* <li>
|
|
1667
|
-
* <p>This NotificationConfiguration is being deleted.</p>
|
|
2990
|
+
* <p>This <code>NotificationConfiguration</code> is being deleted.</p>
|
|
1668
2991
|
* </li>
|
|
1669
2992
|
* <li>
|
|
1670
2993
|
* <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p>
|
|
@@ -1683,7 +3006,8 @@ export interface ListNotificationConfigurationsRequest {
|
|
|
1683
3006
|
*/
|
|
1684
3007
|
maxResults?: number | undefined;
|
|
1685
3008
|
/**
|
|
1686
|
-
* <p>The start token for paginated calls. Retrieved from the response of a previous
|
|
3009
|
+
* <p>The start token for paginated calls. Retrieved from the response of a previous
|
|
3010
|
+
* <code>ListEventRules</code> call. Next token uses Base64 encoding.</p>
|
|
1687
3011
|
* @public
|
|
1688
3012
|
*/
|
|
1689
3013
|
nextToken?: string | undefined;
|
|
@@ -1694,86 +3018,34 @@ export interface ListNotificationConfigurationsRequest {
|
|
|
1694
3018
|
*/
|
|
1695
3019
|
export interface NotificationConfigurationStructure {
|
|
1696
3020
|
/**
|
|
1697
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
3021
|
+
* <p>The Amazon Resource Name (ARN) of the <code>NotificationConfiguration</code>
|
|
3022
|
+
* resource.</p>
|
|
1698
3023
|
* @public
|
|
1699
3024
|
*/
|
|
1700
3025
|
arn: string | undefined;
|
|
1701
3026
|
/**
|
|
1702
|
-
* <p>The name of the NotificationConfiguration
|
|
3027
|
+
* <p>The name of the <code>NotificationConfiguration</code>. Supports RFC 3986's
|
|
3028
|
+
* unreserved characters.</p>
|
|
1703
3029
|
* @public
|
|
1704
3030
|
*/
|
|
1705
3031
|
name: string | undefined;
|
|
1706
3032
|
/**
|
|
1707
|
-
* <p>The description of the NotificationConfiguration
|
|
3033
|
+
* <p>The description of the <code>NotificationConfiguration</code>.</p>
|
|
1708
3034
|
* @public
|
|
1709
3035
|
*/
|
|
1710
3036
|
description: string | undefined;
|
|
1711
3037
|
/**
|
|
1712
|
-
* <p>The status of
|
|
1713
|
-
* <p>The status should always be INACTIVE when part of the CreateNotificationConfiguration response.</p>
|
|
1714
|
-
* <ul>
|
|
1715
|
-
* <li>
|
|
1716
|
-
* <p>Values:</p>
|
|
1717
|
-
* <ul>
|
|
1718
|
-
* <li>
|
|
1719
|
-
* <p>
|
|
1720
|
-
* <code>ACTIVE</code>
|
|
1721
|
-
* </p>
|
|
1722
|
-
* <ul>
|
|
1723
|
-
* <li>
|
|
1724
|
-
* <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p>
|
|
1725
|
-
* </li>
|
|
1726
|
-
* </ul>
|
|
1727
|
-
* </li>
|
|
1728
|
-
* <li>
|
|
1729
|
-
* <p>
|
|
1730
|
-
* <code>PARTIALLY_ACTIVE</code>
|
|
1731
|
-
* </p>
|
|
1732
|
-
* <ul>
|
|
1733
|
-
* <li>
|
|
1734
|
-
* <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>.</p>
|
|
1735
|
-
* </li>
|
|
1736
|
-
* <li>
|
|
1737
|
-
* <p>Any call can be run.</p>
|
|
1738
|
-
* </li>
|
|
1739
|
-
* </ul>
|
|
1740
|
-
* </li>
|
|
1741
|
-
* <li>
|
|
1742
|
-
* <p>
|
|
1743
|
-
* <code>INACTIVE</code>
|
|
1744
|
-
* </p>
|
|
1745
|
-
* <ul>
|
|
1746
|
-
* <li>
|
|
1747
|
-
* <p>All EventRules are <code>INACTIVE</code> and any call can be run.</p>
|
|
1748
|
-
* </li>
|
|
1749
|
-
* </ul>
|
|
1750
|
-
* </li>
|
|
1751
|
-
* <li>
|
|
1752
|
-
* <p>
|
|
1753
|
-
* <code>DELETING</code>
|
|
1754
|
-
* </p>
|
|
1755
|
-
* <ul>
|
|
1756
|
-
* <li>
|
|
1757
|
-
* <p>This NotificationConfiguration is being deleted. Only <code>GET</code> and <code>LIST</code> calls can be run.</p>
|
|
1758
|
-
* </li>
|
|
1759
|
-
* <li>
|
|
1760
|
-
* <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p>
|
|
1761
|
-
* </li>
|
|
1762
|
-
* </ul>
|
|
1763
|
-
* </li>
|
|
1764
|
-
* </ul>
|
|
1765
|
-
* </li>
|
|
1766
|
-
* </ul>
|
|
3038
|
+
* <p>The current status of the <code>NotificationConfiguration</code>.</p>
|
|
1767
3039
|
* @public
|
|
1768
3040
|
*/
|
|
1769
3041
|
status: NotificationConfigurationStatus | undefined;
|
|
1770
3042
|
/**
|
|
1771
|
-
* <p>The creation time of the
|
|
3043
|
+
* <p>The creation time of the <code>NotificationConfiguration</code>.</p>
|
|
1772
3044
|
* @public
|
|
1773
3045
|
*/
|
|
1774
3046
|
creationTime: Date | undefined;
|
|
1775
3047
|
/**
|
|
1776
|
-
* <p>The aggregation preference of the NotificationConfiguration
|
|
3048
|
+
* <p>The aggregation preference of the <code>NotificationConfiguration</code>.</p>
|
|
1777
3049
|
* <ul>
|
|
1778
3050
|
* <li>
|
|
1779
3051
|
* <p>Values:</p>
|
|
@@ -1805,7 +3077,6 @@ export interface NotificationConfigurationStructure {
|
|
|
1805
3077
|
* <ul>
|
|
1806
3078
|
* <li>
|
|
1807
3079
|
* <p>Don't aggregate notifications.</p>
|
|
1808
|
-
* <p>No delay in delivery.</p>
|
|
1809
3080
|
* </li>
|
|
1810
3081
|
* </ul>
|
|
1811
3082
|
* </li>
|
|
@@ -1826,7 +3097,7 @@ export interface ListNotificationConfigurationsResponse {
|
|
|
1826
3097
|
*/
|
|
1827
3098
|
nextToken?: string | undefined;
|
|
1828
3099
|
/**
|
|
1829
|
-
* <p>The NotificationConfigurations in the account.</p>
|
|
3100
|
+
* <p>The <code>NotificationConfigurations</code> in the account.</p>
|
|
1830
3101
|
* @public
|
|
1831
3102
|
*/
|
|
1832
3103
|
notificationConfigurations: NotificationConfigurationStructure[] | undefined;
|
|
@@ -1846,13 +3117,13 @@ export interface ListNotificationEventsRequest {
|
|
|
1846
3117
|
*/
|
|
1847
3118
|
endTime?: Date | undefined;
|
|
1848
3119
|
/**
|
|
1849
|
-
* <p>The locale code of the language used for the retrieved NotificationEvent
|
|
3120
|
+
* <p>The locale code of the language used for the retrieved <code>NotificationEvent</code>. The default locale is English <code>(en_US)</code>.</p>
|
|
1850
3121
|
* @public
|
|
1851
3122
|
*/
|
|
1852
3123
|
locale?: LocaleCode | undefined;
|
|
1853
3124
|
/**
|
|
1854
3125
|
* <p>The matched event source.</p>
|
|
1855
|
-
* <p>Must match one of the valid EventBridge sources. Only
|
|
3126
|
+
* <p>Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1856
3127
|
* @public
|
|
1857
3128
|
*/
|
|
1858
3129
|
source?: string | undefined;
|
|
@@ -1862,7 +3133,8 @@ export interface ListNotificationEventsRequest {
|
|
|
1862
3133
|
*/
|
|
1863
3134
|
includeChildEvents?: boolean | undefined;
|
|
1864
3135
|
/**
|
|
1865
|
-
* <p>The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn to
|
|
3136
|
+
* <p>The Amazon Resource Name (ARN) of the <code>aggregatedNotificationEventArn</code> to
|
|
3137
|
+
* match.</p>
|
|
1866
3138
|
* @public
|
|
1867
3139
|
*/
|
|
1868
3140
|
aggregateNotificationEventArn?: string | undefined;
|
|
@@ -1872,24 +3144,15 @@ export interface ListNotificationEventsRequest {
|
|
|
1872
3144
|
*/
|
|
1873
3145
|
maxResults?: number | undefined;
|
|
1874
3146
|
/**
|
|
1875
|
-
* <p>The start token for paginated calls. Retrieved from the response of a previous
|
|
3147
|
+
* <p>The start token for paginated calls. Retrieved from the response of a previous
|
|
3148
|
+
* <code>ListEventRules</code> call. Next token uses Base64 encoding.</p>
|
|
1876
3149
|
* @public
|
|
1877
3150
|
*/
|
|
1878
3151
|
nextToken?: string | undefined;
|
|
1879
3152
|
}
|
|
1880
3153
|
/**
|
|
1881
|
-
* <p>Contains the
|
|
1882
|
-
*
|
|
1883
|
-
*/
|
|
1884
|
-
export interface MessageComponentsSummary {
|
|
1885
|
-
/**
|
|
1886
|
-
* <p>A sentence long summary. For example, titles or an email subject line.</p>
|
|
1887
|
-
* @public
|
|
1888
|
-
*/
|
|
1889
|
-
headline: string | undefined;
|
|
1890
|
-
}
|
|
1891
|
-
/**
|
|
1892
|
-
* <p>Contains metadata about the event that caused the NotificationEvent. For other specific values, see sourceEventMetadata.</p>
|
|
3154
|
+
* <p>Contains metadata about the event that caused the <code>NotificationEvent</code>. For
|
|
3155
|
+
* other specific values, see <code>sourceEventMetadata</code>.</p>
|
|
1893
3156
|
* @public
|
|
1894
3157
|
*/
|
|
1895
3158
|
export interface SourceEventMetadataSummary {
|
|
@@ -1901,19 +3164,19 @@ export interface SourceEventMetadataSummary {
|
|
|
1901
3164
|
eventOriginRegion?: string | undefined;
|
|
1902
3165
|
/**
|
|
1903
3166
|
* <p>The matched event source.</p>
|
|
1904
|
-
* <p>Must match one of the valid EventBridge sources. Only
|
|
3167
|
+
* <p>Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1905
3168
|
* @public
|
|
1906
3169
|
*/
|
|
1907
3170
|
source: string | undefined;
|
|
1908
3171
|
/**
|
|
1909
3172
|
* <p>The event type to match.</p>
|
|
1910
|
-
* <p>Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and
|
|
3173
|
+
* <p>Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1911
3174
|
* @public
|
|
1912
3175
|
*/
|
|
1913
3176
|
eventType: string | undefined;
|
|
1914
3177
|
}
|
|
1915
3178
|
/**
|
|
1916
|
-
* <p>Describes a short summary and metadata for a
|
|
3179
|
+
* <p>Describes a short summary and metadata for a <code>NotificationEvent</code>.</p>
|
|
1917
3180
|
* @public
|
|
1918
3181
|
*/
|
|
1919
3182
|
export interface NotificationEventSummary {
|
|
@@ -1933,7 +3196,7 @@ export interface NotificationEventSummary {
|
|
|
1933
3196
|
*/
|
|
1934
3197
|
messageComponents: MessageComponentsSummary | undefined;
|
|
1935
3198
|
/**
|
|
1936
|
-
* <p>
|
|
3199
|
+
* <p>Provides additional information about the current status of the <code>NotificationEvent</code>.</p>
|
|
1937
3200
|
* <ul>
|
|
1938
3201
|
* <li>
|
|
1939
3202
|
* <p>Values:</p>
|
|
@@ -1944,7 +3207,7 @@ export interface NotificationEventSummary {
|
|
|
1944
3207
|
* </p>
|
|
1945
3208
|
* <ul>
|
|
1946
3209
|
* <li>
|
|
1947
|
-
* <p>All EventRules are <code>ACTIVE</code
|
|
3210
|
+
* <p>All <code>EventRules</code> are <code>ACTIVE</code>.</p>
|
|
1948
3211
|
* </li>
|
|
1949
3212
|
* </ul>
|
|
1950
3213
|
* </li>
|
|
@@ -1954,7 +3217,7 @@ export interface NotificationEventSummary {
|
|
|
1954
3217
|
* </p>
|
|
1955
3218
|
* <ul>
|
|
1956
3219
|
* <li>
|
|
1957
|
-
* <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code
|
|
3220
|
+
* <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>.</p>
|
|
1958
3221
|
* </li>
|
|
1959
3222
|
* </ul>
|
|
1960
3223
|
* </li>
|
|
@@ -2018,7 +3281,7 @@ export interface NotificationEventSummary {
|
|
|
2018
3281
|
notificationType: NotificationType | undefined;
|
|
2019
3282
|
}
|
|
2020
3283
|
/**
|
|
2021
|
-
* <p>Describes a short summary of a NotificationEvent
|
|
3284
|
+
* <p>Describes a short summary of a <code>NotificationEvent</code>. This is only used when listing notification events.</p>
|
|
2022
3285
|
* @public
|
|
2023
3286
|
*/
|
|
2024
3287
|
export interface NotificationEventOverview {
|
|
@@ -2028,28 +3291,28 @@ export interface NotificationEventOverview {
|
|
|
2028
3291
|
*/
|
|
2029
3292
|
arn: string | undefined;
|
|
2030
3293
|
/**
|
|
2031
|
-
* <p>The ARN of the NotificationConfiguration
|
|
3294
|
+
* <p>The ARN of the <code>NotificationConfiguration</code>.</p>
|
|
2032
3295
|
* @public
|
|
2033
3296
|
*/
|
|
2034
3297
|
notificationConfigurationArn: string | undefined;
|
|
2035
3298
|
/**
|
|
2036
|
-
* <p>The account name containing the NotificationHub
|
|
3299
|
+
* <p>The account name containing the <code>NotificationHub</code>.</p>
|
|
2037
3300
|
* @public
|
|
2038
3301
|
*/
|
|
2039
3302
|
relatedAccount: string | undefined;
|
|
2040
3303
|
/**
|
|
2041
|
-
* <p>The creation time of the NotificationEvent
|
|
3304
|
+
* <p>The creation time of the <code>NotificationEvent</code>.</p>
|
|
2042
3305
|
* @public
|
|
2043
3306
|
*/
|
|
2044
3307
|
creationTime: Date | undefined;
|
|
2045
3308
|
/**
|
|
2046
|
-
* <p>Refers to a NotificationEventSummary object.</p>
|
|
2047
|
-
* <p>Similar in structure to <code>content</code> in the GetNotificationEvent response.</p>
|
|
3309
|
+
* <p>Refers to a <code>NotificationEventSummary</code> object.</p>
|
|
3310
|
+
* <p>Similar in structure to <code>content</code> in the <code>GetNotificationEvent</code> response.</p>
|
|
2048
3311
|
* @public
|
|
2049
3312
|
*/
|
|
2050
3313
|
notificationEvent: NotificationEventSummary | undefined;
|
|
2051
3314
|
/**
|
|
2052
|
-
* <p>The NotificationConfiguration's aggregation type.</p>
|
|
3315
|
+
* <p>The <code>NotificationConfiguration</code>'s aggregation type.</p>
|
|
2053
3316
|
* <ul>
|
|
2054
3317
|
* <li>
|
|
2055
3318
|
* <p>Values:</p>
|
|
@@ -2070,7 +3333,7 @@ export interface NotificationEventOverview {
|
|
|
2070
3333
|
* </p>
|
|
2071
3334
|
* <ul>
|
|
2072
3335
|
* <li>
|
|
2073
|
-
* <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p>
|
|
3336
|
+
* <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p>
|
|
2074
3337
|
* </li>
|
|
2075
3338
|
* </ul>
|
|
2076
3339
|
* </li>
|
|
@@ -2091,10 +3354,15 @@ export interface NotificationEventOverview {
|
|
|
2091
3354
|
*/
|
|
2092
3355
|
aggregationEventType?: AggregationEventType | undefined;
|
|
2093
3356
|
/**
|
|
2094
|
-
* <p>The ARN of the aggregatedNotificationEventArn to match.</p>
|
|
3357
|
+
* <p>The ARN of the <code>aggregatedNotificationEventArn</code> to match.</p>
|
|
2095
3358
|
* @public
|
|
2096
3359
|
*/
|
|
2097
3360
|
aggregateNotificationEventArn?: string | undefined;
|
|
3361
|
+
/**
|
|
3362
|
+
* <p>Provides an aggregated summary data for notification events.</p>
|
|
3363
|
+
* @public
|
|
3364
|
+
*/
|
|
3365
|
+
aggregationSummary?: AggregationSummary | undefined;
|
|
2098
3366
|
}
|
|
2099
3367
|
/**
|
|
2100
3368
|
* @public
|
|
@@ -2127,8 +3395,8 @@ export interface ListNotificationHubsRequest {
|
|
|
2127
3395
|
nextToken?: string | undefined;
|
|
2128
3396
|
}
|
|
2129
3397
|
/**
|
|
2130
|
-
* <p>Describes an overview of a NotificationHub
|
|
2131
|
-
* <p>A
|
|
3398
|
+
* <p>Describes an overview of a <code>NotificationHub</code>.</p>
|
|
3399
|
+
* <p>A <code>NotificationConfiguration</code> is an account-level setting used to select the Regions where you want to store, process and replicate your notifications.</p>
|
|
2132
3400
|
* @public
|
|
2133
3401
|
*/
|
|
2134
3402
|
export interface NotificationHubOverview {
|
|
@@ -2143,12 +3411,12 @@ export interface NotificationHubOverview {
|
|
|
2143
3411
|
*/
|
|
2144
3412
|
statusSummary: NotificationHubStatusSummary | undefined;
|
|
2145
3413
|
/**
|
|
2146
|
-
* <p>The date and time the
|
|
3414
|
+
* <p>The date and time the <code>NotificationHubOverview</code> was created.</p>
|
|
2147
3415
|
* @public
|
|
2148
3416
|
*/
|
|
2149
3417
|
creationTime: Date | undefined;
|
|
2150
3418
|
/**
|
|
2151
|
-
* <p>The most recent time this NotificationHub had an ACTIVE status.</p>
|
|
3419
|
+
* <p>The most recent time this <code>NotificationHub</code> had an <code>ACTIVE</code> status.</p>
|
|
2152
3420
|
* @public
|
|
2153
3421
|
*/
|
|
2154
3422
|
lastActivationTime?: Date | undefined;
|
|
@@ -2158,7 +3426,7 @@ export interface NotificationHubOverview {
|
|
|
2158
3426
|
*/
|
|
2159
3427
|
export interface ListNotificationHubsResponse {
|
|
2160
3428
|
/**
|
|
2161
|
-
* <p>The NotificationHubs in the account.</p>
|
|
3429
|
+
* <p>The <code>NotificationHubs</code> in the account.</p>
|
|
2162
3430
|
* @public
|
|
2163
3431
|
*/
|
|
2164
3432
|
notificationHubs: NotificationHubOverview[] | undefined;
|
|
@@ -2193,70 +3461,53 @@ export interface ListTagsForResourceResponse {
|
|
|
2193
3461
|
*/
|
|
2194
3462
|
export interface UpdateNotificationConfigurationRequest {
|
|
2195
3463
|
/**
|
|
2196
|
-
* <p>The Amazon Resource Name (ARN) used to update the NotificationConfiguration
|
|
3464
|
+
* <p>The Amazon Resource Name (ARN) used to update the <code>NotificationConfiguration</code>.</p>
|
|
2197
3465
|
* @public
|
|
2198
3466
|
*/
|
|
2199
3467
|
arn: string | undefined;
|
|
2200
3468
|
/**
|
|
2201
|
-
* <p>The name of the NotificationConfiguration
|
|
3469
|
+
* <p>The name of the <code>NotificationConfiguration</code>.</p>
|
|
2202
3470
|
* @public
|
|
2203
3471
|
*/
|
|
2204
3472
|
name?: string | undefined;
|
|
2205
3473
|
/**
|
|
2206
|
-
* <p>The description of the NotificationConfiguration
|
|
3474
|
+
* <p>The description of the <code>NotificationConfiguration</code>.</p>
|
|
2207
3475
|
* @public
|
|
2208
3476
|
*/
|
|
2209
3477
|
description?: string | undefined;
|
|
2210
3478
|
/**
|
|
2211
|
-
* <p>The
|
|
2212
|
-
* <p>The status should always be <code>INACTIVE</code> when part of the CreateNotificationConfiguration response.</p>
|
|
3479
|
+
* <p>The aggregation preference of the <code>NotificationConfiguration</code>.</p>
|
|
2213
3480
|
* <ul>
|
|
2214
3481
|
* <li>
|
|
2215
3482
|
* <p>Values:</p>
|
|
2216
3483
|
* <ul>
|
|
2217
3484
|
* <li>
|
|
2218
3485
|
* <p>
|
|
2219
|
-
* <code>
|
|
2220
|
-
* </p>
|
|
2221
|
-
* <ul>
|
|
2222
|
-
* <li>
|
|
2223
|
-
* <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p>
|
|
2224
|
-
* </li>
|
|
2225
|
-
* </ul>
|
|
2226
|
-
* </li>
|
|
2227
|
-
* <li>
|
|
2228
|
-
* <p>
|
|
2229
|
-
* <code>PARTIALLY_ACTIVE</code>
|
|
3486
|
+
* <code>LONG</code>
|
|
2230
3487
|
* </p>
|
|
2231
3488
|
* <ul>
|
|
2232
3489
|
* <li>
|
|
2233
|
-
* <p>
|
|
2234
|
-
* </li>
|
|
2235
|
-
* <li>
|
|
2236
|
-
* <p>Any call can be run.</p>
|
|
3490
|
+
* <p>Aggregate notifications for long periods of time (12 hours).</p>
|
|
2237
3491
|
* </li>
|
|
2238
3492
|
* </ul>
|
|
2239
3493
|
* </li>
|
|
2240
3494
|
* <li>
|
|
2241
3495
|
* <p>
|
|
2242
|
-
* <code>
|
|
3496
|
+
* <code>SHORT</code>
|
|
2243
3497
|
* </p>
|
|
2244
3498
|
* <ul>
|
|
2245
3499
|
* <li>
|
|
2246
|
-
* <p>
|
|
3500
|
+
* <p>Aggregate notifications for short periods of time (5 minutes).</p>
|
|
2247
3501
|
* </li>
|
|
2248
3502
|
* </ul>
|
|
2249
3503
|
* </li>
|
|
2250
3504
|
* <li>
|
|
2251
3505
|
* <p>
|
|
2252
|
-
* <code>
|
|
3506
|
+
* <code>NONE</code>
|
|
2253
3507
|
* </p>
|
|
2254
3508
|
* <ul>
|
|
2255
3509
|
* <li>
|
|
2256
|
-
* <p>
|
|
2257
|
-
* </li>
|
|
2258
|
-
* <li>
|
|
2259
|
-
* <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p>
|
|
3510
|
+
* <p>Don't aggregate notifications.</p>
|
|
2260
3511
|
* </li>
|
|
2261
3512
|
* </ul>
|
|
2262
3513
|
* </li>
|
|
@@ -2272,7 +3523,7 @@ export interface UpdateNotificationConfigurationRequest {
|
|
|
2272
3523
|
*/
|
|
2273
3524
|
export interface UpdateNotificationConfigurationResponse {
|
|
2274
3525
|
/**
|
|
2275
|
-
* <p>The ARN used to update the NotificationConfiguration
|
|
3526
|
+
* <p>The ARN used to update the <code>NotificationConfiguration</code>.</p>
|
|
2276
3527
|
* @public
|
|
2277
3528
|
*/
|
|
2278
3529
|
arn: string | undefined;
|
|
@@ -2282,7 +3533,7 @@ export interface UpdateNotificationConfigurationResponse {
|
|
|
2282
3533
|
*/
|
|
2283
3534
|
export interface RegisterNotificationHubRequest {
|
|
2284
3535
|
/**
|
|
2285
|
-
* <p>The Region of the NotificationHub
|
|
3536
|
+
* <p>The Region of the <code>NotificationHub</code>.</p>
|
|
2286
3537
|
* @public
|
|
2287
3538
|
*/
|
|
2288
3539
|
notificationHubRegion: string | undefined;
|
|
@@ -2292,12 +3543,13 @@ export interface RegisterNotificationHubRequest {
|
|
|
2292
3543
|
*/
|
|
2293
3544
|
export interface RegisterNotificationHubResponse {
|
|
2294
3545
|
/**
|
|
2295
|
-
* <p>The Region of the NotificationHub
|
|
3546
|
+
* <p>The Region of the <code>NotificationHub</code>.</p>
|
|
2296
3547
|
* @public
|
|
2297
3548
|
*/
|
|
2298
3549
|
notificationHubRegion: string | undefined;
|
|
2299
3550
|
/**
|
|
2300
|
-
* <p>
|
|
3551
|
+
* <p>Provides additional information about the current <code>NotificationConfiguration</code>
|
|
3552
|
+
* status information.</p>
|
|
2301
3553
|
* @public
|
|
2302
3554
|
*/
|
|
2303
3555
|
statusSummary: NotificationHubStatusSummary | undefined;
|