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

***************
stop_engagement
***************



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

  

  Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.

  

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


  **Request Syntax**
  ::

    response = client.stop_engagement(
        EngagementId='string',
        Reason='string'
    )
    
  :type EngagementId: string
  :param EngagementId: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the engagement.

    

  
  :type Reason: string
  :param Reason: 

    The reason that you're stopping the engagement.

    

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

    
    ::

      {}
      
    **Response Structure**

    

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

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

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

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

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

  

  **Examples**

  The following stop-engagement example stops an engagement from paging further contacts and contact channels.
  ::

    response = client.stop_engagement(
        EngagementId='arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356',
    )
    
    print(response)

  
  Expected Output:
  ::

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

  