1 | import {Request} from '../lib/request';
|
2 | import {Response} from '../lib/response';
|
3 | import {AWSError} from '../lib/error';
|
4 | import {Service} from '../lib/service';
|
5 | import {ServiceConfigurationOptions} from '../lib/service';
|
6 | import {ConfigBase as Config} from '../lib/config';
|
7 | interface Blob {}
|
8 | declare class CodeStarNotifications extends Service {
|
9 | |
10 |
|
11 |
|
12 | constructor(options?: CodeStarNotifications.Types.ClientConfiguration)
|
13 | config: Config & CodeStarNotifications.Types.ClientConfiguration;
|
14 | /**
|
15 | * Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as SNS topics) where you want to receive them.
|
16 | */
|
17 | createNotificationRule(params: CodeStarNotifications.Types.CreateNotificationRuleRequest, callback?: (err: AWSError, data: CodeStarNotifications.Types.CreateNotificationRuleResult) => void): Request<CodeStarNotifications.Types.CreateNotificationRuleResult, AWSError>;
|
18 | /**
|
19 | * Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as SNS topics) where you want to receive them.
|
20 | */
|
21 | createNotificationRule(callback?: (err: AWSError, data: CodeStarNotifications.Types.CreateNotificationRuleResult) => void): Request<CodeStarNotifications.Types.CreateNotificationRuleResult, AWSError>;
|
22 | /**
|
23 | * Deletes a notification rule for a resource.
|
24 | */
|
25 | deleteNotificationRule(params: CodeStarNotifications.Types.DeleteNotificationRuleRequest, callback?: (err: AWSError, data: CodeStarNotifications.Types.DeleteNotificationRuleResult) => void): Request<CodeStarNotifications.Types.DeleteNotificationRuleResult, AWSError>;
|
26 | /**
|
27 | * Deletes a notification rule for a resource.
|
28 | */
|
29 | deleteNotificationRule(callback?: (err: AWSError, data: CodeStarNotifications.Types.DeleteNotificationRuleResult) => void): Request<CodeStarNotifications.Types.DeleteNotificationRuleResult, AWSError>;
|
30 | /**
|
31 | * Deletes a specified target for notifications.
|
32 | */
|
33 | deleteTarget(params: CodeStarNotifications.Types.DeleteTargetRequest, callback?: (err: AWSError, data: CodeStarNotifications.Types.DeleteTargetResult) => void): Request<CodeStarNotifications.Types.DeleteTargetResult, AWSError>;
|
34 | /**
|
35 | * Deletes a specified target for notifications.
|
36 | */
|
37 | deleteTarget(callback?: (err: AWSError, data: CodeStarNotifications.Types.DeleteTargetResult) => void): Request<CodeStarNotifications.Types.DeleteTargetResult, AWSError>;
|
38 | /**
|
39 | * Returns information about a specified notification rule.
|
40 | */
|
41 | describeNotificationRule(params: CodeStarNotifications.Types.DescribeNotificationRuleRequest, callback?: (err: AWSError, data: CodeStarNotifications.Types.DescribeNotificationRuleResult) => void): Request<CodeStarNotifications.Types.DescribeNotificationRuleResult, AWSError>;
|
42 | /**
|
43 | * Returns information about a specified notification rule.
|
44 | */
|
45 | describeNotificationRule(callback?: (err: AWSError, data: CodeStarNotifications.Types.DescribeNotificationRuleResult) => void): Request<CodeStarNotifications.Types.DescribeNotificationRuleResult, AWSError>;
|
46 | /**
|
47 | * Returns information about the event types available for configuring notifications.
|
48 | */
|
49 | listEventTypes(params: CodeStarNotifications.Types.ListEventTypesRequest, callback?: (err: AWSError, data: CodeStarNotifications.Types.ListEventTypesResult) => void): Request<CodeStarNotifications.Types.ListEventTypesResult, AWSError>;
|
50 | /**
|
51 | * Returns information about the event types available for configuring notifications.
|
52 | */
|
53 | listEventTypes(callback?: (err: AWSError, data: CodeStarNotifications.Types.ListEventTypesResult) => void): Request<CodeStarNotifications.Types.ListEventTypesResult, AWSError>;
|
54 | /**
|
55 | * Returns a list of the notification rules for an AWS account.
|
56 | */
|
57 | listNotificationRules(params: CodeStarNotifications.Types.ListNotificationRulesRequest, callback?: (err: AWSError, data: CodeStarNotifications.Types.ListNotificationRulesResult) => void): Request<CodeStarNotifications.Types.ListNotificationRulesResult, AWSError>;
|
58 | /**
|
59 | * Returns a list of the notification rules for an AWS account.
|
60 | */
|
61 | listNotificationRules(callback?: (err: AWSError, data: CodeStarNotifications.Types.ListNotificationRulesResult) => void): Request<CodeStarNotifications.Types.ListNotificationRulesResult, AWSError>;
|
62 | /**
|
63 | * Returns a list of the tags associated with a notification rule.
|
64 | */
|
65 | listTagsForResource(params: CodeStarNotifications.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: CodeStarNotifications.Types.ListTagsForResourceResult) => void): Request<CodeStarNotifications.Types.ListTagsForResourceResult, AWSError>;
|
66 | /**
|
67 | * Returns a list of the tags associated with a notification rule.
|
68 | */
|
69 | listTagsForResource(callback?: (err: AWSError, data: CodeStarNotifications.Types.ListTagsForResourceResult) => void): Request<CodeStarNotifications.Types.ListTagsForResourceResult, AWSError>;
|
70 | /**
|
71 | * Returns a list of the notification rule targets for an AWS account.
|
72 | */
|
73 | listTargets(params: CodeStarNotifications.Types.ListTargetsRequest, callback?: (err: AWSError, data: CodeStarNotifications.Types.ListTargetsResult) => void): Request<CodeStarNotifications.Types.ListTargetsResult, AWSError>;
|
74 | /**
|
75 | * Returns a list of the notification rule targets for an AWS account.
|
76 | */
|
77 | listTargets(callback?: (err: AWSError, data: CodeStarNotifications.Types.ListTargetsResult) => void): Request<CodeStarNotifications.Types.ListTargetsResult, AWSError>;
|
78 | /**
|
79 | * Creates an association between a notification rule and an SNS topic so that the associated target can receive notifications when the events described in the rule are triggered.
|
80 | */
|
81 | subscribe(params: CodeStarNotifications.Types.SubscribeRequest, callback?: (err: AWSError, data: CodeStarNotifications.Types.SubscribeResult) => void): Request<CodeStarNotifications.Types.SubscribeResult, AWSError>;
|
82 | /**
|
83 | * Creates an association between a notification rule and an SNS topic so that the associated target can receive notifications when the events described in the rule are triggered.
|
84 | */
|
85 | subscribe(callback?: (err: AWSError, data: CodeStarNotifications.Types.SubscribeResult) => void): Request<CodeStarNotifications.Types.SubscribeResult, AWSError>;
|
86 | /**
|
87 | * Associates a set of provided tags with a notification rule.
|
88 | */
|
89 | tagResource(params: CodeStarNotifications.Types.TagResourceRequest, callback?: (err: AWSError, data: CodeStarNotifications.Types.TagResourceResult) => void): Request<CodeStarNotifications.Types.TagResourceResult, AWSError>;
|
90 | /**
|
91 | * Associates a set of provided tags with a notification rule.
|
92 | */
|
93 | tagResource(callback?: (err: AWSError, data: CodeStarNotifications.Types.TagResourceResult) => void): Request<CodeStarNotifications.Types.TagResourceResult, AWSError>;
|
94 | /**
|
95 | * Removes an association between a notification rule and an Amazon SNS topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.
|
96 | */
|
97 | unsubscribe(params: CodeStarNotifications.Types.UnsubscribeRequest, callback?: (err: AWSError, data: CodeStarNotifications.Types.UnsubscribeResult) => void): Request<CodeStarNotifications.Types.UnsubscribeResult, AWSError>;
|
98 | /**
|
99 | * Removes an association between a notification rule and an Amazon SNS topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.
|
100 | */
|
101 | unsubscribe(callback?: (err: AWSError, data: CodeStarNotifications.Types.UnsubscribeResult) => void): Request<CodeStarNotifications.Types.UnsubscribeResult, AWSError>;
|
102 | /**
|
103 | * Removes the association between one or more provided tags and a notification rule.
|
104 | */
|
105 | untagResource(params: CodeStarNotifications.Types.UntagResourceRequest, callback?: (err: AWSError, data: CodeStarNotifications.Types.UntagResourceResult) => void): Request<CodeStarNotifications.Types.UntagResourceResult, AWSError>;
|
106 | /**
|
107 | * Removes the association between one or more provided tags and a notification rule.
|
108 | */
|
109 | untagResource(callback?: (err: AWSError, data: CodeStarNotifications.Types.UntagResourceResult) => void): Request<CodeStarNotifications.Types.UntagResourceResult, AWSError>;
|
110 | /**
|
111 | * Updates a notification rule for a resource. You can change the events that trigger the notification rule, the status of the rule, and the targets that receive the notifications. To add or remove tags for a notification rule, you must use TagResource and UntagResource.
|
112 | */
|
113 | updateNotificationRule(params: CodeStarNotifications.Types.UpdateNotificationRuleRequest, callback?: (err: AWSError, data: CodeStarNotifications.Types.UpdateNotificationRuleResult) => void): Request<CodeStarNotifications.Types.UpdateNotificationRuleResult, AWSError>;
|
114 | /**
|
115 | * Updates a notification rule for a resource. You can change the events that trigger the notification rule, the status of the rule, and the targets that receive the notifications. To add or remove tags for a notification rule, you must use TagResource and UntagResource.
|
116 | */
|
117 | updateNotificationRule(callback?: (err: AWSError, data: CodeStarNotifications.Types.UpdateNotificationRuleResult) => void): Request<CodeStarNotifications.Types.UpdateNotificationRuleResult, AWSError>;
|
118 | }
|
119 | declare namespace CodeStarNotifications {
|
120 | export type ClientRequestToken = string;
|
121 | export interface CreateNotificationRuleRequest {
|
122 | |
123 |
|
124 |
|
125 | Name: NotificationRuleName;
|
126 | |
127 |
|
128 |
|
129 | EventTypeIds: EventTypeIds;
|
130 | |
131 |
|
132 |
|
133 | Resource: NotificationRuleResource;
|
134 | |
135 |
|
136 |
|
137 | Targets: Targets;
|
138 | |
139 |
|
140 |
|
141 | DetailType: DetailType;
|
142 | |
143 |
|
144 |
|
145 | ClientRequestToken?: ClientRequestToken;
|
146 | |
147 |
|
148 |
|
149 | Tags?: Tags;
|
150 | |
151 |
|
152 |
|
153 | Status?: NotificationRuleStatus;
|
154 | }
|
155 | export interface CreateNotificationRuleResult {
|
156 | |
157 |
|
158 |
|
159 | Arn?: NotificationRuleArn;
|
160 | }
|
161 | export type CreatedTimestamp = Date;
|
162 | export interface DeleteNotificationRuleRequest {
|
163 | |
164 |
|
165 |
|
166 | Arn: NotificationRuleArn;
|
167 | }
|
168 | export interface DeleteNotificationRuleResult {
|
169 | |
170 |
|
171 |
|
172 | Arn?: NotificationRuleArn;
|
173 | }
|
174 | export interface DeleteTargetRequest {
|
175 | |
176 |
|
177 |
|
178 | TargetAddress: TargetAddress;
|
179 | |
180 |
|
181 |
|
182 | ForceUnsubscribeAll?: ForceUnsubscribeAll;
|
183 | }
|
184 | export interface DeleteTargetResult {
|
185 | }
|
186 | export interface DescribeNotificationRuleRequest {
|
187 | |
188 |
|
189 |
|
190 | Arn: NotificationRuleArn;
|
191 | }
|
192 | export interface DescribeNotificationRuleResult {
|
193 | |
194 |
|
195 |
|
196 | Arn: NotificationRuleArn;
|
197 | |
198 |
|
199 |
|
200 | Name?: NotificationRuleName;
|
201 | |
202 |
|
203 |
|
204 | EventTypes?: EventTypeBatch;
|
205 | |
206 |
|
207 |
|
208 | Resource?: NotificationRuleResource;
|
209 | |
210 |
|
211 |
|
212 | Targets?: TargetsBatch;
|
213 | |
214 |
|
215 |
|
216 | DetailType?: DetailType;
|
217 | |
218 |
|
219 |
|
220 | CreatedBy?: NotificationRuleCreatedBy;
|
221 | |
222 |
|
223 |
|
224 | Status?: NotificationRuleStatus;
|
225 | |
226 |
|
227 |
|
228 | CreatedTimestamp?: CreatedTimestamp;
|
229 | |
230 |
|
231 |
|
232 | LastModifiedTimestamp?: LastModifiedTimestamp;
|
233 | |
234 |
|
235 |
|
236 | Tags?: Tags;
|
237 | }
|
238 | export type DetailType = "BASIC"|"FULL"|string;
|
239 | export type EventTypeBatch = EventTypeSummary[];
|
240 | export type EventTypeId = string;
|
241 | export type EventTypeIds = EventTypeId[];
|
242 | export type EventTypeName = string;
|
243 | export interface EventTypeSummary {
|
244 | |
245 |
|
246 |
|
247 | EventTypeId?: EventTypeId;
|
248 | |
249 |
|
250 |
|
251 | ServiceName?: ServiceName;
|
252 | |
253 |
|
254 |
|
255 | EventTypeName?: EventTypeName;
|
256 | |
257 |
|
258 |
|
259 | ResourceType?: ResourceType;
|
260 | }
|
261 | export type ForceUnsubscribeAll = boolean;
|
262 | export type LastModifiedTimestamp = Date;
|
263 | export interface ListEventTypesFilter {
|
264 | |
265 |
|
266 |
|
267 | Name: ListEventTypesFilterName;
|
268 | |
269 |
|
270 |
|
271 | Value: ListEventTypesFilterValue;
|
272 | }
|
273 | export type ListEventTypesFilterName = "RESOURCE_TYPE"|"SERVICE_NAME"|string;
|
274 | export type ListEventTypesFilterValue = string;
|
275 | export type ListEventTypesFilters = ListEventTypesFilter[];
|
276 | export interface ListEventTypesRequest {
|
277 | |
278 |
|
279 |
|
280 | Filters?: ListEventTypesFilters;
|
281 | |
282 |
|
283 |
|
284 | NextToken?: NextToken;
|
285 | |
286 |
|
287 |
|
288 | MaxResults?: MaxResults;
|
289 | }
|
290 | export interface ListEventTypesResult {
|
291 | |
292 |
|
293 |
|
294 | EventTypes?: EventTypeBatch;
|
295 | |
296 |
|
297 |
|
298 | NextToken?: NextToken;
|
299 | }
|
300 | export interface ListNotificationRulesFilter {
|
301 | |
302 |
|
303 |
|
304 | Name: ListNotificationRulesFilterName;
|
305 | |
306 |
|
307 |
|
308 | Value: ListNotificationRulesFilterValue;
|
309 | }
|
310 | export type ListNotificationRulesFilterName = "EVENT_TYPE_ID"|"CREATED_BY"|"RESOURCE"|"TARGET_ADDRESS"|string;
|
311 | export type ListNotificationRulesFilterValue = string;
|
312 | export type ListNotificationRulesFilters = ListNotificationRulesFilter[];
|
313 | export interface ListNotificationRulesRequest {
|
314 | |
315 |
|
316 |
|
317 | Filters?: ListNotificationRulesFilters;
|
318 | |
319 |
|
320 |
|
321 | NextToken?: NextToken;
|
322 | |
323 |
|
324 |
|
325 | MaxResults?: MaxResults;
|
326 | }
|
327 | export interface ListNotificationRulesResult {
|
328 | |
329 |
|
330 |
|
331 | NextToken?: NextToken;
|
332 | |
333 |
|
334 |
|
335 | NotificationRules?: NotificationRuleBatch;
|
336 | }
|
337 | export interface ListTagsForResourceRequest {
|
338 | |
339 |
|
340 |
|
341 | Arn: NotificationRuleArn;
|
342 | }
|
343 | export interface ListTagsForResourceResult {
|
344 | |
345 |
|
346 |
|
347 | Tags?: Tags;
|
348 | }
|
349 | export interface ListTargetsFilter {
|
350 | |
351 |
|
352 |
|
353 | Name: ListTargetsFilterName;
|
354 | |
355 |
|
356 |
|
357 | Value: ListTargetsFilterValue;
|
358 | }
|
359 | export type ListTargetsFilterName = "TARGET_TYPE"|"TARGET_ADDRESS"|"TARGET_STATUS"|string;
|
360 | export type ListTargetsFilterValue = string;
|
361 | export type ListTargetsFilters = ListTargetsFilter[];
|
362 | export interface ListTargetsRequest {
|
363 | |
364 |
|
365 |
|
366 | Filters?: ListTargetsFilters;
|
367 | |
368 |
|
369 |
|
370 | NextToken?: NextToken;
|
371 | |
372 |
|
373 |
|
374 | MaxResults?: MaxResults;
|
375 | }
|
376 | export interface ListTargetsResult {
|
377 | |
378 |
|
379 |
|
380 | Targets?: TargetsBatch;
|
381 | |
382 |
|
383 |
|
384 | NextToken?: NextToken;
|
385 | }
|
386 | export type MaxResults = number;
|
387 | export type NextToken = string;
|
388 | export type NotificationRuleArn = string;
|
389 | export type NotificationRuleBatch = NotificationRuleSummary[];
|
390 | export type NotificationRuleCreatedBy = string;
|
391 | export type NotificationRuleId = string;
|
392 | export type NotificationRuleName = string;
|
393 | export type NotificationRuleResource = string;
|
394 | export type NotificationRuleStatus = "ENABLED"|"DISABLED"|string;
|
395 | export interface NotificationRuleSummary {
|
396 | |
397 |
|
398 |
|
399 | Id?: NotificationRuleId;
|
400 | |
401 |
|
402 |
|
403 | Arn?: NotificationRuleArn;
|
404 | }
|
405 | export type ResourceType = string;
|
406 | export type ServiceName = string;
|
407 | export interface SubscribeRequest {
|
408 | |
409 |
|
410 |
|
411 | Arn: NotificationRuleArn;
|
412 | Target: Target;
|
413 | |
414 |
|
415 |
|
416 | ClientRequestToken?: ClientRequestToken;
|
417 | }
|
418 | export interface SubscribeResult {
|
419 | |
420 |
|
421 |
|
422 | Arn?: NotificationRuleArn;
|
423 | }
|
424 | export type TagKey = string;
|
425 | export type TagKeys = TagKey[];
|
426 | export interface TagResourceRequest {
|
427 | |
428 |
|
429 |
|
430 | Arn: NotificationRuleArn;
|
431 | |
432 |
|
433 |
|
434 | Tags: Tags;
|
435 | }
|
436 | export interface TagResourceResult {
|
437 | |
438 |
|
439 |
|
440 | Tags?: Tags;
|
441 | }
|
442 | export type TagValue = string;
|
443 | export type Tags = {[key: string]: TagValue};
|
444 | export interface Target {
|
445 | |
446 |
|
447 |
|
448 | TargetType?: TargetType;
|
449 | |
450 |
|
451 |
|
452 | TargetAddress?: TargetAddress;
|
453 | }
|
454 | export type TargetAddress = string;
|
455 | export type TargetStatus = "PENDING"|"ACTIVE"|"UNREACHABLE"|"INACTIVE"|"DEACTIVATED"|string;
|
456 | export interface TargetSummary {
|
457 | |
458 |
|
459 |
|
460 | TargetAddress?: TargetAddress;
|
461 | |
462 |
|
463 |
|
464 | TargetType?: TargetType;
|
465 | |
466 |
|
467 |
|
468 | TargetStatus?: TargetStatus;
|
469 | }
|
470 | export type TargetType = string;
|
471 | export type Targets = Target[];
|
472 | export type TargetsBatch = TargetSummary[];
|
473 | export interface UnsubscribeRequest {
|
474 | |
475 |
|
476 |
|
477 | Arn: NotificationRuleArn;
|
478 | |
479 |
|
480 |
|
481 | TargetAddress: TargetAddress;
|
482 | }
|
483 | export interface UnsubscribeResult {
|
484 | |
485 |
|
486 |
|
487 | Arn: NotificationRuleArn;
|
488 | }
|
489 | export interface UntagResourceRequest {
|
490 | |
491 |
|
492 |
|
493 | Arn: NotificationRuleArn;
|
494 | |
495 |
|
496 |
|
497 | TagKeys: TagKeys;
|
498 | }
|
499 | export interface UntagResourceResult {
|
500 | }
|
501 | export interface UpdateNotificationRuleRequest {
|
502 | |
503 |
|
504 |
|
505 | Arn: NotificationRuleArn;
|
506 | |
507 |
|
508 |
|
509 | Name?: NotificationRuleName;
|
510 | |
511 |
|
512 |
|
513 | Status?: NotificationRuleStatus;
|
514 | |
515 |
|
516 |
|
517 | EventTypeIds?: EventTypeIds;
|
518 | |
519 |
|
520 |
|
521 | Targets?: Targets;
|
522 | |
523 |
|
524 |
|
525 | DetailType?: DetailType;
|
526 | }
|
527 | export interface UpdateNotificationRuleResult {
|
528 | }
|
529 | |
530 |
|
531 |
|
532 | export type apiVersion = "2019-10-15"|"latest"|string;
|
533 | export interface ClientApiVersions {
|
534 | |
535 |
|
536 |
|
537 | apiVersion?: apiVersion;
|
538 | }
|
539 | export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
|
540 | |
541 |
|
542 |
|
543 | export import Types = CodeStarNotifications;
|
544 | }
|
545 | export = CodeStarNotifications;
|