Skip to main content

page_receipts

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

Overview

Namepage_receipts
TypeResource
Idaws.ssm_contacts.page_receipts

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
contact_channel_arnstringThe 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_infostringInformation provided during the page acknowledgement. (pattern: <code>^[.\s\S]*$</code>)
receipt_timestring (date-time)The time receipt was SENT, DELIVERED, or READ.
receipt_typestringThe type follows the engagement cycle, SENT, DELIVERED, and READ. (DELIVERED, ERROR, READ, SENT, STOP)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_page_receiptsselectregionLists 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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

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
;