Menu
AWS Glue
Developer Guide

Jobs

Data Types

Job Structure

Specifies a job in the Data Catalog.

Fields

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

    The name you assign to this job.

  • Description – Description string, matching the URI address multi-line string pattern.

    Description of this job.

  • LogUri – String.

    This field is reserved for future use.

  • Role – String.

    The role associated with this job.

  • CreatedOn – Timestamp.

    The time and date that this job specification was created.

  • LastModifiedOn – Timestamp.

    The last point in time when this job specification was modified.

  • ExecutionProperty – An ExecutionProperty object.

    An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

  • Command – A JobCommand object.

    The JobCommand that executes this job.

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

    The default parameters for this job.

  • Connections – A ConnectionsList object.

    The connections used for this job.

  • MaxRetries – Number (integer).

    The maximum number of times to retry this job if it fails.

  • AllocatedCapacity – Number (integer).

    The number of capacity units allocated to this job.

ExecutionProperty Structure

An execution property of a job.

Fields

  • MaxConcurrentRuns – Number (integer).

    The maximum number of concurrent runs allowed for a job.

JobCommand Structure

Specifies code that executes a job.

Fields

  • Name – String.

    The name of this job command.

  • ScriptLocation – String.

    Specifies the location of a script that executes a job.

ConnectionsList Structure

Specifies the connections used by a job.

Fields

  • Connections – An array of UTF-8 strings.

    A list of connections used by the job.

JobUpdate Structure

Specifies information used to update an existing job.

Fields

  • Description – Description string, matching the URI address multi-line string pattern.

    Description of the job.

  • LogUri – String.

    This field is reserved for future use.

  • Role – String.

    The role associated with this job.

  • ExecutionProperty – An ExecutionProperty object.

    An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

  • Command – A JobCommand object.

    The JobCommand that executes this job.

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

    The default parameters for this job.

  • Connections – A ConnectionsList object.

    The connections used for this job.

  • MaxRetries – Number (integer).

    The maximum number of times to retry this job if it fails.

  • AllocatedCapacity – Number (integer).

    The number of capacity units allocated to this job.

Operations

CreateJob Action (Python: create_job)

Creates a new job.

Request

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

    The name you assign to this job.

  • Description – Description string, matching the URI address multi-line string pattern.

    Description of the job.

  • LogUri – String.

    This field is reserved for future use.

  • Role – String. Required.

    The role associated with this job.

  • ExecutionProperty – An ExecutionProperty object.

    An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

  • Command – A JobCommand object. Required.

    The JobCommand that executes this job.

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

    The default parameters for this job.

  • Connections – A ConnectionsList object.

    The connections used for this job.

  • MaxRetries – Number (integer).

    The maximum number of times to retry this job if it fails.

  • AllocatedCapacity – Number (integer).

    The number of capacity units allocated to this job.

Response

Errors

  • InvalidInputException

  • IdempotentParameterMismatchException

  • AlreadyExistsException

  • InternalServiceException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

UpdateJob Action (Python: update_job)

Updates an existing job definition.

Request

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

    Name of the job definition to update.

  • JobUpdate – A JobUpdate object. Required.

    Specifies the values with which to update the job.

Response

Errors

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

GetJob Action (Python: get_job)

Retrieves an existing job definition.

Request

Response

  • Job – A Job object.

    The requested job definition.

Errors

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

GetJobs Action (Python: get_jobs)

Retrieves all current jobs.

Request

  • NextToken – String.

    A continuation token, if this is a continuation call.

  • MaxResults – Number (integer).

    The maximum size of the response.

Response

  • Jobs – An array of Jobs.

    A list of jobs.

  • NextToken – String.

    A continuation token, if not all jobs have yet been returned.

Errors

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

DeleteJob Action (Python: delete_job)

Deletes a specified job.

Request

Response

Errors

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException