DeadlineCloud / Client / list_step_consumers

list_step_consumers#

DeadlineCloud.Client.list_step_consumers(**kwargs)#

Lists step consumers.

See also: AWS API Documentation

Request Syntax

response = client.list_step_consumers(
    farmId='string',
    jobId='string',
    maxResults=123,
    nextToken='string',
    queueId='string',
    stepId='string'
)
Parameters:

  • farmId (string) –

    [REQUIRED]

    The farm ID for the list of step consumers.

  • jobId (string) –

    [REQUIRED]

    The job ID for the step consumer.

  • maxResults (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

  • nextToken (string) – The token for the next set of results, or null to start from the beginning.

  • queueId (string) –

    [REQUIRED]

    The queue ID for the step consumer.

  • stepId (string) –

    [REQUIRED]

    The step ID to include on the list.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • consumers (list) –

      The consumers on the list.

      • (dict) –

        The details of a step consumer.

        • status (string) –

          The step consumer status.

        • stepId (string) –

          The step ID.

    • 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