Skip to content

accept_page 

accept_page(
    page_id: SsmContactsArn,
    accept_type: AcceptType,
    accept_code: AcceptCode,
    *,
    config_overrides: Optional[SSMContactsClientConfig] = None,
    contact_channel_id: Optional[SsmContactsArn] = None,
    note: Optional[ReceiptInfo] = None,
    accept_code_validation: Optional[AcceptCodeValidation] = None,
) -> AcceptPageResult

Used to acknowledge an engagement to a contact channel during an incident.

Parameters:

  • page_id (SsmContactsArn) –

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

  • contact_channel_id (Optional[SsmContactsArn], default: None ) –

    The ARN of the contact channel.

  • accept_type (AcceptType) –

    The type indicates if the page was DELIVERED or READ.

  • note (Optional[ReceiptInfo], default: None ) –

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

  • accept_code (AcceptCode) –

    A 6-digit code used to acknowledge the page.

  • accept_code_validation (Optional[AcceptCodeValidation], default: None ) –

    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.

Raises:

Source code in docs_src/capo_ssm_contacts/_services/ssm_contacts.py 
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
def accept_page(
    self,
    page_id: "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn",
    accept_type: "capo_ssm_contacts.types.accept_type.AcceptType",
    accept_code: "capo_ssm_contacts.types.accept_code.AcceptCode",
    *,
    config_overrides: Optional[SSMContactsClientConfig] = None,
    contact_channel_id: Optional[
        "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn"
    ] = None,
    note: Optional["capo_ssm_contacts.types.receipt_info.ReceiptInfo"] = None,
    accept_code_validation: Optional[
        "capo_ssm_contacts.types.accept_code_validation.AcceptCodeValidation"
    ] = None,
) -> "capo_ssm_contacts.types.accept_page_result.AcceptPageResult":
    """<p>Used to acknowledge an engagement to a contact channel during an incident.</p>

    Args:
        page_id: <p>The Amazon Resource Name (ARN) of the engagement to a contact channel.</p>
        contact_channel_id: <p>The ARN of the contact channel.</p>
        accept_type: <p>The type indicates if the page was <code>DELIVERED</code> or <code>READ</code>.</p>
        note: <p>Information provided by the user when the user acknowledges the page.</p>
        accept_code: <p>A 6-digit code used to acknowledge the page.</p>
        accept_code_validation: <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>

    Raises:
        capo_ssm_contacts.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this operation.</p>
        capo_ssm_contacts.errors.internal_server_exception.InternalServerException: <p>Unexpected error occurred while processing the request.</p>
        capo_ssm_contacts.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource that doesn't exist.</p>
        capo_ssm_contacts.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_ssm_contacts.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_ssm_contacts.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm_contacts.types.accept_page_request.AcceptPageRequest]",
    ) -> OperationResponse[
        "capo_ssm_contacts.types.accept_page_result.AcceptPageResult"
    ]:
        import capo_ssm_contacts._operations.ssm_contacts.accept_page

        output, http_response = (
            capo_ssm_contacts._operations.ssm_contacts.accept_page.accept_page(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AcceptPage")
    )
    input_: capo_ssm_contacts.types.accept_page_request.AcceptPageRequest = {
        "page_id": page_id,
        "accept_type": accept_type,
        "accept_code": accept_code,
    }
    if contact_channel_id is not None:
        input_["contact_channel_id"] = contact_channel_id
    if note is not None:
        input_["note"] = note
    if accept_code_validation is not None:
        input_["accept_code_validation"] = accept_code_validation

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output