:doc:`Omics <../../omics>` / Waiter / TaskCompleted

*************
TaskCompleted
*************



.. py:class:: Omics.Waiter.TaskCompleted

  ::

    
    waiter = client.get_waiter('task_completed')

  
  

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

    Polls :py:meth:`Omics.Client.get_run_task` every 30 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/omics-2022-11-28/GetRunTask>`_    


    **Request Syntax**
    ::

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

      The workflow run ID.

      

    
    :type taskId: string
    :param taskId: **[REQUIRED]** 

      The task's ID.

      

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

        

      
    
    
    :returns: None