/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / ssmincidents.d.ts
ssmincidents.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {WaiterConfiguration} from '../lib/service'; 6 import {ServiceConfigurationOptions} from '../lib/service'; 7 import {ConfigBase as Config} from '../lib/config-base'; 8 interface Blob {} 9 declare class SSMIncidents extends Service { 10 /** 11 * Constructs a service object. This object has one method for each API operation. 12 */ 13 constructor(options?: SSMIncidents.Types.ClientConfiguration) 14 config: Config & SSMIncidents.Types.ClientConfiguration; 15 /** 16 * A replication set replicates and encrypts your data to the provided Regions with the provided KMS key. 17 */ 18 createReplicationSet(params: SSMIncidents.Types.CreateReplicationSetInput, callback?: (err: AWSError, data: SSMIncidents.Types.CreateReplicationSetOutput) => void): Request<SSMIncidents.Types.CreateReplicationSetOutput, AWSError>; 19 /** 20 * A replication set replicates and encrypts your data to the provided Regions with the provided KMS key. 21 */ 22 createReplicationSet(callback?: (err: AWSError, data: SSMIncidents.Types.CreateReplicationSetOutput) => void): Request<SSMIncidents.Types.CreateReplicationSetOutput, AWSError>; 23 /** 24 * Creates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning of an incident. 25 */ 26 createResponsePlan(params: SSMIncidents.Types.CreateResponsePlanInput, callback?: (err: AWSError, data: SSMIncidents.Types.CreateResponsePlanOutput) => void): Request<SSMIncidents.Types.CreateResponsePlanOutput, AWSError>; 27 /** 28 * Creates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning of an incident. 29 */ 30 createResponsePlan(callback?: (err: AWSError, data: SSMIncidents.Types.CreateResponsePlanOutput) => void): Request<SSMIncidents.Types.CreateResponsePlanOutput, AWSError>; 31 /** 32 * Creates a custom timeline event on the incident details page of an incident record. Timeline events are automatically created by Incident Manager, marking key moment during an incident. You can create custom timeline events to mark important events that are automatically detected by Incident Manager. 33 */ 34 createTimelineEvent(params: SSMIncidents.Types.CreateTimelineEventInput, callback?: (err: AWSError, data: SSMIncidents.Types.CreateTimelineEventOutput) => void): Request<SSMIncidents.Types.CreateTimelineEventOutput, AWSError>; 35 /** 36 * Creates a custom timeline event on the incident details page of an incident record. Timeline events are automatically created by Incident Manager, marking key moment during an incident. You can create custom timeline events to mark important events that are automatically detected by Incident Manager. 37 */ 38 createTimelineEvent(callback?: (err: AWSError, data: SSMIncidents.Types.CreateTimelineEventOutput) => void): Request<SSMIncidents.Types.CreateTimelineEventOutput, AWSError>; 39 /** 40 * Delete an incident record from Incident Manager. 41 */ 42 deleteIncidentRecord(params: SSMIncidents.Types.DeleteIncidentRecordInput, callback?: (err: AWSError, data: SSMIncidents.Types.DeleteIncidentRecordOutput) => void): Request<SSMIncidents.Types.DeleteIncidentRecordOutput, AWSError>; 43 /** 44 * Delete an incident record from Incident Manager. 45 */ 46 deleteIncidentRecord(callback?: (err: AWSError, data: SSMIncidents.Types.DeleteIncidentRecordOutput) => void): Request<SSMIncidents.Types.DeleteIncidentRecordOutput, AWSError>; 47 /** 48 * Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data. 49 */ 50 deleteReplicationSet(params: SSMIncidents.Types.DeleteReplicationSetInput, callback?: (err: AWSError, data: SSMIncidents.Types.DeleteReplicationSetOutput) => void): Request<SSMIncidents.Types.DeleteReplicationSetOutput, AWSError>; 51 /** 52 * Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data. 53 */ 54 deleteReplicationSet(callback?: (err: AWSError, data: SSMIncidents.Types.DeleteReplicationSetOutput) => void): Request<SSMIncidents.Types.DeleteReplicationSetOutput, AWSError>; 55 /** 56 * Deletes the resource policy that AWS Resource Access Manager uses to share your Incident Manager resource. 57 */ 58 deleteResourcePolicy(params: SSMIncidents.Types.DeleteResourcePolicyInput, callback?: (err: AWSError, data: SSMIncidents.Types.DeleteResourcePolicyOutput) => void): Request<SSMIncidents.Types.DeleteResourcePolicyOutput, AWSError>; 59 /** 60 * Deletes the resource policy that AWS Resource Access Manager uses to share your Incident Manager resource. 61 */ 62 deleteResourcePolicy(callback?: (err: AWSError, data: SSMIncidents.Types.DeleteResourcePolicyOutput) => void): Request<SSMIncidents.Types.DeleteResourcePolicyOutput, AWSError>; 63 /** 64 * Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response plan. 65 */ 66 deleteResponsePlan(params: SSMIncidents.Types.DeleteResponsePlanInput, callback?: (err: AWSError, data: SSMIncidents.Types.DeleteResponsePlanOutput) => void): Request<SSMIncidents.Types.DeleteResponsePlanOutput, AWSError>; 67 /** 68 * Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response plan. 69 */ 70 deleteResponsePlan(callback?: (err: AWSError, data: SSMIncidents.Types.DeleteResponsePlanOutput) => void): Request<SSMIncidents.Types.DeleteResponsePlanOutput, AWSError>; 71 /** 72 * Deletes a timeline event from an incident. 73 */ 74 deleteTimelineEvent(params: SSMIncidents.Types.DeleteTimelineEventInput, callback?: (err: AWSError, data: SSMIncidents.Types.DeleteTimelineEventOutput) => void): Request<SSMIncidents.Types.DeleteTimelineEventOutput, AWSError>; 75 /** 76 * Deletes a timeline event from an incident. 77 */ 78 deleteTimelineEvent(callback?: (err: AWSError, data: SSMIncidents.Types.DeleteTimelineEventOutput) => void): Request<SSMIncidents.Types.DeleteTimelineEventOutput, AWSError>; 79 /** 80 * Returns the details of the specified incident record. 81 */ 82 getIncidentRecord(params: SSMIncidents.Types.GetIncidentRecordInput, callback?: (err: AWSError, data: SSMIncidents.Types.GetIncidentRecordOutput) => void): Request<SSMIncidents.Types.GetIncidentRecordOutput, AWSError>; 83 /** 84 * Returns the details of the specified incident record. 85 */ 86 getIncidentRecord(callback?: (err: AWSError, data: SSMIncidents.Types.GetIncidentRecordOutput) => void): Request<SSMIncidents.Types.GetIncidentRecordOutput, AWSError>; 87 /** 88 * Retrieve your Incident Manager replication set. 89 */ 90 getReplicationSet(params: SSMIncidents.Types.GetReplicationSetInput, callback?: (err: AWSError, data: SSMIncidents.Types.GetReplicationSetOutput) => void): Request<SSMIncidents.Types.GetReplicationSetOutput, AWSError>; 91 /** 92 * Retrieve your Incident Manager replication set. 93 */ 94 getReplicationSet(callback?: (err: AWSError, data: SSMIncidents.Types.GetReplicationSetOutput) => void): Request<SSMIncidents.Types.GetReplicationSetOutput, AWSError>; 95 /** 96 * Retrieves the resource policies attached to the specified response plan. 97 */ 98 getResourcePolicies(params: SSMIncidents.Types.GetResourcePoliciesInput, callback?: (err: AWSError, data: SSMIncidents.Types.GetResourcePoliciesOutput) => void): Request<SSMIncidents.Types.GetResourcePoliciesOutput, AWSError>; 99 /** 100 * Retrieves the resource policies attached to the specified response plan. 101 */ 102 getResourcePolicies(callback?: (err: AWSError, data: SSMIncidents.Types.GetResourcePoliciesOutput) => void): Request<SSMIncidents.Types.GetResourcePoliciesOutput, AWSError>; 103 /** 104 * Retrieves the details of the specified response plan. 105 */ 106 getResponsePlan(params: SSMIncidents.Types.GetResponsePlanInput, callback?: (err: AWSError, data: SSMIncidents.Types.GetResponsePlanOutput) => void): Request<SSMIncidents.Types.GetResponsePlanOutput, AWSError>; 107 /** 108 * Retrieves the details of the specified response plan. 109 */ 110 getResponsePlan(callback?: (err: AWSError, data: SSMIncidents.Types.GetResponsePlanOutput) => void): Request<SSMIncidents.Types.GetResponsePlanOutput, AWSError>; 111 /** 112 * Retrieves a timeline event based on its ID and incident record. 113 */ 114 getTimelineEvent(params: SSMIncidents.Types.GetTimelineEventInput, callback?: (err: AWSError, data: SSMIncidents.Types.GetTimelineEventOutput) => void): Request<SSMIncidents.Types.GetTimelineEventOutput, AWSError>; 115 /** 116 * Retrieves a timeline event based on its ID and incident record. 117 */ 118 getTimelineEvent(callback?: (err: AWSError, data: SSMIncidents.Types.GetTimelineEventOutput) => void): Request<SSMIncidents.Types.GetTimelineEventOutput, AWSError>; 119 /** 120 * Lists all incident records in your account. Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update. 121 */ 122 listIncidentRecords(params: SSMIncidents.Types.ListIncidentRecordsInput, callback?: (err: AWSError, data: SSMIncidents.Types.ListIncidentRecordsOutput) => void): Request<SSMIncidents.Types.ListIncidentRecordsOutput, AWSError>; 123 /** 124 * Lists all incident records in your account. Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update. 125 */ 126 listIncidentRecords(callback?: (err: AWSError, data: SSMIncidents.Types.ListIncidentRecordsOutput) => void): Request<SSMIncidents.Types.ListIncidentRecordsOutput, AWSError>; 127 /** 128 * List all related items for an incident record. 129 */ 130 listRelatedItems(params: SSMIncidents.Types.ListRelatedItemsInput, callback?: (err: AWSError, data: SSMIncidents.Types.ListRelatedItemsOutput) => void): Request<SSMIncidents.Types.ListRelatedItemsOutput, AWSError>; 131 /** 132 * List all related items for an incident record. 133 */ 134 listRelatedItems(callback?: (err: AWSError, data: SSMIncidents.Types.ListRelatedItemsOutput) => void): Request<SSMIncidents.Types.ListRelatedItemsOutput, AWSError>; 135 /** 136 * Lists details about the replication set configured in your account. 137 */ 138 listReplicationSets(params: SSMIncidents.Types.ListReplicationSetsInput, callback?: (err: AWSError, data: SSMIncidents.Types.ListReplicationSetsOutput) => void): Request<SSMIncidents.Types.ListReplicationSetsOutput, AWSError>; 139 /** 140 * Lists details about the replication set configured in your account. 141 */ 142 listReplicationSets(callback?: (err: AWSError, data: SSMIncidents.Types.ListReplicationSetsOutput) => void): Request<SSMIncidents.Types.ListReplicationSetsOutput, AWSError>; 143 /** 144 * Lists all response plans in your account. 145 */ 146 listResponsePlans(params: SSMIncidents.Types.ListResponsePlansInput, callback?: (err: AWSError, data: SSMIncidents.Types.ListResponsePlansOutput) => void): Request<SSMIncidents.Types.ListResponsePlansOutput, AWSError>; 147 /** 148 * Lists all response plans in your account. 149 */ 150 listResponsePlans(callback?: (err: AWSError, data: SSMIncidents.Types.ListResponsePlansOutput) => void): Request<SSMIncidents.Types.ListResponsePlansOutput, AWSError>; 151 /** 152 * Lists the tags that are attached to the specified response plan. 153 */ 154 listTagsForResource(params: SSMIncidents.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: SSMIncidents.Types.ListTagsForResourceResponse) => void): Request<SSMIncidents.Types.ListTagsForResourceResponse, AWSError>; 155 /** 156 * Lists the tags that are attached to the specified response plan. 157 */ 158 listTagsForResource(callback?: (err: AWSError, data: SSMIncidents.Types.ListTagsForResourceResponse) => void): Request<SSMIncidents.Types.ListTagsForResourceResponse, AWSError>; 159 /** 160 * Lists timeline events of the specified incident record. 161 */ 162 listTimelineEvents(params: SSMIncidents.Types.ListTimelineEventsInput, callback?: (err: AWSError, data: SSMIncidents.Types.ListTimelineEventsOutput) => void): Request<SSMIncidents.Types.ListTimelineEventsOutput, AWSError>; 163 /** 164 * Lists timeline events of the specified incident record. 165 */ 166 listTimelineEvents(callback?: (err: AWSError, data: SSMIncidents.Types.ListTimelineEventsOutput) => void): Request<SSMIncidents.Types.ListTimelineEventsOutput, AWSError>; 167 /** 168 * Adds a resource policy to the specified response plan. 169 */ 170 putResourcePolicy(params: SSMIncidents.Types.PutResourcePolicyInput, callback?: (err: AWSError, data: SSMIncidents.Types.PutResourcePolicyOutput) => void): Request<SSMIncidents.Types.PutResourcePolicyOutput, AWSError>; 171 /** 172 * Adds a resource policy to the specified response plan. 173 */ 174 putResourcePolicy(callback?: (err: AWSError, data: SSMIncidents.Types.PutResourcePolicyOutput) => void): Request<SSMIncidents.Types.PutResourcePolicyOutput, AWSError>; 175 /** 176 * Used to start an incident from CloudWatch alarms, EventBridge events, or manually. 177 */ 178 startIncident(params: SSMIncidents.Types.StartIncidentInput, callback?: (err: AWSError, data: SSMIncidents.Types.StartIncidentOutput) => void): Request<SSMIncidents.Types.StartIncidentOutput, AWSError>; 179 /** 180 * Used to start an incident from CloudWatch alarms, EventBridge events, or manually. 181 */ 182 startIncident(callback?: (err: AWSError, data: SSMIncidents.Types.StartIncidentOutput) => void): Request<SSMIncidents.Types.StartIncidentOutput, AWSError>; 183 /** 184 * Adds a tag to a response plan. 185 */ 186 tagResource(params: SSMIncidents.Types.TagResourceRequest, callback?: (err: AWSError, data: SSMIncidents.Types.TagResourceResponse) => void): Request<SSMIncidents.Types.TagResourceResponse, AWSError>; 187 /** 188 * Adds a tag to a response plan. 189 */ 190 tagResource(callback?: (err: AWSError, data: SSMIncidents.Types.TagResourceResponse) => void): Request<SSMIncidents.Types.TagResourceResponse, AWSError>; 191 /** 192 * Removes a tag from a resource. 193 */ 194 untagResource(params: SSMIncidents.Types.UntagResourceRequest, callback?: (err: AWSError, data: SSMIncidents.Types.UntagResourceResponse) => void): Request<SSMIncidents.Types.UntagResourceResponse, AWSError>; 195 /** 196 * Removes a tag from a resource. 197 */ 198 untagResource(callback?: (err: AWSError, data: SSMIncidents.Types.UntagResourceResponse) => void): Request<SSMIncidents.Types.UntagResourceResponse, AWSError>; 199 /** 200 * Update deletion protection to either allow or deny deletion of the final Region in a replication set. 201 */ 202 updateDeletionProtection(params: SSMIncidents.Types.UpdateDeletionProtectionInput, callback?: (err: AWSError, data: SSMIncidents.Types.UpdateDeletionProtectionOutput) => void): Request<SSMIncidents.Types.UpdateDeletionProtectionOutput, AWSError>; 203 /** 204 * Update deletion protection to either allow or deny deletion of the final Region in a replication set. 205 */ 206 updateDeletionProtection(callback?: (err: AWSError, data: SSMIncidents.Types.UpdateDeletionProtectionOutput) => void): Request<SSMIncidents.Types.UpdateDeletionProtectionOutput, AWSError>; 207 /** 208 * Update the details of an incident record. You can use this action to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat. 209 */ 210 updateIncidentRecord(params: SSMIncidents.Types.UpdateIncidentRecordInput, callback?: (err: AWSError, data: SSMIncidents.Types.UpdateIncidentRecordOutput) => void): Request<SSMIncidents.Types.UpdateIncidentRecordOutput, AWSError>; 211 /** 212 * Update the details of an incident record. You can use this action to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat. 213 */ 214 updateIncidentRecord(callback?: (err: AWSError, data: SSMIncidents.Types.UpdateIncidentRecordOutput) => void): Request<SSMIncidents.Types.UpdateIncidentRecordOutput, AWSError>; 215 /** 216 * Add or remove related items from the related items tab of an incident record. 217 */ 218 updateRelatedItems(params: SSMIncidents.Types.UpdateRelatedItemsInput, callback?: (err: AWSError, data: SSMIncidents.Types.UpdateRelatedItemsOutput) => void): Request<SSMIncidents.Types.UpdateRelatedItemsOutput, AWSError>; 219 /** 220 * Add or remove related items from the related items tab of an incident record. 221 */ 222 updateRelatedItems(callback?: (err: AWSError, data: SSMIncidents.Types.UpdateRelatedItemsOutput) => void): Request<SSMIncidents.Types.UpdateRelatedItemsOutput, AWSError>; 223 /** 224 * Add or delete Regions from your replication set. 225 */ 226 updateReplicationSet(params: SSMIncidents.Types.UpdateReplicationSetInput, callback?: (err: AWSError, data: SSMIncidents.Types.UpdateReplicationSetOutput) => void): Request<SSMIncidents.Types.UpdateReplicationSetOutput, AWSError>; 227 /** 228 * Add or delete Regions from your replication set. 229 */ 230 updateReplicationSet(callback?: (err: AWSError, data: SSMIncidents.Types.UpdateReplicationSetOutput) => void): Request<SSMIncidents.Types.UpdateReplicationSetOutput, AWSError>; 231 /** 232 * Updates the specified response plan. 233 */ 234 updateResponsePlan(params: SSMIncidents.Types.UpdateResponsePlanInput, callback?: (err: AWSError, data: SSMIncidents.Types.UpdateResponsePlanOutput) => void): Request<SSMIncidents.Types.UpdateResponsePlanOutput, AWSError>; 235 /** 236 * Updates the specified response plan. 237 */ 238 updateResponsePlan(callback?: (err: AWSError, data: SSMIncidents.Types.UpdateResponsePlanOutput) => void): Request<SSMIncidents.Types.UpdateResponsePlanOutput, AWSError>; 239 /** 240 * Updates a timeline event. You can update events of type Custom Event. 241 */ 242 updateTimelineEvent(params: SSMIncidents.Types.UpdateTimelineEventInput, callback?: (err: AWSError, data: SSMIncidents.Types.UpdateTimelineEventOutput) => void): Request<SSMIncidents.Types.UpdateTimelineEventOutput, AWSError>; 243 /** 244 * Updates a timeline event. You can update events of type Custom Event. 245 */ 246 updateTimelineEvent(callback?: (err: AWSError, data: SSMIncidents.Types.UpdateTimelineEventOutput) => void): Request<SSMIncidents.Types.UpdateTimelineEventOutput, AWSError>; 247 /** 248 * Waits for the waitForReplicationSetActive state by periodically calling the underlying SSMIncidents.getReplicationSetoperation every 30 seconds (at most 5 times). Wait for a replication set to become ACTIVE 249 */ 250 waitFor(state: "waitForReplicationSetActive", params: SSMIncidents.Types.GetReplicationSetInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SSMIncidents.Types.GetReplicationSetOutput) => void): Request<SSMIncidents.Types.GetReplicationSetOutput, AWSError>; 251 /** 252 * Waits for the waitForReplicationSetActive state by periodically calling the underlying SSMIncidents.getReplicationSetoperation every 30 seconds (at most 5 times). Wait for a replication set to become ACTIVE 253 */ 254 waitFor(state: "waitForReplicationSetActive", callback?: (err: AWSError, data: SSMIncidents.Types.GetReplicationSetOutput) => void): Request<SSMIncidents.Types.GetReplicationSetOutput, AWSError>; 255 /** 256 * Waits for the waitForReplicationSetDeleted state by periodically calling the underlying SSMIncidents.getReplicationSetoperation every 30 seconds (at most 5 times). Wait for a replication set to be deleted 257 */ 258 waitFor(state: "waitForReplicationSetDeleted", params: SSMIncidents.Types.GetReplicationSetInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: SSMIncidents.Types.GetReplicationSetOutput) => void): Request<SSMIncidents.Types.GetReplicationSetOutput, AWSError>; 259 /** 260 * Waits for the waitForReplicationSetDeleted state by periodically calling the underlying SSMIncidents.getReplicationSetoperation every 30 seconds (at most 5 times). Wait for a replication set to be deleted 261 */ 262 waitFor(state: "waitForReplicationSetDeleted", callback?: (err: AWSError, data: SSMIncidents.Types.GetReplicationSetOutput) => void): Request<SSMIncidents.Types.GetReplicationSetOutput, AWSError>; 263 } 264 declare namespace SSMIncidents { 265 export interface Action { 266 /** 267 * The Systems Manager automation document to start as the runbook at the beginning of the incident. 268 */ 269 ssmAutomation?: SsmAutomation; 270 } 271 export type ActionsList = Action[]; 272 export interface AddRegionAction { 273 /** 274 * The Region name to add to the replication set. 275 */ 276 regionName: RegionName; 277 /** 278 * The KMS key ID to use to encrypt your replication set. 279 */ 280 sseKmsKeyId?: SseKmsKey; 281 } 282 export type Arn = string; 283 export interface AttributeValueList { 284 /** 285 * The list of integer values that the filter matches. 286 */ 287 integerValues?: IntegerList; 288 /** 289 * The list of string values that the filter matches. 290 */ 291 stringValues?: StringList; 292 } 293 export interface AutomationExecution { 294 /** 295 * The Amazon Resource Name (ARN) of the automation process. 296 */ 297 ssmExecutionArn?: Arn; 298 } 299 export type AutomationExecutionSet = AutomationExecution[]; 300 export type Boolean = boolean; 301 export interface ChatChannel { 302 /** 303 * The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the SNS topics. 304 */ 305 chatbotSns?: ChatbotSnsConfigurationSet; 306 /** 307 * Used to remove the chat channel from an incident record or response plan. 308 */ 309 empty?: EmptyChatChannel; 310 } 311 export type ChatbotSnsConfigurationSet = SnsArn[]; 312 export type ClientToken = string; 313 export interface Condition { 314 /** 315 * After the specified timestamp. 316 */ 317 after?: Timestamp; 318 /** 319 * Before the specified timestamp 320 */ 321 before?: Timestamp; 322 /** 323 * The value is equal to the provided string or integer. 324 */ 325 equals?: AttributeValueList; 326 } 327 export interface CreateReplicationSetInput { 328 /** 329 * A token ensuring that the action is called only once with the specified details. 330 */ 331 clientToken?: ClientToken; 332 /** 333 * The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set. 334 */ 335 regions: RegionMapInput; 336 } 337 export interface CreateReplicationSetOutput { 338 /** 339 * The Amazon Resource Name (ARN) of the replication set. 340 */ 341 arn: Arn; 342 } 343 export interface CreateResponsePlanInput { 344 /** 345 * The actions that the response plan starts at the beginning of an incident. 346 */ 347 actions?: ActionsList; 348 /** 349 * The AWS Chatbot chat channel used for collaboration during an incident. 350 */ 351 chatChannel?: ChatChannel; 352 /** 353 * A token ensuring that the action is called only once with the specified details. 354 */ 355 clientToken?: ClientToken; 356 /** 357 * The long format of the response plan name. This field can contain spaces. 358 */ 359 displayName?: ResponsePlanDisplayName; 360 /** 361 * The contacts and escalation plans that the response plan engages during an incident. 362 */ 363 engagements?: EngagementSet; 364 /** 365 * Details used to create an incident when using this response plan. 366 */ 367 incidentTemplate: IncidentTemplate; 368 /** 369 * The short format name of the response plan. Can't include spaces. 370 */ 371 name: ResponsePlanName; 372 /** 373 * A list of tags that you are adding to the response plan. 374 */ 375 tags?: TagMap; 376 } 377 export interface CreateResponsePlanOutput { 378 /** 379 * The Amazon Resource Name (ARN) of the response plan. 380 */ 381 arn: Arn; 382 } 383 export interface CreateTimelineEventInput { 384 /** 385 * A token ensuring that the action is called only once with the specified details. 386 */ 387 clientToken?: ClientToken; 388 /** 389 * A valid JSON string. There is no other schema imposed. A short description of the event. 390 */ 391 eventData: EventData; 392 /** 393 * The time that the event occurred. 394 */ 395 eventTime: Timestamp; 396 /** 397 * The type of the event. You can create timeline events of type Custom Event. 398 */ 399 eventType: TimelineEventType; 400 /** 401 * The Amazon Resource Name (ARN) of the incident record you are adding the event to. 402 */ 403 incidentRecordArn: Arn; 404 } 405 export interface CreateTimelineEventOutput { 406 /** 407 * The ID of the event for easy reference later. 408 */ 409 eventId: UUID; 410 /** 411 * The ARN of the incident record that you added the event to. 412 */ 413 incidentRecordArn: Arn; 414 } 415 export type DedupeString = string; 416 export interface DeleteIncidentRecordInput { 417 /** 418 * The Amazon Resource Name (ARN) of the incident record you are deleting. 419 */ 420 arn: Arn; 421 } 422 export interface DeleteIncidentRecordOutput { 423 } 424 export interface DeleteRegionAction { 425 /** 426 * The name of the Region you're deleting from the replication set. 427 */ 428 regionName: RegionName; 429 } 430 export interface DeleteReplicationSetInput { 431 /** 432 * The Amazon Resource Name (ARN) of the replication set you're deleting. 433 */ 434 arn: Arn; 435 } 436 export interface DeleteReplicationSetOutput { 437 } 438 export interface DeleteResourcePolicyInput { 439 /** 440 * The ID of the resource policy you're deleting. 441 */ 442 policyId: PolicyId; 443 /** 444 * The Amazon Resource Name (ARN) of the resource you're deleting the policy from. 445 */ 446 resourceArn: Arn; 447 } 448 export interface DeleteResourcePolicyOutput { 449 } 450 export interface DeleteResponsePlanInput { 451 /** 452 * The Amazon Resource Name (ARN) of the response plan. 453 */ 454 arn: Arn; 455 } 456 export interface DeleteResponsePlanOutput { 457 } 458 export interface DeleteTimelineEventInput { 459 /** 460 * The ID of the event you are updating. You can find this by using ListTimelineEvents. 461 */ 462 eventId: UUID; 463 /** 464 * The Amazon Resource Name (ARN) of the incident that the event is part of. 465 */ 466 incidentRecordArn: Arn; 467 } 468 export interface DeleteTimelineEventOutput { 469 } 470 export interface EmptyChatChannel { 471 } 472 export type EngagementSet = SsmContactsArn[]; 473 export type EventData = string; 474 export interface EventSummary { 475 /** 476 * The timeline event ID. 477 */ 478 eventId: UUID; 479 /** 480 * The time that the event occurred. 481 */ 482 eventTime: Timestamp; 483 /** 484 * The type of event. The timeline event must be Custom Event. 485 */ 486 eventType: TimelineEventType; 487 /** 488 * The time that the timeline event was last updated. 489 */ 490 eventUpdatedTime: Timestamp; 491 /** 492 * The Amazon Resource Name (ARN) of the incident that the event happened during. 493 */ 494 incidentRecordArn: Arn; 495 } 496 export type EventSummaryList = EventSummary[]; 497 export interface Filter { 498 /** 499 * The condition accepts before or after a specified time, equal to a string, or equal to an integer. 500 */ 501 condition: Condition; 502 /** 503 * The key that you're filtering on. 504 */ 505 key: FilterKeyString; 506 } 507 export type FilterKeyString = string; 508 export type FilterList = Filter[]; 509 export interface GetIncidentRecordInput { 510 /** 511 * The Amazon Resource Name (ARN) of the incident record. 512 */ 513 arn: Arn; 514 } 515 export interface GetIncidentRecordOutput { 516 /** 517 * Details structure of the incident record. 518 */ 519 incidentRecord: IncidentRecord; 520 } 521 export interface GetReplicationSetInput { 522 /** 523 * The Amazon Resource Name (ARN) of the replication set you want to retrieve. 524 */ 525 arn: Arn; 526 } 527 export interface GetReplicationSetOutput { 528 /** 529 * Details of the replication set. 530 */ 531 replicationSet: ReplicationSet; 532 } 533 export interface GetResourcePoliciesInput { 534 /** 535 * The maximum number of resource policies to display per page of results. 536 */ 537 maxResults?: MaxResults; 538 /** 539 * The pagination token to continue to the next page of results. 540 */ 541 nextToken?: NextToken; 542 /** 543 * The Amazon Resource Name (ARN) of the response plan with the attached resource policy. 544 */ 545 resourceArn: Arn; 546 } 547 export interface GetResourcePoliciesOutput { 548 /** 549 * The pagination token to continue to the next page of results. 550 */ 551 nextToken?: NextToken; 552 /** 553 * Details about the resource policy attached to the response plan. 554 */ 555 resourcePolicies: ResourcePolicyList; 556 } 557 export interface GetResponsePlanInput { 558 /** 559 * The Amazon Resource Name (ARN) of the response plan. 560 */ 561 arn: Arn; 562 } 563 export interface GetResponsePlanOutput { 564 /** 565 * The actions that this response plan takes at the beginning of the incident. 566 */ 567 actions?: ActionsList; 568 /** 569 * The ARN of the response plan. 570 */ 571 arn: Arn; 572 /** 573 * The AWS Chatbot chat channel used for collaboration during an incident. 574 */ 575 chatChannel?: ChatChannel; 576 /** 577 * The long format name of the response plan. Can contain spaces. 578 */ 579 displayName?: ResponsePlanDisplayName; 580 /** 581 * The contacts and escalation plans that the response plan engages during an incident. 582 */ 583 engagements?: EngagementSet; 584 /** 585 * Details used to create the incident when using this response plan. 586 */ 587 incidentTemplate: IncidentTemplate; 588 /** 589 * The short format name of the response plan. Can't contain spaces. 590 */ 591 name: ResponsePlanName; 592 } 593 export interface GetTimelineEventInput { 594 /** 595 * The ID of the event. You can get an event's ID when you create it or by using ListTimelineEvents. 596 */ 597 eventId: UUID; 598 /** 599 * The Amazon Resource Name (ARN) of the incident that the timeline event is part of. 600 */ 601 incidentRecordArn: Arn; 602 } 603 export interface GetTimelineEventOutput { 604 /** 605 * Details about the timeline event. 606 */ 607 event: TimelineEvent; 608 } 609 export type Impact = number; 610 export interface IncidentRecord { 611 /** 612 * The Amazon Resource Name (ARN) of the incident record. 613 */ 614 arn: Arn; 615 /** 616 * The runbook, or automation document, that's run at the beginning of the incident. 617 */ 618 automationExecutions?: AutomationExecutionSet; 619 /** 620 * The chat channel used for collaboration during an incident. 621 */ 622 chatChannel?: ChatChannel; 623 /** 624 * The time that Incident Manager created the incident record. 625 */ 626 creationTime: Timestamp; 627 /** 628 * The string Incident Manager uses to prevent duplicate incidents from being created by the same incident. 629 */ 630 dedupeString: DedupeString; 631 /** 632 * The impact of the incident on customers and applications. 633 */ 634 impact: Impact; 635 /** 636 * Details about the action that started the incident. 637 */ 638 incidentRecordSource: IncidentRecordSource; 639 /** 640 * Who modified the incident most recently. 641 */ 642 lastModifiedBy: Arn; 643 /** 644 * The time at which the incident was most recently modified. 645 */ 646 lastModifiedTime: Timestamp; 647 /** 648 * The SNS targets that are notified when updates are made to an incident. 649 */ 650 notificationTargets?: NotificationTargetSet; 651 /** 652 * The time at which the incident was resolved. This appears as a timeline event. 653 */ 654 resolvedTime?: Timestamp; 655 /** 656 * The current status of the incident. 657 */ 658 status: IncidentRecordStatus; 659 /** 660 * The summary of the incident. The summary is a brief synopsis of what occurred, what is currently happening, and context. 661 */ 662 summary?: IncidentSummary; 663 /** 664 * The title of the incident. 665 */ 666 title: IncidentTitle; 667 } 668 export interface IncidentRecordSource { 669 /** 670 * The principal that started the incident. 671 */ 672 createdBy: Arn; 673 /** 674 * The principal the assumed the role specified of the createdBy. 675 */ 676 invokedBy?: Arn; 677 /** 678 * The resource that caused the incident to be created. 679 */ 680 resourceArn?: Arn; 681 /** 682 * The service that started the incident. This can be manually created from Incident Manager, automatically created using an AWS CloudWatch alarm, or Amazon EventBridge event. 683 */ 684 source: IncidentSource; 685 } 686 export type IncidentRecordStatus = "OPEN"|"RESOLVED"|string; 687 export interface IncidentRecordSummary { 688 /** 689 * The Amazon Resource Name (ARN) of the incident. 690 */ 691 arn: Arn; 692 /** 693 * The time the incident was created. 694 */ 695 creationTime: Timestamp; 696 /** 697 * Defines the impact to customers and applications. 698 */ 699 impact: Impact; 700 /** 701 * What caused Incident Manager to create the incident. 702 */ 703 incidentRecordSource: IncidentRecordSource; 704 /** 705 * The time the incident was resolved. 706 */ 707 resolvedTime?: Timestamp; 708 /** 709 * The current status of the incident. 710 */ 711 status: IncidentRecordStatus; 712 /** 713 * The title of the incident. This value is either provided by the response plan or overwritten on creation. 714 */ 715 title: IncidentTitle; 716 } 717 export type IncidentRecordSummaryList = IncidentRecordSummary[]; 718 export type IncidentSource = string; 719 export type IncidentSummary = string; 720 export interface IncidentTemplate { 721 /** 722 * Used to stop Incident Manager from creating multiple incident records for the same incident. 723 */ 724 dedupeString?: DedupeString; 725 /** 726 * The impact of the incident on your customers and applications. 727 */ 728 impact: Impact; 729 /** 730 * The SNS targets that are notified when updates are made to an incident. 731 */ 732 notificationTargets?: NotificationTargetSet; 733 /** 734 * The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context. 735 */ 736 summary?: IncidentSummary; 737 /** 738 * The title of the incident. 739 */ 740 title: IncidentTitle; 741 } 742 export type IncidentTitle = string; 743 export type Integer = number; 744 export type IntegerList = Integer[]; 745 export interface ItemIdentifier { 746 /** 747 * The type of related item. Incident Manager supports the following types: ANALYSIS INCIDENT METRIC PARENT ATTACHMENT OTHER 748 */ 749 type: ItemType; 750 /** 751 * Details about the related item. 752 */ 753 value: ItemValue; 754 } 755 export type ItemType = "ANALYSIS"|"INCIDENT"|"METRIC"|"PARENT"|"ATTACHMENT"|"OTHER"|string; 756 export interface ItemValue { 757 /** 758 * The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource. 759 */ 760 arn?: Arn; 761 /** 762 * The metric definition, if the related item is a metric in CloudWatch. 763 */ 764 metricDefinition?: MetricDefinition; 765 /** 766 * The URL, if the related item is a non-AWS resource. 767 */ 768 url?: Url; 769 } 770 export interface ListIncidentRecordsInput { 771 /** 772 * Filter the list of incident records you are searching through. You can filter on the following keys: creationTime impact status createdBy 773 */ 774 filters?: FilterList; 775 /** 776 * The maximum number of results per page. 777 */ 778 maxResults?: MaxResults; 779 /** 780 * The pagination token to continue to the next page of results. 781 */ 782 nextToken?: NextToken; 783 } 784 export interface ListIncidentRecordsOutput { 785 /** 786 * The details of each listed incident record. 787 */ 788 incidentRecordSummaries: IncidentRecordSummaryList; 789 /** 790 * The pagination token to continue to the next page of results. 791 */ 792 nextToken?: NextToken; 793 } 794 export interface ListRelatedItemsInput { 795 /** 796 * The Amazon Resource Name (ARN) of the incident record that you are listing related items for. 797 */ 798 incidentRecordArn: Arn; 799 /** 800 * The maximum number of related items per page. 801 */ 802 maxResults?: MaxResults; 803 /** 804 * The pagination token to continue to the next page of results. 805 */ 806 nextToken?: NextToken; 807 } 808 export interface ListRelatedItemsOutput { 809 /** 810 * The pagination token to continue to the next page of results. 811 */ 812 nextToken?: NextToken; 813 /** 814 * Details about each related item. 815 */ 816 relatedItems: RelatedItemList; 817 } 818 export interface ListReplicationSetsInput { 819 /** 820 * The maximum number of results per page. 821 */ 822 maxResults?: MaxResults; 823 /** 824 * The pagination token to continue to the next page of results. 825 */ 826 nextToken?: NextToken; 827 } 828 export interface ListReplicationSetsOutput { 829 /** 830 * The pagination token to continue to the next page of results. 831 */ 832 nextToken?: NextToken; 833 /** 834 * The Amazon Resource Name (ARN) of the list replication set. 835 */ 836 replicationSetArns: ReplicationSetArnList; 837 } 838 export interface ListResponsePlansInput { 839 /** 840 * The maximum number of response plans per page. 841 */ 842 maxResults?: MaxResults; 843 /** 844 * The pagination token to continue to the next page of results. 845 */ 846 nextToken?: NextToken; 847 } 848 export interface ListResponsePlansOutput { 849 /** 850 * The pagination token to continue to the next page of results. 851 */ 852 nextToken?: NextToken; 853 /** 854 * Details of each response plan. 855 */ 856 responsePlanSummaries: ResponsePlanSummaryList; 857 } 858 export interface ListTagsForResourceRequest { 859 /** 860 * The Amazon Resource Name (ARN) of the response plan. 861 */ 862 resourceArn: String; 863 } 864 export interface ListTagsForResourceResponse { 865 /** 866 * A list of tags for the response plan. 867 */ 868 tags: TagMap; 869 } 870 export interface ListTimelineEventsInput { 871 /** 872 * Filters the timeline events based on the provided conditional values. You can filter timeline events using the following keys: eventTime eventType 873 */ 874 filters?: FilterList; 875 /** 876 * The Amazon Resource Name (ARN) of the incident that the event is part of. 877 */ 878 incidentRecordArn: Arn; 879 /** 880 * The maximum number of results per page. 881 */ 882 maxResults?: MaxResults; 883 /** 884 * The pagination token to continue to the next page of results. 885 */ 886 nextToken?: NextToken; 887 /** 888 * Sort by the specified key value pair. 889 */ 890 sortBy?: TimelineEventSort; 891 /** 892 * Sorts the order of timeline events by the value specified in the sortBy field. 893 */ 894 sortOrder?: SortOrder; 895 } 896 export interface ListTimelineEventsOutput { 897 /** 898 * Details about each event that occurred during the incident. 899 */ 900 eventSummaries: EventSummaryList; 901 /** 902 * The pagination token to continue to the next page of results. 903 */ 904 nextToken?: NextToken; 905 } 906 export type MaxResults = number; 907 export type MetricDefinition = string; 908 export type NextToken = string; 909 export interface NotificationTargetItem { 910 /** 911 * The Amazon Resource Name (ARN) of the SNS topic. 912 */ 913 snsTopicArn?: Arn; 914 } 915 export type NotificationTargetSet = NotificationTargetItem[]; 916 export type Policy = string; 917 export type PolicyId = string; 918 export interface PutResourcePolicyInput { 919 /** 920 * Details of the resource policy. 921 */ 922 policy: Policy; 923 /** 924 * The Amazon Resource Name (ARN) of the response plan you're adding the resource policy to. 925 */ 926 resourceArn: Arn; 927 } 928 export interface PutResourcePolicyOutput { 929 /** 930 * The ID of the resource policy. 931 */ 932 policyId: PolicyId; 933 } 934 export type RawData = string; 935 export interface RegionInfo { 936 /** 937 * The ID of the KMS key used to encrypt the data in this Region. 938 */ 939 sseKmsKeyId?: SseKmsKey; 940 /** 941 * The status of the Region in the replication set. 942 */ 943 status: RegionStatus; 944 /** 945 * Information displayed about the status of the Region. 946 */ 947 statusMessage?: String; 948 /** 949 * The most recent date and time that the Region's status was updated. 950 */ 951 statusUpdateDateTime: Timestamp; 952 } 953 export type RegionInfoMap = {[key: string]: RegionInfo}; 954 export type RegionMapInput = {[key: string]: RegionMapInputValue}; 955 export interface RegionMapInputValue { 956 /** 957 * The KMS key used to encrypt the data in your replication set. 958 */ 959 sseKmsKeyId?: SseKmsKey; 960 } 961 export type RegionName = string; 962 export type RegionStatus = "ACTIVE"|"CREATING"|"DELETING"|"FAILED"|string; 963 export interface RelatedItem { 964 /** 965 * Details about the related item. 966 */ 967 identifier: ItemIdentifier; 968 /** 969 * The title of the related item. 970 */ 971 title?: RelatedItemTitleString; 972 } 973 export type RelatedItemList = RelatedItem[]; 974 export type RelatedItemTitleString = string; 975 export interface RelatedItemsUpdate { 976 /** 977 * Details about the related item you're adding. 978 */ 979 itemToAdd?: RelatedItem; 980 /** 981 * Details about the related item you're deleting. 982 */ 983 itemToRemove?: ItemIdentifier; 984 } 985 export interface ReplicationSet { 986 /** 987 * The Amazon Resource Name (ARN) of the replication set. 988 */ 989 arn?: Arn; 990 /** 991 * Details about who created the replication set. 992 */ 993 createdBy: Arn; 994 /** 995 * When the replication set was created. 996 */ 997 createdTime: Timestamp; 998 /** 999 * Determines if the replication set deletion protection is enabled or not. If deletion protection is enabled, you can't delete the last Region in the replication set. 1000 */ 1001 deletionProtected: Boolean; 1002 /** 1003 * Who last modified the replication set. 1004 */ 1005 lastModifiedBy: Arn; 1006 /** 1007 * When the replication set was last updated. 1008 */ 1009 lastModifiedTime: Timestamp; 1010 /** 1011 * The map between each Region in your replication set and the KMS key that is used to encrypt the data in that Region. 1012 */ 1013 regionMap: RegionInfoMap; 1014 /** 1015 * The status of the replication set. If the replication set is still pending, you can't use Incident Manager functionality. 1016 */ 1017 status: ReplicationSetStatus; 1018 } 1019 export type ReplicationSetArnList = Arn[]; 1020 export type ReplicationSetStatus = "ACTIVE"|"CREATING"|"UPDATING"|"DELETING"|"FAILED"|string; 1021 export interface ResourcePolicy { 1022 /** 1023 * The JSON blob that describes the policy. 1024 */ 1025 policyDocument: Policy; 1026 /** 1027 * The ID of the resource policy. 1028 */ 1029 policyId: PolicyId; 1030 /** 1031 * The Region that policy allows resources to be used in. 1032 */ 1033 ramResourceShareRegion: String; 1034 } 1035 export type ResourcePolicyList = ResourcePolicy[]; 1036 export type ResponsePlanDisplayName = string; 1037 export type ResponsePlanName = string; 1038 export interface ResponsePlanSummary { 1039 /** 1040 * The Amazon Resource Name (ARN) of the response plan. 1041 */ 1042 arn: Arn; 1043 /** 1044 * The human readable name of the response plan. This can include spaces. 1045 */ 1046 displayName?: ResponsePlanDisplayName; 1047 /** 1048 * The name of the response plan. This can't include spaces. 1049 */ 1050 name: ResponsePlanName; 1051 } 1052 export type ResponsePlanSummaryList = ResponsePlanSummary[]; 1053 export type RoleArn = string; 1054 export type SnsArn = string; 1055 export type SortOrder = "ASCENDING"|"DESCENDING"|string; 1056 export type SseKmsKey = string; 1057 export interface SsmAutomation { 1058 /** 1059 * The automation document's name. 1060 */ 1061 documentName: SsmAutomationDocumentNameString; 1062 /** 1063 * The automation document's version to use when running. 1064 */ 1065 documentVersion?: SsmAutomationDocumentVersionString; 1066 /** 1067 * The key-value pair parameters to use when running the automation document. 1068 */ 1069 parameters?: SsmParameters; 1070 /** 1071 * The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands. 1072 */ 1073 roleArn: RoleArn; 1074 /** 1075 * The account that the automation document will be run in. This can be in either the management account or an application account. 1076 */ 1077 targetAccount?: SsmTargetAccount; 1078 } 1079 export type SsmAutomationDocumentNameString = string; 1080 export type SsmAutomationDocumentVersionString = string; 1081 export type SsmContactsArn = string; 1082 export type SsmParameterValues = SsmParameterValuesMemberString[]; 1083 export type SsmParameterValuesMemberString = string; 1084 export type SsmParameters = {[key: string]: SsmParameterValues}; 1085 export type SsmParametersKeyString = string; 1086 export type SsmTargetAccount = "RESPONSE_PLAN_OWNER_ACCOUNT"|"IMPACTED_ACCOUNT"|string; 1087 export interface StartIncidentInput { 1088 /** 1089 * A token ensuring that the action is called only once with the specified details. 1090 */ 1091 clientToken?: ClientToken; 1092 /** 1093 * Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan. Possible impacts: 1 - Critical impact, this typically relates to full application failure that impacts many to all customers. 2 - High impact, partial application failure with impact to many customers. 3 - Medium impact, the application is providing reduced service to customers. 4 - Low impact, customer might aren't impacted by the problem yet. 5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact. 1094 */ 1095 impact?: Impact; 1096 /** 1097 * Add related items to the incident for other responders to use. Related items are AWS resources, external links, or files uploaded to an S3 bucket. 1098 */ 1099 relatedItems?: RelatedItemList; 1100 /** 1101 * The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, SNS topics, runbooks, title, and impact of the incident. 1102 */ 1103 responsePlanArn: Arn; 1104 /** 1105 * Provide a title for the incident. Providing a title overwrites the title provided by the response plan. 1106 */ 1107 title?: IncidentTitle; 1108 /** 1109 * Details of what created the incident record in Incident Manager. 1110 */ 1111 triggerDetails?: TriggerDetails; 1112 } 1113 export interface StartIncidentOutput { 1114 /** 1115 * The ARN of the newly created incident record. 1116 */ 1117 incidentRecordArn: Arn; 1118 } 1119 export type String = string; 1120 export type StringList = StringListMemberString[]; 1121 export type StringListMemberString = string; 1122 export type TagKey = string; 1123 export type TagKeyList = TagKey[]; 1124 export type TagMap = {[key: string]: TagValue}; 1125 export interface TagResourceRequest { 1126 /** 1127 * The Amazon Resource Name (ARN) of the response plan you're adding the tags to. 1128 */ 1129 resourceArn: String; 1130 /** 1131 * A list of tags that you are adding to the response plan. 1132 */ 1133 tags: TagMap; 1134 } 1135 export interface TagResourceResponse { 1136 } 1137 export type TagValue = string; 1138 export interface TimelineEvent { 1139 /** 1140 * A short description of the event. 1141 */ 1142 eventData: EventData; 1143 /** 1144 * The ID of the timeline event. 1145 */ 1146 eventId: UUID; 1147 /** 1148 * The time that the event occurred. 1149 */ 1150 eventTime: Timestamp; 1151 /** 1152 * The type of event that occurred. Currently Incident Manager supports only the Custom Event type. 1153 */ 1154 eventType: TimelineEventType; 1155 /** 1156 * The time that the timeline event was last updated. 1157 */ 1158 eventUpdatedTime: Timestamp; 1159 /** 1160 * The Amazon Resource Name (ARN) of the incident that the event occurred during. 1161 */ 1162 incidentRecordArn: Arn; 1163 } 1164 export type TimelineEventSort = "EVENT_TIME"|string; 1165 export type TimelineEventType = string; 1166 export type Timestamp = Date; 1167 export interface TriggerDetails { 1168 /** 1169 * Raw data passed from either EventBridge, CloudWatch, or Incident Manager when an incident is created. 1170 */ 1171 rawData?: RawData; 1172 /** 1173 * Identifies the service that sourced the event. All events sourced from within AWS begin with "aws." Customer-generated events can have any value here, as long as it doesn't begin with "aws." We recommend the use of Java package-name style reverse domain-name strings. 1174 */ 1175 source: IncidentSource; 1176 /** 1177 * The time that the incident was detected. 1178 */ 1179 timestamp: Timestamp; 1180 /** 1181 * The ARN of the source that detected the incident. 1182 */ 1183 triggerArn?: Arn; 1184 } 1185 export type UUID = string; 1186 export interface UntagResourceRequest { 1187 /** 1188 * The Amazon Resource Name (ARN) of the response plan you're removing a tag from. 1189 */ 1190 resourceArn: String; 1191 /** 1192 * The name of the tag you're removing from the response plan. 1193 */ 1194 tagKeys: TagKeyList; 1195 } 1196 export interface UntagResourceResponse { 1197 } 1198 export interface UpdateDeletionProtectionInput { 1199 /** 1200 * The Amazon Resource Name (ARN) of the replication set you're updating. 1201 */ 1202 arn: Arn; 1203 /** 1204 * A token ensuring that the action is called only once with the specified details. 1205 */ 1206 clientToken?: ClientToken; 1207 /** 1208 * Details if deletion protection is enabled or disabled in your account. 1209 */ 1210 deletionProtected: Boolean; 1211 } 1212 export interface UpdateDeletionProtectionOutput { 1213 } 1214 export interface UpdateIncidentRecordInput { 1215 /** 1216 * The Amazon Resource Name (ARN) of the incident record you are updating. 1217 */ 1218 arn: Arn; 1219 /** 1220 * The AWS Chatbot chat channel for responders to collaborate in. 1221 */ 1222 chatChannel?: ChatChannel; 1223 /** 1224 * A token ensuring that the action is called only once with the specified details. 1225 */ 1226 clientToken?: ClientToken; 1227 /** 1228 * Defines the impact to customers and applications. Providing an impact overwrites the impact provided by the response plan. Possible impacts: 1 - Critical impact, this typically relates to full application failure that impacts many to all customers. 2 - High impact, partial application failure with impact to many customers. 3 - Medium impact, the application is providing reduced service to customers. 4 - Low impact, customer might aren't impacted by the problem yet. 5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact. 1229 */ 1230 impact?: Impact; 1231 /** 1232 * The SNS targets that are notified when updates are made to an incident. Using multiple SNS topics creates redundancy in the case that a Region is down during the incident. 1233 */ 1234 notificationTargets?: NotificationTargetSet; 1235 /** 1236 * The status of the incident. An incident can be Open or Resolved. 1237 */ 1238 status?: IncidentRecordStatus; 1239 /** 1240 * The summary describes what has happened during the incident. 1241 */ 1242 summary?: IncidentSummary; 1243 /** 1244 * The title of the incident is a brief and easily recognizable. 1245 */ 1246 title?: IncidentTitle; 1247 } 1248 export interface UpdateIncidentRecordOutput { 1249 } 1250 export interface UpdateRelatedItemsInput { 1251 /** 1252 * A token ensuring that the action is called only once with the specified details. 1253 */ 1254 clientToken?: ClientToken; 1255 /** 1256 * The Amazon Resource Name (ARN) of the incident record you are updating related items in. 1257 */ 1258 incidentRecordArn: Arn; 1259 /** 1260 * Details about the item you are adding or deleting. 1261 */ 1262 relatedItemsUpdate: RelatedItemsUpdate; 1263 } 1264 export interface UpdateRelatedItemsOutput { 1265 } 1266 export interface UpdateReplicationSetAction { 1267 /** 1268 * Details about the Region that you're adding to the replication set. 1269 */ 1270 addRegionAction?: AddRegionAction; 1271 /** 1272 * Details about the Region that you're deleting to the replication set. 1273 */ 1274 deleteRegionAction?: DeleteRegionAction; 1275 } 1276 export interface UpdateReplicationSetInput { 1277 /** 1278 * An action to add or delete a Region. 1279 */ 1280 actions: UpdateReplicationSetInputActionsList; 1281 /** 1282 * The Amazon Resource Name (ARN) of the replication set you're updating. 1283 */ 1284 arn: Arn; 1285 /** 1286 * A token ensuring that the action is called only once with the specified details. 1287 */ 1288 clientToken?: ClientToken; 1289 } 1290 export type UpdateReplicationSetInputActionsList = UpdateReplicationSetAction[]; 1291 export interface UpdateReplicationSetOutput { 1292 } 1293 export interface UpdateResponsePlanInput { 1294 /** 1295 * The actions that this response plan takes at the beginning of an incident. 1296 */ 1297 actions?: ActionsList; 1298 /** 1299 * The Amazon Resource Name (ARN) of the response plan. 1300 */ 1301 arn: Arn; 1302 /** 1303 * The AWS Chatbot chat channel used for collaboration during an incident. Use the empty structure to remove the chat channel from the response plan. 1304 */ 1305 chatChannel?: ChatChannel; 1306 /** 1307 * A token ensuring that the action is called only once with the specified details. 1308 */ 1309 clientToken?: ClientToken; 1310 /** 1311 * The long format name of the response plan. Can't contain spaces. 1312 */ 1313 displayName?: ResponsePlanDisplayName; 1314 /** 1315 * The contacts and escalation plans that Incident Manager engages at the start of the incident. 1316 */ 1317 engagements?: EngagementSet; 1318 /** 1319 * Used to create only one incident record for an incident. 1320 */ 1321 incidentTemplateDedupeString?: DedupeString; 1322 /** 1323 * Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan. Possible impacts: 5 - Severe impact 4 - High impact 3 - Medium impact 2 - Low impact 1 - No impact 1324 */ 1325 incidentTemplateImpact?: Impact; 1326 /** 1327 * The SNS targets that are notified when updates are made to an incident. 1328 */ 1329 incidentTemplateNotificationTargets?: NotificationTargetSet; 1330 /** 1331 * A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps. 1332 */ 1333 incidentTemplateSummary?: IncidentSummary; 1334 /** 1335 * The short format name of the incident. Can't contain spaces. 1336 */ 1337 incidentTemplateTitle?: IncidentTitle; 1338 } 1339 export interface UpdateResponsePlanOutput { 1340 } 1341 export interface UpdateTimelineEventInput { 1342 /** 1343 * A token ensuring that the action is called only once with the specified details. 1344 */ 1345 clientToken?: ClientToken; 1346 /** 1347 * A short description of the event. 1348 */ 1349 eventData?: EventData; 1350 /** 1351 * The ID of the event you are updating. You can find this by using ListTimelineEvents. 1352 */ 1353 eventId: UUID; 1354 /** 1355 * The time that the event occurred. 1356 */ 1357 eventTime?: Timestamp; 1358 /** 1359 * The type of the event. You can update events of type Custom Event. 1360 */ 1361 eventType?: TimelineEventType; 1362 /** 1363 * The Amazon Resource Name (ARN) of the incident that the timeline event is part of. 1364 */ 1365 incidentRecordArn: Arn; 1366 } 1367 export interface UpdateTimelineEventOutput { 1368 } 1369 export type Url = string; 1370 /** 1371 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1372 */ 1373 export type apiVersion = "2018-05-10"|"latest"|string; 1374 export interface ClientApiVersions { 1375 /** 1376 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1377 */ 1378 apiVersion?: apiVersion; 1379 } 1380 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1381 /** 1382 * Contains interfaces for use with the SSMIncidents client. 1383 */ 1384 export import Types = SSMIncidents; 1385 } 1386 export = SSMIncidents;