:doc:`Transfer <../../transfer>` / Waiter / ServerOnline

************
ServerOnline
************



.. py:class:: Transfer.Waiter.ServerOnline

  ::

    
    waiter = client.get_waiter('server_online')

  
  

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

    Polls :py:meth:`Transfer.Client.describe_server` every 30 seconds until a successful state is reached. An error is raised after 120 failed checks.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServer>`_    


    **Request Syntax**
    ::

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

      A system-assigned unique identifier for a server.

      

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

        

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

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

        

      
    
    
    :returns: None