:doc:`DeadlineCloud <../../deadline>` / Waiter / JobSucceeded

************
JobSucceeded
************



.. py:class:: DeadlineCloud.Waiter.JobSucceeded

  ::

    
    waiter = client.get_waiter('job_succeeded')

  
  

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

    Polls :py:meth:`DeadlineCloud.Client.get_job` every 15 seconds until a successful state is reached. An error is raised after 240 failed checks.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/GetJob>`_    


    **Request Syntax**
    ::

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

      The farm ID of the farm in the job.

      

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

      The queue ID associated with the job.

      

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

      The job 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: 15

        

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

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

        

      
    
    
    :returns: None