DeadlineCloud / Paginator / ListSteps


class DeadlineCloud.Paginator.ListSteps#
paginator = client.get_paginator('list_steps')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • farmId (string) –


    The farm ID to include on the list of steps.

  • jobId (string) –


    The job ID to include on the list of steps.

  • queueId (string) –


    The queue ID to include on the list of steps.

  • 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:



Response Syntax

    'steps': [
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'dependencyCounts': {
                'consumersResolved': 123,
                'consumersUnresolved': 123,
                'dependenciesResolved': 123,
                'dependenciesUnresolved': 123
            'endedAt': datetime(2015, 1, 1),
            'lifecycleStatusMessage': 'string',
            'name': 'string',
            'startedAt': datetime(2015, 1, 1),
            'stepId': 'string',
            'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
            'taskRunStatusCounts': {
                'string': 123
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • steps (list) –

      The steps on the list.

      • (dict) –

        The details for a step.

        • createdAt (datetime) –

          The date and time the resource was created.

        • createdBy (string) –

          The user or system that created this resource.

        • dependencyCounts (dict) –

          The number of dependencies for the step.

          • consumersResolved (integer) –

            The number of consumers resolved.

          • consumersUnresolved (integer) –

            The number of unresolved consumers.

          • dependenciesResolved (integer) –

            The number of resolved dependencies.

          • dependenciesUnresolved (integer) –

            The number of unresolved dependencies.

        • endedAt (datetime) –

          The date and time the resource ended running.

        • lifecycleStatus (string) –

          The life cycle status.

        • lifecycleStatusMessage (string) –

          A message that describes the lifecycle of the step.

        • name (string) –

          The name of the step.

        • startedAt (datetime) –

          The date and time the resource started running.

        • stepId (string) –

          The step ID.

        • targetTaskRunStatus (string) –

          The task status to start with on the job.

        • taskRunStatus (string) –

          The task run status for the job.

          • PENDING–pending and waiting for resources.

          • READY–ready to process.

          • ASSIGNED–assigned and will run next on a worker.

          • SCHEDULED–scheduled to run on a worker.

          • INTERRUPTING–being interrupted.

          • RUNNING–running on a worker.

          • SUSPENDED–the task is suspended.

          • CANCELED–the task has been canceled.

          • FAILED–the task has failed.

          • SUCCEEDED–the task has succeeded.

        • taskRunStatusCounts (dict) –

          The number of tasks running on the job.

          • (string) –

            • (integer) –

        • updatedAt (datetime) –

          The date and time the resource was updated.

        • updatedBy (string) –

          The user or system that updated this resource.

    • NextToken (string) –

      A token to resume pagination.