AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

JobRun

import "github.com/aws/aws-sdk-go/service/glue"

type JobRun struct { AllocatedCapacity *int64 `deprecated:"true" type:"integer"` Arguments map[string]*string `type:"map"` Attempt *int64 `type:"integer"` CompletedOn *time.Time `type:"timestamp"` ErrorMessage *string `type:"string"` ExecutionTime *int64 `type:"integer"` Id *string `min:"1" type:"string"` JobName *string `min:"1" type:"string"` JobRunState *string `type:"string" enum:"JobRunState"` LastModifiedOn *time.Time `type:"timestamp"` LogGroupName *string `type:"string"` MaxCapacity *float64 `type:"double"` NotificationProperty *NotificationProperty `type:"structure"` PredecessorRuns []*Predecessor `type:"list"` PreviousRunId *string `min:"1" type:"string"` SecurityConfiguration *string `min:"1" type:"string"` StartedOn *time.Time `type:"timestamp"` Timeout *int64 `min:"1" type:"integer"` TriggerName *string `min:"1" type:"string"` }

Contains information about a job run.

AllocatedCapacity

Type: *int64

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 (https://aws.amazon.com/glue/pricing/).

Deprecated: This property is deprecated, use MaxCapacity instead.

Arguments

Type: map[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 (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) 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 (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) topic in the developer guide.

Attempt

Type: *int64

The number of the attempt to run this job.

CompletedOn

Type: *time.Time

The date and time this job run completed.

ErrorMessage

Type: *string

An error message associated with this job run.

ExecutionTime

Type: *int64

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

Id

Type: *string

The ID of this job run.

JobName

Type: *string

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

JobRunState

Type: *string

The current state of the job run.

LastModifiedOn

Type: *time.Time

The last time this job run was modified.

LogGroupName

Type: *string

The name of the log group for secure logging, that can be server-side encrypted in CloudWatch using 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 will be used to encrypt the log group.

MaxCapacity

Type: *float64

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 (https://aws.amazon.com/glue/pricing/).

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.

NotificationProperty

Specifies configuration properties of a notification.

PredecessorRuns

A job run that was used in the predicate of a conditional trigger that triggered this job run.

PreviousRunId

Type: *string

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

SecurityConfiguration

Type: *string

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

StartedOn

Type: *time.Time

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

Timeout

Type: *int64

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.

TriggerName

Type: *string

The name of the trigger that started this job run.

Method

GoString

func (s JobRun) GoString() string

GoString returns the string representation

SetAllocatedCapacity

func (s *JobRun) SetAllocatedCapacity(v int64) *JobRun

SetAllocatedCapacity sets the AllocatedCapacity field's value.

SetArguments

func (s *JobRun) SetArguments(v map[string]*string) *JobRun

SetArguments sets the Arguments field's value.

SetAttempt

func (s *JobRun) SetAttempt(v int64) *JobRun

SetAttempt sets the Attempt field's value.

SetCompletedOn

func (s *JobRun) SetCompletedOn(v time.Time) *JobRun

SetCompletedOn sets the CompletedOn field's value.

SetErrorMessage

func (s *JobRun) SetErrorMessage(v string) *JobRun

SetErrorMessage sets the ErrorMessage field's value.

SetExecutionTime

func (s *JobRun) SetExecutionTime(v int64) *JobRun

SetExecutionTime sets the ExecutionTime field's value.

SetId

func (s *JobRun) SetId(v string) *JobRun

SetId sets the Id field's value.

SetJobName

func (s *JobRun) SetJobName(v string) *JobRun

SetJobName sets the JobName field's value.

SetJobRunState

func (s *JobRun) SetJobRunState(v string) *JobRun

SetJobRunState sets the JobRunState field's value.

SetLastModifiedOn

func (s *JobRun) SetLastModifiedOn(v time.Time) *JobRun

SetLastModifiedOn sets the LastModifiedOn field's value.

SetLogGroupName

func (s *JobRun) SetLogGroupName(v string) *JobRun

SetLogGroupName sets the LogGroupName field's value.

SetMaxCapacity

func (s *JobRun) SetMaxCapacity(v float64) *JobRun

SetMaxCapacity sets the MaxCapacity field's value.

SetNotificationProperty

func (s *JobRun) SetNotificationProperty(v *NotificationProperty) *JobRun

SetNotificationProperty sets the NotificationProperty field's value.

SetPredecessorRuns

func (s *JobRun) SetPredecessorRuns(v []*Predecessor) *JobRun

SetPredecessorRuns sets the PredecessorRuns field's value.

SetPreviousRunId

func (s *JobRun) SetPreviousRunId(v string) *JobRun

SetPreviousRunId sets the PreviousRunId field's value.

SetSecurityConfiguration

func (s *JobRun) SetSecurityConfiguration(v string) *JobRun

SetSecurityConfiguration sets the SecurityConfiguration field's value.

SetStartedOn

func (s *JobRun) SetStartedOn(v time.Time) *JobRun

SetStartedOn sets the StartedOn field's value.

SetTimeout

func (s *JobRun) SetTimeout(v int64) *JobRun

SetTimeout sets the Timeout field's value.

SetTriggerName

func (s *JobRun) SetTriggerName(v string) *JobRun

SetTriggerName sets the TriggerName field's value.

String

func (s JobRun) String() string

String returns the string representation

On this page: