@aws-sdk/client-notifications 3.698.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +380 -0
- package/dist-cjs/Notifications.js +53 -0
- package/dist-cjs/NotificationsClient.js +50 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/commands/AssociateChannelCommand.js +26 -0
- package/dist-cjs/commands/CreateEventRuleCommand.js +26 -0
- package/dist-cjs/commands/CreateNotificationConfigurationCommand.js +26 -0
- package/dist-cjs/commands/DeleteEventRuleCommand.js +26 -0
- package/dist-cjs/commands/DeleteNotificationConfigurationCommand.js +26 -0
- package/dist-cjs/commands/DeregisterNotificationHubCommand.js +26 -0
- package/dist-cjs/commands/DisassociateChannelCommand.js +26 -0
- package/dist-cjs/commands/GetEventRuleCommand.js +26 -0
- package/dist-cjs/commands/GetNotificationConfigurationCommand.js +26 -0
- package/dist-cjs/commands/GetNotificationEventCommand.js +26 -0
- package/dist-cjs/commands/ListChannelsCommand.js +26 -0
- package/dist-cjs/commands/ListEventRulesCommand.js +26 -0
- package/dist-cjs/commands/ListNotificationConfigurationsCommand.js +26 -0
- package/dist-cjs/commands/ListNotificationEventsCommand.js +26 -0
- package/dist-cjs/commands/ListNotificationHubsCommand.js +26 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +26 -0
- package/dist-cjs/commands/RegisterNotificationHubCommand.js +26 -0
- package/dist-cjs/commands/TagResourceCommand.js +26 -0
- package/dist-cjs/commands/UntagResourceCommand.js +26 -0
- package/dist-cjs/commands/UpdateEventRuleCommand.js +26 -0
- package/dist-cjs/commands/UpdateNotificationConfigurationCommand.js +26 -0
- package/dist-cjs/commands/index.js +24 -0
- package/dist-cjs/endpoint/EndpointParameters.js +16 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +11 -0
- package/dist-cjs/models/NotificationsServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +181 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListChannelsPaginator.js +7 -0
- package/dist-cjs/pagination/ListEventRulesPaginator.js +7 -0
- package/dist-cjs/pagination/ListNotificationConfigurationsPaginator.js +7 -0
- package/dist-cjs/pagination/ListNotificationEventsPaginator.js +7 -0
- package/dist-cjs/pagination/ListNotificationHubsPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +9 -0
- package/dist-cjs/protocols/Aws_restJson1.js +885 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +50 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +34 -0
- package/dist-cjs/runtimeExtensions.js +25 -0
- package/dist-es/Notifications.js +49 -0
- package/dist-es/NotificationsClient.js +46 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/AssociateChannelCommand.js +22 -0
- package/dist-es/commands/CreateEventRuleCommand.js +22 -0
- package/dist-es/commands/CreateNotificationConfigurationCommand.js +22 -0
- package/dist-es/commands/DeleteEventRuleCommand.js +22 -0
- package/dist-es/commands/DeleteNotificationConfigurationCommand.js +22 -0
- package/dist-es/commands/DeregisterNotificationHubCommand.js +22 -0
- package/dist-es/commands/DisassociateChannelCommand.js +22 -0
- package/dist-es/commands/GetEventRuleCommand.js +22 -0
- package/dist-es/commands/GetNotificationConfigurationCommand.js +22 -0
- package/dist-es/commands/GetNotificationEventCommand.js +22 -0
- package/dist-es/commands/ListChannelsCommand.js +22 -0
- package/dist-es/commands/ListEventRulesCommand.js +22 -0
- package/dist-es/commands/ListNotificationConfigurationsCommand.js +22 -0
- package/dist-es/commands/ListNotificationEventsCommand.js +22 -0
- package/dist-es/commands/ListNotificationHubsCommand.js +22 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +22 -0
- package/dist-es/commands/RegisterNotificationHubCommand.js +22 -0
- package/dist-es/commands/TagResourceCommand.js +22 -0
- package/dist-es/commands/UntagResourceCommand.js +22 -0
- package/dist-es/commands/UpdateEventRuleCommand.js +22 -0
- package/dist-es/commands/UpdateNotificationConfigurationCommand.js +22 -0
- package/dist-es/commands/index.js +21 -0
- package/dist-es/endpoint/EndpointParameters.js +12 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/NotificationsServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +171 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListChannelsPaginator.js +4 -0
- package/dist-es/pagination/ListEventRulesPaginator.js +4 -0
- package/dist-es/pagination/ListNotificationConfigurationsPaginator.js +4 -0
- package/dist-es/pagination/ListNotificationEventsPaginator.js +4 -0
- package/dist-es/pagination/ListNotificationHubsPaginator.js +4 -0
- package/dist-es/pagination/index.js +6 -0
- package/dist-es/protocols/Aws_restJson1.js +840 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +45 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +30 -0
- package/dist-es/runtimeExtensions.js +21 -0
- package/dist-types/Notifications.d.ts +167 -0
- package/dist-types/NotificationsClient.d.ts +197 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
- package/dist-types/commands/AssociateChannelCommand.d.ts +92 -0
- package/dist-types/commands/CreateEventRuleCommand.d.ts +105 -0
- package/dist-types/commands/CreateNotificationConfigurationCommand.d.ts +95 -0
- package/dist-types/commands/DeleteEventRuleCommand.d.ts +87 -0
- package/dist-types/commands/DeleteNotificationConfigurationCommand.d.ts +87 -0
- package/dist-types/commands/DeregisterNotificationHubCommand.d.ts +96 -0
- package/dist-types/commands/DisassociateChannelCommand.d.ts +85 -0
- package/dist-types/commands/GetEventRuleCommand.d.ts +103 -0
- package/dist-types/commands/GetNotificationConfigurationCommand.d.ts +91 -0
- package/dist-types/commands/GetNotificationEventCommand.d.ts +154 -0
- package/dist-types/commands/ListChannelsCommand.d.ts +91 -0
- package/dist-types/commands/ListEventRulesCommand.d.ts +110 -0
- package/dist-types/commands/ListNotificationConfigurationsCommand.d.ts +97 -0
- package/dist-types/commands/ListNotificationEventsCommand.d.ts +118 -0
- package/dist-types/commands/ListNotificationHubsCommand.d.ts +95 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +92 -0
- package/dist-types/commands/RegisterNotificationHubCommand.d.ts +96 -0
- package/dist-types/commands/TagResourceCommand.d.ts +91 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +88 -0
- package/dist-types/commands/UpdateEventRuleCommand.d.ts +100 -0
- package/dist-types/commands/UpdateNotificationConfigurationCommand.d.ts +92 -0
- package/dist-types/commands/index.d.ts +21 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +34 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +21 -0
- package/dist-types/models/NotificationsServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +2354 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListChannelsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEventRulesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListNotificationConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListNotificationEventsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListNotificationHubsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +6 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +191 -0
- package/dist-types/runtimeConfig.browser.d.ts +48 -0
- package/dist-types/runtimeConfig.d.ts +48 -0
- package/dist-types/runtimeConfig.native.d.ts +47 -0
- package/dist-types/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/Notifications.d.ts +367 -0
- package/dist-types/ts3.4/NotificationsClient.d.ts +245 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
- package/dist-types/ts3.4/commands/AssociateChannelCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateEventRuleCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateNotificationConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteEventRuleCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteNotificationConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeregisterNotificationHubCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DisassociateChannelCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetEventRuleCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetNotificationConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetNotificationEventCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListChannelsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListEventRulesCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListNotificationConfigurationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListNotificationEventsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListNotificationHubsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/RegisterNotificationHubCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateEventRuleCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateNotificationConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +21 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +9 -0
- package/dist-types/ts3.4/models/NotificationsServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +447 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListChannelsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListEventRulesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListNotificationConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListNotificationEventsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListNotificationHubsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +6 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +257 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +93 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +94 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +87 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/package.json +101 -0
|
@@ -0,0 +1,2354 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { NotificationsServiceException as __BaseException } from "./NotificationsServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
8
|
+
readonly name: "AccessDeniedException";
|
|
9
|
+
readonly $fault: "client";
|
|
10
|
+
/**
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
* @enum
|
|
18
|
+
*/
|
|
19
|
+
export declare const AggregationDuration: {
|
|
20
|
+
/**
|
|
21
|
+
* Aggregate notifications for long periods of time (12 hours)
|
|
22
|
+
*/
|
|
23
|
+
readonly LONG: "LONG";
|
|
24
|
+
/**
|
|
25
|
+
* Do not aggregate notifications sourced from a notification configuration
|
|
26
|
+
*/
|
|
27
|
+
readonly NONE: "NONE";
|
|
28
|
+
/**
|
|
29
|
+
* Aggregate notifications for short periods of time (5 mins)
|
|
30
|
+
*/
|
|
31
|
+
readonly SHORT: "SHORT";
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
36
|
+
export type AggregationDuration = (typeof AggregationDuration)[keyof typeof AggregationDuration];
|
|
37
|
+
/**
|
|
38
|
+
* @public
|
|
39
|
+
* @enum
|
|
40
|
+
*/
|
|
41
|
+
export declare const AggregationEventType: {
|
|
42
|
+
readonly AGGREGATE: "AGGREGATE";
|
|
43
|
+
readonly CHILD: "CHILD";
|
|
44
|
+
readonly NONE: "NONE";
|
|
45
|
+
};
|
|
46
|
+
/**
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
export type AggregationEventType = (typeof AggregationEventType)[keyof typeof AggregationEventType];
|
|
50
|
+
/**
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
export interface AssociateChannelRequest {
|
|
54
|
+
/**
|
|
55
|
+
* <p>The Amazon Resource Name (ARN) of the Channel to associate with the NotificationConfiguration.</p>
|
|
56
|
+
* <p>Supported ARNs include AWS Chatbot, the Console Mobile Application, and notifications-contacts.</p>
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
59
|
+
arn: string | undefined;
|
|
60
|
+
/**
|
|
61
|
+
* <p>The ARN of the NotificationConfiguration to associate with the Channel.</p>
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
64
|
+
notificationConfigurationArn: string | undefined;
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
export interface AssociateChannelResponse {
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
export declare class ConflictException extends __BaseException {
|
|
76
|
+
readonly name: "ConflictException";
|
|
77
|
+
readonly $fault: "client";
|
|
78
|
+
/**
|
|
79
|
+
* <p>The resource ID that prompted the conflict error.</p>
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
resourceId: string | undefined;
|
|
83
|
+
/**
|
|
84
|
+
* @internal
|
|
85
|
+
*/
|
|
86
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* <p>Unexpected error during processing of request.</p>
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
export declare class InternalServerException extends __BaseException {
|
|
93
|
+
readonly name: "InternalServerException";
|
|
94
|
+
readonly $fault: "server";
|
|
95
|
+
$retryable: {};
|
|
96
|
+
/**
|
|
97
|
+
* @internal
|
|
98
|
+
*/
|
|
99
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* <p>Request references a resource which does not exist. </p>
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
106
|
+
readonly name: "ResourceNotFoundException";
|
|
107
|
+
readonly $fault: "client";
|
|
108
|
+
/**
|
|
109
|
+
* <p>The ID of the resource that wasn't found.</p>
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
resourceId: string | undefined;
|
|
113
|
+
/**
|
|
114
|
+
* @internal
|
|
115
|
+
*/
|
|
116
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* <p>Request would cause a service quota to be exceeded.</p>
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
123
|
+
readonly name: "ServiceQuotaExceededException";
|
|
124
|
+
readonly $fault: "client";
|
|
125
|
+
/**
|
|
126
|
+
* <p>The type of the resource that exceeds the service quota.</p>
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
129
|
+
resourceType: string | undefined;
|
|
130
|
+
/**
|
|
131
|
+
* <p>The ID of the resource that exceeds the service quota.</p>
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
resourceId?: string | undefined;
|
|
135
|
+
/**
|
|
136
|
+
* <p>The code for the service quota exceeded in <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html">Service Quotas</a>.</p>
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
serviceCode?: string | undefined;
|
|
140
|
+
/**
|
|
141
|
+
* <p>The code for the service quota in <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html">Service Quotas</a>.</p>
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
quotaCode?: string | undefined;
|
|
145
|
+
/**
|
|
146
|
+
* @internal
|
|
147
|
+
*/
|
|
148
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* <p>Request was denied due to request throttling. </p>
|
|
152
|
+
* @public
|
|
153
|
+
*/
|
|
154
|
+
export declare class ThrottlingException extends __BaseException {
|
|
155
|
+
readonly name: "ThrottlingException";
|
|
156
|
+
readonly $fault: "client";
|
|
157
|
+
$retryable: {
|
|
158
|
+
throttling: boolean;
|
|
159
|
+
};
|
|
160
|
+
/**
|
|
161
|
+
* <p>Identifies the service being throttled.</p>
|
|
162
|
+
* @public
|
|
163
|
+
*/
|
|
164
|
+
serviceCode?: string | undefined;
|
|
165
|
+
/**
|
|
166
|
+
* <p>Identifies the quota that is being throttled.</p>
|
|
167
|
+
* @public
|
|
168
|
+
*/
|
|
169
|
+
quotaCode?: string | undefined;
|
|
170
|
+
/**
|
|
171
|
+
* <p>The number of seconds a client should wait before retrying the request.</p>
|
|
172
|
+
* @public
|
|
173
|
+
*/
|
|
174
|
+
retryAfterSeconds?: number | undefined;
|
|
175
|
+
/**
|
|
176
|
+
* @internal
|
|
177
|
+
*/
|
|
178
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* <p>Stores information about a field passed inside a request that resulted in an exception.</p>
|
|
182
|
+
* @public
|
|
183
|
+
*/
|
|
184
|
+
export interface ValidationExceptionField {
|
|
185
|
+
/**
|
|
186
|
+
* <p>The field name where the invalid entry was detected.</p>
|
|
187
|
+
* @public
|
|
188
|
+
*/
|
|
189
|
+
name: string | undefined;
|
|
190
|
+
/**
|
|
191
|
+
* <p>A message with the reason for the validation exception error.</p>
|
|
192
|
+
* @public
|
|
193
|
+
*/
|
|
194
|
+
message: string | undefined;
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* @public
|
|
198
|
+
* @enum
|
|
199
|
+
*/
|
|
200
|
+
export declare const ValidationExceptionReason: {
|
|
201
|
+
readonly FIELD_VALIDATION_FAILED: "fieldValidationFailed";
|
|
202
|
+
readonly OTHER: "other";
|
|
203
|
+
};
|
|
204
|
+
/**
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
208
|
+
/**
|
|
209
|
+
* <p>This exception is thrown when the notification event fails validation.</p>
|
|
210
|
+
* @public
|
|
211
|
+
*/
|
|
212
|
+
export declare class ValidationException extends __BaseException {
|
|
213
|
+
readonly name: "ValidationException";
|
|
214
|
+
readonly $fault: "client";
|
|
215
|
+
/**
|
|
216
|
+
* <p>The reason why your input is considered invalid.</p>
|
|
217
|
+
* @public
|
|
218
|
+
*/
|
|
219
|
+
reason?: ValidationExceptionReason | undefined;
|
|
220
|
+
/**
|
|
221
|
+
* <p>The list of input fields that are invalid.</p>
|
|
222
|
+
* @public
|
|
223
|
+
*/
|
|
224
|
+
fieldList?: ValidationExceptionField[] | undefined;
|
|
225
|
+
/**
|
|
226
|
+
* @internal
|
|
227
|
+
*/
|
|
228
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
229
|
+
}
|
|
230
|
+
/**
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
export interface DisassociateChannelRequest {
|
|
234
|
+
/**
|
|
235
|
+
* <p>The Amazon Resource Name (ARN) of the Channel to disassociate.</p>
|
|
236
|
+
* @public
|
|
237
|
+
*/
|
|
238
|
+
arn: string | undefined;
|
|
239
|
+
/**
|
|
240
|
+
* <p>The ARN of the NotificationConfiguration to disassociate.</p>
|
|
241
|
+
* @public
|
|
242
|
+
*/
|
|
243
|
+
notificationConfigurationArn: string | undefined;
|
|
244
|
+
}
|
|
245
|
+
/**
|
|
246
|
+
* @public
|
|
247
|
+
*/
|
|
248
|
+
export interface DisassociateChannelResponse {
|
|
249
|
+
}
|
|
250
|
+
/**
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
export interface ListChannelsRequest {
|
|
254
|
+
/**
|
|
255
|
+
* <p>The Amazon Resource Name (ARN) of the NotificationConfiguration.</p>
|
|
256
|
+
* @public
|
|
257
|
+
*/
|
|
258
|
+
notificationConfigurationArn: string | undefined;
|
|
259
|
+
/**
|
|
260
|
+
* <p>The maximum number of results to be returned in this call. The default value is 20.</p>
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
maxResults?: number | undefined;
|
|
264
|
+
/**
|
|
265
|
+
* <p>The start token for paginated calls. Retrieved from the response of a previous ListNotificationEvents call. NextToken uses Base64 encoding.</p>
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
nextToken?: string | undefined;
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* @public
|
|
272
|
+
*/
|
|
273
|
+
export interface ListChannelsResponse {
|
|
274
|
+
/**
|
|
275
|
+
* <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>
|
|
276
|
+
* @public
|
|
277
|
+
*/
|
|
278
|
+
nextToken?: string | undefined;
|
|
279
|
+
/**
|
|
280
|
+
* <p>A list of Channels.</p>
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
283
|
+
channels: string[] | undefined;
|
|
284
|
+
}
|
|
285
|
+
/**
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
288
|
+
export interface CreateEventRuleRequest {
|
|
289
|
+
/**
|
|
290
|
+
* <p>The Amazon Resource Name (ARN) of the NotificationConfiguration associated with this EventRule.</p>
|
|
291
|
+
* @public
|
|
292
|
+
*/
|
|
293
|
+
notificationConfigurationArn: string | undefined;
|
|
294
|
+
/**
|
|
295
|
+
* <p>The matched event source.</p>
|
|
296
|
+
* <p>Must match one of the valid EventBridge sources. Only AWS 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 AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
297
|
+
* @public
|
|
298
|
+
*/
|
|
299
|
+
source: string | undefined;
|
|
300
|
+
/**
|
|
301
|
+
* <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 AWS 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 AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
303
|
+
* @public
|
|
304
|
+
*/
|
|
305
|
+
eventType: string | undefined;
|
|
306
|
+
/**
|
|
307
|
+
* <p>An additional event pattern used to further filter the events this EventRule receives.</p>
|
|
308
|
+
* <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
|
+
* </p>
|
|
310
|
+
* @public
|
|
311
|
+
*/
|
|
312
|
+
eventPattern?: string | undefined;
|
|
313
|
+
/**
|
|
314
|
+
* <p>A list of AWS Regions that send events to this EventRule.</p>
|
|
315
|
+
* @public
|
|
316
|
+
*/
|
|
317
|
+
regions: string[] | undefined;
|
|
318
|
+
}
|
|
319
|
+
/**
|
|
320
|
+
* @public
|
|
321
|
+
* @enum
|
|
322
|
+
*/
|
|
323
|
+
export declare const EventRuleStatus: {
|
|
324
|
+
/**
|
|
325
|
+
* EventRule is processing events. Any call can be executed.
|
|
326
|
+
*/
|
|
327
|
+
readonly ACTIVE: "ACTIVE";
|
|
328
|
+
/**
|
|
329
|
+
* This EventRule is being created. Only GET/LIST calls can be executed.
|
|
330
|
+
*/
|
|
331
|
+
readonly CREATING: "CREATING";
|
|
332
|
+
/**
|
|
333
|
+
* This EventRule is being deleted. Only GET/LIST calls can be executed.
|
|
334
|
+
*/
|
|
335
|
+
readonly DELETING: "DELETING";
|
|
336
|
+
/**
|
|
337
|
+
* EventRule is in a bad state and may not be processing events. Any call can be executed.
|
|
338
|
+
*/
|
|
339
|
+
readonly INACTIVE: "INACTIVE";
|
|
340
|
+
/**
|
|
341
|
+
* This EventRule is being updated. Only GET/LIST calls can be executed.
|
|
342
|
+
*/
|
|
343
|
+
readonly UPDATING: "UPDATING";
|
|
344
|
+
};
|
|
345
|
+
/**
|
|
346
|
+
* @public
|
|
347
|
+
*/
|
|
348
|
+
export type EventRuleStatus = (typeof EventRuleStatus)[keyof typeof EventRuleStatus];
|
|
349
|
+
/**
|
|
350
|
+
* <p>Describes EventRule status information.</p>
|
|
351
|
+
* @public
|
|
352
|
+
*/
|
|
353
|
+
export interface EventRuleStatusSummary {
|
|
354
|
+
/**
|
|
355
|
+
* <p>The status of the EventRule.</p>
|
|
356
|
+
* <ul>
|
|
357
|
+
* <li>
|
|
358
|
+
* <p>Values:</p>
|
|
359
|
+
* <ul>
|
|
360
|
+
* <li>
|
|
361
|
+
* <p>
|
|
362
|
+
* <code>ACTIVE</code>
|
|
363
|
+
* </p>
|
|
364
|
+
* <ul>
|
|
365
|
+
* <li>
|
|
366
|
+
* <p>The EventRule can process events.</p>
|
|
367
|
+
* </li>
|
|
368
|
+
* </ul>
|
|
369
|
+
* </li>
|
|
370
|
+
* <li>
|
|
371
|
+
* <p>
|
|
372
|
+
* <code>INACTIVE</code>
|
|
373
|
+
* </p>
|
|
374
|
+
* <ul>
|
|
375
|
+
* <li>
|
|
376
|
+
* <p>The EventRule may be unable to process events.</p>
|
|
377
|
+
* </li>
|
|
378
|
+
* </ul>
|
|
379
|
+
* </li>
|
|
380
|
+
* <li>
|
|
381
|
+
* <p>
|
|
382
|
+
* <code>CREATING</code>
|
|
383
|
+
* </p>
|
|
384
|
+
* <ul>
|
|
385
|
+
* <li>
|
|
386
|
+
* <p>The EventRule is being created.</p>
|
|
387
|
+
* <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p>
|
|
388
|
+
* </li>
|
|
389
|
+
* </ul>
|
|
390
|
+
* </li>
|
|
391
|
+
* <li>
|
|
392
|
+
* <p>
|
|
393
|
+
* <code>UPDATING</code>
|
|
394
|
+
* </p>
|
|
395
|
+
* <ul>
|
|
396
|
+
* <li>
|
|
397
|
+
* <p>The EventRule is being updated.</p>
|
|
398
|
+
* <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p>
|
|
399
|
+
* </li>
|
|
400
|
+
* </ul>
|
|
401
|
+
* </li>
|
|
402
|
+
* <li>
|
|
403
|
+
* <p>
|
|
404
|
+
* <code>DELETING</code>
|
|
405
|
+
* </p>
|
|
406
|
+
* <ul>
|
|
407
|
+
* <li>
|
|
408
|
+
* <p>The EventRule is being deleted.</p>
|
|
409
|
+
* <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p>
|
|
410
|
+
* </li>
|
|
411
|
+
* </ul>
|
|
412
|
+
* </li>
|
|
413
|
+
* </ul>
|
|
414
|
+
* </li>
|
|
415
|
+
* </ul>
|
|
416
|
+
* @public
|
|
417
|
+
*/
|
|
418
|
+
status: EventRuleStatus | undefined;
|
|
419
|
+
/**
|
|
420
|
+
* <p>A human-readable reason for EventRuleStatus.</p>
|
|
421
|
+
* @public
|
|
422
|
+
*/
|
|
423
|
+
reason: string | undefined;
|
|
424
|
+
}
|
|
425
|
+
/**
|
|
426
|
+
* @public
|
|
427
|
+
*/
|
|
428
|
+
export interface CreateEventRuleResponse {
|
|
429
|
+
/**
|
|
430
|
+
* <p>The ARN of the resource.</p>
|
|
431
|
+
* @public
|
|
432
|
+
*/
|
|
433
|
+
arn: string | undefined;
|
|
434
|
+
/**
|
|
435
|
+
* <p>The ARN of a NotificationConfiguration.</p>
|
|
436
|
+
* @public
|
|
437
|
+
*/
|
|
438
|
+
notificationConfigurationArn: string | undefined;
|
|
439
|
+
/**
|
|
440
|
+
* <p>A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.</p>
|
|
441
|
+
* @public
|
|
442
|
+
*/
|
|
443
|
+
statusSummaryByRegion: Record<string, EventRuleStatusSummary> | undefined;
|
|
444
|
+
}
|
|
445
|
+
/**
|
|
446
|
+
* @public
|
|
447
|
+
*/
|
|
448
|
+
export interface CreateNotificationConfigurationRequest {
|
|
449
|
+
/**
|
|
450
|
+
* <p>The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters.</p>
|
|
451
|
+
* @public
|
|
452
|
+
*/
|
|
453
|
+
name: string | undefined;
|
|
454
|
+
/**
|
|
455
|
+
* <p>The description of the NotificationConfiguration.</p>
|
|
456
|
+
* @public
|
|
457
|
+
*/
|
|
458
|
+
description: string | undefined;
|
|
459
|
+
/**
|
|
460
|
+
* <p>The aggregation preference of the NotificationConfiguration.</p>
|
|
461
|
+
* <ul>
|
|
462
|
+
* <li>
|
|
463
|
+
* <p>Values:</p>
|
|
464
|
+
* <ul>
|
|
465
|
+
* <li>
|
|
466
|
+
* <p>
|
|
467
|
+
* <code>LONG</code>
|
|
468
|
+
* </p>
|
|
469
|
+
* <ul>
|
|
470
|
+
* <li>
|
|
471
|
+
* <p>Aggregate notifications for long periods of time (12 hours).</p>
|
|
472
|
+
* </li>
|
|
473
|
+
* </ul>
|
|
474
|
+
* </li>
|
|
475
|
+
* <li>
|
|
476
|
+
* <p>
|
|
477
|
+
* <code>SHORT</code>
|
|
478
|
+
* </p>
|
|
479
|
+
* <ul>
|
|
480
|
+
* <li>
|
|
481
|
+
* <p>Aggregate notifications for short periods of time (5 minutes).</p>
|
|
482
|
+
* </li>
|
|
483
|
+
* </ul>
|
|
484
|
+
* </li>
|
|
485
|
+
* <li>
|
|
486
|
+
* <p>
|
|
487
|
+
* <code>NONE</code>
|
|
488
|
+
* </p>
|
|
489
|
+
* <ul>
|
|
490
|
+
* <li>
|
|
491
|
+
* <p>Don't aggregate notifications.</p>
|
|
492
|
+
* <p>No delay in delivery.</p>
|
|
493
|
+
* </li>
|
|
494
|
+
* </ul>
|
|
495
|
+
* </li>
|
|
496
|
+
* </ul>
|
|
497
|
+
* </li>
|
|
498
|
+
* </ul>
|
|
499
|
+
* @public
|
|
500
|
+
*/
|
|
501
|
+
aggregationDuration?: AggregationDuration | undefined;
|
|
502
|
+
/**
|
|
503
|
+
* <p>A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.</p>
|
|
504
|
+
* @public
|
|
505
|
+
*/
|
|
506
|
+
tags?: Record<string, string> | undefined;
|
|
507
|
+
}
|
|
508
|
+
/**
|
|
509
|
+
* @public
|
|
510
|
+
* @enum
|
|
511
|
+
*/
|
|
512
|
+
export declare const NotificationConfigurationStatus: {
|
|
513
|
+
/**
|
|
514
|
+
* All of the EventRules are in ACTIVE Status. Any call can be executed.
|
|
515
|
+
*/
|
|
516
|
+
readonly ACTIVE: "ACTIVE";
|
|
517
|
+
/**
|
|
518
|
+
* This NotificationConfiguration is being deleted. Only GET/LIST calls can be executed.
|
|
519
|
+
*/
|
|
520
|
+
readonly DELETING: "DELETING";
|
|
521
|
+
/**
|
|
522
|
+
* All of the EventRules are in INACTIVE Status. Any call can be executed.
|
|
523
|
+
*/
|
|
524
|
+
readonly INACTIVE: "INACTIVE";
|
|
525
|
+
/**
|
|
526
|
+
* Some EventRules are in ACTIVE Status and some are INACTIVE. Any call can be executed.
|
|
527
|
+
*/
|
|
528
|
+
readonly PARTIALLY_ACTIVE: "PARTIALLY_ACTIVE";
|
|
529
|
+
};
|
|
530
|
+
/**
|
|
531
|
+
* @public
|
|
532
|
+
*/
|
|
533
|
+
export type NotificationConfigurationStatus = (typeof NotificationConfigurationStatus)[keyof typeof NotificationConfigurationStatus];
|
|
534
|
+
/**
|
|
535
|
+
* @public
|
|
536
|
+
*/
|
|
537
|
+
export interface CreateNotificationConfigurationResponse {
|
|
538
|
+
/**
|
|
539
|
+
* <p>The Amazon Resource Name (ARN) of the the resource.</p>
|
|
540
|
+
* @public
|
|
541
|
+
*/
|
|
542
|
+
arn: string | undefined;
|
|
543
|
+
/**
|
|
544
|
+
* <p>The status of this NotificationConfiguration.</p>
|
|
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>
|
|
599
|
+
* @public
|
|
600
|
+
*/
|
|
601
|
+
status: NotificationConfigurationStatus | undefined;
|
|
602
|
+
}
|
|
603
|
+
/**
|
|
604
|
+
* @public
|
|
605
|
+
*/
|
|
606
|
+
export interface DeleteEventRuleRequest {
|
|
607
|
+
/**
|
|
608
|
+
* <p>The Amazon Resource Name (ARN) of the EventRule to delete.</p>
|
|
609
|
+
* @public
|
|
610
|
+
*/
|
|
611
|
+
arn: string | undefined;
|
|
612
|
+
}
|
|
613
|
+
/**
|
|
614
|
+
* @public
|
|
615
|
+
*/
|
|
616
|
+
export interface DeleteEventRuleResponse {
|
|
617
|
+
}
|
|
618
|
+
/**
|
|
619
|
+
* @public
|
|
620
|
+
*/
|
|
621
|
+
export interface DeleteNotificationConfigurationRequest {
|
|
622
|
+
/**
|
|
623
|
+
* <p>The Amazon Resource Name (ARN) of the NotificationConfiguration to delete.</p>
|
|
624
|
+
* @public
|
|
625
|
+
*/
|
|
626
|
+
arn: string | undefined;
|
|
627
|
+
}
|
|
628
|
+
/**
|
|
629
|
+
* @public
|
|
630
|
+
*/
|
|
631
|
+
export interface DeleteNotificationConfigurationResponse {
|
|
632
|
+
}
|
|
633
|
+
/**
|
|
634
|
+
* @public
|
|
635
|
+
*/
|
|
636
|
+
export interface DeregisterNotificationHubRequest {
|
|
637
|
+
/**
|
|
638
|
+
* <p>The NotificationHub Region.</p>
|
|
639
|
+
* @public
|
|
640
|
+
*/
|
|
641
|
+
notificationHubRegion: string | undefined;
|
|
642
|
+
}
|
|
643
|
+
/**
|
|
644
|
+
* @public
|
|
645
|
+
* @enum
|
|
646
|
+
*/
|
|
647
|
+
export declare const NotificationHubStatus: {
|
|
648
|
+
/**
|
|
649
|
+
* Incoming Notification Events are being replicated to this Notification Hub. A Notification Hub with this status can be deregistered.
|
|
650
|
+
*/
|
|
651
|
+
readonly ACTIVE: "ACTIVE";
|
|
652
|
+
/**
|
|
653
|
+
* Notification Hub is being deleted. Cannot register a Notification Hub in the same region as one in this status.
|
|
654
|
+
*/
|
|
655
|
+
readonly DEREGISTERING: "DEREGISTERING";
|
|
656
|
+
/**
|
|
657
|
+
* Notification Hub is in a failure state. Incoming Notification Events are not being replicated to this Hub.
|
|
658
|
+
*/
|
|
659
|
+
readonly INACTIVE: "INACTIVE";
|
|
660
|
+
/**
|
|
661
|
+
* Notification Hub is initializing. Cannot deregister a Notification Hub in this status.
|
|
662
|
+
*/
|
|
663
|
+
readonly REGISTERING: "REGISTERING";
|
|
664
|
+
};
|
|
665
|
+
/**
|
|
666
|
+
* @public
|
|
667
|
+
*/
|
|
668
|
+
export type NotificationHubStatus = (typeof NotificationHubStatus)[keyof typeof NotificationHubStatus];
|
|
669
|
+
/**
|
|
670
|
+
* <p>NotificationHub status information.</p>
|
|
671
|
+
* @public
|
|
672
|
+
*/
|
|
673
|
+
export interface NotificationHubStatusSummary {
|
|
674
|
+
/**
|
|
675
|
+
* <p>Status information about the NotificationHub.</p>
|
|
676
|
+
* <ul>
|
|
677
|
+
* <li>
|
|
678
|
+
* <p>Values:</p>
|
|
679
|
+
* <ul>
|
|
680
|
+
* <li>
|
|
681
|
+
* <p>
|
|
682
|
+
* <code>ACTIVE</code>
|
|
683
|
+
* </p>
|
|
684
|
+
* <ul>
|
|
685
|
+
* <li>
|
|
686
|
+
* <p>Incoming NotificationEvents are replicated to this NotificationHub.</p>
|
|
687
|
+
* </li>
|
|
688
|
+
* </ul>
|
|
689
|
+
* </li>
|
|
690
|
+
* <li>
|
|
691
|
+
* <p>
|
|
692
|
+
* <code>REGISTERING</code>
|
|
693
|
+
* </p>
|
|
694
|
+
* <ul>
|
|
695
|
+
* <li>
|
|
696
|
+
* <p>The NotificationHub is initializing. A NotificationHub with this status can't be deregistered.</p>
|
|
697
|
+
* </li>
|
|
698
|
+
* </ul>
|
|
699
|
+
* </li>
|
|
700
|
+
* <li>
|
|
701
|
+
* <p>
|
|
702
|
+
* <code>DEREGISTERING</code>
|
|
703
|
+
* </p>
|
|
704
|
+
* <ul>
|
|
705
|
+
* <li>
|
|
706
|
+
* <p>The NotificationHub is being deleted. You can't register additional NotificationHubs in the same Region as a NotificationHub with this status.</p>
|
|
707
|
+
* </li>
|
|
708
|
+
* </ul>
|
|
709
|
+
* </li>
|
|
710
|
+
* </ul>
|
|
711
|
+
* </li>
|
|
712
|
+
* </ul>
|
|
713
|
+
* @public
|
|
714
|
+
*/
|
|
715
|
+
status: NotificationHubStatus | undefined;
|
|
716
|
+
/**
|
|
717
|
+
* <p>An Explanation for the current status.</p>
|
|
718
|
+
* @public
|
|
719
|
+
*/
|
|
720
|
+
reason: string | undefined;
|
|
721
|
+
}
|
|
722
|
+
/**
|
|
723
|
+
* @public
|
|
724
|
+
*/
|
|
725
|
+
export interface DeregisterNotificationHubResponse {
|
|
726
|
+
/**
|
|
727
|
+
* <p>The NotificationHub Region.</p>
|
|
728
|
+
* @public
|
|
729
|
+
*/
|
|
730
|
+
notificationHubRegion: string | undefined;
|
|
731
|
+
/**
|
|
732
|
+
* <p>NotificationHub status information.</p>
|
|
733
|
+
* @public
|
|
734
|
+
*/
|
|
735
|
+
statusSummary: NotificationHubStatusSummary | undefined;
|
|
736
|
+
}
|
|
737
|
+
/**
|
|
738
|
+
* <p>The key-value pair of properties for an event.</p>
|
|
739
|
+
* @public
|
|
740
|
+
*/
|
|
741
|
+
export interface Dimension {
|
|
742
|
+
/**
|
|
743
|
+
* <p>The name of the dimension</p>
|
|
744
|
+
* @public
|
|
745
|
+
*/
|
|
746
|
+
name: string | undefined;
|
|
747
|
+
/**
|
|
748
|
+
* <p>The value of the dimension.</p>
|
|
749
|
+
* @public
|
|
750
|
+
*/
|
|
751
|
+
value: string | undefined;
|
|
752
|
+
}
|
|
753
|
+
/**
|
|
754
|
+
* @public
|
|
755
|
+
*/
|
|
756
|
+
export interface GetEventRuleRequest {
|
|
757
|
+
/**
|
|
758
|
+
* <p>The Amazon Resource Name (ARN) of the EventRule to return.</p>
|
|
759
|
+
* @public
|
|
760
|
+
*/
|
|
761
|
+
arn: string | undefined;
|
|
762
|
+
}
|
|
763
|
+
/**
|
|
764
|
+
* @public
|
|
765
|
+
*/
|
|
766
|
+
export interface GetEventRuleResponse {
|
|
767
|
+
/**
|
|
768
|
+
* <p>The ARN of the resource.</p>
|
|
769
|
+
* @public
|
|
770
|
+
*/
|
|
771
|
+
arn: string | undefined;
|
|
772
|
+
/**
|
|
773
|
+
* <p>The ARN of a NotificationConfiguration.</p>
|
|
774
|
+
* @public
|
|
775
|
+
*/
|
|
776
|
+
notificationConfigurationArn: string | undefined;
|
|
777
|
+
/**
|
|
778
|
+
* <p>The date when the EventRule was created.</p>
|
|
779
|
+
* @public
|
|
780
|
+
*/
|
|
781
|
+
creationTime: Date | undefined;
|
|
782
|
+
/**
|
|
783
|
+
* <p>The matched event source.</p>
|
|
784
|
+
* <p>Must match one of the valid EventBridge sources. Only AWS 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 AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
785
|
+
* @public
|
|
786
|
+
*/
|
|
787
|
+
source: string | undefined;
|
|
788
|
+
/**
|
|
789
|
+
* <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 AWS 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 AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
791
|
+
* @public
|
|
792
|
+
*/
|
|
793
|
+
eventType: string | undefined;
|
|
794
|
+
/**
|
|
795
|
+
* <p>An additional event pattern used to further filter the events this EventRule receives.</p>
|
|
796
|
+
* <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
|
+
* </p>
|
|
798
|
+
* @public
|
|
799
|
+
*/
|
|
800
|
+
eventPattern: string | undefined;
|
|
801
|
+
/**
|
|
802
|
+
* <p>A list of AWS Regions that send events to this EventRule.</p>
|
|
803
|
+
* @public
|
|
804
|
+
*/
|
|
805
|
+
regions: string[] | undefined;
|
|
806
|
+
/**
|
|
807
|
+
* <p>A list of managed rules from EventBridge that are are associated with this EventRule.</p>
|
|
808
|
+
* <note>
|
|
809
|
+
* <p>These are created by AWS User Notifications within your account so this EventRule functions.</p>
|
|
810
|
+
* </note>
|
|
811
|
+
* @public
|
|
812
|
+
*/
|
|
813
|
+
managedRules: string[] | undefined;
|
|
814
|
+
/**
|
|
815
|
+
* <p>A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.</p>
|
|
816
|
+
* @public
|
|
817
|
+
*/
|
|
818
|
+
statusSummaryByRegion: Record<string, EventRuleStatusSummary> | undefined;
|
|
819
|
+
}
|
|
820
|
+
/**
|
|
821
|
+
* @public
|
|
822
|
+
*/
|
|
823
|
+
export interface ListEventRulesRequest {
|
|
824
|
+
/**
|
|
825
|
+
* <p>The Amazon Resource Name (ARN) of the NotificationConfiguration.</p>
|
|
826
|
+
* @public
|
|
827
|
+
*/
|
|
828
|
+
notificationConfigurationArn: string | undefined;
|
|
829
|
+
/**
|
|
830
|
+
* <p>The maximum number of results to be returned in this call. The default value is 20.</p>
|
|
831
|
+
* @public
|
|
832
|
+
*/
|
|
833
|
+
maxResults?: number | undefined;
|
|
834
|
+
/**
|
|
835
|
+
* <p>The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.</p>
|
|
836
|
+
* @public
|
|
837
|
+
*/
|
|
838
|
+
nextToken?: string | undefined;
|
|
839
|
+
}
|
|
840
|
+
/**
|
|
841
|
+
* <p>Contains a complete list of fields related to an EventRule.</p>
|
|
842
|
+
* @public
|
|
843
|
+
*/
|
|
844
|
+
export interface EventRuleStructure {
|
|
845
|
+
/**
|
|
846
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
847
|
+
* @public
|
|
848
|
+
*/
|
|
849
|
+
arn: string | undefined;
|
|
850
|
+
/**
|
|
851
|
+
* <p>The ARN for the NotificationConfiguration associated with this EventRule.</p>
|
|
852
|
+
* @public
|
|
853
|
+
*/
|
|
854
|
+
notificationConfigurationArn: string | undefined;
|
|
855
|
+
/**
|
|
856
|
+
* <p>The creation time of the resource.</p>
|
|
857
|
+
* @public
|
|
858
|
+
*/
|
|
859
|
+
creationTime: Date | undefined;
|
|
860
|
+
/**
|
|
861
|
+
* <p>The matched event source.</p>
|
|
862
|
+
* <p>Must match one of the valid EventBridge sources. Only AWS 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 AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
863
|
+
* @public
|
|
864
|
+
*/
|
|
865
|
+
source: string | undefined;
|
|
866
|
+
/**
|
|
867
|
+
* <p>The event type to match.</p>
|
|
868
|
+
* <p>Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and AWS 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 AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
869
|
+
* @public
|
|
870
|
+
*/
|
|
871
|
+
eventType: string | undefined;
|
|
872
|
+
/**
|
|
873
|
+
* <p>An additional event pattern used to further filter the events this EventRule receives.</p>
|
|
874
|
+
* <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
|
+
* </p>
|
|
876
|
+
* @public
|
|
877
|
+
*/
|
|
878
|
+
eventPattern: string | undefined;
|
|
879
|
+
/**
|
|
880
|
+
* <p>A list of AWS Regions that send events to this EventRule.</p>
|
|
881
|
+
* @public
|
|
882
|
+
*/
|
|
883
|
+
regions: string[] | undefined;
|
|
884
|
+
/**
|
|
885
|
+
* <p>A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule.</p>
|
|
886
|
+
* <note>
|
|
887
|
+
* <p>These are created by AWS User Notifications within your account so your EventRules can function.</p>
|
|
888
|
+
* </note>
|
|
889
|
+
* @public
|
|
890
|
+
*/
|
|
891
|
+
managedRules: string[] | undefined;
|
|
892
|
+
/**
|
|
893
|
+
* <p>A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.</p>
|
|
894
|
+
* @public
|
|
895
|
+
*/
|
|
896
|
+
statusSummaryByRegion: Record<string, EventRuleStatusSummary> | undefined;
|
|
897
|
+
}
|
|
898
|
+
/**
|
|
899
|
+
* @public
|
|
900
|
+
*/
|
|
901
|
+
export interface ListEventRulesResponse {
|
|
902
|
+
/**
|
|
903
|
+
* <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>
|
|
904
|
+
* @public
|
|
905
|
+
*/
|
|
906
|
+
nextToken?: string | undefined;
|
|
907
|
+
/**
|
|
908
|
+
* <p>A list of EventRules.</p>
|
|
909
|
+
* @public
|
|
910
|
+
*/
|
|
911
|
+
eventRules: EventRuleStructure[] | undefined;
|
|
912
|
+
}
|
|
913
|
+
/**
|
|
914
|
+
* @public
|
|
915
|
+
*/
|
|
916
|
+
export interface UpdateEventRuleRequest {
|
|
917
|
+
/**
|
|
918
|
+
* <p>The Amazon Resource Name (ARN) to use to update the EventRule.</p>
|
|
919
|
+
* @public
|
|
920
|
+
*/
|
|
921
|
+
arn: string | undefined;
|
|
922
|
+
/**
|
|
923
|
+
* <p>An additional event pattern used to further filter the events this EventRule receives.</p>
|
|
924
|
+
* <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
|
+
* </p>
|
|
926
|
+
* @public
|
|
927
|
+
*/
|
|
928
|
+
eventPattern?: string | undefined;
|
|
929
|
+
/**
|
|
930
|
+
* <p>A list of AWS Regions that sends events to this EventRule.</p>
|
|
931
|
+
* @public
|
|
932
|
+
*/
|
|
933
|
+
regions?: string[] | undefined;
|
|
934
|
+
}
|
|
935
|
+
/**
|
|
936
|
+
* @public
|
|
937
|
+
*/
|
|
938
|
+
export interface UpdateEventRuleResponse {
|
|
939
|
+
/**
|
|
940
|
+
* <p>The Amazon Resource Name (ARN) to use to update the EventRule.</p>
|
|
941
|
+
* @public
|
|
942
|
+
*/
|
|
943
|
+
arn: string | undefined;
|
|
944
|
+
/**
|
|
945
|
+
* <p>The ARN of the NotificationConfiguration.</p>
|
|
946
|
+
* @public
|
|
947
|
+
*/
|
|
948
|
+
notificationConfigurationArn: string | undefined;
|
|
949
|
+
/**
|
|
950
|
+
* <p>The status of the action by Region.</p>
|
|
951
|
+
* @public
|
|
952
|
+
*/
|
|
953
|
+
statusSummaryByRegion: Record<string, EventRuleStatusSummary> | undefined;
|
|
954
|
+
}
|
|
955
|
+
/**
|
|
956
|
+
* @public
|
|
957
|
+
* @enum
|
|
958
|
+
*/
|
|
959
|
+
export declare const EventStatus: {
|
|
960
|
+
readonly HEALTHY: "HEALTHY";
|
|
961
|
+
readonly UNHEALTHY: "UNHEALTHY";
|
|
962
|
+
};
|
|
963
|
+
/**
|
|
964
|
+
* @public
|
|
965
|
+
*/
|
|
966
|
+
export type EventStatus = (typeof EventStatus)[keyof typeof EventStatus];
|
|
967
|
+
/**
|
|
968
|
+
* @public
|
|
969
|
+
*/
|
|
970
|
+
export interface GetNotificationConfigurationRequest {
|
|
971
|
+
/**
|
|
972
|
+
* <p>The Amazon Resource Name (ARN) of the NotificationConfiguration to return.</p>
|
|
973
|
+
* @public
|
|
974
|
+
*/
|
|
975
|
+
arn: string | undefined;
|
|
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";
|
|
1113
|
+
/**
|
|
1114
|
+
* English (Canada)
|
|
1115
|
+
*/
|
|
1116
|
+
readonly en_CA: "en_CA";
|
|
1117
|
+
/**
|
|
1118
|
+
* English (United Kingdom)
|
|
1119
|
+
*/
|
|
1120
|
+
readonly en_UK: "en_UK";
|
|
1121
|
+
/**
|
|
1122
|
+
* English (United States). This is the default locale.
|
|
1123
|
+
*/
|
|
1124
|
+
readonly en_US: "en_US";
|
|
1125
|
+
/**
|
|
1126
|
+
* Spanish (Spain)
|
|
1127
|
+
*/
|
|
1128
|
+
readonly es_ES: "es_ES";
|
|
1129
|
+
/**
|
|
1130
|
+
* French (Canada)
|
|
1131
|
+
*/
|
|
1132
|
+
readonly fr_CA: "fr_CA";
|
|
1133
|
+
/**
|
|
1134
|
+
* French (France)
|
|
1135
|
+
*/
|
|
1136
|
+
readonly fr_FR: "fr_FR";
|
|
1137
|
+
/**
|
|
1138
|
+
* Bahasa Indonesian (Indonesia)
|
|
1139
|
+
*/
|
|
1140
|
+
readonly id_ID: "id_ID";
|
|
1141
|
+
/**
|
|
1142
|
+
* Italian (Italy)
|
|
1143
|
+
*/
|
|
1144
|
+
readonly it_IT: "it_IT";
|
|
1145
|
+
/**
|
|
1146
|
+
* Japanese (Japan)
|
|
1147
|
+
*/
|
|
1148
|
+
readonly ja_JP: "ja_JP";
|
|
1149
|
+
/**
|
|
1150
|
+
* Korean (Korea)
|
|
1151
|
+
*/
|
|
1152
|
+
readonly ko_KR: "ko_KR";
|
|
1153
|
+
/**
|
|
1154
|
+
* Portuguese (Brazil)
|
|
1155
|
+
*/
|
|
1156
|
+
readonly pt_BR: "pt_BR";
|
|
1157
|
+
/**
|
|
1158
|
+
* Turkish (Turkey)
|
|
1159
|
+
*/
|
|
1160
|
+
readonly tr_TR: "tr_TR";
|
|
1161
|
+
/**
|
|
1162
|
+
* Chinese (China)
|
|
1163
|
+
*/
|
|
1164
|
+
readonly zh_CN: "zh_CN";
|
|
1165
|
+
/**
|
|
1166
|
+
* Chinese (Taiwan)
|
|
1167
|
+
*/
|
|
1168
|
+
readonly zh_TW: "zh_TW";
|
|
1169
|
+
};
|
|
1170
|
+
/**
|
|
1171
|
+
* @public
|
|
1172
|
+
*/
|
|
1173
|
+
export type LocaleCode = (typeof LocaleCode)[keyof typeof LocaleCode];
|
|
1174
|
+
/**
|
|
1175
|
+
* @public
|
|
1176
|
+
*/
|
|
1177
|
+
export interface GetNotificationEventRequest {
|
|
1178
|
+
/**
|
|
1179
|
+
* <p>The Amazon Resource Name (ARN) of the NotificationEvent to return.</p>
|
|
1180
|
+
* @public
|
|
1181
|
+
*/
|
|
1182
|
+
arn: string | undefined;
|
|
1183
|
+
/**
|
|
1184
|
+
* <p>The locale code of the language used for the retrieved NotificationEvent. The default locale is English <code>en_US</code>.</p>
|
|
1185
|
+
* @public
|
|
1186
|
+
*/
|
|
1187
|
+
locale?: LocaleCode | undefined;
|
|
1188
|
+
}
|
|
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
|
+
/**
|
|
1227
|
+
* <p>Describes the components of a notification message.</p>
|
|
1228
|
+
* @public
|
|
1229
|
+
*/
|
|
1230
|
+
export interface MessageComponents {
|
|
1231
|
+
/**
|
|
1232
|
+
* <p>A sentence long summary. For example, titles or an email subject line.</p>
|
|
1233
|
+
* @public
|
|
1234
|
+
*/
|
|
1235
|
+
headline?: string | undefined;
|
|
1236
|
+
/**
|
|
1237
|
+
* <p>A paragraph long or multiple sentence summary. For example, AWS Chatbot notifications.</p>
|
|
1238
|
+
* @public
|
|
1239
|
+
*/
|
|
1240
|
+
paragraphSummary?: string | undefined;
|
|
1241
|
+
/**
|
|
1242
|
+
* <p>A complete summary with all possible relevant information.</p>
|
|
1243
|
+
* @public
|
|
1244
|
+
*/
|
|
1245
|
+
completeDescription?: string | undefined;
|
|
1246
|
+
/**
|
|
1247
|
+
* <p>A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.</p>
|
|
1248
|
+
* <note>
|
|
1249
|
+
* <p>Included dimensions, keys, and values are subject to change.</p>
|
|
1250
|
+
* </note>
|
|
1251
|
+
* @public
|
|
1252
|
+
*/
|
|
1253
|
+
dimensions?: Dimension[] | undefined;
|
|
1254
|
+
}
|
|
1255
|
+
/**
|
|
1256
|
+
* @public
|
|
1257
|
+
* @enum
|
|
1258
|
+
*/
|
|
1259
|
+
export declare const NotificationType: {
|
|
1260
|
+
readonly ALERT: "ALERT";
|
|
1261
|
+
readonly ANNOUNCEMENT: "ANNOUNCEMENT";
|
|
1262
|
+
readonly INFORMATIONAL: "INFORMATIONAL";
|
|
1263
|
+
readonly WARNING: "WARNING";
|
|
1264
|
+
};
|
|
1265
|
+
/**
|
|
1266
|
+
* @public
|
|
1267
|
+
*/
|
|
1268
|
+
export type NotificationType = (typeof NotificationType)[keyof typeof NotificationType];
|
|
1269
|
+
/**
|
|
1270
|
+
* @public
|
|
1271
|
+
* @enum
|
|
1272
|
+
*/
|
|
1273
|
+
export declare const SchemaVersion: {
|
|
1274
|
+
readonly SCHEMA_VERSION_1_0: "v1.0";
|
|
1275
|
+
};
|
|
1276
|
+
/**
|
|
1277
|
+
* @public
|
|
1278
|
+
*/
|
|
1279
|
+
export type SchemaVersion = (typeof SchemaVersion)[keyof typeof SchemaVersion];
|
|
1280
|
+
/**
|
|
1281
|
+
* <p>A resource affected by or closely linked to an event.</p>
|
|
1282
|
+
* @public
|
|
1283
|
+
*/
|
|
1284
|
+
export interface Resource {
|
|
1285
|
+
/**
|
|
1286
|
+
* <p>The unique identifier for the resource.</p>
|
|
1287
|
+
* <p>At least one id or ARN is required.</p>
|
|
1288
|
+
* @public
|
|
1289
|
+
*/
|
|
1290
|
+
id?: string | undefined;
|
|
1291
|
+
/**
|
|
1292
|
+
* <p>The Amazon Resource Name (ARN) of the resource. At least one id or ARN is required.</p>
|
|
1293
|
+
* @public
|
|
1294
|
+
*/
|
|
1295
|
+
arn?: string | undefined;
|
|
1296
|
+
/**
|
|
1297
|
+
* <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>
|
|
1298
|
+
* @public
|
|
1299
|
+
*/
|
|
1300
|
+
detailUrl?: string | undefined;
|
|
1301
|
+
/**
|
|
1302
|
+
* <p>A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.</p>
|
|
1303
|
+
* @public
|
|
1304
|
+
*/
|
|
1305
|
+
tags?: string[] | undefined;
|
|
1306
|
+
}
|
|
1307
|
+
/**
|
|
1308
|
+
* <p>Describes the metadata for a source event.</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>
|
|
1310
|
+
* @public
|
|
1311
|
+
*/
|
|
1312
|
+
export interface SourceEventMetadata {
|
|
1313
|
+
/**
|
|
1314
|
+
* <p>The version of the type of event.</p>
|
|
1315
|
+
* @public
|
|
1316
|
+
*/
|
|
1317
|
+
eventTypeVersion: string | undefined;
|
|
1318
|
+
/**
|
|
1319
|
+
* <p>The source event id.</p>
|
|
1320
|
+
* @public
|
|
1321
|
+
*/
|
|
1322
|
+
sourceEventId: string | undefined;
|
|
1323
|
+
/**
|
|
1324
|
+
* <p>The Region the event originated from.</p>
|
|
1325
|
+
* @public
|
|
1326
|
+
*/
|
|
1327
|
+
eventOriginRegion?: string | undefined;
|
|
1328
|
+
/**
|
|
1329
|
+
* <p>The Primary AWS account of Source Event</p>
|
|
1330
|
+
* @public
|
|
1331
|
+
*/
|
|
1332
|
+
relatedAccount: string | undefined;
|
|
1333
|
+
/**
|
|
1334
|
+
* <p>The AWS servvice the event originates from. For example <code>aws.cloudwatch</code>.</p>
|
|
1335
|
+
* @public
|
|
1336
|
+
*/
|
|
1337
|
+
source: string | undefined;
|
|
1338
|
+
/**
|
|
1339
|
+
* <p>The date and time the source event occurred. This is based on the Source Event.</p>
|
|
1340
|
+
* @public
|
|
1341
|
+
*/
|
|
1342
|
+
eventOccurrenceTime: Date | undefined;
|
|
1343
|
+
/**
|
|
1344
|
+
* <p>The type of event. For example, an AWS CloudWatch state change.</p>
|
|
1345
|
+
* @public
|
|
1346
|
+
*/
|
|
1347
|
+
eventType: string | undefined;
|
|
1348
|
+
/**
|
|
1349
|
+
* <p>A list of resources related to this NotificationEvent.</p>
|
|
1350
|
+
* @public
|
|
1351
|
+
*/
|
|
1352
|
+
relatedResources: Resource[] | undefined;
|
|
1353
|
+
}
|
|
1354
|
+
/**
|
|
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
|
+
* @public
|
|
1370
|
+
*/
|
|
1371
|
+
export interface TextPartValue {
|
|
1372
|
+
/**
|
|
1373
|
+
* <p>The type of text part. Determines the usage of all other fields and whether or not they're required.</p>
|
|
1374
|
+
* @public
|
|
1375
|
+
*/
|
|
1376
|
+
type: TextPartType | undefined;
|
|
1377
|
+
/**
|
|
1378
|
+
* <p>A short single line description of the link. Must be hyperlinked with the URL itself. </p>
|
|
1379
|
+
* <p>Used for text parts with the type <code>URL</code>.</p>
|
|
1380
|
+
* @public
|
|
1381
|
+
*/
|
|
1382
|
+
displayText?: string | undefined;
|
|
1383
|
+
/**
|
|
1384
|
+
* <p>A map of locales to the text in that locale.</p>
|
|
1385
|
+
* @public
|
|
1386
|
+
*/
|
|
1387
|
+
textByLocale?: Partial<Record<LocaleCode, string>> | undefined;
|
|
1388
|
+
/**
|
|
1389
|
+
* <p>The URL itself.</p>
|
|
1390
|
+
* @public
|
|
1391
|
+
*/
|
|
1392
|
+
url?: string | undefined;
|
|
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 {
|
|
1399
|
+
/**
|
|
1400
|
+
* <p>The schema version of the Notification Event.</p>
|
|
1401
|
+
* @public
|
|
1402
|
+
*/
|
|
1403
|
+
schemaVersion: SchemaVersion | undefined;
|
|
1404
|
+
/**
|
|
1405
|
+
* <p>The unique identifier for a NotificationEvent.</p>
|
|
1406
|
+
* @public
|
|
1407
|
+
*/
|
|
1408
|
+
id: string | undefined;
|
|
1409
|
+
/**
|
|
1410
|
+
* <p>The source event metadata.</p>
|
|
1411
|
+
* @public
|
|
1412
|
+
*/
|
|
1413
|
+
sourceEventMetadata: SourceEventMetadata | undefined;
|
|
1414
|
+
/**
|
|
1415
|
+
* <p>Describes the components of a notification message.</p>
|
|
1416
|
+
* @public
|
|
1417
|
+
*/
|
|
1418
|
+
messageComponents: MessageComponents | undefined;
|
|
1419
|
+
/**
|
|
1420
|
+
* <p>The source event URL.</p>
|
|
1421
|
+
* @public
|
|
1422
|
+
*/
|
|
1423
|
+
sourceEventDetailUrl?: string | undefined;
|
|
1424
|
+
/**
|
|
1425
|
+
* <p>The detailed URL for the source event.</p>
|
|
1426
|
+
* @public
|
|
1427
|
+
*/
|
|
1428
|
+
sourceEventDetailUrlDisplayText?: string | undefined;
|
|
1429
|
+
/**
|
|
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 EventRules are <code>ACTIVE</code> and any call can be run.</p>
|
|
1494
|
+
* </li>
|
|
1495
|
+
* </ul>
|
|
1496
|
+
* </li>
|
|
1497
|
+
* <li>
|
|
1498
|
+
* <p>
|
|
1499
|
+
* <code>UNHEALTHY</code>
|
|
1500
|
+
* </p>
|
|
1501
|
+
* <ul>
|
|
1502
|
+
* <li>
|
|
1503
|
+
* <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p>
|
|
1504
|
+
* </li>
|
|
1505
|
+
* </ul>
|
|
1506
|
+
* </li>
|
|
1507
|
+
* </ul>
|
|
1508
|
+
* </li>
|
|
1509
|
+
* </ul>
|
|
1510
|
+
* @public
|
|
1511
|
+
*/
|
|
1512
|
+
eventStatus?: EventStatus | undefined;
|
|
1513
|
+
/**
|
|
1514
|
+
* <p>The NotificationConfiguration's aggregation type.</p>
|
|
1515
|
+
* <ul>
|
|
1516
|
+
* <li>
|
|
1517
|
+
* <p>Values:</p>
|
|
1518
|
+
* <ul>
|
|
1519
|
+
* <li>
|
|
1520
|
+
* <p>
|
|
1521
|
+
* <code>AGGREGATE</code>
|
|
1522
|
+
* </p>
|
|
1523
|
+
* <ul>
|
|
1524
|
+
* <li>
|
|
1525
|
+
* <p>The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.</p>
|
|
1526
|
+
* </li>
|
|
1527
|
+
* </ul>
|
|
1528
|
+
* </li>
|
|
1529
|
+
* <li>
|
|
1530
|
+
* <p>
|
|
1531
|
+
* <code>CHILD</code>
|
|
1532
|
+
* </p>
|
|
1533
|
+
* <ul>
|
|
1534
|
+
* <li>
|
|
1535
|
+
* <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p>
|
|
1536
|
+
* </li>
|
|
1537
|
+
* </ul>
|
|
1538
|
+
* </li>
|
|
1539
|
+
* <li>
|
|
1540
|
+
* <p>
|
|
1541
|
+
* <code>NONE</code>
|
|
1542
|
+
* </p>
|
|
1543
|
+
* <ul>
|
|
1544
|
+
* <li>
|
|
1545
|
+
* <p>The notification isn't aggregated.</p>
|
|
1546
|
+
* </li>
|
|
1547
|
+
* </ul>
|
|
1548
|
+
* </li>
|
|
1549
|
+
* </ul>
|
|
1550
|
+
* </li>
|
|
1551
|
+
* </ul>
|
|
1552
|
+
* @public
|
|
1553
|
+
*/
|
|
1554
|
+
aggregationEventType?: AggregationEventType | undefined;
|
|
1555
|
+
/**
|
|
1556
|
+
* <p>If the value of aggregationEventType is not <code>NONE</code>, this is the Amazon Resource Event (ARN) of the parent aggregate notification.</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>
|
|
1568
|
+
* @public
|
|
1569
|
+
*/
|
|
1570
|
+
endTime?: Date | undefined;
|
|
1571
|
+
/**
|
|
1572
|
+
* <p>A list of text values.</p>
|
|
1573
|
+
* @public
|
|
1574
|
+
*/
|
|
1575
|
+
textParts: Record<string, TextPartValue> | undefined;
|
|
1576
|
+
/**
|
|
1577
|
+
* <p>A list of media elements.</p>
|
|
1578
|
+
* @public
|
|
1579
|
+
*/
|
|
1580
|
+
media: MediaElement[] | undefined;
|
|
1581
|
+
}
|
|
1582
|
+
/**
|
|
1583
|
+
* @public
|
|
1584
|
+
*/
|
|
1585
|
+
export interface GetNotificationEventResponse {
|
|
1586
|
+
/**
|
|
1587
|
+
* <p>The ARN of the resource.</p>
|
|
1588
|
+
* @public
|
|
1589
|
+
*/
|
|
1590
|
+
arn: string | undefined;
|
|
1591
|
+
/**
|
|
1592
|
+
* <p>The ARN of the NotificationConfiguration.</p>
|
|
1593
|
+
* @public
|
|
1594
|
+
*/
|
|
1595
|
+
notificationConfigurationArn: string | undefined;
|
|
1596
|
+
/**
|
|
1597
|
+
* <p>The creation time of the NotificationEvent.</p>
|
|
1598
|
+
* @public
|
|
1599
|
+
*/
|
|
1600
|
+
creationTime: Date | undefined;
|
|
1601
|
+
/**
|
|
1602
|
+
* <p>The content of the NotificationEvent.</p>
|
|
1603
|
+
* @public
|
|
1604
|
+
*/
|
|
1605
|
+
content: NotificationEventSchema | undefined;
|
|
1606
|
+
}
|
|
1607
|
+
/**
|
|
1608
|
+
* @public
|
|
1609
|
+
*/
|
|
1610
|
+
export interface ListNotificationConfigurationsRequest {
|
|
1611
|
+
/**
|
|
1612
|
+
* <p>The matched event source.</p>
|
|
1613
|
+
* <p>Must match one of the valid EventBridge sources. Only AWS 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 AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1614
|
+
* @public
|
|
1615
|
+
*/
|
|
1616
|
+
eventRuleSource?: string | undefined;
|
|
1617
|
+
/**
|
|
1618
|
+
* <p>The Amazon Resource Name (ARN) of the Channel to match.</p>
|
|
1619
|
+
* @public
|
|
1620
|
+
*/
|
|
1621
|
+
channelArn?: string | undefined;
|
|
1622
|
+
/**
|
|
1623
|
+
* <p>The NotificationConfiguration status to match.</p>
|
|
1624
|
+
* <ul>
|
|
1625
|
+
* <li>
|
|
1626
|
+
* <p>Values:</p>
|
|
1627
|
+
* <ul>
|
|
1628
|
+
* <li>
|
|
1629
|
+
* <p>
|
|
1630
|
+
* <code>ACTIVE</code>
|
|
1631
|
+
* </p>
|
|
1632
|
+
* <ul>
|
|
1633
|
+
* <li>
|
|
1634
|
+
* <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p>
|
|
1635
|
+
* </li>
|
|
1636
|
+
* </ul>
|
|
1637
|
+
* </li>
|
|
1638
|
+
* <li>
|
|
1639
|
+
* <p>
|
|
1640
|
+
* <code>PARTIALLY_ACTIVE</code>
|
|
1641
|
+
* </p>
|
|
1642
|
+
* <ul>
|
|
1643
|
+
* <li>
|
|
1644
|
+
* <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p>
|
|
1645
|
+
* </li>
|
|
1646
|
+
* <li>
|
|
1647
|
+
* <p>Any call can be run.</p>
|
|
1648
|
+
* </li>
|
|
1649
|
+
* </ul>
|
|
1650
|
+
* </li>
|
|
1651
|
+
* <li>
|
|
1652
|
+
* <p>
|
|
1653
|
+
* <code>INACTIVE</code>
|
|
1654
|
+
* </p>
|
|
1655
|
+
* <ul>
|
|
1656
|
+
* <li>
|
|
1657
|
+
* <p>All EventRules are <code>INACTIVE</code> and any call can be run.</p>
|
|
1658
|
+
* </li>
|
|
1659
|
+
* </ul>
|
|
1660
|
+
* </li>
|
|
1661
|
+
* <li>
|
|
1662
|
+
* <p>
|
|
1663
|
+
* <code>DELETING</code>
|
|
1664
|
+
* </p>
|
|
1665
|
+
* <ul>
|
|
1666
|
+
* <li>
|
|
1667
|
+
* <p>This NotificationConfiguration is being deleted.</p>
|
|
1668
|
+
* </li>
|
|
1669
|
+
* <li>
|
|
1670
|
+
* <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p>
|
|
1671
|
+
* </li>
|
|
1672
|
+
* </ul>
|
|
1673
|
+
* </li>
|
|
1674
|
+
* </ul>
|
|
1675
|
+
* </li>
|
|
1676
|
+
* </ul>
|
|
1677
|
+
* @public
|
|
1678
|
+
*/
|
|
1679
|
+
status?: NotificationConfigurationStatus | undefined;
|
|
1680
|
+
/**
|
|
1681
|
+
* <p>The maximum number of results to be returned in this call. Defaults to 20.</p>
|
|
1682
|
+
* @public
|
|
1683
|
+
*/
|
|
1684
|
+
maxResults?: number | undefined;
|
|
1685
|
+
/**
|
|
1686
|
+
* <p>The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.</p>
|
|
1687
|
+
* @public
|
|
1688
|
+
*/
|
|
1689
|
+
nextToken?: string | undefined;
|
|
1690
|
+
}
|
|
1691
|
+
/**
|
|
1692
|
+
* <p>Contains the complete list of fields for a NotificationConfiguration.</p>
|
|
1693
|
+
* @public
|
|
1694
|
+
*/
|
|
1695
|
+
export interface NotificationConfigurationStructure {
|
|
1696
|
+
/**
|
|
1697
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
1698
|
+
* @public
|
|
1699
|
+
*/
|
|
1700
|
+
arn: string | undefined;
|
|
1701
|
+
/**
|
|
1702
|
+
* <p>The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters.</p>
|
|
1703
|
+
* @public
|
|
1704
|
+
*/
|
|
1705
|
+
name: string | undefined;
|
|
1706
|
+
/**
|
|
1707
|
+
* <p>The description of the NotificationConfiguration.</p>
|
|
1708
|
+
* @public
|
|
1709
|
+
*/
|
|
1710
|
+
description: string | undefined;
|
|
1711
|
+
/**
|
|
1712
|
+
* <p>The status of this NotificationConfiguration.</p>
|
|
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>
|
|
1767
|
+
* @public
|
|
1768
|
+
*/
|
|
1769
|
+
status: NotificationConfigurationStatus | undefined;
|
|
1770
|
+
/**
|
|
1771
|
+
* <p>The creation time of the resource.</p>
|
|
1772
|
+
* @public
|
|
1773
|
+
*/
|
|
1774
|
+
creationTime: Date | undefined;
|
|
1775
|
+
/**
|
|
1776
|
+
* <p>The aggregation preference of the NotificationConfiguration.</p>
|
|
1777
|
+
* <ul>
|
|
1778
|
+
* <li>
|
|
1779
|
+
* <p>Values:</p>
|
|
1780
|
+
* <ul>
|
|
1781
|
+
* <li>
|
|
1782
|
+
* <p>
|
|
1783
|
+
* <code>LONG</code>
|
|
1784
|
+
* </p>
|
|
1785
|
+
* <ul>
|
|
1786
|
+
* <li>
|
|
1787
|
+
* <p>Aggregate notifications for long periods of time (12 hours).</p>
|
|
1788
|
+
* </li>
|
|
1789
|
+
* </ul>
|
|
1790
|
+
* </li>
|
|
1791
|
+
* <li>
|
|
1792
|
+
* <p>
|
|
1793
|
+
* <code>SHORT</code>
|
|
1794
|
+
* </p>
|
|
1795
|
+
* <ul>
|
|
1796
|
+
* <li>
|
|
1797
|
+
* <p>Aggregate notifications for short periods of time (5 minutes).</p>
|
|
1798
|
+
* </li>
|
|
1799
|
+
* </ul>
|
|
1800
|
+
* </li>
|
|
1801
|
+
* <li>
|
|
1802
|
+
* <p>
|
|
1803
|
+
* <code>NONE</code>
|
|
1804
|
+
* </p>
|
|
1805
|
+
* <ul>
|
|
1806
|
+
* <li>
|
|
1807
|
+
* <p>Don't aggregate notifications.</p>
|
|
1808
|
+
* <p>No delay in delivery.</p>
|
|
1809
|
+
* </li>
|
|
1810
|
+
* </ul>
|
|
1811
|
+
* </li>
|
|
1812
|
+
* </ul>
|
|
1813
|
+
* </li>
|
|
1814
|
+
* </ul>
|
|
1815
|
+
* @public
|
|
1816
|
+
*/
|
|
1817
|
+
aggregationDuration?: AggregationDuration | undefined;
|
|
1818
|
+
}
|
|
1819
|
+
/**
|
|
1820
|
+
* @public
|
|
1821
|
+
*/
|
|
1822
|
+
export interface ListNotificationConfigurationsResponse {
|
|
1823
|
+
/**
|
|
1824
|
+
* <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>
|
|
1825
|
+
* @public
|
|
1826
|
+
*/
|
|
1827
|
+
nextToken?: string | undefined;
|
|
1828
|
+
/**
|
|
1829
|
+
* <p>The NotificationConfigurations in the account.</p>
|
|
1830
|
+
* @public
|
|
1831
|
+
*/
|
|
1832
|
+
notificationConfigurations: NotificationConfigurationStructure[] | undefined;
|
|
1833
|
+
}
|
|
1834
|
+
/**
|
|
1835
|
+
* @public
|
|
1836
|
+
*/
|
|
1837
|
+
export interface ListNotificationEventsRequest {
|
|
1838
|
+
/**
|
|
1839
|
+
* <p>The earliest time of events to return from this call.</p>
|
|
1840
|
+
* @public
|
|
1841
|
+
*/
|
|
1842
|
+
startTime?: Date | undefined;
|
|
1843
|
+
/**
|
|
1844
|
+
* <p>Latest time of events to return from this call.</p>
|
|
1845
|
+
* @public
|
|
1846
|
+
*/
|
|
1847
|
+
endTime?: Date | undefined;
|
|
1848
|
+
/**
|
|
1849
|
+
* <p>The locale code of the language used for the retrieved NotificationEvent. The default locale is English <code>(en_US)</code>.</p>
|
|
1850
|
+
* @public
|
|
1851
|
+
*/
|
|
1852
|
+
locale?: LocaleCode | undefined;
|
|
1853
|
+
/**
|
|
1854
|
+
* <p>The matched event source.</p>
|
|
1855
|
+
* <p>Must match one of the valid EventBridge sources. Only AWS 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 AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1856
|
+
* @public
|
|
1857
|
+
*/
|
|
1858
|
+
source?: string | undefined;
|
|
1859
|
+
/**
|
|
1860
|
+
* <p>Include aggregated child events in the result.</p>
|
|
1861
|
+
* @public
|
|
1862
|
+
*/
|
|
1863
|
+
includeChildEvents?: boolean | undefined;
|
|
1864
|
+
/**
|
|
1865
|
+
* <p>The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn to match.</p>
|
|
1866
|
+
* @public
|
|
1867
|
+
*/
|
|
1868
|
+
aggregateNotificationEventArn?: string | undefined;
|
|
1869
|
+
/**
|
|
1870
|
+
* <p>The maximum number of results to be returned in this call. Defaults to 20.</p>
|
|
1871
|
+
* @public
|
|
1872
|
+
*/
|
|
1873
|
+
maxResults?: number | undefined;
|
|
1874
|
+
/**
|
|
1875
|
+
* <p>The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.</p>
|
|
1876
|
+
* @public
|
|
1877
|
+
*/
|
|
1878
|
+
nextToken?: string | undefined;
|
|
1879
|
+
}
|
|
1880
|
+
/**
|
|
1881
|
+
* <p>Contains the headline message component.</p>
|
|
1882
|
+
* @public
|
|
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>
|
|
1893
|
+
* @public
|
|
1894
|
+
*/
|
|
1895
|
+
export interface SourceEventMetadataSummary {
|
|
1896
|
+
/**
|
|
1897
|
+
* <p>The Region where the notification originated.</p>
|
|
1898
|
+
* <p>Unavailable for aggregated notifications.</p>
|
|
1899
|
+
* @public
|
|
1900
|
+
*/
|
|
1901
|
+
eventOriginRegion?: string | undefined;
|
|
1902
|
+
/**
|
|
1903
|
+
* <p>The matched event source.</p>
|
|
1904
|
+
* <p>Must match one of the valid EventBridge sources. Only AWS 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 AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1905
|
+
* @public
|
|
1906
|
+
*/
|
|
1907
|
+
source: string | undefined;
|
|
1908
|
+
/**
|
|
1909
|
+
* <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 AWS 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 AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1911
|
+
* @public
|
|
1912
|
+
*/
|
|
1913
|
+
eventType: string | undefined;
|
|
1914
|
+
}
|
|
1915
|
+
/**
|
|
1916
|
+
* <p>Describes a short summary and metadata for a notification event.</p>
|
|
1917
|
+
* @public
|
|
1918
|
+
*/
|
|
1919
|
+
export interface NotificationEventSummary {
|
|
1920
|
+
/**
|
|
1921
|
+
* <p>The schema version of the Notification Event.</p>
|
|
1922
|
+
* @public
|
|
1923
|
+
*/
|
|
1924
|
+
schemaVersion: SchemaVersion | undefined;
|
|
1925
|
+
/**
|
|
1926
|
+
* <p>The source event metadata.</p>
|
|
1927
|
+
* @public
|
|
1928
|
+
*/
|
|
1929
|
+
sourceEventMetadata: SourceEventMetadataSummary | undefined;
|
|
1930
|
+
/**
|
|
1931
|
+
* <p>The message components of a notification event.</p>
|
|
1932
|
+
* @public
|
|
1933
|
+
*/
|
|
1934
|
+
messageComponents: MessageComponentsSummary | undefined;
|
|
1935
|
+
/**
|
|
1936
|
+
* <p>The notification event status.</p>
|
|
1937
|
+
* <ul>
|
|
1938
|
+
* <li>
|
|
1939
|
+
* <p>Values:</p>
|
|
1940
|
+
* <ul>
|
|
1941
|
+
* <li>
|
|
1942
|
+
* <p>
|
|
1943
|
+
* <code>HEALTHY</code>
|
|
1944
|
+
* </p>
|
|
1945
|
+
* <ul>
|
|
1946
|
+
* <li>
|
|
1947
|
+
* <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p>
|
|
1948
|
+
* </li>
|
|
1949
|
+
* </ul>
|
|
1950
|
+
* </li>
|
|
1951
|
+
* <li>
|
|
1952
|
+
* <p>
|
|
1953
|
+
* <code>UNHEALTHY</code>
|
|
1954
|
+
* </p>
|
|
1955
|
+
* <ul>
|
|
1956
|
+
* <li>
|
|
1957
|
+
* <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p>
|
|
1958
|
+
* </li>
|
|
1959
|
+
* </ul>
|
|
1960
|
+
* </li>
|
|
1961
|
+
* </ul>
|
|
1962
|
+
* </li>
|
|
1963
|
+
* </ul>
|
|
1964
|
+
* @public
|
|
1965
|
+
*/
|
|
1966
|
+
eventStatus: EventStatus | undefined;
|
|
1967
|
+
/**
|
|
1968
|
+
* <p>The type of event causing the notification.</p>
|
|
1969
|
+
* <ul>
|
|
1970
|
+
* <li>
|
|
1971
|
+
* <p>Values:</p>
|
|
1972
|
+
* <ul>
|
|
1973
|
+
* <li>
|
|
1974
|
+
* <p>
|
|
1975
|
+
* <code>ALERT</code>
|
|
1976
|
+
* </p>
|
|
1977
|
+
* <ul>
|
|
1978
|
+
* <li>
|
|
1979
|
+
* <p>A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.</p>
|
|
1980
|
+
* </li>
|
|
1981
|
+
* </ul>
|
|
1982
|
+
* </li>
|
|
1983
|
+
* <li>
|
|
1984
|
+
* <p>
|
|
1985
|
+
* <code>WARNING</code>
|
|
1986
|
+
* </p>
|
|
1987
|
+
* <ul>
|
|
1988
|
+
* <li>
|
|
1989
|
+
* <p>A notification about an event where an issue is about to arise. For example, something is approaching a threshold.</p>
|
|
1990
|
+
* </li>
|
|
1991
|
+
* </ul>
|
|
1992
|
+
* </li>
|
|
1993
|
+
* <li>
|
|
1994
|
+
* <p>
|
|
1995
|
+
* <code>ANNOUNCEMENT</code>
|
|
1996
|
+
* </p>
|
|
1997
|
+
* <ul>
|
|
1998
|
+
* <li>
|
|
1999
|
+
* <p>A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.</p>
|
|
2000
|
+
* </li>
|
|
2001
|
+
* </ul>
|
|
2002
|
+
* </li>
|
|
2003
|
+
* <li>
|
|
2004
|
+
* <p>
|
|
2005
|
+
* <code>INFORMATIONAL</code>
|
|
2006
|
+
* </p>
|
|
2007
|
+
* <ul>
|
|
2008
|
+
* <li>
|
|
2009
|
+
* <p>A notification about informational messages. For example, recommendations, service announcements, or reminders.</p>
|
|
2010
|
+
* </li>
|
|
2011
|
+
* </ul>
|
|
2012
|
+
* </li>
|
|
2013
|
+
* </ul>
|
|
2014
|
+
* </li>
|
|
2015
|
+
* </ul>
|
|
2016
|
+
* @public
|
|
2017
|
+
*/
|
|
2018
|
+
notificationType: NotificationType | undefined;
|
|
2019
|
+
}
|
|
2020
|
+
/**
|
|
2021
|
+
* <p>Describes a short summary of a NotificationEvent. This is only used when listing notification events.</p>
|
|
2022
|
+
* @public
|
|
2023
|
+
*/
|
|
2024
|
+
export interface NotificationEventOverview {
|
|
2025
|
+
/**
|
|
2026
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
2027
|
+
* @public
|
|
2028
|
+
*/
|
|
2029
|
+
arn: string | undefined;
|
|
2030
|
+
/**
|
|
2031
|
+
* <p>The ARN of the NotificationConfiguration.</p>
|
|
2032
|
+
* @public
|
|
2033
|
+
*/
|
|
2034
|
+
notificationConfigurationArn: string | undefined;
|
|
2035
|
+
/**
|
|
2036
|
+
* <p>The account name containing the NotificationHub.</p>
|
|
2037
|
+
* @public
|
|
2038
|
+
*/
|
|
2039
|
+
relatedAccount: string | undefined;
|
|
2040
|
+
/**
|
|
2041
|
+
* <p>The creation time of the NotificationEvent.</p>
|
|
2042
|
+
* @public
|
|
2043
|
+
*/
|
|
2044
|
+
creationTime: Date | undefined;
|
|
2045
|
+
/**
|
|
2046
|
+
* <p>Refers to a NotificationEventSummary object.</p>
|
|
2047
|
+
* <p>Similar in structure to <code>content</code> in the GetNotificationEvent response.</p>
|
|
2048
|
+
* @public
|
|
2049
|
+
*/
|
|
2050
|
+
notificationEvent: NotificationEventSummary | undefined;
|
|
2051
|
+
/**
|
|
2052
|
+
* <p>The NotificationConfiguration's aggregation type.</p>
|
|
2053
|
+
* <ul>
|
|
2054
|
+
* <li>
|
|
2055
|
+
* <p>Values:</p>
|
|
2056
|
+
* <ul>
|
|
2057
|
+
* <li>
|
|
2058
|
+
* <p>
|
|
2059
|
+
* <code>AGGREGATE</code>
|
|
2060
|
+
* </p>
|
|
2061
|
+
* <ul>
|
|
2062
|
+
* <li>
|
|
2063
|
+
* <p>The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.</p>
|
|
2064
|
+
* </li>
|
|
2065
|
+
* </ul>
|
|
2066
|
+
* </li>
|
|
2067
|
+
* <li>
|
|
2068
|
+
* <p>
|
|
2069
|
+
* <code>CHILD</code>
|
|
2070
|
+
* </p>
|
|
2071
|
+
* <ul>
|
|
2072
|
+
* <li>
|
|
2073
|
+
* <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p>
|
|
2074
|
+
* </li>
|
|
2075
|
+
* </ul>
|
|
2076
|
+
* </li>
|
|
2077
|
+
* <li>
|
|
2078
|
+
* <p>
|
|
2079
|
+
* <code>NONE</code>
|
|
2080
|
+
* </p>
|
|
2081
|
+
* <ul>
|
|
2082
|
+
* <li>
|
|
2083
|
+
* <p>The notification isn't aggregated.</p>
|
|
2084
|
+
* </li>
|
|
2085
|
+
* </ul>
|
|
2086
|
+
* </li>
|
|
2087
|
+
* </ul>
|
|
2088
|
+
* </li>
|
|
2089
|
+
* </ul>
|
|
2090
|
+
* @public
|
|
2091
|
+
*/
|
|
2092
|
+
aggregationEventType?: AggregationEventType | undefined;
|
|
2093
|
+
/**
|
|
2094
|
+
* <p>The ARN of the aggregatedNotificationEventArn to match.</p>
|
|
2095
|
+
* @public
|
|
2096
|
+
*/
|
|
2097
|
+
aggregateNotificationEventArn?: string | undefined;
|
|
2098
|
+
}
|
|
2099
|
+
/**
|
|
2100
|
+
* @public
|
|
2101
|
+
*/
|
|
2102
|
+
export interface ListNotificationEventsResponse {
|
|
2103
|
+
/**
|
|
2104
|
+
* <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>
|
|
2105
|
+
* @public
|
|
2106
|
+
*/
|
|
2107
|
+
nextToken?: string | undefined;
|
|
2108
|
+
/**
|
|
2109
|
+
* <p>The list of notification events.</p>
|
|
2110
|
+
* @public
|
|
2111
|
+
*/
|
|
2112
|
+
notificationEvents: NotificationEventOverview[] | undefined;
|
|
2113
|
+
}
|
|
2114
|
+
/**
|
|
2115
|
+
* @public
|
|
2116
|
+
*/
|
|
2117
|
+
export interface ListNotificationHubsRequest {
|
|
2118
|
+
/**
|
|
2119
|
+
* <p>The maximum number of records to list in a single response.</p>
|
|
2120
|
+
* @public
|
|
2121
|
+
*/
|
|
2122
|
+
maxResults?: number | undefined;
|
|
2123
|
+
/**
|
|
2124
|
+
* <p>A pagination token. Set to null to start listing notification hubs from the start.</p>
|
|
2125
|
+
* @public
|
|
2126
|
+
*/
|
|
2127
|
+
nextToken?: string | undefined;
|
|
2128
|
+
}
|
|
2129
|
+
/**
|
|
2130
|
+
* <p>Describes an overview of a NotificationHub.</p>
|
|
2131
|
+
* <p>A NotificationHub is an account-level setting used to select the Regions where you want to store, process and replicate your notifications.</p>
|
|
2132
|
+
* @public
|
|
2133
|
+
*/
|
|
2134
|
+
export interface NotificationHubOverview {
|
|
2135
|
+
/**
|
|
2136
|
+
* <p>The Region of the resource.</p>
|
|
2137
|
+
* @public
|
|
2138
|
+
*/
|
|
2139
|
+
notificationHubRegion: string | undefined;
|
|
2140
|
+
/**
|
|
2141
|
+
* <p>The status summary of the resource.</p>
|
|
2142
|
+
* @public
|
|
2143
|
+
*/
|
|
2144
|
+
statusSummary: NotificationHubStatusSummary | undefined;
|
|
2145
|
+
/**
|
|
2146
|
+
* <p>The date and time the resource was created.</p>
|
|
2147
|
+
* @public
|
|
2148
|
+
*/
|
|
2149
|
+
creationTime: Date | undefined;
|
|
2150
|
+
/**
|
|
2151
|
+
* <p>The most recent time this NotificationHub had an ACTIVE status.</p>
|
|
2152
|
+
* @public
|
|
2153
|
+
*/
|
|
2154
|
+
lastActivationTime?: Date | undefined;
|
|
2155
|
+
}
|
|
2156
|
+
/**
|
|
2157
|
+
* @public
|
|
2158
|
+
*/
|
|
2159
|
+
export interface ListNotificationHubsResponse {
|
|
2160
|
+
/**
|
|
2161
|
+
* <p>The NotificationHubs in the account.</p>
|
|
2162
|
+
* @public
|
|
2163
|
+
*/
|
|
2164
|
+
notificationHubs: NotificationHubOverview[] | undefined;
|
|
2165
|
+
/**
|
|
2166
|
+
* <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>
|
|
2167
|
+
* @public
|
|
2168
|
+
*/
|
|
2169
|
+
nextToken?: string | undefined;
|
|
2170
|
+
}
|
|
2171
|
+
/**
|
|
2172
|
+
* @public
|
|
2173
|
+
*/
|
|
2174
|
+
export interface ListTagsForResourceRequest {
|
|
2175
|
+
/**
|
|
2176
|
+
* <p>The Amazon Resource Name (ARN) to use to list tags.</p>
|
|
2177
|
+
* @public
|
|
2178
|
+
*/
|
|
2179
|
+
arn: string | undefined;
|
|
2180
|
+
}
|
|
2181
|
+
/**
|
|
2182
|
+
* @public
|
|
2183
|
+
*/
|
|
2184
|
+
export interface ListTagsForResourceResponse {
|
|
2185
|
+
/**
|
|
2186
|
+
* <p>A list of tags for the specified ARN.</p>
|
|
2187
|
+
* @public
|
|
2188
|
+
*/
|
|
2189
|
+
tags?: Record<string, string> | undefined;
|
|
2190
|
+
}
|
|
2191
|
+
/**
|
|
2192
|
+
* @public
|
|
2193
|
+
*/
|
|
2194
|
+
export interface UpdateNotificationConfigurationRequest {
|
|
2195
|
+
/**
|
|
2196
|
+
* <p>The Amazon Resource Name (ARN) used to update the NotificationConfiguration.</p>
|
|
2197
|
+
* @public
|
|
2198
|
+
*/
|
|
2199
|
+
arn: string | undefined;
|
|
2200
|
+
/**
|
|
2201
|
+
* <p>The name of the NotificationConfiguration.</p>
|
|
2202
|
+
* @public
|
|
2203
|
+
*/
|
|
2204
|
+
name?: string | undefined;
|
|
2205
|
+
/**
|
|
2206
|
+
* <p>The description of the NotificationConfiguration.</p>
|
|
2207
|
+
* @public
|
|
2208
|
+
*/
|
|
2209
|
+
description?: string | undefined;
|
|
2210
|
+
/**
|
|
2211
|
+
* <p>The status of this NotificationConfiguration.</p>
|
|
2212
|
+
* <p>The status should always be <code>INACTIVE</code> when part of the CreateNotificationConfiguration response.</p>
|
|
2213
|
+
* <ul>
|
|
2214
|
+
* <li>
|
|
2215
|
+
* <p>Values:</p>
|
|
2216
|
+
* <ul>
|
|
2217
|
+
* <li>
|
|
2218
|
+
* <p>
|
|
2219
|
+
* <code>ACTIVE</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>
|
|
2230
|
+
* </p>
|
|
2231
|
+
* <ul>
|
|
2232
|
+
* <li>
|
|
2233
|
+
* <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p>
|
|
2234
|
+
* </li>
|
|
2235
|
+
* <li>
|
|
2236
|
+
* <p>Any call can be run.</p>
|
|
2237
|
+
* </li>
|
|
2238
|
+
* </ul>
|
|
2239
|
+
* </li>
|
|
2240
|
+
* <li>
|
|
2241
|
+
* <p>
|
|
2242
|
+
* <code>INACTIVE</code>
|
|
2243
|
+
* </p>
|
|
2244
|
+
* <ul>
|
|
2245
|
+
* <li>
|
|
2246
|
+
* <p>All EventRules are <code>INACTIVE</code> and any call can be run.</p>
|
|
2247
|
+
* </li>
|
|
2248
|
+
* </ul>
|
|
2249
|
+
* </li>
|
|
2250
|
+
* <li>
|
|
2251
|
+
* <p>
|
|
2252
|
+
* <code>DELETING</code>
|
|
2253
|
+
* </p>
|
|
2254
|
+
* <ul>
|
|
2255
|
+
* <li>
|
|
2256
|
+
* <p>This NotificationConfiguration is being deleted.</p>
|
|
2257
|
+
* </li>
|
|
2258
|
+
* <li>
|
|
2259
|
+
* <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p>
|
|
2260
|
+
* </li>
|
|
2261
|
+
* </ul>
|
|
2262
|
+
* </li>
|
|
2263
|
+
* </ul>
|
|
2264
|
+
* </li>
|
|
2265
|
+
* </ul>
|
|
2266
|
+
* @public
|
|
2267
|
+
*/
|
|
2268
|
+
aggregationDuration?: AggregationDuration | undefined;
|
|
2269
|
+
}
|
|
2270
|
+
/**
|
|
2271
|
+
* @public
|
|
2272
|
+
*/
|
|
2273
|
+
export interface UpdateNotificationConfigurationResponse {
|
|
2274
|
+
/**
|
|
2275
|
+
* <p>The ARN used to update the NotificationConfiguration.</p>
|
|
2276
|
+
* @public
|
|
2277
|
+
*/
|
|
2278
|
+
arn: string | undefined;
|
|
2279
|
+
}
|
|
2280
|
+
/**
|
|
2281
|
+
* @public
|
|
2282
|
+
*/
|
|
2283
|
+
export interface RegisterNotificationHubRequest {
|
|
2284
|
+
/**
|
|
2285
|
+
* <p>The Region of the NotificationHub.</p>
|
|
2286
|
+
* @public
|
|
2287
|
+
*/
|
|
2288
|
+
notificationHubRegion: string | undefined;
|
|
2289
|
+
}
|
|
2290
|
+
/**
|
|
2291
|
+
* @public
|
|
2292
|
+
*/
|
|
2293
|
+
export interface RegisterNotificationHubResponse {
|
|
2294
|
+
/**
|
|
2295
|
+
* <p>The Region of the NotificationHub.</p>
|
|
2296
|
+
* @public
|
|
2297
|
+
*/
|
|
2298
|
+
notificationHubRegion: string | undefined;
|
|
2299
|
+
/**
|
|
2300
|
+
* <p>NotificationHub status information.</p>
|
|
2301
|
+
* @public
|
|
2302
|
+
*/
|
|
2303
|
+
statusSummary: NotificationHubStatusSummary | undefined;
|
|
2304
|
+
/**
|
|
2305
|
+
* <p>The date the resource was created.</p>
|
|
2306
|
+
* @public
|
|
2307
|
+
*/
|
|
2308
|
+
creationTime: Date | undefined;
|
|
2309
|
+
/**
|
|
2310
|
+
* <p>The date the resource was last activated.</p>
|
|
2311
|
+
* @public
|
|
2312
|
+
*/
|
|
2313
|
+
lastActivationTime?: Date | undefined;
|
|
2314
|
+
}
|
|
2315
|
+
/**
|
|
2316
|
+
* @public
|
|
2317
|
+
*/
|
|
2318
|
+
export interface TagResourceRequest {
|
|
2319
|
+
/**
|
|
2320
|
+
* <p>The Amazon Resource Name (ARN) to use to tag a resource.</p>
|
|
2321
|
+
* @public
|
|
2322
|
+
*/
|
|
2323
|
+
arn: string | undefined;
|
|
2324
|
+
/**
|
|
2325
|
+
* <p>A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.</p>
|
|
2326
|
+
* @public
|
|
2327
|
+
*/
|
|
2328
|
+
tags: Record<string, string> | undefined;
|
|
2329
|
+
}
|
|
2330
|
+
/**
|
|
2331
|
+
* @public
|
|
2332
|
+
*/
|
|
2333
|
+
export interface TagResourceResponse {
|
|
2334
|
+
}
|
|
2335
|
+
/**
|
|
2336
|
+
* @public
|
|
2337
|
+
*/
|
|
2338
|
+
export interface UntagResourceRequest {
|
|
2339
|
+
/**
|
|
2340
|
+
* <p>The Amazon Resource Name (ARN) to use to untag a resource.</p>
|
|
2341
|
+
* @public
|
|
2342
|
+
*/
|
|
2343
|
+
arn: string | undefined;
|
|
2344
|
+
/**
|
|
2345
|
+
* <p>The tag keys to use to untag a resource.</p>
|
|
2346
|
+
* @public
|
|
2347
|
+
*/
|
|
2348
|
+
tagKeys: string[] | undefined;
|
|
2349
|
+
}
|
|
2350
|
+
/**
|
|
2351
|
+
* @public
|
|
2352
|
+
*/
|
|
2353
|
+
export interface UntagResourceResponse {
|
|
2354
|
+
}
|