@aws-sdk/client-ssm-incidents 3.299.0 → 3.301.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-es/endpoint/ruleset.js +3 -3
- package/dist-types/SSMIncidents.d.ts +20 -22
- package/dist-types/commands/CreateReplicationSetCommand.d.ts +12 -1
- package/dist-types/commands/CreateResponsePlanCommand.d.ts +65 -3
- package/dist-types/commands/CreateTimelineEventCommand.d.ts +16 -3
- package/dist-types/commands/DeleteIncidentRecordCommand.d.ts +3 -0
- package/dist-types/commands/DeleteReplicationSetCommand.d.ts +4 -1
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +5 -1
- package/dist-types/commands/DeleteResponsePlanCommand.d.ts +5 -2
- package/dist-types/commands/DeleteTimelineEventCommand.d.ts +4 -0
- package/dist-types/commands/GetIncidentRecordCommand.d.ts +3 -0
- package/dist-types/commands/GetReplicationSetCommand.d.ts +3 -0
- package/dist-types/commands/GetResourcePoliciesCommand.d.ts +5 -0
- package/dist-types/commands/GetResponsePlanCommand.d.ts +3 -0
- package/dist-types/commands/GetTimelineEventCommand.d.ts +4 -0
- package/dist-types/commands/ListIncidentRecordsCommand.d.ts +22 -1
- package/dist-types/commands/ListRelatedItemsCommand.d.ts +5 -0
- package/dist-types/commands/ListReplicationSetsCommand.d.ts +4 -0
- package/dist-types/commands/ListResponsePlansCommand.d.ts +4 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -0
- package/dist-types/commands/ListTimelineEventsCommand.d.ts +24 -0
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +6 -3
- package/dist-types/commands/StartIncidentCommand.d.ts +32 -1
- package/dist-types/commands/TagResourceCommand.d.ts +6 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
- package/dist-types/commands/UpdateDeletionProtectionCommand.d.ts +6 -1
- package/dist-types/commands/UpdateIncidentRecordCommand.d.ts +22 -3
- package/dist-types/commands/UpdateRelatedItemsCommand.d.ts +36 -0
- package/dist-types/commands/UpdateReplicationSetCommand.d.ts +15 -0
- package/dist-types/commands/UpdateResponsePlanCommand.d.ts +57 -0
- package/dist-types/commands/UpdateTimelineEventCommand.d.ts +15 -2
- package/dist-types/models/models_0.d.ts +210 -236
- package/package.json +8 -8
|
@@ -30,7 +30,7 @@ export type DynamicSsmParameterValue = DynamicSsmParameterValue.VariableMember |
|
|
|
30
30
|
export declare namespace DynamicSsmParameterValue {
|
|
31
31
|
/**
|
|
32
32
|
* <p>Variable dynamic parameters. A parameter value is determined when an incident is
|
|
33
|
-
*
|
|
33
|
+
* created.</p>
|
|
34
34
|
*/
|
|
35
35
|
interface VariableMember {
|
|
36
36
|
variable: VariableType | string;
|
|
@@ -56,12 +56,12 @@ export declare enum SsmTargetAccount {
|
|
|
56
56
|
/**
|
|
57
57
|
* @public
|
|
58
58
|
* <p>Details about the Systems Manager automation document that will be used as a runbook
|
|
59
|
-
*
|
|
59
|
+
* during an incident.</p>
|
|
60
60
|
*/
|
|
61
61
|
export interface SsmAutomation {
|
|
62
62
|
/**
|
|
63
63
|
* <p>The Amazon Resource Name (ARN) of the role that the automation document will assume when
|
|
64
|
-
*
|
|
64
|
+
* running commands.</p>
|
|
65
65
|
*/
|
|
66
66
|
roleArn: string | undefined;
|
|
67
67
|
/**
|
|
@@ -74,7 +74,7 @@ export interface SsmAutomation {
|
|
|
74
74
|
documentVersion?: string;
|
|
75
75
|
/**
|
|
76
76
|
* <p>The account that the automation document will be run in. This can be in either the
|
|
77
|
-
*
|
|
77
|
+
* management account or an application account.</p>
|
|
78
78
|
*/
|
|
79
79
|
targetAccount?: SsmTargetAccount | string;
|
|
80
80
|
/**
|
|
@@ -82,15 +82,15 @@ export interface SsmAutomation {
|
|
|
82
82
|
*/
|
|
83
83
|
parameters?: Record<string, string[]>;
|
|
84
84
|
/**
|
|
85
|
-
* <p>The key-value pair to resolve dynamic parameter values when processing a Systems Manager
|
|
86
|
-
*
|
|
85
|
+
* <p>The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation
|
|
86
|
+
* runbook.</p>
|
|
87
87
|
*/
|
|
88
88
|
dynamicParameters?: Record<string, DynamicSsmParameterValue>;
|
|
89
89
|
}
|
|
90
90
|
/**
|
|
91
91
|
* @public
|
|
92
92
|
* <p>The action that starts at the beginning of an incident. The response plan defines the
|
|
93
|
-
*
|
|
93
|
+
* action.</p>
|
|
94
94
|
*/
|
|
95
95
|
export type Action = Action.SsmAutomationMember | Action.$UnknownMember;
|
|
96
96
|
/**
|
|
@@ -98,8 +98,8 @@ export type Action = Action.SsmAutomationMember | Action.$UnknownMember;
|
|
|
98
98
|
*/
|
|
99
99
|
export declare namespace Action {
|
|
100
100
|
/**
|
|
101
|
-
* <p>The Systems Manager automation document to start as the runbook at the beginning of
|
|
102
|
-
*
|
|
101
|
+
* <p>The Systems Manager automation document to start as the runbook at the beginning of the
|
|
102
|
+
* incident.</p>
|
|
103
103
|
*/
|
|
104
104
|
interface SsmAutomationMember {
|
|
105
105
|
ssmAutomation: SsmAutomation;
|
|
@@ -117,8 +117,8 @@ export declare namespace Action {
|
|
|
117
117
|
}
|
|
118
118
|
/**
|
|
119
119
|
* @public
|
|
120
|
-
* <p>Defines the Amazon Web Services Region and KMS key to add to the
|
|
121
|
-
*
|
|
120
|
+
* <p>Defines the Amazon Web Services Region and KMS key to add to the replication
|
|
121
|
+
* set. </p>
|
|
122
122
|
*/
|
|
123
123
|
export interface AddRegionAction {
|
|
124
124
|
/**
|
|
@@ -170,7 +170,7 @@ export declare namespace AttributeValueList {
|
|
|
170
170
|
/**
|
|
171
171
|
* @public
|
|
172
172
|
* <p>The Systems Manager automation document process to start as the runbook at the
|
|
173
|
-
*
|
|
173
|
+
* beginning of the incident.</p>
|
|
174
174
|
*/
|
|
175
175
|
export type AutomationExecution = AutomationExecution.SsmExecutionArnMember | AutomationExecution.$UnknownMember;
|
|
176
176
|
/**
|
|
@@ -202,8 +202,7 @@ export interface EmptyChatChannel {
|
|
|
202
202
|
}
|
|
203
203
|
/**
|
|
204
204
|
* @public
|
|
205
|
-
* <p>The Chatbot chat channel used for collaboration during an
|
|
206
|
-
* incident.</p>
|
|
205
|
+
* <p>The Chatbot chat channel used for collaboration during an incident.</p>
|
|
207
206
|
*/
|
|
208
207
|
export type ChatChannel = ChatChannel.ChatbotSnsMember | ChatChannel.EmptyMember | ChatChannel.$UnknownMember;
|
|
209
208
|
/**
|
|
@@ -219,9 +218,9 @@ export declare namespace ChatChannel {
|
|
|
219
218
|
$unknown?: never;
|
|
220
219
|
}
|
|
221
220
|
/**
|
|
222
|
-
* <p>The Amazon SNS targets that Chatbot uses to notify the chat channel
|
|
223
|
-
*
|
|
224
|
-
*
|
|
221
|
+
* <p>The Amazon SNS targets that Chatbot uses to notify the chat channel of
|
|
222
|
+
* updates to an incident. You can also make updates to the incident through the chat channel by
|
|
223
|
+
* using the Amazon SNS topics. </p>
|
|
225
224
|
*/
|
|
226
225
|
interface ChatbotSnsMember {
|
|
227
226
|
empty?: never;
|
|
@@ -243,9 +242,9 @@ export declare namespace ChatChannel {
|
|
|
243
242
|
/**
|
|
244
243
|
* @public
|
|
245
244
|
* <p>A conditional statement with which to compare a value, after a timestamp, before a
|
|
246
|
-
*
|
|
247
|
-
*
|
|
248
|
-
*
|
|
245
|
+
* timestamp, or equal to a string or integer. If multiple conditions are specified, the
|
|
246
|
+
* conditionals become an <code>AND</code>ed statement. If multiple values are specified for a
|
|
247
|
+
* conditional, the values are <code>OR</code>d.</p>
|
|
249
248
|
*/
|
|
250
249
|
export type Condition = Condition.AfterMember | Condition.BeforeMember | Condition.EqualsMember | Condition.$UnknownMember;
|
|
251
250
|
/**
|
|
@@ -330,7 +329,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
330
329
|
/**
|
|
331
330
|
* @public
|
|
332
331
|
* <p>The mapping between a Amazon Web Services Region and the key that's used to encrypt the
|
|
333
|
-
*
|
|
332
|
+
* data.</p>
|
|
334
333
|
*/
|
|
335
334
|
export interface RegionMapInputValue {
|
|
336
335
|
/**
|
|
@@ -343,13 +342,13 @@ export interface RegionMapInputValue {
|
|
|
343
342
|
*/
|
|
344
343
|
export interface CreateReplicationSetInput {
|
|
345
344
|
/**
|
|
346
|
-
* <p>The Regions that Incident Manager replicates your data to. You can have up to three Regions
|
|
347
|
-
*
|
|
345
|
+
* <p>The Regions that Incident Manager replicates your data to. You can have up to three Regions in
|
|
346
|
+
* your replication set.</p>
|
|
348
347
|
*/
|
|
349
348
|
regions: Record<string, RegionMapInputValue> | undefined;
|
|
350
349
|
/**
|
|
351
350
|
* <p>A token that ensures that the operation is called only once with the specified
|
|
352
|
-
*
|
|
351
|
+
* details.</p>
|
|
353
352
|
*/
|
|
354
353
|
clientToken?: string;
|
|
355
354
|
/**
|
|
@@ -475,7 +474,7 @@ export declare namespace NotificationTargetItem {
|
|
|
475
474
|
/**
|
|
476
475
|
* @public
|
|
477
476
|
* <p>Basic details used in creating a response plan. The response plan is then used to create
|
|
478
|
-
*
|
|
477
|
+
* an incident record.</p>
|
|
479
478
|
*/
|
|
480
479
|
export interface IncidentTemplate {
|
|
481
480
|
/**
|
|
@@ -488,34 +487,33 @@ export interface IncidentTemplate {
|
|
|
488
487
|
impact: number | undefined;
|
|
489
488
|
/**
|
|
490
489
|
* <p>The summary of the incident. The summary is a brief synopsis of what occurred, what's
|
|
491
|
-
*
|
|
490
|
+
* currently happening, and context.</p>
|
|
492
491
|
*/
|
|
493
492
|
summary?: string;
|
|
494
493
|
/**
|
|
495
494
|
* <p>Used to stop Incident Manager from creating multiple incident records for the same incident.
|
|
496
|
-
*
|
|
495
|
+
* </p>
|
|
497
496
|
*/
|
|
498
497
|
dedupeString?: string;
|
|
499
498
|
/**
|
|
500
499
|
* <p>The Amazon SNS targets that are notified when updates are made to an
|
|
501
|
-
*
|
|
500
|
+
* incident.</p>
|
|
502
501
|
*/
|
|
503
502
|
notificationTargets?: NotificationTargetItem[];
|
|
504
503
|
/**
|
|
505
|
-
* <p>Tags to assign to the template. When the <code>StartIncident</code> API action is
|
|
506
|
-
*
|
|
504
|
+
* <p>Tags to assign to the template. When the <code>StartIncident</code> API action is called,
|
|
505
|
+
* Incident Manager assigns the tags specified in the template to the incident.</p>
|
|
507
506
|
*/
|
|
508
507
|
incidentTags?: Record<string, string>;
|
|
509
508
|
}
|
|
510
509
|
/**
|
|
511
510
|
* @public
|
|
512
|
-
* <p>Details about the PagerDuty service where the response plan creates an
|
|
513
|
-
* incident.</p>
|
|
511
|
+
* <p>Details about the PagerDuty service where the response plan creates an incident.</p>
|
|
514
512
|
*/
|
|
515
513
|
export interface PagerDutyIncidentConfiguration {
|
|
516
514
|
/**
|
|
517
|
-
* <p>The ID of the PagerDuty service that the response plan associates with an incident
|
|
518
|
-
*
|
|
515
|
+
* <p>The ID of the PagerDuty service that the response plan associates with an incident when it
|
|
516
|
+
* launches.</p>
|
|
519
517
|
*/
|
|
520
518
|
serviceId: string | undefined;
|
|
521
519
|
}
|
|
@@ -530,7 +528,7 @@ export interface PagerDutyConfiguration {
|
|
|
530
528
|
name: string | undefined;
|
|
531
529
|
/**
|
|
532
530
|
* <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
|
-
*
|
|
531
|
+
* User Token REST API Key, and other user credentials.</p>
|
|
534
532
|
*/
|
|
535
533
|
secretId: string | undefined;
|
|
536
534
|
/**
|
|
@@ -549,7 +547,7 @@ export type Integration = Integration.PagerDutyConfigurationMember | Integration
|
|
|
549
547
|
export declare namespace Integration {
|
|
550
548
|
/**
|
|
551
549
|
* <p>Information about the PagerDuty service where the response plan creates an
|
|
552
|
-
*
|
|
550
|
+
* incident.</p>
|
|
553
551
|
*/
|
|
554
552
|
interface PagerDutyConfigurationMember {
|
|
555
553
|
pagerDutyConfiguration: PagerDutyConfiguration;
|
|
@@ -570,8 +568,7 @@ export declare namespace Integration {
|
|
|
570
568
|
*/
|
|
571
569
|
export interface CreateResponsePlanInput {
|
|
572
570
|
/**
|
|
573
|
-
* <p>A token ensuring that the operation is called only once with the specified
|
|
574
|
-
* details.</p>
|
|
571
|
+
* <p>A token ensuring that the operation is called only once with the specified details.</p>
|
|
575
572
|
*/
|
|
576
573
|
clientToken?: string;
|
|
577
574
|
/**
|
|
@@ -587,13 +584,12 @@ export interface CreateResponsePlanInput {
|
|
|
587
584
|
*/
|
|
588
585
|
incidentTemplate: IncidentTemplate | undefined;
|
|
589
586
|
/**
|
|
590
|
-
* <p>The Chatbot chat channel used for collaboration during an
|
|
591
|
-
* incident.</p>
|
|
587
|
+
* <p>The Chatbot chat channel used for collaboration during an incident.</p>
|
|
592
588
|
*/
|
|
593
589
|
chatChannel?: ChatChannel;
|
|
594
590
|
/**
|
|
595
591
|
* <p>The Amazon Resource Name (ARN) for the contacts and escalation plans that the response
|
|
596
|
-
*
|
|
592
|
+
* plan engages during an incident.</p>
|
|
597
593
|
*/
|
|
598
594
|
engagements?: string[];
|
|
599
595
|
/**
|
|
@@ -641,7 +637,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
641
637
|
/**
|
|
642
638
|
* @public
|
|
643
639
|
* <p>An item referenced in a <code>TimelineEvent</code> that is involved in or somehow
|
|
644
|
-
*
|
|
640
|
+
* 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
641
|
*/
|
|
646
642
|
export type EventReference = EventReference.RelatedItemIdMember | EventReference.ResourceMember | EventReference.$UnknownMember;
|
|
647
643
|
/**
|
|
@@ -650,7 +646,7 @@ export type EventReference = EventReference.RelatedItemIdMember | EventReference
|
|
|
650
646
|
export declare namespace EventReference {
|
|
651
647
|
/**
|
|
652
648
|
* <p>The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a
|
|
653
|
-
*
|
|
649
|
+
* <code>TimelineEvent</code>.</p>
|
|
654
650
|
*/
|
|
655
651
|
interface ResourceMember {
|
|
656
652
|
resource: string;
|
|
@@ -682,13 +678,13 @@ export declare namespace EventReference {
|
|
|
682
678
|
*/
|
|
683
679
|
export interface CreateTimelineEventInput {
|
|
684
680
|
/**
|
|
685
|
-
* <p>A token
|
|
686
|
-
*
|
|
681
|
+
* <p>A token that ensures that a client calls the action only once with the specified
|
|
682
|
+
* details.</p>
|
|
687
683
|
*/
|
|
688
684
|
clientToken?: string;
|
|
689
685
|
/**
|
|
690
|
-
* <p>The Amazon Resource Name (ARN) of the incident record
|
|
691
|
-
*
|
|
686
|
+
* <p>The Amazon Resource Name (ARN) of the incident record that the action adds the incident
|
|
687
|
+
* to.</p>
|
|
692
688
|
*/
|
|
693
689
|
incidentRecordArn: string | undefined;
|
|
694
690
|
/**
|
|
@@ -696,8 +692,8 @@ export interface CreateTimelineEventInput {
|
|
|
696
692
|
*/
|
|
697
693
|
eventTime: Date | undefined;
|
|
698
694
|
/**
|
|
699
|
-
* <p>The type of
|
|
700
|
-
*
|
|
695
|
+
* <p>The type of event. You can create timeline events of type <code>Custom
|
|
696
|
+
* Event</code>.</p>
|
|
701
697
|
*/
|
|
702
698
|
eventType: string | undefined;
|
|
703
699
|
/**
|
|
@@ -705,13 +701,11 @@ export interface CreateTimelineEventInput {
|
|
|
705
701
|
*/
|
|
706
702
|
eventData: string | undefined;
|
|
707
703
|
/**
|
|
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>
|
|
704
|
+
* <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
|
|
705
|
+
* its Amazon Resource Name (ARN). You can also specify a related item associated with a
|
|
706
|
+
* resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a
|
|
707
|
+
* resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated
|
|
708
|
+
* with the DynamoDB table as a related item.</p>
|
|
715
709
|
*/
|
|
716
710
|
eventReferences?: EventReference[];
|
|
717
711
|
}
|
|
@@ -745,12 +739,11 @@ export interface DeleteIncidentRecordOutput {
|
|
|
745
739
|
/**
|
|
746
740
|
* @public
|
|
747
741
|
* <p>Defines the information about the Amazon Web Services Region you're deleting from your
|
|
748
|
-
*
|
|
742
|
+
* replication set.</p>
|
|
749
743
|
*/
|
|
750
744
|
export interface DeleteRegionAction {
|
|
751
745
|
/**
|
|
752
|
-
* <p>The name of the Amazon Web Services Region you're deleting from the replication
|
|
753
|
-
* set.</p>
|
|
746
|
+
* <p>The name of the Amazon Web Services Region you're deleting from the replication set.</p>
|
|
754
747
|
*/
|
|
755
748
|
regionName: string | undefined;
|
|
756
749
|
}
|
|
@@ -805,13 +798,12 @@ export interface DeleteResponsePlanOutput {
|
|
|
805
798
|
*/
|
|
806
799
|
export interface DeleteTimelineEventInput {
|
|
807
800
|
/**
|
|
808
|
-
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline
|
|
809
|
-
* event.</p>
|
|
801
|
+
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
|
|
810
802
|
*/
|
|
811
803
|
incidentRecordArn: string | undefined;
|
|
812
804
|
/**
|
|
813
|
-
* <p>The ID of the event
|
|
814
|
-
*
|
|
805
|
+
* <p>The ID of the event to update. You can use <code>ListTimelineEvents</code> to find an
|
|
806
|
+
* event's ID.</p>
|
|
815
807
|
*/
|
|
816
808
|
eventId: string | undefined;
|
|
817
809
|
}
|
|
@@ -860,8 +852,8 @@ export interface Filter {
|
|
|
860
852
|
*/
|
|
861
853
|
key: string | undefined;
|
|
862
854
|
/**
|
|
863
|
-
* <p>The condition accepts before or after a specified time, equal to a string, or equal to
|
|
864
|
-
*
|
|
855
|
+
* <p>The condition accepts before or after a specified time, equal to a string, or equal to an
|
|
856
|
+
* integer.</p>
|
|
865
857
|
*/
|
|
866
858
|
condition: Condition | undefined;
|
|
867
859
|
}
|
|
@@ -885,7 +877,7 @@ export interface IncidentRecordSource {
|
|
|
885
877
|
createdBy: string | undefined;
|
|
886
878
|
/**
|
|
887
879
|
* <p>The service principal that assumed the role specified in <code>createdBy</code>. If no
|
|
888
|
-
*
|
|
880
|
+
* service principal assumed the role this will be left blank.</p>
|
|
889
881
|
*/
|
|
890
882
|
invokedBy?: string;
|
|
891
883
|
/**
|
|
@@ -894,8 +886,8 @@ export interface IncidentRecordSource {
|
|
|
894
886
|
resourceArn?: string;
|
|
895
887
|
/**
|
|
896
888
|
* <p>The service that started the incident. This can be manually created from Incident Manager,
|
|
897
|
-
*
|
|
898
|
-
*
|
|
889
|
+
* automatically created using an Amazon CloudWatch alarm, or Amazon EventBridge
|
|
890
|
+
* event.</p>
|
|
899
891
|
*/
|
|
900
892
|
source: string | undefined;
|
|
901
893
|
}
|
|
@@ -921,7 +913,7 @@ export interface IncidentRecord {
|
|
|
921
913
|
title: string | undefined;
|
|
922
914
|
/**
|
|
923
915
|
* <p>The summary of the incident. The summary is a brief synopsis of what occurred, what's
|
|
924
|
-
*
|
|
916
|
+
* currently happening, and context of the incident.</p>
|
|
925
917
|
*/
|
|
926
918
|
summary?: string;
|
|
927
919
|
/**
|
|
@@ -957,8 +949,8 @@ export interface IncidentRecord {
|
|
|
957
949
|
*/
|
|
958
950
|
incidentRecordSource: IncidentRecordSource | undefined;
|
|
959
951
|
/**
|
|
960
|
-
* <p>The string Incident Manager uses to prevent duplicate incidents from being created by the
|
|
961
|
-
*
|
|
952
|
+
* <p>The string Incident Manager uses to prevent duplicate incidents from being created by the same
|
|
953
|
+
* incident in the same account.</p>
|
|
962
954
|
*/
|
|
963
955
|
dedupeString: string | undefined;
|
|
964
956
|
/**
|
|
@@ -967,7 +959,7 @@ export interface IncidentRecord {
|
|
|
967
959
|
chatChannel?: ChatChannel;
|
|
968
960
|
/**
|
|
969
961
|
* <p>The Amazon SNS targets that are notified when updates are made to an
|
|
970
|
-
*
|
|
962
|
+
* incident.</p>
|
|
971
963
|
*/
|
|
972
964
|
notificationTargets?: NotificationTargetItem[];
|
|
973
965
|
}
|
|
@@ -1059,8 +1051,8 @@ export declare enum ReplicationSetStatus {
|
|
|
1059
1051
|
}
|
|
1060
1052
|
/**
|
|
1061
1053
|
* @public
|
|
1062
|
-
* <p>The set of Amazon Web Services Region that your Incident Manager data will be replicated to
|
|
1063
|
-
*
|
|
1054
|
+
* <p>The set of Amazon Web Services Region that your Incident Manager data will be replicated to and
|
|
1055
|
+
* the KMS key used to encrypt the data. </p>
|
|
1064
1056
|
*/
|
|
1065
1057
|
export interface ReplicationSet {
|
|
1066
1058
|
/**
|
|
@@ -1072,14 +1064,14 @@ export interface ReplicationSet {
|
|
|
1072
1064
|
*/
|
|
1073
1065
|
regionMap: Record<string, RegionInfo> | undefined;
|
|
1074
1066
|
/**
|
|
1075
|
-
* <p>The status of the replication set. If the replication set is still pending, you can't
|
|
1076
|
-
*
|
|
1067
|
+
* <p>The status of the replication set. If the replication set is still pending, you can't use
|
|
1068
|
+
* Incident Manager functionality.</p>
|
|
1077
1069
|
*/
|
|
1078
1070
|
status: ReplicationSetStatus | string | undefined;
|
|
1079
1071
|
/**
|
|
1080
1072
|
* <p>Determines if the replication set deletion protection is enabled or not. If deletion
|
|
1081
|
-
*
|
|
1082
|
-
*
|
|
1073
|
+
* protection is enabled, you can't delete the last Amazon Web Services Region in the replication
|
|
1074
|
+
* set. </p>
|
|
1083
1075
|
*/
|
|
1084
1076
|
deletionProtected: boolean | undefined;
|
|
1085
1077
|
/**
|
|
@@ -1114,7 +1106,7 @@ export interface GetReplicationSetOutput {
|
|
|
1114
1106
|
export interface GetResourcePoliciesInput {
|
|
1115
1107
|
/**
|
|
1116
1108
|
* <p>The Amazon Resource Name (ARN) of the response plan with the attached resource policy.
|
|
1117
|
-
*
|
|
1109
|
+
* </p>
|
|
1118
1110
|
*/
|
|
1119
1111
|
resourceArn: string | undefined;
|
|
1120
1112
|
/**
|
|
@@ -1129,7 +1121,7 @@ export interface GetResourcePoliciesInput {
|
|
|
1129
1121
|
/**
|
|
1130
1122
|
* @public
|
|
1131
1123
|
* <p>The resource policy that allows Incident Manager to perform actions on resources on your
|
|
1132
|
-
*
|
|
1124
|
+
* behalf.</p>
|
|
1133
1125
|
*/
|
|
1134
1126
|
export interface ResourcePolicy {
|
|
1135
1127
|
/**
|
|
@@ -1188,13 +1180,12 @@ export interface GetResponsePlanOutput {
|
|
|
1188
1180
|
*/
|
|
1189
1181
|
incidentTemplate: IncidentTemplate | undefined;
|
|
1190
1182
|
/**
|
|
1191
|
-
* <p>The Chatbot chat channel used for collaboration during an
|
|
1192
|
-
* incident.</p>
|
|
1183
|
+
* <p>The Chatbot chat channel used for collaboration during an incident.</p>
|
|
1193
1184
|
*/
|
|
1194
1185
|
chatChannel?: ChatChannel;
|
|
1195
1186
|
/**
|
|
1196
1187
|
* <p>The Amazon Resource Name (ARN) for the contacts and escalation plans that the response
|
|
1197
|
-
*
|
|
1188
|
+
* plan engages during an incident.</p>
|
|
1198
1189
|
*/
|
|
1199
1190
|
engagements?: string[];
|
|
1200
1191
|
/**
|
|
@@ -1203,7 +1194,7 @@ export interface GetResponsePlanOutput {
|
|
|
1203
1194
|
actions?: Action[];
|
|
1204
1195
|
/**
|
|
1205
1196
|
* <p>Information about third-party services integrated into the Incident Manager response
|
|
1206
|
-
*
|
|
1197
|
+
* plan.</p>
|
|
1207
1198
|
*/
|
|
1208
1199
|
integrations?: Integration[];
|
|
1209
1200
|
}
|
|
@@ -1212,13 +1203,12 @@ export interface GetResponsePlanOutput {
|
|
|
1212
1203
|
*/
|
|
1213
1204
|
export interface GetTimelineEventInput {
|
|
1214
1205
|
/**
|
|
1215
|
-
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline
|
|
1216
|
-
* event.</p>
|
|
1206
|
+
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
|
|
1217
1207
|
*/
|
|
1218
1208
|
incidentRecordArn: string | undefined;
|
|
1219
1209
|
/**
|
|
1220
1210
|
* <p>The ID of the event. You can get an event's ID when you create it, or by using
|
|
1221
|
-
*
|
|
1211
|
+
* <code>ListTimelineEvents</code>.</p>
|
|
1222
1212
|
*/
|
|
1223
1213
|
eventId: string | undefined;
|
|
1224
1214
|
}
|
|
@@ -1245,7 +1235,7 @@ export interface TimelineEvent {
|
|
|
1245
1235
|
eventUpdatedTime: Date | undefined;
|
|
1246
1236
|
/**
|
|
1247
1237
|
* <p>The type of event that occurred. Currently Incident Manager supports only the <code>Custom
|
|
1248
|
-
*
|
|
1238
|
+
* Event</code> type.</p>
|
|
1249
1239
|
*/
|
|
1250
1240
|
eventType: string | undefined;
|
|
1251
1241
|
/**
|
|
@@ -1277,7 +1267,7 @@ export interface IncidentRecordSummary {
|
|
|
1277
1267
|
arn: string | undefined;
|
|
1278
1268
|
/**
|
|
1279
1269
|
* <p>The title of the incident. This value is either provided by the response plan or
|
|
1280
|
-
*
|
|
1270
|
+
* overwritten on creation.</p>
|
|
1281
1271
|
*/
|
|
1282
1272
|
title: string | undefined;
|
|
1283
1273
|
/**
|
|
@@ -1317,23 +1307,22 @@ export declare enum ItemType {
|
|
|
1317
1307
|
}
|
|
1318
1308
|
/**
|
|
1319
1309
|
* @public
|
|
1320
|
-
* <p>Details about the PagerDuty incident associated with an incident created by an
|
|
1321
|
-
*
|
|
1310
|
+
* <p>Details about the PagerDuty incident associated with an incident created by an Incident Manager
|
|
1311
|
+
* response plan.</p>
|
|
1322
1312
|
*/
|
|
1323
1313
|
export interface PagerDutyIncidentDetail {
|
|
1324
1314
|
/**
|
|
1325
|
-
* <p>The ID of the incident associated with the PagerDuty service for the response
|
|
1326
|
-
* plan.</p>
|
|
1315
|
+
* <p>The ID of the incident associated with the PagerDuty service for the response plan.</p>
|
|
1327
1316
|
*/
|
|
1328
1317
|
id: string | undefined;
|
|
1329
1318
|
/**
|
|
1330
1319
|
* <p>Indicates whether to resolve the PagerDuty incident when you resolve the associated
|
|
1331
|
-
*
|
|
1320
|
+
* Incident Manager incident.</p>
|
|
1332
1321
|
*/
|
|
1333
1322
|
autoResolve?: boolean;
|
|
1334
1323
|
/**
|
|
1335
1324
|
* <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
|
-
*
|
|
1325
|
+
* User Token REST API Key, and other user credentials.</p>
|
|
1337
1326
|
*/
|
|
1338
1327
|
secretId?: string;
|
|
1339
1328
|
}
|
|
@@ -1348,7 +1337,7 @@ export type ItemValue = ItemValue.ArnMember | ItemValue.MetricDefinitionMember |
|
|
|
1348
1337
|
export declare namespace ItemValue {
|
|
1349
1338
|
/**
|
|
1350
1339
|
* <p>The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon
|
|
1351
|
-
*
|
|
1340
|
+
* resource.</p>
|
|
1352
1341
|
*/
|
|
1353
1342
|
interface ArnMember {
|
|
1354
1343
|
arn: string;
|
|
@@ -1422,43 +1411,42 @@ export interface ItemIdentifier {
|
|
|
1422
1411
|
*/
|
|
1423
1412
|
export interface ListIncidentRecordsInput {
|
|
1424
1413
|
/**
|
|
1425
|
-
* <p>Filters the list of incident records
|
|
1426
|
-
*
|
|
1427
|
-
*
|
|
1414
|
+
* <p>Filters the list of incident records you want to search through. You can filter on the
|
|
1415
|
+
* following keys:</p>
|
|
1416
|
+
* <ul>
|
|
1428
1417
|
* <li>
|
|
1429
|
-
*
|
|
1418
|
+
* <p>
|
|
1430
1419
|
* <code>creationTime</code>
|
|
1431
1420
|
* </p>
|
|
1432
1421
|
* </li>
|
|
1433
1422
|
* <li>
|
|
1434
|
-
*
|
|
1423
|
+
* <p>
|
|
1435
1424
|
* <code>impact</code>
|
|
1436
1425
|
* </p>
|
|
1437
1426
|
* </li>
|
|
1438
1427
|
* <li>
|
|
1439
|
-
*
|
|
1428
|
+
* <p>
|
|
1440
1429
|
* <code>status</code>
|
|
1441
1430
|
* </p>
|
|
1442
1431
|
* </li>
|
|
1443
1432
|
* <li>
|
|
1444
|
-
*
|
|
1433
|
+
* <p>
|
|
1445
1434
|
* <code>createdBy</code>
|
|
1446
1435
|
* </p>
|
|
1447
1436
|
* </li>
|
|
1448
1437
|
* </ul>
|
|
1449
|
-
*
|
|
1450
|
-
*
|
|
1438
|
+
* <p>Note the following when when you use Filters:</p>
|
|
1439
|
+
* <ul>
|
|
1451
1440
|
* <li>
|
|
1452
|
-
*
|
|
1453
|
-
* records.</p>
|
|
1441
|
+
* <p>If you don't specify a Filter, the response includes all incident records.</p>
|
|
1454
1442
|
* </li>
|
|
1455
1443
|
* <li>
|
|
1456
|
-
*
|
|
1457
|
-
*
|
|
1444
|
+
* <p>If you specify more than one filter in a single request, the response returns incident
|
|
1445
|
+
* records that match all filters.</p>
|
|
1458
1446
|
* </li>
|
|
1459
1447
|
* <li>
|
|
1460
|
-
*
|
|
1461
|
-
*
|
|
1448
|
+
* <p>If you specify a filter with more than one value, the response returns incident
|
|
1449
|
+
* records that match any of the values provided.</p>
|
|
1462
1450
|
* </li>
|
|
1463
1451
|
* </ul>
|
|
1464
1452
|
*/
|
|
@@ -1491,7 +1479,7 @@ export interface ListIncidentRecordsOutput {
|
|
|
1491
1479
|
export interface ListRelatedItemsInput {
|
|
1492
1480
|
/**
|
|
1493
1481
|
* <p>The Amazon Resource Name (ARN) of the incident record containing the listed related
|
|
1494
|
-
*
|
|
1482
|
+
* items.</p>
|
|
1495
1483
|
*/
|
|
1496
1484
|
incidentRecordArn: string | undefined;
|
|
1497
1485
|
/**
|
|
@@ -1519,8 +1507,7 @@ export interface RelatedItem {
|
|
|
1519
1507
|
/**
|
|
1520
1508
|
* <p>A unique ID for a <code>RelatedItem</code>.</p>
|
|
1521
1509
|
* <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>
|
|
1510
|
+
* <p>Don't specify this parameter when you add a <code>RelatedItem</code> by using the <a>UpdateRelatedItems</a> API action.</p>
|
|
1524
1511
|
* </important>
|
|
1525
1512
|
*/
|
|
1526
1513
|
generatedId?: string;
|
|
@@ -1644,49 +1631,47 @@ export declare enum SortOrder {
|
|
|
1644
1631
|
*/
|
|
1645
1632
|
export interface ListTimelineEventsInput {
|
|
1646
1633
|
/**
|
|
1647
|
-
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline
|
|
1648
|
-
* event.</p>
|
|
1634
|
+
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
|
|
1649
1635
|
*/
|
|
1650
1636
|
incidentRecordArn: string | undefined;
|
|
1651
1637
|
/**
|
|
1652
1638
|
* <p>Filters the timeline events based on the provided conditional values. You can filter
|
|
1653
|
-
*
|
|
1654
|
-
*
|
|
1639
|
+
* timeline events with the following keys:</p>
|
|
1640
|
+
* <ul>
|
|
1655
1641
|
* <li>
|
|
1656
|
-
*
|
|
1642
|
+
* <p>
|
|
1657
1643
|
* <code>eventTime</code>
|
|
1658
1644
|
* </p>
|
|
1659
1645
|
* </li>
|
|
1660
1646
|
* <li>
|
|
1661
|
-
*
|
|
1647
|
+
* <p>
|
|
1662
1648
|
* <code>eventType</code>
|
|
1663
1649
|
* </p>
|
|
1664
1650
|
* </li>
|
|
1665
1651
|
* </ul>
|
|
1666
|
-
*
|
|
1667
|
-
*
|
|
1652
|
+
* <p>Note the following when deciding how to use Filters:</p>
|
|
1653
|
+
* <ul>
|
|
1668
1654
|
* <li>
|
|
1669
|
-
*
|
|
1670
|
-
* events.</p>
|
|
1655
|
+
* <p>If you don't specify a Filter, the response includes all timeline events.</p>
|
|
1671
1656
|
* </li>
|
|
1672
1657
|
* <li>
|
|
1673
|
-
*
|
|
1674
|
-
*
|
|
1658
|
+
* <p>If you specify more than one filter in a single request, the response returns timeline
|
|
1659
|
+
* events that match all filters.</p>
|
|
1675
1660
|
* </li>
|
|
1676
1661
|
* <li>
|
|
1677
|
-
*
|
|
1678
|
-
*
|
|
1662
|
+
* <p>If you specify a filter with more than one value, the response returns timeline events
|
|
1663
|
+
* that match any of the values provided.</p>
|
|
1679
1664
|
* </li>
|
|
1680
1665
|
* </ul>
|
|
1681
1666
|
*/
|
|
1682
1667
|
filters?: Filter[];
|
|
1683
1668
|
/**
|
|
1684
|
-
* <p>Sort by the specified key value pair.</p>
|
|
1669
|
+
* <p>Sort timeline events by the specified key value pair.</p>
|
|
1685
1670
|
*/
|
|
1686
1671
|
sortBy?: TimelineEventSort | string;
|
|
1687
1672
|
/**
|
|
1688
1673
|
* <p>Sorts the order of timeline events by the value specified in the <code>sortBy</code>
|
|
1689
|
-
*
|
|
1674
|
+
* field.</p>
|
|
1690
1675
|
*/
|
|
1691
1676
|
sortOrder?: SortOrder | string;
|
|
1692
1677
|
/**
|
|
@@ -1716,8 +1701,7 @@ export interface ListTimelineEventsOutput {
|
|
|
1716
1701
|
*/
|
|
1717
1702
|
export interface PutResourcePolicyInput {
|
|
1718
1703
|
/**
|
|
1719
|
-
* <p>The Amazon Resource Name (ARN) of the response plan to add the resource policy
|
|
1720
|
-
* to.</p>
|
|
1704
|
+
* <p>The Amazon Resource Name (ARN) of the response plan to add the resource policy to.</p>
|
|
1721
1705
|
*/
|
|
1722
1706
|
resourceArn: string | undefined;
|
|
1723
1707
|
/**
|
|
@@ -1777,9 +1761,9 @@ export declare namespace RelatedItemsUpdate {
|
|
|
1777
1761
|
*/
|
|
1778
1762
|
export interface TriggerDetails {
|
|
1779
1763
|
/**
|
|
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
|
-
*
|
|
1764
|
+
* <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,
|
|
1765
|
+
* as long as it doesn't begin with "<code>aws.</code>" We recommend the use of Java package-name
|
|
1766
|
+
* style reverse domain-name strings. </p>
|
|
1783
1767
|
*/
|
|
1784
1768
|
source: string | undefined;
|
|
1785
1769
|
/**
|
|
@@ -1800,52 +1784,49 @@ export interface TriggerDetails {
|
|
|
1800
1784
|
*/
|
|
1801
1785
|
export interface StartIncidentInput {
|
|
1802
1786
|
/**
|
|
1803
|
-
* <p>A token ensuring that the operation is called only once with the specified
|
|
1804
|
-
* details.</p>
|
|
1787
|
+
* <p>A token ensuring that the operation is called only once with the specified details.</p>
|
|
1805
1788
|
*/
|
|
1806
1789
|
clientToken?: string;
|
|
1807
1790
|
/**
|
|
1808
1791
|
* <p>The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat
|
|
1809
|
-
*
|
|
1810
|
-
* </p>
|
|
1792
|
+
* channels, Amazon SNS topics, runbooks, title, and impact of the incident. </p>
|
|
1811
1793
|
*/
|
|
1812
1794
|
responsePlanArn: string | undefined;
|
|
1813
1795
|
/**
|
|
1814
|
-
* <p>Provide a title for the incident. Providing a title overwrites the title provided by
|
|
1815
|
-
*
|
|
1796
|
+
* <p>Provide a title for the incident. Providing a title overwrites the title provided by the
|
|
1797
|
+
* response plan. </p>
|
|
1816
1798
|
*/
|
|
1817
1799
|
title?: string;
|
|
1818
1800
|
/**
|
|
1819
|
-
* <p>Defines the impact to the customers. Providing an impact overwrites the impact
|
|
1820
|
-
*
|
|
1821
|
-
*
|
|
1801
|
+
* <p>Defines the impact to the customers. Providing an impact overwrites the impact provided by
|
|
1802
|
+
* a response plan.</p>
|
|
1803
|
+
* <p class="title">
|
|
1822
1804
|
* <b>Possible impacts:</b>
|
|
1823
1805
|
* </p>
|
|
1824
1806
|
* <ul>
|
|
1825
1807
|
* <li>
|
|
1826
|
-
*
|
|
1827
|
-
* <code>1</code> - Critical impact, this typically relates to full application
|
|
1828
|
-
*
|
|
1808
|
+
* <p>
|
|
1809
|
+
* <code>1</code> - Critical impact, this typically relates to full application failure
|
|
1810
|
+
* that impacts many to all customers. </p>
|
|
1829
1811
|
* </li>
|
|
1830
1812
|
* <li>
|
|
1831
|
-
*
|
|
1813
|
+
* <p>
|
|
1832
1814
|
* <code>2</code> - High impact, partial application failure with impact to many
|
|
1833
|
-
*
|
|
1815
|
+
* customers.</p>
|
|
1834
1816
|
* </li>
|
|
1835
1817
|
* <li>
|
|
1836
|
-
*
|
|
1837
|
-
* <code>3</code> - Medium impact, the application is providing reduced service
|
|
1838
|
-
*
|
|
1818
|
+
* <p>
|
|
1819
|
+
* <code>3</code> - Medium impact, the application is providing reduced service to
|
|
1820
|
+
* customers.</p>
|
|
1839
1821
|
* </li>
|
|
1840
1822
|
* <li>
|
|
1841
|
-
*
|
|
1842
|
-
* <code>4</code> - Low impact, customer might aren't impacted by the problem
|
|
1843
|
-
* yet.</p>
|
|
1823
|
+
* <p>
|
|
1824
|
+
* <code>4</code> - Low impact, customer might aren't impacted by the problem yet.</p>
|
|
1844
1825
|
* </li>
|
|
1845
1826
|
* <li>
|
|
1846
|
-
*
|
|
1847
|
-
* <code>5</code> - No impact, customers aren't currently impacted but urgent
|
|
1848
|
-
*
|
|
1827
|
+
* <p>
|
|
1828
|
+
* <code>5</code> - No impact, customers aren't currently impacted but urgent action is
|
|
1829
|
+
* needed to avoid impact.</p>
|
|
1849
1830
|
* </li>
|
|
1850
1831
|
* </ul>
|
|
1851
1832
|
*/
|
|
@@ -1855,8 +1836,8 @@ export interface StartIncidentInput {
|
|
|
1855
1836
|
*/
|
|
1856
1837
|
triggerDetails?: TriggerDetails;
|
|
1857
1838
|
/**
|
|
1858
|
-
* <p>Add related items to the incident for other responders to use. Related items are
|
|
1859
|
-
*
|
|
1839
|
+
* <p>Add related items to the incident for other responders to use. Related items are Amazon Web Services
|
|
1840
|
+
* resources, external links, or files uploaded to an Amazon S3 bucket. </p>
|
|
1860
1841
|
*/
|
|
1861
1842
|
relatedItems?: RelatedItem[];
|
|
1862
1843
|
}
|
|
@@ -1919,7 +1900,7 @@ export interface UpdateDeletionProtectionInput {
|
|
|
1919
1900
|
deletionProtected: boolean | undefined;
|
|
1920
1901
|
/**
|
|
1921
1902
|
* <p>A token that ensures that the operation is called only once with the specified
|
|
1922
|
-
*
|
|
1903
|
+
* details.</p>
|
|
1923
1904
|
*/
|
|
1924
1905
|
clientToken?: string;
|
|
1925
1906
|
}
|
|
@@ -1933,8 +1914,8 @@ export interface UpdateDeletionProtectionOutput {
|
|
|
1933
1914
|
*/
|
|
1934
1915
|
export interface UpdateIncidentRecordInput {
|
|
1935
1916
|
/**
|
|
1936
|
-
* <p>A token that ensures that the operation
|
|
1937
|
-
*
|
|
1917
|
+
* <p>A token that ensures that a client calls the operation only once with the specified
|
|
1918
|
+
* details.</p>
|
|
1938
1919
|
*/
|
|
1939
1920
|
clientToken?: string;
|
|
1940
1921
|
/**
|
|
@@ -1950,43 +1931,42 @@ export interface UpdateIncidentRecordInput {
|
|
|
1950
1931
|
*/
|
|
1951
1932
|
summary?: string;
|
|
1952
1933
|
/**
|
|
1953
|
-
* <p>Defines the impact of the incident to customers and applications.
|
|
1954
|
-
*
|
|
1955
|
-
*
|
|
1934
|
+
* <p>Defines the impact of the incident to customers and applications. If you provide an impact
|
|
1935
|
+
* for an incident, it overwrites the impact provided by the response plan.</p>
|
|
1936
|
+
* <p class="title">
|
|
1956
1937
|
* <b>Possible impacts:</b>
|
|
1957
1938
|
* </p>
|
|
1958
1939
|
* <ul>
|
|
1959
1940
|
* <li>
|
|
1960
|
-
*
|
|
1961
|
-
* <code>1</code> - Critical impact, full application failure that impacts many
|
|
1962
|
-
*
|
|
1941
|
+
* <p>
|
|
1942
|
+
* <code>1</code> - Critical impact, full application failure that impacts many to all
|
|
1943
|
+
* customers. </p>
|
|
1963
1944
|
* </li>
|
|
1964
1945
|
* <li>
|
|
1965
|
-
*
|
|
1946
|
+
* <p>
|
|
1966
1947
|
* <code>2</code> - High impact, partial application failure with impact to many
|
|
1967
|
-
*
|
|
1948
|
+
* customers.</p>
|
|
1968
1949
|
* </li>
|
|
1969
1950
|
* <li>
|
|
1970
|
-
*
|
|
1971
|
-
* <code>3</code> - Medium impact, the application is providing reduced service
|
|
1972
|
-
*
|
|
1951
|
+
* <p>
|
|
1952
|
+
* <code>3</code> - Medium impact, the application is providing reduced service to
|
|
1953
|
+
* customers.</p>
|
|
1973
1954
|
* </li>
|
|
1974
1955
|
* <li>
|
|
1975
|
-
*
|
|
1976
|
-
* <code>4</code> - Low impact, customer aren't impacted by the problem
|
|
1977
|
-
* yet.</p>
|
|
1956
|
+
* <p>
|
|
1957
|
+
* <code>4</code> - Low impact, customer aren't impacted by the problem yet.</p>
|
|
1978
1958
|
* </li>
|
|
1979
1959
|
* <li>
|
|
1980
|
-
*
|
|
1981
|
-
* <code>5</code> - No impact, customers aren't currently impacted but urgent
|
|
1982
|
-
*
|
|
1960
|
+
* <p>
|
|
1961
|
+
* <code>5</code> - No impact, customers aren't currently impacted but urgent action is
|
|
1962
|
+
* needed to avoid impact.</p>
|
|
1983
1963
|
* </li>
|
|
1984
1964
|
* </ul>
|
|
1985
1965
|
*/
|
|
1986
1966
|
impact?: number;
|
|
1987
1967
|
/**
|
|
1988
|
-
* <p>The status of the incident.
|
|
1989
|
-
*
|
|
1968
|
+
* <p>The status of the incident. Possible statuses are <code>Open</code> or
|
|
1969
|
+
* <code>Resolved</code>.</p>
|
|
1990
1970
|
*/
|
|
1991
1971
|
status?: IncidentRecordStatus | string;
|
|
1992
1972
|
/**
|
|
@@ -1994,10 +1974,10 @@ export interface UpdateIncidentRecordInput {
|
|
|
1994
1974
|
*/
|
|
1995
1975
|
chatChannel?: ChatChannel;
|
|
1996
1976
|
/**
|
|
1997
|
-
* <p>The Amazon SNS targets that
|
|
1998
|
-
*
|
|
1999
|
-
*
|
|
2000
|
-
*
|
|
1977
|
+
* <p>The Amazon SNS targets that Incident Manager notifies when a client updates an
|
|
1978
|
+
* incident.</p>
|
|
1979
|
+
* <p>Using multiple SNS topics creates redundancy in the event that a Region is down during the
|
|
1980
|
+
* incident.</p>
|
|
2001
1981
|
*/
|
|
2002
1982
|
notificationTargets?: NotificationTargetItem[];
|
|
2003
1983
|
}
|
|
@@ -2011,17 +1991,17 @@ export interface UpdateIncidentRecordOutput {
|
|
|
2011
1991
|
*/
|
|
2012
1992
|
export interface UpdateRelatedItemsInput {
|
|
2013
1993
|
/**
|
|
2014
|
-
* <p>A token
|
|
2015
|
-
*
|
|
1994
|
+
* <p>A token that ensures that a client calls the operation only once with the specified
|
|
1995
|
+
* details.</p>
|
|
2016
1996
|
*/
|
|
2017
1997
|
clientToken?: string;
|
|
2018
1998
|
/**
|
|
2019
|
-
* <p>The Amazon Resource Name (ARN) of the incident record
|
|
2020
|
-
*
|
|
1999
|
+
* <p>The Amazon Resource Name (ARN) of the incident record that contains the related items that
|
|
2000
|
+
* you update.</p>
|
|
2021
2001
|
*/
|
|
2022
2002
|
incidentRecordArn: string | undefined;
|
|
2023
2003
|
/**
|
|
2024
|
-
* <p>Details about the item you are
|
|
2004
|
+
* <p>Details about the item that you are add to, or delete from, an incident.</p>
|
|
2025
2005
|
*/
|
|
2026
2006
|
relatedItemsUpdate: RelatedItemsUpdate | undefined;
|
|
2027
2007
|
}
|
|
@@ -2041,7 +2021,7 @@ export type UpdateReplicationSetAction = UpdateReplicationSetAction.AddRegionAct
|
|
|
2041
2021
|
export declare namespace UpdateReplicationSetAction {
|
|
2042
2022
|
/**
|
|
2043
2023
|
* <p>Details about the Amazon Web Services Region that you're adding to the replication
|
|
2044
|
-
*
|
|
2024
|
+
* set.</p>
|
|
2045
2025
|
*/
|
|
2046
2026
|
interface AddRegionActionMember {
|
|
2047
2027
|
addRegionAction: AddRegionAction;
|
|
@@ -2050,7 +2030,7 @@ export declare namespace UpdateReplicationSetAction {
|
|
|
2050
2030
|
}
|
|
2051
2031
|
/**
|
|
2052
2032
|
* <p>Details about the Amazon Web Services Region that you're deleting to the replication
|
|
2053
|
-
*
|
|
2033
|
+
* set.</p>
|
|
2054
2034
|
*/
|
|
2055
2035
|
interface DeleteRegionActionMember {
|
|
2056
2036
|
addRegionAction?: never;
|
|
@@ -2083,7 +2063,7 @@ export interface UpdateReplicationSetInput {
|
|
|
2083
2063
|
actions: UpdateReplicationSetAction[] | undefined;
|
|
2084
2064
|
/**
|
|
2085
2065
|
* <p>A token that ensures that the operation is called only once with the specified
|
|
2086
|
-
*
|
|
2066
|
+
* details.</p>
|
|
2087
2067
|
*/
|
|
2088
2068
|
clientToken?: string;
|
|
2089
2069
|
}
|
|
@@ -2097,8 +2077,7 @@ export interface UpdateReplicationSetOutput {
|
|
|
2097
2077
|
*/
|
|
2098
2078
|
export interface UpdateResponsePlanInput {
|
|
2099
2079
|
/**
|
|
2100
|
-
* <p>A token ensuring that the operation is called only once with the specified
|
|
2101
|
-
* details.</p>
|
|
2080
|
+
* <p>A token ensuring that the operation is called only once with the specified details.</p>
|
|
2102
2081
|
*/
|
|
2103
2082
|
clientToken?: string;
|
|
2104
2083
|
/**
|
|
@@ -2106,8 +2085,7 @@ export interface UpdateResponsePlanInput {
|
|
|
2106
2085
|
*/
|
|
2107
2086
|
arn: string | undefined;
|
|
2108
2087
|
/**
|
|
2109
|
-
* <p>The long format name of the response plan. The display name can't contain
|
|
2110
|
-
* spaces.</p>
|
|
2088
|
+
* <p>The long format name of the response plan. The display name can't contain spaces.</p>
|
|
2111
2089
|
*/
|
|
2112
2090
|
displayName?: string;
|
|
2113
2091
|
/**
|
|
@@ -2115,30 +2093,30 @@ export interface UpdateResponsePlanInput {
|
|
|
2115
2093
|
*/
|
|
2116
2094
|
incidentTemplateTitle?: string;
|
|
2117
2095
|
/**
|
|
2118
|
-
* <p>Defines the impact to the customers. Providing an impact overwrites the impact
|
|
2119
|
-
*
|
|
2120
|
-
*
|
|
2096
|
+
* <p>Defines the impact to the customers. Providing an impact overwrites the impact provided by
|
|
2097
|
+
* a response plan.</p>
|
|
2098
|
+
* <p class="title">
|
|
2121
2099
|
* <b>Possible impacts:</b>
|
|
2122
2100
|
* </p>
|
|
2123
2101
|
* <ul>
|
|
2124
2102
|
* <li>
|
|
2125
|
-
*
|
|
2103
|
+
* <p>
|
|
2126
2104
|
* <code>5</code> - Severe impact</p>
|
|
2127
2105
|
* </li>
|
|
2128
2106
|
* <li>
|
|
2129
|
-
*
|
|
2107
|
+
* <p>
|
|
2130
2108
|
* <code>4</code> - High impact</p>
|
|
2131
2109
|
* </li>
|
|
2132
2110
|
* <li>
|
|
2133
|
-
*
|
|
2111
|
+
* <p>
|
|
2134
2112
|
* <code>3</code> - Medium impact</p>
|
|
2135
2113
|
* </li>
|
|
2136
2114
|
* <li>
|
|
2137
|
-
*
|
|
2115
|
+
* <p>
|
|
2138
2116
|
* <code>2</code> - Low impact</p>
|
|
2139
2117
|
* </li>
|
|
2140
2118
|
* <li>
|
|
2141
|
-
*
|
|
2119
|
+
* <p>
|
|
2142
2120
|
* <code>1</code> - No impact</p>
|
|
2143
2121
|
* </li>
|
|
2144
2122
|
* </ul>
|
|
@@ -2146,28 +2124,27 @@ export interface UpdateResponsePlanInput {
|
|
|
2146
2124
|
incidentTemplateImpact?: number;
|
|
2147
2125
|
/**
|
|
2148
2126
|
* <p>A brief summary of the incident. This typically contains what has happened, what's
|
|
2149
|
-
*
|
|
2127
|
+
* currently happening, and next steps.</p>
|
|
2150
2128
|
*/
|
|
2151
2129
|
incidentTemplateSummary?: string;
|
|
2152
2130
|
/**
|
|
2153
|
-
* <p>The string Incident Manager uses to prevent duplicate incidents from being created by the
|
|
2154
|
-
*
|
|
2131
|
+
* <p>The string Incident Manager uses to prevent duplicate incidents from being created by the same
|
|
2132
|
+
* incident in the same account.</p>
|
|
2155
2133
|
*/
|
|
2156
2134
|
incidentTemplateDedupeString?: string;
|
|
2157
2135
|
/**
|
|
2158
2136
|
* <p>The Amazon SNS targets that are notified when updates are made to an
|
|
2159
|
-
*
|
|
2137
|
+
* incident.</p>
|
|
2160
2138
|
*/
|
|
2161
2139
|
incidentTemplateNotificationTargets?: NotificationTargetItem[];
|
|
2162
2140
|
/**
|
|
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>
|
|
2141
|
+
* <p>The Chatbot chat channel used for collaboration during an incident.</p>
|
|
2142
|
+
* <p>Use the empty structure to remove the chat channel from the response plan.</p>
|
|
2166
2143
|
*/
|
|
2167
2144
|
chatChannel?: ChatChannel;
|
|
2168
2145
|
/**
|
|
2169
2146
|
* <p>The Amazon Resource Name (ARN) for the contacts and escalation plans that the response
|
|
2170
|
-
*
|
|
2147
|
+
* plan engages during an incident.</p>
|
|
2171
2148
|
*/
|
|
2172
2149
|
engagements?: string[];
|
|
2173
2150
|
/**
|
|
@@ -2175,10 +2152,10 @@ export interface UpdateResponsePlanInput {
|
|
|
2175
2152
|
*/
|
|
2176
2153
|
actions?: Action[];
|
|
2177
2154
|
/**
|
|
2178
|
-
* <p>Tags to assign to the template. When the <code>StartIncident</code> API action is
|
|
2179
|
-
*
|
|
2180
|
-
*
|
|
2181
|
-
*
|
|
2155
|
+
* <p>Tags to assign to the template. When the <code>StartIncident</code> API action is called,
|
|
2156
|
+
* Incident Manager assigns the tags specified in the template to the incident. To call this action,
|
|
2157
|
+
* you must also have permission to call the <code>TagResource</code> API action for the incident
|
|
2158
|
+
* record resource.</p>
|
|
2182
2159
|
*/
|
|
2183
2160
|
incidentTemplateTags?: Record<string, string>;
|
|
2184
2161
|
/**
|
|
@@ -2196,18 +2173,17 @@ export interface UpdateResponsePlanOutput {
|
|
|
2196
2173
|
*/
|
|
2197
2174
|
export interface UpdateTimelineEventInput {
|
|
2198
2175
|
/**
|
|
2199
|
-
* <p>A token
|
|
2200
|
-
*
|
|
2176
|
+
* <p>A token that ensures that a client calls the operation only once with the specified
|
|
2177
|
+
* details.</p>
|
|
2201
2178
|
*/
|
|
2202
2179
|
clientToken?: string;
|
|
2203
2180
|
/**
|
|
2204
|
-
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline
|
|
2205
|
-
* event.</p>
|
|
2181
|
+
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
|
|
2206
2182
|
*/
|
|
2207
2183
|
incidentRecordArn: string | undefined;
|
|
2208
2184
|
/**
|
|
2209
|
-
* <p>The ID of the event
|
|
2210
|
-
*
|
|
2185
|
+
* <p>The ID of the event to update. You can use <code>ListTimelineEvents</code> to find an
|
|
2186
|
+
* event's ID.</p>
|
|
2211
2187
|
*/
|
|
2212
2188
|
eventId: string | undefined;
|
|
2213
2189
|
/**
|
|
@@ -2215,7 +2191,7 @@ export interface UpdateTimelineEventInput {
|
|
|
2215
2191
|
*/
|
|
2216
2192
|
eventTime?: Date;
|
|
2217
2193
|
/**
|
|
2218
|
-
* <p>The type of
|
|
2194
|
+
* <p>The type of event. You can update events of type <code>Custom Event</code>.</p>
|
|
2219
2195
|
*/
|
|
2220
2196
|
eventType?: string;
|
|
2221
2197
|
/**
|
|
@@ -2223,18 +2199,16 @@ export interface UpdateTimelineEventInput {
|
|
|
2223
2199
|
*/
|
|
2224
2200
|
eventData?: string;
|
|
2225
2201
|
/**
|
|
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>
|
|
2202
|
+
* <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
|
|
2203
|
+
* its Amazon Resource Name (ARN). You can also specify a related item associated with that
|
|
2204
|
+
* resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a
|
|
2205
|
+
* resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with
|
|
2206
|
+
* the DynamoDB table as a related item.</p>
|
|
2207
|
+
* <important>
|
|
2234
2208
|
* <p>This update action overrides all existing references. If you want to keep existing
|
|
2235
|
-
*
|
|
2236
|
-
*
|
|
2237
|
-
*
|
|
2209
|
+
* references, you must specify them in the call. If you don't, this action removes any
|
|
2210
|
+
* existing references and enters only new references.</p>
|
|
2211
|
+
* </important>
|
|
2238
2212
|
*/
|
|
2239
2213
|
eventReferences?: EventReference[];
|
|
2240
2214
|
}
|