engagements

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

Overview

Name	engagements
Type	Resource
Id	aws.ssm_contacts.engagements

Fields

The following fields are returned by SELECT queries:

describe_engagement

Name	Datatype	Description
contact_arn	string	The ARN of the escalation plan or contacts involved in the engagement. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=/,.@]:[0-9]+:([\w+=/,.@:-]+)</code>)
content	string	The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL. (pattern: <code>^[.\s\S]*$</code>)
engagement_arn	string	The ARN of the engagement. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=/,.@]:[0-9]+:([\w+=/,.@:-]+)</code>)
incident_id	string	The ARN of the incident in which the engagement occurred. (pattern: <code>^[\a-zA-Z0-9_@#%+=:?./!\s-]$</code>)
public_content	string	The insecure content of the message that was sent to the contact. Use this field for engagements to SMS. (pattern: <code>^[.\s\S]*$</code>)
public_subject	string	The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS. (pattern: <code>^[.\s\S]*$</code>)
sender	string	The user that started the engagement. (pattern: <code>^[\a-zA-Z0-9_@#%+=:?./!\s-]$</code>)
start_time	string (date-time)	The time that the engagement started.
stop_time	string (date-time)	The time that the engagement ended.
subject	string	The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL. (pattern: <code>^[.\s\S]*$</code>)

list_engagements

Name	Datatype	Description
contact_arn	string	The ARN of the escalation plan or contact that Incident Manager is engaging. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=/,.@]:[0-9]+:([\w+=/,.@:-]+)</code>)
engagement_arn	string	The Amazon Resource Name (ARN) of the engagement. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=/,.@]:[0-9]+:([\w+=/,.@:-]+)</code>)
incident_id	string	The ARN of the incident that's engaging the contact. (pattern: <code>^[\a-zA-Z0-9_@#%+=:?./!\s-]$</code>)
sender	string	The user that started the engagement. (pattern: <code>^[\a-zA-Z0-9_@#%+=:?./!\s-]$</code>)
start_time	string (date-time)	The time that the engagement began.
stop_time	string (date-time)	The time that the engagement ended.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_engagement	select	region		Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.
list_engagements	select	region		Lists all engagements that have happened in an incident.

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_engagement

Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.

SELECT
contact_arn,
content,
engagement_arn,
incident_id,
public_content,
public_subject,
sender,
start_time,
stop_time,
subject
FROM aws.ssm_contacts.engagements
WHERE region = '{{ region }}' -- required
;

list_engagements

Lists all engagements that have happened in an incident.

SELECT
contact_arn,
engagement_arn,
incident_id,
sender,
start_time,
stop_time
FROM aws.ssm_contacts.engagements
WHERE region = '{{ region }}' -- required
;