@aws-sdk/client-ssm-incidents 3.300.0 → 3.303.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/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +53 -63
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +53 -63
- package/dist-types/SSMIncidents.d.ts +20 -22
- package/dist-types/commands/CreateReplicationSetCommand.d.ts +5 -5
- package/dist-types/commands/CreateResponsePlanCommand.d.ts +22 -22
- package/dist-types/commands/CreateTimelineEventCommand.d.ts +6 -6
- package/dist-types/commands/DeleteIncidentRecordCommand.d.ts +1 -1
- package/dist-types/commands/DeleteReplicationSetCommand.d.ts +2 -2
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +2 -2
- package/dist-types/commands/DeleteResponsePlanCommand.d.ts +3 -3
- package/dist-types/commands/DeleteTimelineEventCommand.d.ts +1 -1
- package/dist-types/commands/GetIncidentRecordCommand.d.ts +1 -1
- package/dist-types/commands/GetReplicationSetCommand.d.ts +1 -1
- package/dist-types/commands/GetResourcePoliciesCommand.d.ts +1 -1
- package/dist-types/commands/GetResponsePlanCommand.d.ts +1 -1
- package/dist-types/commands/GetTimelineEventCommand.d.ts +1 -1
- package/dist-types/commands/ListIncidentRecordsCommand.d.ts +8 -8
- package/dist-types/commands/ListRelatedItemsCommand.d.ts +1 -1
- package/dist-types/commands/ListReplicationSetsCommand.d.ts +1 -1
- package/dist-types/commands/ListResponsePlansCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListTimelineEventsCommand.d.ts +7 -7
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +3 -4
- package/dist-types/commands/StartIncidentCommand.d.ts +8 -8
- package/dist-types/commands/TagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateDeletionProtectionCommand.d.ts +2 -2
- package/dist-types/commands/UpdateIncidentRecordCommand.d.ts +8 -8
- package/dist-types/commands/UpdateRelatedItemsCommand.d.ts +7 -7
- package/dist-types/commands/UpdateReplicationSetCommand.d.ts +5 -5
- package/dist-types/commands/UpdateResponsePlanCommand.d.ts +18 -18
- package/dist-types/commands/UpdateTimelineEventCommand.d.ts +4 -5
- package/dist-types/models/models_0.d.ts +313 -289
- package/dist-types/ts3.4/models/models_0.d.ts +67 -53
- package/package.json +35 -35
|
@@ -14,11 +14,16 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
16
|
* @public
|
|
17
|
+
* @enum
|
|
17
18
|
*/
|
|
18
|
-
export declare
|
|
19
|
-
INCIDENT_RECORD_ARN
|
|
20
|
-
INVOLVED_RESOURCES
|
|
21
|
-
}
|
|
19
|
+
export declare const VariableType: {
|
|
20
|
+
readonly INCIDENT_RECORD_ARN: "INCIDENT_RECORD_ARN";
|
|
21
|
+
readonly INVOLVED_RESOURCES: "INVOLVED_RESOURCES";
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
export type VariableType = (typeof VariableType)[keyof typeof VariableType];
|
|
22
27
|
/**
|
|
23
28
|
* @public
|
|
24
29
|
* <p>The dynamic SSM parameter value.</p>
|
|
@@ -30,7 +35,7 @@ export type DynamicSsmParameterValue = DynamicSsmParameterValue.VariableMember |
|
|
|
30
35
|
export declare namespace DynamicSsmParameterValue {
|
|
31
36
|
/**
|
|
32
37
|
* <p>Variable dynamic parameters. A parameter value is determined when an incident is
|
|
33
|
-
*
|
|
38
|
+
* created.</p>
|
|
34
39
|
*/
|
|
35
40
|
interface VariableMember {
|
|
36
41
|
variable: VariableType | string;
|
|
@@ -48,20 +53,25 @@ export declare namespace DynamicSsmParameterValue {
|
|
|
48
53
|
}
|
|
49
54
|
/**
|
|
50
55
|
* @public
|
|
56
|
+
* @enum
|
|
51
57
|
*/
|
|
52
|
-
export declare
|
|
53
|
-
IMPACTED_ACCOUNT
|
|
54
|
-
RESPONSE_PLAN_OWNER_ACCOUNT
|
|
55
|
-
}
|
|
58
|
+
export declare const SsmTargetAccount: {
|
|
59
|
+
readonly IMPACTED_ACCOUNT: "IMPACTED_ACCOUNT";
|
|
60
|
+
readonly RESPONSE_PLAN_OWNER_ACCOUNT: "RESPONSE_PLAN_OWNER_ACCOUNT";
|
|
61
|
+
};
|
|
62
|
+
/**
|
|
63
|
+
* @public
|
|
64
|
+
*/
|
|
65
|
+
export type SsmTargetAccount = (typeof SsmTargetAccount)[keyof typeof SsmTargetAccount];
|
|
56
66
|
/**
|
|
57
67
|
* @public
|
|
58
68
|
* <p>Details about the Systems Manager automation document that will be used as a runbook
|
|
59
|
-
*
|
|
69
|
+
* during an incident.</p>
|
|
60
70
|
*/
|
|
61
71
|
export interface SsmAutomation {
|
|
62
72
|
/**
|
|
63
73
|
* <p>The Amazon Resource Name (ARN) of the role that the automation document will assume when
|
|
64
|
-
*
|
|
74
|
+
* running commands.</p>
|
|
65
75
|
*/
|
|
66
76
|
roleArn: string | undefined;
|
|
67
77
|
/**
|
|
@@ -74,7 +84,7 @@ export interface SsmAutomation {
|
|
|
74
84
|
documentVersion?: string;
|
|
75
85
|
/**
|
|
76
86
|
* <p>The account that the automation document will be run in. This can be in either the
|
|
77
|
-
*
|
|
87
|
+
* management account or an application account.</p>
|
|
78
88
|
*/
|
|
79
89
|
targetAccount?: SsmTargetAccount | string;
|
|
80
90
|
/**
|
|
@@ -82,15 +92,15 @@ export interface SsmAutomation {
|
|
|
82
92
|
*/
|
|
83
93
|
parameters?: Record<string, string[]>;
|
|
84
94
|
/**
|
|
85
|
-
* <p>The key-value pair to resolve dynamic parameter values when processing a Systems Manager
|
|
86
|
-
*
|
|
95
|
+
* <p>The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation
|
|
96
|
+
* runbook.</p>
|
|
87
97
|
*/
|
|
88
98
|
dynamicParameters?: Record<string, DynamicSsmParameterValue>;
|
|
89
99
|
}
|
|
90
100
|
/**
|
|
91
101
|
* @public
|
|
92
102
|
* <p>The action that starts at the beginning of an incident. The response plan defines the
|
|
93
|
-
*
|
|
103
|
+
* action.</p>
|
|
94
104
|
*/
|
|
95
105
|
export type Action = Action.SsmAutomationMember | Action.$UnknownMember;
|
|
96
106
|
/**
|
|
@@ -98,8 +108,8 @@ export type Action = Action.SsmAutomationMember | Action.$UnknownMember;
|
|
|
98
108
|
*/
|
|
99
109
|
export declare namespace Action {
|
|
100
110
|
/**
|
|
101
|
-
* <p>The Systems Manager automation document to start as the runbook at the beginning of
|
|
102
|
-
*
|
|
111
|
+
* <p>The Systems Manager automation document to start as the runbook at the beginning of the
|
|
112
|
+
* incident.</p>
|
|
103
113
|
*/
|
|
104
114
|
interface SsmAutomationMember {
|
|
105
115
|
ssmAutomation: SsmAutomation;
|
|
@@ -117,8 +127,8 @@ export declare namespace Action {
|
|
|
117
127
|
}
|
|
118
128
|
/**
|
|
119
129
|
* @public
|
|
120
|
-
* <p>Defines the Amazon Web Services Region and KMS key to add to the
|
|
121
|
-
*
|
|
130
|
+
* <p>Defines the Amazon Web Services Region and KMS key to add to the replication
|
|
131
|
+
* set. </p>
|
|
122
132
|
*/
|
|
123
133
|
export interface AddRegionAction {
|
|
124
134
|
/**
|
|
@@ -170,7 +180,7 @@ export declare namespace AttributeValueList {
|
|
|
170
180
|
/**
|
|
171
181
|
* @public
|
|
172
182
|
* <p>The Systems Manager automation document process to start as the runbook at the
|
|
173
|
-
*
|
|
183
|
+
* beginning of the incident.</p>
|
|
174
184
|
*/
|
|
175
185
|
export type AutomationExecution = AutomationExecution.SsmExecutionArnMember | AutomationExecution.$UnknownMember;
|
|
176
186
|
/**
|
|
@@ -202,8 +212,7 @@ export interface EmptyChatChannel {
|
|
|
202
212
|
}
|
|
203
213
|
/**
|
|
204
214
|
* @public
|
|
205
|
-
* <p>The Chatbot chat channel used for collaboration during an
|
|
206
|
-
* incident.</p>
|
|
215
|
+
* <p>The Chatbot chat channel used for collaboration during an incident.</p>
|
|
207
216
|
*/
|
|
208
217
|
export type ChatChannel = ChatChannel.ChatbotSnsMember | ChatChannel.EmptyMember | ChatChannel.$UnknownMember;
|
|
209
218
|
/**
|
|
@@ -219,9 +228,9 @@ export declare namespace ChatChannel {
|
|
|
219
228
|
$unknown?: never;
|
|
220
229
|
}
|
|
221
230
|
/**
|
|
222
|
-
* <p>The Amazon SNS targets that Chatbot uses to notify the chat channel
|
|
223
|
-
*
|
|
224
|
-
*
|
|
231
|
+
* <p>The Amazon SNS targets that Chatbot uses to notify the chat channel of
|
|
232
|
+
* updates to an incident. You can also make updates to the incident through the chat channel by
|
|
233
|
+
* using the Amazon SNS topics. </p>
|
|
225
234
|
*/
|
|
226
235
|
interface ChatbotSnsMember {
|
|
227
236
|
empty?: never;
|
|
@@ -243,9 +252,9 @@ export declare namespace ChatChannel {
|
|
|
243
252
|
/**
|
|
244
253
|
* @public
|
|
245
254
|
* <p>A conditional statement with which to compare a value, after a timestamp, before a
|
|
246
|
-
*
|
|
247
|
-
*
|
|
248
|
-
*
|
|
255
|
+
* timestamp, or equal to a string or integer. If multiple conditions are specified, the
|
|
256
|
+
* conditionals become an <code>AND</code>ed statement. If multiple values are specified for a
|
|
257
|
+
* conditional, the values are <code>OR</code>d.</p>
|
|
249
258
|
*/
|
|
250
259
|
export type Condition = Condition.AfterMember | Condition.BeforeMember | Condition.EqualsMember | Condition.$UnknownMember;
|
|
251
260
|
/**
|
|
@@ -295,14 +304,19 @@ export declare namespace Condition {
|
|
|
295
304
|
}
|
|
296
305
|
/**
|
|
297
306
|
* @public
|
|
307
|
+
* @enum
|
|
298
308
|
*/
|
|
299
|
-
export declare
|
|
300
|
-
INCIDENT_RECORD
|
|
301
|
-
REPLICATION_SET
|
|
302
|
-
RESOURCE_POLICY
|
|
303
|
-
RESPONSE_PLAN
|
|
304
|
-
TIMELINE_EVENT
|
|
305
|
-
}
|
|
309
|
+
export declare const ResourceType: {
|
|
310
|
+
readonly INCIDENT_RECORD: "INCIDENT_RECORD";
|
|
311
|
+
readonly REPLICATION_SET: "REPLICATION_SET";
|
|
312
|
+
readonly RESOURCE_POLICY: "RESOURCE_POLICY";
|
|
313
|
+
readonly RESPONSE_PLAN: "RESPONSE_PLAN";
|
|
314
|
+
readonly TIMELINE_EVENT: "TIMELINE_EVENT";
|
|
315
|
+
};
|
|
316
|
+
/**
|
|
317
|
+
* @public
|
|
318
|
+
*/
|
|
319
|
+
export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
306
320
|
/**
|
|
307
321
|
* @public
|
|
308
322
|
* <p>Updating or deleting a resource causes an inconsistent state.</p>
|
|
@@ -330,7 +344,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
330
344
|
/**
|
|
331
345
|
* @public
|
|
332
346
|
* <p>The mapping between a Amazon Web Services Region and the key that's used to encrypt the
|
|
333
|
-
*
|
|
347
|
+
* data.</p>
|
|
334
348
|
*/
|
|
335
349
|
export interface RegionMapInputValue {
|
|
336
350
|
/**
|
|
@@ -343,13 +357,13 @@ export interface RegionMapInputValue {
|
|
|
343
357
|
*/
|
|
344
358
|
export interface CreateReplicationSetInput {
|
|
345
359
|
/**
|
|
346
|
-
* <p>The Regions that Incident Manager replicates your data to. You can have up to three Regions
|
|
347
|
-
*
|
|
360
|
+
* <p>The Regions that Incident Manager replicates your data to. You can have up to three Regions in
|
|
361
|
+
* your replication set.</p>
|
|
348
362
|
*/
|
|
349
363
|
regions: Record<string, RegionMapInputValue> | undefined;
|
|
350
364
|
/**
|
|
351
365
|
* <p>A token that ensures that the operation is called only once with the specified
|
|
352
|
-
*
|
|
366
|
+
* details.</p>
|
|
353
367
|
*/
|
|
354
368
|
clientToken?: string;
|
|
355
369
|
/**
|
|
@@ -381,10 +395,15 @@ export declare class InternalServerException extends __BaseException {
|
|
|
381
395
|
}
|
|
382
396
|
/**
|
|
383
397
|
* @public
|
|
398
|
+
* @enum
|
|
384
399
|
*/
|
|
385
|
-
export declare
|
|
386
|
-
SSM_INCIDENTS
|
|
387
|
-
}
|
|
400
|
+
export declare const ServiceCode: {
|
|
401
|
+
readonly SSM_INCIDENTS: "ssm-incidents";
|
|
402
|
+
};
|
|
403
|
+
/**
|
|
404
|
+
* @public
|
|
405
|
+
*/
|
|
406
|
+
export type ServiceCode = (typeof ServiceCode)[keyof typeof ServiceCode];
|
|
388
407
|
/**
|
|
389
408
|
* @public
|
|
390
409
|
* <p>Request would cause a service quota to be exceeded.</p>
|
|
@@ -475,7 +494,7 @@ export declare namespace NotificationTargetItem {
|
|
|
475
494
|
/**
|
|
476
495
|
* @public
|
|
477
496
|
* <p>Basic details used in creating a response plan. The response plan is then used to create
|
|
478
|
-
*
|
|
497
|
+
* an incident record.</p>
|
|
479
498
|
*/
|
|
480
499
|
export interface IncidentTemplate {
|
|
481
500
|
/**
|
|
@@ -488,34 +507,33 @@ export interface IncidentTemplate {
|
|
|
488
507
|
impact: number | undefined;
|
|
489
508
|
/**
|
|
490
509
|
* <p>The summary of the incident. The summary is a brief synopsis of what occurred, what's
|
|
491
|
-
*
|
|
510
|
+
* currently happening, and context.</p>
|
|
492
511
|
*/
|
|
493
512
|
summary?: string;
|
|
494
513
|
/**
|
|
495
514
|
* <p>Used to stop Incident Manager from creating multiple incident records for the same incident.
|
|
496
|
-
*
|
|
515
|
+
* </p>
|
|
497
516
|
*/
|
|
498
517
|
dedupeString?: string;
|
|
499
518
|
/**
|
|
500
519
|
* <p>The Amazon SNS targets that are notified when updates are made to an
|
|
501
|
-
*
|
|
520
|
+
* incident.</p>
|
|
502
521
|
*/
|
|
503
522
|
notificationTargets?: NotificationTargetItem[];
|
|
504
523
|
/**
|
|
505
|
-
* <p>Tags to assign to the template. When the <code>StartIncident</code> API action is
|
|
506
|
-
*
|
|
524
|
+
* <p>Tags to assign to the template. When the <code>StartIncident</code> API action is called,
|
|
525
|
+
* Incident Manager assigns the tags specified in the template to the incident.</p>
|
|
507
526
|
*/
|
|
508
527
|
incidentTags?: Record<string, string>;
|
|
509
528
|
}
|
|
510
529
|
/**
|
|
511
530
|
* @public
|
|
512
|
-
* <p>Details about the PagerDuty service where the response plan creates an
|
|
513
|
-
* incident.</p>
|
|
531
|
+
* <p>Details about the PagerDuty service where the response plan creates an incident.</p>
|
|
514
532
|
*/
|
|
515
533
|
export interface PagerDutyIncidentConfiguration {
|
|
516
534
|
/**
|
|
517
|
-
* <p>The ID of the PagerDuty service that the response plan associates with an incident
|
|
518
|
-
*
|
|
535
|
+
* <p>The ID of the PagerDuty service that the response plan associates with an incident when it
|
|
536
|
+
* launches.</p>
|
|
519
537
|
*/
|
|
520
538
|
serviceId: string | undefined;
|
|
521
539
|
}
|
|
@@ -530,7 +548,7 @@ export interface PagerDutyConfiguration {
|
|
|
530
548
|
name: string | undefined;
|
|
531
549
|
/**
|
|
532
550
|
* <p>The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or
|
|
533
|
-
*
|
|
551
|
+
* User Token REST API Key, and other user credentials.</p>
|
|
534
552
|
*/
|
|
535
553
|
secretId: string | undefined;
|
|
536
554
|
/**
|
|
@@ -549,7 +567,7 @@ export type Integration = Integration.PagerDutyConfigurationMember | Integration
|
|
|
549
567
|
export declare namespace Integration {
|
|
550
568
|
/**
|
|
551
569
|
* <p>Information about the PagerDuty service where the response plan creates an
|
|
552
|
-
*
|
|
570
|
+
* incident.</p>
|
|
553
571
|
*/
|
|
554
572
|
interface PagerDutyConfigurationMember {
|
|
555
573
|
pagerDutyConfiguration: PagerDutyConfiguration;
|
|
@@ -570,8 +588,7 @@ export declare namespace Integration {
|
|
|
570
588
|
*/
|
|
571
589
|
export interface CreateResponsePlanInput {
|
|
572
590
|
/**
|
|
573
|
-
* <p>A token ensuring that the operation is called only once with the specified
|
|
574
|
-
* details.</p>
|
|
591
|
+
* <p>A token ensuring that the operation is called only once with the specified details.</p>
|
|
575
592
|
*/
|
|
576
593
|
clientToken?: string;
|
|
577
594
|
/**
|
|
@@ -587,13 +604,12 @@ export interface CreateResponsePlanInput {
|
|
|
587
604
|
*/
|
|
588
605
|
incidentTemplate: IncidentTemplate | undefined;
|
|
589
606
|
/**
|
|
590
|
-
* <p>The Chatbot chat channel used for collaboration during an
|
|
591
|
-
* incident.</p>
|
|
607
|
+
* <p>The Chatbot chat channel used for collaboration during an incident.</p>
|
|
592
608
|
*/
|
|
593
609
|
chatChannel?: ChatChannel;
|
|
594
610
|
/**
|
|
595
611
|
* <p>The Amazon Resource Name (ARN) for the contacts and escalation plans that the response
|
|
596
|
-
*
|
|
612
|
+
* plan engages during an incident.</p>
|
|
597
613
|
*/
|
|
598
614
|
engagements?: string[];
|
|
599
615
|
/**
|
|
@@ -641,7 +657,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
641
657
|
/**
|
|
642
658
|
* @public
|
|
643
659
|
* <p>An item referenced in a <code>TimelineEvent</code> that is involved in or somehow
|
|
644
|
-
*
|
|
660
|
+
* associated with an incident. You can specify an Amazon Resource Name (ARN) for an Amazon Web Services resource or a <code>RelatedItem</code> ID.</p>
|
|
645
661
|
*/
|
|
646
662
|
export type EventReference = EventReference.RelatedItemIdMember | EventReference.ResourceMember | EventReference.$UnknownMember;
|
|
647
663
|
/**
|
|
@@ -650,7 +666,7 @@ export type EventReference = EventReference.RelatedItemIdMember | EventReference
|
|
|
650
666
|
export declare namespace EventReference {
|
|
651
667
|
/**
|
|
652
668
|
* <p>The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a
|
|
653
|
-
*
|
|
669
|
+
* <code>TimelineEvent</code>.</p>
|
|
654
670
|
*/
|
|
655
671
|
interface ResourceMember {
|
|
656
672
|
resource: string;
|
|
@@ -682,13 +698,13 @@ export declare namespace EventReference {
|
|
|
682
698
|
*/
|
|
683
699
|
export interface CreateTimelineEventInput {
|
|
684
700
|
/**
|
|
685
|
-
* <p>A token
|
|
686
|
-
*
|
|
701
|
+
* <p>A token that ensures that a client calls the action only once with the specified
|
|
702
|
+
* details.</p>
|
|
687
703
|
*/
|
|
688
704
|
clientToken?: string;
|
|
689
705
|
/**
|
|
690
|
-
* <p>The Amazon Resource Name (ARN) of the incident record
|
|
691
|
-
*
|
|
706
|
+
* <p>The Amazon Resource Name (ARN) of the incident record that the action adds the incident
|
|
707
|
+
* to.</p>
|
|
692
708
|
*/
|
|
693
709
|
incidentRecordArn: string | undefined;
|
|
694
710
|
/**
|
|
@@ -696,8 +712,8 @@ export interface CreateTimelineEventInput {
|
|
|
696
712
|
*/
|
|
697
713
|
eventTime: Date | undefined;
|
|
698
714
|
/**
|
|
699
|
-
* <p>The type of
|
|
700
|
-
*
|
|
715
|
+
* <p>The type of event. You can create timeline events of type <code>Custom
|
|
716
|
+
* Event</code>.</p>
|
|
701
717
|
*/
|
|
702
718
|
eventType: string | undefined;
|
|
703
719
|
/**
|
|
@@ -705,13 +721,11 @@ export interface CreateTimelineEventInput {
|
|
|
705
721
|
*/
|
|
706
722
|
eventData: string | undefined;
|
|
707
723
|
/**
|
|
708
|
-
* <p>Adds one or more references to the <code>TimelineEvent</code>. A reference
|
|
709
|
-
*
|
|
710
|
-
*
|
|
711
|
-
*
|
|
712
|
-
*
|
|
713
|
-
* the resource. You could also specify a Amazon CloudWatch metric for that table. The
|
|
714
|
-
* metric is the related item.</p>
|
|
724
|
+
* <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
|
+
* its Amazon Resource Name (ARN). You can also specify a related item associated with a
|
|
726
|
+
* resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a
|
|
727
|
+
* resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated
|
|
728
|
+
* with the DynamoDB table as a related item.</p>
|
|
715
729
|
*/
|
|
716
730
|
eventReferences?: EventReference[];
|
|
717
731
|
}
|
|
@@ -745,12 +759,11 @@ export interface DeleteIncidentRecordOutput {
|
|
|
745
759
|
/**
|
|
746
760
|
* @public
|
|
747
761
|
* <p>Defines the information about the Amazon Web Services Region you're deleting from your
|
|
748
|
-
*
|
|
762
|
+
* replication set.</p>
|
|
749
763
|
*/
|
|
750
764
|
export interface DeleteRegionAction {
|
|
751
765
|
/**
|
|
752
|
-
* <p>The name of the Amazon Web Services Region you're deleting from the replication
|
|
753
|
-
* set.</p>
|
|
766
|
+
* <p>The name of the Amazon Web Services Region you're deleting from the replication set.</p>
|
|
754
767
|
*/
|
|
755
768
|
regionName: string | undefined;
|
|
756
769
|
}
|
|
@@ -805,13 +818,12 @@ export interface DeleteResponsePlanOutput {
|
|
|
805
818
|
*/
|
|
806
819
|
export interface DeleteTimelineEventInput {
|
|
807
820
|
/**
|
|
808
|
-
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline
|
|
809
|
-
* event.</p>
|
|
821
|
+
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
|
|
810
822
|
*/
|
|
811
823
|
incidentRecordArn: string | undefined;
|
|
812
824
|
/**
|
|
813
|
-
* <p>The ID of the event
|
|
814
|
-
*
|
|
825
|
+
* <p>The ID of the event to update. You can use <code>ListTimelineEvents</code> to find an
|
|
826
|
+
* event's ID.</p>
|
|
815
827
|
*/
|
|
816
828
|
eventId: string | undefined;
|
|
817
829
|
}
|
|
@@ -860,8 +872,8 @@ export interface Filter {
|
|
|
860
872
|
*/
|
|
861
873
|
key: string | undefined;
|
|
862
874
|
/**
|
|
863
|
-
* <p>The condition accepts before or after a specified time, equal to a string, or equal to
|
|
864
|
-
*
|
|
875
|
+
* <p>The condition accepts before or after a specified time, equal to a string, or equal to an
|
|
876
|
+
* integer.</p>
|
|
865
877
|
*/
|
|
866
878
|
condition: Condition | undefined;
|
|
867
879
|
}
|
|
@@ -885,7 +897,7 @@ export interface IncidentRecordSource {
|
|
|
885
897
|
createdBy: string | undefined;
|
|
886
898
|
/**
|
|
887
899
|
* <p>The service principal that assumed the role specified in <code>createdBy</code>. If no
|
|
888
|
-
*
|
|
900
|
+
* service principal assumed the role this will be left blank.</p>
|
|
889
901
|
*/
|
|
890
902
|
invokedBy?: string;
|
|
891
903
|
/**
|
|
@@ -894,18 +906,23 @@ export interface IncidentRecordSource {
|
|
|
894
906
|
resourceArn?: string;
|
|
895
907
|
/**
|
|
896
908
|
* <p>The service that started the incident. This can be manually created from Incident Manager,
|
|
897
|
-
*
|
|
898
|
-
*
|
|
909
|
+
* automatically created using an Amazon CloudWatch alarm, or Amazon EventBridge
|
|
910
|
+
* event.</p>
|
|
899
911
|
*/
|
|
900
912
|
source: string | undefined;
|
|
901
913
|
}
|
|
902
914
|
/**
|
|
903
915
|
* @public
|
|
916
|
+
* @enum
|
|
904
917
|
*/
|
|
905
|
-
export declare
|
|
906
|
-
OPEN
|
|
907
|
-
RESOLVED
|
|
908
|
-
}
|
|
918
|
+
export declare const IncidentRecordStatus: {
|
|
919
|
+
readonly OPEN: "OPEN";
|
|
920
|
+
readonly RESOLVED: "RESOLVED";
|
|
921
|
+
};
|
|
922
|
+
/**
|
|
923
|
+
* @public
|
|
924
|
+
*/
|
|
925
|
+
export type IncidentRecordStatus = (typeof IncidentRecordStatus)[keyof typeof IncidentRecordStatus];
|
|
909
926
|
/**
|
|
910
927
|
* @public
|
|
911
928
|
* <p>The record of the incident that's created when an incident occurs.</p>
|
|
@@ -921,7 +938,7 @@ export interface IncidentRecord {
|
|
|
921
938
|
title: string | undefined;
|
|
922
939
|
/**
|
|
923
940
|
* <p>The summary of the incident. The summary is a brief synopsis of what occurred, what's
|
|
924
|
-
*
|
|
941
|
+
* currently happening, and context of the incident.</p>
|
|
925
942
|
*/
|
|
926
943
|
summary?: string;
|
|
927
944
|
/**
|
|
@@ -957,8 +974,8 @@ export interface IncidentRecord {
|
|
|
957
974
|
*/
|
|
958
975
|
incidentRecordSource: IncidentRecordSource | undefined;
|
|
959
976
|
/**
|
|
960
|
-
* <p>The string Incident Manager uses to prevent duplicate incidents from being created by the
|
|
961
|
-
*
|
|
977
|
+
* <p>The string Incident Manager uses to prevent duplicate incidents from being created by the same
|
|
978
|
+
* incident in the same account.</p>
|
|
962
979
|
*/
|
|
963
980
|
dedupeString: string | undefined;
|
|
964
981
|
/**
|
|
@@ -967,7 +984,7 @@ export interface IncidentRecord {
|
|
|
967
984
|
chatChannel?: ChatChannel;
|
|
968
985
|
/**
|
|
969
986
|
* <p>The Amazon SNS targets that are notified when updates are made to an
|
|
970
|
-
*
|
|
987
|
+
* incident.</p>
|
|
971
988
|
*/
|
|
972
989
|
notificationTargets?: NotificationTargetItem[];
|
|
973
990
|
}
|
|
@@ -991,25 +1008,30 @@ export interface GetReplicationSetInput {
|
|
|
991
1008
|
}
|
|
992
1009
|
/**
|
|
993
1010
|
* @public
|
|
1011
|
+
* @enum
|
|
994
1012
|
*/
|
|
995
|
-
export declare
|
|
1013
|
+
export declare const RegionStatus: {
|
|
996
1014
|
/**
|
|
997
1015
|
* All operations have completed successfully and the region is ready to use
|
|
998
1016
|
*/
|
|
999
|
-
ACTIVE
|
|
1017
|
+
readonly ACTIVE: "ACTIVE";
|
|
1000
1018
|
/**
|
|
1001
1019
|
* The region is in the process of being created.
|
|
1002
1020
|
*/
|
|
1003
|
-
CREATING
|
|
1021
|
+
readonly CREATING: "CREATING";
|
|
1004
1022
|
/**
|
|
1005
1023
|
* The region is in the process of being deleted.
|
|
1006
1024
|
*/
|
|
1007
|
-
DELETING
|
|
1025
|
+
readonly DELETING: "DELETING";
|
|
1008
1026
|
/**
|
|
1009
1027
|
* The region is not healthy and we cannot automatically fix it.
|
|
1010
1028
|
*/
|
|
1011
|
-
FAILED
|
|
1012
|
-
}
|
|
1029
|
+
readonly FAILED: "FAILED";
|
|
1030
|
+
};
|
|
1031
|
+
/**
|
|
1032
|
+
* @public
|
|
1033
|
+
*/
|
|
1034
|
+
export type RegionStatus = (typeof RegionStatus)[keyof typeof RegionStatus];
|
|
1013
1035
|
/**
|
|
1014
1036
|
* @public
|
|
1015
1037
|
* <p>Information about a Amazon Web Services Region in your replication set.</p>
|
|
@@ -1034,33 +1056,38 @@ export interface RegionInfo {
|
|
|
1034
1056
|
}
|
|
1035
1057
|
/**
|
|
1036
1058
|
* @public
|
|
1059
|
+
* @enum
|
|
1037
1060
|
*/
|
|
1038
|
-
export declare
|
|
1061
|
+
export declare const ReplicationSetStatus: {
|
|
1039
1062
|
/**
|
|
1040
1063
|
* All operations have completed successfully and the replication set is ready to use
|
|
1041
1064
|
*/
|
|
1042
|
-
ACTIVE
|
|
1065
|
+
readonly ACTIVE: "ACTIVE";
|
|
1043
1066
|
/**
|
|
1044
1067
|
* Replication set is in the process of being created.
|
|
1045
1068
|
*/
|
|
1046
|
-
CREATING
|
|
1069
|
+
readonly CREATING: "CREATING";
|
|
1047
1070
|
/**
|
|
1048
1071
|
* Replication set is in the process of being deleted.
|
|
1049
1072
|
*/
|
|
1050
|
-
DELETING
|
|
1073
|
+
readonly DELETING: "DELETING";
|
|
1051
1074
|
/**
|
|
1052
1075
|
* Replication set is not healthy and we cannot fix it.
|
|
1053
1076
|
*/
|
|
1054
|
-
FAILED
|
|
1077
|
+
readonly FAILED: "FAILED";
|
|
1055
1078
|
/**
|
|
1056
1079
|
* Replication set is in the process of being updated.
|
|
1057
1080
|
*/
|
|
1058
|
-
UPDATING
|
|
1059
|
-
}
|
|
1081
|
+
readonly UPDATING: "UPDATING";
|
|
1082
|
+
};
|
|
1083
|
+
/**
|
|
1084
|
+
* @public
|
|
1085
|
+
*/
|
|
1086
|
+
export type ReplicationSetStatus = (typeof ReplicationSetStatus)[keyof typeof ReplicationSetStatus];
|
|
1060
1087
|
/**
|
|
1061
1088
|
* @public
|
|
1062
|
-
* <p>The set of Amazon Web Services Region that your Incident Manager data will be replicated to
|
|
1063
|
-
*
|
|
1089
|
+
* <p>The set of Amazon Web Services Region that your Incident Manager data will be replicated to and
|
|
1090
|
+
* the KMS key used to encrypt the data. </p>
|
|
1064
1091
|
*/
|
|
1065
1092
|
export interface ReplicationSet {
|
|
1066
1093
|
/**
|
|
@@ -1072,14 +1099,14 @@ export interface ReplicationSet {
|
|
|
1072
1099
|
*/
|
|
1073
1100
|
regionMap: Record<string, RegionInfo> | undefined;
|
|
1074
1101
|
/**
|
|
1075
|
-
* <p>The status of the replication set. If the replication set is still pending, you can't
|
|
1076
|
-
*
|
|
1102
|
+
* <p>The status of the replication set. If the replication set is still pending, you can't use
|
|
1103
|
+
* Incident Manager functionality.</p>
|
|
1077
1104
|
*/
|
|
1078
1105
|
status: ReplicationSetStatus | string | undefined;
|
|
1079
1106
|
/**
|
|
1080
1107
|
* <p>Determines if the replication set deletion protection is enabled or not. If deletion
|
|
1081
|
-
*
|
|
1082
|
-
*
|
|
1108
|
+
* protection is enabled, you can't delete the last Amazon Web Services Region in the replication
|
|
1109
|
+
* set. </p>
|
|
1083
1110
|
*/
|
|
1084
1111
|
deletionProtected: boolean | undefined;
|
|
1085
1112
|
/**
|
|
@@ -1114,7 +1141,7 @@ export interface GetReplicationSetOutput {
|
|
|
1114
1141
|
export interface GetResourcePoliciesInput {
|
|
1115
1142
|
/**
|
|
1116
1143
|
* <p>The Amazon Resource Name (ARN) of the response plan with the attached resource policy.
|
|
1117
|
-
*
|
|
1144
|
+
* </p>
|
|
1118
1145
|
*/
|
|
1119
1146
|
resourceArn: string | undefined;
|
|
1120
1147
|
/**
|
|
@@ -1129,7 +1156,7 @@ export interface GetResourcePoliciesInput {
|
|
|
1129
1156
|
/**
|
|
1130
1157
|
* @public
|
|
1131
1158
|
* <p>The resource policy that allows Incident Manager to perform actions on resources on your
|
|
1132
|
-
*
|
|
1159
|
+
* behalf.</p>
|
|
1133
1160
|
*/
|
|
1134
1161
|
export interface ResourcePolicy {
|
|
1135
1162
|
/**
|
|
@@ -1188,13 +1215,12 @@ export interface GetResponsePlanOutput {
|
|
|
1188
1215
|
*/
|
|
1189
1216
|
incidentTemplate: IncidentTemplate | undefined;
|
|
1190
1217
|
/**
|
|
1191
|
-
* <p>The Chatbot chat channel used for collaboration during an
|
|
1192
|
-
* incident.</p>
|
|
1218
|
+
* <p>The Chatbot chat channel used for collaboration during an incident.</p>
|
|
1193
1219
|
*/
|
|
1194
1220
|
chatChannel?: ChatChannel;
|
|
1195
1221
|
/**
|
|
1196
1222
|
* <p>The Amazon Resource Name (ARN) for the contacts and escalation plans that the response
|
|
1197
|
-
*
|
|
1223
|
+
* plan engages during an incident.</p>
|
|
1198
1224
|
*/
|
|
1199
1225
|
engagements?: string[];
|
|
1200
1226
|
/**
|
|
@@ -1203,7 +1229,7 @@ export interface GetResponsePlanOutput {
|
|
|
1203
1229
|
actions?: Action[];
|
|
1204
1230
|
/**
|
|
1205
1231
|
* <p>Information about third-party services integrated into the Incident Manager response
|
|
1206
|
-
*
|
|
1232
|
+
* plan.</p>
|
|
1207
1233
|
*/
|
|
1208
1234
|
integrations?: Integration[];
|
|
1209
1235
|
}
|
|
@@ -1212,13 +1238,12 @@ export interface GetResponsePlanOutput {
|
|
|
1212
1238
|
*/
|
|
1213
1239
|
export interface GetTimelineEventInput {
|
|
1214
1240
|
/**
|
|
1215
|
-
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline
|
|
1216
|
-
* event.</p>
|
|
1241
|
+
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
|
|
1217
1242
|
*/
|
|
1218
1243
|
incidentRecordArn: string | undefined;
|
|
1219
1244
|
/**
|
|
1220
1245
|
* <p>The ID of the event. You can get an event's ID when you create it, or by using
|
|
1221
|
-
*
|
|
1246
|
+
* <code>ListTimelineEvents</code>.</p>
|
|
1222
1247
|
*/
|
|
1223
1248
|
eventId: string | undefined;
|
|
1224
1249
|
}
|
|
@@ -1245,7 +1270,7 @@ export interface TimelineEvent {
|
|
|
1245
1270
|
eventUpdatedTime: Date | undefined;
|
|
1246
1271
|
/**
|
|
1247
1272
|
* <p>The type of event that occurred. Currently Incident Manager supports only the <code>Custom
|
|
1248
|
-
*
|
|
1273
|
+
* Event</code> type.</p>
|
|
1249
1274
|
*/
|
|
1250
1275
|
eventType: string | undefined;
|
|
1251
1276
|
/**
|
|
@@ -1277,7 +1302,7 @@ export interface IncidentRecordSummary {
|
|
|
1277
1302
|
arn: string | undefined;
|
|
1278
1303
|
/**
|
|
1279
1304
|
* <p>The title of the incident. This value is either provided by the response plan or
|
|
1280
|
-
*
|
|
1305
|
+
* overwritten on creation.</p>
|
|
1281
1306
|
*/
|
|
1282
1307
|
title: string | undefined;
|
|
1283
1308
|
/**
|
|
@@ -1303,37 +1328,41 @@ export interface IncidentRecordSummary {
|
|
|
1303
1328
|
}
|
|
1304
1329
|
/**
|
|
1305
1330
|
* @public
|
|
1331
|
+
* @enum
|
|
1306
1332
|
*/
|
|
1307
|
-
export declare
|
|
1308
|
-
ANALYSIS
|
|
1309
|
-
ATTACHMENT
|
|
1310
|
-
AUTOMATION
|
|
1311
|
-
INCIDENT
|
|
1312
|
-
INVOLVED_RESOURCE
|
|
1313
|
-
METRIC
|
|
1314
|
-
OTHER
|
|
1315
|
-
PARENT
|
|
1316
|
-
TASK
|
|
1317
|
-
}
|
|
1333
|
+
export declare const ItemType: {
|
|
1334
|
+
readonly ANALYSIS: "ANALYSIS";
|
|
1335
|
+
readonly ATTACHMENT: "ATTACHMENT";
|
|
1336
|
+
readonly AUTOMATION: "AUTOMATION";
|
|
1337
|
+
readonly INCIDENT: "INCIDENT";
|
|
1338
|
+
readonly INVOLVED_RESOURCE: "INVOLVED_RESOURCE";
|
|
1339
|
+
readonly METRIC: "METRIC";
|
|
1340
|
+
readonly OTHER: "OTHER";
|
|
1341
|
+
readonly PARENT: "PARENT";
|
|
1342
|
+
readonly TASK: "TASK";
|
|
1343
|
+
};
|
|
1344
|
+
/**
|
|
1345
|
+
* @public
|
|
1346
|
+
*/
|
|
1347
|
+
export type ItemType = (typeof ItemType)[keyof typeof ItemType];
|
|
1318
1348
|
/**
|
|
1319
1349
|
* @public
|
|
1320
|
-
* <p>Details about the PagerDuty incident associated with an incident created by an
|
|
1321
|
-
*
|
|
1350
|
+
* <p>Details about the PagerDuty incident associated with an incident created by an Incident Manager
|
|
1351
|
+
* response plan.</p>
|
|
1322
1352
|
*/
|
|
1323
1353
|
export interface PagerDutyIncidentDetail {
|
|
1324
1354
|
/**
|
|
1325
|
-
* <p>The ID of the incident associated with the PagerDuty service for the response
|
|
1326
|
-
* plan.</p>
|
|
1355
|
+
* <p>The ID of the incident associated with the PagerDuty service for the response plan.</p>
|
|
1327
1356
|
*/
|
|
1328
1357
|
id: string | undefined;
|
|
1329
1358
|
/**
|
|
1330
1359
|
* <p>Indicates whether to resolve the PagerDuty incident when you resolve the associated
|
|
1331
|
-
*
|
|
1360
|
+
* Incident Manager incident.</p>
|
|
1332
1361
|
*/
|
|
1333
1362
|
autoResolve?: boolean;
|
|
1334
1363
|
/**
|
|
1335
1364
|
* <p>The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or
|
|
1336
|
-
*
|
|
1365
|
+
* User Token REST API Key, and other user credentials.</p>
|
|
1337
1366
|
*/
|
|
1338
1367
|
secretId?: string;
|
|
1339
1368
|
}
|
|
@@ -1348,7 +1377,7 @@ export type ItemValue = ItemValue.ArnMember | ItemValue.MetricDefinitionMember |
|
|
|
1348
1377
|
export declare namespace ItemValue {
|
|
1349
1378
|
/**
|
|
1350
1379
|
* <p>The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon
|
|
1351
|
-
*
|
|
1380
|
+
* resource.</p>
|
|
1352
1381
|
*/
|
|
1353
1382
|
interface ArnMember {
|
|
1354
1383
|
arn: string;
|
|
@@ -1422,43 +1451,42 @@ export interface ItemIdentifier {
|
|
|
1422
1451
|
*/
|
|
1423
1452
|
export interface ListIncidentRecordsInput {
|
|
1424
1453
|
/**
|
|
1425
|
-
* <p>Filters the list of incident records
|
|
1426
|
-
*
|
|
1427
|
-
*
|
|
1454
|
+
* <p>Filters the list of incident records you want to search through. You can filter on the
|
|
1455
|
+
* following keys:</p>
|
|
1456
|
+
* <ul>
|
|
1428
1457
|
* <li>
|
|
1429
|
-
*
|
|
1458
|
+
* <p>
|
|
1430
1459
|
* <code>creationTime</code>
|
|
1431
1460
|
* </p>
|
|
1432
1461
|
* </li>
|
|
1433
1462
|
* <li>
|
|
1434
|
-
*
|
|
1463
|
+
* <p>
|
|
1435
1464
|
* <code>impact</code>
|
|
1436
1465
|
* </p>
|
|
1437
1466
|
* </li>
|
|
1438
1467
|
* <li>
|
|
1439
|
-
*
|
|
1468
|
+
* <p>
|
|
1440
1469
|
* <code>status</code>
|
|
1441
1470
|
* </p>
|
|
1442
1471
|
* </li>
|
|
1443
1472
|
* <li>
|
|
1444
|
-
*
|
|
1473
|
+
* <p>
|
|
1445
1474
|
* <code>createdBy</code>
|
|
1446
1475
|
* </p>
|
|
1447
1476
|
* </li>
|
|
1448
1477
|
* </ul>
|
|
1449
|
-
*
|
|
1450
|
-
*
|
|
1478
|
+
* <p>Note the following when when you use Filters:</p>
|
|
1479
|
+
* <ul>
|
|
1451
1480
|
* <li>
|
|
1452
|
-
*
|
|
1453
|
-
* records.</p>
|
|
1481
|
+
* <p>If you don't specify a Filter, the response includes all incident records.</p>
|
|
1454
1482
|
* </li>
|
|
1455
1483
|
* <li>
|
|
1456
|
-
*
|
|
1457
|
-
*
|
|
1484
|
+
* <p>If you specify more than one filter in a single request, the response returns incident
|
|
1485
|
+
* records that match all filters.</p>
|
|
1458
1486
|
* </li>
|
|
1459
1487
|
* <li>
|
|
1460
|
-
*
|
|
1461
|
-
*
|
|
1488
|
+
* <p>If you specify a filter with more than one value, the response returns incident
|
|
1489
|
+
* records that match any of the values provided.</p>
|
|
1462
1490
|
* </li>
|
|
1463
1491
|
* </ul>
|
|
1464
1492
|
*/
|
|
@@ -1491,7 +1519,7 @@ export interface ListIncidentRecordsOutput {
|
|
|
1491
1519
|
export interface ListRelatedItemsInput {
|
|
1492
1520
|
/**
|
|
1493
1521
|
* <p>The Amazon Resource Name (ARN) of the incident record containing the listed related
|
|
1494
|
-
*
|
|
1522
|
+
* items.</p>
|
|
1495
1523
|
*/
|
|
1496
1524
|
incidentRecordArn: string | undefined;
|
|
1497
1525
|
/**
|
|
@@ -1519,8 +1547,7 @@ export interface RelatedItem {
|
|
|
1519
1547
|
/**
|
|
1520
1548
|
* <p>A unique ID for a <code>RelatedItem</code>.</p>
|
|
1521
1549
|
* <important>
|
|
1522
|
-
* <p>Don't specify this parameter when you add a <code>RelatedItem</code> by using the
|
|
1523
|
-
* <a>UpdateRelatedItems</a> API action.</p>
|
|
1550
|
+
* <p>Don't specify this parameter when you add a <code>RelatedItem</code> by using the <a>UpdateRelatedItems</a> API action.</p>
|
|
1524
1551
|
* </important>
|
|
1525
1552
|
*/
|
|
1526
1553
|
generatedId?: string;
|
|
@@ -1628,65 +1655,73 @@ export interface ListTagsForResourceResponse {
|
|
|
1628
1655
|
}
|
|
1629
1656
|
/**
|
|
1630
1657
|
* @public
|
|
1658
|
+
* @enum
|
|
1631
1659
|
*/
|
|
1632
|
-
export declare
|
|
1633
|
-
EVENT_TIME
|
|
1634
|
-
}
|
|
1660
|
+
export declare const TimelineEventSort: {
|
|
1661
|
+
readonly EVENT_TIME: "EVENT_TIME";
|
|
1662
|
+
};
|
|
1635
1663
|
/**
|
|
1636
1664
|
* @public
|
|
1637
1665
|
*/
|
|
1638
|
-
export
|
|
1639
|
-
|
|
1640
|
-
|
|
1641
|
-
|
|
1666
|
+
export type TimelineEventSort = (typeof TimelineEventSort)[keyof typeof TimelineEventSort];
|
|
1667
|
+
/**
|
|
1668
|
+
* @public
|
|
1669
|
+
* @enum
|
|
1670
|
+
*/
|
|
1671
|
+
export declare const SortOrder: {
|
|
1672
|
+
readonly ASCENDING: "ASCENDING";
|
|
1673
|
+
readonly DESCENDING: "DESCENDING";
|
|
1674
|
+
};
|
|
1675
|
+
/**
|
|
1676
|
+
* @public
|
|
1677
|
+
*/
|
|
1678
|
+
export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
1642
1679
|
/**
|
|
1643
1680
|
* @public
|
|
1644
1681
|
*/
|
|
1645
1682
|
export interface ListTimelineEventsInput {
|
|
1646
1683
|
/**
|
|
1647
|
-
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline
|
|
1648
|
-
* event.</p>
|
|
1684
|
+
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
|
|
1649
1685
|
*/
|
|
1650
1686
|
incidentRecordArn: string | undefined;
|
|
1651
1687
|
/**
|
|
1652
1688
|
* <p>Filters the timeline events based on the provided conditional values. You can filter
|
|
1653
|
-
*
|
|
1654
|
-
*
|
|
1689
|
+
* timeline events with the following keys:</p>
|
|
1690
|
+
* <ul>
|
|
1655
1691
|
* <li>
|
|
1656
|
-
*
|
|
1692
|
+
* <p>
|
|
1657
1693
|
* <code>eventTime</code>
|
|
1658
1694
|
* </p>
|
|
1659
1695
|
* </li>
|
|
1660
1696
|
* <li>
|
|
1661
|
-
*
|
|
1697
|
+
* <p>
|
|
1662
1698
|
* <code>eventType</code>
|
|
1663
1699
|
* </p>
|
|
1664
1700
|
* </li>
|
|
1665
1701
|
* </ul>
|
|
1666
|
-
*
|
|
1667
|
-
*
|
|
1702
|
+
* <p>Note the following when deciding how to use Filters:</p>
|
|
1703
|
+
* <ul>
|
|
1668
1704
|
* <li>
|
|
1669
|
-
*
|
|
1670
|
-
* events.</p>
|
|
1705
|
+
* <p>If you don't specify a Filter, the response includes all timeline events.</p>
|
|
1671
1706
|
* </li>
|
|
1672
1707
|
* <li>
|
|
1673
|
-
*
|
|
1674
|
-
*
|
|
1708
|
+
* <p>If you specify more than one filter in a single request, the response returns timeline
|
|
1709
|
+
* events that match all filters.</p>
|
|
1675
1710
|
* </li>
|
|
1676
1711
|
* <li>
|
|
1677
|
-
*
|
|
1678
|
-
*
|
|
1712
|
+
* <p>If you specify a filter with more than one value, the response returns timeline events
|
|
1713
|
+
* that match any of the values provided.</p>
|
|
1679
1714
|
* </li>
|
|
1680
1715
|
* </ul>
|
|
1681
1716
|
*/
|
|
1682
1717
|
filters?: Filter[];
|
|
1683
1718
|
/**
|
|
1684
|
-
* <p>Sort by the specified key value pair.</p>
|
|
1719
|
+
* <p>Sort timeline events by the specified key value pair.</p>
|
|
1685
1720
|
*/
|
|
1686
1721
|
sortBy?: TimelineEventSort | string;
|
|
1687
1722
|
/**
|
|
1688
1723
|
* <p>Sorts the order of timeline events by the value specified in the <code>sortBy</code>
|
|
1689
|
-
*
|
|
1724
|
+
* field.</p>
|
|
1690
1725
|
*/
|
|
1691
1726
|
sortOrder?: SortOrder | string;
|
|
1692
1727
|
/**
|
|
@@ -1716,8 +1751,7 @@ export interface ListTimelineEventsOutput {
|
|
|
1716
1751
|
*/
|
|
1717
1752
|
export interface PutResourcePolicyInput {
|
|
1718
1753
|
/**
|
|
1719
|
-
* <p>The Amazon Resource Name (ARN) of the response plan to add the resource policy
|
|
1720
|
-
* to.</p>
|
|
1754
|
+
* <p>The Amazon Resource Name (ARN) of the response plan to add the resource policy to.</p>
|
|
1721
1755
|
*/
|
|
1722
1756
|
resourceArn: string | undefined;
|
|
1723
1757
|
/**
|
|
@@ -1777,9 +1811,9 @@ export declare namespace RelatedItemsUpdate {
|
|
|
1777
1811
|
*/
|
|
1778
1812
|
export interface TriggerDetails {
|
|
1779
1813
|
/**
|
|
1780
|
-
* <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
|
|
1781
|
-
*
|
|
1782
|
-
*
|
|
1814
|
+
* <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
|
+
* as long as it doesn't begin with "<code>aws.</code>" We recommend the use of Java package-name
|
|
1816
|
+
* style reverse domain-name strings. </p>
|
|
1783
1817
|
*/
|
|
1784
1818
|
source: string | undefined;
|
|
1785
1819
|
/**
|
|
@@ -1800,52 +1834,49 @@ export interface TriggerDetails {
|
|
|
1800
1834
|
*/
|
|
1801
1835
|
export interface StartIncidentInput {
|
|
1802
1836
|
/**
|
|
1803
|
-
* <p>A token ensuring that the operation is called only once with the specified
|
|
1804
|
-
* details.</p>
|
|
1837
|
+
* <p>A token ensuring that the operation is called only once with the specified details.</p>
|
|
1805
1838
|
*/
|
|
1806
1839
|
clientToken?: string;
|
|
1807
1840
|
/**
|
|
1808
1841
|
* <p>The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat
|
|
1809
|
-
*
|
|
1810
|
-
* </p>
|
|
1842
|
+
* channels, Amazon SNS topics, runbooks, title, and impact of the incident. </p>
|
|
1811
1843
|
*/
|
|
1812
1844
|
responsePlanArn: string | undefined;
|
|
1813
1845
|
/**
|
|
1814
|
-
* <p>Provide a title for the incident. Providing a title overwrites the title provided by
|
|
1815
|
-
*
|
|
1846
|
+
* <p>Provide a title for the incident. Providing a title overwrites the title provided by the
|
|
1847
|
+
* response plan. </p>
|
|
1816
1848
|
*/
|
|
1817
1849
|
title?: string;
|
|
1818
1850
|
/**
|
|
1819
|
-
* <p>Defines the impact to the customers. Providing an impact overwrites the impact
|
|
1820
|
-
*
|
|
1821
|
-
*
|
|
1851
|
+
* <p>Defines the impact to the customers. Providing an impact overwrites the impact provided by
|
|
1852
|
+
* a response plan.</p>
|
|
1853
|
+
* <p class="title">
|
|
1822
1854
|
* <b>Possible impacts:</b>
|
|
1823
1855
|
* </p>
|
|
1824
1856
|
* <ul>
|
|
1825
1857
|
* <li>
|
|
1826
|
-
*
|
|
1827
|
-
* <code>1</code> - Critical impact, this typically relates to full application
|
|
1828
|
-
*
|
|
1858
|
+
* <p>
|
|
1859
|
+
* <code>1</code> - Critical impact, this typically relates to full application failure
|
|
1860
|
+
* that impacts many to all customers. </p>
|
|
1829
1861
|
* </li>
|
|
1830
1862
|
* <li>
|
|
1831
|
-
*
|
|
1863
|
+
* <p>
|
|
1832
1864
|
* <code>2</code> - High impact, partial application failure with impact to many
|
|
1833
|
-
*
|
|
1865
|
+
* customers.</p>
|
|
1834
1866
|
* </li>
|
|
1835
1867
|
* <li>
|
|
1836
|
-
*
|
|
1837
|
-
* <code>3</code> - Medium impact, the application is providing reduced service
|
|
1838
|
-
*
|
|
1868
|
+
* <p>
|
|
1869
|
+
* <code>3</code> - Medium impact, the application is providing reduced service to
|
|
1870
|
+
* customers.</p>
|
|
1839
1871
|
* </li>
|
|
1840
1872
|
* <li>
|
|
1841
|
-
*
|
|
1842
|
-
* <code>4</code> - Low impact, customer might aren't impacted by the problem
|
|
1843
|
-
* yet.</p>
|
|
1873
|
+
* <p>
|
|
1874
|
+
* <code>4</code> - Low impact, customer might aren't impacted by the problem yet.</p>
|
|
1844
1875
|
* </li>
|
|
1845
1876
|
* <li>
|
|
1846
|
-
*
|
|
1847
|
-
* <code>5</code> - No impact, customers aren't currently impacted but urgent
|
|
1848
|
-
*
|
|
1877
|
+
* <p>
|
|
1878
|
+
* <code>5</code> - No impact, customers aren't currently impacted but urgent action is
|
|
1879
|
+
* needed to avoid impact.</p>
|
|
1849
1880
|
* </li>
|
|
1850
1881
|
* </ul>
|
|
1851
1882
|
*/
|
|
@@ -1855,8 +1886,8 @@ export interface StartIncidentInput {
|
|
|
1855
1886
|
*/
|
|
1856
1887
|
triggerDetails?: TriggerDetails;
|
|
1857
1888
|
/**
|
|
1858
|
-
* <p>Add related items to the incident for other responders to use. Related items are
|
|
1859
|
-
*
|
|
1889
|
+
* <p>Add related items to the incident for other responders to use. Related items are Amazon Web Services
|
|
1890
|
+
* resources, external links, or files uploaded to an Amazon S3 bucket. </p>
|
|
1860
1891
|
*/
|
|
1861
1892
|
relatedItems?: RelatedItem[];
|
|
1862
1893
|
}
|
|
@@ -1919,7 +1950,7 @@ export interface UpdateDeletionProtectionInput {
|
|
|
1919
1950
|
deletionProtected: boolean | undefined;
|
|
1920
1951
|
/**
|
|
1921
1952
|
* <p>A token that ensures that the operation is called only once with the specified
|
|
1922
|
-
*
|
|
1953
|
+
* details.</p>
|
|
1923
1954
|
*/
|
|
1924
1955
|
clientToken?: string;
|
|
1925
1956
|
}
|
|
@@ -1933,8 +1964,8 @@ export interface UpdateDeletionProtectionOutput {
|
|
|
1933
1964
|
*/
|
|
1934
1965
|
export interface UpdateIncidentRecordInput {
|
|
1935
1966
|
/**
|
|
1936
|
-
* <p>A token that ensures that the operation
|
|
1937
|
-
*
|
|
1967
|
+
* <p>A token that ensures that a client calls the operation only once with the specified
|
|
1968
|
+
* details.</p>
|
|
1938
1969
|
*/
|
|
1939
1970
|
clientToken?: string;
|
|
1940
1971
|
/**
|
|
@@ -1950,43 +1981,42 @@ export interface UpdateIncidentRecordInput {
|
|
|
1950
1981
|
*/
|
|
1951
1982
|
summary?: string;
|
|
1952
1983
|
/**
|
|
1953
|
-
* <p>Defines the impact of the incident to customers and applications.
|
|
1954
|
-
*
|
|
1955
|
-
*
|
|
1984
|
+
* <p>Defines the impact of the incident to customers and applications. If you provide an impact
|
|
1985
|
+
* for an incident, it overwrites the impact provided by the response plan.</p>
|
|
1986
|
+
* <p class="title">
|
|
1956
1987
|
* <b>Possible impacts:</b>
|
|
1957
1988
|
* </p>
|
|
1958
1989
|
* <ul>
|
|
1959
1990
|
* <li>
|
|
1960
|
-
*
|
|
1961
|
-
* <code>1</code> - Critical impact, full application failure that impacts many
|
|
1962
|
-
*
|
|
1991
|
+
* <p>
|
|
1992
|
+
* <code>1</code> - Critical impact, full application failure that impacts many to all
|
|
1993
|
+
* customers. </p>
|
|
1963
1994
|
* </li>
|
|
1964
1995
|
* <li>
|
|
1965
|
-
*
|
|
1996
|
+
* <p>
|
|
1966
1997
|
* <code>2</code> - High impact, partial application failure with impact to many
|
|
1967
|
-
*
|
|
1998
|
+
* customers.</p>
|
|
1968
1999
|
* </li>
|
|
1969
2000
|
* <li>
|
|
1970
|
-
*
|
|
1971
|
-
* <code>3</code> - Medium impact, the application is providing reduced service
|
|
1972
|
-
*
|
|
2001
|
+
* <p>
|
|
2002
|
+
* <code>3</code> - Medium impact, the application is providing reduced service to
|
|
2003
|
+
* customers.</p>
|
|
1973
2004
|
* </li>
|
|
1974
2005
|
* <li>
|
|
1975
|
-
*
|
|
1976
|
-
* <code>4</code> - Low impact, customer aren't impacted by the problem
|
|
1977
|
-
* yet.</p>
|
|
2006
|
+
* <p>
|
|
2007
|
+
* <code>4</code> - Low impact, customer aren't impacted by the problem yet.</p>
|
|
1978
2008
|
* </li>
|
|
1979
2009
|
* <li>
|
|
1980
|
-
*
|
|
1981
|
-
* <code>5</code> - No impact, customers aren't currently impacted but urgent
|
|
1982
|
-
*
|
|
2010
|
+
* <p>
|
|
2011
|
+
* <code>5</code> - No impact, customers aren't currently impacted but urgent action is
|
|
2012
|
+
* needed to avoid impact.</p>
|
|
1983
2013
|
* </li>
|
|
1984
2014
|
* </ul>
|
|
1985
2015
|
*/
|
|
1986
2016
|
impact?: number;
|
|
1987
2017
|
/**
|
|
1988
|
-
* <p>The status of the incident.
|
|
1989
|
-
*
|
|
2018
|
+
* <p>The status of the incident. Possible statuses are <code>Open</code> or
|
|
2019
|
+
* <code>Resolved</code>.</p>
|
|
1990
2020
|
*/
|
|
1991
2021
|
status?: IncidentRecordStatus | string;
|
|
1992
2022
|
/**
|
|
@@ -1994,10 +2024,10 @@ export interface UpdateIncidentRecordInput {
|
|
|
1994
2024
|
*/
|
|
1995
2025
|
chatChannel?: ChatChannel;
|
|
1996
2026
|
/**
|
|
1997
|
-
* <p>The Amazon SNS targets that
|
|
1998
|
-
*
|
|
1999
|
-
*
|
|
2000
|
-
*
|
|
2027
|
+
* <p>The Amazon SNS targets that Incident Manager notifies when a client updates an
|
|
2028
|
+
* incident.</p>
|
|
2029
|
+
* <p>Using multiple SNS topics creates redundancy in the event that a Region is down during the
|
|
2030
|
+
* incident.</p>
|
|
2001
2031
|
*/
|
|
2002
2032
|
notificationTargets?: NotificationTargetItem[];
|
|
2003
2033
|
}
|
|
@@ -2011,17 +2041,17 @@ export interface UpdateIncidentRecordOutput {
|
|
|
2011
2041
|
*/
|
|
2012
2042
|
export interface UpdateRelatedItemsInput {
|
|
2013
2043
|
/**
|
|
2014
|
-
* <p>A token
|
|
2015
|
-
*
|
|
2044
|
+
* <p>A token that ensures that a client calls the operation only once with the specified
|
|
2045
|
+
* details.</p>
|
|
2016
2046
|
*/
|
|
2017
2047
|
clientToken?: string;
|
|
2018
2048
|
/**
|
|
2019
|
-
* <p>The Amazon Resource Name (ARN) of the incident record
|
|
2020
|
-
*
|
|
2049
|
+
* <p>The Amazon Resource Name (ARN) of the incident record that contains the related items that
|
|
2050
|
+
* you update.</p>
|
|
2021
2051
|
*/
|
|
2022
2052
|
incidentRecordArn: string | undefined;
|
|
2023
2053
|
/**
|
|
2024
|
-
* <p>Details about the item you are
|
|
2054
|
+
* <p>Details about the item that you are add to, or delete from, an incident.</p>
|
|
2025
2055
|
*/
|
|
2026
2056
|
relatedItemsUpdate: RelatedItemsUpdate | undefined;
|
|
2027
2057
|
}
|
|
@@ -2041,7 +2071,7 @@ export type UpdateReplicationSetAction = UpdateReplicationSetAction.AddRegionAct
|
|
|
2041
2071
|
export declare namespace UpdateReplicationSetAction {
|
|
2042
2072
|
/**
|
|
2043
2073
|
* <p>Details about the Amazon Web Services Region that you're adding to the replication
|
|
2044
|
-
*
|
|
2074
|
+
* set.</p>
|
|
2045
2075
|
*/
|
|
2046
2076
|
interface AddRegionActionMember {
|
|
2047
2077
|
addRegionAction: AddRegionAction;
|
|
@@ -2050,7 +2080,7 @@ export declare namespace UpdateReplicationSetAction {
|
|
|
2050
2080
|
}
|
|
2051
2081
|
/**
|
|
2052
2082
|
* <p>Details about the Amazon Web Services Region that you're deleting to the replication
|
|
2053
|
-
*
|
|
2083
|
+
* set.</p>
|
|
2054
2084
|
*/
|
|
2055
2085
|
interface DeleteRegionActionMember {
|
|
2056
2086
|
addRegionAction?: never;
|
|
@@ -2083,7 +2113,7 @@ export interface UpdateReplicationSetInput {
|
|
|
2083
2113
|
actions: UpdateReplicationSetAction[] | undefined;
|
|
2084
2114
|
/**
|
|
2085
2115
|
* <p>A token that ensures that the operation is called only once with the specified
|
|
2086
|
-
*
|
|
2116
|
+
* details.</p>
|
|
2087
2117
|
*/
|
|
2088
2118
|
clientToken?: string;
|
|
2089
2119
|
}
|
|
@@ -2097,8 +2127,7 @@ export interface UpdateReplicationSetOutput {
|
|
|
2097
2127
|
*/
|
|
2098
2128
|
export interface UpdateResponsePlanInput {
|
|
2099
2129
|
/**
|
|
2100
|
-
* <p>A token ensuring that the operation is called only once with the specified
|
|
2101
|
-
* details.</p>
|
|
2130
|
+
* <p>A token ensuring that the operation is called only once with the specified details.</p>
|
|
2102
2131
|
*/
|
|
2103
2132
|
clientToken?: string;
|
|
2104
2133
|
/**
|
|
@@ -2106,8 +2135,7 @@ export interface UpdateResponsePlanInput {
|
|
|
2106
2135
|
*/
|
|
2107
2136
|
arn: string | undefined;
|
|
2108
2137
|
/**
|
|
2109
|
-
* <p>The long format name of the response plan. The display name can't contain
|
|
2110
|
-
* spaces.</p>
|
|
2138
|
+
* <p>The long format name of the response plan. The display name can't contain spaces.</p>
|
|
2111
2139
|
*/
|
|
2112
2140
|
displayName?: string;
|
|
2113
2141
|
/**
|
|
@@ -2115,30 +2143,30 @@ export interface UpdateResponsePlanInput {
|
|
|
2115
2143
|
*/
|
|
2116
2144
|
incidentTemplateTitle?: string;
|
|
2117
2145
|
/**
|
|
2118
|
-
* <p>Defines the impact to the customers. Providing an impact overwrites the impact
|
|
2119
|
-
*
|
|
2120
|
-
*
|
|
2146
|
+
* <p>Defines the impact to the customers. Providing an impact overwrites the impact provided by
|
|
2147
|
+
* a response plan.</p>
|
|
2148
|
+
* <p class="title">
|
|
2121
2149
|
* <b>Possible impacts:</b>
|
|
2122
2150
|
* </p>
|
|
2123
2151
|
* <ul>
|
|
2124
2152
|
* <li>
|
|
2125
|
-
*
|
|
2153
|
+
* <p>
|
|
2126
2154
|
* <code>5</code> - Severe impact</p>
|
|
2127
2155
|
* </li>
|
|
2128
2156
|
* <li>
|
|
2129
|
-
*
|
|
2157
|
+
* <p>
|
|
2130
2158
|
* <code>4</code> - High impact</p>
|
|
2131
2159
|
* </li>
|
|
2132
2160
|
* <li>
|
|
2133
|
-
*
|
|
2161
|
+
* <p>
|
|
2134
2162
|
* <code>3</code> - Medium impact</p>
|
|
2135
2163
|
* </li>
|
|
2136
2164
|
* <li>
|
|
2137
|
-
*
|
|
2165
|
+
* <p>
|
|
2138
2166
|
* <code>2</code> - Low impact</p>
|
|
2139
2167
|
* </li>
|
|
2140
2168
|
* <li>
|
|
2141
|
-
*
|
|
2169
|
+
* <p>
|
|
2142
2170
|
* <code>1</code> - No impact</p>
|
|
2143
2171
|
* </li>
|
|
2144
2172
|
* </ul>
|
|
@@ -2146,28 +2174,27 @@ export interface UpdateResponsePlanInput {
|
|
|
2146
2174
|
incidentTemplateImpact?: number;
|
|
2147
2175
|
/**
|
|
2148
2176
|
* <p>A brief summary of the incident. This typically contains what has happened, what's
|
|
2149
|
-
*
|
|
2177
|
+
* currently happening, and next steps.</p>
|
|
2150
2178
|
*/
|
|
2151
2179
|
incidentTemplateSummary?: string;
|
|
2152
2180
|
/**
|
|
2153
|
-
* <p>The string Incident Manager uses to prevent duplicate incidents from being created by the
|
|
2154
|
-
*
|
|
2181
|
+
* <p>The string Incident Manager uses to prevent duplicate incidents from being created by the same
|
|
2182
|
+
* incident in the same account.</p>
|
|
2155
2183
|
*/
|
|
2156
2184
|
incidentTemplateDedupeString?: string;
|
|
2157
2185
|
/**
|
|
2158
2186
|
* <p>The Amazon SNS targets that are notified when updates are made to an
|
|
2159
|
-
*
|
|
2187
|
+
* incident.</p>
|
|
2160
2188
|
*/
|
|
2161
2189
|
incidentTemplateNotificationTargets?: NotificationTargetItem[];
|
|
2162
2190
|
/**
|
|
2163
|
-
* <p>The Chatbot chat channel used for collaboration during an
|
|
2164
|
-
*
|
|
2165
|
-
* <p>Use the empty structure to remove the chat channel from the response plan.</p>
|
|
2191
|
+
* <p>The Chatbot chat channel used for collaboration during an incident.</p>
|
|
2192
|
+
* <p>Use the empty structure to remove the chat channel from the response plan.</p>
|
|
2166
2193
|
*/
|
|
2167
2194
|
chatChannel?: ChatChannel;
|
|
2168
2195
|
/**
|
|
2169
2196
|
* <p>The Amazon Resource Name (ARN) for the contacts and escalation plans that the response
|
|
2170
|
-
*
|
|
2197
|
+
* plan engages during an incident.</p>
|
|
2171
2198
|
*/
|
|
2172
2199
|
engagements?: string[];
|
|
2173
2200
|
/**
|
|
@@ -2175,10 +2202,10 @@ export interface UpdateResponsePlanInput {
|
|
|
2175
2202
|
*/
|
|
2176
2203
|
actions?: Action[];
|
|
2177
2204
|
/**
|
|
2178
|
-
* <p>Tags to assign to the template. When the <code>StartIncident</code> API action is
|
|
2179
|
-
*
|
|
2180
|
-
*
|
|
2181
|
-
*
|
|
2205
|
+
* <p>Tags to assign to the template. When the <code>StartIncident</code> API action is called,
|
|
2206
|
+
* Incident Manager assigns the tags specified in the template to the incident. To call this action,
|
|
2207
|
+
* you must also have permission to call the <code>TagResource</code> API action for the incident
|
|
2208
|
+
* record resource.</p>
|
|
2182
2209
|
*/
|
|
2183
2210
|
incidentTemplateTags?: Record<string, string>;
|
|
2184
2211
|
/**
|
|
@@ -2196,18 +2223,17 @@ export interface UpdateResponsePlanOutput {
|
|
|
2196
2223
|
*/
|
|
2197
2224
|
export interface UpdateTimelineEventInput {
|
|
2198
2225
|
/**
|
|
2199
|
-
* <p>A token
|
|
2200
|
-
*
|
|
2226
|
+
* <p>A token that ensures that a client calls the operation only once with the specified
|
|
2227
|
+
* details.</p>
|
|
2201
2228
|
*/
|
|
2202
2229
|
clientToken?: string;
|
|
2203
2230
|
/**
|
|
2204
|
-
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline
|
|
2205
|
-
* event.</p>
|
|
2231
|
+
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
|
|
2206
2232
|
*/
|
|
2207
2233
|
incidentRecordArn: string | undefined;
|
|
2208
2234
|
/**
|
|
2209
|
-
* <p>The ID of the event
|
|
2210
|
-
*
|
|
2235
|
+
* <p>The ID of the event to update. You can use <code>ListTimelineEvents</code> to find an
|
|
2236
|
+
* event's ID.</p>
|
|
2211
2237
|
*/
|
|
2212
2238
|
eventId: string | undefined;
|
|
2213
2239
|
/**
|
|
@@ -2215,7 +2241,7 @@ export interface UpdateTimelineEventInput {
|
|
|
2215
2241
|
*/
|
|
2216
2242
|
eventTime?: Date;
|
|
2217
2243
|
/**
|
|
2218
|
-
* <p>The type of
|
|
2244
|
+
* <p>The type of event. You can update events of type <code>Custom Event</code>.</p>
|
|
2219
2245
|
*/
|
|
2220
2246
|
eventType?: string;
|
|
2221
2247
|
/**
|
|
@@ -2223,18 +2249,16 @@ export interface UpdateTimelineEventInput {
|
|
|
2223
2249
|
*/
|
|
2224
2250
|
eventData?: string;
|
|
2225
2251
|
/**
|
|
2226
|
-
* <p>Updates all existing references in a <code>TimelineEvent</code>. A reference
|
|
2227
|
-
*
|
|
2228
|
-
*
|
|
2229
|
-
*
|
|
2230
|
-
*
|
|
2231
|
-
*
|
|
2232
|
-
* metric is the related item.</p>
|
|
2233
|
-
* <important>
|
|
2252
|
+
* <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
|
+
* its Amazon Resource Name (ARN). You can also specify a related item associated with that
|
|
2254
|
+
* resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a
|
|
2255
|
+
* resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with
|
|
2256
|
+
* the DynamoDB table as a related item.</p>
|
|
2257
|
+
* <important>
|
|
2234
2258
|
* <p>This update action overrides all existing references. If you want to keep existing
|
|
2235
|
-
*
|
|
2236
|
-
*
|
|
2237
|
-
*
|
|
2259
|
+
* references, you must specify them in the call. If you don't, this action removes any
|
|
2260
|
+
* existing references and enters only new references.</p>
|
|
2261
|
+
* </important>
|
|
2238
2262
|
*/
|
|
2239
2263
|
eventReferences?: EventReference[];
|
|
2240
2264
|
}
|