Class: Aws::Glue::Types::JobRun

Inherits:

Struct

Object
Struct
Aws::Glue::Types::JobRun

show all

Includes:: Structure

Defined in:: lib/aws-sdk-glue/types.rb

Overview

Contains information about a job run.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#allocated_capacity ⇒ Integer

This field is deprecated.
#arguments ⇒ Hash<String,String>

The job arguments associated with this run.
#attempt ⇒ Integer

The number of the attempt to run this job.
#completed_on ⇒ Time

The date and time that this job run completed.
#error_message ⇒ String

An error message associated with this job run.
#execution_time ⇒ Integer

The amount of time (in seconds) that the job run consumed resources.
#glue_version ⇒ String

Glue version determines the versions of Apache Spark and Python that AWS Glue supports.
#id ⇒ String

The ID of this job run.
#job_name ⇒ String

The name of the job definition being used in this run.
#job_run_state ⇒ String

The current state of the job run.
#last_modified_on ⇒ Time

The last time that this job run was modified.
#log_group_name ⇒ String

The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using AWS KMS.
#max_capacity ⇒ Float

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
#notification_property ⇒ Types::NotificationProperty

Specifies configuration properties of a job run notification.
#number_of_workers ⇒ Integer

The number of workers of a defined ‘workerType` that are allocated when a job runs.
#predecessor_runs ⇒ Array<Types::Predecessor>

A list of predecessors to this job run.
#previous_run_id ⇒ String

The ID of the previous run of this job.
#security_configuration ⇒ String

The name of the ‘SecurityConfiguration` structure to be used with this job run.
#started_on ⇒ Time

The date and time at which this job run was started.
#timeout ⇒ Integer

The ‘JobRun` timeout in minutes.
#trigger_name ⇒ String

The name of the trigger that started this job run.
#worker_type ⇒ String

The type of predefined worker that is allocated when a job runs.

Instance Attribute Details

#allocated_capacity ⇒ `Integer`

This field is deprecated. Use ‘MaxCapacity` instead.

The number of AWS Glue data processing units (DPUs) allocated to this JobRun. 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].

[1]: aws.amazon.com/glue/pricing/

Returns:

(Integer)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#arguments ⇒ `Hash<String,String>`

The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.

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.

[1]: docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html [2]: docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#attempt ⇒ `Integer`

The number of the attempt to run this job.

Returns:

(Integer)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#completed_on ⇒ `Time`

The date and time that this job run completed.

Returns:

(Time)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ `String`

An error message associated with this job run.

Returns:

(String)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#execution_time ⇒ `Integer`

The amount of time (in seconds) that the job run consumed resources.

Returns:

(Integer)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#glue_version ⇒ `String`

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see [Glue version] in the developer guide.

Jobs that are created without specifying a Glue version default to Glue 0.9.

[1]: docs.aws.amazon.com/glue/latest/dg/add-job.html

Returns:

(String)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ `String`

The ID of this job run.

Returns:

(String)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ `String`

The name of the job definition being used in this run.

Returns:

(String)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#job_run_state ⇒ `String`

The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see [AWS Glue Job Run Statuses].

[1]: docs.aws.amazon.com/glue/latest/dg/job-run-statuses.html

Returns:

(String)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_on ⇒ `Time`

The last time that this job run was modified.

Returns:

(Time)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_name ⇒ `String`

The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using AWS KMS. This name can be ‘/aws-glue/jobs/`, in which case the default encryption is `NONE`. If you add a role name and `SecurityConfiguration` name (in other words, `/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/`), then that security configuration is used to encrypt the log group.

Returns:

(String)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#max_capacity ⇒ `Float`

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. 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].

Do not set ‘Max Capacity` if using `WorkerType` and `NumberOfWorkers`.

The value that can be allocated for ‘MaxCapacity` depends on whether you are running a Python shell job or an Apache Spark ETL job:

When you specify a Python shell job (‘JobCommand.Name`=“pythonshell”), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (‘JobCommand.Name`=“glueetl”), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

[1]: docs.aws.amazon.com/https:/aws.amazon.com/glue/pricing/

Returns:

(Float)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#notification_property ⇒ `Types::NotificationProperty`

Specifies configuration properties of a job run notification.

Returns:

(Types::NotificationProperty)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_workers ⇒ `Integer`

The number of workers of a defined ‘workerType` that are allocated when a job runs.

The maximum number of workers you can define are 299 for ‘G.1X`, and 149 for `G.2X`.

Returns:

(Integer)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#predecessor_runs ⇒ `Array<Types::Predecessor>`

A list of predecessors to this job run.

Returns:

(Array<Types::Predecessor>)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#previous_run_id ⇒ `String`

The ID of the previous run of this job. For example, the ‘JobRunId` specified in the `StartJobRun` action.

Returns:

(String)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#security_configuration ⇒ `String`

The name of the ‘SecurityConfiguration` structure to be used with this job run.

Returns:

(String)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#started_on ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#timeout ⇒ `Integer`

The ‘JobRun` timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters `TIMEOUT` status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

Returns:

(Integer)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#trigger_name ⇒ `String`

The name of the trigger that started this job run.

Returns:

(String)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

#worker_type ⇒ `String`

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

For the ‘Standard` worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the ‘G.1X` worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the ‘G.2X` worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

Returns:

(String)

# File 'lib/aws-sdk-glue/types.rb', line 10354

class JobRun < Struct.new(
  :id,
  :attempt,
  :previous_run_id,
  :trigger_name,
  :job_name,
  :started_on,
  :last_modified_on,
  :completed_on,
  :job_run_state,
  :arguments,
  :error_message,
  :predecessor_runs,
  :allocated_capacity,
  :execution_time,
  :timeout,
  :max_capacity,
  :worker_type,
  :number_of_workers,
  :security_configuration,
  :log_group_name,
  :notification_property,
  :glue_version)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Glue::Types::JobRun

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_capacity ⇒ Integer

#arguments ⇒ Hash<String,String>

#attempt ⇒ Integer

#completed_on ⇒ Time

#error_message ⇒ String

#execution_time ⇒ Integer

#glue_version ⇒ String

#id ⇒ String

#job_name ⇒ String

#job_run_state ⇒ String

#last_modified_on ⇒ Time

#log_group_name ⇒ String

#max_capacity ⇒ Float

#notification_property ⇒ Types::NotificationProperty

#number_of_workers ⇒ Integer

#predecessor_runs ⇒ Array<Types::Predecessor>

#previous_run_id ⇒ String

#security_configuration ⇒ String

#started_on ⇒ Time

#timeout ⇒ Integer

#trigger_name ⇒ String

#worker_type ⇒ String

#allocated_capacity ⇒ `Integer`

#arguments ⇒ `Hash<String,String>`

#attempt ⇒ `Integer`

#completed_on ⇒ `Time`

#error_message ⇒ `String`

#execution_time ⇒ `Integer`

#glue_version ⇒ `String`

#id ⇒ `String`

#job_name ⇒ `String`

#job_run_state ⇒ `String`

#last_modified_on ⇒ `Time`

#log_group_name ⇒ `String`

#max_capacity ⇒ `Float`

#notification_property ⇒ `Types::NotificationProperty`

#number_of_workers ⇒ `Integer`

#predecessor_runs ⇒ `Array<Types::Predecessor>`

#previous_run_id ⇒ `String`

#security_configuration ⇒ `String`

#started_on ⇒ `Time`

#timeout ⇒ `Integer`

#trigger_name ⇒ `String`

#worker_type ⇒ `String`