DeadlineCloud / Client / list_steps

list_steps

DeadlineCloud.Client.list_steps(**kwargs)

Lists steps for a job.

See also: AWS API Documentation

Request Syntax

response = client.list_steps(
    farmId='string',
    queueId='string',
    jobId='string',
    nextToken='string',
    maxResults=123
)

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.

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

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

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

    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

• DeadlineCloud.Client.exceptions.AccessDeniedException

• DeadlineCloud.Client.exceptions.InternalServerErrorException

• DeadlineCloud.Client.exceptions.ResourceNotFoundException

• DeadlineCloud.Client.exceptions.ThrottlingException

• DeadlineCloud.Client.exceptions.ValidationException