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

********
get_step
********



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

  

  Gets a step.

  

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


  **Request Syntax**
  ::

    response = client.get_step(
        farmId='string',
        queueId='string',
        jobId='string',
        stepId='string'
    )
    
  :type farmId: string
  :param farmId: **[REQUIRED]** 

    The farm ID for the step.

    

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

    The queue ID for the step.

    

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

    The job ID for the step.

    

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

    The step ID.

    

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

    
    ::

      {
          'stepId': 'string',
          'name': 'string',
          'lifecycleStatus': 'CREATE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED',
          'lifecycleStatusMessage': 'string',
          'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
          'taskRunStatusCounts': {
              'string': 123
          },
          'taskFailureRetryCount': 123,
          'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
          'createdAt': datetime(2015, 1, 1),
          'createdBy': 'string',
          'updatedAt': datetime(2015, 1, 1),
          'updatedBy': 'string',
          'startedAt': datetime(2015, 1, 1),
          'endedAt': datetime(2015, 1, 1),
          'dependencyCounts': {
              'dependenciesResolved': 123,
              'dependenciesUnresolved': 123,
              'consumersResolved': 123,
              'consumersUnresolved': 123
          },
          'requiredCapabilities': {
              'attributes': [
                  {
                      'name': 'string',
                      'anyOf': [
                          'string',
                      ],
                      'allOf': [
                          'string',
                      ]
                  },
              ],
              'amounts': [
                  {
                      'name': 'string',
                      'min': 123.0,
                      'max': 123.0,
                      'value': 123.0
                  },
              ]
          },
          'parameterSpace': {
              'parameters': [
                  {
                      'name': 'string',
                      'type': 'INT'|'FLOAT'|'STRING'|'PATH'|'CHUNK_INT',
                      'chunks': {
                          'defaultTaskCount': 123,
                          'targetRuntimeSeconds': 123,
                          'rangeConstraint': 'CONTIGUOUS'|'NONCONTIGUOUS'
                      }
                  },
              ],
              'combination': 'string'
          },
          'description': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **stepId** *(string) --* 

        The step ID.

        
      

      - **name** *(string) --* 

        The name of the step.

        
      

      - **lifecycleStatus** *(string) --* 

        The life cycle status of the step.

        
      

      - **lifecycleStatusMessage** *(string) --* 

        A message that describes the lifecycle status of the step.

        
      

      - **taskRunStatus** *(string) --* 

        The task run status for the job.

        
      

      - **taskRunStatusCounts** *(dict) --* 

        The number of tasks running on the job.

        
        

        - *(string) --* 
          

          - *(integer) --* 
    
  
      

      - **taskFailureRetryCount** *(integer) --* 

        The total number of times tasks from the step failed and were retried.

        
      

      - **targetTaskRunStatus** *(string) --* 

        The task status with which the job started.

        
      

      - **createdAt** *(datetime) --* 

        The date and time the resource was created.

        
      

      - **createdBy** *(string) --* 

        The user or system that created this resource.

        
      

      - **updatedAt** *(datetime) --* 

        The date and time the resource was updated.

        
      

      - **updatedBy** *(string) --* 

        The user or system that updated this resource.

        
      

      - **startedAt** *(datetime) --* 

        The date and time the resource started running.

        
      

      - **endedAt** *(datetime) --* 

        The date and time the resource ended running.

        
      

      - **dependencyCounts** *(dict) --* 

        The number of dependencies in the step.

        
        

        - **dependenciesResolved** *(integer) --* 

          The number of resolved dependencies.

          
        

        - **dependenciesUnresolved** *(integer) --* 

          The number of unresolved dependencies.

          
        

        - **consumersResolved** *(integer) --* 

          The number of consumers resolved.

          
        

        - **consumersUnresolved** *(integer) --* 

          The number of unresolved consumers.

          
    
      

      - **requiredCapabilities** *(dict) --* 

        The required capabilities of the step.

        
        

        - **attributes** *(list) --* 

          The capability attributes that the step requires.

          
          

          - *(dict) --* 

            The list of step attributes.

            
            

            - **name** *(string) --* 

              The name of the step attribute.

              
            

            - **anyOf** *(list) --* 

              Requires any of the step attributes in a given list.

              
              

              - *(string) --* 
          
            

            - **allOf** *(list) --* 

              Requires all of the step attribute values.

              
              

              - *(string) --* 
          
        
      
        

        - **amounts** *(list) --* 

          The capability amounts that the step requires.

          
          

          - *(dict) --* 

            The details outlining the minimum and maximum capability of a step.

            
            

            - **name** *(string) --* 

              The name of the step.

              
            

            - **min** *(float) --* 

              The minimum amount.

              
            

            - **max** *(float) --* 

              The maximum amount.

              
            

            - **value** *(float) --* 

              The amount value.

              
        
      
    
      

      - **parameterSpace** *(dict) --* 

        A list of step parameters and the combination expression for the step.

        
        

        - **parameters** *(list) --* 

          The parameters to search for.

          
          

          - *(dict) --* 

            The details of a step parameter.

            
            

            - **name** *(string) --* 

              The name of the parameter.

              
            

            - **type** *(string) --* 

              The data type of the parameter.

              
            

            - **chunks** *(dict) --* 

              The configuration for task chunking.

              
              

              - **defaultTaskCount** *(integer) --* 

                The number of tasks to combine into a single chunk by default.

                
              

              - **targetRuntimeSeconds** *(integer) --* 

                The number of seconds to aim for when forming chunks.

                
              

              - **rangeConstraint** *(string) --* 

                Specifies whether the chunked ranges must be contiguous or can have gaps between them.

                
          
        
      
        

        - **combination** *(string) --* 

          The combination expression to use in the search.

          
    
      

      - **description** *(string) --* 

        The description of the step.

         

        .. warning::

           

          This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

          

        
  
  **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.ValidationException`

  