DeadlineCloud / Paginator / ListStepConsumers

ListStepConsumers#

class DeadlineCloud.Paginator.ListStepConsumers#
paginator = client.get_paginator('list_step_consumers')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from DeadlineCloud.Client.list_step_consumers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    farmId='string',
    queueId='string',
    jobId='string',
    stepId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • farmId (string) –

    [REQUIRED]

    The farm ID for the list of step consumers.

  • queueId (string) –

    [REQUIRED]

    The queue ID for the step consumer.

  • jobId (string) –

    [REQUIRED]

    The job ID for the step consumer.

  • stepId (string) –

    [REQUIRED]

    The step ID to include on the list.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

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) –

      A token to resume pagination.