Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . glue ]

get-jobs

Description

Retrieves all current jobs.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

get-jobs is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Jobs

Synopsis

  get-jobs
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Jobs -> (list)

A list of jobs.

(structure)

Specifies a job.

Name -> (string)

The name you assign to this job.

Description -> (string)

Description of this job.

LogUri -> (string)

This field is reserved for future use.

Role -> (string)

The name of the IAM 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 -> (structure)

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

MaxConcurrentRuns -> (integer)

The maximum number of concurrent runs allowed for a job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

Command -> (structure)

The JobCommand that executes this job.

Name -> (string)

The name of the job command: this must be glueetl .

ScriptLocation -> (string)

Specifies the S3 path to a script that executes a job (required).

DefaultArguments -> (map)

The default arguments for this job, specified as name-value pairs.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

key -> (string)

value -> (string)

Connections -> (structure)

The connections used for this job.

Connections -> (list)

A list of connections used by the job.

(string)

MaxRetries -> (integer)

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

AllocatedCapacity -> (integer)

The number of AWS Glue data processing units (DPUs) allocated to this Job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

NextToken -> (string)

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