page_receipts
Creates, updates, deletes, gets or lists a page_receipts resource.
Overview
| Name | page_receipts |
| Type | Resource |
| Id | aws.ssm_contacts.page_receipts |
Fields
The following fields are returned by SELECT queries:
- list_page_receipts
| Name | Datatype | Description |
|---|---|---|
contact_channel_arn | string | The Amazon Resource Name (ARN) of the contact channel Incident Manager engaged. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=/,.@]:[0-9]+:([\w+=/,.@:-]+)</code>) |
receipt_info | string | Information provided during the page acknowledgement. (pattern: <code>^[.\s\S]*$</code>) |
receipt_time | string (date-time) | The time receipt was SENT, DELIVERED, or READ. |
receipt_type | string | The type follows the engagement cycle, SENT, DELIVERED, and READ. (DELIVERED, ERROR, READ, SENT, STOP) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_page_receipts | select | region | Lists all of the engagements to contact channels that have been acknowledged. |
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_page_receipts
Lists all of the engagements to contact channels that have been acknowledged.
SELECT
contact_channel_arn,
receipt_info,
receipt_time,
receipt_type
FROM aws.ssm_contacts.page_receipts
WHERE region = '{{ region }}' -- required
;