pages_by_contacts
Creates, updates, deletes, gets or lists a pages_by_contacts resource.
Overview
| Name | pages_by_contacts |
| Type | Resource |
| Id | aws.ssm_contacts.pages_by_contacts |
Fields
The following fields are returned by SELECT queries:
- list_pages_by_contact
| Name | Datatype | Description |
|---|---|---|
contact_arn | string | The ARN of the contact that Incident Manager is engaging. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=/,.@]:[0-9]+:([\w+=/,.@:-]+)</code>) |
delivery_time | string (date-time) | The time the message was delivered to the contact channel. |
engagement_arn | string | The ARN of the engagement that this page is part of. (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 channel. (pattern: <code>^[\a-zA-Z0-9_@#%+=:?./!\s-]$</code>) |
page_arn | string | The Amazon Resource Name (ARN) of the page to the contact channel. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=/,.@]:[0-9]+:([\w+=/,.@:-]+)</code>) |
read_time | string (date-time) | The time that the contact channel acknowledged engagement. |
sender | string | The user that started the engagement. (pattern: <code>^[\a-zA-Z0-9_@#%+=:?./!\s-]$</code>) |
sent_time | string (date-time) | The time that Incident Manager engaged the contact channel. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_pages_by_contact | select | region | Lists the engagements to a contact's contact channels. |
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
- list_pages_by_contact
Lists the engagements to a contact's contact channels.
SELECT
contact_arn,
delivery_time,
engagement_arn,
incident_id,
page_arn,
read_time,
sender,
sent_time
FROM aws.ssm_contacts.pages_by_contacts
WHERE region = '{{ region }}' -- required
;