2022/07/05 - AWS Systems Manager Incident Manager - 3 updated api methods
Changes Adds support for tagging incident-record on creation by providing incident tags in the template within a response-plan.
{'incidentTemplate': {'incidentTags': {'string': 'string'}}}
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.
See also: AWS API Documentation
Request Syntax
client.create_response_plan(
actions=[
{
'ssmAutomation': {
'documentName': 'string',
'documentVersion': 'string',
'dynamicParameters': {
'string': {
'variable': 'INCIDENT_RECORD_ARN'|'INVOLVED_RESOURCES'
}
},
'parameters': {
'string': [
'string',
]
},
'roleArn': 'string',
'targetAccount': 'RESPONSE_PLAN_OWNER_ACCOUNT'|'IMPACTED_ACCOUNT'
}
},
],
chatChannel={
'chatbotSns': [
'string',
],
'empty': {}
},
clientToken='string',
displayName='string',
engagements=[
'string',
],
incidentTemplate={
'dedupeString': 'string',
'impact': 123,
'incidentTags': {
'string': 'string'
},
'notificationTargets': [
{
'snsTopicArn': 'string'
},
],
'summary': 'string',
'title': 'string'
},
name='string',
tags={
'string': 'string'
}
)
list
The actions that the response plan starts at the beginning of an incident.
(dict) --
The action that starts at the beginning of an incident. The response plan defines the action.
ssmAutomation (dict) --
The Systems Manager automation document to start as the runbook at the beginning of the incident.
documentName (string) -- [REQUIRED]
The automation document's name.
documentVersion (string) --
The automation document's version to use when running.
dynamicParameters (dict) --
The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
(string) --
(dict) --
The dynamic SSM parameter value.
variable (string) --
Variable dynamic parameters. A parameter value is determined when an incident is created.
parameters (dict) --
The key-value pair parameters to use when running the automation document.
(string) --
(list) --
(string) --
roleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
targetAccount (string) --
The account that the automation document will be run in. This can be in either the management account or an application account.
dict
The Chatbot chat channel used for collaboration during an incident.
chatbotSns (list) --
The Amazon SNS targets that 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 Amazon SNS topics.
(string) --
empty (dict) --
Used to remove the chat channel from an incident record or response plan.
string
A token ensuring that the operation is called only once with the specified details.
This field is autopopulated if not provided.
string
The long format of the response plan name. This field can contain spaces.
list
The contacts and escalation plans that the response plan engages during an incident.
(string) --
dict
[REQUIRED]
Details used to create an incident when using this response plan.
dedupeString (string) --
Used to stop Incident Manager from creating multiple incident records for the same incident.
impact (integer) -- [REQUIRED]
The impact of the incident on your customers and applications.
incidentTags (dict) --
Tags to apply to an incident when calling the StartIncident API action.
(string) --
(string) --
notificationTargets (list) --
The Amazon SNS targets that are notified when updates are made to an incident.
(dict) --
The SNS targets that are notified when updates are made to an incident.
snsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS topic.
summary (string) --
The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.
title (string) -- [REQUIRED]
The title of the incident.
string
[REQUIRED]
The short format name of the response plan. Can't include spaces.
dict
A list of tags that you are adding to the response plan.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the response plan.
{'incidentTemplate': {'incidentTags': {'string': 'string'}}}
Retrieves the details of the specified response plan.
See also: AWS API Documentation
Request Syntax
client.get_response_plan(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the response plan.
dict
Response Syntax
{
'actions': [
{
'ssmAutomation': {
'documentName': 'string',
'documentVersion': 'string',
'dynamicParameters': {
'string': {
'variable': 'INCIDENT_RECORD_ARN'|'INVOLVED_RESOURCES'
}
},
'parameters': {
'string': [
'string',
]
},
'roleArn': 'string',
'targetAccount': 'RESPONSE_PLAN_OWNER_ACCOUNT'|'IMPACTED_ACCOUNT'
}
},
],
'arn': 'string',
'chatChannel': {
'chatbotSns': [
'string',
],
'empty': {}
},
'displayName': 'string',
'engagements': [
'string',
],
'incidentTemplate': {
'dedupeString': 'string',
'impact': 123,
'incidentTags': {
'string': 'string'
},
'notificationTargets': [
{
'snsTopicArn': 'string'
},
],
'summary': 'string',
'title': 'string'
},
'name': 'string'
}
Response Structure
(dict) --
actions (list) --
The actions that this response plan takes at the beginning of the incident.
(dict) --
The action that starts at the beginning of an incident. The response plan defines the action.
ssmAutomation (dict) --
The Systems Manager automation document to start as the runbook at the beginning of the incident.
documentName (string) --
The automation document's name.
documentVersion (string) --
The automation document's version to use when running.
dynamicParameters (dict) --
The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
(string) --
(dict) --
The dynamic SSM parameter value.
variable (string) --
Variable dynamic parameters. A parameter value is determined when an incident is created.
parameters (dict) --
The key-value pair parameters to use when running the automation document.
(string) --
(list) --
(string) --
roleArn (string) --
The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
targetAccount (string) --
The account that the automation document will be run in. This can be in either the management account or an application account.
arn (string) --
The ARN of the response plan.
chatChannel (dict) --
The Chatbot chat channel used for collaboration during an incident.
chatbotSns (list) --
The Amazon SNS targets that 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 Amazon SNS topics.
(string) --
empty (dict) --
Used to remove the chat channel from an incident record or response plan.
displayName (string) --
The long format name of the response plan. Can contain spaces.
engagements (list) --
The contacts and escalation plans that the response plan engages during an incident.
(string) --
incidentTemplate (dict) --
Details used to create the incident when using this response plan.
dedupeString (string) --
Used to stop Incident Manager from creating multiple incident records for the same incident.
impact (integer) --
The impact of the incident on your customers and applications.
incidentTags (dict) --
Tags to apply to an incident when calling the StartIncident API action.
(string) --
(string) --
notificationTargets (list) --
The Amazon SNS targets that are notified when updates are made to an incident.
(dict) --
The SNS targets that are notified when updates are made to an incident.
snsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS topic.
summary (string) --
The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.
title (string) --
The title of the incident.
name (string) --
The short format name of the response plan. The name can't contain spaces.
{'incidentTemplateTags': {'string': 'string'}}
Updates the specified response plan.
See also: AWS API Documentation
Request Syntax
client.update_response_plan(
actions=[
{
'ssmAutomation': {
'documentName': 'string',
'documentVersion': 'string',
'dynamicParameters': {
'string': {
'variable': 'INCIDENT_RECORD_ARN'|'INVOLVED_RESOURCES'
}
},
'parameters': {
'string': [
'string',
]
},
'roleArn': 'string',
'targetAccount': 'RESPONSE_PLAN_OWNER_ACCOUNT'|'IMPACTED_ACCOUNT'
}
},
],
arn='string',
chatChannel={
'chatbotSns': [
'string',
],
'empty': {}
},
clientToken='string',
displayName='string',
engagements=[
'string',
],
incidentTemplateDedupeString='string',
incidentTemplateImpact=123,
incidentTemplateNotificationTargets=[
{
'snsTopicArn': 'string'
},
],
incidentTemplateSummary='string',
incidentTemplateTags={
'string': 'string'
},
incidentTemplateTitle='string'
)
list
The actions that this response plan takes at the beginning of an incident.
(dict) --
The action that starts at the beginning of an incident. The response plan defines the action.
ssmAutomation (dict) --
The Systems Manager automation document to start as the runbook at the beginning of the incident.
documentName (string) -- [REQUIRED]
The automation document's name.
documentVersion (string) --
The automation document's version to use when running.
dynamicParameters (dict) --
The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
(string) --
(dict) --
The dynamic SSM parameter value.
variable (string) --
Variable dynamic parameters. A parameter value is determined when an incident is created.
parameters (dict) --
The key-value pair parameters to use when running the automation document.
(string) --
(list) --
(string) --
roleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
targetAccount (string) --
The account that the automation document will be run in. This can be in either the management account or an application account.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the response plan.
dict
The Chatbot chat channel used for collaboration during an incident.
Use the empty structure to remove the chat channel from the response plan.
chatbotSns (list) --
The Amazon SNS targets that 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 Amazon SNS topics.
(string) --
empty (dict) --
Used to remove the chat channel from an incident record or response plan.
string
A token ensuring that the operation is called only once with the specified details.
This field is autopopulated if not provided.
string
The long format name of the response plan. The display name can't contain spaces.
list
The contacts and escalation plans that Incident Manager engages at the start of the incident.
(string) --
string
The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.
integer
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
list
The Amazon SNS targets that are notified when updates are made to an incident.
(dict) --
The SNS targets that are notified when updates are made to an incident.
snsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS topic.
string
A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.
dict
Tags to apply to an incident when calling the StartIncident API action. To call this action, you must also have permission to call the TagResource API action for the incident record resource.
(string) --
(string) --
string
The short format name of the incident. The title can't contain spaces.
dict
Response Syntax
{}
Response Structure
(dict) --