:doc:`PrometheusService <../../amp>` / Waiter / WorkspaceActive

***************
WorkspaceActive
***************



.. py:class:: PrometheusService.Waiter.WorkspaceActive

  ::

    
    waiter = client.get_waiter('workspace_active')

  
  

  .. py:method:: wait(**kwargs)

    Polls :py:meth:`PrometheusService.Client.describe_workspace` every 2 seconds until a successful state is reached. An error is raised after 60 failed checks.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeWorkspace>`_    


    **Request Syntax**
    ::

      waiter.wait(
          workspaceId='string',
          WaiterConfig={
              'Delay': 123,
              'MaxAttempts': 123
          }
      )
      
    :type workspaceId: string
    :param workspaceId: **[REQUIRED]** 

      The ID of the workspace to describe.

      

    
    :type WaiterConfig: dict
    :param WaiterConfig: 

      A dictionary that provides parameters to control waiting behavior.

      

    
      - **Delay** *(integer) --* 

        The amount of time in seconds to wait between attempts. Default: 2

        

      
      - **MaxAttempts** *(integer) --* 

        The maximum number of attempts to be made. Default: 60

        

      
    
    
    :returns: None