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.

JobExecution

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

type JobExecution struct { ApproximateSecondsBeforeTimedOut *int64 `locationName:"approximateSecondsBeforeTimedOut" type:"long"` ExecutionNumber *int64 `locationName:"executionNumber" type:"long"` ForceCanceled *bool `locationName:"forceCanceled" type:"boolean"` JobId *string `locationName:"jobId" min:"1" type:"string"` LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` QueuedAt *time.Time `locationName:"queuedAt" type:"timestamp"` StartedAt *time.Time `locationName:"startedAt" type:"timestamp"` Status *string `locationName:"status" type:"string" enum:"JobExecutionStatus"` StatusDetails *JobExecutionStatusDetails `locationName:"statusDetails" type:"structure"` ThingArn *string `locationName:"thingArn" type:"string"` VersionNumber *int64 `locationName:"versionNumber" type:"long"` }

The job execution object represents the execution of a job on a particular device.

ApproximateSecondsBeforeTimedOut

Type: *int64

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.

ExecutionNumber

Type: *int64

A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

ForceCanceled

Type: *bool

Will be true if the job execution was canceled with the optional force parameter set to true.

JobId

Type: *string

The unique identifier you assigned to the job when it was created.

LastUpdatedAt

Type: *time.Time

The time, in seconds since the epoch, when the job execution was last updated.

QueuedAt

Type: *time.Time

The time, in seconds since the epoch, when the job execution was queued.

StartedAt

Type: *time.Time

The time, in seconds since the epoch, when the job execution started.

Status

Type: *string

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

StatusDetails

Details of the job execution status.

ThingArn

Type: *string

The ARN of the thing on which the job execution is running.

VersionNumber

Type: *int64

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

Method

GoString

func (s JobExecution) GoString() string

GoString returns the string representation

SetApproximateSecondsBeforeTimedOut

func (s *JobExecution) SetApproximateSecondsBeforeTimedOut(v int64) *JobExecution

SetApproximateSecondsBeforeTimedOut sets the ApproximateSecondsBeforeTimedOut field's value.

SetExecutionNumber

func (s *JobExecution) SetExecutionNumber(v int64) *JobExecution

SetExecutionNumber sets the ExecutionNumber field's value.

SetForceCanceled

func (s *JobExecution) SetForceCanceled(v bool) *JobExecution

SetForceCanceled sets the ForceCanceled field's value.

SetJobId

func (s *JobExecution) SetJobId(v string) *JobExecution

SetJobId sets the JobId field's value.

SetLastUpdatedAt

func (s *JobExecution) SetLastUpdatedAt(v time.Time) *JobExecution

SetLastUpdatedAt sets the LastUpdatedAt field's value.

SetQueuedAt

func (s *JobExecution) SetQueuedAt(v time.Time) *JobExecution

SetQueuedAt sets the QueuedAt field's value.

SetStartedAt

func (s *JobExecution) SetStartedAt(v time.Time) *JobExecution

SetStartedAt sets the StartedAt field's value.

SetStatus

func (s *JobExecution) SetStatus(v string) *JobExecution

SetStatus sets the Status field's value.

SetStatusDetails

func (s *JobExecution) SetStatusDetails(v *JobExecutionStatusDetails) *JobExecution

SetStatusDetails sets the StatusDetails field's value.

SetThingArn

func (s *JobExecution) SetThingArn(v string) *JobExecution

SetThingArn sets the ThingArn field's value.

SetVersionNumber

func (s *JobExecution) SetVersionNumber(v int64) *JobExecution

SetVersionNumber sets the VersionNumber field's value.

String

func (s JobExecution) String() string

String returns the string representation

On this page: