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.

CancelJobInput

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

type CancelJobInput struct { Comment *string `locationName:"comment" type:"string"` Force *bool `location:"querystring" locationName:"force" type:"boolean"` JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"` ReasonCode *string `locationName:"reasonCode" type:"string"` }

Comment

Type: *string

An optional comment string describing why the job was canceled.

Force

Type: *bool

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

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

JobId

Type: *string

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

JobId is a required field

ReasonCode

Type: *string

(Optional)A reason code string that explains why the job was canceled.

Method

GoString

func (s CancelJobInput) GoString() string

GoString returns the string representation

SetComment

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

SetComment sets the Comment field's value.

SetForce

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

SetForce sets the Force field's value.

SetJobId

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

SetJobId sets the JobId field's value.

SetReasonCode

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

SetReasonCode sets the ReasonCode field's value.

String

func (s CancelJobInput) String() string

String returns the string representation

Validate

func (s *CancelJobInput) Validate() error

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

On this page: