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.

CancelJobExecutionInput

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

type CancelJobExecutionInput struct { ExpectedVersion *int64 `locationName:"expectedVersion" type:"long"` Force *bool `location:"querystring" locationName:"force" type:"boolean"` JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"` StatusDetails map[string]*string `locationName:"statusDetails" type:"map"` ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"` }

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

Force

Type: *bool

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

JobId

Type: *string

The ID of the job to be canceled.

JobId is a required field

StatusDetails

Type: map[string]*string

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

ThingName

Type: *string

The name of the thing whose execution of the job will be canceled.

ThingName is a required field

Method

GoString

func (s CancelJobExecutionInput) GoString() string

GoString returns the string representation

SetExpectedVersion

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

SetExpectedVersion sets the ExpectedVersion field's value.

SetForce

func (s *CancelJobExecutionInput) SetForce(v bool) *CancelJobExecutionInput

SetForce sets the Force field's value.

SetJobId

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

SetJobId sets the JobId field's value.

SetStatusDetails

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

SetStatusDetails sets the StatusDetails field's value.

SetThingName

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

SetThingName sets the ThingName field's value.

String

func (s CancelJobExecutionInput) String() string

String returns the string representation

Validate

func (s *CancelJobExecutionInput) Validate() error

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

On this page: