Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BatchPutMessageErrorEntry

type BatchPutMessageErrorEntry struct {

	// The code associated with the error.
	ErrorCode ErrorCode

	// More information about the error.
	ErrorMessage *string

	// The ID of the message that caused the error. (See the value corresponding to the
	// "messageId" key in the "message" object.)
	MessageId *string
}

    Contains information about the errors encountered.

    type BatchUpdateDetectorErrorEntry

    type BatchUpdateDetectorErrorEntry struct {
    
    	// The code of the error.
    	ErrorCode ErrorCode
    
    	// A message describing the error.
    	ErrorMessage *string
    
    	// The "messageId" of the update request that caused the error. (The value of the
    	// "messageId" in the update request "Detector" object.)
    	MessageId *string
    }

      Information about the error that occured when attempting to update a detector.

      type Detector

      type Detector struct {
      
      	// The time the detector (instance) was created.
      	CreationTime *time.Time
      
      	// The name of the detector model that created this detector (instance).
      	DetectorModelName *string
      
      	// The version of the detector model that created this detector (instance).
      	DetectorModelVersion *string
      
      	// The value of the key (identifying the device or system) that caused the creation
      	// of this detector (instance).
      	KeyValue *string
      
      	// The time the detector (instance) was last updated.
      	LastUpdateTime *time.Time
      
      	// The current state of the detector (instance).
      	State *DetectorState
      }

        Information about the detector (instance).

        type DetectorState

        type DetectorState struct {
        
        	// The name of the state.
        	//
        	// This member is required.
        	StateName *string
        
        	// The current state of the detector's timers.
        	//
        	// This member is required.
        	Timers []Timer
        
        	// The current values of the detector's variables.
        	//
        	// This member is required.
        	Variables []Variable
        }

          Information about the current state of the detector instance.

          type DetectorStateDefinition

          type DetectorStateDefinition struct {
          
          	// The name of the new state of the detector (instance).
          	//
          	// This member is required.
          	StateName *string
          
          	// The new values of the detector's timers. Any timer whose value isn't specified
          	// is cleared, and its timeout event won't occur.
          	//
          	// This member is required.
          	Timers []TimerDefinition
          
          	// The new values of the detector's variables. Any variable whose value isn't
          	// specified is cleared.
          	//
          	// This member is required.
          	Variables []VariableDefinition
          }

            The new state, variable values, and timer settings of the detector (instance).

            type DetectorStateSummary

            type DetectorStateSummary struct {
            
            	// The name of the state.
            	StateName *string
            }

              Information about the detector state.

              type DetectorSummary

              type DetectorSummary struct {
              
              	// The time the detector (instance) was created.
              	CreationTime *time.Time
              
              	// The name of the detector model that created this detector (instance).
              	DetectorModelName *string
              
              	// The version of the detector model that created this detector (instance).
              	DetectorModelVersion *string
              
              	// The value of the key (identifying the device or system) that caused the creation
              	// of this detector (instance).
              	KeyValue *string
              
              	// The time the detector (instance) was last updated.
              	LastUpdateTime *time.Time
              
              	// The current state of the detector (instance).
              	State *DetectorStateSummary
              }

                Information about the detector (instance).

                type ErrorCode

                type ErrorCode string
                const (
                	ErrorCodeResourceNotFoundException   ErrorCode = "ResourceNotFoundException"
                	ErrorCodeInvalidRequestException     ErrorCode = "InvalidRequestException"
                	ErrorCodeInternalFailureException    ErrorCode = "InternalFailureException"
                	ErrorCodeServiceUnavailableException ErrorCode = "ServiceUnavailableException"
                	ErrorCodeThrottlingException         ErrorCode = "ThrottlingException"
                )

                  Enum values for ErrorCode

                  func (ErrorCode) Values

                  func (ErrorCode) Values() []ErrorCode

                    Values returns all known values for ErrorCode. 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 InternalFailureException

                    type InternalFailureException struct {
                    	Message *string
                    }

                      An internal failure occured.

                      func (*InternalFailureException) Error

                      func (e *InternalFailureException) Error() string

                      func (*InternalFailureException) ErrorCode

                      func (e *InternalFailureException) ErrorCode() string

                      func (*InternalFailureException) ErrorFault

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

                      func (*InternalFailureException) ErrorMessage

                      func (e *InternalFailureException) ErrorMessage() string

                      type InvalidRequestException

                      type InvalidRequestException struct {
                      	Message *string
                      }

                        The request was 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 Message

                        type Message struct {
                        
                        	// The name of the input into which the message payload is transformed.
                        	//
                        	// This member is required.
                        	InputName *string
                        
                        	// The ID to assign to the message. Within each batch sent, each "messageId" must
                        	// be unique.
                        	//
                        	// This member is required.
                        	MessageId *string
                        
                        	// The payload of the message. This can be a JSON string or a Base-64-encoded
                        	// string representing binary data (in which case you must decode it).
                        	//
                        	// This member is required.
                        	Payload []byte
                        }

                          Information about a message.

                          type ResourceNotFoundException

                          type ResourceNotFoundException struct {
                          	Message *string
                          }

                            The resource was not found.

                            func (*ResourceNotFoundException) Error

                            func (e *ResourceNotFoundException) Error() string

                            func (*ResourceNotFoundException) ErrorCode

                            func (e *ResourceNotFoundException) ErrorCode() string

                            func (*ResourceNotFoundException) ErrorFault

                            func (*ResourceNotFoundException) ErrorMessage

                            func (e *ResourceNotFoundException) ErrorMessage() string

                            type ServiceUnavailableException

                            type ServiceUnavailableException struct {
                            	Message *string
                            }

                              The service is currently unavailable.

                              func (*ServiceUnavailableException) Error

                              func (*ServiceUnavailableException) ErrorCode

                              func (e *ServiceUnavailableException) ErrorCode() string

                              func (*ServiceUnavailableException) ErrorFault

                              func (*ServiceUnavailableException) ErrorMessage

                              func (e *ServiceUnavailableException) ErrorMessage() string

                              type ThrottlingException

                              type ThrottlingException struct {
                              	Message *string
                              }

                                The request could not be completed due to throttling.

                                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 Timer

                                type Timer struct {
                                
                                	// The name of the timer.
                                	//
                                	// This member is required.
                                	Name *string
                                
                                	// The number of seconds which have elapsed on the timer.
                                	//
                                	// This member is required.
                                	Timestamp *time.Time
                                }

                                  The current state of a timer.

                                  type TimerDefinition

                                  type TimerDefinition struct {
                                  
                                  	// The name of the timer.
                                  	//
                                  	// This member is required.
                                  	Name *string
                                  
                                  	// The new setting of the timer (the number of seconds before the timer elapses).
                                  	//
                                  	// This member is required.
                                  	Seconds *int32
                                  }

                                    The new setting of a timer.

                                    type UpdateDetectorRequest

                                    type UpdateDetectorRequest struct {
                                    
                                    	// The name of the detector model that created the detectors (instances).
                                    	//
                                    	// This member is required.
                                    	DetectorModelName *string
                                    
                                    	// The ID to assign to the detector update "message". Each "messageId" must be
                                    	// unique within each batch sent.
                                    	//
                                    	// This member is required.
                                    	MessageId *string
                                    
                                    	// The new state, variable values, and timer settings of the detector (instance).
                                    	//
                                    	// This member is required.
                                    	State *DetectorStateDefinition
                                    
                                    	// The value of the input key attribute (identifying the device or system) that
                                    	// caused the creation of this detector (instance).
                                    	KeyValue *string
                                    }

                                      Information used to update the detector (instance).

                                      type Variable

                                      type Variable struct {
                                      
                                      	// The name of the variable.
                                      	//
                                      	// This member is required.
                                      	Name *string
                                      
                                      	// The current value of the variable.
                                      	//
                                      	// This member is required.
                                      	Value *string
                                      }

                                        The current state of the variable.

                                        type VariableDefinition

                                        type VariableDefinition struct {
                                        
                                        	// The name of the variable.
                                        	//
                                        	// This member is required.
                                        	Name *string
                                        
                                        	// The new value of the variable.
                                        	//
                                        	// This member is required.
                                        	Value *string
                                        }

                                          The new value of the variable.