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.

DeleteJobInput

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

type DeleteJobInput struct { Force *bool `location:"querystring" locationName:"force" type:"boolean"` JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"` }

Force

Type: *bool

(Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.

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

JobId

Type: *string

The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

JobId is a required field

Method

GoString

func (s DeleteJobInput) GoString() string

GoString returns the string representation

SetForce

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

SetForce sets the Force field's value.

SetJobId

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

SetJobId sets the JobId field's value.

String

func (s DeleteJobInput) String() string

String returns the string representation

Validate

func (s *DeleteJobInput) Validate() error

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

On this page: