jobs

type Client struct {
	Timeouts time.Duration
	// contains filtered or unexported fields
}

type DescribeJobExecutionInput struct {
	// Optional. A number that identifies a particular job execution on a particular
	// device. If not specified, the latest job execution is returned.
	ExecutionNumber *int64 `json:"executionNumber,omitempty"`

	// Optional. When set to true, the response contains the job document. The default
	// is false.
	IncludeJobDocument *bool `json:"includeJobDocument,omitempty"`

	ClientToken string `json:"clientToken,omitempty"`
}

type DescribeJobExecutionOutput struct {
	// Contains data about a job execution.
	Execution *JobExecution `json:"execution"`

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata

	ClientToken string `json:"clientToken"`
	Timestamp   int    `json:"timestamp"`
}

type ErrorMessage struct {
	ClientToken string `json:"clientToken"`
	Timestamp   int    `json:"timestamp"`
	Code        string `json:"code"`
	Message     string `json:"message"`
}

type JobDocument struct {
	Comment string `json:"_comment"`
	Version string `json:"version"`
	Steps   []struct {
		Action struct {
			Name  string `json:"name"`
			Type  string `json:"type"`
			Input struct {
				Handler string   `json:"handler"`
				Args    []string `json:"args"`
				Path    string   `json:"path"`
			} `json:"input"`
			RunAsUser string `json:"runAsUser"`
		} `json:"action"`
	} `json:"steps"`
	FinalStep struct {
		Action struct {
			Name  string `json:"name"`
			Type  string `json:"type"`
			Input struct {
				Handler string   `json:"handler"`
				Args    []string `json:"args"`
				Path    string   `json:"path"`
			} `json:"input"`
			RunAsUser string `json:"runAsUser"`
		} `json:"action"`
	} `json:"finalStep"`
}

type JobExecution struct {

	// The estimated number of seconds that remain before the job execution status will
	// be changed to TIMED_OUT.
	ApproximateSecondsBeforeTimedOut *int64

	// A number that identifies a particular job execution on a particular device. It
	// can be used later in commands that return or update job execution information.
	ExecutionNumber *int64 `json:"executionNumber"`

	// The content of the job document.
	JobDocument JobDocument `json:"jobDocument"`

	// The unique identifier you assigned to this job when it was created.
	JobId *string `json:"jobId"`

	// The time, in milliseconds since the epoch, when the job execution was last
	// updated.
	LastUpdatedAt int64 `json:"lastUpdatedAt"`

	// The time, in milliseconds since the epoch, when the job execution was enqueued.
	QueuedAt int64 `json:"queuedAt"`

	// The time, in milliseconds since the epoch, when the job execution was started.
	StartedAt *int64 `json:"startedAt"`

	// The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS",
	// "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
	Status JobExecutionStatus `json:"status"`

	// A collection of name/value pairs that describe the status of the job execution.
	StatusDetails map[string]string `json:"statusDetails"`

	// The name of the thing that is executing the job.
	ThingName *string `json:"thingName"`

	// The version of the job execution. Job execution versions are incremented each
	// time they are updated by a device.
	VersionNumber int64 `json:"versionNumber"`

	ClientToken string `json:"clientToken"`
	Timestamp   int    `json:"timestamp"`
}

type JobExecutionState struct {

	// The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS",
	// "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
	Status JobExecutionStatus

	// A collection of name/value pairs that describe the status of the job execution.
	StatusDetails map[string]string

	// The version of the job execution. Job execution versions are incremented each
	// time they are updated by a device.
	VersionNumber int64
}

type JobExecutionStatus string

type JobExecutionSummary struct {

	// A number that identifies a particular job execution on a particular device.
	ExecutionNumber *int64 `json:"executionNumber"`

	// The unique identifier you assigned to this job when it was created.
	JobId *string `json:"jobId"`

	// The time, in milliseconds since the epoch, when the job execution was last
	// updated.
	LastUpdatedAt int64 `json:"lastUpdatedAt"`

	// The time, in milliseconds since the epoch, when the job execution was enqueued.
	QueuedAt int64 `json:"queuedAt"`

	// The time, in milliseconds since the epoch, when the job execution started.
	StartedAt *int64 `json:"startedAt"`

	// The version of the job execution. Job execution versions are incremented each
	// time AWS IoT Jobs receives an update from a device.
	VersionNumber int64 `json:"versionNumber"`
}

type JobExecutions []JobExecution

type JobExecutionsChangedHandler func(cli *Client, msg JobExecutionsChangedMessage) error

type JobExecutionsChangedMessage struct {
	Timestamp int                                  `json:"timestamp"`
	Jobs      map[JobExecutionStatus]JobExecutions `json:"jobs"`
}

type NextJobExecutionChangedHandler func(cli *Client, msg NextJobExecutionChangedMessage) error

type NextJobExecutionChangedMessage struct {
	Timestamp int          `json:"timestamp"`
	Execution JobExecution `json:"execution"`
}

type StartNextPendingJobExecutionOutput struct {

	// A JobExecution object.
	Execution *JobExecution `json:"execution"`

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata `json:"-"`

	ClientToken string `json:"clientToken"`
	Timestamp   int    `json:"timestamp"`
}

type UpdateJobExecutionInput struct {
	// The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or
	// REJECTED). This must be specified on every update.
	//
	// This member is required.
	Status types.JobExecutionStatus `json:"status"`

	// Optional. A number that identifies a particular job execution on a particular
	// device.
	ExecutionNumber *int64 `json:"executionNumber"`

	// 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.)
	ExpectedVersion *int64 `json:"expectedVersion"`

	// Optional. When set to true, the response contains the job document. The default
	// is false.
	IncludeJobDocument *bool `json:"includeJobDocument"`

	// Optional. When included and set to true, the response contains the
	// JobExecutionState data. The default is false.
	IncludeJobExecutionState *bool `json:"includeJobExecutionState"`

	// Optional. A collection of name/value pairs that describe the status of the job
	// execution. If not specified, the statusDetails are unchanged.
	StatusDetails map[string]string `json:"statusDetails"`

	// 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).
	StepTimeoutInMinutes *int64 `json:"stepTimeoutInMinutes"`

	ClientToken string `json:"clientToken"`
	Timestamp   int    `json:"timestamp"`
}