pages

Creates, updates, deletes, gets or lists a pages resource.

Overview

Name	pages
Type	Resource
Id	aws.ssm_contacts.pages

Fields

The following fields are returned by SELECT queries:

describe_page

Name	Datatype	Description
contact_arn	string	The ARN of the contact that was engaged. (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>)
delivery_time	string (date-time)	The time that the contact channel received the engagement.
engagement_arn	string	The ARN of the engagement that engaged the contact channel. (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 engaged the contact channel. (pattern: <code>^[\a-zA-Z0-9_@#%+=:?./!\s-]$</code>)
page_arn	string	The Amazon Resource Name (ARN) of the engagement to a contact channel. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=/,.@]:[0-9]+:([\w+=/,.@:-]+)</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>)
read_time	string (date-time)	The time that the contact channel acknowledged the engagement.
sender	string	The user that started the engagement. (pattern: <code>^[\a-zA-Z0-9_@#%+=:?./!\s-]$</code>)
sent_time	string (date-time)	The time the engagement was sent to the contact channel.
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>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_page	select	region		Lists details of the engagement to a contact channel.
accept_page	exec	region, PageId, AcceptType, AcceptCode		Used to acknowledge an engagement to a contact channel during 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_page

Lists details of the engagement to a contact channel.

SELECT
contact_arn,
content,
delivery_time,
engagement_arn,
incident_id,
page_arn,
public_content,
public_subject,
read_time,
sender,
sent_time,
subject
FROM aws.ssm_contacts.pages
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

accept_page

Used to acknowledge an engagement to a contact channel during an incident.

EXEC aws.ssm_contacts.pages.accept_page 
@region='{{ region }}' --required 
@@json=
'{
"PageId": "{{ PageId }}", 
"ContactChannelId": "{{ ContactChannelId }}", 
"AcceptType": "{{ AcceptType }}", 
"Note": "{{ Note }}", 
"AcceptCode": "{{ AcceptCode }}", 
"AcceptCodeValidation": "{{ AcceptCodeValidation }}"
}'
;