DeadlineCloud / Paginator / ListSteps

ListSteps

class DeadlineCloud.Paginator.ListSteps

paginator = client.get_paginator('list_steps')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID to include on the list of steps.

• queueId (string) –

  [REQUIRED]

  The queue ID to include on the list of steps.

• jobId (string) –

  [REQUIRED]

  The job 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:

dict

Returns:

Response Syntax

{
    'steps': [
        {
            '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
            },
            '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
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • steps (list) –

    The steps on the list.

    • (dict) –

      The details for a step.

      • stepId (string) –

        The step ID.

      • name (string) –

        The name of the step.

      • lifecycleStatus (string) –

        The life cycle status.

      • lifecycleStatusMessage (string) –

        A message that describes the lifecycle of the step.

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

      • targetTaskRunStatus (string) –

        The task status to start with on the job.

      • 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 for 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.

  • NextToken (string) –

    A token to resume pagination.