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.

DeleteJobExecutionInput

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

type DeleteJobExecutionInput struct { ExecutionNumber *int64 `location:"uri" locationName:"executionNumber" type:"long" required:"true"` Force *bool `location:"querystring" locationName:"force" type:"boolean"` JobId *string `location:"uri" locationName:"jobId" min:"1" type:"string" required:"true"` ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"` }

ExecutionNumber

Type: *int64

The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.

ExecutionNumber is a required field

Force

Type: *bool

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

Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or 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 whose execution on a particular device will be deleted.

JobId is a required field

ThingName

Type: *string

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

ThingName is a required field

Method

GoString

func (s DeleteJobExecutionInput) GoString() string

GoString returns the string representation

SetExecutionNumber

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

SetExecutionNumber sets the ExecutionNumber field's value.

SetForce

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

SetForce sets the Force field's value.

SetJobId

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

SetJobId sets the JobId field's value.

SetThingName

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

SetThingName sets the ThingName field's value.

String

func (s DeleteJobExecutionInput) String() string

String returns the string representation

Validate

func (s *DeleteJobExecutionInput) Validate() error

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

On this page: