:doc:`SSMContacts <../../ssm-contacts>` / Client / accept_page

***********
accept_page
***********



.. py:method:: SSMContacts.Client.accept_page(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/AcceptPage>`_  


  **Request Syntax**
  ::

    response = client.accept_page(
        PageId='string',
        ContactChannelId='string',
        AcceptType='DELIVERED'|'READ',
        Note='string',
        AcceptCode='string',
        AcceptCodeValidation='IGNORE'|'ENFORCE'
    )
    
  :type PageId: string
  :param PageId: **[REQUIRED]** 

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

    

  
  :type ContactChannelId: string
  :param ContactChannelId: 

    The ARN of the contact channel.

    

  
  :type AcceptType: string
  :param AcceptType: **[REQUIRED]** 

    The type indicates if the page was ``DELIVERED`` or ``READ``.

    

  
  :type Note: string
  :param Note: 

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

    

  
  :type AcceptCode: string
  :param AcceptCode: **[REQUIRED]** 

    A 6-digit code used to acknowledge the page.

    

  
  :type AcceptCodeValidation: string
  :param 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``.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`SSMContacts.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`SSMContacts.Client.exceptions.InternalServerException`

  
  *   :py:class:`SSMContacts.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`SSMContacts.Client.exceptions.ThrottlingException`

  
  *   :py:class:`SSMContacts.Client.exceptions.ValidationException`

  

  **Examples**

  The following accept-page operation uses an accept code sent to the contact channel to accept a page.
  ::

    response = client.accept_page(
        AcceptCode='425440',
        AcceptType='READ',
        PageId='arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3',
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'ResponseMetadata': {
            '...': '...',
        },
    }

  