incident_records

Creates, updates, deletes, gets or lists an incident_records resource.

Overview

Name	incident_records
Type	Resource
Id	aws.ssm_incidents.incident_records

Fields

The following fields are returned by SELECT queries:

get_incident_record

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the incident record. (pattern: <code>^arn:aws(-cn|-us-gov)?:[a-z0-9-]:[a-z0-9-]:([0-9]{12})?:.+$</code>)
automation_executions	array	The runbook, or automation document, that's run at the beginning of the incident.
chat_channel	object	The Chatbot chat channel used for collaboration during an incident.
creation_time	string (date-time)	The timestamp for when Incident Manager created the incident record.
dedupe_string	string	The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.
impact	integer	The impact of the incident on customers and applications. Supported impact codes 1 - Critical 2 - High 3 - Medium 4 - Low 5 - No Impact
incident_record_source	object	Details about the action that started the incident.
last_modified_by	string	Who modified the incident most recently. (pattern: <code>^arn:aws(-cn|-us-gov)?:[a-z0-9-]:[a-z0-9-]:([0-9]{12})?:.+$</code>)
last_modified_time	string (date-time)	The timestamp for when the incident was most recently modified.
notification_targets	array	The Amazon SNS targets that are notified when updates are made to an incident.
resolved_time	string (date-time)	The timestamp for when the incident was resolved. This appears as a timeline event.
status	string	The current status of the incident. (OPEN, RESOLVED)
summary	string	The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context of the incident.
title_	string	The title of the incident.

list_incident_records

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the incident. (pattern: <code>^arn:aws(-cn|-us-gov)?:[a-z0-9-]:[a-z0-9-]:([0-9]{12})?:.+$</code>)
creation_time	string (date-time)	The timestamp for when the incident was created.
impact	integer	Defines the impact to customers and applications.
incident_record_source	object	What caused Incident Manager to create the incident.
resolved_time	string (date-time)	The timestamp for when the incident was resolved.
status	string	The current status of the incident. (OPEN, RESOLVED)
title_	string	The title of the incident. This value is either provided by the response plan or overwritten on creation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_incident_record	select	arn, region		Returns the details for the specified incident record.
list_incident_records	select	region		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.
update_incident_record	update	region, arn		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.
delete_incident_record	delete	region		Delete an incident record from Incident Manager.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the incident record.
region	string	AWS region (default: us-east-1)

SELECT examples

get_incident_record

Returns the details for the specified incident record.

SELECT
arn,
automation_executions,
chat_channel,
creation_time,
dedupe_string,
impact,
incident_record_source,
last_modified_by,
last_modified_time,
notification_targets,
resolved_time,
status,
summary,
title_
FROM aws.ssm_incidents.incident_records
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
;

list_incident_records

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.

SELECT
arn,
creation_time,
impact,
incident_record_source,
resolved_time,
status,
title_
FROM aws.ssm_incidents.incident_records
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_incident_record

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.

UPDATE aws.ssm_incidents.incident_records
SET 
arn = '{{ arn }}',
chatChannel = '{{ chatChannel }}',
clientToken = '{{ clientToken }}',
impact = {{ impact }},
notificationTargets = '{{ notificationTargets }}',
status = '{{ status }}',
summary = '{{ summary }}',
title = '{{ title }}'
WHERE 
region = '{{ region }}' --required
AND arn = '{{ arn }}' --required;

DELETE examples

delete_incident_record

Delete an incident record from Incident Manager.

DELETE FROM aws.ssm_incidents.incident_records
WHERE region = '{{ region }}' --required
;