types

Documentation

Index

• type CertificateValidationException
  • func (e *CertificateValidationException) Error() string
  • func (e *CertificateValidationException) ErrorCode() string
  • func (e *CertificateValidationException) ErrorFault() smithy.ErrorFault
  • func (e *CertificateValidationException) ErrorMessage() string
• type InvalidRequestException
  • func (e *InvalidRequestException) Error() string
  • func (e *InvalidRequestException) ErrorCode() string
  • func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault
  • func (e *InvalidRequestException) ErrorMessage() string
• type InvalidStateTransitionException
  • func (e *InvalidStateTransitionException) Error() string
  • func (e *InvalidStateTransitionException) ErrorCode() string
  • func (e *InvalidStateTransitionException) ErrorFault() smithy.ErrorFault
  • func (e *InvalidStateTransitionException) ErrorMessage() string
• type JobExecution
• type JobExecutionState
• type JobExecutionStatus
• type JobExecutionSummary
• type ResourceNotFoundException
  • func (e *ResourceNotFoundException) Error() string
  • func (e *ResourceNotFoundException) ErrorCode() string
  • func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
  • func (e *ResourceNotFoundException) ErrorMessage() string
• type ServiceUnavailableException
  • func (e *ServiceUnavailableException) Error() string
  • func (e *ServiceUnavailableException) ErrorCode() string
  • func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault
  • func (e *ServiceUnavailableException) ErrorMessage() string
• type TerminalStateException
  • func (e *TerminalStateException) Error() string
  • func (e *TerminalStateException) ErrorCode() string
  • func (e *TerminalStateException) ErrorFault() smithy.ErrorFault
  • func (e *TerminalStateException) ErrorMessage() string
• type ThrottlingException
  • func (e *ThrottlingException) Error() string
  • func (e *ThrottlingException) ErrorCode() string
  • func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
  • func (e *ThrottlingException) ErrorMessage() string

Types

type CertificateValidationException

type CertificateValidationException struct {
	Message *string
}

The certificate is invalid.

func (*CertificateValidationException) Error

func (e *CertificateValidationException) Error() string

func (*CertificateValidationException) ErrorCode

func (e *CertificateValidationException) ErrorCode() string

func (*CertificateValidationException) ErrorFault

func (e *CertificateValidationException) ErrorFault() smithy.ErrorFault

func (*CertificateValidationException) ErrorMessage

func (e *CertificateValidationException) ErrorMessage() string

type InvalidRequestException

type InvalidRequestException struct {
	Message *string
}

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

func (*InvalidRequestException) Error

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault

func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidRequestException) ErrorMessage

func (e *InvalidRequestException) ErrorMessage() string

type InvalidStateTransitionException

type InvalidStateTransitionException struct {
	Message *string
}

An update attempted to change the job execution to a state that is invalid because of the job execution's current state (for example, an attempt to change a request in state SUCCESS to state IN_PROGRESS). In this case, the body of the error message also contains the executionState field.

func (*InvalidStateTransitionException) Error

func (e *InvalidStateTransitionException) Error() string

func (*InvalidStateTransitionException) ErrorCode

func (e *InvalidStateTransitionException) ErrorCode() string

func (*InvalidStateTransitionException) ErrorFault

func (e *InvalidStateTransitionException) ErrorFault() smithy.ErrorFault

func (*InvalidStateTransitionException) ErrorMessage

func (e *InvalidStateTransitionException) ErrorMessage() string

type JobExecution

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

	// The content of the job document.
	JobDocument *string

	// The unique identifier you assigned to this job when it was created.
	JobId *string

	// The time, in milliseconds since the epoch, when the job execution was last
	// updated.
	LastUpdatedAt *int64

	// The time, in milliseconds since the epoch, when the job execution was enqueued.
	QueuedAt *int64

	// The time, in milliseconds since the epoch, when the job execution was started.
	StartedAt *int64

	// 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 name of the thing that is executing the job.
	ThingName *string

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

Contains data about a job execution.

type JobExecutionState

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
}

Contains data about the state of a job execution.

type JobExecutionStatus

type JobExecutionStatus string

const (
	JobExecutionStatusQueued      JobExecutionStatus = "QUEUED"
	JobExecutionStatusIn_progress JobExecutionStatus = "IN_PROGRESS"
	JobExecutionStatusSucceeded   JobExecutionStatus = "SUCCEEDED"
	JobExecutionStatusFailed      JobExecutionStatus = "FAILED"
	JobExecutionStatusTimed_out   JobExecutionStatus = "TIMED_OUT"
	JobExecutionStatusRejected    JobExecutionStatus = "REJECTED"
	JobExecutionStatusRemoved     JobExecutionStatus = "REMOVED"
	JobExecutionStatusCanceled    JobExecutionStatus = "CANCELED"
)

Enum values for JobExecutionStatus

type JobExecutionSummary

type JobExecutionSummary struct {

	// A number that identifies a particular job execution on a particular device.
	ExecutionNumber *int64

	// The unique identifier you assigned to this job when it was created.
	JobId *string

	// The time, in milliseconds since the epoch, when the job execution was last
	// updated.
	LastUpdatedAt *int64

	// The time, in milliseconds since the epoch, when the job execution was enqueued.
	QueuedAt *int64

	// The time, in milliseconds since the epoch, when the job execution started.
	StartedAt *int64

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

Contains a subset of information about a job execution.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string
}

The specified resource does not exist.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type ServiceUnavailableException

type ServiceUnavailableException struct {
	Message *string
}

The service is temporarily unavailable.

func (*ServiceUnavailableException) Error

func (e *ServiceUnavailableException) Error() string

func (*ServiceUnavailableException) ErrorCode

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault

func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault

func (*ServiceUnavailableException) ErrorMessage

func (e *ServiceUnavailableException) ErrorMessage() string

type TerminalStateException

type TerminalStateException struct {
	Message *string
}

The job is in a terminal state.

func (*TerminalStateException) Error

func (e *TerminalStateException) Error() string

func (*TerminalStateException) ErrorCode

func (e *TerminalStateException) ErrorCode() string

func (*TerminalStateException) ErrorFault

func (e *TerminalStateException) ErrorFault() smithy.ErrorFault

func (*TerminalStateException) ErrorMessage

func (e *TerminalStateException) ErrorMessage() string

type ThrottlingException

type ThrottlingException struct {
	Message *string

	Payload []byte
}

The rate exceeds the limit.

func (*ThrottlingException) Error

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage

func (e *ThrottlingException) ErrorMessage() string