create_response_plan
¶
create_response_plan(
name: ResponsePlanName,
incident_template: IncidentTemplate,
*,
config_overrides: Optional[SSMIncidentsClientConfig] = None,
client_token: Optional[ClientToken] = None,
display_name: Optional[ResponsePlanDisplayName] = None,
chat_channel: Optional[ChatChannel] = None,
engagements: Optional[EngagementSet] = None,
actions: Optional[ActionsList] = None,
tags: Optional[TagMap] = None,
integrations: Optional[Integrations] = None,
) -> CreateResponsePlanOutput
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.
Parameters:
-
client_token(Optional[ClientToken], default:None) –A token ensuring that the operation is called only once with the specified details.
-
name(ResponsePlanName) –The short format name of the response plan. Can't include spaces.
-
display_name(Optional[ResponsePlanDisplayName], default:None) –The long format of the response plan name. This field can contain spaces.
-
incident_template(IncidentTemplate) –Details used to create an incident when using this response plan.
-
chat_channel(Optional[ChatChannel], default:None) –The Chatbot chat channel used for collaboration during an incident.
-
engagements(Optional[EngagementSet], default:None) –The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
-
actions(Optional[ActionsList], default:None) –The actions that the response plan starts at the beginning of an incident.
-
tags(Optional[TagMap], default:None) –A list of tags that you are adding to the response plan.
-
integrations(Optional[Integrations], default:None) –Information about third-party services integrated into the response plan.
Raises:
-
AccessDeniedException–You don't have sufficient access to perform this operation.
-
ConflictException–Updating or deleting a resource causes an inconsistent state.
-
InternalServerException–The request processing has failed because of an unknown error, exception or failure.
-
ResourceNotFoundException–Request references a resource which doesn't exist.
-
ThrottlingException–The request was denied due to request throttling.
-
ValidationException–The input fails to satisfy the constraints specified by an Amazon Web Services service.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_ssm_incidents/_services/ssm_incidents.py
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 | |