:doc:`WorkSpaces <../../workspaces>` / Client / stop_workspaces_pool

********************
stop_workspaces_pool
********************



.. py:method:: WorkSpaces.Client.stop_workspaces_pool(**kwargs)

  

  Stops the specified pool.

   

  You cannot stop a WorkSpace pool unless it has a running mode of ``AutoStop`` and a state of ``AVAILABLE``, ``IMPAIRED``, ``UNHEALTHY``, or ``ERROR``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspacesPool>`_  


  **Request Syntax**
  ::

    response = client.stop_workspaces_pool(
        PoolId='string'
    )
    
  :type PoolId: string
  :param PoolId: **[REQUIRED]** 

    The identifier of the pool.

    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`WorkSpaces.Client.exceptions.InvalidParameterValuesException`

  
  *   :py:class:`WorkSpaces.Client.exceptions.InvalidResourceStateException`

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

  
  *   :py:class:`WorkSpaces.Client.exceptions.OperationInProgressException`

  
  *   :py:class:`WorkSpaces.Client.exceptions.AccessDeniedException`

  