types

package
v1.25.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 3, 2025 License: Apache-2.0 Imports: 3 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CertificateValidationException 

type CertificateValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 CommandParameterValue added in v1.24.0 

type CommandParameterValue struct {

	// An attribute of type Boolean. For example:
	//
	//     "BOOL": true
	B *bool

	// An attribute of type Binary.
	BIN []byte

	// An attribute of type Double (Sixty-Four Bits).
	D *float64

	// An attribute of type Integer (Thirty-Two Bits).
	I *int32

	// An attribute of type Long.
	L *int64

	// An attribute of type String. For example:
	//
	//     "S": "Hello"
	S *string

	// An attribute of type Unsigned Long.
	UL *string
	// contains filtered or unexported fields
}

The list of values used to describe a specific command parameter.

type ConflictException added in v1.24.0 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId *string
	// contains filtered or unexported fields
}

A conflict has occurred when performing the API request.

func (*ConflictException) Error added in v1.24.0 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode added in v1.24.0 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault added in v1.24.0 

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

func (*ConflictException) ErrorMessage added in v1.24.0 

func (e *ConflictException) ErrorMessage() string

type InternalServerException added in v1.24.0 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An internal server error occurred when performing the API request.

func (*InternalServerException) Error added in v1.24.0 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode added in v1.24.0 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault added in v1.24.0 

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

func (*InternalServerException) ErrorMessage added in v1.24.0 

func (e *InternalServerException) ErrorMessage() string

type InvalidRequestException 

type InvalidRequestException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The contents of the request were invalid.

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 . The actual job execution timeout can occur up to
	// 60 seconds later than the estimated duration.
	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 seconds since the epoch, when the job execution was last updated.
	LastUpdatedAt int64

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

	// The time, in seconds 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", "TIMED_OUT", "REJECTED", or "REMOVED".
	Status JobExecutionStatus

	// A collection of name/value pairs that describe the status of the job execution.
	//
	// The maximum length of the value in the name/value pair is 1,024 characters.
	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 filtered or unexported fields
}

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", "TIMED_OUT", "REJECTED", or "REMOVED".
	Status JobExecutionStatus

	// A collection of name/value pairs that describe the status of the job execution.
	//
	// The maximum length of the value in the name/value pair is 1,024 characters.
	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 filtered or unexported fields
}

Contains data about the state of a job execution.

type JobExecutionStatus 

type JobExecutionStatus string
const (
	JobExecutionStatusQueued     JobExecutionStatus = "QUEUED"
	JobExecutionStatusInProgress JobExecutionStatus = "IN_PROGRESS"
	JobExecutionStatusSucceeded  JobExecutionStatus = "SUCCEEDED"
	JobExecutionStatusFailed     JobExecutionStatus = "FAILED"
	JobExecutionStatusTimedOut   JobExecutionStatus = "TIMED_OUT"
	JobExecutionStatusRejected   JobExecutionStatus = "REJECTED"
	JobExecutionStatusRemoved    JobExecutionStatus = "REMOVED"
	JobExecutionStatusCanceled   JobExecutionStatus = "CANCELED"
)

Enum values for JobExecutionStatus

func (JobExecutionStatus) Values added in v0.29.0 

func (JobExecutionStatus) Values() []JobExecutionStatus

Values returns all known values for JobExecutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

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 seconds since the epoch, when the job execution was last updated.
	LastUpdatedAt int64

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

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

	// The version of the job execution. Job execution versions are incremented each
	// time IoT Jobs receives an update from a device.
	VersionNumber int64
	// contains filtered or unexported fields
}

Contains a subset of information about a job execution.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 ServiceQuotaExceededException added in v1.24.0 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The service quota has been exceeded for this request.

func (*ServiceQuotaExceededException) Error added in v1.24.0 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode added in v1.24.0 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault added in v1.24.0 

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

func (*ServiceQuotaExceededException) ErrorMessage added in v1.24.0 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type ServiceUnavailableException 

type ServiceUnavailableException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string

	Payload []byte
	// contains filtered or unexported fields
}

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

type ValidationException added in v1.24.0 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A validation error occurred when performing the API request.

func (*ValidationException) Error added in v1.24.0 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode added in v1.24.0 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault added in v1.24.0 

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

func (*ValidationException) ErrorMessage added in v1.24.0 

func (e *ValidationException) ErrorMessage() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.