Table of Contents
A low-level client representing AWS Systems Manager Incident Manager (SSM Incidents)
Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An incident is any unplanned interruption or reduction in quality of services.
Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.
import boto3
client = boto3.client('ssm-incidents')
These are the available methods:
Check if an operation can be paginated.
A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.
See also: AWS API Documentation
Request Syntax
response = client.create_replication_set(
clientToken='string',
regions={
'string': {
'sseKmsKeyId': 'string'
}
}
)
A token ensuring that the operation is called only once with the specified details.
This field is autopopulated if not provided.
[REQUIRED]
The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
The mapping between a Amazon Web Services Region and the key that's used to encrypt the data.
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.
Exceptions
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
response = 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'
}
)
The actions that the response plan starts at the beginning of an incident.
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.
The Systems Manager automation document to start as the runbook at the beginning of the incident.
The automation document's name.
The automation document's version to use when running.
The key-value pair parameters to use when running the automation document.
The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
The account that the automation document will be run in. This can be in either the management account or an application account.
The 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.
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.
Used to remove the chat channel from an incident record or response plan.
A token ensuring that the operation is called only once with the specified details.
This field is autopopulated if not provided.
The contacts and escalation plans that the response plan engages during an incident.
[REQUIRED]
Details used to create an incident when using this response plan.
Used to stop Incident Manager from creating multiple incident records for the same incident.
The impact of the incident on your customers and applications.
The Amazon SNS targets that are notified when updates are made to an incident.
The SNS targets that are notified when updates are made to an incident.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: snsTopicArn.
The Amazon Resource Name (ARN) of the SNS topic.
The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.
The title of the incident.
[REQUIRED]
The short format name of the response plan. Can't include spaces.
A list of tags that you are adding to the response plan.
dict
Response Syntax
{
'arn': 'string'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the response plan.
Exceptions
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
response = client.create_timeline_event(
clientToken='string',
eventData='string',
eventTime=datetime(2015, 1, 1),
eventType='string',
incidentRecordArn='string'
)
A token ensuring that the action is called only once with the specified details.
This field is autopopulated if not provided.
[REQUIRED]
A short description of the event as a valid JSON string. There is no other schema imposed.
[REQUIRED]
The time that the event occurred.
[REQUIRED]
The type of the event. You can create timeline events of type Custom Event .
[REQUIRED]
The Amazon Resource Name (ARN) of the incident record to which the event will be added.
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.
Exceptions
Delete an incident record from Incident Manager.
See also: AWS API Documentation
Request Syntax
response = client.delete_incident_record(
arn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the incident record you are deleting.
{}
Response Structure
Exceptions
Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.
See also: AWS API Documentation
Request Syntax
response = client.delete_replication_set(
arn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication set you're deleting.
{}
Response Structure
Exceptions
Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource.
See also: AWS API Documentation
Request Syntax
response = client.delete_resource_policy(
policyId='string',
resourceArn='string'
)
[REQUIRED]
The ID of the resource policy you're deleting.
[REQUIRED]
The Amazon Resource Name (ARN) of the resource you're deleting the policy from.
dict
Response Syntax
{}
Response Structure
Exceptions
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
response = client.delete_response_plan(
arn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the response plan.
{}
Response Structure
Exceptions
Deletes a timeline event from an incident.
See also: AWS API Documentation
Request Syntax
response = client.delete_timeline_event(
eventId='string',
incidentRecordArn='string'
)
[REQUIRED]
The ID of the event you are updating. You can find this by using ListTimelineEvents .
[REQUIRED]
The Amazon Resource Name (ARN) of the incident that includes the timeline event.
dict
Response Syntax
{}
Response Structure
Exceptions
Returns the details for the specified incident record.
See also: AWS API Documentation
Request Syntax
response = client.get_incident_record(
arn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the incident record.
{
'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
Details the structure of the incident record.
The Amazon Resource Name (ARN) of the incident record.
The runbook, or automation document, that's run at the beginning of the incident.
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'}
The Amazon Resource Name (ARN) of the automation process.
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'}
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.
Used to remove the chat channel from an incident record or response plan.
The time that Incident Manager created the incident record.
The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.
The impact of the incident on customers and applications.
Details about the action that started the incident.
The principal that started the incident.
The principal the assumed the role specified of the createdBy .
The resource that caused the incident to be created.
The service that started the incident. This can be manually created from Incident Manager, automatically created using an Amazon CloudWatch alarm, or Amazon EventBridge event.
Who modified the incident most recently.
The time at which the incident was most recently modified.
The Amazon SNS targets that are notified when updates are made to an incident.
The SNS targets that are notified when updates are made to an incident.
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'}
The Amazon Resource Name (ARN) of the SNS topic.
The time at which the incident was resolved. This appears as a timeline event.
The current status of the incident.
The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context of the incident.
The title of the incident.
Exceptions
Create a paginator for an operation.
Retrieve your Incident Manager replication set.
See also: AWS API Documentation
Request Syntax
response = client.get_replication_set(
arn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication set you want to retrieve.
{
'replicationSet': {
'arn': 'string',
'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
Details of the replication set.
The Amazon Resource Name (ARN) of the replication set.
Details about who created the replication set.
When the replication set was created.
Determines if the replication set deletion protection is enabled or not. If deletion protection is enabled, you can't delete the last Amazon Web Services Region in the replication set.
Who last modified the replication set.
When the replication set was last updated.
The map between each Amazon Web Services Region in your replication set and the KMS key that's used to encrypt the data in that Region.
Information about a Amazon Web Services Region in your replication set.
The ID of the KMS key used to encrypt the data in this Amazon Web Services Region.
The status of the Amazon Web Services Region in the replication set.
Information displayed about the status of the Amazon Web Services Region.
The most recent date and time that Incident Manager updated the Amazon Web Services Region's status.
The status of the replication set. If the replication set is still pending, you can't use Incident Manager functionality.
Exceptions
Retrieves the resource policies attached to the specified response plan.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_policies(
maxResults=123,
nextToken='string',
resourceArn='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 Amazon Web Services Region that policy allows resources to be used in.
Exceptions
Retrieves the details of the specified response plan.
See also: AWS API Documentation
Request Syntax
response = client.get_response_plan(
arn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the 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': {}
},
'displayName': 'string',
'engagements': [
'string',
],
'incidentTemplate': {
'dedupeString': 'string',
'impact': 123,
'notificationTargets': [
{
'snsTopicArn': 'string'
},
],
'summary': 'string',
'title': 'string'
},
'name': 'string'
}
Response Structure
The actions that this response plan takes at the beginning of the incident.
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'}
The Systems Manager automation document to start as the runbook at the beginning of the incident.
The automation document's name.
The automation document's version to use when running.
The key-value pair parameters to use when running the automation document.
The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
The account that the automation document will be run in. This can be in either the management account or an application account.
The ARN of the response plan.
The 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'}
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.
Used to remove the chat channel from an incident record or response plan.
The long format name of the response plan. Can contain spaces.
The contacts and escalation plans that the response plan engages during an incident.
Details used to create the incident when using this response plan.
Used to stop Incident Manager from creating multiple incident records for the same incident.
The impact of the incident on your customers and applications.
The Amazon SNS targets that are notified when updates are made to an incident.
The SNS targets that are notified when updates are made to an incident.
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'}
The Amazon Resource Name (ARN) of the SNS topic.
The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.
The title of the incident.
The short format name of the response plan. The name can't contain spaces.
Exceptions
Retrieves a timeline event based on its ID and incident record.
See also: AWS API Documentation
Request Syntax
response = client.get_timeline_event(
eventId='string',
incidentRecordArn='string'
)
[REQUIRED]
The ID of the event. You can get an event's ID when you create it, or by using ListTimelineEvents .
[REQUIRED]
The Amazon Resource Name (ARN) of the incident that includes the timeline event.
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.
Exceptions
Returns an object that can wait for some condition.
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
response = 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'
)
Filters the list of incident records through which you are searching. You can filter on the following keys:
Note the following when deciding how to use Filters:
Filter the selection by using a condition.
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 the specified timestamp.
Before the specified timestamp
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.
The list of integer values that the filter matches.
The list of string values that the filter matches.
The key that you're filtering on.
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 Amazon 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.
Exceptions
List all related items for an incident record.
See also: AWS API Documentation
Request Syntax
response = client.list_related_items(
incidentRecordArn='string',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the incident record containing the listed related items.
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:
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 Amazon CloudWatch.
url (string) --
The URL, if the related item is a non-Amazon Web Services resource.
title (string) --
The title of the related item.
Exceptions
Lists details about the replication set configured in your account.
See also: AWS API Documentation
Request Syntax
response = client.list_replication_sets(
maxResults=123,
nextToken='string'
)
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.
Exceptions
Lists all response plans in your account.
See also: AWS API Documentation
Request Syntax
response = client.list_response_plans(
maxResults=123,
nextToken='string'
)
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.
Exceptions
Lists the tags that are attached to the specified response plan.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the response plan.
{
'tags': {
'string': 'string'
}
}
Response Structure
A list of tags for the response plan.
Exceptions
Lists timeline events for the specified incident record.
See also: AWS API Documentation
Request Syntax
response = 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'
)
Filters the timeline events based on the provided conditional values. You can filter timeline events using the following keys:
Note the following when deciding how to use Filters:
Filter the selection by using a condition.
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 the specified timestamp.
Before the specified timestamp
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.
The list of integer values that the filter matches.
The list of string values that the filter matches.
The key that you're filtering on.
[REQUIRED]
The Amazon Resource Name (ARN) of the incident that includes the timeline event.
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.
Exceptions
Adds a resource policy to the specified response plan.
See also: AWS API Documentation
Request Syntax
response = client.put_resource_policy(
policy='string',
resourceArn='string'
)
[REQUIRED]
Details of the resource policy.
[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.
Exceptions
Used to start an incident from CloudWatch alarms, EventBridge events, or manually.
See also: AWS API Documentation
Request Syntax
response = 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'
}
)
A token ensuring that the operation is called only once with the specified details.
This field is autopopulated if not provided.
Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.
Possible impacts:
Add related items to the incident for other responders to use. Related items are AWS resources, external links, or files uploaded to an Amazon S3 bucket.
Resources that responders use to triage and mitigate the incident.
Details about the related item.
The type of related item. Incident Manager supports the following types:
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.
The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.
The metric definition, if the related item is a metric in Amazon CloudWatch.
The URL, if the related item is a non-Amazon Web Services resource.
The title of the related item.
[REQUIRED]
The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident.
Details of what created the incident record in Incident Manager.
Raw data passed from either Amazon EventBridge, Amazon CloudWatch, or Incident Manager when an incident is created.
Identifies the service that sourced the event. All events sourced from within Amazon Web Services 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.
The time that the incident was detected.
The Amazon Resource Name (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.
Exceptions
Adds a tag to a response plan.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the response plan you're adding the tags to.
[REQUIRED]
A list of tags that you are adding to the response plan.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes a tag from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the response plan you're removing a tag from.
[REQUIRED]
The name of the tag you're removing from the response plan.
dict
Response Syntax
{}
Response Structure
Exceptions
Update deletion protection to either allow or deny deletion of the final Region in a replication set.
See also: AWS API Documentation
Request Syntax
response = client.update_deletion_protection(
arn='string',
clientToken='string',
deletionProtected=True|False
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication set you're updating.
A token ensuring that the operation is called only once with the specified details.
This field is autopopulated if not provided.
[REQUIRED]
Details if deletion protection is enabled or disabled in your account.
dict
Response Syntax
{}
Response Structure
Exceptions
Update the details of an incident record. You can use this operation 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
response = client.update_incident_record(
arn='string',
chatChannel={
'chatbotSns': [
'string',
],
'empty': {}
},
clientToken='string',
impact=123,
notificationTargets=[
{
'snsTopicArn': 'string'
},
],
status='OPEN'|'RESOLVED',
summary='string',
title='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the incident record you are updating.
The Chatbot chat channel where responders can collaborate.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: chatbotSns, empty.
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.
Used to remove the chat channel from an incident record or response plan.
A token that ensures that the operation is called only once with the specified details.
This field is autopopulated if not provided.
Defines the impact of the incident to customers and applications. Providing an impact overwrites the impact provided by the response plan.
Possible impacts:
The Amazon SNS targets that are notified when updates are made to an incident.
Using multiple SNS topics creates redundancy in the event that a Region is down during the incident.
The SNS targets that are notified when updates are made to an incident.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: snsTopicArn.
The Amazon Resource Name (ARN) of the SNS topic.
dict
Response Syntax
{}
Response Structure
Exceptions
Add or remove related items from the related items tab of an incident record.
See also: AWS API Documentation
Request Syntax
response = 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'
}
}
}
)
A token ensuring that the operation is called only once with the specified details.
This field is autopopulated if not provided.
[REQUIRED]
The Amazon Resource Name (ARN) of the incident record containing the related items you are updating.
[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.
Details about the related item you're adding.
Details about the related item.
The type of related item. Incident Manager supports the following types:
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.
The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.
The metric definition, if the related item is a metric in Amazon CloudWatch.
The URL, if the related item is a non-Amazon Web Services resource.
The title of the related item.
Details about the related item you're deleting.
The type of related item. Incident Manager supports the following types:
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.
The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.
The metric definition, if the related item is a metric in Amazon CloudWatch.
The URL, if the related item is a non-Amazon Web Services resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Add or delete Regions from your replication set.
See also: AWS API Documentation
Request Syntax
response = client.update_replication_set(
actions=[
{
'addRegionAction': {
'regionName': 'string',
'sseKmsKeyId': 'string'
},
'deleteRegionAction': {
'regionName': 'string'
}
},
],
arn='string',
clientToken='string'
)
[REQUIRED]
An action to add or delete a Region.
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.
Details about the Amazon Web Services Region that you're adding to the replication set.
The Amazon Web Services Region name to add to the replication set.
The KMS key ID to use to encrypt your replication set.
Details about the Amazon Web Services Region that you're deleting to the replication set.
The name of the Amazon Web Services Region you're deleting from the replication set.
[REQUIRED]
The Amazon Resource Name (ARN) of the replication set you're updating.
A token ensuring that the operation is called only once with the specified details.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates the specified response plan.
See also: AWS API Documentation
Request Syntax
response = 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'
)
The actions that this response plan takes at the beginning of an incident.
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.
The Systems Manager automation document to start as the runbook at the beginning of the incident.
The automation document's name.
The automation document's version to use when running.
The key-value pair parameters to use when running the automation document.
The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
The account that the automation document will be run in. This can be in either the management account or an application account.
[REQUIRED]
The Amazon Resource Name (ARN) of the response plan.
The Chatbot chat channel used for collaboration during an incident.
Use the empty structure to remove the chat channel from the response plan.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: chatbotSns, empty.
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.
Used to remove the chat channel from an incident record or response plan.
A token ensuring that the operation is called only once with the specified details.
This field is autopopulated if not provided.
The contacts and escalation plans that Incident Manager engages at the start of the incident.
Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.
Possible impacts:
The Amazon SNS targets that are notified when updates are made to an incident.
The SNS targets that are notified when updates are made to an incident.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: snsTopicArn.
The Amazon Resource Name (ARN) of the SNS topic.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates a timeline event. You can update events of type Custom Event .
See also: AWS API Documentation
Request Syntax
response = client.update_timeline_event(
clientToken='string',
eventData='string',
eventId='string',
eventTime=datetime(2015, 1, 1),
eventType='string',
incidentRecordArn='string'
)
A token ensuring that the operation is called only once with the specified details.
This field is autopopulated if not provided.
[REQUIRED]
The ID of the event you are updating. You can find this by using ListTimelineEvents .
[REQUIRED]
The Amazon Resource Name (ARN) of the incident that includes the timeline event.
dict
Response Syntax
{}
Response Structure
Exceptions
The available paginators are:
paginator = client.get_paginator('get_resource_policies')
Creates an iterator that will paginate through responses from SSMIncidents.Client.get_resource_policies().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
resourceArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the response plan with the attached resource policy.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'resourcePolicies': [
{
'policyDocument': 'string',
'policyId': 'string',
'ramResourceShareRegion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
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 Amazon Web Services Region that policy allows resources to be used in.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_incident_records')
Creates an iterator that will paginate through responses from SSMIncidents.Client.list_incident_records().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters=[
{
'condition': {
'after': datetime(2015, 1, 1),
'before': datetime(2015, 1, 1),
'equals': {
'integerValues': [
123,
],
'stringValues': [
'string',
]
}
},
'key': 'string'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters the list of incident records through which you are searching. You can filter on the following keys:
Note the following when deciding how to use Filters:
Filter the selection by using a condition.
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 the specified timestamp.
Before the specified timestamp
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.
The list of integer values that the filter matches.
The list of string values that the filter matches.
The key that you're filtering on.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
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 Amazon 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) --
A token to resume pagination.
paginator = client.get_paginator('list_related_items')
Creates an iterator that will paginate through responses from SSMIncidents.Client.list_related_items().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
incidentRecordArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the incident record containing the listed related items.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'relatedItems': [
{
'identifier': {
'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER',
'value': {
'arn': 'string',
'metricDefinition': 'string',
'url': 'string'
}
},
'title': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
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:
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 Amazon CloudWatch.
url (string) --
The URL, if the related item is a non-Amazon Web Services resource.
title (string) --
The title of the related item.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_replication_sets')
Creates an iterator that will paginate through responses from SSMIncidents.Client.list_replication_sets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'replicationSetArns': [
'string',
],
'NextToken': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the list replication set.
A token to resume pagination.
paginator = client.get_paginator('list_response_plans')
Creates an iterator that will paginate through responses from SSMIncidents.Client.list_response_plans().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'responsePlanSummaries': [
{
'arn': 'string',
'displayName': 'string',
'name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Details of each response plan.
Details of the response plan that are used when creating an incident.
The Amazon Resource Name (ARN) of the response plan.
The human readable name of the response plan. This can include spaces.
The name of the response plan. This can't include spaces.
A token to resume pagination.
paginator = client.get_paginator('list_timeline_events')
Creates an iterator that will paginate through responses from SSMIncidents.Client.list_timeline_events().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters=[
{
'condition': {
'after': datetime(2015, 1, 1),
'before': datetime(2015, 1, 1),
'equals': {
'integerValues': [
123,
],
'stringValues': [
'string',
]
}
},
'key': 'string'
},
],
incidentRecordArn='string',
sortBy='EVENT_TIME',
sortOrder='ASCENDING'|'DESCENDING',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters the timeline events based on the provided conditional values. You can filter timeline events using the following keys:
Note the following when deciding how to use Filters:
Filter the selection by using a condition.
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 the specified timestamp.
Before the specified timestamp
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.
The list of integer values that the filter matches.
The list of string values that the filter matches.
The key that you're filtering on.
[REQUIRED]
The Amazon Resource Name (ARN) of the incident that includes the timeline event.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
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) --
A token to resume pagination.
The available waiters are:
waiter = client.get_waiter('wait_for_replication_set_active')
Polls SSMIncidents.Client.get_replication_set() every 30 seconds until a successful state is reached. An error is returned after 5 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
arn='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication set you want to retrieve.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 5
None
waiter = client.get_waiter('wait_for_replication_set_deleted')
Polls SSMIncidents.Client.get_replication_set() every 30 seconds until a successful state is reached. An error is returned after 5 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
arn='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the replication set you want to retrieve.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 5
None