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.

UpdateJobExecutionInput

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

type UpdateJobExecutionInput struct { ExecutionNumber *int64 `locationName:"executionNumber" type:"long"` ExpectedVersion *int64 `locationName:"expectedVersion" type:"long"` IncludeJobDocument *bool `locationName:"includeJobDocument" type:"boolean"` IncludeJobExecutionState *bool `locationName:"includeJobExecutionState" type:"boolean"` JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"` Status *string `locationName:"status" type:"string" required:"true" enum:"JobExecutionStatus"` StatusDetails map[string]*string `locationName:"statusDetails" type:"map"` StepTimeoutInMinutes *int64 `locationName:"stepTimeoutInMinutes" type:"long"` ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"` }

ExecutionNumber

Type: *int64

Optional. A number that identifies a particular job execution on a particular device.

ExpectedVersion

Type: *int64

Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

IncludeJobDocument

Type: *bool

Optional. When set to true, the response contains the job document. The default is false.

IncludeJobExecutionState

Type: *bool

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

JobId

Type: *string

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

JobId is a required field

Status

Type: *string

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Status is a required field

StatusDetails

Type: map[string]*string

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

StepTimeoutInMinutes

Type: *int64

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

ThingName

Type: *string

The name of the thing associated with the device.

ThingName is a required field

Method

GoString

func (s UpdateJobExecutionInput) GoString() string

GoString returns the string representation

SetExecutionNumber

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

SetExecutionNumber sets the ExecutionNumber field's value.

SetExpectedVersion

func (s *UpdateJobExecutionInput) SetExpectedVersion(v int64) *UpdateJobExecutionInput

SetExpectedVersion sets the ExpectedVersion field's value.

SetIncludeJobDocument

func (s *UpdateJobExecutionInput) SetIncludeJobDocument(v bool) *UpdateJobExecutionInput

SetIncludeJobDocument sets the IncludeJobDocument field's value.

SetIncludeJobExecutionState

func (s *UpdateJobExecutionInput) SetIncludeJobExecutionState(v bool) *UpdateJobExecutionInput

SetIncludeJobExecutionState sets the IncludeJobExecutionState field's value.

SetJobId

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

SetJobId sets the JobId field's value.

SetStatus

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

SetStatus sets the Status field's value.

SetStatusDetails

func (s *UpdateJobExecutionInput) SetStatusDetails(v map[string]*string) *UpdateJobExecutionInput

SetStatusDetails sets the StatusDetails field's value.

SetStepTimeoutInMinutes

func (s *UpdateJobExecutionInput) SetStepTimeoutInMinutes(v int64) *UpdateJobExecutionInput

SetStepTimeoutInMinutes sets the StepTimeoutInMinutes field's value.

SetThingName

func (s *UpdateJobExecutionInput) SetThingName(v string) *UpdateJobExecutionInput

SetThingName sets the ThingName field's value.

String

func (s UpdateJobExecutionInput) String() string

String returns the string representation

Validate

func (s *UpdateJobExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: