:doc:`DeadlineCloud <../../deadline>` / Client / update_step

***********
update_step
***********



.. py:method:: DeadlineCloud.Client.update_step(**kwargs)

  

  Updates a step.

  

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


  **Request Syntax**
  ::

    response = client.update_step(
        targetTaskRunStatus='READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
        clientToken='string',
        farmId='string',
        queueId='string',
        jobId='string',
        stepId='string'
    )
    
  :type targetTaskRunStatus: string
  :param targetTaskRunStatus: **[REQUIRED]** 

    The task status to update the step's tasks to.

    

  
  :type clientToken: string
  :param clientToken: 

    The unique token which the server uses to recognize retries of the same request.

    This field is autopopulated if not provided.

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

    The farm ID to update.

    

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

    The queue ID to update.

    

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

    The job ID to update.

    

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

    The step ID to update.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`DeadlineCloud.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.ThrottlingException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.ConflictException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.ValidationException`

  