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.

Job

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

type Job struct { AllocatedCapacity *int64 `deprecated:"true" type:"integer"` Command *JobCommand `type:"structure"` Connections *ConnectionsList `type:"structure"` CreatedOn *time.Time `type:"timestamp"` DefaultArguments map[string]*string `type:"map"` Description *string `type:"string"` ExecutionProperty *ExecutionProperty `type:"structure"` LastModifiedOn *time.Time `type:"timestamp"` LogUri *string `type:"string"` MaxCapacity *float64 `type:"double"` MaxRetries *int64 `type:"integer"` Name *string `min:"1" type:"string"` NotificationProperty *NotificationProperty `type:"structure"` Role *string `type:"string"` SecurityConfiguration *string `min:"1" type:"string"` Timeout *int64 `min:"1" type:"integer"` }

Specifies a job definition.

AllocatedCapacity

Type: *int64

This field is deprecated, use MaxCapacity instead.

The number of AWS Glue data processing units (DPUs) allocated to runs of 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 (https://aws.amazon.com/glue/pricing/).

Deprecated: This property is deprecated, use MaxCapacity instead.

Command

Specifies code executed when a job is run.

Connections

Specifies the connections used by a job.

CreatedOn

Type: *time.Time

The time and date that this job definition was created.

DefaultArguments

Type: map[string]*string

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 (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.

Description

Type: *string

Description of the job being defined.

ExecutionProperty

An execution property of a job.

LastModifiedOn

Type: *time.Time

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

LogUri

Type: *string

This field is reserved for future use.

MaxCapacity

Type: *float64

AWS Glue supports running jobs on a JobCommand.Name="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using MaxCapacity. Glue ETL jobs running in any other way cannot have fractional DPU allocations.

MaxRetries

Type: *int64

The maximum number of times to retry this job after a JobRun fails.

Name

Type: *string

The name you assign to this job definition.

NotificationProperty

Specifies configuration properties of a notification.

Role

Type: *string

The name or ARN of the IAM role associated with this job.

SecurityConfiguration

Type: *string

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

Timeout

Type: *int64

The job 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).

Method

GoString

func (s Job) GoString() string

GoString returns the string representation

SetAllocatedCapacity

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

SetAllocatedCapacity sets the AllocatedCapacity field's value.

SetCommand

func (s *Job) SetCommand(v *JobCommand) *Job

SetCommand sets the Command field's value.

SetConnections

func (s *Job) SetConnections(v *ConnectionsList) *Job

SetConnections sets the Connections field's value.

SetCreatedOn

func (s *Job) SetCreatedOn(v time.Time) *Job

SetCreatedOn sets the CreatedOn field's value.

SetDefaultArguments

func (s *Job) SetDefaultArguments(v map[string]*string) *Job

SetDefaultArguments sets the DefaultArguments field's value.

SetDescription

func (s *Job) SetDescription(v string) *Job

SetDescription sets the Description field's value.

SetExecutionProperty

func (s *Job) SetExecutionProperty(v *ExecutionProperty) *Job

SetExecutionProperty sets the ExecutionProperty field's value.

SetLastModifiedOn

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

SetLastModifiedOn sets the LastModifiedOn field's value.

SetLogUri

func (s *Job) SetLogUri(v string) *Job

SetLogUri sets the LogUri field's value.

SetMaxCapacity

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

SetMaxCapacity sets the MaxCapacity field's value.

SetMaxRetries

func (s *Job) SetMaxRetries(v int64) *Job

SetMaxRetries sets the MaxRetries field's value.

SetName

func (s *Job) SetName(v string) *Job

SetName sets the Name field's value.

SetNotificationProperty

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

SetNotificationProperty sets the NotificationProperty field's value.

SetRole

func (s *Job) SetRole(v string) *Job

SetRole sets the Role field's value.

SetSecurityConfiguration

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

SetSecurityConfiguration sets the SecurityConfiguration field's value.

SetTimeout

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

SetTimeout sets the Timeout field's value.

String

func (s Job) String() string

String returns the string representation

On this page: