2021/05/11 - AWS Systems Manager Incident Manager - 29 new api methods
Changes AWS Systems Manager Incident Manager enables faster resolution of critical application availability and performance issues, management of contacts and post-incident analysis
Delete an incident record from Incident Manager.
See also: AWS API Documentation
Request Syntax
client.delete_incident_record(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the incident record you are deleting.
dict
Response Syntax
{}
Response Structure
(dict) --
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',
'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,
'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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ssmAutomation.
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.
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 AWS Chatbot chat channel used for collaboration during an incident.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: chatbotSns, empty.
chatbotSns (list) --
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.
(string) --
empty (dict) --
Used to remove the chat channel from an incident record or response plan.
string
A token ensuring that the action 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.
notificationTargets (list) --
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 using the SNS topics.
(dict) --
The SNS topic that's used by AWS Chatbot to notify the incidents chat channel.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: snsTopicArn.
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.
Lists the tags that are attached to the specified response plan.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the response plan.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
A list of tags for the response plan.
(string) --
(string) --
Lists timeline events of the specified incident record.
See also: AWS API Documentation
Request Syntax
client.list_timeline_events(
filters=[
{
'condition': {
'after': datetime(2015, 1, 1),
'before': datetime(2015, 1, 1),
'equals': {
'integerValues': [
123,
],
'stringValues': [
'string',
]
}
},
'key': 'string'
},
],
incidentRecordArn='string',
maxResults=123,
nextToken='string',
sortBy='EVENT_TIME',
sortOrder='ASCENDING'|'DESCENDING'
)
list
Filters the timeline events based on the provided conditional values. You can filter timeline events using the following keys:
eventTime
eventType
(dict) --
Filter the selection by using a condition.
condition (dict) -- [REQUIRED]
The condition accepts before or after a specified time, equal to a string, or equal to an integer.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: after, before, equals.
after (datetime) --
After the specified timestamp.
before (datetime) --
Before the specified timestamp
equals (dict) --
The value is equal to the provided string or integer.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: integerValues, stringValues.
integerValues (list) --
The list of integer values that the filter matches.
(integer) --
stringValues (list) --
The list of string values that the filter matches.
(string) --
key (string) -- [REQUIRED]
The key that you're filtering on.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the incident that the event is part of.
integer
The maximum number of results per page.
string
The pagination token to continue to the next page of results.
string
Sort by the specified key value pair.
string
Sorts the order of timeline events by the value specified in the sortBy field.
dict
Response Syntax
{
'eventSummaries': [
{
'eventId': 'string',
'eventTime': datetime(2015, 1, 1),
'eventType': 'string',
'eventUpdatedTime': datetime(2015, 1, 1),
'incidentRecordArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
eventSummaries (list) --
Details about each event that occurred during the incident.
(dict) --
Details about a timeline event during an incident.
eventId (string) --
The timeline event ID.
eventTime (datetime) --
The time that the event occurred.
eventType (string) --
The type of event. The timeline event must be Custom Event .
eventUpdatedTime (datetime) --
The time that the timeline event was last updated.
incidentRecordArn (string) --
The Amazon Resource Name (ARN) of the incident that the event happened during.
nextToken (string) --
The pagination token to continue to the next page of results.
A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.
See also: AWS API Documentation
Request Syntax
client.create_replication_set(
clientToken='string',
regions={
'string': {
'sseKmsKeyId': 'string'
}
}
)
string
A token ensuring that the action is called only once with the specified details.
This field is autopopulated if not provided.
dict
[REQUIRED]
The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
(string) --
(dict) --
The mapping between a Region and the key that's used to encrypt the data.
sseKmsKeyId (string) --
The KMS key used to encrypt the data in your replication set.
dict
Response Syntax
{
'arn': 'string'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the replication set.
Update deletion protection to either allow or deny deletion of the final Region in a replication set.
See also: AWS API Documentation
Request Syntax
client.update_deletion_protection(
arn='string',
clientToken='string',
deletionProtected=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication set you're updating.
string
A token ensuring that the action is called only once with the specified details.
This field is autopopulated if not provided.
boolean
[REQUIRED]
Details if deletion protection is enabled or disabled in your account.
dict
Response Syntax
{}
Response Structure
(dict) --
List all related items for an incident record.
See also: AWS API Documentation
Request Syntax
client.list_related_items(
incidentRecordArn='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the incident record that you are listing related items for.
integer
The maximum number of related items per page.
string
The pagination token to continue to the next page of results.
dict
Response Syntax
{
'nextToken': 'string',
'relatedItems': [
{
'identifier': {
'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER',
'value': {
'arn': 'string',
'metricDefinition': 'string',
'url': 'string'
}
},
'title': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token to continue to the next page of results.
relatedItems (list) --
Details about each related item.
(dict) --
Resources that responders use to triage and mitigate the incident.
identifier (dict) --
Details about the related item.
type (string) --
The type of related item. Incident Manager supports the following types:
ANALYSIS
INCIDENT
METRIC
PARENT
ATTACHMENT
OTHER
value (dict) --
Details about the related item.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: arn, metricDefinition, url. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
arn (string) --
The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.
metricDefinition (string) --
The metric definition, if the related item is a metric in CloudWatch.
url (string) --
The URL, if the related item is a non-AWS resource.
title (string) --
The title of the related item.
Retrieves a timeline event based on its ID and incident record.
See also: AWS API Documentation
Request Syntax
client.get_timeline_event(
eventId='string',
incidentRecordArn='string'
)
string
[REQUIRED]
The ID of the event. You can get an event's ID when you create it or by using ListTimelineEvents .
string
[REQUIRED]
The Amazon Resource Name (ARN) of the incident that the timeline event is part of.
dict
Response Syntax
{
'event': {
'eventData': 'string',
'eventId': 'string',
'eventTime': datetime(2015, 1, 1),
'eventType': 'string',
'eventUpdatedTime': datetime(2015, 1, 1),
'incidentRecordArn': 'string'
}
}
Response Structure
(dict) --
event (dict) --
Details about the timeline event.
eventData (string) --
A short description of the event.
eventId (string) --
The ID of the timeline event.
eventTime (datetime) --
The time that the event occurred.
eventType (string) --
The type of event that occurred. Currently Incident Manager supports only the Custom Event type.
eventUpdatedTime (datetime) --
The time that the timeline event was last updated.
incidentRecordArn (string) --
The Amazon Resource Name (ARN) of the incident that the event occurred during.
Deletes the resource policy that AWS Resource Access Manager uses to share your Incident Manager resource.
See also: AWS API Documentation
Request Syntax
client.delete_resource_policy(
policyId='string',
resourceArn='string'
)
string
[REQUIRED]
The ID of the resource policy you're deleting.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource you're deleting the policy from.
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.list_incident_records(
filters=[
{
'condition': {
'after': datetime(2015, 1, 1),
'before': datetime(2015, 1, 1),
'equals': {
'integerValues': [
123,
],
'stringValues': [
'string',
]
}
},
'key': 'string'
},
],
maxResults=123,
nextToken='string'
)
list
Filter the list of incident records you are searching through. You can filter on the following keys:
creationTime
impact
status
createdBy
(dict) --
Filter the selection by using a condition.
condition (dict) -- [REQUIRED]
The condition accepts before or after a specified time, equal to a string, or equal to an integer.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: after, before, equals.
after (datetime) --
After the specified timestamp.
before (datetime) --
Before the specified timestamp
equals (dict) --
The value is equal to the provided string or integer.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: integerValues, stringValues.
integerValues (list) --
The list of integer values that the filter matches.
(integer) --
stringValues (list) --
The list of string values that the filter matches.
(string) --
key (string) -- [REQUIRED]
The key that you're filtering on.
integer
The maximum number of results per page.
string
The pagination token to continue to the next page of results.
dict
Response Syntax
{
'incidentRecordSummaries': [
{
'arn': 'string',
'creationTime': datetime(2015, 1, 1),
'impact': 123,
'incidentRecordSource': {
'createdBy': 'string',
'invokedBy': 'string',
'resourceArn': 'string',
'source': 'string'
},
'resolvedTime': datetime(2015, 1, 1),
'status': 'OPEN'|'RESOLVED',
'title': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
incidentRecordSummaries (list) --
The details of each listed incident record.
(dict) --
Details describing an incident record.
arn (string) --
The Amazon Resource Name (ARN) of the incident.
creationTime (datetime) --
The time the incident was created.
impact (integer) --
Defines the impact to customers and applications.
incidentRecordSource (dict) --
What caused Incident Manager to create the incident.
createdBy (string) --
The principal that started the incident.
invokedBy (string) --
The principal the assumed the role specified of the createdBy .
resourceArn (string) --
The resource that caused the incident to be created.
source (string) --
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.
resolvedTime (datetime) --
The time the incident was resolved.
status (string) --
The current status of the incident.
title (string) --
The title of the incident. This value is either provided by the response plan or overwritten on creation.
nextToken (string) --
The pagination token to continue to the next page of results.
Updates the specified response plan.
See also: AWS API Documentation
Request Syntax
client.update_response_plan(
actions=[
{
'ssmAutomation': {
'documentName': 'string',
'documentVersion': 'string',
'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',
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ssmAutomation.
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.
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 AWS Chatbot chat channel used for collaboration during an incident.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: chatbotSns, empty.
chatbotSns (list) --
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.
(string) --
empty (dict) --
Used to remove the chat channel from an incident record or response plan.
string
A token ensuring that the action is called only once with the specified details.
This field is autopopulated if not provided.
string
The long format name of the response plan. Can't contain spaces.
list
The contacts and escalation plans that Incident Manager engages at the start of the incident.
(string) --
string
Used to create only one incident record for an incident.
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 SNS targets that AWS Chatbot uses to notify the chat channels and perform actions on the incident record.
(dict) --
The SNS topic that's used by AWS Chatbot to notify the incidents chat channel.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: snsTopicArn.
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.
string
The short format name of the incident. Can't contain spaces.
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.create_timeline_event(
clientToken='string',
eventData='string',
eventTime=datetime(2015, 1, 1),
eventType='string',
incidentRecordArn='string'
)
string
[REQUIRED]
A token ensuring that the action is called only once with the specified details.
This field is autopopulated if not provided.
string
[REQUIRED]
A short description of the event.
datetime
[REQUIRED]
The time that the event occurred.
string
[REQUIRED]
The type of the event. You can create timeline events of type Custom Event .
string
[REQUIRED]
The Amazon Resource Name (ARN) of the incident record you are adding the event to.
dict
Response Syntax
{
'eventId': 'string',
'incidentRecordArn': 'string'
}
Response Structure
(dict) --
eventId (string) --
The ID of the event for easy reference later.
incidentRecordArn (string) --
The ARN of the incident record that you added the event to.
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',
'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,
'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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: ssmAutomation. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
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 AWS Chatbot chat channel used for collaboration during an incident.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: chatbotSns, empty. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
chatbotSns (list) --
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.
(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.
notificationTargets (list) --
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 using the SNS topics.
(dict) --
The SNS topic that's used by AWS Chatbot to notify the incidents chat channel.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: snsTopicArn. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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. Can't contain spaces.
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.
See also: AWS API Documentation
Request Syntax
client.delete_response_plan(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the response plan.
dict
Response Syntax
{}
Response Structure
(dict) --
Used to start an incident from CloudWatch alarms, EventBridge events, or manually.
See also: AWS API Documentation
Request Syntax
client.start_incident(
clientToken='string',
impact=123,
relatedItems=[
{
'identifier': {
'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER',
'value': {
'arn': 'string',
'metricDefinition': 'string',
'url': 'string'
}
},
'title': 'string'
},
],
responsePlanArn='string',
title='string',
triggerDetails={
'rawData': 'string',
'source': 'string',
'timestamp': datetime(2015, 1, 1),
'triggerArn': 'string'
}
)
string
A token ensuring that the action is called only once with the specified details.
This field is autopopulated if not provided.
integer
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.
list
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.
(dict) --
Resources that responders use to triage and mitigate the incident.
identifier (dict) -- [REQUIRED]
Details about the related item.
type (string) -- [REQUIRED]
The type of related item. Incident Manager supports the following types:
ANALYSIS
INCIDENT
METRIC
PARENT
ATTACHMENT
OTHER
value (dict) -- [REQUIRED]
Details about the related item.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: arn, metricDefinition, url.
arn (string) --
The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.
metricDefinition (string) --
The metric definition, if the related item is a metric in CloudWatch.
url (string) --
The URL, if the related item is a non-AWS resource.
title (string) --
The title of the related item.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, SNS topics, runbooks, title, and impact of the incident.
string
Provide a title for the incident. Providing a title overwrites the title provided by the response plan.
dict
Details of what created the incident record in Incident Manager.
rawData (string) --
Raw data passed from either EventBridge, CloudWatch, or Incident Manager when an incident is created.
source (string) -- [REQUIRED]
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.
timestamp (datetime) -- [REQUIRED]
The time that the incident was detected.
triggerArn (string) --
The ARN of the source that detected the incident.
dict
Response Syntax
{
'incidentRecordArn': 'string'
}
Response Structure
(dict) --
incidentRecordArn (string) --
The ARN of the newly created incident record.
Add or remove related items from the related items tab of an incident record.
See also: AWS API Documentation
Request Syntax
client.update_related_items(
clientToken='string',
incidentRecordArn='string',
relatedItemsUpdate={
'itemToAdd': {
'identifier': {
'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER',
'value': {
'arn': 'string',
'metricDefinition': 'string',
'url': 'string'
}
},
'title': 'string'
},
'itemToRemove': {
'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER',
'value': {
'arn': 'string',
'metricDefinition': 'string',
'url': 'string'
}
}
}
)
string
A token ensuring that the action is called only once with the specified details.
This field is autopopulated if not provided.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the incident record you are updating related items in.
dict
[REQUIRED]
Details about the item you are adding or deleting.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: itemToAdd, itemToRemove.
itemToAdd (dict) --
Details about the related item you're adding.
identifier (dict) -- [REQUIRED]
Details about the related item.
type (string) -- [REQUIRED]
The type of related item. Incident Manager supports the following types:
ANALYSIS
INCIDENT
METRIC
PARENT
ATTACHMENT
OTHER
value (dict) -- [REQUIRED]
Details about the related item.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: arn, metricDefinition, url.
arn (string) --
The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.
metricDefinition (string) --
The metric definition, if the related item is a metric in CloudWatch.
url (string) --
The URL, if the related item is a non-AWS resource.
title (string) --
The title of the related item.
itemToRemove (dict) --
Details about the related item you're deleting.
type (string) -- [REQUIRED]
The type of related item. Incident Manager supports the following types:
ANALYSIS
INCIDENT
METRIC
PARENT
ATTACHMENT
OTHER
value (dict) -- [REQUIRED]
Details about the related item.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: arn, metricDefinition, url.
arn (string) --
The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.
metricDefinition (string) --
The metric definition, if the related item is a metric in CloudWatch.
url (string) --
The URL, if the related item is a non-AWS resource.
dict
Response Syntax
{}
Response Structure
(dict) --
Adds a resource policy to the specified response plan.
See also: AWS API Documentation
Request Syntax
client.put_resource_policy(
policy='string',
resourceArn='string'
)
string
[REQUIRED]
Details of the resource policy.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the response plan you're adding the resource policy to.
dict
Response Syntax
{
'policyId': 'string'
}
Response Structure
(dict) --
policyId (string) --
The ID of the resource policy.
Deletes a timeline event from an incident.
See also: AWS API Documentation
Request Syntax
client.delete_timeline_event(
eventId='string',
incidentRecordArn='string'
)
string
[REQUIRED]
The ID of the event you are updating. You can find this by using ListTimelineEvents .
string
[REQUIRED]
The Amazon Resource Name (ARN) of the incident that the event is part of.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates a timeline event. You can update events of type Custom Event .
See also: AWS API Documentation
Request Syntax
client.update_timeline_event(
clientToken='string',
eventData='string',
eventId='string',
eventTime=datetime(2015, 1, 1),
eventType='string',
incidentRecordArn='string'
)
string
[REQUIRED]
A token ensuring that the action is called only once with the specified details.
This field is autopopulated if not provided.
string
A short description of the event.
string
[REQUIRED]
The ID of the event you are updating. You can find this by using ListTimelineEvents .
datetime
The time that the event occurred.
string
The type of the event. You can update events of type Custom Event .
string
[REQUIRED]
The Amazon Resource Name (ARN) of the incident that the timeline event is part of.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieve your Incident Manager replication set.
See also: AWS API Documentation
Request Syntax
client.get_replication_set(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication set you want to retrieve.
dict
Response Syntax
{
'replicationSet': {
'createdBy': 'string',
'createdTime': datetime(2015, 1, 1),
'deletionProtected': True|False,
'lastModifiedBy': 'string',
'lastModifiedTime': datetime(2015, 1, 1),
'regionMap': {
'string': {
'sseKmsKeyId': 'string',
'status': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED',
'statusMessage': 'string',
'statusUpdateDateTime': datetime(2015, 1, 1)
}
},
'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'FAILED'
}
}
Response Structure
(dict) --
replicationSet (dict) --
Details of the replication set.
createdBy (string) --
Details about who created the replication set.
createdTime (datetime) --
When the replication set was created.
deletionProtected (boolean) --
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.
lastModifiedBy (string) --
Who last modified the replication set.
lastModifiedTime (datetime) --
When the replication set was last updated.
regionMap (dict) --
The map between each Region in your replication set and the KMS key that is used to encrypt the data in that Region.
(string) --
(dict) --
Information about a Region in your replication set.
sseKmsKeyId (string) --
The ID of the KMS key used to encrypt the data in this Region.
status (string) --
The status of the Region in the replication set.
statusMessage (string) --
Information displayed about the status of the Region.
statusUpdateDateTime (datetime) --
The most recent date and time that the Region's status was updated.
status (string) --
The status of the replication set. If the replication set is still pending, you can't use Incident Manager functionality.
Lists all response plans in your account.
See also: AWS API Documentation
Request Syntax
client.list_response_plans(
maxResults=123,
nextToken='string'
)
integer
The maximum number of response plans per page.
string
The pagination token to continue to the next page of results.
dict
Response Syntax
{
'nextToken': 'string',
'responsePlanSummaries': [
{
'arn': 'string',
'displayName': 'string',
'name': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token to continue to the next page of results.
responsePlanSummaries (list) --
Details of each response plan.
(dict) --
Details of the response plan that are used when creating an incident.
arn (string) --
The Amazon Resource Name (ARN) of the response plan.
displayName (string) --
The human readable name of the response plan. This can include spaces.
name (string) --
The name of the response plan. This can't include spaces.
Removes a tag from a resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the response plan you're removing a tag from.
list
[REQUIRED]
The name of the tag you're removing from the response plan.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves the resource policies attached to the specified response plan.
See also: AWS API Documentation
Request Syntax
client.get_resource_policies(
maxResults=123,
nextToken='string',
resourceArn='string'
)
integer
The maximum number of resource policies to display per page of results.
string
The pagination token to continue to the next page of results.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the response plan with the attached resource policy.
dict
Response Syntax
{
'nextToken': 'string',
'resourcePolicies': [
{
'policyDocument': 'string',
'policyId': 'string',
'ramResourceShareRegion': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token to continue to the next page of results.
resourcePolicies (list) --
Details about the resource policy attached to the response plan.
(dict) --
The resource policy that allows Incident Manager to perform actions on resources on your behalf.
policyDocument (string) --
The JSON blob that describes the policy.
policyId (string) --
The ID of the resource policy.
ramResourceShareRegion (string) --
The Region that policy allows resources to be used in.
Returns the details of the specified incident record.
See also: AWS API Documentation
Request Syntax
client.get_incident_record(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the incident record.
dict
Response Syntax
{
'incidentRecord': {
'arn': 'string',
'automationExecutions': [
{
'ssmExecutionArn': 'string'
},
],
'chatChannel': {
'chatbotSns': [
'string',
],
'empty': {}
},
'creationTime': datetime(2015, 1, 1),
'dedupeString': 'string',
'impact': 123,
'incidentRecordSource': {
'createdBy': 'string',
'invokedBy': 'string',
'resourceArn': 'string',
'source': 'string'
},
'lastModifiedBy': 'string',
'lastModifiedTime': datetime(2015, 1, 1),
'notificationTargets': [
{
'snsTopicArn': 'string'
},
],
'resolvedTime': datetime(2015, 1, 1),
'status': 'OPEN'|'RESOLVED',
'summary': 'string',
'title': 'string'
}
}
Response Structure
(dict) --
incidentRecord (dict) --
Details structure of the incident record.
arn (string) --
The Amazon Resource Name (ARN) of the incident record.
automationExecutions (list) --
The runbook, or automation document, that's run at the beginning of the incident.
(dict) --
The Systems Manager automation document process to start as the runbook at the beginning of the incident.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: ssmExecutionArn. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
ssmExecutionArn (string) --
The Amazon Resource Name (ARN) of the automation process.
chatChannel (dict) --
The chat channel used for collaboration during an incident.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: chatbotSns, empty. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
chatbotSns (list) --
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.
(string) --
empty (dict) --
Used to remove the chat channel from an incident record or response plan.
creationTime (datetime) --
The time that Incident Manager created the incident record.
dedupeString (string) --
The string Incident Manager uses to prevent duplicate incidents from being created by the same incident.
impact (integer) --
The impact of the incident on customers and applications.
incidentRecordSource (dict) --
Details about the action that started the incident.
createdBy (string) --
The principal that started the incident.
invokedBy (string) --
The principal the assumed the role specified of the createdBy .
resourceArn (string) --
The resource that caused the incident to be created.
source (string) --
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.
lastModifiedBy (string) --
Who modified the incident most recently.
lastModifiedTime (datetime) --
The time at which the incident was most recently modified.
notificationTargets (list) --
The SNS targets that AWS Chatbot uses to notify the chat channels and perform actions on the incident record.
(dict) --
The SNS topic that's used by AWS Chatbot to notify the incidents chat channel.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: snsTopicArn. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
snsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS topic.
resolvedTime (datetime) --
The time at which the incident was resolved. This appears as a timeline event.
status (string) --
The current status of the incident.
summary (string) --
The summary of the incident. The summary is a brief synopsis of what occurred, what is currently happening, and context.
title (string) --
The title of the incident.
Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.
See also: AWS API Documentation
Request Syntax
client.delete_replication_set(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication set you're deleting.
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.update_incident_record(
arn='string',
chatChannel={
'chatbotSns': [
'string',
],
'empty': {}
},
clientToken='string',
impact=123,
notificationTargets=[
{
'snsTopicArn': 'string'
},
],
status='OPEN'|'RESOLVED',
summary='string',
title='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the incident record you are updating.
dict
The AWS Chatbot chat channel for responders to collaborate in.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: chatbotSns, empty.
chatbotSns (list) --
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.
(string) --
empty (dict) --
Used to remove the chat channel from an incident record or response plan.
string
A token ensuring that the action is called only once with the specified details.
This field is autopopulated if not provided.
integer
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.
list
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 using the SNS topics.
Using multiple SNS topics creates redundancy in the case that a Region is down during the incident.
(dict) --
The SNS topic that's used by AWS Chatbot to notify the incidents chat channel.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: snsTopicArn.
snsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS topic.
string
The status of the incident. An incident can be Open or Resolved .
string
The summary describes what has happened during the incident.
string
The title of the incident is a brief and easily recognizable.
dict
Response Syntax
{}
Response Structure
(dict) --
Adds a tag to a response plan.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the response plan you're adding the tags to.
dict
[REQUIRED]
A list of tags that you are adding to the response plan.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Add or delete Regions from your replication set.
See also: AWS API Documentation
Request Syntax
client.update_replication_set(
actions=[
{
'addRegionAction': {
'regionName': 'string',
'sseKmsKeyId': 'string'
},
'deleteRegionAction': {
'regionName': 'string'
}
},
],
arn='string',
clientToken='string'
)
list
[REQUIRED]
An action to add or delete a Region.
(dict) --
Details used when updating the replication set.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: addRegionAction, deleteRegionAction.
addRegionAction (dict) --
Details about the Region that you're adding to the replication set.
regionName (string) -- [REQUIRED]
The Region name to add to the replication set.
sseKmsKeyId (string) --
The KMS key ID to use to encrypt your replication set.
deleteRegionAction (dict) --
Details about the Region that you're deleting to the replication set.
regionName (string) -- [REQUIRED]
The name of the Region you're deleting from the replication set.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the replication set you're updating.
string
A token ensuring that the action is called only once with the specified details.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists details about the replication set configured in your account.
See also: AWS API Documentation
Request Syntax
client.list_replication_sets(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results per page.
string
The pagination token to continue to the next page of results.
dict
Response Syntax
{
'nextToken': 'string',
'replicationSetArns': [
'string',
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token to continue to the next page of results.
replicationSetArns (list) --
The Amazon Resource Name (ARN) of the list replication set.
(string) --