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/iot"

type Job struct { AbortConfig *AbortConfig `locationName:"abortConfig" type:"structure"` Comment *string `locationName:"comment" type:"string"` CompletedAt *time.Time `locationName:"completedAt" type:"timestamp"` CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` Description *string `locationName:"description" type:"string"` ForceCanceled *bool `locationName:"forceCanceled" type:"boolean"` JobArn *string `locationName:"jobArn" type:"string"` JobExecutionsRolloutConfig *JobExecutionsRolloutConfig `locationName:"jobExecutionsRolloutConfig" type:"structure"` JobId *string `locationName:"jobId" min:"1" type:"string"` JobProcessDetails *JobProcessDetails `locationName:"jobProcessDetails" type:"structure"` LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` PresignedUrlConfig *PresignedUrlConfig `locationName:"presignedUrlConfig" type:"structure"` ReasonCode *string `locationName:"reasonCode" type:"string"` Status *string `locationName:"status" type:"string" enum:"JobStatus"` TargetSelection *string `locationName:"targetSelection" type:"string" enum:"TargetSelection"` Targets []*string `locationName:"targets" min:"1" type:"list"` TimeoutConfig *TimeoutConfig `locationName:"timeoutConfig" type:"structure"` }

The Job object contains details about a job.

AbortConfig

Details of abort criteria to abort the job.

Comment

Type: *string

If the job was updated, describes the reason for the update.

CompletedAt

Type: *time.Time

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

CreatedAt

Type: *time.Time

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

Description

Type: *string

A short text description of the job.

ForceCanceled

Type: *bool

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

JobArn

Type: *string

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

JobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.

JobId

Type: *string

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

JobProcessDetails

The job process details.

LastUpdatedAt

Type: *time.Time

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

PresignedUrlConfig

Configuration for pre-signed S3 URLs.

ReasonCode

Type: *string

If the job was updated, provides the reason code for the update.

Status

Type: *string

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

TargetSelection

Type: *string

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

Targets

Type: []*string

A list of IoT things and thing groups to which the job should be sent.

TimeoutConfig

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Method

GoString

func (s Job) GoString() string

GoString returns the string representation

SetAbortConfig

func (s *Job) SetAbortConfig(v *AbortConfig) *Job

SetAbortConfig sets the AbortConfig field's value.

SetComment

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

SetComment sets the Comment field's value.

SetCompletedAt

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

SetCompletedAt sets the CompletedAt field's value.

SetCreatedAt

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

SetCreatedAt sets the CreatedAt field's value.

SetDescription

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

SetDescription sets the Description field's value.

SetForceCanceled

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

SetForceCanceled sets the ForceCanceled field's value.

SetJobArn

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

SetJobArn sets the JobArn field's value.

SetJobExecutionsRolloutConfig

func (s *Job) SetJobExecutionsRolloutConfig(v *JobExecutionsRolloutConfig) *Job

SetJobExecutionsRolloutConfig sets the JobExecutionsRolloutConfig field's value.

SetJobId

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

SetJobId sets the JobId field's value.

SetJobProcessDetails

func (s *Job) SetJobProcessDetails(v *JobProcessDetails) *Job

SetJobProcessDetails sets the JobProcessDetails field's value.

SetLastUpdatedAt

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

SetLastUpdatedAt sets the LastUpdatedAt field's value.

SetPresignedUrlConfig

func (s *Job) SetPresignedUrlConfig(v *PresignedUrlConfig) *Job

SetPresignedUrlConfig sets the PresignedUrlConfig field's value.

SetReasonCode

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

SetReasonCode sets the ReasonCode field's value.

SetStatus

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

SetStatus sets the Status field's value.

SetTargetSelection

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

SetTargetSelection sets the TargetSelection field's value.

SetTargets

func (s *Job) SetTargets(v []*string) *Job

SetTargets sets the Targets field's value.

SetTimeoutConfig

func (s *Job) SetTimeoutConfig(v *TimeoutConfig) *Job

SetTimeoutConfig sets the TimeoutConfig field's value.

String

func (s Job) String() string

String returns the string representation

On this page: