@aws-sdk/client-ssm-incidents 3.378.0 → 3.382.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.
|
@@ -34,6 +34,7 @@ export type DynamicSsmParameterValue = DynamicSsmParameterValue.VariableMember |
|
|
|
34
34
|
*/
|
|
35
35
|
export declare namespace DynamicSsmParameterValue {
|
|
36
36
|
/**
|
|
37
|
+
* @public
|
|
37
38
|
* <p>Variable dynamic parameters. A parameter value is determined when an incident is
|
|
38
39
|
* created.</p>
|
|
39
40
|
*/
|
|
@@ -41,6 +42,9 @@ export declare namespace DynamicSsmParameterValue {
|
|
|
41
42
|
variable: VariableType | string;
|
|
42
43
|
$unknown?: never;
|
|
43
44
|
}
|
|
45
|
+
/**
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
44
48
|
interface $UnknownMember {
|
|
45
49
|
variable?: never;
|
|
46
50
|
$unknown: [string, any];
|
|
@@ -70,28 +74,34 @@ export type SsmTargetAccount = (typeof SsmTargetAccount)[keyof typeof SsmTargetA
|
|
|
70
74
|
*/
|
|
71
75
|
export interface SsmAutomation {
|
|
72
76
|
/**
|
|
77
|
+
* @public
|
|
73
78
|
* <p>The Amazon Resource Name (ARN) of the role that the automation document will assume when
|
|
74
79
|
* running commands.</p>
|
|
75
80
|
*/
|
|
76
81
|
roleArn: string | undefined;
|
|
77
82
|
/**
|
|
83
|
+
* @public
|
|
78
84
|
* <p>The automation document's name.</p>
|
|
79
85
|
*/
|
|
80
86
|
documentName: string | undefined;
|
|
81
87
|
/**
|
|
88
|
+
* @public
|
|
82
89
|
* <p>The automation document's version to use when running.</p>
|
|
83
90
|
*/
|
|
84
91
|
documentVersion?: string;
|
|
85
92
|
/**
|
|
93
|
+
* @public
|
|
86
94
|
* <p>The account that the automation document will be run in. This can be in either the
|
|
87
95
|
* management account or an application account.</p>
|
|
88
96
|
*/
|
|
89
97
|
targetAccount?: SsmTargetAccount | string;
|
|
90
98
|
/**
|
|
99
|
+
* @public
|
|
91
100
|
* <p>The key-value pair parameters to use when running the automation document.</p>
|
|
92
101
|
*/
|
|
93
102
|
parameters?: Record<string, string[]>;
|
|
94
103
|
/**
|
|
104
|
+
* @public
|
|
95
105
|
* <p>The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation
|
|
96
106
|
* runbook.</p>
|
|
97
107
|
*/
|
|
@@ -108,6 +118,7 @@ export type Action = Action.SsmAutomationMember | Action.$UnknownMember;
|
|
|
108
118
|
*/
|
|
109
119
|
export declare namespace Action {
|
|
110
120
|
/**
|
|
121
|
+
* @public
|
|
111
122
|
* <p>The Systems Manager automation document to start as the runbook at the beginning of the
|
|
112
123
|
* incident.</p>
|
|
113
124
|
*/
|
|
@@ -115,6 +126,9 @@ export declare namespace Action {
|
|
|
115
126
|
ssmAutomation: SsmAutomation;
|
|
116
127
|
$unknown?: never;
|
|
117
128
|
}
|
|
129
|
+
/**
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
118
132
|
interface $UnknownMember {
|
|
119
133
|
ssmAutomation?: never;
|
|
120
134
|
$unknown: [string, any];
|
|
@@ -132,10 +146,12 @@ export declare namespace Action {
|
|
|
132
146
|
*/
|
|
133
147
|
export interface AddRegionAction {
|
|
134
148
|
/**
|
|
149
|
+
* @public
|
|
135
150
|
* <p>The Amazon Web Services Region name to add to the replication set.</p>
|
|
136
151
|
*/
|
|
137
152
|
regionName: string | undefined;
|
|
138
153
|
/**
|
|
154
|
+
* @public
|
|
139
155
|
* <p>The KMS key ID to use to encrypt your replication set.</p>
|
|
140
156
|
*/
|
|
141
157
|
sseKmsKeyId?: string;
|
|
@@ -150,6 +166,7 @@ export type AttributeValueList = AttributeValueList.IntegerValuesMember | Attrib
|
|
|
150
166
|
*/
|
|
151
167
|
export declare namespace AttributeValueList {
|
|
152
168
|
/**
|
|
169
|
+
* @public
|
|
153
170
|
* <p>The list of string values that the filter matches.</p>
|
|
154
171
|
*/
|
|
155
172
|
interface StringValuesMember {
|
|
@@ -158,6 +175,7 @@ export declare namespace AttributeValueList {
|
|
|
158
175
|
$unknown?: never;
|
|
159
176
|
}
|
|
160
177
|
/**
|
|
178
|
+
* @public
|
|
161
179
|
* <p>The list of integer values that the filter matches.</p>
|
|
162
180
|
*/
|
|
163
181
|
interface IntegerValuesMember {
|
|
@@ -165,6 +183,9 @@ export declare namespace AttributeValueList {
|
|
|
165
183
|
integerValues: number[];
|
|
166
184
|
$unknown?: never;
|
|
167
185
|
}
|
|
186
|
+
/**
|
|
187
|
+
* @public
|
|
188
|
+
*/
|
|
168
189
|
interface $UnknownMember {
|
|
169
190
|
stringValues?: never;
|
|
170
191
|
integerValues?: never;
|
|
@@ -188,12 +209,16 @@ export type AutomationExecution = AutomationExecution.SsmExecutionArnMember | Au
|
|
|
188
209
|
*/
|
|
189
210
|
export declare namespace AutomationExecution {
|
|
190
211
|
/**
|
|
212
|
+
* @public
|
|
191
213
|
* <p>The Amazon Resource Name (ARN) of the automation process.</p>
|
|
192
214
|
*/
|
|
193
215
|
interface SsmExecutionArnMember {
|
|
194
216
|
ssmExecutionArn: string;
|
|
195
217
|
$unknown?: never;
|
|
196
218
|
}
|
|
219
|
+
/**
|
|
220
|
+
* @public
|
|
221
|
+
*/
|
|
197
222
|
interface $UnknownMember {
|
|
198
223
|
ssmExecutionArn?: never;
|
|
199
224
|
$unknown: [string, any];
|
|
@@ -220,6 +245,7 @@ export type ChatChannel = ChatChannel.ChatbotSnsMember | ChatChannel.EmptyMember
|
|
|
220
245
|
*/
|
|
221
246
|
export declare namespace ChatChannel {
|
|
222
247
|
/**
|
|
248
|
+
* @public
|
|
223
249
|
* <p>Used to remove the chat channel from an incident record or response plan.</p>
|
|
224
250
|
*/
|
|
225
251
|
interface EmptyMember {
|
|
@@ -228,6 +254,7 @@ export declare namespace ChatChannel {
|
|
|
228
254
|
$unknown?: never;
|
|
229
255
|
}
|
|
230
256
|
/**
|
|
257
|
+
* @public
|
|
231
258
|
* <p>The Amazon SNS targets that Chatbot uses to notify the chat channel of
|
|
232
259
|
* updates to an incident. You can also make updates to the incident through the chat channel by
|
|
233
260
|
* using the Amazon SNS topics. </p>
|
|
@@ -237,6 +264,9 @@ export declare namespace ChatChannel {
|
|
|
237
264
|
chatbotSns: string[];
|
|
238
265
|
$unknown?: never;
|
|
239
266
|
}
|
|
267
|
+
/**
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
240
270
|
interface $UnknownMember {
|
|
241
271
|
empty?: never;
|
|
242
272
|
chatbotSns?: never;
|
|
@@ -262,6 +292,7 @@ export type Condition = Condition.AfterMember | Condition.BeforeMember | Conditi
|
|
|
262
292
|
*/
|
|
263
293
|
export declare namespace Condition {
|
|
264
294
|
/**
|
|
295
|
+
* @public
|
|
265
296
|
* <p>Before the specified timestamp</p>
|
|
266
297
|
*/
|
|
267
298
|
interface BeforeMember {
|
|
@@ -271,6 +302,7 @@ export declare namespace Condition {
|
|
|
271
302
|
$unknown?: never;
|
|
272
303
|
}
|
|
273
304
|
/**
|
|
305
|
+
* @public
|
|
274
306
|
* <p>After the specified timestamp.</p>
|
|
275
307
|
*/
|
|
276
308
|
interface AfterMember {
|
|
@@ -280,6 +312,7 @@ export declare namespace Condition {
|
|
|
280
312
|
$unknown?: never;
|
|
281
313
|
}
|
|
282
314
|
/**
|
|
315
|
+
* @public
|
|
283
316
|
* <p>The value is equal to the provided string or integer. </p>
|
|
284
317
|
*/
|
|
285
318
|
interface EqualsMember {
|
|
@@ -288,6 +321,9 @@ export declare namespace Condition {
|
|
|
288
321
|
equals: AttributeValueList;
|
|
289
322
|
$unknown?: never;
|
|
290
323
|
}
|
|
324
|
+
/**
|
|
325
|
+
* @public
|
|
326
|
+
*/
|
|
291
327
|
interface $UnknownMember {
|
|
292
328
|
before?: never;
|
|
293
329
|
after?: never;
|
|
@@ -325,14 +361,17 @@ export declare class ConflictException extends __BaseException {
|
|
|
325
361
|
readonly name: "ConflictException";
|
|
326
362
|
readonly $fault: "client";
|
|
327
363
|
/**
|
|
364
|
+
* @public
|
|
328
365
|
* The identifier of the requested resource
|
|
329
366
|
*/
|
|
330
367
|
resourceIdentifier?: string;
|
|
331
368
|
/**
|
|
369
|
+
* @public
|
|
332
370
|
* The resource type
|
|
333
371
|
*/
|
|
334
372
|
resourceType?: ResourceType | string;
|
|
335
373
|
/**
|
|
374
|
+
* @public
|
|
336
375
|
* If present in the output, the operation can be retried after this time
|
|
337
376
|
*/
|
|
338
377
|
retryAfter?: Date;
|
|
@@ -348,6 +387,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
348
387
|
*/
|
|
349
388
|
export interface RegionMapInputValue {
|
|
350
389
|
/**
|
|
390
|
+
* @public
|
|
351
391
|
* <p>The KMS key used to encrypt the data in your replication set.</p>
|
|
352
392
|
*/
|
|
353
393
|
sseKmsKeyId?: string;
|
|
@@ -357,16 +397,19 @@ export interface RegionMapInputValue {
|
|
|
357
397
|
*/
|
|
358
398
|
export interface CreateReplicationSetInput {
|
|
359
399
|
/**
|
|
400
|
+
* @public
|
|
360
401
|
* <p>The Regions that Incident Manager replicates your data to. You can have up to three Regions in
|
|
361
402
|
* your replication set.</p>
|
|
362
403
|
*/
|
|
363
404
|
regions: Record<string, RegionMapInputValue> | undefined;
|
|
364
405
|
/**
|
|
406
|
+
* @public
|
|
365
407
|
* <p>A token that ensures that the operation is called only once with the specified
|
|
366
408
|
* details.</p>
|
|
367
409
|
*/
|
|
368
410
|
clientToken?: string;
|
|
369
411
|
/**
|
|
412
|
+
* @public
|
|
370
413
|
* <p>A list of tags to add to the replication set.</p>
|
|
371
414
|
*/
|
|
372
415
|
tags?: Record<string, string>;
|
|
@@ -376,6 +419,7 @@ export interface CreateReplicationSetInput {
|
|
|
376
419
|
*/
|
|
377
420
|
export interface CreateReplicationSetOutput {
|
|
378
421
|
/**
|
|
422
|
+
* @public
|
|
379
423
|
* <p>The Amazon Resource Name (ARN) of the replication set. </p>
|
|
380
424
|
*/
|
|
381
425
|
arn: string | undefined;
|
|
@@ -412,18 +456,22 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
412
456
|
readonly name: "ServiceQuotaExceededException";
|
|
413
457
|
readonly $fault: "client";
|
|
414
458
|
/**
|
|
459
|
+
* @public
|
|
415
460
|
* The identifier for the requested resource
|
|
416
461
|
*/
|
|
417
462
|
resourceIdentifier?: string;
|
|
418
463
|
/**
|
|
464
|
+
* @public
|
|
419
465
|
* The resource type
|
|
420
466
|
*/
|
|
421
467
|
resourceType?: ResourceType | string;
|
|
422
468
|
/**
|
|
469
|
+
* @public
|
|
423
470
|
* Originating service code
|
|
424
471
|
*/
|
|
425
472
|
serviceCode: ServiceCode | string | undefined;
|
|
426
473
|
/**
|
|
474
|
+
* @public
|
|
427
475
|
* Originating quota code
|
|
428
476
|
*/
|
|
429
477
|
quotaCode: string | undefined;
|
|
@@ -440,10 +488,12 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
440
488
|
readonly name: "ThrottlingException";
|
|
441
489
|
readonly $fault: "client";
|
|
442
490
|
/**
|
|
491
|
+
* @public
|
|
443
492
|
* Originating service code
|
|
444
493
|
*/
|
|
445
494
|
serviceCode: ServiceCode | string | undefined;
|
|
446
495
|
/**
|
|
496
|
+
* @public
|
|
447
497
|
* Originating quota code
|
|
448
498
|
*/
|
|
449
499
|
quotaCode: string | undefined;
|
|
@@ -475,12 +525,16 @@ export type NotificationTargetItem = NotificationTargetItem.SnsTopicArnMember |
|
|
|
475
525
|
*/
|
|
476
526
|
export declare namespace NotificationTargetItem {
|
|
477
527
|
/**
|
|
528
|
+
* @public
|
|
478
529
|
* <p>The Amazon Resource Name (ARN) of the SNS topic.</p>
|
|
479
530
|
*/
|
|
480
531
|
interface SnsTopicArnMember {
|
|
481
532
|
snsTopicArn: string;
|
|
482
533
|
$unknown?: never;
|
|
483
534
|
}
|
|
535
|
+
/**
|
|
536
|
+
* @public
|
|
537
|
+
*/
|
|
484
538
|
interface $UnknownMember {
|
|
485
539
|
snsTopicArn?: never;
|
|
486
540
|
$unknown: [string, any];
|
|
@@ -498,29 +552,35 @@ export declare namespace NotificationTargetItem {
|
|
|
498
552
|
*/
|
|
499
553
|
export interface IncidentTemplate {
|
|
500
554
|
/**
|
|
555
|
+
* @public
|
|
501
556
|
* <p>The title of the incident. </p>
|
|
502
557
|
*/
|
|
503
558
|
title: string | undefined;
|
|
504
559
|
/**
|
|
560
|
+
* @public
|
|
505
561
|
* <p>The impact of the incident on your customers and applications. </p>
|
|
506
562
|
*/
|
|
507
563
|
impact: number | undefined;
|
|
508
564
|
/**
|
|
565
|
+
* @public
|
|
509
566
|
* <p>The summary of the incident. The summary is a brief synopsis of what occurred, what's
|
|
510
567
|
* currently happening, and context.</p>
|
|
511
568
|
*/
|
|
512
569
|
summary?: string;
|
|
513
570
|
/**
|
|
571
|
+
* @public
|
|
514
572
|
* <p>Used to stop Incident Manager from creating multiple incident records for the same incident.
|
|
515
573
|
* </p>
|
|
516
574
|
*/
|
|
517
575
|
dedupeString?: string;
|
|
518
576
|
/**
|
|
577
|
+
* @public
|
|
519
578
|
* <p>The Amazon SNS targets that are notified when updates are made to an
|
|
520
579
|
* incident.</p>
|
|
521
580
|
*/
|
|
522
581
|
notificationTargets?: NotificationTargetItem[];
|
|
523
582
|
/**
|
|
583
|
+
* @public
|
|
524
584
|
* <p>Tags to assign to the template. When the <code>StartIncident</code> API action is called,
|
|
525
585
|
* Incident Manager assigns the tags specified in the template to the incident.</p>
|
|
526
586
|
*/
|
|
@@ -532,6 +592,7 @@ export interface IncidentTemplate {
|
|
|
532
592
|
*/
|
|
533
593
|
export interface PagerDutyIncidentConfiguration {
|
|
534
594
|
/**
|
|
595
|
+
* @public
|
|
535
596
|
* <p>The ID of the PagerDuty service that the response plan associates with an incident when it
|
|
536
597
|
* launches.</p>
|
|
537
598
|
*/
|
|
@@ -543,15 +604,18 @@ export interface PagerDutyIncidentConfiguration {
|
|
|
543
604
|
*/
|
|
544
605
|
export interface PagerDutyConfiguration {
|
|
545
606
|
/**
|
|
607
|
+
* @public
|
|
546
608
|
* <p>The name of the PagerDuty configuration.</p>
|
|
547
609
|
*/
|
|
548
610
|
name: string | undefined;
|
|
549
611
|
/**
|
|
612
|
+
* @public
|
|
550
613
|
* <p>The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or
|
|
551
614
|
* User Token REST API Key, and other user credentials.</p>
|
|
552
615
|
*/
|
|
553
616
|
secretId: string | undefined;
|
|
554
617
|
/**
|
|
618
|
+
* @public
|
|
555
619
|
* <p>Details about the PagerDuty service associated with the configuration.</p>
|
|
556
620
|
*/
|
|
557
621
|
pagerDutyIncidentConfiguration: PagerDutyIncidentConfiguration | undefined;
|
|
@@ -566,6 +630,7 @@ export type Integration = Integration.PagerDutyConfigurationMember | Integration
|
|
|
566
630
|
*/
|
|
567
631
|
export declare namespace Integration {
|
|
568
632
|
/**
|
|
633
|
+
* @public
|
|
569
634
|
* <p>Information about the PagerDuty service where the response plan creates an
|
|
570
635
|
* incident.</p>
|
|
571
636
|
*/
|
|
@@ -573,6 +638,9 @@ export declare namespace Integration {
|
|
|
573
638
|
pagerDutyConfiguration: PagerDutyConfiguration;
|
|
574
639
|
$unknown?: never;
|
|
575
640
|
}
|
|
641
|
+
/**
|
|
642
|
+
* @public
|
|
643
|
+
*/
|
|
576
644
|
interface $UnknownMember {
|
|
577
645
|
pagerDutyConfiguration?: never;
|
|
578
646
|
$unknown: [string, any];
|
|
@@ -588,39 +656,48 @@ export declare namespace Integration {
|
|
|
588
656
|
*/
|
|
589
657
|
export interface CreateResponsePlanInput {
|
|
590
658
|
/**
|
|
659
|
+
* @public
|
|
591
660
|
* <p>A token ensuring that the operation is called only once with the specified details.</p>
|
|
592
661
|
*/
|
|
593
662
|
clientToken?: string;
|
|
594
663
|
/**
|
|
664
|
+
* @public
|
|
595
665
|
* <p>The short format name of the response plan. Can't include spaces.</p>
|
|
596
666
|
*/
|
|
597
667
|
name: string | undefined;
|
|
598
668
|
/**
|
|
669
|
+
* @public
|
|
599
670
|
* <p>The long format of the response plan name. This field can contain spaces.</p>
|
|
600
671
|
*/
|
|
601
672
|
displayName?: string;
|
|
602
673
|
/**
|
|
674
|
+
* @public
|
|
603
675
|
* <p>Details used to create an incident when using this response plan.</p>
|
|
604
676
|
*/
|
|
605
677
|
incidentTemplate: IncidentTemplate | undefined;
|
|
606
678
|
/**
|
|
679
|
+
* @public
|
|
607
680
|
* <p>The Chatbot chat channel used for collaboration during an incident.</p>
|
|
608
681
|
*/
|
|
609
682
|
chatChannel?: ChatChannel;
|
|
610
683
|
/**
|
|
684
|
+
* @public
|
|
611
685
|
* <p>The Amazon Resource Name (ARN) for the contacts and escalation plans that the response
|
|
612
686
|
* plan engages during an incident.</p>
|
|
613
687
|
*/
|
|
614
688
|
engagements?: string[];
|
|
615
689
|
/**
|
|
690
|
+
* @public
|
|
616
691
|
* <p>The actions that the response plan starts at the beginning of an incident.</p>
|
|
617
692
|
*/
|
|
618
693
|
actions?: Action[];
|
|
619
694
|
/**
|
|
695
|
+
* @public
|
|
620
696
|
* <p>A list of tags that you are adding to the response plan.</p>
|
|
621
697
|
*/
|
|
622
698
|
tags?: Record<string, string>;
|
|
623
699
|
/**
|
|
700
|
+
* @public
|
|
624
701
|
* <p>Information about third-party services integrated into the response plan.</p>
|
|
625
702
|
*/
|
|
626
703
|
integrations?: Integration[];
|
|
@@ -630,6 +707,7 @@ export interface CreateResponsePlanInput {
|
|
|
630
707
|
*/
|
|
631
708
|
export interface CreateResponsePlanOutput {
|
|
632
709
|
/**
|
|
710
|
+
* @public
|
|
633
711
|
* <p>The Amazon Resource Name (ARN) of the response plan.</p>
|
|
634
712
|
*/
|
|
635
713
|
arn: string | undefined;
|
|
@@ -642,10 +720,12 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
642
720
|
readonly name: "ResourceNotFoundException";
|
|
643
721
|
readonly $fault: "client";
|
|
644
722
|
/**
|
|
723
|
+
* @public
|
|
645
724
|
* The identifier for the requested resource
|
|
646
725
|
*/
|
|
647
726
|
resourceIdentifier?: string;
|
|
648
727
|
/**
|
|
728
|
+
* @public
|
|
649
729
|
* The resource type
|
|
650
730
|
*/
|
|
651
731
|
resourceType?: ResourceType | string;
|
|
@@ -665,6 +745,7 @@ export type EventReference = EventReference.RelatedItemIdMember | EventReference
|
|
|
665
745
|
*/
|
|
666
746
|
export declare namespace EventReference {
|
|
667
747
|
/**
|
|
748
|
+
* @public
|
|
668
749
|
* <p>The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a
|
|
669
750
|
* <code>TimelineEvent</code>.</p>
|
|
670
751
|
*/
|
|
@@ -674,6 +755,7 @@ export declare namespace EventReference {
|
|
|
674
755
|
$unknown?: never;
|
|
675
756
|
}
|
|
676
757
|
/**
|
|
758
|
+
* @public
|
|
677
759
|
* <p>The ID of a <code>RelatedItem</code> referenced in a <code>TimelineEvent</code>.</p>
|
|
678
760
|
*/
|
|
679
761
|
interface RelatedItemIdMember {
|
|
@@ -681,6 +763,9 @@ export declare namespace EventReference {
|
|
|
681
763
|
relatedItemId: string;
|
|
682
764
|
$unknown?: never;
|
|
683
765
|
}
|
|
766
|
+
/**
|
|
767
|
+
* @public
|
|
768
|
+
*/
|
|
684
769
|
interface $UnknownMember {
|
|
685
770
|
resource?: never;
|
|
686
771
|
relatedItemId?: never;
|
|
@@ -698,29 +783,35 @@ export declare namespace EventReference {
|
|
|
698
783
|
*/
|
|
699
784
|
export interface CreateTimelineEventInput {
|
|
700
785
|
/**
|
|
786
|
+
* @public
|
|
701
787
|
* <p>A token that ensures that a client calls the action only once with the specified
|
|
702
788
|
* details.</p>
|
|
703
789
|
*/
|
|
704
790
|
clientToken?: string;
|
|
705
791
|
/**
|
|
792
|
+
* @public
|
|
706
793
|
* <p>The Amazon Resource Name (ARN) of the incident record that the action adds the incident
|
|
707
794
|
* to.</p>
|
|
708
795
|
*/
|
|
709
796
|
incidentRecordArn: string | undefined;
|
|
710
797
|
/**
|
|
798
|
+
* @public
|
|
711
799
|
* <p>The time that the event occurred.</p>
|
|
712
800
|
*/
|
|
713
801
|
eventTime: Date | undefined;
|
|
714
802
|
/**
|
|
803
|
+
* @public
|
|
715
804
|
* <p>The type of event. You can create timeline events of type <code>Custom
|
|
716
805
|
* Event</code>.</p>
|
|
717
806
|
*/
|
|
718
807
|
eventType: string | undefined;
|
|
719
808
|
/**
|
|
809
|
+
* @public
|
|
720
810
|
* <p>A short description of the event.</p>
|
|
721
811
|
*/
|
|
722
812
|
eventData: string | undefined;
|
|
723
813
|
/**
|
|
814
|
+
* @public
|
|
724
815
|
* <p>Adds one or more references to the <code>TimelineEvent</code>. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter
|
|
725
816
|
* its Amazon Resource Name (ARN). You can also specify a related item associated with a
|
|
726
817
|
* resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a
|
|
@@ -734,10 +825,12 @@ export interface CreateTimelineEventInput {
|
|
|
734
825
|
*/
|
|
735
826
|
export interface CreateTimelineEventOutput {
|
|
736
827
|
/**
|
|
828
|
+
* @public
|
|
737
829
|
* <p>The ARN of the incident record that you added the event to.</p>
|
|
738
830
|
*/
|
|
739
831
|
incidentRecordArn: string | undefined;
|
|
740
832
|
/**
|
|
833
|
+
* @public
|
|
741
834
|
* <p>The ID of the event for easy reference later. </p>
|
|
742
835
|
*/
|
|
743
836
|
eventId: string | undefined;
|
|
@@ -747,6 +840,7 @@ export interface CreateTimelineEventOutput {
|
|
|
747
840
|
*/
|
|
748
841
|
export interface DeleteIncidentRecordInput {
|
|
749
842
|
/**
|
|
843
|
+
* @public
|
|
750
844
|
* <p>The Amazon Resource Name (ARN) of the incident record you are deleting.</p>
|
|
751
845
|
*/
|
|
752
846
|
arn: string | undefined;
|
|
@@ -763,6 +857,7 @@ export interface DeleteIncidentRecordOutput {
|
|
|
763
857
|
*/
|
|
764
858
|
export interface DeleteRegionAction {
|
|
765
859
|
/**
|
|
860
|
+
* @public
|
|
766
861
|
* <p>The name of the Amazon Web Services Region you're deleting from the replication set.</p>
|
|
767
862
|
*/
|
|
768
863
|
regionName: string | undefined;
|
|
@@ -772,6 +867,7 @@ export interface DeleteRegionAction {
|
|
|
772
867
|
*/
|
|
773
868
|
export interface DeleteReplicationSetInput {
|
|
774
869
|
/**
|
|
870
|
+
* @public
|
|
775
871
|
* <p>The Amazon Resource Name (ARN) of the replication set you're deleting.</p>
|
|
776
872
|
*/
|
|
777
873
|
arn: string | undefined;
|
|
@@ -786,10 +882,12 @@ export interface DeleteReplicationSetOutput {
|
|
|
786
882
|
*/
|
|
787
883
|
export interface DeleteResourcePolicyInput {
|
|
788
884
|
/**
|
|
885
|
+
* @public
|
|
789
886
|
* <p>The Amazon Resource Name (ARN) of the resource you're deleting the policy from.</p>
|
|
790
887
|
*/
|
|
791
888
|
resourceArn: string | undefined;
|
|
792
889
|
/**
|
|
890
|
+
* @public
|
|
793
891
|
* <p>The ID of the resource policy you're deleting.</p>
|
|
794
892
|
*/
|
|
795
893
|
policyId: string | undefined;
|
|
@@ -804,6 +902,7 @@ export interface DeleteResourcePolicyOutput {
|
|
|
804
902
|
*/
|
|
805
903
|
export interface DeleteResponsePlanInput {
|
|
806
904
|
/**
|
|
905
|
+
* @public
|
|
807
906
|
* <p>The Amazon Resource Name (ARN) of the response plan.</p>
|
|
808
907
|
*/
|
|
809
908
|
arn: string | undefined;
|
|
@@ -818,10 +917,12 @@ export interface DeleteResponsePlanOutput {
|
|
|
818
917
|
*/
|
|
819
918
|
export interface DeleteTimelineEventInput {
|
|
820
919
|
/**
|
|
920
|
+
* @public
|
|
821
921
|
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
|
|
822
922
|
*/
|
|
823
923
|
incidentRecordArn: string | undefined;
|
|
824
924
|
/**
|
|
925
|
+
* @public
|
|
825
926
|
* <p>The ID of the event to update. You can use <code>ListTimelineEvents</code> to find an
|
|
826
927
|
* event's ID.</p>
|
|
827
928
|
*/
|
|
@@ -838,26 +939,32 @@ export interface DeleteTimelineEventOutput {
|
|
|
838
939
|
*/
|
|
839
940
|
export interface EventSummary {
|
|
840
941
|
/**
|
|
942
|
+
* @public
|
|
841
943
|
* <p>The Amazon Resource Name (ARN) of the incident that the event happened during.</p>
|
|
842
944
|
*/
|
|
843
945
|
incidentRecordArn: string | undefined;
|
|
844
946
|
/**
|
|
947
|
+
* @public
|
|
845
948
|
* <p>The timeline event ID.</p>
|
|
846
949
|
*/
|
|
847
950
|
eventId: string | undefined;
|
|
848
951
|
/**
|
|
952
|
+
* @public
|
|
849
953
|
* <p>The time that the event occurred.</p>
|
|
850
954
|
*/
|
|
851
955
|
eventTime: Date | undefined;
|
|
852
956
|
/**
|
|
957
|
+
* @public
|
|
853
958
|
* <p>The time that the timeline event was last updated.</p>
|
|
854
959
|
*/
|
|
855
960
|
eventUpdatedTime: Date | undefined;
|
|
856
961
|
/**
|
|
962
|
+
* @public
|
|
857
963
|
* <p>The type of event. The timeline event must be <code>Custom Event</code>.</p>
|
|
858
964
|
*/
|
|
859
965
|
eventType: string | undefined;
|
|
860
966
|
/**
|
|
967
|
+
* @public
|
|
861
968
|
* <p>A list of references in a <code>TimelineEvent</code>.</p>
|
|
862
969
|
*/
|
|
863
970
|
eventReferences?: EventReference[];
|
|
@@ -868,10 +975,12 @@ export interface EventSummary {
|
|
|
868
975
|
*/
|
|
869
976
|
export interface Filter {
|
|
870
977
|
/**
|
|
978
|
+
* @public
|
|
871
979
|
* <p>The key that you're filtering on.</p>
|
|
872
980
|
*/
|
|
873
981
|
key: string | undefined;
|
|
874
982
|
/**
|
|
983
|
+
* @public
|
|
875
984
|
* <p>The condition accepts before or after a specified time, equal to a string, or equal to an
|
|
876
985
|
* integer.</p>
|
|
877
986
|
*/
|
|
@@ -882,6 +991,7 @@ export interface Filter {
|
|
|
882
991
|
*/
|
|
883
992
|
export interface GetIncidentRecordInput {
|
|
884
993
|
/**
|
|
994
|
+
* @public
|
|
885
995
|
* <p>The Amazon Resource Name (ARN) of the incident record.</p>
|
|
886
996
|
*/
|
|
887
997
|
arn: string | undefined;
|
|
@@ -892,19 +1002,23 @@ export interface GetIncidentRecordInput {
|
|
|
892
1002
|
*/
|
|
893
1003
|
export interface IncidentRecordSource {
|
|
894
1004
|
/**
|
|
1005
|
+
* @public
|
|
895
1006
|
* <p>The principal that started the incident.</p>
|
|
896
1007
|
*/
|
|
897
1008
|
createdBy: string | undefined;
|
|
898
1009
|
/**
|
|
1010
|
+
* @public
|
|
899
1011
|
* <p>The service principal that assumed the role specified in <code>createdBy</code>. If no
|
|
900
1012
|
* service principal assumed the role this will be left blank.</p>
|
|
901
1013
|
*/
|
|
902
1014
|
invokedBy?: string;
|
|
903
1015
|
/**
|
|
1016
|
+
* @public
|
|
904
1017
|
* <p>The resource that caused the incident to be created.</p>
|
|
905
1018
|
*/
|
|
906
1019
|
resourceArn?: string;
|
|
907
1020
|
/**
|
|
1021
|
+
* @public
|
|
908
1022
|
* <p>The service that started the incident. This can be manually created from Incident Manager,
|
|
909
1023
|
* automatically created using an Amazon CloudWatch alarm, or Amazon EventBridge
|
|
910
1024
|
* event.</p>
|
|
@@ -929,60 +1043,74 @@ export type IncidentRecordStatus = (typeof IncidentRecordStatus)[keyof typeof In
|
|
|
929
1043
|
*/
|
|
930
1044
|
export interface IncidentRecord {
|
|
931
1045
|
/**
|
|
1046
|
+
* @public
|
|
932
1047
|
* <p>The Amazon Resource Name (ARN) of the incident record.</p>
|
|
933
1048
|
*/
|
|
934
1049
|
arn: string | undefined;
|
|
935
1050
|
/**
|
|
1051
|
+
* @public
|
|
936
1052
|
* <p>The title of the incident.</p>
|
|
937
1053
|
*/
|
|
938
1054
|
title: string | undefined;
|
|
939
1055
|
/**
|
|
1056
|
+
* @public
|
|
940
1057
|
* <p>The summary of the incident. The summary is a brief synopsis of what occurred, what's
|
|
941
1058
|
* currently happening, and context of the incident.</p>
|
|
942
1059
|
*/
|
|
943
1060
|
summary?: string;
|
|
944
1061
|
/**
|
|
1062
|
+
* @public
|
|
945
1063
|
* <p>The current status of the incident.</p>
|
|
946
1064
|
*/
|
|
947
1065
|
status: IncidentRecordStatus | string | undefined;
|
|
948
1066
|
/**
|
|
1067
|
+
* @public
|
|
949
1068
|
* <p>The impact of the incident on customers and applications.</p>
|
|
950
1069
|
*/
|
|
951
1070
|
impact: number | undefined;
|
|
952
1071
|
/**
|
|
1072
|
+
* @public
|
|
953
1073
|
* <p>The time that Incident Manager created the incident record.</p>
|
|
954
1074
|
*/
|
|
955
1075
|
creationTime: Date | undefined;
|
|
956
1076
|
/**
|
|
1077
|
+
* @public
|
|
957
1078
|
* <p>The time at which the incident was resolved. This appears as a timeline event.</p>
|
|
958
1079
|
*/
|
|
959
1080
|
resolvedTime?: Date;
|
|
960
1081
|
/**
|
|
1082
|
+
* @public
|
|
961
1083
|
* <p>The time at which the incident was most recently modified.</p>
|
|
962
1084
|
*/
|
|
963
1085
|
lastModifiedTime: Date | undefined;
|
|
964
1086
|
/**
|
|
1087
|
+
* @public
|
|
965
1088
|
* <p>Who modified the incident most recently.</p>
|
|
966
1089
|
*/
|
|
967
1090
|
lastModifiedBy: string | undefined;
|
|
968
1091
|
/**
|
|
1092
|
+
* @public
|
|
969
1093
|
* <p>The runbook, or automation document, that's run at the beginning of the incident.</p>
|
|
970
1094
|
*/
|
|
971
1095
|
automationExecutions?: AutomationExecution[];
|
|
972
1096
|
/**
|
|
1097
|
+
* @public
|
|
973
1098
|
* <p>Details about the action that started the incident.</p>
|
|
974
1099
|
*/
|
|
975
1100
|
incidentRecordSource: IncidentRecordSource | undefined;
|
|
976
1101
|
/**
|
|
1102
|
+
* @public
|
|
977
1103
|
* <p>The string Incident Manager uses to prevent duplicate incidents from being created by the same
|
|
978
1104
|
* incident in the same account.</p>
|
|
979
1105
|
*/
|
|
980
1106
|
dedupeString: string | undefined;
|
|
981
1107
|
/**
|
|
1108
|
+
* @public
|
|
982
1109
|
* <p>The chat channel used for collaboration during an incident.</p>
|
|
983
1110
|
*/
|
|
984
1111
|
chatChannel?: ChatChannel;
|
|
985
1112
|
/**
|
|
1113
|
+
* @public
|
|
986
1114
|
* <p>The Amazon SNS targets that are notified when updates are made to an
|
|
987
1115
|
* incident.</p>
|
|
988
1116
|
*/
|
|
@@ -993,6 +1121,7 @@ export interface IncidentRecord {
|
|
|
993
1121
|
*/
|
|
994
1122
|
export interface GetIncidentRecordOutput {
|
|
995
1123
|
/**
|
|
1124
|
+
* @public
|
|
996
1125
|
* <p>Details the structure of the incident record.</p>
|
|
997
1126
|
*/
|
|
998
1127
|
incidentRecord: IncidentRecord | undefined;
|
|
@@ -1002,6 +1131,7 @@ export interface GetIncidentRecordOutput {
|
|
|
1002
1131
|
*/
|
|
1003
1132
|
export interface GetReplicationSetInput {
|
|
1004
1133
|
/**
|
|
1134
|
+
* @public
|
|
1005
1135
|
* <p>The Amazon Resource Name (ARN) of the replication set you want to retrieve.</p>
|
|
1006
1136
|
*/
|
|
1007
1137
|
arn: string | undefined;
|
|
@@ -1038,18 +1168,22 @@ export type RegionStatus = (typeof RegionStatus)[keyof typeof RegionStatus];
|
|
|
1038
1168
|
*/
|
|
1039
1169
|
export interface RegionInfo {
|
|
1040
1170
|
/**
|
|
1171
|
+
* @public
|
|
1041
1172
|
* <p>The ID of the KMS key used to encrypt the data in this Amazon Web Services Region.</p>
|
|
1042
1173
|
*/
|
|
1043
1174
|
sseKmsKeyId?: string;
|
|
1044
1175
|
/**
|
|
1176
|
+
* @public
|
|
1045
1177
|
* <p>The status of the Amazon Web Services Region in the replication set.</p>
|
|
1046
1178
|
*/
|
|
1047
1179
|
status: RegionStatus | string | undefined;
|
|
1048
1180
|
/**
|
|
1181
|
+
* @public
|
|
1049
1182
|
* <p>Information displayed about the status of the Amazon Web Services Region.</p>
|
|
1050
1183
|
*/
|
|
1051
1184
|
statusMessage?: string;
|
|
1052
1185
|
/**
|
|
1186
|
+
* @public
|
|
1053
1187
|
* <p>The most recent date and time that Incident Manager updated the Amazon Web Services Region's status.</p>
|
|
1054
1188
|
*/
|
|
1055
1189
|
statusUpdateDateTime: Date | undefined;
|
|
@@ -1091,37 +1225,45 @@ export type ReplicationSetStatus = (typeof ReplicationSetStatus)[keyof typeof Re
|
|
|
1091
1225
|
*/
|
|
1092
1226
|
export interface ReplicationSet {
|
|
1093
1227
|
/**
|
|
1228
|
+
* @public
|
|
1094
1229
|
* <p>The Amazon Resource Name (ARN) of the replication set.</p>
|
|
1095
1230
|
*/
|
|
1096
1231
|
arn?: string;
|
|
1097
1232
|
/**
|
|
1233
|
+
* @public
|
|
1098
1234
|
* <p>The map between each Amazon Web Services Region in your replication set and the KMS key that's used to encrypt the data in that Region.</p>
|
|
1099
1235
|
*/
|
|
1100
1236
|
regionMap: Record<string, RegionInfo> | undefined;
|
|
1101
1237
|
/**
|
|
1238
|
+
* @public
|
|
1102
1239
|
* <p>The status of the replication set. If the replication set is still pending, you can't use
|
|
1103
1240
|
* Incident Manager functionality.</p>
|
|
1104
1241
|
*/
|
|
1105
1242
|
status: ReplicationSetStatus | string | undefined;
|
|
1106
1243
|
/**
|
|
1244
|
+
* @public
|
|
1107
1245
|
* <p>Determines if the replication set deletion protection is enabled or not. If deletion
|
|
1108
1246
|
* protection is enabled, you can't delete the last Amazon Web Services Region in the replication
|
|
1109
1247
|
* set. </p>
|
|
1110
1248
|
*/
|
|
1111
1249
|
deletionProtected: boolean | undefined;
|
|
1112
1250
|
/**
|
|
1251
|
+
* @public
|
|
1113
1252
|
* <p>When the replication set was created.</p>
|
|
1114
1253
|
*/
|
|
1115
1254
|
createdTime: Date | undefined;
|
|
1116
1255
|
/**
|
|
1256
|
+
* @public
|
|
1117
1257
|
* <p>Details about who created the replication set.</p>
|
|
1118
1258
|
*/
|
|
1119
1259
|
createdBy: string | undefined;
|
|
1120
1260
|
/**
|
|
1261
|
+
* @public
|
|
1121
1262
|
* <p>When the replication set was last updated.</p>
|
|
1122
1263
|
*/
|
|
1123
1264
|
lastModifiedTime: Date | undefined;
|
|
1124
1265
|
/**
|
|
1266
|
+
* @public
|
|
1125
1267
|
* <p>Who last modified the replication set.</p>
|
|
1126
1268
|
*/
|
|
1127
1269
|
lastModifiedBy: string | undefined;
|
|
@@ -1131,6 +1273,7 @@ export interface ReplicationSet {
|
|
|
1131
1273
|
*/
|
|
1132
1274
|
export interface GetReplicationSetOutput {
|
|
1133
1275
|
/**
|
|
1276
|
+
* @public
|
|
1134
1277
|
* <p>Details of the replication set.</p>
|
|
1135
1278
|
*/
|
|
1136
1279
|
replicationSet: ReplicationSet | undefined;
|
|
@@ -1140,15 +1283,18 @@ export interface GetReplicationSetOutput {
|
|
|
1140
1283
|
*/
|
|
1141
1284
|
export interface GetResourcePoliciesInput {
|
|
1142
1285
|
/**
|
|
1286
|
+
* @public
|
|
1143
1287
|
* <p>The Amazon Resource Name (ARN) of the response plan with the attached resource policy.
|
|
1144
1288
|
* </p>
|
|
1145
1289
|
*/
|
|
1146
1290
|
resourceArn: string | undefined;
|
|
1147
1291
|
/**
|
|
1292
|
+
* @public
|
|
1148
1293
|
* <p>The maximum number of resource policies to display for each page of results.</p>
|
|
1149
1294
|
*/
|
|
1150
1295
|
maxResults?: number;
|
|
1151
1296
|
/**
|
|
1297
|
+
* @public
|
|
1152
1298
|
* <p>The pagination token to continue to the next page of results.</p>
|
|
1153
1299
|
*/
|
|
1154
1300
|
nextToken?: string;
|
|
@@ -1160,14 +1306,17 @@ export interface GetResourcePoliciesInput {
|
|
|
1160
1306
|
*/
|
|
1161
1307
|
export interface ResourcePolicy {
|
|
1162
1308
|
/**
|
|
1309
|
+
* @public
|
|
1163
1310
|
* <p>The JSON blob that describes the policy.</p>
|
|
1164
1311
|
*/
|
|
1165
1312
|
policyDocument: string | undefined;
|
|
1166
1313
|
/**
|
|
1314
|
+
* @public
|
|
1167
1315
|
* <p>The ID of the resource policy.</p>
|
|
1168
1316
|
*/
|
|
1169
1317
|
policyId: string | undefined;
|
|
1170
1318
|
/**
|
|
1319
|
+
* @public
|
|
1171
1320
|
* <p>The Amazon Web Services Region that policy allows resources to be used in.</p>
|
|
1172
1321
|
*/
|
|
1173
1322
|
ramResourceShareRegion: string | undefined;
|
|
@@ -1177,10 +1326,12 @@ export interface ResourcePolicy {
|
|
|
1177
1326
|
*/
|
|
1178
1327
|
export interface GetResourcePoliciesOutput {
|
|
1179
1328
|
/**
|
|
1329
|
+
* @public
|
|
1180
1330
|
* <p>Details about the resource policy attached to the response plan.</p>
|
|
1181
1331
|
*/
|
|
1182
1332
|
resourcePolicies: ResourcePolicy[] | undefined;
|
|
1183
1333
|
/**
|
|
1334
|
+
* @public
|
|
1184
1335
|
* <p>The pagination token to continue to the next page of results.</p>
|
|
1185
1336
|
*/
|
|
1186
1337
|
nextToken?: string;
|
|
@@ -1190,6 +1341,7 @@ export interface GetResourcePoliciesOutput {
|
|
|
1190
1341
|
*/
|
|
1191
1342
|
export interface GetResponsePlanInput {
|
|
1192
1343
|
/**
|
|
1344
|
+
* @public
|
|
1193
1345
|
* <p>The Amazon Resource Name (ARN) of the response plan.</p>
|
|
1194
1346
|
*/
|
|
1195
1347
|
arn: string | undefined;
|
|
@@ -1199,35 +1351,43 @@ export interface GetResponsePlanInput {
|
|
|
1199
1351
|
*/
|
|
1200
1352
|
export interface GetResponsePlanOutput {
|
|
1201
1353
|
/**
|
|
1354
|
+
* @public
|
|
1202
1355
|
* <p>The ARN of the response plan.</p>
|
|
1203
1356
|
*/
|
|
1204
1357
|
arn: string | undefined;
|
|
1205
1358
|
/**
|
|
1359
|
+
* @public
|
|
1206
1360
|
* <p>The short format name of the response plan. The name can't contain spaces.</p>
|
|
1207
1361
|
*/
|
|
1208
1362
|
name: string | undefined;
|
|
1209
1363
|
/**
|
|
1364
|
+
* @public
|
|
1210
1365
|
* <p>The long format name of the response plan. Can contain spaces.</p>
|
|
1211
1366
|
*/
|
|
1212
1367
|
displayName?: string;
|
|
1213
1368
|
/**
|
|
1369
|
+
* @public
|
|
1214
1370
|
* <p>Details used to create the incident when using this response plan.</p>
|
|
1215
1371
|
*/
|
|
1216
1372
|
incidentTemplate: IncidentTemplate | undefined;
|
|
1217
1373
|
/**
|
|
1374
|
+
* @public
|
|
1218
1375
|
* <p>The Chatbot chat channel used for collaboration during an incident.</p>
|
|
1219
1376
|
*/
|
|
1220
1377
|
chatChannel?: ChatChannel;
|
|
1221
1378
|
/**
|
|
1379
|
+
* @public
|
|
1222
1380
|
* <p>The Amazon Resource Name (ARN) for the contacts and escalation plans that the response
|
|
1223
1381
|
* plan engages during an incident.</p>
|
|
1224
1382
|
*/
|
|
1225
1383
|
engagements?: string[];
|
|
1226
1384
|
/**
|
|
1385
|
+
* @public
|
|
1227
1386
|
* <p>The actions that this response plan takes at the beginning of the incident.</p>
|
|
1228
1387
|
*/
|
|
1229
1388
|
actions?: Action[];
|
|
1230
1389
|
/**
|
|
1390
|
+
* @public
|
|
1231
1391
|
* <p>Information about third-party services integrated into the Incident Manager response
|
|
1232
1392
|
* plan.</p>
|
|
1233
1393
|
*/
|
|
@@ -1238,10 +1398,12 @@ export interface GetResponsePlanOutput {
|
|
|
1238
1398
|
*/
|
|
1239
1399
|
export interface GetTimelineEventInput {
|
|
1240
1400
|
/**
|
|
1401
|
+
* @public
|
|
1241
1402
|
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
|
|
1242
1403
|
*/
|
|
1243
1404
|
incidentRecordArn: string | undefined;
|
|
1244
1405
|
/**
|
|
1406
|
+
* @public
|
|
1245
1407
|
* <p>The ID of the event. You can get an event's ID when you create it, or by using
|
|
1246
1408
|
* <code>ListTimelineEvents</code>.</p>
|
|
1247
1409
|
*/
|
|
@@ -1253,31 +1415,38 @@ export interface GetTimelineEventInput {
|
|
|
1253
1415
|
*/
|
|
1254
1416
|
export interface TimelineEvent {
|
|
1255
1417
|
/**
|
|
1418
|
+
* @public
|
|
1256
1419
|
* <p>The Amazon Resource Name (ARN) of the incident that the event occurred during.</p>
|
|
1257
1420
|
*/
|
|
1258
1421
|
incidentRecordArn: string | undefined;
|
|
1259
1422
|
/**
|
|
1423
|
+
* @public
|
|
1260
1424
|
* <p>The ID of the timeline event.</p>
|
|
1261
1425
|
*/
|
|
1262
1426
|
eventId: string | undefined;
|
|
1263
1427
|
/**
|
|
1428
|
+
* @public
|
|
1264
1429
|
* <p>The time that the event occurred.</p>
|
|
1265
1430
|
*/
|
|
1266
1431
|
eventTime: Date | undefined;
|
|
1267
1432
|
/**
|
|
1433
|
+
* @public
|
|
1268
1434
|
* <p>The time that the timeline event was last updated.</p>
|
|
1269
1435
|
*/
|
|
1270
1436
|
eventUpdatedTime: Date | undefined;
|
|
1271
1437
|
/**
|
|
1438
|
+
* @public
|
|
1272
1439
|
* <p>The type of event that occurred. Currently Incident Manager supports only the <code>Custom
|
|
1273
1440
|
* Event</code> type.</p>
|
|
1274
1441
|
*/
|
|
1275
1442
|
eventType: string | undefined;
|
|
1276
1443
|
/**
|
|
1444
|
+
* @public
|
|
1277
1445
|
* <p>A short description of the event.</p>
|
|
1278
1446
|
*/
|
|
1279
1447
|
eventData: string | undefined;
|
|
1280
1448
|
/**
|
|
1449
|
+
* @public
|
|
1281
1450
|
* <p>A list of references in a <code>TimelineEvent</code>.</p>
|
|
1282
1451
|
*/
|
|
1283
1452
|
eventReferences?: EventReference[];
|
|
@@ -1287,6 +1456,7 @@ export interface TimelineEvent {
|
|
|
1287
1456
|
*/
|
|
1288
1457
|
export interface GetTimelineEventOutput {
|
|
1289
1458
|
/**
|
|
1459
|
+
* @public
|
|
1290
1460
|
* <p>Details about the timeline event.</p>
|
|
1291
1461
|
*/
|
|
1292
1462
|
event: TimelineEvent | undefined;
|
|
@@ -1297,31 +1467,38 @@ export interface GetTimelineEventOutput {
|
|
|
1297
1467
|
*/
|
|
1298
1468
|
export interface IncidentRecordSummary {
|
|
1299
1469
|
/**
|
|
1470
|
+
* @public
|
|
1300
1471
|
* <p>The Amazon Resource Name (ARN) of the incident.</p>
|
|
1301
1472
|
*/
|
|
1302
1473
|
arn: string | undefined;
|
|
1303
1474
|
/**
|
|
1475
|
+
* @public
|
|
1304
1476
|
* <p>The title of the incident. This value is either provided by the response plan or
|
|
1305
1477
|
* overwritten on creation.</p>
|
|
1306
1478
|
*/
|
|
1307
1479
|
title: string | undefined;
|
|
1308
1480
|
/**
|
|
1481
|
+
* @public
|
|
1309
1482
|
* <p>The current status of the incident.</p>
|
|
1310
1483
|
*/
|
|
1311
1484
|
status: IncidentRecordStatus | string | undefined;
|
|
1312
1485
|
/**
|
|
1486
|
+
* @public
|
|
1313
1487
|
* <p>Defines the impact to customers and applications.</p>
|
|
1314
1488
|
*/
|
|
1315
1489
|
impact: number | undefined;
|
|
1316
1490
|
/**
|
|
1491
|
+
* @public
|
|
1317
1492
|
* <p>The time the incident was created.</p>
|
|
1318
1493
|
*/
|
|
1319
1494
|
creationTime: Date | undefined;
|
|
1320
1495
|
/**
|
|
1496
|
+
* @public
|
|
1321
1497
|
* <p>The time the incident was resolved.</p>
|
|
1322
1498
|
*/
|
|
1323
1499
|
resolvedTime?: Date;
|
|
1324
1500
|
/**
|
|
1501
|
+
* @public
|
|
1325
1502
|
* <p>What caused Incident Manager to create the incident.</p>
|
|
1326
1503
|
*/
|
|
1327
1504
|
incidentRecordSource: IncidentRecordSource | undefined;
|
|
@@ -1352,15 +1529,18 @@ export type ItemType = (typeof ItemType)[keyof typeof ItemType];
|
|
|
1352
1529
|
*/
|
|
1353
1530
|
export interface PagerDutyIncidentDetail {
|
|
1354
1531
|
/**
|
|
1532
|
+
* @public
|
|
1355
1533
|
* <p>The ID of the incident associated with the PagerDuty service for the response plan.</p>
|
|
1356
1534
|
*/
|
|
1357
1535
|
id: string | undefined;
|
|
1358
1536
|
/**
|
|
1537
|
+
* @public
|
|
1359
1538
|
* <p>Indicates whether to resolve the PagerDuty incident when you resolve the associated
|
|
1360
1539
|
* Incident Manager incident.</p>
|
|
1361
1540
|
*/
|
|
1362
1541
|
autoResolve?: boolean;
|
|
1363
1542
|
/**
|
|
1543
|
+
* @public
|
|
1364
1544
|
* <p>The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or
|
|
1365
1545
|
* User Token REST API Key, and other user credentials.</p>
|
|
1366
1546
|
*/
|
|
@@ -1376,6 +1556,7 @@ export type ItemValue = ItemValue.ArnMember | ItemValue.MetricDefinitionMember |
|
|
|
1376
1556
|
*/
|
|
1377
1557
|
export declare namespace ItemValue {
|
|
1378
1558
|
/**
|
|
1559
|
+
* @public
|
|
1379
1560
|
* <p>The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon
|
|
1380
1561
|
* resource.</p>
|
|
1381
1562
|
*/
|
|
@@ -1387,6 +1568,7 @@ export declare namespace ItemValue {
|
|
|
1387
1568
|
$unknown?: never;
|
|
1388
1569
|
}
|
|
1389
1570
|
/**
|
|
1571
|
+
* @public
|
|
1390
1572
|
* <p>The URL, if the related item is a non-Amazon Web Services resource.</p>
|
|
1391
1573
|
*/
|
|
1392
1574
|
interface UrlMember {
|
|
@@ -1397,6 +1579,7 @@ export declare namespace ItemValue {
|
|
|
1397
1579
|
$unknown?: never;
|
|
1398
1580
|
}
|
|
1399
1581
|
/**
|
|
1582
|
+
* @public
|
|
1400
1583
|
* <p>The metric definition, if the related item is a metric in Amazon CloudWatch.</p>
|
|
1401
1584
|
*/
|
|
1402
1585
|
interface MetricDefinitionMember {
|
|
@@ -1407,6 +1590,7 @@ export declare namespace ItemValue {
|
|
|
1407
1590
|
$unknown?: never;
|
|
1408
1591
|
}
|
|
1409
1592
|
/**
|
|
1593
|
+
* @public
|
|
1410
1594
|
* <p>Details about an incident that is associated with a PagerDuty incident.</p>
|
|
1411
1595
|
*/
|
|
1412
1596
|
interface PagerDutyIncidentDetailMember {
|
|
@@ -1416,6 +1600,9 @@ export declare namespace ItemValue {
|
|
|
1416
1600
|
pagerDutyIncidentDetail: PagerDutyIncidentDetail;
|
|
1417
1601
|
$unknown?: never;
|
|
1418
1602
|
}
|
|
1603
|
+
/**
|
|
1604
|
+
* @public
|
|
1605
|
+
*/
|
|
1419
1606
|
interface $UnknownMember {
|
|
1420
1607
|
arn?: never;
|
|
1421
1608
|
url?: never;
|
|
@@ -1438,10 +1625,12 @@ export declare namespace ItemValue {
|
|
|
1438
1625
|
*/
|
|
1439
1626
|
export interface ItemIdentifier {
|
|
1440
1627
|
/**
|
|
1628
|
+
* @public
|
|
1441
1629
|
* <p>Details about the related item.</p>
|
|
1442
1630
|
*/
|
|
1443
1631
|
value: ItemValue | undefined;
|
|
1444
1632
|
/**
|
|
1633
|
+
* @public
|
|
1445
1634
|
* <p>The type of related item. </p>
|
|
1446
1635
|
*/
|
|
1447
1636
|
type: ItemType | string | undefined;
|
|
@@ -1451,6 +1640,7 @@ export interface ItemIdentifier {
|
|
|
1451
1640
|
*/
|
|
1452
1641
|
export interface ListIncidentRecordsInput {
|
|
1453
1642
|
/**
|
|
1643
|
+
* @public
|
|
1454
1644
|
* <p>Filters the list of incident records you want to search through. You can filter on the
|
|
1455
1645
|
* following keys:</p>
|
|
1456
1646
|
* <ul>
|
|
@@ -1492,10 +1682,12 @@ export interface ListIncidentRecordsInput {
|
|
|
1492
1682
|
*/
|
|
1493
1683
|
filters?: Filter[];
|
|
1494
1684
|
/**
|
|
1685
|
+
* @public
|
|
1495
1686
|
* <p>The maximum number of results per page.</p>
|
|
1496
1687
|
*/
|
|
1497
1688
|
maxResults?: number;
|
|
1498
1689
|
/**
|
|
1690
|
+
* @public
|
|
1499
1691
|
* <p>The pagination token to continue to the next page of results.</p>
|
|
1500
1692
|
*/
|
|
1501
1693
|
nextToken?: string;
|
|
@@ -1505,10 +1697,12 @@ export interface ListIncidentRecordsInput {
|
|
|
1505
1697
|
*/
|
|
1506
1698
|
export interface ListIncidentRecordsOutput {
|
|
1507
1699
|
/**
|
|
1700
|
+
* @public
|
|
1508
1701
|
* <p>The details of each listed incident record.</p>
|
|
1509
1702
|
*/
|
|
1510
1703
|
incidentRecordSummaries: IncidentRecordSummary[] | undefined;
|
|
1511
1704
|
/**
|
|
1705
|
+
* @public
|
|
1512
1706
|
* <p>The pagination token to continue to the next page of results.</p>
|
|
1513
1707
|
*/
|
|
1514
1708
|
nextToken?: string;
|
|
@@ -1518,15 +1712,18 @@ export interface ListIncidentRecordsOutput {
|
|
|
1518
1712
|
*/
|
|
1519
1713
|
export interface ListRelatedItemsInput {
|
|
1520
1714
|
/**
|
|
1715
|
+
* @public
|
|
1521
1716
|
* <p>The Amazon Resource Name (ARN) of the incident record containing the listed related
|
|
1522
1717
|
* items.</p>
|
|
1523
1718
|
*/
|
|
1524
1719
|
incidentRecordArn: string | undefined;
|
|
1525
1720
|
/**
|
|
1721
|
+
* @public
|
|
1526
1722
|
* <p>The maximum number of related items per page.</p>
|
|
1527
1723
|
*/
|
|
1528
1724
|
maxResults?: number;
|
|
1529
1725
|
/**
|
|
1726
|
+
* @public
|
|
1530
1727
|
* <p>The pagination token to continue to the next page of results.</p>
|
|
1531
1728
|
*/
|
|
1532
1729
|
nextToken?: string;
|
|
@@ -1537,14 +1734,17 @@ export interface ListRelatedItemsInput {
|
|
|
1537
1734
|
*/
|
|
1538
1735
|
export interface RelatedItem {
|
|
1539
1736
|
/**
|
|
1737
|
+
* @public
|
|
1540
1738
|
* <p>Details about the related item.</p>
|
|
1541
1739
|
*/
|
|
1542
1740
|
identifier: ItemIdentifier | undefined;
|
|
1543
1741
|
/**
|
|
1742
|
+
* @public
|
|
1544
1743
|
* <p>The title of the related item.</p>
|
|
1545
1744
|
*/
|
|
1546
1745
|
title?: string;
|
|
1547
1746
|
/**
|
|
1747
|
+
* @public
|
|
1548
1748
|
* <p>A unique ID for a <code>RelatedItem</code>.</p>
|
|
1549
1749
|
* <important>
|
|
1550
1750
|
* <p>Don't specify this parameter when you add a <code>RelatedItem</code> by using the <a>UpdateRelatedItems</a> API action.</p>
|
|
@@ -1557,10 +1757,12 @@ export interface RelatedItem {
|
|
|
1557
1757
|
*/
|
|
1558
1758
|
export interface ListRelatedItemsOutput {
|
|
1559
1759
|
/**
|
|
1760
|
+
* @public
|
|
1560
1761
|
* <p>Details about each related item.</p>
|
|
1561
1762
|
*/
|
|
1562
1763
|
relatedItems: RelatedItem[] | undefined;
|
|
1563
1764
|
/**
|
|
1765
|
+
* @public
|
|
1564
1766
|
* <p>The pagination token to continue to the next page of results.</p>
|
|
1565
1767
|
*/
|
|
1566
1768
|
nextToken?: string;
|
|
@@ -1570,10 +1772,12 @@ export interface ListRelatedItemsOutput {
|
|
|
1570
1772
|
*/
|
|
1571
1773
|
export interface ListReplicationSetsInput {
|
|
1572
1774
|
/**
|
|
1775
|
+
* @public
|
|
1573
1776
|
* <p>The maximum number of results per page. </p>
|
|
1574
1777
|
*/
|
|
1575
1778
|
maxResults?: number;
|
|
1576
1779
|
/**
|
|
1780
|
+
* @public
|
|
1577
1781
|
* <p>The pagination token to continue to the next page of results.</p>
|
|
1578
1782
|
*/
|
|
1579
1783
|
nextToken?: string;
|
|
@@ -1583,10 +1787,12 @@ export interface ListReplicationSetsInput {
|
|
|
1583
1787
|
*/
|
|
1584
1788
|
export interface ListReplicationSetsOutput {
|
|
1585
1789
|
/**
|
|
1790
|
+
* @public
|
|
1586
1791
|
* <p>The Amazon Resource Name (ARN) of the list replication set.</p>
|
|
1587
1792
|
*/
|
|
1588
1793
|
replicationSetArns: string[] | undefined;
|
|
1589
1794
|
/**
|
|
1795
|
+
* @public
|
|
1590
1796
|
* <p>The pagination token to continue to the next page of results.</p>
|
|
1591
1797
|
*/
|
|
1592
1798
|
nextToken?: string;
|
|
@@ -1596,10 +1802,12 @@ export interface ListReplicationSetsOutput {
|
|
|
1596
1802
|
*/
|
|
1597
1803
|
export interface ListResponsePlansInput {
|
|
1598
1804
|
/**
|
|
1805
|
+
* @public
|
|
1599
1806
|
* <p>The maximum number of response plans per page.</p>
|
|
1600
1807
|
*/
|
|
1601
1808
|
maxResults?: number;
|
|
1602
1809
|
/**
|
|
1810
|
+
* @public
|
|
1603
1811
|
* <p>The pagination token to continue to the next page of results.</p>
|
|
1604
1812
|
*/
|
|
1605
1813
|
nextToken?: string;
|
|
@@ -1610,14 +1818,17 @@ export interface ListResponsePlansInput {
|
|
|
1610
1818
|
*/
|
|
1611
1819
|
export interface ResponsePlanSummary {
|
|
1612
1820
|
/**
|
|
1821
|
+
* @public
|
|
1613
1822
|
* <p>The Amazon Resource Name (ARN) of the response plan.</p>
|
|
1614
1823
|
*/
|
|
1615
1824
|
arn: string | undefined;
|
|
1616
1825
|
/**
|
|
1826
|
+
* @public
|
|
1617
1827
|
* <p>The name of the response plan. This can't include spaces.</p>
|
|
1618
1828
|
*/
|
|
1619
1829
|
name: string | undefined;
|
|
1620
1830
|
/**
|
|
1831
|
+
* @public
|
|
1621
1832
|
* <p>The human readable name of the response plan. This can include spaces.</p>
|
|
1622
1833
|
*/
|
|
1623
1834
|
displayName?: string;
|
|
@@ -1627,10 +1838,12 @@ export interface ResponsePlanSummary {
|
|
|
1627
1838
|
*/
|
|
1628
1839
|
export interface ListResponsePlansOutput {
|
|
1629
1840
|
/**
|
|
1841
|
+
* @public
|
|
1630
1842
|
* <p>Details of each response plan.</p>
|
|
1631
1843
|
*/
|
|
1632
1844
|
responsePlanSummaries: ResponsePlanSummary[] | undefined;
|
|
1633
1845
|
/**
|
|
1846
|
+
* @public
|
|
1634
1847
|
* <p>The pagination token to continue to the next page of results.</p>
|
|
1635
1848
|
*/
|
|
1636
1849
|
nextToken?: string;
|
|
@@ -1640,6 +1853,7 @@ export interface ListResponsePlansOutput {
|
|
|
1640
1853
|
*/
|
|
1641
1854
|
export interface ListTagsForResourceRequest {
|
|
1642
1855
|
/**
|
|
1856
|
+
* @public
|
|
1643
1857
|
* <p>The Amazon Resource Name (ARN) of the response plan.</p>
|
|
1644
1858
|
*/
|
|
1645
1859
|
resourceArn: string | undefined;
|
|
@@ -1649,6 +1863,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1649
1863
|
*/
|
|
1650
1864
|
export interface ListTagsForResourceResponse {
|
|
1651
1865
|
/**
|
|
1866
|
+
* @public
|
|
1652
1867
|
* <p>A list of tags for the response plan.</p>
|
|
1653
1868
|
*/
|
|
1654
1869
|
tags: Record<string, string> | undefined;
|
|
@@ -1681,10 +1896,12 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
|
1681
1896
|
*/
|
|
1682
1897
|
export interface ListTimelineEventsInput {
|
|
1683
1898
|
/**
|
|
1899
|
+
* @public
|
|
1684
1900
|
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
|
|
1685
1901
|
*/
|
|
1686
1902
|
incidentRecordArn: string | undefined;
|
|
1687
1903
|
/**
|
|
1904
|
+
* @public
|
|
1688
1905
|
* <p>Filters the timeline events based on the provided conditional values. You can filter
|
|
1689
1906
|
* timeline events with the following keys:</p>
|
|
1690
1907
|
* <ul>
|
|
@@ -1716,19 +1933,23 @@ export interface ListTimelineEventsInput {
|
|
|
1716
1933
|
*/
|
|
1717
1934
|
filters?: Filter[];
|
|
1718
1935
|
/**
|
|
1936
|
+
* @public
|
|
1719
1937
|
* <p>Sort timeline events by the specified key value pair.</p>
|
|
1720
1938
|
*/
|
|
1721
1939
|
sortBy?: TimelineEventSort | string;
|
|
1722
1940
|
/**
|
|
1941
|
+
* @public
|
|
1723
1942
|
* <p>Sorts the order of timeline events by the value specified in the <code>sortBy</code>
|
|
1724
1943
|
* field.</p>
|
|
1725
1944
|
*/
|
|
1726
1945
|
sortOrder?: SortOrder | string;
|
|
1727
1946
|
/**
|
|
1947
|
+
* @public
|
|
1728
1948
|
* <p>The maximum number of results per page.</p>
|
|
1729
1949
|
*/
|
|
1730
1950
|
maxResults?: number;
|
|
1731
1951
|
/**
|
|
1952
|
+
* @public
|
|
1732
1953
|
* <p>The pagination token to continue to the next page of results.</p>
|
|
1733
1954
|
*/
|
|
1734
1955
|
nextToken?: string;
|
|
@@ -1738,10 +1959,12 @@ export interface ListTimelineEventsInput {
|
|
|
1738
1959
|
*/
|
|
1739
1960
|
export interface ListTimelineEventsOutput {
|
|
1740
1961
|
/**
|
|
1962
|
+
* @public
|
|
1741
1963
|
* <p>Details about each event that occurred during the incident.</p>
|
|
1742
1964
|
*/
|
|
1743
1965
|
eventSummaries: EventSummary[] | undefined;
|
|
1744
1966
|
/**
|
|
1967
|
+
* @public
|
|
1745
1968
|
* <p>The pagination token to continue to the next page of results.</p>
|
|
1746
1969
|
*/
|
|
1747
1970
|
nextToken?: string;
|
|
@@ -1751,10 +1974,12 @@ export interface ListTimelineEventsOutput {
|
|
|
1751
1974
|
*/
|
|
1752
1975
|
export interface PutResourcePolicyInput {
|
|
1753
1976
|
/**
|
|
1977
|
+
* @public
|
|
1754
1978
|
* <p>The Amazon Resource Name (ARN) of the response plan to add the resource policy to.</p>
|
|
1755
1979
|
*/
|
|
1756
1980
|
resourceArn: string | undefined;
|
|
1757
1981
|
/**
|
|
1982
|
+
* @public
|
|
1758
1983
|
* <p>Details of the resource policy.</p>
|
|
1759
1984
|
*/
|
|
1760
1985
|
policy: string | undefined;
|
|
@@ -1764,6 +1989,7 @@ export interface PutResourcePolicyInput {
|
|
|
1764
1989
|
*/
|
|
1765
1990
|
export interface PutResourcePolicyOutput {
|
|
1766
1991
|
/**
|
|
1992
|
+
* @public
|
|
1767
1993
|
* <p>The ID of the resource policy.</p>
|
|
1768
1994
|
*/
|
|
1769
1995
|
policyId: string | undefined;
|
|
@@ -1778,6 +2004,7 @@ export type RelatedItemsUpdate = RelatedItemsUpdate.ItemToAddMember | RelatedIte
|
|
|
1778
2004
|
*/
|
|
1779
2005
|
export declare namespace RelatedItemsUpdate {
|
|
1780
2006
|
/**
|
|
2007
|
+
* @public
|
|
1781
2008
|
* <p>Details about the related item you're adding.</p>
|
|
1782
2009
|
*/
|
|
1783
2010
|
interface ItemToAddMember {
|
|
@@ -1786,6 +2013,7 @@ export declare namespace RelatedItemsUpdate {
|
|
|
1786
2013
|
$unknown?: never;
|
|
1787
2014
|
}
|
|
1788
2015
|
/**
|
|
2016
|
+
* @public
|
|
1789
2017
|
* <p>Details about the related item you're deleting.</p>
|
|
1790
2018
|
*/
|
|
1791
2019
|
interface ItemToRemoveMember {
|
|
@@ -1793,6 +2021,9 @@ export declare namespace RelatedItemsUpdate {
|
|
|
1793
2021
|
itemToRemove: ItemIdentifier;
|
|
1794
2022
|
$unknown?: never;
|
|
1795
2023
|
}
|
|
2024
|
+
/**
|
|
2025
|
+
* @public
|
|
2026
|
+
*/
|
|
1796
2027
|
interface $UnknownMember {
|
|
1797
2028
|
itemToAdd?: never;
|
|
1798
2029
|
itemToRemove?: never;
|
|
@@ -1811,20 +2042,24 @@ export declare namespace RelatedItemsUpdate {
|
|
|
1811
2042
|
*/
|
|
1812
2043
|
export interface TriggerDetails {
|
|
1813
2044
|
/**
|
|
2045
|
+
* @public
|
|
1814
2046
|
* <p>Identifies the service that sourced the event. All events sourced from within Amazon Web Services begin with "<code>aws.</code>" Customer-generated events can have any value here,
|
|
1815
2047
|
* as long as it doesn't begin with "<code>aws.</code>" We recommend the use of Java package-name
|
|
1816
2048
|
* style reverse domain-name strings. </p>
|
|
1817
2049
|
*/
|
|
1818
2050
|
source: string | undefined;
|
|
1819
2051
|
/**
|
|
2052
|
+
* @public
|
|
1820
2053
|
* <p>The Amazon Resource Name (ARN) of the source that detected the incident.</p>
|
|
1821
2054
|
*/
|
|
1822
2055
|
triggerArn?: string;
|
|
1823
2056
|
/**
|
|
2057
|
+
* @public
|
|
1824
2058
|
* <p>The time that the incident was detected.</p>
|
|
1825
2059
|
*/
|
|
1826
2060
|
timestamp: Date | undefined;
|
|
1827
2061
|
/**
|
|
2062
|
+
* @public
|
|
1828
2063
|
* <p>Raw data passed from either Amazon EventBridge, Amazon CloudWatch, or Incident Manager when an incident is created.</p>
|
|
1829
2064
|
*/
|
|
1830
2065
|
rawData?: string;
|
|
@@ -1834,20 +2069,24 @@ export interface TriggerDetails {
|
|
|
1834
2069
|
*/
|
|
1835
2070
|
export interface StartIncidentInput {
|
|
1836
2071
|
/**
|
|
2072
|
+
* @public
|
|
1837
2073
|
* <p>A token ensuring that the operation is called only once with the specified details.</p>
|
|
1838
2074
|
*/
|
|
1839
2075
|
clientToken?: string;
|
|
1840
2076
|
/**
|
|
2077
|
+
* @public
|
|
1841
2078
|
* <p>The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat
|
|
1842
2079
|
* channels, Amazon SNS topics, runbooks, title, and impact of the incident. </p>
|
|
1843
2080
|
*/
|
|
1844
2081
|
responsePlanArn: string | undefined;
|
|
1845
2082
|
/**
|
|
2083
|
+
* @public
|
|
1846
2084
|
* <p>Provide a title for the incident. Providing a title overwrites the title provided by the
|
|
1847
2085
|
* response plan. </p>
|
|
1848
2086
|
*/
|
|
1849
2087
|
title?: string;
|
|
1850
2088
|
/**
|
|
2089
|
+
* @public
|
|
1851
2090
|
* <p>Defines the impact to the customers. Providing an impact overwrites the impact provided by
|
|
1852
2091
|
* a response plan.</p>
|
|
1853
2092
|
* <p class="title">
|
|
@@ -1882,10 +2121,12 @@ export interface StartIncidentInput {
|
|
|
1882
2121
|
*/
|
|
1883
2122
|
impact?: number;
|
|
1884
2123
|
/**
|
|
2124
|
+
* @public
|
|
1885
2125
|
* <p>Details of what created the incident record in Incident Manager.</p>
|
|
1886
2126
|
*/
|
|
1887
2127
|
triggerDetails?: TriggerDetails;
|
|
1888
2128
|
/**
|
|
2129
|
+
* @public
|
|
1889
2130
|
* <p>Add related items to the incident for other responders to use. Related items are Amazon Web Services
|
|
1890
2131
|
* resources, external links, or files uploaded to an Amazon S3 bucket. </p>
|
|
1891
2132
|
*/
|
|
@@ -1896,6 +2137,7 @@ export interface StartIncidentInput {
|
|
|
1896
2137
|
*/
|
|
1897
2138
|
export interface StartIncidentOutput {
|
|
1898
2139
|
/**
|
|
2140
|
+
* @public
|
|
1899
2141
|
* <p>The ARN of the newly created incident record.</p>
|
|
1900
2142
|
*/
|
|
1901
2143
|
incidentRecordArn: string | undefined;
|
|
@@ -1905,10 +2147,12 @@ export interface StartIncidentOutput {
|
|
|
1905
2147
|
*/
|
|
1906
2148
|
export interface TagResourceRequest {
|
|
1907
2149
|
/**
|
|
2150
|
+
* @public
|
|
1908
2151
|
* <p>The Amazon Resource Name (ARN) of the response plan you're adding the tags to.</p>
|
|
1909
2152
|
*/
|
|
1910
2153
|
resourceArn: string | undefined;
|
|
1911
2154
|
/**
|
|
2155
|
+
* @public
|
|
1912
2156
|
* <p>A list of tags to add to the response plan.</p>
|
|
1913
2157
|
*/
|
|
1914
2158
|
tags: Record<string, string> | undefined;
|
|
@@ -1923,10 +2167,12 @@ export interface TagResourceResponse {
|
|
|
1923
2167
|
*/
|
|
1924
2168
|
export interface UntagResourceRequest {
|
|
1925
2169
|
/**
|
|
2170
|
+
* @public
|
|
1926
2171
|
* <p>The Amazon Resource Name (ARN) of the response plan you're removing a tag from.</p>
|
|
1927
2172
|
*/
|
|
1928
2173
|
resourceArn: string | undefined;
|
|
1929
2174
|
/**
|
|
2175
|
+
* @public
|
|
1930
2176
|
* <p>The name of the tag to remove from the response plan.</p>
|
|
1931
2177
|
*/
|
|
1932
2178
|
tagKeys: string[] | undefined;
|
|
@@ -1941,14 +2187,17 @@ export interface UntagResourceResponse {
|
|
|
1941
2187
|
*/
|
|
1942
2188
|
export interface UpdateDeletionProtectionInput {
|
|
1943
2189
|
/**
|
|
2190
|
+
* @public
|
|
1944
2191
|
* <p>The Amazon Resource Name (ARN) of the replication set to update.</p>
|
|
1945
2192
|
*/
|
|
1946
2193
|
arn: string | undefined;
|
|
1947
2194
|
/**
|
|
2195
|
+
* @public
|
|
1948
2196
|
* <p>Specifies if deletion protection is turned on or off in your account. </p>
|
|
1949
2197
|
*/
|
|
1950
2198
|
deletionProtected: boolean | undefined;
|
|
1951
2199
|
/**
|
|
2200
|
+
* @public
|
|
1952
2201
|
* <p>A token that ensures that the operation is called only once with the specified
|
|
1953
2202
|
* details.</p>
|
|
1954
2203
|
*/
|
|
@@ -1964,23 +2213,28 @@ export interface UpdateDeletionProtectionOutput {
|
|
|
1964
2213
|
*/
|
|
1965
2214
|
export interface UpdateIncidentRecordInput {
|
|
1966
2215
|
/**
|
|
2216
|
+
* @public
|
|
1967
2217
|
* <p>A token that ensures that a client calls the operation only once with the specified
|
|
1968
2218
|
* details.</p>
|
|
1969
2219
|
*/
|
|
1970
2220
|
clientToken?: string;
|
|
1971
2221
|
/**
|
|
2222
|
+
* @public
|
|
1972
2223
|
* <p>The Amazon Resource Name (ARN) of the incident record you are updating.</p>
|
|
1973
2224
|
*/
|
|
1974
2225
|
arn: string | undefined;
|
|
1975
2226
|
/**
|
|
2227
|
+
* @public
|
|
1976
2228
|
* <p>A brief description of the incident.</p>
|
|
1977
2229
|
*/
|
|
1978
2230
|
title?: string;
|
|
1979
2231
|
/**
|
|
2232
|
+
* @public
|
|
1980
2233
|
* <p>A longer description of what occurred during the incident.</p>
|
|
1981
2234
|
*/
|
|
1982
2235
|
summary?: string;
|
|
1983
2236
|
/**
|
|
2237
|
+
* @public
|
|
1984
2238
|
* <p>Defines the impact of the incident to customers and applications. If you provide an impact
|
|
1985
2239
|
* for an incident, it overwrites the impact provided by the response plan.</p>
|
|
1986
2240
|
* <p class="title">
|
|
@@ -2015,15 +2269,18 @@ export interface UpdateIncidentRecordInput {
|
|
|
2015
2269
|
*/
|
|
2016
2270
|
impact?: number;
|
|
2017
2271
|
/**
|
|
2272
|
+
* @public
|
|
2018
2273
|
* <p>The status of the incident. Possible statuses are <code>Open</code> or
|
|
2019
2274
|
* <code>Resolved</code>.</p>
|
|
2020
2275
|
*/
|
|
2021
2276
|
status?: IncidentRecordStatus | string;
|
|
2022
2277
|
/**
|
|
2278
|
+
* @public
|
|
2023
2279
|
* <p>The Chatbot chat channel where responders can collaborate.</p>
|
|
2024
2280
|
*/
|
|
2025
2281
|
chatChannel?: ChatChannel;
|
|
2026
2282
|
/**
|
|
2283
|
+
* @public
|
|
2027
2284
|
* <p>The Amazon SNS targets that Incident Manager notifies when a client updates an
|
|
2028
2285
|
* incident.</p>
|
|
2029
2286
|
* <p>Using multiple SNS topics creates redundancy in the event that a Region is down during the
|
|
@@ -2041,16 +2298,19 @@ export interface UpdateIncidentRecordOutput {
|
|
|
2041
2298
|
*/
|
|
2042
2299
|
export interface UpdateRelatedItemsInput {
|
|
2043
2300
|
/**
|
|
2301
|
+
* @public
|
|
2044
2302
|
* <p>A token that ensures that a client calls the operation only once with the specified
|
|
2045
2303
|
* details.</p>
|
|
2046
2304
|
*/
|
|
2047
2305
|
clientToken?: string;
|
|
2048
2306
|
/**
|
|
2307
|
+
* @public
|
|
2049
2308
|
* <p>The Amazon Resource Name (ARN) of the incident record that contains the related items that
|
|
2050
2309
|
* you update.</p>
|
|
2051
2310
|
*/
|
|
2052
2311
|
incidentRecordArn: string | undefined;
|
|
2053
2312
|
/**
|
|
2313
|
+
* @public
|
|
2054
2314
|
* <p>Details about the item that you are add to, or delete from, an incident.</p>
|
|
2055
2315
|
*/
|
|
2056
2316
|
relatedItemsUpdate: RelatedItemsUpdate | undefined;
|
|
@@ -2070,6 +2330,7 @@ export type UpdateReplicationSetAction = UpdateReplicationSetAction.AddRegionAct
|
|
|
2070
2330
|
*/
|
|
2071
2331
|
export declare namespace UpdateReplicationSetAction {
|
|
2072
2332
|
/**
|
|
2333
|
+
* @public
|
|
2073
2334
|
* <p>Details about the Amazon Web Services Region that you're adding to the replication
|
|
2074
2335
|
* set.</p>
|
|
2075
2336
|
*/
|
|
@@ -2079,6 +2340,7 @@ export declare namespace UpdateReplicationSetAction {
|
|
|
2079
2340
|
$unknown?: never;
|
|
2080
2341
|
}
|
|
2081
2342
|
/**
|
|
2343
|
+
* @public
|
|
2082
2344
|
* <p>Details about the Amazon Web Services Region that you're deleting to the replication
|
|
2083
2345
|
* set.</p>
|
|
2084
2346
|
*/
|
|
@@ -2087,6 +2349,9 @@ export declare namespace UpdateReplicationSetAction {
|
|
|
2087
2349
|
deleteRegionAction: DeleteRegionAction;
|
|
2088
2350
|
$unknown?: never;
|
|
2089
2351
|
}
|
|
2352
|
+
/**
|
|
2353
|
+
* @public
|
|
2354
|
+
*/
|
|
2090
2355
|
interface $UnknownMember {
|
|
2091
2356
|
addRegionAction?: never;
|
|
2092
2357
|
deleteRegionAction?: never;
|
|
@@ -2104,14 +2369,17 @@ export declare namespace UpdateReplicationSetAction {
|
|
|
2104
2369
|
*/
|
|
2105
2370
|
export interface UpdateReplicationSetInput {
|
|
2106
2371
|
/**
|
|
2372
|
+
* @public
|
|
2107
2373
|
* <p>The Amazon Resource Name (ARN) of the replication set you're updating.</p>
|
|
2108
2374
|
*/
|
|
2109
2375
|
arn: string | undefined;
|
|
2110
2376
|
/**
|
|
2377
|
+
* @public
|
|
2111
2378
|
* <p>An action to add or delete a Region.</p>
|
|
2112
2379
|
*/
|
|
2113
2380
|
actions: UpdateReplicationSetAction[] | undefined;
|
|
2114
2381
|
/**
|
|
2382
|
+
* @public
|
|
2115
2383
|
* <p>A token that ensures that the operation is called only once with the specified
|
|
2116
2384
|
* details.</p>
|
|
2117
2385
|
*/
|
|
@@ -2127,22 +2395,27 @@ export interface UpdateReplicationSetOutput {
|
|
|
2127
2395
|
*/
|
|
2128
2396
|
export interface UpdateResponsePlanInput {
|
|
2129
2397
|
/**
|
|
2398
|
+
* @public
|
|
2130
2399
|
* <p>A token ensuring that the operation is called only once with the specified details.</p>
|
|
2131
2400
|
*/
|
|
2132
2401
|
clientToken?: string;
|
|
2133
2402
|
/**
|
|
2403
|
+
* @public
|
|
2134
2404
|
* <p>The Amazon Resource Name (ARN) of the response plan.</p>
|
|
2135
2405
|
*/
|
|
2136
2406
|
arn: string | undefined;
|
|
2137
2407
|
/**
|
|
2408
|
+
* @public
|
|
2138
2409
|
* <p>The long format name of the response plan. The display name can't contain spaces.</p>
|
|
2139
2410
|
*/
|
|
2140
2411
|
displayName?: string;
|
|
2141
2412
|
/**
|
|
2413
|
+
* @public
|
|
2142
2414
|
* <p>The short format name of the incident. The title can't contain spaces.</p>
|
|
2143
2415
|
*/
|
|
2144
2416
|
incidentTemplateTitle?: string;
|
|
2145
2417
|
/**
|
|
2418
|
+
* @public
|
|
2146
2419
|
* <p>Defines the impact to the customers. Providing an impact overwrites the impact provided by
|
|
2147
2420
|
* a response plan.</p>
|
|
2148
2421
|
* <p class="title">
|
|
@@ -2173,35 +2446,42 @@ export interface UpdateResponsePlanInput {
|
|
|
2173
2446
|
*/
|
|
2174
2447
|
incidentTemplateImpact?: number;
|
|
2175
2448
|
/**
|
|
2449
|
+
* @public
|
|
2176
2450
|
* <p>A brief summary of the incident. This typically contains what has happened, what's
|
|
2177
2451
|
* currently happening, and next steps.</p>
|
|
2178
2452
|
*/
|
|
2179
2453
|
incidentTemplateSummary?: string;
|
|
2180
2454
|
/**
|
|
2455
|
+
* @public
|
|
2181
2456
|
* <p>The string Incident Manager uses to prevent duplicate incidents from being created by the same
|
|
2182
2457
|
* incident in the same account.</p>
|
|
2183
2458
|
*/
|
|
2184
2459
|
incidentTemplateDedupeString?: string;
|
|
2185
2460
|
/**
|
|
2461
|
+
* @public
|
|
2186
2462
|
* <p>The Amazon SNS targets that are notified when updates are made to an
|
|
2187
2463
|
* incident.</p>
|
|
2188
2464
|
*/
|
|
2189
2465
|
incidentTemplateNotificationTargets?: NotificationTargetItem[];
|
|
2190
2466
|
/**
|
|
2467
|
+
* @public
|
|
2191
2468
|
* <p>The Chatbot chat channel used for collaboration during an incident.</p>
|
|
2192
2469
|
* <p>Use the empty structure to remove the chat channel from the response plan.</p>
|
|
2193
2470
|
*/
|
|
2194
2471
|
chatChannel?: ChatChannel;
|
|
2195
2472
|
/**
|
|
2473
|
+
* @public
|
|
2196
2474
|
* <p>The Amazon Resource Name (ARN) for the contacts and escalation plans that the response
|
|
2197
2475
|
* plan engages during an incident.</p>
|
|
2198
2476
|
*/
|
|
2199
2477
|
engagements?: string[];
|
|
2200
2478
|
/**
|
|
2479
|
+
* @public
|
|
2201
2480
|
* <p>The actions that this response plan takes at the beginning of an incident.</p>
|
|
2202
2481
|
*/
|
|
2203
2482
|
actions?: Action[];
|
|
2204
2483
|
/**
|
|
2484
|
+
* @public
|
|
2205
2485
|
* <p>Tags to assign to the template. When the <code>StartIncident</code> API action is called,
|
|
2206
2486
|
* Incident Manager assigns the tags specified in the template to the incident. To call this action,
|
|
2207
2487
|
* you must also have permission to call the <code>TagResource</code> API action for the incident
|
|
@@ -2209,6 +2489,7 @@ export interface UpdateResponsePlanInput {
|
|
|
2209
2489
|
*/
|
|
2210
2490
|
incidentTemplateTags?: Record<string, string>;
|
|
2211
2491
|
/**
|
|
2492
|
+
* @public
|
|
2212
2493
|
* <p>Information about third-party services integrated into the response plan.</p>
|
|
2213
2494
|
*/
|
|
2214
2495
|
integrations?: Integration[];
|
|
@@ -2223,32 +2504,39 @@ export interface UpdateResponsePlanOutput {
|
|
|
2223
2504
|
*/
|
|
2224
2505
|
export interface UpdateTimelineEventInput {
|
|
2225
2506
|
/**
|
|
2507
|
+
* @public
|
|
2226
2508
|
* <p>A token that ensures that a client calls the operation only once with the specified
|
|
2227
2509
|
* details.</p>
|
|
2228
2510
|
*/
|
|
2229
2511
|
clientToken?: string;
|
|
2230
2512
|
/**
|
|
2513
|
+
* @public
|
|
2231
2514
|
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
|
|
2232
2515
|
*/
|
|
2233
2516
|
incidentRecordArn: string | undefined;
|
|
2234
2517
|
/**
|
|
2518
|
+
* @public
|
|
2235
2519
|
* <p>The ID of the event to update. You can use <code>ListTimelineEvents</code> to find an
|
|
2236
2520
|
* event's ID.</p>
|
|
2237
2521
|
*/
|
|
2238
2522
|
eventId: string | undefined;
|
|
2239
2523
|
/**
|
|
2524
|
+
* @public
|
|
2240
2525
|
* <p>The time that the event occurred.</p>
|
|
2241
2526
|
*/
|
|
2242
2527
|
eventTime?: Date;
|
|
2243
2528
|
/**
|
|
2529
|
+
* @public
|
|
2244
2530
|
* <p>The type of event. You can update events of type <code>Custom Event</code>.</p>
|
|
2245
2531
|
*/
|
|
2246
2532
|
eventType?: string;
|
|
2247
2533
|
/**
|
|
2534
|
+
* @public
|
|
2248
2535
|
* <p>A short description of the event.</p>
|
|
2249
2536
|
*/
|
|
2250
2537
|
eventData?: string;
|
|
2251
2538
|
/**
|
|
2539
|
+
* @public
|
|
2252
2540
|
* <p>Updates all existing references in a <code>TimelineEvent</code>. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter
|
|
2253
2541
|
* its Amazon Resource Name (ARN). You can also specify a related item associated with that
|
|
2254
2542
|
* resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a
|