Menu
AWS Glue
Developer Guide

Job Runs

Data Types

JobRun Structure

Contains information about a job run.

Fields

  • Id – String, matching the Single-line string pattern.

    The ID of this job run.

  • Attempt – Number (integer).

    The number or the attempt to run this job.

  • PreviousRunId – String, matching the Single-line string pattern.

    The ID of the previous run of this job.

  • TriggerName – String, matching the Single-line string pattern.

    The name of the trigger for this job run.

  • JobName – String, matching the Single-line string pattern.

    The name of the job being run.

  • StartedOn – Timestamp.

    The date and time at which this job run was started.

  • LastModifiedOn – Timestamp.

    The last time this job run was modified.

  • CompletedOn – Timestamp.

    The date and time this job run completed.

  • JobRunState – String (valid values: STARTING | RUNNING | STOPPING | STOPPED | SUCCEEDED | FAILED).

    The current state of the job run.

  • Arguments – An array of UTF-8 string–to–UTF-8 string mappings.

    The job arguments associated with this run.

  • ErrorMessage – String.

    An error message associated with this job run.

  • PredecessorRuns – An array of Predecessors.

    A list of predecessors to this job run.

  • AllocatedCapacity – Number (integer).

    The amount of infrastructure capacity allocated to this job run.

Predecessor Structure

A job run that preceded this one.

Fields

JobBookmarkEntry Structure

Defines a point which a job can resume processing.

Fields

  • JobName – String.

    Name of the job in question.

  • Version – Number (integer).

    Version of the job.

  • Run – Number (integer).

    The run ID number.

  • Attempt – Number (integer).

    The attempt ID number.

  • JobBookmark – String.

    The bookmark itself.

Operations

StartJobRun Action (Python: start_job_run)

Runs a job.

Request

  • JobName – String, matching the Single-line string pattern. Required.

    The name of the job to start.

  • JobRunId – String, matching the Single-line string pattern.

    The ID of the job run to start.

  • Arguments – An array of UTF-8 string–to–UTF-8 string mappings.

    Specific arguments for this job run.

  • AllocatedCapacity – Number (integer).

    The infrastructure capacity to allocate to this job.

Response

Errors

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • ConcurrentRunsExceededException

GetJobRun Action (Python: get_job_run)

Retrieves the metadata for a given job run.

Request

  • JobName – String, matching the Single-line string pattern. Required.

    Name of the job being run.

  • RunId – String, matching the Single-line string pattern. Required.

    The ID of the job run.

  • PredecessorsIncluded – Boolean.

    A list of the predecessor runs to return as well.

Response

  • JobRun – A JobRun object.

    The requested job-run metadata.

Errors

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

GetJobRuns Action (Python: get_job_runs)

Retrieves metadata for all runs of a given job.

Request

  • JobName – String, matching the Single-line string pattern. Required.

    The name of the job for which to retrieve all job runs.

  • NextToken – String.

    A continuation token, if this is a continuation call.

  • MaxResults – Number (integer).

    The maximum size of the response.

Response

  • JobRuns – An array of JobRuns.

    A list of job-run metatdata objects.

  • NextToken – String.

    A continuation token, if not all reequested job runs have been returned.

Errors

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

ResetJobBookmark Action (Python: reset_job_bookmark)

Resets a bookmark entry.

Request

  • JobName – String. Required.

    The name of the job in question.

Response

  • JobBookmarkEntry – A JobBookmarkEntry object.

    The reset bookmark entry.

Errors

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException