@aws-sdk/client-ssm-incidents 3.533.0 → 3.540.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/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/SSMIncidents.d.ts +4 -1
- package/dist-types/SSMIncidentsClient.d.ts +1 -1
- package/dist-types/commands/BatchGetIncidentFindingsCommand.d.ts +2 -1
- package/dist-types/commands/CreateReplicationSetCommand.d.ts +2 -1
- package/dist-types/commands/CreateResponsePlanCommand.d.ts +2 -1
- package/dist-types/commands/CreateTimelineEventCommand.d.ts +2 -1
- package/dist-types/commands/DeleteIncidentRecordCommand.d.ts +2 -1
- package/dist-types/commands/DeleteReplicationSetCommand.d.ts +2 -1
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +2 -1
- package/dist-types/commands/DeleteResponsePlanCommand.d.ts +2 -1
- package/dist-types/commands/DeleteTimelineEventCommand.d.ts +2 -1
- package/dist-types/commands/GetIncidentRecordCommand.d.ts +2 -1
- package/dist-types/commands/GetReplicationSetCommand.d.ts +2 -1
- package/dist-types/commands/GetResourcePoliciesCommand.d.ts +2 -1
- package/dist-types/commands/GetResponsePlanCommand.d.ts +2 -1
- package/dist-types/commands/GetTimelineEventCommand.d.ts +2 -1
- package/dist-types/commands/ListIncidentFindingsCommand.d.ts +2 -1
- package/dist-types/commands/ListIncidentRecordsCommand.d.ts +2 -1
- package/dist-types/commands/ListRelatedItemsCommand.d.ts +2 -1
- package/dist-types/commands/ListReplicationSetsCommand.d.ts +2 -1
- package/dist-types/commands/ListResponsePlansCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListTimelineEventsCommand.d.ts +2 -1
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +2 -1
- package/dist-types/commands/StartIncidentCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDeletionProtectionCommand.d.ts +2 -1
- package/dist-types/commands/UpdateIncidentRecordCommand.d.ts +2 -1
- package/dist-types/commands/UpdateRelatedItemsCommand.d.ts +2 -1
- package/dist-types/commands/UpdateReplicationSetCommand.d.ts +2 -1
- package/dist-types/commands/UpdateResponsePlanCommand.d.ts +2 -1
- package/dist-types/commands/UpdateTimelineEventCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +326 -326
- package/dist-types/ts3.4/SSMIncidents.d.ts +3 -0
- package/dist-types/ts3.4/commands/BatchGetIncidentFindingsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateReplicationSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateResponsePlanCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateTimelineEventCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteIncidentRecordCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteReplicationSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteResponsePlanCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteTimelineEventCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetIncidentRecordCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetReplicationSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetResourcePoliciesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetResponsePlanCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetTimelineEventCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListIncidentFindingsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListIncidentRecordsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListRelatedItemsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListReplicationSetsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListResponsePlansCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTimelineEventsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartIncidentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateDeletionProtectionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateIncidentRecordCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateRelatedItemsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateReplicationSetCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateResponsePlanCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateTimelineEventCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +41 -41
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { SSMIncidentsServiceException as __BaseException } from "./SSMIncidentsServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>You don't have sufficient access to perform this operation.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
@@ -25,8 +25,8 @@ export declare const VariableType: {
|
|
|
25
25
|
*/
|
|
26
26
|
export type VariableType = (typeof VariableType)[keyof typeof VariableType];
|
|
27
27
|
/**
|
|
28
|
-
* @public
|
|
29
28
|
* <p>The dynamic SSM parameter value.</p>
|
|
29
|
+
* @public
|
|
30
30
|
*/
|
|
31
31
|
export type DynamicSsmParameterValue = DynamicSsmParameterValue.VariableMember | DynamicSsmParameterValue.$UnknownMember;
|
|
32
32
|
/**
|
|
@@ -34,9 +34,9 @@ export type DynamicSsmParameterValue = DynamicSsmParameterValue.VariableMember |
|
|
|
34
34
|
*/
|
|
35
35
|
export declare namespace DynamicSsmParameterValue {
|
|
36
36
|
/**
|
|
37
|
-
* @public
|
|
38
37
|
* <p>Variable dynamic parameters. A parameter value is determined when an incident is
|
|
39
38
|
* created.</p>
|
|
39
|
+
* @public
|
|
40
40
|
*/
|
|
41
41
|
interface VariableMember {
|
|
42
42
|
variable: VariableType;
|
|
@@ -68,49 +68,49 @@ export declare const SsmTargetAccount: {
|
|
|
68
68
|
*/
|
|
69
69
|
export type SsmTargetAccount = (typeof SsmTargetAccount)[keyof typeof SsmTargetAccount];
|
|
70
70
|
/**
|
|
71
|
-
* @public
|
|
72
71
|
* <p>Details about the Systems Manager automation document that will be used as a runbook
|
|
73
72
|
* during an incident.</p>
|
|
73
|
+
* @public
|
|
74
74
|
*/
|
|
75
75
|
export interface SsmAutomation {
|
|
76
76
|
/**
|
|
77
|
-
* @public
|
|
78
77
|
* <p>The Amazon Resource Name (ARN) of the role that the automation document will assume when
|
|
79
78
|
* running commands.</p>
|
|
79
|
+
* @public
|
|
80
80
|
*/
|
|
81
81
|
roleArn: string | undefined;
|
|
82
82
|
/**
|
|
83
|
-
* @public
|
|
84
83
|
* <p>The automation document's name.</p>
|
|
84
|
+
* @public
|
|
85
85
|
*/
|
|
86
86
|
documentName: string | undefined;
|
|
87
87
|
/**
|
|
88
|
-
* @public
|
|
89
88
|
* <p>The automation document's version to use when running.</p>
|
|
89
|
+
* @public
|
|
90
90
|
*/
|
|
91
91
|
documentVersion?: string;
|
|
92
92
|
/**
|
|
93
|
-
* @public
|
|
94
93
|
* <p>The account that the automation document will be run in. This can be in either the
|
|
95
94
|
* management account or an application account.</p>
|
|
95
|
+
* @public
|
|
96
96
|
*/
|
|
97
97
|
targetAccount?: SsmTargetAccount;
|
|
98
98
|
/**
|
|
99
|
-
* @public
|
|
100
99
|
* <p>The key-value pair parameters to use when running the automation document.</p>
|
|
100
|
+
* @public
|
|
101
101
|
*/
|
|
102
102
|
parameters?: Record<string, string[]>;
|
|
103
103
|
/**
|
|
104
|
-
* @public
|
|
105
104
|
* <p>The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation
|
|
106
105
|
* runbook.</p>
|
|
106
|
+
* @public
|
|
107
107
|
*/
|
|
108
108
|
dynamicParameters?: Record<string, DynamicSsmParameterValue>;
|
|
109
109
|
}
|
|
110
110
|
/**
|
|
111
|
-
* @public
|
|
112
111
|
* <p>The action that starts at the beginning of an incident. The response plan defines the
|
|
113
112
|
* action.</p>
|
|
113
|
+
* @public
|
|
114
114
|
*/
|
|
115
115
|
export type Action = Action.SsmAutomationMember | Action.$UnknownMember;
|
|
116
116
|
/**
|
|
@@ -118,9 +118,9 @@ export type Action = Action.SsmAutomationMember | Action.$UnknownMember;
|
|
|
118
118
|
*/
|
|
119
119
|
export declare namespace Action {
|
|
120
120
|
/**
|
|
121
|
-
* @public
|
|
122
121
|
* <p>The Systems Manager automation document to start as the runbook at the beginning of the
|
|
123
122
|
* incident.</p>
|
|
123
|
+
* @public
|
|
124
124
|
*/
|
|
125
125
|
interface SsmAutomationMember {
|
|
126
126
|
ssmAutomation: SsmAutomation;
|
|
@@ -140,25 +140,25 @@ export declare namespace Action {
|
|
|
140
140
|
const visit: <T>(value: Action, visitor: Visitor<T>) => T;
|
|
141
141
|
}
|
|
142
142
|
/**
|
|
143
|
-
* @public
|
|
144
143
|
* <p>Defines the Amazon Web Services Region and KMS key to add to the replication
|
|
145
144
|
* set. </p>
|
|
145
|
+
* @public
|
|
146
146
|
*/
|
|
147
147
|
export interface AddRegionAction {
|
|
148
148
|
/**
|
|
149
|
-
* @public
|
|
150
149
|
* <p>The Amazon Web Services Region name to add to the replication set.</p>
|
|
150
|
+
* @public
|
|
151
151
|
*/
|
|
152
152
|
regionName: string | undefined;
|
|
153
153
|
/**
|
|
154
|
-
* @public
|
|
155
154
|
* <p>The KMS key ID to use to encrypt your replication set.</p>
|
|
155
|
+
* @public
|
|
156
156
|
*/
|
|
157
157
|
sseKmsKeyId?: string;
|
|
158
158
|
}
|
|
159
159
|
/**
|
|
160
|
-
* @public
|
|
161
160
|
* <p>Use the AttributeValueList to filter by string or integer values.</p>
|
|
161
|
+
* @public
|
|
162
162
|
*/
|
|
163
163
|
export type AttributeValueList = AttributeValueList.IntegerValuesMember | AttributeValueList.StringValuesMember | AttributeValueList.$UnknownMember;
|
|
164
164
|
/**
|
|
@@ -166,8 +166,8 @@ export type AttributeValueList = AttributeValueList.IntegerValuesMember | Attrib
|
|
|
166
166
|
*/
|
|
167
167
|
export declare namespace AttributeValueList {
|
|
168
168
|
/**
|
|
169
|
-
* @public
|
|
170
169
|
* <p>The list of string values that the filter matches.</p>
|
|
170
|
+
* @public
|
|
171
171
|
*/
|
|
172
172
|
interface StringValuesMember {
|
|
173
173
|
stringValues: string[];
|
|
@@ -175,8 +175,8 @@ export declare namespace AttributeValueList {
|
|
|
175
175
|
$unknown?: never;
|
|
176
176
|
}
|
|
177
177
|
/**
|
|
178
|
-
* @public
|
|
179
178
|
* <p>The list of integer values that the filter matches.</p>
|
|
179
|
+
* @public
|
|
180
180
|
*/
|
|
181
181
|
interface IntegerValuesMember {
|
|
182
182
|
stringValues?: never;
|
|
@@ -199,9 +199,9 @@ export declare namespace AttributeValueList {
|
|
|
199
199
|
const visit: <T>(value: AttributeValueList, visitor: Visitor<T>) => T;
|
|
200
200
|
}
|
|
201
201
|
/**
|
|
202
|
-
* @public
|
|
203
202
|
* <p>The Systems Manager automation document process to start as the runbook at the
|
|
204
203
|
* beginning of the incident.</p>
|
|
204
|
+
* @public
|
|
205
205
|
*/
|
|
206
206
|
export type AutomationExecution = AutomationExecution.SsmExecutionArnMember | AutomationExecution.$UnknownMember;
|
|
207
207
|
/**
|
|
@@ -209,8 +209,8 @@ export type AutomationExecution = AutomationExecution.SsmExecutionArnMember | Au
|
|
|
209
209
|
*/
|
|
210
210
|
export declare namespace AutomationExecution {
|
|
211
211
|
/**
|
|
212
|
-
* @public
|
|
213
212
|
* <p>The Amazon Resource Name (ARN) of the automation process.</p>
|
|
213
|
+
* @public
|
|
214
214
|
*/
|
|
215
215
|
interface SsmExecutionArnMember {
|
|
216
216
|
ssmExecutionArn: string;
|
|
@@ -234,98 +234,98 @@ export declare namespace AutomationExecution {
|
|
|
234
234
|
*/
|
|
235
235
|
export interface BatchGetIncidentFindingsInput {
|
|
236
236
|
/**
|
|
237
|
-
* @public
|
|
238
237
|
* <p>The Amazon Resource Name (ARN) of the incident for which you want to view finding
|
|
239
238
|
* details.</p>
|
|
239
|
+
* @public
|
|
240
240
|
*/
|
|
241
241
|
incidentRecordArn: string | undefined;
|
|
242
242
|
/**
|
|
243
|
-
* @public
|
|
244
243
|
* <p>A list of IDs of findings for which you want to view details.</p>
|
|
244
|
+
* @public
|
|
245
245
|
*/
|
|
246
246
|
findingIds: string[] | undefined;
|
|
247
247
|
}
|
|
248
248
|
/**
|
|
249
|
-
* @public
|
|
250
249
|
* <p>Details about an error returned for a <a>BatchGetIncidentFindings</a>
|
|
251
250
|
* operation.</p>
|
|
251
|
+
* @public
|
|
252
252
|
*/
|
|
253
253
|
export interface BatchGetIncidentFindingsError {
|
|
254
254
|
/**
|
|
255
|
-
* @public
|
|
256
255
|
* <p>The ID of a specified finding for which an error was returned for a
|
|
257
256
|
* <code>BatchGetIncidentFindings</code> operation.</p>
|
|
257
|
+
* @public
|
|
258
258
|
*/
|
|
259
259
|
findingId: string | undefined;
|
|
260
260
|
/**
|
|
261
|
-
* @public
|
|
262
261
|
* <p>The code associated with an error that was returned for a
|
|
263
262
|
* <code>BatchGetIncidentFindings</code> operation.</p>
|
|
263
|
+
* @public
|
|
264
264
|
*/
|
|
265
265
|
code: string | undefined;
|
|
266
266
|
/**
|
|
267
|
-
* @public
|
|
268
267
|
* <p>The description for an error that was returned for a <code>BatchGetIncidentFindings</code>
|
|
269
268
|
* operation.</p>
|
|
269
|
+
* @public
|
|
270
270
|
*/
|
|
271
271
|
message: string | undefined;
|
|
272
272
|
}
|
|
273
273
|
/**
|
|
274
|
-
* @public
|
|
275
274
|
* <p>Information about an CloudFormation stack creation or update that occurred around
|
|
276
275
|
* the time of an incident and could be a potential cause of the incident.</p>
|
|
276
|
+
* @public
|
|
277
277
|
*/
|
|
278
278
|
export interface CloudFormationStackUpdate {
|
|
279
279
|
/**
|
|
280
|
-
* @public
|
|
281
280
|
* <p>The timestamp for when the CloudFormation stack creation or update began.</p>
|
|
281
|
+
* @public
|
|
282
282
|
*/
|
|
283
283
|
startTime: Date | undefined;
|
|
284
284
|
/**
|
|
285
|
-
* @public
|
|
286
285
|
* <p>The timestamp for when the CloudFormation stack creation or update ended. Not reported
|
|
287
286
|
* for deployments that are still in progress.</p>
|
|
287
|
+
* @public
|
|
288
288
|
*/
|
|
289
289
|
endTime?: Date;
|
|
290
290
|
/**
|
|
291
|
-
* @public
|
|
292
291
|
* <p>The Amazon Resource Name (ARN) of the CloudFormation stack involved in the
|
|
293
292
|
* update.</p>
|
|
293
|
+
* @public
|
|
294
294
|
*/
|
|
295
295
|
stackArn: string | undefined;
|
|
296
296
|
}
|
|
297
297
|
/**
|
|
298
|
-
* @public
|
|
299
298
|
* <p>Information about a CodeDeploy deployment that occurred around the time of an
|
|
300
299
|
* incident and could be a possible cause of the incident.</p>
|
|
300
|
+
* @public
|
|
301
301
|
*/
|
|
302
302
|
export interface CodeDeployDeployment {
|
|
303
303
|
/**
|
|
304
|
-
* @public
|
|
305
304
|
* <p>The timestamp for when the CodeDeploy deployment began.</p>
|
|
305
|
+
* @public
|
|
306
306
|
*/
|
|
307
307
|
startTime: Date | undefined;
|
|
308
308
|
/**
|
|
309
|
-
* @public
|
|
310
309
|
* <p>The timestamp for when the CodeDeploy deployment ended. Not reported for
|
|
311
310
|
* deployments that are still in progress.</p>
|
|
311
|
+
* @public
|
|
312
312
|
*/
|
|
313
313
|
endTime?: Date;
|
|
314
314
|
/**
|
|
315
|
-
* @public
|
|
316
315
|
* <p>The Amazon Resource Name (ARN) of the CodeDeploy deployment group associated with
|
|
317
316
|
* the deployment.</p>
|
|
317
|
+
* @public
|
|
318
318
|
*/
|
|
319
319
|
deploymentGroupArn: string | undefined;
|
|
320
320
|
/**
|
|
321
|
-
* @public
|
|
322
321
|
* <p>The ID of the CodeDeploy deployment.</p>
|
|
322
|
+
* @public
|
|
323
323
|
*/
|
|
324
324
|
deploymentId: string | undefined;
|
|
325
325
|
}
|
|
326
326
|
/**
|
|
327
|
-
* @public
|
|
328
327
|
* <p>Extended textual information about the finding.</p>
|
|
328
|
+
* @public
|
|
329
329
|
*/
|
|
330
330
|
export type FindingDetails = FindingDetails.CloudFormationStackUpdateMember | FindingDetails.CodeDeployDeploymentMember | FindingDetails.$UnknownMember;
|
|
331
331
|
/**
|
|
@@ -333,8 +333,8 @@ export type FindingDetails = FindingDetails.CloudFormationStackUpdateMember | Fi
|
|
|
333
333
|
*/
|
|
334
334
|
export declare namespace FindingDetails {
|
|
335
335
|
/**
|
|
336
|
-
* @public
|
|
337
336
|
* <p>Information about the CodeDeploy deployment associated with the finding.</p>
|
|
337
|
+
* @public
|
|
338
338
|
*/
|
|
339
339
|
interface CodeDeployDeploymentMember {
|
|
340
340
|
codeDeployDeployment: CodeDeployDeployment;
|
|
@@ -342,9 +342,9 @@ export declare namespace FindingDetails {
|
|
|
342
342
|
$unknown?: never;
|
|
343
343
|
}
|
|
344
344
|
/**
|
|
345
|
-
* @public
|
|
346
345
|
* <p>Information about the CloudFormation stack creation or update associated with the
|
|
347
346
|
* finding.</p>
|
|
347
|
+
* @public
|
|
348
348
|
*/
|
|
349
349
|
interface CloudFormationStackUpdateMember {
|
|
350
350
|
codeDeployDeployment?: never;
|
|
@@ -367,31 +367,31 @@ export declare namespace FindingDetails {
|
|
|
367
367
|
const visit: <T>(value: FindingDetails, visitor: Visitor<T>) => T;
|
|
368
368
|
}
|
|
369
369
|
/**
|
|
370
|
-
* @public
|
|
371
370
|
* <p>Information about a specific CodeDeploy deployment or CloudFormation
|
|
372
371
|
* stack creation or update that occurred around the time of a reported incident. These
|
|
373
372
|
* activities can be investigated as a potential cause of the incident.</p>
|
|
373
|
+
* @public
|
|
374
374
|
*/
|
|
375
375
|
export interface Finding {
|
|
376
376
|
/**
|
|
377
|
-
* @public
|
|
378
377
|
* <p>The ID assigned to the finding.</p>
|
|
378
|
+
* @public
|
|
379
379
|
*/
|
|
380
380
|
id: string | undefined;
|
|
381
381
|
/**
|
|
382
|
-
* @public
|
|
383
382
|
* <p>The timestamp for when a finding was created.</p>
|
|
383
|
+
* @public
|
|
384
384
|
*/
|
|
385
385
|
creationTime: Date | undefined;
|
|
386
386
|
/**
|
|
387
|
-
* @public
|
|
388
387
|
* <p>The timestamp for when the finding was most recently updated with additional
|
|
389
388
|
* information.</p>
|
|
389
|
+
* @public
|
|
390
390
|
*/
|
|
391
391
|
lastModifiedTime: Date | undefined;
|
|
392
392
|
/**
|
|
393
|
-
* @public
|
|
394
393
|
* <p>Details about the finding.</p>
|
|
394
|
+
* @public
|
|
395
395
|
*/
|
|
396
396
|
details?: FindingDetails;
|
|
397
397
|
}
|
|
@@ -400,20 +400,20 @@ export interface Finding {
|
|
|
400
400
|
*/
|
|
401
401
|
export interface BatchGetIncidentFindingsOutput {
|
|
402
402
|
/**
|
|
403
|
-
* @public
|
|
404
403
|
* <p>Information about the requested findings.</p>
|
|
404
|
+
* @public
|
|
405
405
|
*/
|
|
406
406
|
findings: Finding[] | undefined;
|
|
407
407
|
/**
|
|
408
|
-
* @public
|
|
409
408
|
* <p>A list of errors encountered during the operation.</p>
|
|
409
|
+
* @public
|
|
410
410
|
*/
|
|
411
411
|
errors: BatchGetIncidentFindingsError[] | undefined;
|
|
412
412
|
}
|
|
413
413
|
/**
|
|
414
|
-
* @public
|
|
415
414
|
* <p>The request processing has failed because of an unknown error, exception or
|
|
416
415
|
* failure.</p>
|
|
416
|
+
* @public
|
|
417
417
|
*/
|
|
418
418
|
export declare class InternalServerException extends __BaseException {
|
|
419
419
|
readonly name: "InternalServerException";
|
|
@@ -439,20 +439,20 @@ export declare const ResourceType: {
|
|
|
439
439
|
*/
|
|
440
440
|
export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
441
441
|
/**
|
|
442
|
-
* @public
|
|
443
442
|
* <p>Request references a resource which doesn't exist. </p>
|
|
443
|
+
* @public
|
|
444
444
|
*/
|
|
445
445
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
446
446
|
readonly name: "ResourceNotFoundException";
|
|
447
447
|
readonly $fault: "client";
|
|
448
448
|
/**
|
|
449
|
-
* @public
|
|
450
449
|
* The identifier for the requested resource
|
|
450
|
+
* @public
|
|
451
451
|
*/
|
|
452
452
|
resourceIdentifier?: string;
|
|
453
453
|
/**
|
|
454
|
-
* @public
|
|
455
454
|
* The resource type
|
|
455
|
+
* @public
|
|
456
456
|
*/
|
|
457
457
|
resourceType?: ResourceType;
|
|
458
458
|
/**
|
|
@@ -472,20 +472,20 @@ export declare const ServiceCode: {
|
|
|
472
472
|
*/
|
|
473
473
|
export type ServiceCode = (typeof ServiceCode)[keyof typeof ServiceCode];
|
|
474
474
|
/**
|
|
475
|
-
* @public
|
|
476
475
|
* <p>The request was denied due to request throttling.</p>
|
|
476
|
+
* @public
|
|
477
477
|
*/
|
|
478
478
|
export declare class ThrottlingException extends __BaseException {
|
|
479
479
|
readonly name: "ThrottlingException";
|
|
480
480
|
readonly $fault: "client";
|
|
481
481
|
/**
|
|
482
|
-
* @public
|
|
483
482
|
* Originating service code
|
|
483
|
+
* @public
|
|
484
484
|
*/
|
|
485
485
|
serviceCode: ServiceCode | undefined;
|
|
486
486
|
/**
|
|
487
|
-
* @public
|
|
488
487
|
* Originating quota code
|
|
488
|
+
* @public
|
|
489
489
|
*/
|
|
490
490
|
quotaCode: string | undefined;
|
|
491
491
|
/**
|
|
@@ -494,9 +494,9 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
494
494
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
495
495
|
}
|
|
496
496
|
/**
|
|
497
|
-
* @public
|
|
498
497
|
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
499
498
|
* service.</p>
|
|
499
|
+
* @public
|
|
500
500
|
*/
|
|
501
501
|
export declare class ValidationException extends __BaseException {
|
|
502
502
|
readonly name: "ValidationException";
|
|
@@ -507,14 +507,14 @@ export declare class ValidationException extends __BaseException {
|
|
|
507
507
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
508
508
|
}
|
|
509
509
|
/**
|
|
510
|
-
* @public
|
|
511
510
|
* <p>Used to remove the chat channel from an incident record or response plan.</p>
|
|
511
|
+
* @public
|
|
512
512
|
*/
|
|
513
513
|
export interface EmptyChatChannel {
|
|
514
514
|
}
|
|
515
515
|
/**
|
|
516
|
-
* @public
|
|
517
516
|
* <p>The Chatbot chat channel used for collaboration during an incident.</p>
|
|
517
|
+
* @public
|
|
518
518
|
*/
|
|
519
519
|
export type ChatChannel = ChatChannel.ChatbotSnsMember | ChatChannel.EmptyMember | ChatChannel.$UnknownMember;
|
|
520
520
|
/**
|
|
@@ -522,8 +522,8 @@ export type ChatChannel = ChatChannel.ChatbotSnsMember | ChatChannel.EmptyMember
|
|
|
522
522
|
*/
|
|
523
523
|
export declare namespace ChatChannel {
|
|
524
524
|
/**
|
|
525
|
-
* @public
|
|
526
525
|
* <p>Used to remove the chat channel from an incident record or response plan.</p>
|
|
526
|
+
* @public
|
|
527
527
|
*/
|
|
528
528
|
interface EmptyMember {
|
|
529
529
|
empty: EmptyChatChannel;
|
|
@@ -531,10 +531,10 @@ export declare namespace ChatChannel {
|
|
|
531
531
|
$unknown?: never;
|
|
532
532
|
}
|
|
533
533
|
/**
|
|
534
|
-
* @public
|
|
535
534
|
* <p>The Amazon SNS targets that Chatbot uses to notify the chat channel of
|
|
536
535
|
* updates to an incident. You can also make updates to the incident through the chat channel by
|
|
537
536
|
* using the Amazon SNS topics. </p>
|
|
537
|
+
* @public
|
|
538
538
|
*/
|
|
539
539
|
interface ChatbotSnsMember {
|
|
540
540
|
empty?: never;
|
|
@@ -557,11 +557,11 @@ export declare namespace ChatChannel {
|
|
|
557
557
|
const visit: <T>(value: ChatChannel, visitor: Visitor<T>) => T;
|
|
558
558
|
}
|
|
559
559
|
/**
|
|
560
|
-
* @public
|
|
561
560
|
* <p>A conditional statement with which to compare a value, after a timestamp, before a
|
|
562
561
|
* timestamp, or equal to a string or integer. If multiple conditions are specified, the
|
|
563
562
|
* conditionals become an <code>AND</code>ed statement. If multiple values are specified for a
|
|
564
563
|
* conditional, the values are <code>OR</code>d.</p>
|
|
564
|
+
* @public
|
|
565
565
|
*/
|
|
566
566
|
export type Condition = Condition.AfterMember | Condition.BeforeMember | Condition.EqualsMember | Condition.$UnknownMember;
|
|
567
567
|
/**
|
|
@@ -569,8 +569,8 @@ export type Condition = Condition.AfterMember | Condition.BeforeMember | Conditi
|
|
|
569
569
|
*/
|
|
570
570
|
export declare namespace Condition {
|
|
571
571
|
/**
|
|
572
|
-
* @public
|
|
573
572
|
* <p>Before the specified timestamp</p>
|
|
573
|
+
* @public
|
|
574
574
|
*/
|
|
575
575
|
interface BeforeMember {
|
|
576
576
|
before: Date;
|
|
@@ -579,8 +579,8 @@ export declare namespace Condition {
|
|
|
579
579
|
$unknown?: never;
|
|
580
580
|
}
|
|
581
581
|
/**
|
|
582
|
-
* @public
|
|
583
582
|
* <p>After the specified timestamp.</p>
|
|
583
|
+
* @public
|
|
584
584
|
*/
|
|
585
585
|
interface AfterMember {
|
|
586
586
|
before?: never;
|
|
@@ -589,8 +589,8 @@ export declare namespace Condition {
|
|
|
589
589
|
$unknown?: never;
|
|
590
590
|
}
|
|
591
591
|
/**
|
|
592
|
-
* @public
|
|
593
592
|
* <p>The value is equal to the provided string or integer. </p>
|
|
593
|
+
* @public
|
|
594
594
|
*/
|
|
595
595
|
interface EqualsMember {
|
|
596
596
|
before?: never;
|
|
@@ -616,25 +616,25 @@ export declare namespace Condition {
|
|
|
616
616
|
const visit: <T>(value: Condition, visitor: Visitor<T>) => T;
|
|
617
617
|
}
|
|
618
618
|
/**
|
|
619
|
-
* @public
|
|
620
619
|
* <p>Updating or deleting a resource causes an inconsistent state.</p>
|
|
620
|
+
* @public
|
|
621
621
|
*/
|
|
622
622
|
export declare class ConflictException extends __BaseException {
|
|
623
623
|
readonly name: "ConflictException";
|
|
624
624
|
readonly $fault: "client";
|
|
625
625
|
/**
|
|
626
|
-
* @public
|
|
627
626
|
* The identifier of the requested resource
|
|
627
|
+
* @public
|
|
628
628
|
*/
|
|
629
629
|
resourceIdentifier?: string;
|
|
630
630
|
/**
|
|
631
|
-
* @public
|
|
632
631
|
* The resource type
|
|
632
|
+
* @public
|
|
633
633
|
*/
|
|
634
634
|
resourceType?: ResourceType;
|
|
635
635
|
/**
|
|
636
|
-
* @public
|
|
637
636
|
* If present in the output, the operation can be retried after this time
|
|
637
|
+
* @public
|
|
638
638
|
*/
|
|
639
639
|
retryAfter?: Date;
|
|
640
640
|
/**
|
|
@@ -643,14 +643,14 @@ export declare class ConflictException extends __BaseException {
|
|
|
643
643
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
644
644
|
}
|
|
645
645
|
/**
|
|
646
|
-
* @public
|
|
647
646
|
* <p>The mapping between a Amazon Web Services Region and the key that's used to encrypt the
|
|
648
647
|
* data.</p>
|
|
648
|
+
* @public
|
|
649
649
|
*/
|
|
650
650
|
export interface RegionMapInputValue {
|
|
651
651
|
/**
|
|
652
|
-
* @public
|
|
653
652
|
* <p>The KMS key used to encrypt the data in your replication set.</p>
|
|
653
|
+
* @public
|
|
654
654
|
*/
|
|
655
655
|
sseKmsKeyId?: string;
|
|
656
656
|
}
|
|
@@ -659,20 +659,20 @@ export interface RegionMapInputValue {
|
|
|
659
659
|
*/
|
|
660
660
|
export interface CreateReplicationSetInput {
|
|
661
661
|
/**
|
|
662
|
-
* @public
|
|
663
662
|
* <p>The Regions that Incident Manager replicates your data to. You can have up to three Regions in
|
|
664
663
|
* your replication set.</p>
|
|
664
|
+
* @public
|
|
665
665
|
*/
|
|
666
666
|
regions: Record<string, RegionMapInputValue> | undefined;
|
|
667
667
|
/**
|
|
668
|
-
* @public
|
|
669
668
|
* <p>A token that ensures that the operation is called only once with the specified
|
|
670
669
|
* details.</p>
|
|
670
|
+
* @public
|
|
671
671
|
*/
|
|
672
672
|
clientToken?: string;
|
|
673
673
|
/**
|
|
674
|
-
* @public
|
|
675
674
|
* <p>A list of tags to add to the replication set.</p>
|
|
675
|
+
* @public
|
|
676
676
|
*/
|
|
677
677
|
tags?: Record<string, string>;
|
|
678
678
|
}
|
|
@@ -681,36 +681,36 @@ export interface CreateReplicationSetInput {
|
|
|
681
681
|
*/
|
|
682
682
|
export interface CreateReplicationSetOutput {
|
|
683
683
|
/**
|
|
684
|
-
* @public
|
|
685
684
|
* <p>The Amazon Resource Name (ARN) of the replication set. </p>
|
|
685
|
+
* @public
|
|
686
686
|
*/
|
|
687
687
|
arn: string | undefined;
|
|
688
688
|
}
|
|
689
689
|
/**
|
|
690
|
-
* @public
|
|
691
690
|
* <p>Request would cause a service quota to be exceeded.</p>
|
|
691
|
+
* @public
|
|
692
692
|
*/
|
|
693
693
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
694
694
|
readonly name: "ServiceQuotaExceededException";
|
|
695
695
|
readonly $fault: "client";
|
|
696
696
|
/**
|
|
697
|
-
* @public
|
|
698
697
|
* The identifier for the requested resource
|
|
698
|
+
* @public
|
|
699
699
|
*/
|
|
700
700
|
resourceIdentifier?: string;
|
|
701
701
|
/**
|
|
702
|
-
* @public
|
|
703
702
|
* The resource type
|
|
703
|
+
* @public
|
|
704
704
|
*/
|
|
705
705
|
resourceType?: ResourceType;
|
|
706
706
|
/**
|
|
707
|
-
* @public
|
|
708
707
|
* Originating service code
|
|
708
|
+
* @public
|
|
709
709
|
*/
|
|
710
710
|
serviceCode: ServiceCode | undefined;
|
|
711
711
|
/**
|
|
712
|
-
* @public
|
|
713
712
|
* Originating quota code
|
|
713
|
+
* @public
|
|
714
714
|
*/
|
|
715
715
|
quotaCode: string | undefined;
|
|
716
716
|
/**
|
|
@@ -719,8 +719,8 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
719
719
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
720
720
|
}
|
|
721
721
|
/**
|
|
722
|
-
* @public
|
|
723
722
|
* <p>The SNS targets that are notified when updates are made to an incident.</p>
|
|
723
|
+
* @public
|
|
724
724
|
*/
|
|
725
725
|
export type NotificationTargetItem = NotificationTargetItem.SnsTopicArnMember | NotificationTargetItem.$UnknownMember;
|
|
726
726
|
/**
|
|
@@ -728,8 +728,8 @@ export type NotificationTargetItem = NotificationTargetItem.SnsTopicArnMember |
|
|
|
728
728
|
*/
|
|
729
729
|
export declare namespace NotificationTargetItem {
|
|
730
730
|
/**
|
|
731
|
-
* @public
|
|
732
731
|
* <p>The Amazon Resource Name (ARN) of the SNS topic.</p>
|
|
732
|
+
* @public
|
|
733
733
|
*/
|
|
734
734
|
interface SnsTopicArnMember {
|
|
735
735
|
snsTopicArn: string;
|
|
@@ -749,18 +749,17 @@ export declare namespace NotificationTargetItem {
|
|
|
749
749
|
const visit: <T>(value: NotificationTargetItem, visitor: Visitor<T>) => T;
|
|
750
750
|
}
|
|
751
751
|
/**
|
|
752
|
-
* @public
|
|
753
752
|
* <p>Basic details used in creating a response plan. The response plan is then used to create
|
|
754
753
|
* an incident record.</p>
|
|
754
|
+
* @public
|
|
755
755
|
*/
|
|
756
756
|
export interface IncidentTemplate {
|
|
757
757
|
/**
|
|
758
|
-
* @public
|
|
759
758
|
* <p>The title of the incident. </p>
|
|
759
|
+
* @public
|
|
760
760
|
*/
|
|
761
761
|
title: string | undefined;
|
|
762
762
|
/**
|
|
763
|
-
* @public
|
|
764
763
|
* <p>The impact of the incident on your customers and applications.</p>
|
|
765
764
|
* <p class="title">
|
|
766
765
|
* <b>Supported impact codes</b>
|
|
@@ -787,16 +786,16 @@ export interface IncidentTemplate {
|
|
|
787
786
|
* <code>5</code> - No Impact</p>
|
|
788
787
|
* </li>
|
|
789
788
|
* </ul>
|
|
789
|
+
* @public
|
|
790
790
|
*/
|
|
791
791
|
impact: number | undefined;
|
|
792
792
|
/**
|
|
793
|
-
* @public
|
|
794
793
|
* <p>The summary of the incident. The summary is a brief synopsis of what occurred, what's
|
|
795
794
|
* currently happening, and context.</p>
|
|
795
|
+
* @public
|
|
796
796
|
*/
|
|
797
797
|
summary?: string;
|
|
798
798
|
/**
|
|
799
|
-
* @public
|
|
800
799
|
* <p>The string Incident Manager uses to prevent the same root cause from creating multiple
|
|
801
800
|
* incidents in the same account.</p>
|
|
802
801
|
* <p>A deduplication string is a term or phrase the system uses to check for duplicate
|
|
@@ -809,58 +808,59 @@ export interface IncidentTemplate {
|
|
|
809
808
|
* same Amazon CloudWatch alarm or Amazon EventBridge event. You don't have to enter
|
|
810
809
|
* your own deduplication string to prevent duplication for these resource types.</p>
|
|
811
810
|
* </note>
|
|
811
|
+
* @public
|
|
812
812
|
*/
|
|
813
813
|
dedupeString?: string;
|
|
814
814
|
/**
|
|
815
|
-
* @public
|
|
816
815
|
* <p>The Amazon SNS targets that are notified when updates are made to an
|
|
817
816
|
* incident.</p>
|
|
817
|
+
* @public
|
|
818
818
|
*/
|
|
819
819
|
notificationTargets?: NotificationTargetItem[];
|
|
820
820
|
/**
|
|
821
|
-
* @public
|
|
822
821
|
* <p>Tags to assign to the template. When the <code>StartIncident</code> API action is called,
|
|
823
822
|
* Incident Manager assigns the tags specified in the template to the incident.</p>
|
|
823
|
+
* @public
|
|
824
824
|
*/
|
|
825
825
|
incidentTags?: Record<string, string>;
|
|
826
826
|
}
|
|
827
827
|
/**
|
|
828
|
-
* @public
|
|
829
828
|
* <p>Details about the PagerDuty service where the response plan creates an incident.</p>
|
|
829
|
+
* @public
|
|
830
830
|
*/
|
|
831
831
|
export interface PagerDutyIncidentConfiguration {
|
|
832
832
|
/**
|
|
833
|
-
* @public
|
|
834
833
|
* <p>The ID of the PagerDuty service that the response plan associates with an incident when it
|
|
835
834
|
* launches.</p>
|
|
835
|
+
* @public
|
|
836
836
|
*/
|
|
837
837
|
serviceId: string | undefined;
|
|
838
838
|
}
|
|
839
839
|
/**
|
|
840
|
-
* @public
|
|
841
840
|
* <p>Details about the PagerDuty configuration for a response plan.</p>
|
|
841
|
+
* @public
|
|
842
842
|
*/
|
|
843
843
|
export interface PagerDutyConfiguration {
|
|
844
844
|
/**
|
|
845
|
-
* @public
|
|
846
845
|
* <p>The name of the PagerDuty configuration.</p>
|
|
846
|
+
* @public
|
|
847
847
|
*/
|
|
848
848
|
name: string | undefined;
|
|
849
849
|
/**
|
|
850
|
-
* @public
|
|
851
850
|
* <p>The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or
|
|
852
851
|
* User Token REST API Key, and other user credentials.</p>
|
|
852
|
+
* @public
|
|
853
853
|
*/
|
|
854
854
|
secretId: string | undefined;
|
|
855
855
|
/**
|
|
856
|
-
* @public
|
|
857
856
|
* <p>Details about the PagerDuty service associated with the configuration.</p>
|
|
857
|
+
* @public
|
|
858
858
|
*/
|
|
859
859
|
pagerDutyIncidentConfiguration: PagerDutyIncidentConfiguration | undefined;
|
|
860
860
|
}
|
|
861
861
|
/**
|
|
862
|
-
* @public
|
|
863
862
|
* <p>Information about third-party services integrated into a response plan.</p>
|
|
863
|
+
* @public
|
|
864
864
|
*/
|
|
865
865
|
export type Integration = Integration.PagerDutyConfigurationMember | Integration.$UnknownMember;
|
|
866
866
|
/**
|
|
@@ -868,9 +868,9 @@ export type Integration = Integration.PagerDutyConfigurationMember | Integration
|
|
|
868
868
|
*/
|
|
869
869
|
export declare namespace Integration {
|
|
870
870
|
/**
|
|
871
|
-
* @public
|
|
872
871
|
* <p>Information about the PagerDuty service where the response plan creates an
|
|
873
872
|
* incident.</p>
|
|
873
|
+
* @public
|
|
874
874
|
*/
|
|
875
875
|
interface PagerDutyConfigurationMember {
|
|
876
876
|
pagerDutyConfiguration: PagerDutyConfiguration;
|
|
@@ -894,49 +894,49 @@ export declare namespace Integration {
|
|
|
894
894
|
*/
|
|
895
895
|
export interface CreateResponsePlanInput {
|
|
896
896
|
/**
|
|
897
|
-
* @public
|
|
898
897
|
* <p>A token ensuring that the operation is called only once with the specified details.</p>
|
|
898
|
+
* @public
|
|
899
899
|
*/
|
|
900
900
|
clientToken?: string;
|
|
901
901
|
/**
|
|
902
|
-
* @public
|
|
903
902
|
* <p>The short format name of the response plan. Can't include spaces.</p>
|
|
903
|
+
* @public
|
|
904
904
|
*/
|
|
905
905
|
name: string | undefined;
|
|
906
906
|
/**
|
|
907
|
-
* @public
|
|
908
907
|
* <p>The long format of the response plan name. This field can contain spaces.</p>
|
|
908
|
+
* @public
|
|
909
909
|
*/
|
|
910
910
|
displayName?: string;
|
|
911
911
|
/**
|
|
912
|
-
* @public
|
|
913
912
|
* <p>Details used to create an incident when using this response plan.</p>
|
|
913
|
+
* @public
|
|
914
914
|
*/
|
|
915
915
|
incidentTemplate: IncidentTemplate | undefined;
|
|
916
916
|
/**
|
|
917
|
-
* @public
|
|
918
917
|
* <p>The Chatbot chat channel used for collaboration during an incident.</p>
|
|
918
|
+
* @public
|
|
919
919
|
*/
|
|
920
920
|
chatChannel?: ChatChannel;
|
|
921
921
|
/**
|
|
922
|
-
* @public
|
|
923
922
|
* <p>The Amazon Resource Name (ARN) for the contacts and escalation plans that the response
|
|
924
923
|
* plan engages during an incident.</p>
|
|
924
|
+
* @public
|
|
925
925
|
*/
|
|
926
926
|
engagements?: string[];
|
|
927
927
|
/**
|
|
928
|
-
* @public
|
|
929
928
|
* <p>The actions that the response plan starts at the beginning of an incident.</p>
|
|
929
|
+
* @public
|
|
930
930
|
*/
|
|
931
931
|
actions?: Action[];
|
|
932
932
|
/**
|
|
933
|
-
* @public
|
|
934
933
|
* <p>A list of tags that you are adding to the response plan.</p>
|
|
934
|
+
* @public
|
|
935
935
|
*/
|
|
936
936
|
tags?: Record<string, string>;
|
|
937
937
|
/**
|
|
938
|
-
* @public
|
|
939
938
|
* <p>Information about third-party services integrated into the response plan.</p>
|
|
939
|
+
* @public
|
|
940
940
|
*/
|
|
941
941
|
integrations?: Integration[];
|
|
942
942
|
}
|
|
@@ -945,15 +945,15 @@ export interface CreateResponsePlanInput {
|
|
|
945
945
|
*/
|
|
946
946
|
export interface CreateResponsePlanOutput {
|
|
947
947
|
/**
|
|
948
|
-
* @public
|
|
949
948
|
* <p>The Amazon Resource Name (ARN) of the response plan.</p>
|
|
949
|
+
* @public
|
|
950
950
|
*/
|
|
951
951
|
arn: string | undefined;
|
|
952
952
|
}
|
|
953
953
|
/**
|
|
954
|
-
* @public
|
|
955
954
|
* <p>An item referenced in a <code>TimelineEvent</code> that is involved in or somehow
|
|
956
955
|
* 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>
|
|
956
|
+
* @public
|
|
957
957
|
*/
|
|
958
958
|
export type EventReference = EventReference.RelatedItemIdMember | EventReference.ResourceMember | EventReference.$UnknownMember;
|
|
959
959
|
/**
|
|
@@ -961,9 +961,9 @@ export type EventReference = EventReference.RelatedItemIdMember | EventReference
|
|
|
961
961
|
*/
|
|
962
962
|
export declare namespace EventReference {
|
|
963
963
|
/**
|
|
964
|
-
* @public
|
|
965
964
|
* <p>The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a
|
|
966
965
|
* <code>TimelineEvent</code>.</p>
|
|
966
|
+
* @public
|
|
967
967
|
*/
|
|
968
968
|
interface ResourceMember {
|
|
969
969
|
resource: string;
|
|
@@ -971,8 +971,8 @@ export declare namespace EventReference {
|
|
|
971
971
|
$unknown?: never;
|
|
972
972
|
}
|
|
973
973
|
/**
|
|
974
|
-
* @public
|
|
975
974
|
* <p>The ID of a <code>RelatedItem</code> referenced in a <code>TimelineEvent</code>.</p>
|
|
975
|
+
* @public
|
|
976
976
|
*/
|
|
977
977
|
interface RelatedItemIdMember {
|
|
978
978
|
resource?: never;
|
|
@@ -999,43 +999,43 @@ export declare namespace EventReference {
|
|
|
999
999
|
*/
|
|
1000
1000
|
export interface CreateTimelineEventInput {
|
|
1001
1001
|
/**
|
|
1002
|
-
* @public
|
|
1003
1002
|
* <p>A token that ensures that a client calls the action only once with the specified
|
|
1004
1003
|
* details.</p>
|
|
1004
|
+
* @public
|
|
1005
1005
|
*/
|
|
1006
1006
|
clientToken?: string;
|
|
1007
1007
|
/**
|
|
1008
|
-
* @public
|
|
1009
1008
|
* <p>The Amazon Resource Name (ARN) of the incident record that the action adds the incident
|
|
1010
1009
|
* to.</p>
|
|
1010
|
+
* @public
|
|
1011
1011
|
*/
|
|
1012
1012
|
incidentRecordArn: string | undefined;
|
|
1013
1013
|
/**
|
|
1014
|
-
* @public
|
|
1015
1014
|
* <p>The timestamp for when the event occurred.</p>
|
|
1015
|
+
* @public
|
|
1016
1016
|
*/
|
|
1017
1017
|
eventTime: Date | undefined;
|
|
1018
1018
|
/**
|
|
1019
|
-
* @public
|
|
1020
1019
|
* <p>The type of event. You can create timeline events of type <code>Custom Event</code> and
|
|
1021
1020
|
* <code>Note</code>.</p>
|
|
1022
1021
|
* <p>To make a Note-type event appear on the <i>Incident notes</i> panel in the
|
|
1023
1022
|
* console, specify <code>eventType</code> as <code>Note</code>and enter the Amazon Resource Name
|
|
1024
1023
|
* (ARN) of the incident as the value for <code>eventReference</code>.</p>
|
|
1024
|
+
* @public
|
|
1025
1025
|
*/
|
|
1026
1026
|
eventType: string | undefined;
|
|
1027
1027
|
/**
|
|
1028
|
-
* @public
|
|
1029
1028
|
* <p>A short description of the event.</p>
|
|
1029
|
+
* @public
|
|
1030
1030
|
*/
|
|
1031
1031
|
eventData: string | undefined;
|
|
1032
1032
|
/**
|
|
1033
|
-
* @public
|
|
1034
1033
|
* <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
|
|
1035
1034
|
* its Amazon Resource Name (ARN). You can also specify a related item associated with a
|
|
1036
1035
|
* resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a
|
|
1037
1036
|
* resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated
|
|
1038
1037
|
* with the DynamoDB table as a related item.</p>
|
|
1038
|
+
* @public
|
|
1039
1039
|
*/
|
|
1040
1040
|
eventReferences?: EventReference[];
|
|
1041
1041
|
}
|
|
@@ -1044,13 +1044,13 @@ export interface CreateTimelineEventInput {
|
|
|
1044
1044
|
*/
|
|
1045
1045
|
export interface CreateTimelineEventOutput {
|
|
1046
1046
|
/**
|
|
1047
|
-
* @public
|
|
1048
1047
|
* <p>The ARN of the incident record that you added the event to.</p>
|
|
1048
|
+
* @public
|
|
1049
1049
|
*/
|
|
1050
1050
|
incidentRecordArn: string | undefined;
|
|
1051
1051
|
/**
|
|
1052
|
-
* @public
|
|
1053
1052
|
* <p>The ID of the event for easy reference later. </p>
|
|
1053
|
+
* @public
|
|
1054
1054
|
*/
|
|
1055
1055
|
eventId: string | undefined;
|
|
1056
1056
|
}
|
|
@@ -1059,8 +1059,8 @@ export interface CreateTimelineEventOutput {
|
|
|
1059
1059
|
*/
|
|
1060
1060
|
export interface DeleteIncidentRecordInput {
|
|
1061
1061
|
/**
|
|
1062
|
-
* @public
|
|
1063
1062
|
* <p>The Amazon Resource Name (ARN) of the incident record you are deleting.</p>
|
|
1063
|
+
* @public
|
|
1064
1064
|
*/
|
|
1065
1065
|
arn: string | undefined;
|
|
1066
1066
|
}
|
|
@@ -1070,14 +1070,14 @@ export interface DeleteIncidentRecordInput {
|
|
|
1070
1070
|
export interface DeleteIncidentRecordOutput {
|
|
1071
1071
|
}
|
|
1072
1072
|
/**
|
|
1073
|
-
* @public
|
|
1074
1073
|
* <p>Defines the information about the Amazon Web Services Region you're deleting from your
|
|
1075
1074
|
* replication set.</p>
|
|
1075
|
+
* @public
|
|
1076
1076
|
*/
|
|
1077
1077
|
export interface DeleteRegionAction {
|
|
1078
1078
|
/**
|
|
1079
|
-
* @public
|
|
1080
1079
|
* <p>The name of the Amazon Web Services Region you're deleting from the replication set.</p>
|
|
1080
|
+
* @public
|
|
1081
1081
|
*/
|
|
1082
1082
|
regionName: string | undefined;
|
|
1083
1083
|
}
|
|
@@ -1086,8 +1086,8 @@ export interface DeleteRegionAction {
|
|
|
1086
1086
|
*/
|
|
1087
1087
|
export interface DeleteReplicationSetInput {
|
|
1088
1088
|
/**
|
|
1089
|
-
* @public
|
|
1090
1089
|
* <p>The Amazon Resource Name (ARN) of the replication set you're deleting.</p>
|
|
1090
|
+
* @public
|
|
1091
1091
|
*/
|
|
1092
1092
|
arn: string | undefined;
|
|
1093
1093
|
}
|
|
@@ -1101,13 +1101,13 @@ export interface DeleteReplicationSetOutput {
|
|
|
1101
1101
|
*/
|
|
1102
1102
|
export interface DeleteResourcePolicyInput {
|
|
1103
1103
|
/**
|
|
1104
|
-
* @public
|
|
1105
1104
|
* <p>The Amazon Resource Name (ARN) of the resource you're deleting the policy from.</p>
|
|
1105
|
+
* @public
|
|
1106
1106
|
*/
|
|
1107
1107
|
resourceArn: string | undefined;
|
|
1108
1108
|
/**
|
|
1109
|
-
* @public
|
|
1110
1109
|
* <p>The ID of the resource policy you're deleting.</p>
|
|
1110
|
+
* @public
|
|
1111
1111
|
*/
|
|
1112
1112
|
policyId: string | undefined;
|
|
1113
1113
|
}
|
|
@@ -1121,8 +1121,8 @@ export interface DeleteResourcePolicyOutput {
|
|
|
1121
1121
|
*/
|
|
1122
1122
|
export interface DeleteResponsePlanInput {
|
|
1123
1123
|
/**
|
|
1124
|
-
* @public
|
|
1125
1124
|
* <p>The Amazon Resource Name (ARN) of the response plan.</p>
|
|
1125
|
+
* @public
|
|
1126
1126
|
*/
|
|
1127
1127
|
arn: string | undefined;
|
|
1128
1128
|
}
|
|
@@ -1136,14 +1136,14 @@ export interface DeleteResponsePlanOutput {
|
|
|
1136
1136
|
*/
|
|
1137
1137
|
export interface DeleteTimelineEventInput {
|
|
1138
1138
|
/**
|
|
1139
|
-
* @public
|
|
1140
1139
|
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
|
|
1140
|
+
* @public
|
|
1141
1141
|
*/
|
|
1142
1142
|
incidentRecordArn: string | undefined;
|
|
1143
1143
|
/**
|
|
1144
|
-
* @public
|
|
1145
1144
|
* <p>The ID of the event to update. You can use <code>ListTimelineEvents</code> to find an
|
|
1146
1145
|
* event's ID.</p>
|
|
1146
|
+
* @public
|
|
1147
1147
|
*/
|
|
1148
1148
|
eventId: string | undefined;
|
|
1149
1149
|
}
|
|
@@ -1153,72 +1153,72 @@ export interface DeleteTimelineEventInput {
|
|
|
1153
1153
|
export interface DeleteTimelineEventOutput {
|
|
1154
1154
|
}
|
|
1155
1155
|
/**
|
|
1156
|
-
* @public
|
|
1157
1156
|
* <p>Details about a timeline event during an incident.</p>
|
|
1157
|
+
* @public
|
|
1158
1158
|
*/
|
|
1159
1159
|
export interface EventSummary {
|
|
1160
1160
|
/**
|
|
1161
|
-
* @public
|
|
1162
1161
|
* <p>The Amazon Resource Name (ARN) of the incident that the event happened during.</p>
|
|
1162
|
+
* @public
|
|
1163
1163
|
*/
|
|
1164
1164
|
incidentRecordArn: string | undefined;
|
|
1165
1165
|
/**
|
|
1166
|
-
* @public
|
|
1167
1166
|
* <p>The timeline event ID.</p>
|
|
1167
|
+
* @public
|
|
1168
1168
|
*/
|
|
1169
1169
|
eventId: string | undefined;
|
|
1170
1170
|
/**
|
|
1171
|
-
* @public
|
|
1172
1171
|
* <p>The timestamp for when the event occurred.</p>
|
|
1172
|
+
* @public
|
|
1173
1173
|
*/
|
|
1174
1174
|
eventTime: Date | undefined;
|
|
1175
1175
|
/**
|
|
1176
|
-
* @public
|
|
1177
1176
|
* <p>The timestamp for when the timeline event was last updated.</p>
|
|
1177
|
+
* @public
|
|
1178
1178
|
*/
|
|
1179
1179
|
eventUpdatedTime: Date | undefined;
|
|
1180
1180
|
/**
|
|
1181
|
-
* @public
|
|
1182
1181
|
* <p>The type of event. The timeline event must be <code>Custom Event</code> or
|
|
1183
1182
|
* <code>Note</code>.</p>
|
|
1183
|
+
* @public
|
|
1184
1184
|
*/
|
|
1185
1185
|
eventType: string | undefined;
|
|
1186
1186
|
/**
|
|
1187
|
-
* @public
|
|
1188
1187
|
* <p>A list of references in a <code>TimelineEvent</code>.</p>
|
|
1188
|
+
* @public
|
|
1189
1189
|
*/
|
|
1190
1190
|
eventReferences?: EventReference[];
|
|
1191
1191
|
}
|
|
1192
1192
|
/**
|
|
1193
|
-
* @public
|
|
1194
1193
|
* <p>Filter the selection by using a condition.</p>
|
|
1194
|
+
* @public
|
|
1195
1195
|
*/
|
|
1196
1196
|
export interface Filter {
|
|
1197
1197
|
/**
|
|
1198
|
-
* @public
|
|
1199
1198
|
* <p>The key that you're filtering on.</p>
|
|
1199
|
+
* @public
|
|
1200
1200
|
*/
|
|
1201
1201
|
key: string | undefined;
|
|
1202
1202
|
/**
|
|
1203
|
-
* @public
|
|
1204
1203
|
* <p>The condition accepts before or after a specified time, equal to a string, or equal to an
|
|
1205
1204
|
* integer.</p>
|
|
1205
|
+
* @public
|
|
1206
1206
|
*/
|
|
1207
1207
|
condition: Condition | undefined;
|
|
1208
1208
|
}
|
|
1209
1209
|
/**
|
|
1210
|
-
* @public
|
|
1211
1210
|
* <p>Identifying information about the finding.</p>
|
|
1211
|
+
* @public
|
|
1212
1212
|
*/
|
|
1213
1213
|
export interface FindingSummary {
|
|
1214
1214
|
/**
|
|
1215
|
-
* @public
|
|
1216
1215
|
* <p>The ID of the finding.</p>
|
|
1216
|
+
* @public
|
|
1217
1217
|
*/
|
|
1218
1218
|
id: string | undefined;
|
|
1219
1219
|
/**
|
|
1220
|
-
* @public
|
|
1221
1220
|
* <p>The timestamp for when the finding was last updated.</p>
|
|
1221
|
+
* @public
|
|
1222
1222
|
*/
|
|
1223
1223
|
lastModifiedTime: Date | undefined;
|
|
1224
1224
|
}
|
|
@@ -1227,37 +1227,37 @@ export interface FindingSummary {
|
|
|
1227
1227
|
*/
|
|
1228
1228
|
export interface GetIncidentRecordInput {
|
|
1229
1229
|
/**
|
|
1230
|
-
* @public
|
|
1231
1230
|
* <p>The Amazon Resource Name (ARN) of the incident record.</p>
|
|
1231
|
+
* @public
|
|
1232
1232
|
*/
|
|
1233
1233
|
arn: string | undefined;
|
|
1234
1234
|
}
|
|
1235
1235
|
/**
|
|
1236
|
-
* @public
|
|
1237
1236
|
* <p>Details about what created the incident record and when it was created.</p>
|
|
1237
|
+
* @public
|
|
1238
1238
|
*/
|
|
1239
1239
|
export interface IncidentRecordSource {
|
|
1240
1240
|
/**
|
|
1241
|
-
* @public
|
|
1242
1241
|
* <p>The principal that started the incident.</p>
|
|
1242
|
+
* @public
|
|
1243
1243
|
*/
|
|
1244
1244
|
createdBy: string | undefined;
|
|
1245
1245
|
/**
|
|
1246
|
-
* @public
|
|
1247
1246
|
* <p>The service principal that assumed the role specified in <code>createdBy</code>. If no
|
|
1248
1247
|
* service principal assumed the role this will be left blank.</p>
|
|
1248
|
+
* @public
|
|
1249
1249
|
*/
|
|
1250
1250
|
invokedBy?: string;
|
|
1251
1251
|
/**
|
|
1252
|
-
* @public
|
|
1253
1252
|
* <p>The resource that caused the incident to be created.</p>
|
|
1253
|
+
* @public
|
|
1254
1254
|
*/
|
|
1255
1255
|
resourceArn?: string;
|
|
1256
1256
|
/**
|
|
1257
|
-
* @public
|
|
1258
1257
|
* <p>The service that started the incident. This can be manually created from Incident Manager,
|
|
1259
1258
|
* automatically created using an Amazon CloudWatch alarm, or Amazon EventBridge
|
|
1260
1259
|
* event.</p>
|
|
1260
|
+
* @public
|
|
1261
1261
|
*/
|
|
1262
1262
|
source: string | undefined;
|
|
1263
1263
|
}
|
|
@@ -1274,33 +1274,32 @@ export declare const IncidentRecordStatus: {
|
|
|
1274
1274
|
*/
|
|
1275
1275
|
export type IncidentRecordStatus = (typeof IncidentRecordStatus)[keyof typeof IncidentRecordStatus];
|
|
1276
1276
|
/**
|
|
1277
|
-
* @public
|
|
1278
1277
|
* <p>The record of the incident that's created when an incident occurs.</p>
|
|
1278
|
+
* @public
|
|
1279
1279
|
*/
|
|
1280
1280
|
export interface IncidentRecord {
|
|
1281
1281
|
/**
|
|
1282
|
-
* @public
|
|
1283
1282
|
* <p>The Amazon Resource Name (ARN) of the incident record.</p>
|
|
1283
|
+
* @public
|
|
1284
1284
|
*/
|
|
1285
1285
|
arn: string | undefined;
|
|
1286
1286
|
/**
|
|
1287
|
-
* @public
|
|
1288
1287
|
* <p>The title of the incident.</p>
|
|
1288
|
+
* @public
|
|
1289
1289
|
*/
|
|
1290
1290
|
title: string | undefined;
|
|
1291
1291
|
/**
|
|
1292
|
-
* @public
|
|
1293
1292
|
* <p>The summary of the incident. The summary is a brief synopsis of what occurred, what's
|
|
1294
1293
|
* currently happening, and context of the incident.</p>
|
|
1294
|
+
* @public
|
|
1295
1295
|
*/
|
|
1296
1296
|
summary?: string;
|
|
1297
1297
|
/**
|
|
1298
|
-
* @public
|
|
1299
1298
|
* <p>The current status of the incident.</p>
|
|
1299
|
+
* @public
|
|
1300
1300
|
*/
|
|
1301
1301
|
status: IncidentRecordStatus | undefined;
|
|
1302
1302
|
/**
|
|
1303
|
-
* @public
|
|
1304
1303
|
* <p>The impact of the incident on customers and applications.</p>
|
|
1305
1304
|
* <p class="title">
|
|
1306
1305
|
* <b>Supported impact codes</b>
|
|
@@ -1327,53 +1326,54 @@ export interface IncidentRecord {
|
|
|
1327
1326
|
* <code>5</code> - No Impact</p>
|
|
1328
1327
|
* </li>
|
|
1329
1328
|
* </ul>
|
|
1329
|
+
* @public
|
|
1330
1330
|
*/
|
|
1331
1331
|
impact: number | undefined;
|
|
1332
1332
|
/**
|
|
1333
|
-
* @public
|
|
1334
1333
|
* <p>The timestamp for when Incident Manager created the incident record.</p>
|
|
1334
|
+
* @public
|
|
1335
1335
|
*/
|
|
1336
1336
|
creationTime: Date | undefined;
|
|
1337
1337
|
/**
|
|
1338
|
-
* @public
|
|
1339
1338
|
* <p>The timestamp for when the incident was resolved. This appears as a timeline event.</p>
|
|
1339
|
+
* @public
|
|
1340
1340
|
*/
|
|
1341
1341
|
resolvedTime?: Date;
|
|
1342
1342
|
/**
|
|
1343
|
-
* @public
|
|
1344
1343
|
* <p>The timestamp for when the incident was most recently modified.</p>
|
|
1344
|
+
* @public
|
|
1345
1345
|
*/
|
|
1346
1346
|
lastModifiedTime: Date | undefined;
|
|
1347
1347
|
/**
|
|
1348
|
-
* @public
|
|
1349
1348
|
* <p>Who modified the incident most recently.</p>
|
|
1349
|
+
* @public
|
|
1350
1350
|
*/
|
|
1351
1351
|
lastModifiedBy: string | undefined;
|
|
1352
1352
|
/**
|
|
1353
|
-
* @public
|
|
1354
1353
|
* <p>The runbook, or automation document, that's run at the beginning of the incident.</p>
|
|
1354
|
+
* @public
|
|
1355
1355
|
*/
|
|
1356
1356
|
automationExecutions?: AutomationExecution[];
|
|
1357
1357
|
/**
|
|
1358
|
-
* @public
|
|
1359
1358
|
* <p>Details about the action that started the incident.</p>
|
|
1359
|
+
* @public
|
|
1360
1360
|
*/
|
|
1361
1361
|
incidentRecordSource: IncidentRecordSource | undefined;
|
|
1362
1362
|
/**
|
|
1363
|
-
* @public
|
|
1364
1363
|
* <p>The string Incident Manager uses to prevent duplicate incidents from being created by the same
|
|
1365
1364
|
* incident in the same account.</p>
|
|
1365
|
+
* @public
|
|
1366
1366
|
*/
|
|
1367
1367
|
dedupeString: string | undefined;
|
|
1368
1368
|
/**
|
|
1369
|
-
* @public
|
|
1370
1369
|
* <p>The chat channel used for collaboration during an incident.</p>
|
|
1370
|
+
* @public
|
|
1371
1371
|
*/
|
|
1372
1372
|
chatChannel?: ChatChannel;
|
|
1373
1373
|
/**
|
|
1374
|
-
* @public
|
|
1375
1374
|
* <p>The Amazon SNS targets that are notified when updates are made to an
|
|
1376
1375
|
* incident.</p>
|
|
1376
|
+
* @public
|
|
1377
1377
|
*/
|
|
1378
1378
|
notificationTargets?: NotificationTargetItem[];
|
|
1379
1379
|
}
|
|
@@ -1382,8 +1382,8 @@ export interface IncidentRecord {
|
|
|
1382
1382
|
*/
|
|
1383
1383
|
export interface GetIncidentRecordOutput {
|
|
1384
1384
|
/**
|
|
1385
|
-
* @public
|
|
1386
1385
|
* <p>Details the structure of the incident record.</p>
|
|
1386
|
+
* @public
|
|
1387
1387
|
*/
|
|
1388
1388
|
incidentRecord: IncidentRecord | undefined;
|
|
1389
1389
|
}
|
|
@@ -1392,8 +1392,8 @@ export interface GetIncidentRecordOutput {
|
|
|
1392
1392
|
*/
|
|
1393
1393
|
export interface GetReplicationSetInput {
|
|
1394
1394
|
/**
|
|
1395
|
-
* @public
|
|
1396
1395
|
* <p>The Amazon Resource Name (ARN) of the replication set you want to retrieve.</p>
|
|
1396
|
+
* @public
|
|
1397
1397
|
*/
|
|
1398
1398
|
arn: string | undefined;
|
|
1399
1399
|
}
|
|
@@ -1424,28 +1424,28 @@ export declare const RegionStatus: {
|
|
|
1424
1424
|
*/
|
|
1425
1425
|
export type RegionStatus = (typeof RegionStatus)[keyof typeof RegionStatus];
|
|
1426
1426
|
/**
|
|
1427
|
-
* @public
|
|
1428
1427
|
* <p>Information about a Amazon Web Services Region in your replication set.</p>
|
|
1428
|
+
* @public
|
|
1429
1429
|
*/
|
|
1430
1430
|
export interface RegionInfo {
|
|
1431
1431
|
/**
|
|
1432
|
-
* @public
|
|
1433
1432
|
* <p>The ID of the KMS key used to encrypt the data in this Amazon Web Services Region.</p>
|
|
1433
|
+
* @public
|
|
1434
1434
|
*/
|
|
1435
1435
|
sseKmsKeyId?: string;
|
|
1436
1436
|
/**
|
|
1437
|
-
* @public
|
|
1438
1437
|
* <p>The status of the Amazon Web Services Region in the replication set.</p>
|
|
1438
|
+
* @public
|
|
1439
1439
|
*/
|
|
1440
1440
|
status: RegionStatus | undefined;
|
|
1441
1441
|
/**
|
|
1442
|
-
* @public
|
|
1443
1442
|
* <p>Information displayed about the status of the Amazon Web Services Region.</p>
|
|
1443
|
+
* @public
|
|
1444
1444
|
*/
|
|
1445
1445
|
statusMessage?: string;
|
|
1446
1446
|
/**
|
|
1447
|
-
* @public
|
|
1448
1447
|
* <p>The timestamp for when Incident Manager updated the status of the Amazon Web Services Region.</p>
|
|
1448
|
+
* @public
|
|
1449
1449
|
*/
|
|
1450
1450
|
statusUpdateDateTime: Date | undefined;
|
|
1451
1451
|
}
|
|
@@ -1480,52 +1480,52 @@ export declare const ReplicationSetStatus: {
|
|
|
1480
1480
|
*/
|
|
1481
1481
|
export type ReplicationSetStatus = (typeof ReplicationSetStatus)[keyof typeof ReplicationSetStatus];
|
|
1482
1482
|
/**
|
|
1483
|
-
* @public
|
|
1484
1483
|
* <p>The set of Amazon Web Services Region that your Incident Manager data will be replicated to and
|
|
1485
1484
|
* the KMS key used to encrypt the data. </p>
|
|
1485
|
+
* @public
|
|
1486
1486
|
*/
|
|
1487
1487
|
export interface ReplicationSet {
|
|
1488
1488
|
/**
|
|
1489
|
-
* @public
|
|
1490
1489
|
* <p>The Amazon Resource Name (ARN) of the replication set.</p>
|
|
1490
|
+
* @public
|
|
1491
1491
|
*/
|
|
1492
1492
|
arn?: string;
|
|
1493
1493
|
/**
|
|
1494
|
-
* @public
|
|
1495
1494
|
* <p>The map between each Amazon Web Services Region in your replication set and the KMS key that's used to encrypt the data in that Region.</p>
|
|
1495
|
+
* @public
|
|
1496
1496
|
*/
|
|
1497
1497
|
regionMap: Record<string, RegionInfo> | undefined;
|
|
1498
1498
|
/**
|
|
1499
|
-
* @public
|
|
1500
1499
|
* <p>The status of the replication set. If the replication set is still pending, you can't use
|
|
1501
1500
|
* Incident Manager functionality.</p>
|
|
1501
|
+
* @public
|
|
1502
1502
|
*/
|
|
1503
1503
|
status: ReplicationSetStatus | undefined;
|
|
1504
1504
|
/**
|
|
1505
|
-
* @public
|
|
1506
1505
|
* <p>Determines if the replication set deletion protection is enabled or not. If deletion
|
|
1507
1506
|
* protection is enabled, you can't delete the last Amazon Web Services Region in the replication
|
|
1508
1507
|
* set. </p>
|
|
1508
|
+
* @public
|
|
1509
1509
|
*/
|
|
1510
1510
|
deletionProtected: boolean | undefined;
|
|
1511
1511
|
/**
|
|
1512
|
-
* @public
|
|
1513
1512
|
* <p>When the replication set was created.</p>
|
|
1513
|
+
* @public
|
|
1514
1514
|
*/
|
|
1515
1515
|
createdTime: Date | undefined;
|
|
1516
1516
|
/**
|
|
1517
|
-
* @public
|
|
1518
1517
|
* <p>Details about who created the replication set.</p>
|
|
1518
|
+
* @public
|
|
1519
1519
|
*/
|
|
1520
1520
|
createdBy: string | undefined;
|
|
1521
1521
|
/**
|
|
1522
|
-
* @public
|
|
1523
1522
|
* <p>When the replication set was last updated.</p>
|
|
1523
|
+
* @public
|
|
1524
1524
|
*/
|
|
1525
1525
|
lastModifiedTime: Date | undefined;
|
|
1526
1526
|
/**
|
|
1527
|
-
* @public
|
|
1528
1527
|
* <p>Who last modified the replication set.</p>
|
|
1528
|
+
* @public
|
|
1529
1529
|
*/
|
|
1530
1530
|
lastModifiedBy: string | undefined;
|
|
1531
1531
|
}
|
|
@@ -1534,8 +1534,8 @@ export interface ReplicationSet {
|
|
|
1534
1534
|
*/
|
|
1535
1535
|
export interface GetReplicationSetOutput {
|
|
1536
1536
|
/**
|
|
1537
|
-
* @public
|
|
1538
1537
|
* <p>Details of the replication set.</p>
|
|
1538
|
+
* @public
|
|
1539
1539
|
*/
|
|
1540
1540
|
replicationSet: ReplicationSet | undefined;
|
|
1541
1541
|
}
|
|
@@ -1544,42 +1544,42 @@ export interface GetReplicationSetOutput {
|
|
|
1544
1544
|
*/
|
|
1545
1545
|
export interface GetResourcePoliciesInput {
|
|
1546
1546
|
/**
|
|
1547
|
-
* @public
|
|
1548
1547
|
* <p>The Amazon Resource Name (ARN) of the response plan with the attached resource policy.
|
|
1549
1548
|
* </p>
|
|
1549
|
+
* @public
|
|
1550
1550
|
*/
|
|
1551
1551
|
resourceArn: string | undefined;
|
|
1552
1552
|
/**
|
|
1553
|
-
* @public
|
|
1554
1553
|
* <p>The maximum number of resource policies to display for each page of results.</p>
|
|
1554
|
+
* @public
|
|
1555
1555
|
*/
|
|
1556
1556
|
maxResults?: number;
|
|
1557
1557
|
/**
|
|
1558
|
-
* @public
|
|
1559
1558
|
* <p>The pagination token for the next set of items to return. (You received this token from a
|
|
1560
1559
|
* previous call.)</p>
|
|
1560
|
+
* @public
|
|
1561
1561
|
*/
|
|
1562
1562
|
nextToken?: string;
|
|
1563
1563
|
}
|
|
1564
1564
|
/**
|
|
1565
|
-
* @public
|
|
1566
1565
|
* <p>The resource policy that allows Incident Manager to perform actions on resources on your
|
|
1567
1566
|
* behalf.</p>
|
|
1567
|
+
* @public
|
|
1568
1568
|
*/
|
|
1569
1569
|
export interface ResourcePolicy {
|
|
1570
1570
|
/**
|
|
1571
|
-
* @public
|
|
1572
1571
|
* <p>The JSON blob that describes the policy.</p>
|
|
1572
|
+
* @public
|
|
1573
1573
|
*/
|
|
1574
1574
|
policyDocument: string | undefined;
|
|
1575
1575
|
/**
|
|
1576
|
-
* @public
|
|
1577
1576
|
* <p>The ID of the resource policy.</p>
|
|
1577
|
+
* @public
|
|
1578
1578
|
*/
|
|
1579
1579
|
policyId: string | undefined;
|
|
1580
1580
|
/**
|
|
1581
|
-
* @public
|
|
1582
1581
|
* <p>The Amazon Web Services Region that policy allows resources to be used in.</p>
|
|
1582
|
+
* @public
|
|
1583
1583
|
*/
|
|
1584
1584
|
ramResourceShareRegion: string | undefined;
|
|
1585
1585
|
}
|
|
@@ -1588,14 +1588,14 @@ export interface ResourcePolicy {
|
|
|
1588
1588
|
*/
|
|
1589
1589
|
export interface GetResourcePoliciesOutput {
|
|
1590
1590
|
/**
|
|
1591
|
-
* @public
|
|
1592
1591
|
* <p>Details about the resource policy attached to the response plan.</p>
|
|
1592
|
+
* @public
|
|
1593
1593
|
*/
|
|
1594
1594
|
resourcePolicies: ResourcePolicy[] | undefined;
|
|
1595
1595
|
/**
|
|
1596
|
-
* @public
|
|
1597
1596
|
* <p>The pagination token to use when requesting the next set of items. If there are no
|
|
1598
1597
|
* additional items to return, the string is null.</p>
|
|
1598
|
+
* @public
|
|
1599
1599
|
*/
|
|
1600
1600
|
nextToken?: string;
|
|
1601
1601
|
}
|
|
@@ -1604,8 +1604,8 @@ export interface GetResourcePoliciesOutput {
|
|
|
1604
1604
|
*/
|
|
1605
1605
|
export interface GetResponsePlanInput {
|
|
1606
1606
|
/**
|
|
1607
|
-
* @public
|
|
1608
1607
|
* <p>The Amazon Resource Name (ARN) of the response plan.</p>
|
|
1608
|
+
* @public
|
|
1609
1609
|
*/
|
|
1610
1610
|
arn: string | undefined;
|
|
1611
1611
|
}
|
|
@@ -1614,45 +1614,45 @@ export interface GetResponsePlanInput {
|
|
|
1614
1614
|
*/
|
|
1615
1615
|
export interface GetResponsePlanOutput {
|
|
1616
1616
|
/**
|
|
1617
|
-
* @public
|
|
1618
1617
|
* <p>The ARN of the response plan.</p>
|
|
1618
|
+
* @public
|
|
1619
1619
|
*/
|
|
1620
1620
|
arn: string | undefined;
|
|
1621
1621
|
/**
|
|
1622
|
-
* @public
|
|
1623
1622
|
* <p>The short format name of the response plan. The name can't contain spaces.</p>
|
|
1623
|
+
* @public
|
|
1624
1624
|
*/
|
|
1625
1625
|
name: string | undefined;
|
|
1626
1626
|
/**
|
|
1627
|
-
* @public
|
|
1628
1627
|
* <p>The long format name of the response plan. Can contain spaces.</p>
|
|
1628
|
+
* @public
|
|
1629
1629
|
*/
|
|
1630
1630
|
displayName?: string;
|
|
1631
1631
|
/**
|
|
1632
|
-
* @public
|
|
1633
1632
|
* <p>Details used to create the incident when using this response plan.</p>
|
|
1633
|
+
* @public
|
|
1634
1634
|
*/
|
|
1635
1635
|
incidentTemplate: IncidentTemplate | undefined;
|
|
1636
1636
|
/**
|
|
1637
|
-
* @public
|
|
1638
1637
|
* <p>The Chatbot chat channel used for collaboration during an incident.</p>
|
|
1638
|
+
* @public
|
|
1639
1639
|
*/
|
|
1640
1640
|
chatChannel?: ChatChannel;
|
|
1641
1641
|
/**
|
|
1642
|
-
* @public
|
|
1643
1642
|
* <p>The Amazon Resource Name (ARN) for the contacts and escalation plans that the response
|
|
1644
1643
|
* plan engages during an incident.</p>
|
|
1644
|
+
* @public
|
|
1645
1645
|
*/
|
|
1646
1646
|
engagements?: string[];
|
|
1647
1647
|
/**
|
|
1648
|
-
* @public
|
|
1649
1648
|
* <p>The actions that this response plan takes at the beginning of the incident.</p>
|
|
1649
|
+
* @public
|
|
1650
1650
|
*/
|
|
1651
1651
|
actions?: Action[];
|
|
1652
1652
|
/**
|
|
1653
|
-
* @public
|
|
1654
1653
|
* <p>Information about third-party services integrated into the Incident Manager response
|
|
1655
1654
|
* plan.</p>
|
|
1655
|
+
* @public
|
|
1656
1656
|
*/
|
|
1657
1657
|
integrations?: Integration[];
|
|
1658
1658
|
}
|
|
@@ -1661,56 +1661,56 @@ export interface GetResponsePlanOutput {
|
|
|
1661
1661
|
*/
|
|
1662
1662
|
export interface GetTimelineEventInput {
|
|
1663
1663
|
/**
|
|
1664
|
-
* @public
|
|
1665
1664
|
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
|
|
1665
|
+
* @public
|
|
1666
1666
|
*/
|
|
1667
1667
|
incidentRecordArn: string | undefined;
|
|
1668
1668
|
/**
|
|
1669
|
-
* @public
|
|
1670
1669
|
* <p>The ID of the event. You can get an event's ID when you create it, or by using
|
|
1671
1670
|
* <code>ListTimelineEvents</code>.</p>
|
|
1671
|
+
* @public
|
|
1672
1672
|
*/
|
|
1673
1673
|
eventId: string | undefined;
|
|
1674
1674
|
}
|
|
1675
1675
|
/**
|
|
1676
|
-
* @public
|
|
1677
1676
|
* <p>A significant event that happened during the incident. </p>
|
|
1677
|
+
* @public
|
|
1678
1678
|
*/
|
|
1679
1679
|
export interface TimelineEvent {
|
|
1680
1680
|
/**
|
|
1681
|
-
* @public
|
|
1682
1681
|
* <p>The Amazon Resource Name (ARN) of the incident that the event occurred during.</p>
|
|
1682
|
+
* @public
|
|
1683
1683
|
*/
|
|
1684
1684
|
incidentRecordArn: string | undefined;
|
|
1685
1685
|
/**
|
|
1686
|
-
* @public
|
|
1687
1686
|
* <p>The ID of the timeline event.</p>
|
|
1687
|
+
* @public
|
|
1688
1688
|
*/
|
|
1689
1689
|
eventId: string | undefined;
|
|
1690
1690
|
/**
|
|
1691
|
-
* @public
|
|
1692
1691
|
* <p>The timestamp for when the event occurred.</p>
|
|
1692
|
+
* @public
|
|
1693
1693
|
*/
|
|
1694
1694
|
eventTime: Date | undefined;
|
|
1695
1695
|
/**
|
|
1696
|
-
* @public
|
|
1697
1696
|
* <p>The timestamp for when the timeline event was last updated.</p>
|
|
1697
|
+
* @public
|
|
1698
1698
|
*/
|
|
1699
1699
|
eventUpdatedTime: Date | undefined;
|
|
1700
1700
|
/**
|
|
1701
|
-
* @public
|
|
1702
1701
|
* <p>The type of event that occurred. Currently Incident Manager supports only the <code>Custom
|
|
1703
1702
|
* Event</code> and <code>Note</code> types.</p>
|
|
1703
|
+
* @public
|
|
1704
1704
|
*/
|
|
1705
1705
|
eventType: string | undefined;
|
|
1706
1706
|
/**
|
|
1707
|
-
* @public
|
|
1708
1707
|
* <p>A short description of the event.</p>
|
|
1708
|
+
* @public
|
|
1709
1709
|
*/
|
|
1710
1710
|
eventData: string | undefined;
|
|
1711
1711
|
/**
|
|
1712
|
-
* @public
|
|
1713
1712
|
* <p>A list of references in a <code>TimelineEvent</code>.</p>
|
|
1713
|
+
* @public
|
|
1714
1714
|
*/
|
|
1715
1715
|
eventReferences?: EventReference[];
|
|
1716
1716
|
}
|
|
@@ -1719,50 +1719,50 @@ export interface TimelineEvent {
|
|
|
1719
1719
|
*/
|
|
1720
1720
|
export interface GetTimelineEventOutput {
|
|
1721
1721
|
/**
|
|
1722
|
-
* @public
|
|
1723
1722
|
* <p>Details about the timeline event.</p>
|
|
1723
|
+
* @public
|
|
1724
1724
|
*/
|
|
1725
1725
|
event: TimelineEvent | undefined;
|
|
1726
1726
|
}
|
|
1727
1727
|
/**
|
|
1728
|
-
* @public
|
|
1729
1728
|
* <p>Details describing an incident record.</p>
|
|
1729
|
+
* @public
|
|
1730
1730
|
*/
|
|
1731
1731
|
export interface IncidentRecordSummary {
|
|
1732
1732
|
/**
|
|
1733
|
-
* @public
|
|
1734
1733
|
* <p>The Amazon Resource Name (ARN) of the incident.</p>
|
|
1734
|
+
* @public
|
|
1735
1735
|
*/
|
|
1736
1736
|
arn: string | undefined;
|
|
1737
1737
|
/**
|
|
1738
|
-
* @public
|
|
1739
1738
|
* <p>The title of the incident. This value is either provided by the response plan or
|
|
1740
1739
|
* overwritten on creation.</p>
|
|
1740
|
+
* @public
|
|
1741
1741
|
*/
|
|
1742
1742
|
title: string | undefined;
|
|
1743
1743
|
/**
|
|
1744
|
-
* @public
|
|
1745
1744
|
* <p>The current status of the incident.</p>
|
|
1745
|
+
* @public
|
|
1746
1746
|
*/
|
|
1747
1747
|
status: IncidentRecordStatus | undefined;
|
|
1748
1748
|
/**
|
|
1749
|
-
* @public
|
|
1750
1749
|
* <p>Defines the impact to customers and applications.</p>
|
|
1750
|
+
* @public
|
|
1751
1751
|
*/
|
|
1752
1752
|
impact: number | undefined;
|
|
1753
1753
|
/**
|
|
1754
|
-
* @public
|
|
1755
1754
|
* <p>The timestamp for when the incident was created.</p>
|
|
1755
|
+
* @public
|
|
1756
1756
|
*/
|
|
1757
1757
|
creationTime: Date | undefined;
|
|
1758
1758
|
/**
|
|
1759
|
-
* @public
|
|
1760
1759
|
* <p>The timestamp for when the incident was resolved.</p>
|
|
1760
|
+
* @public
|
|
1761
1761
|
*/
|
|
1762
1762
|
resolvedTime?: Date;
|
|
1763
1763
|
/**
|
|
1764
|
-
* @public
|
|
1765
1764
|
* <p>What caused Incident Manager to create the incident.</p>
|
|
1765
|
+
* @public
|
|
1766
1766
|
*/
|
|
1767
1767
|
incidentRecordSource: IncidentRecordSource | undefined;
|
|
1768
1768
|
}
|
|
@@ -1786,32 +1786,32 @@ export declare const ItemType: {
|
|
|
1786
1786
|
*/
|
|
1787
1787
|
export type ItemType = (typeof ItemType)[keyof typeof ItemType];
|
|
1788
1788
|
/**
|
|
1789
|
-
* @public
|
|
1790
1789
|
* <p>Details about the PagerDuty incident associated with an incident created by an Incident Manager
|
|
1791
1790
|
* response plan.</p>
|
|
1791
|
+
* @public
|
|
1792
1792
|
*/
|
|
1793
1793
|
export interface PagerDutyIncidentDetail {
|
|
1794
1794
|
/**
|
|
1795
|
-
* @public
|
|
1796
1795
|
* <p>The ID of the incident associated with the PagerDuty service for the response plan.</p>
|
|
1796
|
+
* @public
|
|
1797
1797
|
*/
|
|
1798
1798
|
id: string | undefined;
|
|
1799
1799
|
/**
|
|
1800
|
-
* @public
|
|
1801
1800
|
* <p>Indicates whether to resolve the PagerDuty incident when you resolve the associated
|
|
1802
1801
|
* Incident Manager incident.</p>
|
|
1802
|
+
* @public
|
|
1803
1803
|
*/
|
|
1804
1804
|
autoResolve?: boolean;
|
|
1805
1805
|
/**
|
|
1806
|
-
* @public
|
|
1807
1806
|
* <p>The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or
|
|
1808
1807
|
* User Token REST API Key, and other user credentials.</p>
|
|
1808
|
+
* @public
|
|
1809
1809
|
*/
|
|
1810
1810
|
secretId?: string;
|
|
1811
1811
|
}
|
|
1812
1812
|
/**
|
|
1813
|
-
* @public
|
|
1814
1813
|
* <p>Describes a related item.</p>
|
|
1814
|
+
* @public
|
|
1815
1815
|
*/
|
|
1816
1816
|
export type ItemValue = ItemValue.ArnMember | ItemValue.MetricDefinitionMember | ItemValue.PagerDutyIncidentDetailMember | ItemValue.UrlMember | ItemValue.$UnknownMember;
|
|
1817
1817
|
/**
|
|
@@ -1819,9 +1819,9 @@ export type ItemValue = ItemValue.ArnMember | ItemValue.MetricDefinitionMember |
|
|
|
1819
1819
|
*/
|
|
1820
1820
|
export declare namespace ItemValue {
|
|
1821
1821
|
/**
|
|
1822
|
-
* @public
|
|
1823
1822
|
* <p>The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon
|
|
1824
1823
|
* resource.</p>
|
|
1824
|
+
* @public
|
|
1825
1825
|
*/
|
|
1826
1826
|
interface ArnMember {
|
|
1827
1827
|
arn: string;
|
|
@@ -1831,8 +1831,8 @@ export declare namespace ItemValue {
|
|
|
1831
1831
|
$unknown?: never;
|
|
1832
1832
|
}
|
|
1833
1833
|
/**
|
|
1834
|
-
* @public
|
|
1835
1834
|
* <p>The URL, if the related item is a non-Amazon Web Services resource.</p>
|
|
1835
|
+
* @public
|
|
1836
1836
|
*/
|
|
1837
1837
|
interface UrlMember {
|
|
1838
1838
|
arn?: never;
|
|
@@ -1842,8 +1842,8 @@ export declare namespace ItemValue {
|
|
|
1842
1842
|
$unknown?: never;
|
|
1843
1843
|
}
|
|
1844
1844
|
/**
|
|
1845
|
-
* @public
|
|
1846
1845
|
* <p>The metric definition, if the related item is a metric in Amazon CloudWatch.</p>
|
|
1846
|
+
* @public
|
|
1847
1847
|
*/
|
|
1848
1848
|
interface MetricDefinitionMember {
|
|
1849
1849
|
arn?: never;
|
|
@@ -1853,8 +1853,8 @@ export declare namespace ItemValue {
|
|
|
1853
1853
|
$unknown?: never;
|
|
1854
1854
|
}
|
|
1855
1855
|
/**
|
|
1856
|
-
* @public
|
|
1857
1856
|
* <p>Details about an incident that is associated with a PagerDuty incident.</p>
|
|
1857
|
+
* @public
|
|
1858
1858
|
*/
|
|
1859
1859
|
interface PagerDutyIncidentDetailMember {
|
|
1860
1860
|
arn?: never;
|
|
@@ -1883,18 +1883,18 @@ export declare namespace ItemValue {
|
|
|
1883
1883
|
const visit: <T>(value: ItemValue, visitor: Visitor<T>) => T;
|
|
1884
1884
|
}
|
|
1885
1885
|
/**
|
|
1886
|
-
* @public
|
|
1887
1886
|
* <p>Details and type of a related item.</p>
|
|
1887
|
+
* @public
|
|
1888
1888
|
*/
|
|
1889
1889
|
export interface ItemIdentifier {
|
|
1890
1890
|
/**
|
|
1891
|
-
* @public
|
|
1892
1891
|
* <p>Details about the related item.</p>
|
|
1892
|
+
* @public
|
|
1893
1893
|
*/
|
|
1894
1894
|
value: ItemValue | undefined;
|
|
1895
1895
|
/**
|
|
1896
|
-
* @public
|
|
1897
1896
|
* <p>The type of related item. </p>
|
|
1897
|
+
* @public
|
|
1898
1898
|
*/
|
|
1899
1899
|
type: ItemType | undefined;
|
|
1900
1900
|
}
|
|
@@ -1903,20 +1903,20 @@ export interface ItemIdentifier {
|
|
|
1903
1903
|
*/
|
|
1904
1904
|
export interface ListIncidentFindingsInput {
|
|
1905
1905
|
/**
|
|
1906
|
-
* @public
|
|
1907
1906
|
* <p>The Amazon Resource Name (ARN) of the incident for which you want to view associated
|
|
1908
1907
|
* findings.</p>
|
|
1908
|
+
* @public
|
|
1909
1909
|
*/
|
|
1910
1910
|
incidentRecordArn: string | undefined;
|
|
1911
1911
|
/**
|
|
1912
|
-
* @public
|
|
1913
1912
|
* <p>The maximum number of findings to retrieve per call.</p>
|
|
1913
|
+
* @public
|
|
1914
1914
|
*/
|
|
1915
1915
|
maxResults?: number;
|
|
1916
1916
|
/**
|
|
1917
|
-
* @public
|
|
1918
1917
|
* <p>The pagination token for the next set of items to return. (You received this token from a
|
|
1919
1918
|
* previous call.)</p>
|
|
1919
|
+
* @public
|
|
1920
1920
|
*/
|
|
1921
1921
|
nextToken?: string;
|
|
1922
1922
|
}
|
|
@@ -1925,15 +1925,15 @@ export interface ListIncidentFindingsInput {
|
|
|
1925
1925
|
*/
|
|
1926
1926
|
export interface ListIncidentFindingsOutput {
|
|
1927
1927
|
/**
|
|
1928
|
-
* @public
|
|
1929
1928
|
* <p>A list of findings that represent deployments that might be the potential cause of the
|
|
1930
1929
|
* incident.</p>
|
|
1930
|
+
* @public
|
|
1931
1931
|
*/
|
|
1932
1932
|
findings: FindingSummary[] | undefined;
|
|
1933
1933
|
/**
|
|
1934
|
-
* @public
|
|
1935
1934
|
* <p>The pagination token to use when requesting the next set of items. If there are no
|
|
1936
1935
|
* additional items to return, the string is null.</p>
|
|
1936
|
+
* @public
|
|
1937
1937
|
*/
|
|
1938
1938
|
nextToken?: string;
|
|
1939
1939
|
}
|
|
@@ -1942,7 +1942,6 @@ export interface ListIncidentFindingsOutput {
|
|
|
1942
1942
|
*/
|
|
1943
1943
|
export interface ListIncidentRecordsInput {
|
|
1944
1944
|
/**
|
|
1945
|
-
* @public
|
|
1946
1945
|
* <p>Filters the list of incident records you want to search through. You can filter on the
|
|
1947
1946
|
* following keys:</p>
|
|
1948
1947
|
* <ul>
|
|
@@ -1981,17 +1980,18 @@ export interface ListIncidentRecordsInput {
|
|
|
1981
1980
|
* records that match any of the values provided.</p>
|
|
1982
1981
|
* </li>
|
|
1983
1982
|
* </ul>
|
|
1983
|
+
* @public
|
|
1984
1984
|
*/
|
|
1985
1985
|
filters?: Filter[];
|
|
1986
1986
|
/**
|
|
1987
|
-
* @public
|
|
1988
1987
|
* <p>The maximum number of results per page.</p>
|
|
1988
|
+
* @public
|
|
1989
1989
|
*/
|
|
1990
1990
|
maxResults?: number;
|
|
1991
1991
|
/**
|
|
1992
|
-
* @public
|
|
1993
1992
|
* <p>The pagination token for the next set of items to return. (You received this token from a
|
|
1994
1993
|
* previous call.)</p>
|
|
1994
|
+
* @public
|
|
1995
1995
|
*/
|
|
1996
1996
|
nextToken?: string;
|
|
1997
1997
|
}
|
|
@@ -2000,14 +2000,14 @@ export interface ListIncidentRecordsInput {
|
|
|
2000
2000
|
*/
|
|
2001
2001
|
export interface ListIncidentRecordsOutput {
|
|
2002
2002
|
/**
|
|
2003
|
-
* @public
|
|
2004
2003
|
* <p>The details of each listed incident record.</p>
|
|
2004
|
+
* @public
|
|
2005
2005
|
*/
|
|
2006
2006
|
incidentRecordSummaries: IncidentRecordSummary[] | undefined;
|
|
2007
2007
|
/**
|
|
2008
|
-
* @public
|
|
2009
2008
|
* <p>The pagination token to use when requesting the next set of items. If there are no
|
|
2010
2009
|
* additional items to return, the string is null.</p>
|
|
2010
|
+
* @public
|
|
2011
2011
|
*/
|
|
2012
2012
|
nextToken?: string;
|
|
2013
2013
|
}
|
|
@@ -2016,44 +2016,44 @@ export interface ListIncidentRecordsOutput {
|
|
|
2016
2016
|
*/
|
|
2017
2017
|
export interface ListRelatedItemsInput {
|
|
2018
2018
|
/**
|
|
2019
|
-
* @public
|
|
2020
2019
|
* <p>The Amazon Resource Name (ARN) of the incident record containing the listed related
|
|
2021
2020
|
* items.</p>
|
|
2021
|
+
* @public
|
|
2022
2022
|
*/
|
|
2023
2023
|
incidentRecordArn: string | undefined;
|
|
2024
2024
|
/**
|
|
2025
|
-
* @public
|
|
2026
2025
|
* <p>The maximum number of related items per page.</p>
|
|
2026
|
+
* @public
|
|
2027
2027
|
*/
|
|
2028
2028
|
maxResults?: number;
|
|
2029
2029
|
/**
|
|
2030
|
-
* @public
|
|
2031
2030
|
* <p>The pagination token for the next set of items to return. (You received this token from a
|
|
2032
2031
|
* previous call.)</p>
|
|
2032
|
+
* @public
|
|
2033
2033
|
*/
|
|
2034
2034
|
nextToken?: string;
|
|
2035
2035
|
}
|
|
2036
2036
|
/**
|
|
2037
|
-
* @public
|
|
2038
2037
|
* <p>Resources that responders use to triage and mitigate the incident.</p>
|
|
2038
|
+
* @public
|
|
2039
2039
|
*/
|
|
2040
2040
|
export interface RelatedItem {
|
|
2041
2041
|
/**
|
|
2042
|
-
* @public
|
|
2043
2042
|
* <p>Details about the related item.</p>
|
|
2043
|
+
* @public
|
|
2044
2044
|
*/
|
|
2045
2045
|
identifier: ItemIdentifier | undefined;
|
|
2046
2046
|
/**
|
|
2047
|
-
* @public
|
|
2048
2047
|
* <p>The title of the related item.</p>
|
|
2048
|
+
* @public
|
|
2049
2049
|
*/
|
|
2050
2050
|
title?: string;
|
|
2051
2051
|
/**
|
|
2052
|
-
* @public
|
|
2053
2052
|
* <p>A unique ID for a <code>RelatedItem</code>.</p>
|
|
2054
2053
|
* <important>
|
|
2055
2054
|
* <p>Don't specify this parameter when you add a <code>RelatedItem</code> by using the <a>UpdateRelatedItems</a> API action.</p>
|
|
2056
2055
|
* </important>
|
|
2056
|
+
* @public
|
|
2057
2057
|
*/
|
|
2058
2058
|
generatedId?: string;
|
|
2059
2059
|
}
|
|
@@ -2062,14 +2062,14 @@ export interface RelatedItem {
|
|
|
2062
2062
|
*/
|
|
2063
2063
|
export interface ListRelatedItemsOutput {
|
|
2064
2064
|
/**
|
|
2065
|
-
* @public
|
|
2066
2065
|
* <p>Details about each related item.</p>
|
|
2066
|
+
* @public
|
|
2067
2067
|
*/
|
|
2068
2068
|
relatedItems: RelatedItem[] | undefined;
|
|
2069
2069
|
/**
|
|
2070
|
-
* @public
|
|
2071
2070
|
* <p>The pagination token to use when requesting the next set of items. If there are no
|
|
2072
2071
|
* additional items to return, the string is null.</p>
|
|
2072
|
+
* @public
|
|
2073
2073
|
*/
|
|
2074
2074
|
nextToken?: string;
|
|
2075
2075
|
}
|
|
@@ -2078,14 +2078,14 @@ export interface ListRelatedItemsOutput {
|
|
|
2078
2078
|
*/
|
|
2079
2079
|
export interface ListReplicationSetsInput {
|
|
2080
2080
|
/**
|
|
2081
|
-
* @public
|
|
2082
2081
|
* <p>The maximum number of results per page. </p>
|
|
2082
|
+
* @public
|
|
2083
2083
|
*/
|
|
2084
2084
|
maxResults?: number;
|
|
2085
2085
|
/**
|
|
2086
|
-
* @public
|
|
2087
2086
|
* <p>The pagination token for the next set of items to return. (You received this token from a
|
|
2088
2087
|
* previous call.)</p>
|
|
2088
|
+
* @public
|
|
2089
2089
|
*/
|
|
2090
2090
|
nextToken?: string;
|
|
2091
2091
|
}
|
|
@@ -2094,14 +2094,14 @@ export interface ListReplicationSetsInput {
|
|
|
2094
2094
|
*/
|
|
2095
2095
|
export interface ListReplicationSetsOutput {
|
|
2096
2096
|
/**
|
|
2097
|
-
* @public
|
|
2098
2097
|
* <p>The Amazon Resource Name (ARN) of the list replication set.</p>
|
|
2098
|
+
* @public
|
|
2099
2099
|
*/
|
|
2100
2100
|
replicationSetArns: string[] | undefined;
|
|
2101
2101
|
/**
|
|
2102
|
-
* @public
|
|
2103
2102
|
* <p>The pagination token to use when requesting the next set of items. If there are no
|
|
2104
2103
|
* additional items to return, the string is null.</p>
|
|
2104
|
+
* @public
|
|
2105
2105
|
*/
|
|
2106
2106
|
nextToken?: string;
|
|
2107
2107
|
}
|
|
@@ -2110,35 +2110,35 @@ export interface ListReplicationSetsOutput {
|
|
|
2110
2110
|
*/
|
|
2111
2111
|
export interface ListResponsePlansInput {
|
|
2112
2112
|
/**
|
|
2113
|
-
* @public
|
|
2114
2113
|
* <p>The maximum number of response plans per page.</p>
|
|
2114
|
+
* @public
|
|
2115
2115
|
*/
|
|
2116
2116
|
maxResults?: number;
|
|
2117
2117
|
/**
|
|
2118
|
-
* @public
|
|
2119
2118
|
* <p>The pagination token for the next set of items to return. (You received this token from a
|
|
2120
2119
|
* previous call.)</p>
|
|
2120
|
+
* @public
|
|
2121
2121
|
*/
|
|
2122
2122
|
nextToken?: string;
|
|
2123
2123
|
}
|
|
2124
2124
|
/**
|
|
2125
|
-
* @public
|
|
2126
2125
|
* <p>Details of the response plan that are used when creating an incident.</p>
|
|
2126
|
+
* @public
|
|
2127
2127
|
*/
|
|
2128
2128
|
export interface ResponsePlanSummary {
|
|
2129
2129
|
/**
|
|
2130
|
-
* @public
|
|
2131
2130
|
* <p>The Amazon Resource Name (ARN) of the response plan.</p>
|
|
2131
|
+
* @public
|
|
2132
2132
|
*/
|
|
2133
2133
|
arn: string | undefined;
|
|
2134
2134
|
/**
|
|
2135
|
-
* @public
|
|
2136
2135
|
* <p>The name of the response plan. This can't include spaces.</p>
|
|
2136
|
+
* @public
|
|
2137
2137
|
*/
|
|
2138
2138
|
name: string | undefined;
|
|
2139
2139
|
/**
|
|
2140
|
-
* @public
|
|
2141
2140
|
* <p>The human readable name of the response plan. This can include spaces.</p>
|
|
2141
|
+
* @public
|
|
2142
2142
|
*/
|
|
2143
2143
|
displayName?: string;
|
|
2144
2144
|
}
|
|
@@ -2147,14 +2147,14 @@ export interface ResponsePlanSummary {
|
|
|
2147
2147
|
*/
|
|
2148
2148
|
export interface ListResponsePlansOutput {
|
|
2149
2149
|
/**
|
|
2150
|
-
* @public
|
|
2151
2150
|
* <p>Details of each response plan.</p>
|
|
2151
|
+
* @public
|
|
2152
2152
|
*/
|
|
2153
2153
|
responsePlanSummaries: ResponsePlanSummary[] | undefined;
|
|
2154
2154
|
/**
|
|
2155
|
-
* @public
|
|
2156
2155
|
* <p>The pagination token to use when requesting the next set of items. If there are no
|
|
2157
2156
|
* additional items to return, the string is null.</p>
|
|
2157
|
+
* @public
|
|
2158
2158
|
*/
|
|
2159
2159
|
nextToken?: string;
|
|
2160
2160
|
}
|
|
@@ -2163,8 +2163,8 @@ export interface ListResponsePlansOutput {
|
|
|
2163
2163
|
*/
|
|
2164
2164
|
export interface ListTagsForResourceRequest {
|
|
2165
2165
|
/**
|
|
2166
|
-
* @public
|
|
2167
2166
|
* <p>The Amazon Resource Name (ARN) of the response plan or incident.</p>
|
|
2167
|
+
* @public
|
|
2168
2168
|
*/
|
|
2169
2169
|
resourceArn: string | undefined;
|
|
2170
2170
|
}
|
|
@@ -2173,8 +2173,8 @@ export interface ListTagsForResourceRequest {
|
|
|
2173
2173
|
*/
|
|
2174
2174
|
export interface ListTagsForResourceResponse {
|
|
2175
2175
|
/**
|
|
2176
|
-
* @public
|
|
2177
2176
|
* <p>A list of tags for the response plan or incident.</p>
|
|
2177
|
+
* @public
|
|
2178
2178
|
*/
|
|
2179
2179
|
tags: Record<string, string> | undefined;
|
|
2180
2180
|
}
|
|
@@ -2206,12 +2206,11 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
|
2206
2206
|
*/
|
|
2207
2207
|
export interface ListTimelineEventsInput {
|
|
2208
2208
|
/**
|
|
2209
|
-
* @public
|
|
2210
2209
|
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
|
|
2210
|
+
* @public
|
|
2211
2211
|
*/
|
|
2212
2212
|
incidentRecordArn: string | undefined;
|
|
2213
2213
|
/**
|
|
2214
|
-
* @public
|
|
2215
2214
|
* <p>Filters the timeline events based on the provided conditional values. You can filter
|
|
2216
2215
|
* timeline events with the following keys:</p>
|
|
2217
2216
|
* <ul>
|
|
@@ -2245,28 +2244,29 @@ export interface ListTimelineEventsInput {
|
|
|
2245
2244
|
* that match any of the values provided.</p>
|
|
2246
2245
|
* </li>
|
|
2247
2246
|
* </ul>
|
|
2247
|
+
* @public
|
|
2248
2248
|
*/
|
|
2249
2249
|
filters?: Filter[];
|
|
2250
2250
|
/**
|
|
2251
|
-
* @public
|
|
2252
2251
|
* <p>Sort timeline events by the specified key value pair.</p>
|
|
2252
|
+
* @public
|
|
2253
2253
|
*/
|
|
2254
2254
|
sortBy?: TimelineEventSort;
|
|
2255
2255
|
/**
|
|
2256
|
-
* @public
|
|
2257
2256
|
* <p>Sorts the order of timeline events by the value specified in the <code>sortBy</code>
|
|
2258
2257
|
* field.</p>
|
|
2258
|
+
* @public
|
|
2259
2259
|
*/
|
|
2260
2260
|
sortOrder?: SortOrder;
|
|
2261
2261
|
/**
|
|
2262
|
-
* @public
|
|
2263
2262
|
* <p>The maximum number of results per page.</p>
|
|
2263
|
+
* @public
|
|
2264
2264
|
*/
|
|
2265
2265
|
maxResults?: number;
|
|
2266
2266
|
/**
|
|
2267
|
-
* @public
|
|
2268
2267
|
* <p>The pagination token for the next set of items to return. (You received this token from a
|
|
2269
2268
|
* previous call.)</p>
|
|
2269
|
+
* @public
|
|
2270
2270
|
*/
|
|
2271
2271
|
nextToken?: string;
|
|
2272
2272
|
}
|
|
@@ -2275,14 +2275,14 @@ export interface ListTimelineEventsInput {
|
|
|
2275
2275
|
*/
|
|
2276
2276
|
export interface ListTimelineEventsOutput {
|
|
2277
2277
|
/**
|
|
2278
|
-
* @public
|
|
2279
2278
|
* <p>Details about each event that occurred during the incident.</p>
|
|
2279
|
+
* @public
|
|
2280
2280
|
*/
|
|
2281
2281
|
eventSummaries: EventSummary[] | undefined;
|
|
2282
2282
|
/**
|
|
2283
|
-
* @public
|
|
2284
2283
|
* <p>The pagination token to use when requesting the next set of items. If there are no
|
|
2285
2284
|
* additional items to return, the string is null.</p>
|
|
2285
|
+
* @public
|
|
2286
2286
|
*/
|
|
2287
2287
|
nextToken?: string;
|
|
2288
2288
|
}
|
|
@@ -2291,13 +2291,13 @@ export interface ListTimelineEventsOutput {
|
|
|
2291
2291
|
*/
|
|
2292
2292
|
export interface PutResourcePolicyInput {
|
|
2293
2293
|
/**
|
|
2294
|
-
* @public
|
|
2295
2294
|
* <p>The Amazon Resource Name (ARN) of the response plan to add the resource policy to.</p>
|
|
2295
|
+
* @public
|
|
2296
2296
|
*/
|
|
2297
2297
|
resourceArn: string | undefined;
|
|
2298
2298
|
/**
|
|
2299
|
-
* @public
|
|
2300
2299
|
* <p>Details of the resource policy.</p>
|
|
2300
|
+
* @public
|
|
2301
2301
|
*/
|
|
2302
2302
|
policy: string | undefined;
|
|
2303
2303
|
}
|
|
@@ -2306,14 +2306,14 @@ export interface PutResourcePolicyInput {
|
|
|
2306
2306
|
*/
|
|
2307
2307
|
export interface PutResourcePolicyOutput {
|
|
2308
2308
|
/**
|
|
2309
|
-
* @public
|
|
2310
2309
|
* <p>The ID of the resource policy.</p>
|
|
2310
|
+
* @public
|
|
2311
2311
|
*/
|
|
2312
2312
|
policyId: string | undefined;
|
|
2313
2313
|
}
|
|
2314
2314
|
/**
|
|
2315
|
-
* @public
|
|
2316
2315
|
* <p>Details about the related item you're adding.</p>
|
|
2316
|
+
* @public
|
|
2317
2317
|
*/
|
|
2318
2318
|
export type RelatedItemsUpdate = RelatedItemsUpdate.ItemToAddMember | RelatedItemsUpdate.ItemToRemoveMember | RelatedItemsUpdate.$UnknownMember;
|
|
2319
2319
|
/**
|
|
@@ -2321,8 +2321,8 @@ export type RelatedItemsUpdate = RelatedItemsUpdate.ItemToAddMember | RelatedIte
|
|
|
2321
2321
|
*/
|
|
2322
2322
|
export declare namespace RelatedItemsUpdate {
|
|
2323
2323
|
/**
|
|
2324
|
-
* @public
|
|
2325
2324
|
* <p>Details about the related item you're adding.</p>
|
|
2325
|
+
* @public
|
|
2326
2326
|
*/
|
|
2327
2327
|
interface ItemToAddMember {
|
|
2328
2328
|
itemToAdd: RelatedItem;
|
|
@@ -2330,8 +2330,8 @@ export declare namespace RelatedItemsUpdate {
|
|
|
2330
2330
|
$unknown?: never;
|
|
2331
2331
|
}
|
|
2332
2332
|
/**
|
|
2333
|
-
* @public
|
|
2334
2333
|
* <p>Details about the related item you're deleting.</p>
|
|
2334
|
+
* @public
|
|
2335
2335
|
*/
|
|
2336
2336
|
interface ItemToRemoveMember {
|
|
2337
2337
|
itemToAdd?: never;
|
|
@@ -2354,30 +2354,30 @@ export declare namespace RelatedItemsUpdate {
|
|
|
2354
2354
|
const visit: <T>(value: RelatedItemsUpdate, visitor: Visitor<T>) => T;
|
|
2355
2355
|
}
|
|
2356
2356
|
/**
|
|
2357
|
-
* @public
|
|
2358
2357
|
* <p>Details about what caused the incident to be created in Incident Manager.</p>
|
|
2358
|
+
* @public
|
|
2359
2359
|
*/
|
|
2360
2360
|
export interface TriggerDetails {
|
|
2361
2361
|
/**
|
|
2362
|
-
* @public
|
|
2363
2362
|
* <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,
|
|
2364
2363
|
* as long as it doesn't begin with "<code>aws.</code>" We recommend the use of Java package-name
|
|
2365
2364
|
* style reverse domain-name strings. </p>
|
|
2365
|
+
* @public
|
|
2366
2366
|
*/
|
|
2367
2367
|
source: string | undefined;
|
|
2368
2368
|
/**
|
|
2369
|
-
* @public
|
|
2370
2369
|
* <p>The Amazon Resource Name (ARN) of the source that detected the incident.</p>
|
|
2370
|
+
* @public
|
|
2371
2371
|
*/
|
|
2372
2372
|
triggerArn?: string;
|
|
2373
2373
|
/**
|
|
2374
|
-
* @public
|
|
2375
2374
|
* <p>The timestamp for when the incident was detected.</p>
|
|
2375
|
+
* @public
|
|
2376
2376
|
*/
|
|
2377
2377
|
timestamp: Date | undefined;
|
|
2378
2378
|
/**
|
|
2379
|
-
* @public
|
|
2380
2379
|
* <p>Raw data passed from either Amazon EventBridge, Amazon CloudWatch, or Incident Manager when an incident is created.</p>
|
|
2380
|
+
* @public
|
|
2381
2381
|
*/
|
|
2382
2382
|
rawData?: string;
|
|
2383
2383
|
}
|
|
@@ -2386,24 +2386,23 @@ export interface TriggerDetails {
|
|
|
2386
2386
|
*/
|
|
2387
2387
|
export interface StartIncidentInput {
|
|
2388
2388
|
/**
|
|
2389
|
-
* @public
|
|
2390
2389
|
* <p>A token ensuring that the operation is called only once with the specified details.</p>
|
|
2390
|
+
* @public
|
|
2391
2391
|
*/
|
|
2392
2392
|
clientToken?: string;
|
|
2393
2393
|
/**
|
|
2394
|
-
* @public
|
|
2395
2394
|
* <p>The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat
|
|
2396
2395
|
* channels, Amazon SNS topics, runbooks, title, and impact of the incident. </p>
|
|
2396
|
+
* @public
|
|
2397
2397
|
*/
|
|
2398
2398
|
responsePlanArn: string | undefined;
|
|
2399
2399
|
/**
|
|
2400
|
-
* @public
|
|
2401
2400
|
* <p>Provide a title for the incident. Providing a title overwrites the title provided by the
|
|
2402
2401
|
* response plan. </p>
|
|
2402
|
+
* @public
|
|
2403
2403
|
*/
|
|
2404
2404
|
title?: string;
|
|
2405
2405
|
/**
|
|
2406
|
-
* @public
|
|
2407
2406
|
* <p>Defines the impact to the customers. Providing an impact overwrites the impact provided by
|
|
2408
2407
|
* a response plan.</p>
|
|
2409
2408
|
* <p class="title">
|
|
@@ -2431,17 +2430,18 @@ export interface StartIncidentInput {
|
|
|
2431
2430
|
* <code>5</code> - No Impact</p>
|
|
2432
2431
|
* </li>
|
|
2433
2432
|
* </ul>
|
|
2433
|
+
* @public
|
|
2434
2434
|
*/
|
|
2435
2435
|
impact?: number;
|
|
2436
2436
|
/**
|
|
2437
|
-
* @public
|
|
2438
2437
|
* <p>Details of what created the incident record in Incident Manager.</p>
|
|
2438
|
+
* @public
|
|
2439
2439
|
*/
|
|
2440
2440
|
triggerDetails?: TriggerDetails;
|
|
2441
2441
|
/**
|
|
2442
|
-
* @public
|
|
2443
2442
|
* <p>Add related items to the incident for other responders to use. Related items are Amazon Web Services
|
|
2444
2443
|
* resources, external links, or files uploaded to an Amazon S3 bucket. </p>
|
|
2444
|
+
* @public
|
|
2445
2445
|
*/
|
|
2446
2446
|
relatedItems?: RelatedItem[];
|
|
2447
2447
|
}
|
|
@@ -2450,8 +2450,8 @@ export interface StartIncidentInput {
|
|
|
2450
2450
|
*/
|
|
2451
2451
|
export interface StartIncidentOutput {
|
|
2452
2452
|
/**
|
|
2453
|
-
* @public
|
|
2454
2453
|
* <p>The ARN of the newly created incident record.</p>
|
|
2454
|
+
* @public
|
|
2455
2455
|
*/
|
|
2456
2456
|
incidentRecordArn: string | undefined;
|
|
2457
2457
|
}
|
|
@@ -2460,13 +2460,13 @@ export interface StartIncidentOutput {
|
|
|
2460
2460
|
*/
|
|
2461
2461
|
export interface TagResourceRequest {
|
|
2462
2462
|
/**
|
|
2463
|
-
* @public
|
|
2464
2463
|
* <p>The Amazon Resource Name (ARN) of the response plan you're adding the tags to.</p>
|
|
2464
|
+
* @public
|
|
2465
2465
|
*/
|
|
2466
2466
|
resourceArn: string | undefined;
|
|
2467
2467
|
/**
|
|
2468
|
-
* @public
|
|
2469
2468
|
* <p>A list of tags to add to the response plan.</p>
|
|
2469
|
+
* @public
|
|
2470
2470
|
*/
|
|
2471
2471
|
tags: Record<string, string> | undefined;
|
|
2472
2472
|
}
|
|
@@ -2480,13 +2480,13 @@ export interface TagResourceResponse {
|
|
|
2480
2480
|
*/
|
|
2481
2481
|
export interface UntagResourceRequest {
|
|
2482
2482
|
/**
|
|
2483
|
-
* @public
|
|
2484
2483
|
* <p>The Amazon Resource Name (ARN) of the response plan you're removing a tag from.</p>
|
|
2484
|
+
* @public
|
|
2485
2485
|
*/
|
|
2486
2486
|
resourceArn: string | undefined;
|
|
2487
2487
|
/**
|
|
2488
|
-
* @public
|
|
2489
2488
|
* <p>The name of the tag to remove from the response plan.</p>
|
|
2489
|
+
* @public
|
|
2490
2490
|
*/
|
|
2491
2491
|
tagKeys: string[] | undefined;
|
|
2492
2492
|
}
|
|
@@ -2500,19 +2500,19 @@ export interface UntagResourceResponse {
|
|
|
2500
2500
|
*/
|
|
2501
2501
|
export interface UpdateDeletionProtectionInput {
|
|
2502
2502
|
/**
|
|
2503
|
-
* @public
|
|
2504
2503
|
* <p>The Amazon Resource Name (ARN) of the replication set to update.</p>
|
|
2504
|
+
* @public
|
|
2505
2505
|
*/
|
|
2506
2506
|
arn: string | undefined;
|
|
2507
2507
|
/**
|
|
2508
|
-
* @public
|
|
2509
2508
|
* <p>Specifies if deletion protection is turned on or off in your account. </p>
|
|
2509
|
+
* @public
|
|
2510
2510
|
*/
|
|
2511
2511
|
deletionProtected: boolean | undefined;
|
|
2512
2512
|
/**
|
|
2513
|
-
* @public
|
|
2514
2513
|
* <p>A token that ensures that the operation is called only once with the specified
|
|
2515
2514
|
* details.</p>
|
|
2515
|
+
* @public
|
|
2516
2516
|
*/
|
|
2517
2517
|
clientToken?: string;
|
|
2518
2518
|
}
|
|
@@ -2526,28 +2526,27 @@ export interface UpdateDeletionProtectionOutput {
|
|
|
2526
2526
|
*/
|
|
2527
2527
|
export interface UpdateIncidentRecordInput {
|
|
2528
2528
|
/**
|
|
2529
|
-
* @public
|
|
2530
2529
|
* <p>A token that ensures that a client calls the operation only once with the specified
|
|
2531
2530
|
* details.</p>
|
|
2531
|
+
* @public
|
|
2532
2532
|
*/
|
|
2533
2533
|
clientToken?: string;
|
|
2534
2534
|
/**
|
|
2535
|
-
* @public
|
|
2536
2535
|
* <p>The Amazon Resource Name (ARN) of the incident record you are updating.</p>
|
|
2536
|
+
* @public
|
|
2537
2537
|
*/
|
|
2538
2538
|
arn: string | undefined;
|
|
2539
2539
|
/**
|
|
2540
|
-
* @public
|
|
2541
2540
|
* <p>A brief description of the incident.</p>
|
|
2541
|
+
* @public
|
|
2542
2542
|
*/
|
|
2543
2543
|
title?: string;
|
|
2544
2544
|
/**
|
|
2545
|
-
* @public
|
|
2546
2545
|
* <p>A longer description of what occurred during the incident.</p>
|
|
2546
|
+
* @public
|
|
2547
2547
|
*/
|
|
2548
2548
|
summary?: string;
|
|
2549
2549
|
/**
|
|
2550
|
-
* @public
|
|
2551
2550
|
* <p>Defines the impact of the incident to customers and applications. If you provide an impact
|
|
2552
2551
|
* for an incident, it overwrites the impact provided by the response plan.</p>
|
|
2553
2552
|
* <p class="title">
|
|
@@ -2575,25 +2574,26 @@ export interface UpdateIncidentRecordInput {
|
|
|
2575
2574
|
* <code>5</code> - No Impact</p>
|
|
2576
2575
|
* </li>
|
|
2577
2576
|
* </ul>
|
|
2577
|
+
* @public
|
|
2578
2578
|
*/
|
|
2579
2579
|
impact?: number;
|
|
2580
2580
|
/**
|
|
2581
|
-
* @public
|
|
2582
2581
|
* <p>The status of the incident. Possible statuses are <code>Open</code> or
|
|
2583
2582
|
* <code>Resolved</code>.</p>
|
|
2583
|
+
* @public
|
|
2584
2584
|
*/
|
|
2585
2585
|
status?: IncidentRecordStatus;
|
|
2586
2586
|
/**
|
|
2587
|
-
* @public
|
|
2588
2587
|
* <p>The Chatbot chat channel where responders can collaborate.</p>
|
|
2588
|
+
* @public
|
|
2589
2589
|
*/
|
|
2590
2590
|
chatChannel?: ChatChannel;
|
|
2591
2591
|
/**
|
|
2592
|
-
* @public
|
|
2593
2592
|
* <p>The Amazon SNS targets that Incident Manager notifies when a client updates an
|
|
2594
2593
|
* incident.</p>
|
|
2595
2594
|
* <p>Using multiple SNS topics creates redundancy in the event that a Region is down during the
|
|
2596
2595
|
* incident.</p>
|
|
2596
|
+
* @public
|
|
2597
2597
|
*/
|
|
2598
2598
|
notificationTargets?: NotificationTargetItem[];
|
|
2599
2599
|
}
|
|
@@ -2607,20 +2607,20 @@ export interface UpdateIncidentRecordOutput {
|
|
|
2607
2607
|
*/
|
|
2608
2608
|
export interface UpdateRelatedItemsInput {
|
|
2609
2609
|
/**
|
|
2610
|
-
* @public
|
|
2611
2610
|
* <p>A token that ensures that a client calls the operation only once with the specified
|
|
2612
2611
|
* details.</p>
|
|
2612
|
+
* @public
|
|
2613
2613
|
*/
|
|
2614
2614
|
clientToken?: string;
|
|
2615
2615
|
/**
|
|
2616
|
-
* @public
|
|
2617
2616
|
* <p>The Amazon Resource Name (ARN) of the incident record that contains the related items that
|
|
2618
2617
|
* you update.</p>
|
|
2618
|
+
* @public
|
|
2619
2619
|
*/
|
|
2620
2620
|
incidentRecordArn: string | undefined;
|
|
2621
2621
|
/**
|
|
2622
|
-
* @public
|
|
2623
2622
|
* <p>Details about the item that you are add to, or delete from, an incident.</p>
|
|
2623
|
+
* @public
|
|
2624
2624
|
*/
|
|
2625
2625
|
relatedItemsUpdate: RelatedItemsUpdate | undefined;
|
|
2626
2626
|
}
|
|
@@ -2630,8 +2630,8 @@ export interface UpdateRelatedItemsInput {
|
|
|
2630
2630
|
export interface UpdateRelatedItemsOutput {
|
|
2631
2631
|
}
|
|
2632
2632
|
/**
|
|
2633
|
-
* @public
|
|
2634
2633
|
* <p>Details used when updating the replication set.</p>
|
|
2634
|
+
* @public
|
|
2635
2635
|
*/
|
|
2636
2636
|
export type UpdateReplicationSetAction = UpdateReplicationSetAction.AddRegionActionMember | UpdateReplicationSetAction.DeleteRegionActionMember | UpdateReplicationSetAction.$UnknownMember;
|
|
2637
2637
|
/**
|
|
@@ -2639,9 +2639,9 @@ export type UpdateReplicationSetAction = UpdateReplicationSetAction.AddRegionAct
|
|
|
2639
2639
|
*/
|
|
2640
2640
|
export declare namespace UpdateReplicationSetAction {
|
|
2641
2641
|
/**
|
|
2642
|
-
* @public
|
|
2643
2642
|
* <p>Details about the Amazon Web Services Region that you're adding to the replication
|
|
2644
2643
|
* set.</p>
|
|
2644
|
+
* @public
|
|
2645
2645
|
*/
|
|
2646
2646
|
interface AddRegionActionMember {
|
|
2647
2647
|
addRegionAction: AddRegionAction;
|
|
@@ -2649,9 +2649,9 @@ export declare namespace UpdateReplicationSetAction {
|
|
|
2649
2649
|
$unknown?: never;
|
|
2650
2650
|
}
|
|
2651
2651
|
/**
|
|
2652
|
-
* @public
|
|
2653
2652
|
* <p>Details about the Amazon Web Services Region that you're deleting to the replication
|
|
2654
2653
|
* set.</p>
|
|
2654
|
+
* @public
|
|
2655
2655
|
*/
|
|
2656
2656
|
interface DeleteRegionActionMember {
|
|
2657
2657
|
addRegionAction?: never;
|
|
@@ -2678,19 +2678,19 @@ export declare namespace UpdateReplicationSetAction {
|
|
|
2678
2678
|
*/
|
|
2679
2679
|
export interface UpdateReplicationSetInput {
|
|
2680
2680
|
/**
|
|
2681
|
-
* @public
|
|
2682
2681
|
* <p>The Amazon Resource Name (ARN) of the replication set you're updating.</p>
|
|
2682
|
+
* @public
|
|
2683
2683
|
*/
|
|
2684
2684
|
arn: string | undefined;
|
|
2685
2685
|
/**
|
|
2686
|
-
* @public
|
|
2687
2686
|
* <p>An action to add or delete a Region.</p>
|
|
2687
|
+
* @public
|
|
2688
2688
|
*/
|
|
2689
2689
|
actions: UpdateReplicationSetAction[] | undefined;
|
|
2690
2690
|
/**
|
|
2691
|
-
* @public
|
|
2692
2691
|
* <p>A token that ensures that the operation is called only once with the specified
|
|
2693
2692
|
* details.</p>
|
|
2693
|
+
* @public
|
|
2694
2694
|
*/
|
|
2695
2695
|
clientToken?: string;
|
|
2696
2696
|
}
|
|
@@ -2704,27 +2704,26 @@ export interface UpdateReplicationSetOutput {
|
|
|
2704
2704
|
*/
|
|
2705
2705
|
export interface UpdateResponsePlanInput {
|
|
2706
2706
|
/**
|
|
2707
|
-
* @public
|
|
2708
2707
|
* <p>A token ensuring that the operation is called only once with the specified details.</p>
|
|
2708
|
+
* @public
|
|
2709
2709
|
*/
|
|
2710
2710
|
clientToken?: string;
|
|
2711
2711
|
/**
|
|
2712
|
-
* @public
|
|
2713
2712
|
* <p>The Amazon Resource Name (ARN) of the response plan.</p>
|
|
2713
|
+
* @public
|
|
2714
2714
|
*/
|
|
2715
2715
|
arn: string | undefined;
|
|
2716
2716
|
/**
|
|
2717
|
-
* @public
|
|
2718
2717
|
* <p>The long format name of the response plan. The display name can't contain spaces.</p>
|
|
2718
|
+
* @public
|
|
2719
2719
|
*/
|
|
2720
2720
|
displayName?: string;
|
|
2721
2721
|
/**
|
|
2722
|
-
* @public
|
|
2723
2722
|
* <p>The short format name of the incident. The title can't contain spaces.</p>
|
|
2723
|
+
* @public
|
|
2724
2724
|
*/
|
|
2725
2725
|
incidentTemplateTitle?: string;
|
|
2726
2726
|
/**
|
|
2727
|
-
* @public
|
|
2728
2727
|
* <p>Defines the impact to the customers. Providing an impact overwrites the impact provided by
|
|
2729
2728
|
* a response plan.</p>
|
|
2730
2729
|
* <p class="title">
|
|
@@ -2752,54 +2751,55 @@ export interface UpdateResponsePlanInput {
|
|
|
2752
2751
|
* <code>5</code> - No Impact</p>
|
|
2753
2752
|
* </li>
|
|
2754
2753
|
* </ul>
|
|
2754
|
+
* @public
|
|
2755
2755
|
*/
|
|
2756
2756
|
incidentTemplateImpact?: number;
|
|
2757
2757
|
/**
|
|
2758
|
-
* @public
|
|
2759
2758
|
* <p>A brief summary of the incident. This typically contains what has happened, what's
|
|
2760
2759
|
* currently happening, and next steps.</p>
|
|
2760
|
+
* @public
|
|
2761
2761
|
*/
|
|
2762
2762
|
incidentTemplateSummary?: string;
|
|
2763
2763
|
/**
|
|
2764
|
-
* @public
|
|
2765
2764
|
* <p>The string Incident Manager uses to prevent duplicate incidents from being created by the same
|
|
2766
2765
|
* incident in the same account.</p>
|
|
2766
|
+
* @public
|
|
2767
2767
|
*/
|
|
2768
2768
|
incidentTemplateDedupeString?: string;
|
|
2769
2769
|
/**
|
|
2770
|
-
* @public
|
|
2771
2770
|
* <p>The Amazon SNS targets that are notified when updates are made to an
|
|
2772
2771
|
* incident.</p>
|
|
2772
|
+
* @public
|
|
2773
2773
|
*/
|
|
2774
2774
|
incidentTemplateNotificationTargets?: NotificationTargetItem[];
|
|
2775
2775
|
/**
|
|
2776
|
-
* @public
|
|
2777
2776
|
* <p>The Chatbot chat channel used for collaboration during an incident.</p>
|
|
2778
2777
|
* <p>Use the empty structure to remove the chat channel from the response plan.</p>
|
|
2778
|
+
* @public
|
|
2779
2779
|
*/
|
|
2780
2780
|
chatChannel?: ChatChannel;
|
|
2781
2781
|
/**
|
|
2782
|
-
* @public
|
|
2783
2782
|
* <p>The Amazon Resource Name (ARN) for the contacts and escalation plans that the response
|
|
2784
2783
|
* plan engages during an incident.</p>
|
|
2784
|
+
* @public
|
|
2785
2785
|
*/
|
|
2786
2786
|
engagements?: string[];
|
|
2787
2787
|
/**
|
|
2788
|
-
* @public
|
|
2789
2788
|
* <p>The actions that this response plan takes at the beginning of an incident.</p>
|
|
2789
|
+
* @public
|
|
2790
2790
|
*/
|
|
2791
2791
|
actions?: Action[];
|
|
2792
2792
|
/**
|
|
2793
|
-
* @public
|
|
2794
2793
|
* <p>Tags to assign to the template. When the <code>StartIncident</code> API action is called,
|
|
2795
2794
|
* Incident Manager assigns the tags specified in the template to the incident. To call this action,
|
|
2796
2795
|
* you must also have permission to call the <code>TagResource</code> API action for the incident
|
|
2797
2796
|
* record resource.</p>
|
|
2797
|
+
* @public
|
|
2798
2798
|
*/
|
|
2799
2799
|
incidentTemplateTags?: Record<string, string>;
|
|
2800
2800
|
/**
|
|
2801
|
-
* @public
|
|
2802
2801
|
* <p>Information about third-party services integrated into the response plan.</p>
|
|
2802
|
+
* @public
|
|
2803
2803
|
*/
|
|
2804
2804
|
integrations?: Integration[];
|
|
2805
2805
|
}
|
|
@@ -2813,40 +2813,39 @@ export interface UpdateResponsePlanOutput {
|
|
|
2813
2813
|
*/
|
|
2814
2814
|
export interface UpdateTimelineEventInput {
|
|
2815
2815
|
/**
|
|
2816
|
-
* @public
|
|
2817
2816
|
* <p>A token that ensures that a client calls the operation only once with the specified
|
|
2818
2817
|
* details.</p>
|
|
2818
|
+
* @public
|
|
2819
2819
|
*/
|
|
2820
2820
|
clientToken?: string;
|
|
2821
2821
|
/**
|
|
2822
|
-
* @public
|
|
2823
2822
|
* <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
|
|
2823
|
+
* @public
|
|
2824
2824
|
*/
|
|
2825
2825
|
incidentRecordArn: string | undefined;
|
|
2826
2826
|
/**
|
|
2827
|
-
* @public
|
|
2828
2827
|
* <p>The ID of the event to update. You can use <code>ListTimelineEvents</code> to find an
|
|
2829
2828
|
* event's ID.</p>
|
|
2829
|
+
* @public
|
|
2830
2830
|
*/
|
|
2831
2831
|
eventId: string | undefined;
|
|
2832
2832
|
/**
|
|
2833
|
-
* @public
|
|
2834
2833
|
* <p>The timestamp for when the event occurred.</p>
|
|
2834
|
+
* @public
|
|
2835
2835
|
*/
|
|
2836
2836
|
eventTime?: Date;
|
|
2837
2837
|
/**
|
|
2838
|
-
* @public
|
|
2839
2838
|
* <p>The type of event. You can update events of type <code>Custom Event</code> and
|
|
2840
2839
|
* <code>Note</code>.</p>
|
|
2840
|
+
* @public
|
|
2841
2841
|
*/
|
|
2842
2842
|
eventType?: string;
|
|
2843
2843
|
/**
|
|
2844
|
-
* @public
|
|
2845
2844
|
* <p>A short description of the event.</p>
|
|
2845
|
+
* @public
|
|
2846
2846
|
*/
|
|
2847
2847
|
eventData?: string;
|
|
2848
2848
|
/**
|
|
2849
|
-
* @public
|
|
2850
2849
|
* <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
|
|
2851
2850
|
* its Amazon Resource Name (ARN). You can also specify a related item associated with that
|
|
2852
2851
|
* resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a
|
|
@@ -2857,6 +2856,7 @@ export interface UpdateTimelineEventInput {
|
|
|
2857
2856
|
* references, you must specify them in the call. If you don't, this action removes any
|
|
2858
2857
|
* existing references and enters only new references.</p>
|
|
2859
2858
|
* </important>
|
|
2859
|
+
* @public
|
|
2860
2860
|
*/
|
|
2861
2861
|
eventReferences?: EventReference[];
|
|
2862
2862
|
}
|