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

*******************
list_step_consumers
*******************



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

  

  Lists step consumers.

  

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


  **Request Syntax**
  ::

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

    The farm ID for the list of step consumers.

    

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

    The queue ID for the step consumer.

    

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

    The job ID for the step consumer.

    

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

    The step ID to include on the list.

    

  
  :type nextToken: string
  :param nextToken: 

    The token for the next set of results, or ``null`` to start from the beginning.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return. Use this parameter with ``NextToken`` to get results as a set of sequential pages.

    

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

    
    ::

      {
          'consumers': [
              {
                  'stepId': 'string',
                  'status': 'RESOLVED'|'UNRESOLVED'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **consumers** *(list) --* 

        The consumers on the list.

        
        

        - *(dict) --* 

          The details of a step consumer.

          
          

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

            The step ID.

            
          

          - **status** *(string) --* 

            The step consumer status.

            
      
    
      

      - **nextToken** *(string) --* 

        If Deadline Cloud returns ``nextToken``, then there are more results available. The value of ``nextToken`` is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then ``nextToken`` is set to ``null``. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ``ValidationException`` error.

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

  