Skip to content

DescribePageResult

Source code in docs_src/capo_ssm_contacts/types/describe_page_result.py
class DescribePageResult(TypedDict, closed=True):
    page_arn: "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn"
    """<p>The Amazon Resource Name (ARN) of the engagement to a contact channel.</p>"""
    engagement_arn: "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn"
    """<p>The ARN of the engagement that engaged the contact channel.</p>"""
    contact_arn: "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn"
    """<p>The ARN of the contact that was engaged.</p>"""
    sender: "capo_ssm_contacts.types.sender.Sender"
    """<p>The user that started the engagement.</p>"""
    subject: "capo_ssm_contacts.types.subject.Subject"
    """<p>The secure subject of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> and <code>EMAIL</code>.</p>"""
    content: "capo_ssm_contacts.types.content.Content"
    """<p>The secure content of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> and <code>EMAIL</code>.</p>"""
    public_subject: NotRequired["capo_ssm_contacts.types.public_subject.PublicSubject"]
    """<p>The insecure subject of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>"""
    public_content: NotRequired["capo_ssm_contacts.types.public_content.PublicContent"]
    """<p>The insecure content of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>"""
    incident_id: NotRequired["capo_ssm_contacts.types.incident_id.IncidentId"]
    """<p>The ARN of the incident that engaged the contact channel.</p>"""
    sent_time: NotRequired["capo_ssm_contacts.types.date_time.DateTime"]
    """<p>The time the engagement was sent to the contact channel.</p>"""
    read_time: NotRequired["capo_ssm_contacts.types.date_time.DateTime"]
    """<p>The time that the contact channel acknowledged the engagement.</p>"""
    delivery_time: NotRequired["capo_ssm_contacts.types.date_time.DateTime"]
    """<p>The time that the contact channel received the engagement.</p>"""

contact_arn instance-attribute

contact_arn: SsmContactsArn

The ARN of the contact that was engaged.

content instance-attribute

content: Content

The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

delivery_time instance-attribute

delivery_time: NotRequired[DateTime]

The time that the contact channel received the engagement.

engagement_arn instance-attribute

engagement_arn: SsmContactsArn

The ARN of the engagement that engaged the contact channel.

incident_id instance-attribute

incident_id: NotRequired[IncidentId]

The ARN of the incident that engaged the contact channel.

page_arn instance-attribute

page_arn: SsmContactsArn

The Amazon Resource Name (ARN) of the engagement to a contact channel.

public_content instance-attribute

public_content: NotRequired[PublicContent]

The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.

public_subject instance-attribute

public_subject: NotRequired[PublicSubject]

The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

read_time instance-attribute

read_time: NotRequired[DateTime]

The time that the contact channel acknowledged the engagement.

sender instance-attribute

sender: Sender

The user that started the engagement.

sent_time instance-attribute

sent_time: NotRequired[DateTime]

The time the engagement was sent to the contact channel.

subject instance-attribute

subject: Subject

The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.