:doc:`IoTSiteWise <../../iotsitewise>` / Waiter / PortalActive

************
PortalActive
************



.. py:class:: IoTSiteWise.Waiter.PortalActive

  ::

    
    waiter = client.get_waiter('portal_active')

  
  

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

    Polls :py:meth:`IoTSiteWise.Client.describe_portal` every 3 seconds until a successful state is reached. An error is raised after 20 failed checks.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribePortal>`_    


    **Request Syntax**
    ::

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

      The ID of the portal.

      

    
    :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: 3

        

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

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

        

      
    
    
    :returns: None