:doc:`SsmSap <../../ssm-sap>` / Client / stop_application

****************
stop_application
****************



.. py:method:: SsmSap.Client.stop_application(**kwargs)

  

  Request is an operation to stop an application.

   

  Parameter ``ApplicationId`` is required. Parameters ``StopConnectedEntity`` and ``IncludeEc2InstanceShutdown`` are optional.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ssm-sap-2018-05-10/StopApplication>`_  


  **Request Syntax**
  ::

    response = client.stop_application(
        ApplicationId='string',
        StopConnectedEntity='DBMS',
        IncludeEc2InstanceShutdown=True|False
    )
    
  :type ApplicationId: string
  :param ApplicationId: **[REQUIRED]** 

    The ID of the application.

    

  
  :type StopConnectedEntity: string
  :param StopConnectedEntity: 

    Specify the ``ConnectedEntityType``. Accepted type is ``DBMS``.

     

    If this parameter is included, the connected DBMS (Database Management System) will be stopped.

    

  
  :type IncludeEc2InstanceShutdown: boolean
  :param IncludeEc2InstanceShutdown: 

    Boolean. If included and if set to ``True``, the StopApplication operation will shut down the associated Amazon EC2 instance in addition to the application.

    

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

    
    ::

      {
          'OperationId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **OperationId** *(string) --* 

        The ID of the operation.

        
  
  **Exceptions**
  
  *   :py:class:`SsmSap.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`SsmSap.Client.exceptions.ConflictException`

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

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

  