Skip to content

AcceptPageRequest

Source code in docs_src/capo_ssm_contacts/types/accept_page_request.py
class AcceptPageRequest(TypedDict, closed=True):
    page_id: "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn"
    """<p>The Amazon Resource Name (ARN) of the engagement to a contact channel.</p>"""
    contact_channel_id: NotRequired[
        "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn"
    ]
    """<p>The ARN of the contact channel.</p>"""
    accept_type: "capo_ssm_contacts.types.accept_type.AcceptType"
    """<p>The type indicates if the page was <code>DELIVERED</code> or <code>READ</code>.</p>"""
    note: NotRequired["capo_ssm_contacts.types.receipt_info.ReceiptInfo"]
    """<p>Information provided by the user when the user acknowledges the page.</p>"""
    accept_code: "capo_ssm_contacts.types.accept_code.AcceptCode"
    """<p>A 6-digit code used to acknowledge the page.</p>"""
    accept_code_validation: NotRequired[
        "capo_ssm_contacts.types.accept_code_validation.AcceptCodeValidation"
    ]
    """<p>An optional field that Incident Manager uses to <code>ENFORCE</code> <code>AcceptCode</code> validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.</p> <p>Incident Manager can also <code>IGNORE</code> <code>AcceptCode</code> validation. Ignoring <code>AcceptCode</code> validation causes Incident Manager to accept any value entered for the <code>AcceptCode</code>.</p>"""

accept_code instance-attribute

accept_code: AcceptCode

A 6-digit code used to acknowledge the page.

accept_code_validation instance-attribute

accept_code_validation: NotRequired[AcceptCodeValidation]

An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.

accept_type instance-attribute

accept_type: AcceptType

The type indicates if the page was DELIVERED or READ.

contact_channel_id instance-attribute

contact_channel_id: NotRequired[SsmContactsArn]

The ARN of the contact channel.

note instance-attribute

note: NotRequired[ReceiptInfo]

Information provided by the user when the user acknowledges the page.

page_id instance-attribute

page_id: SsmContactsArn

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