ioteventsdata

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 9 Imported by: 3

Documentation

Overview

Package ioteventsdata provides the client and types for making API requests to AWS IoT Events Data.

AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. AWS IoT Events Data API commands enable you to send inputs to detectors, list detectors, and view or update a detector's status.

See https://docs.aws.amazon.com/goto/WebAPI/iotevents-data-2018-10-23 for more information on this service.

See ioteventsdata package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/ioteventsdata/

Using the Client

To use AWS IoT Events Data with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS IoT Events Data client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/ioteventsdata/#New

Index

Constants

View Source 
const (
	ServiceName = "AWS IoT Events Data" // Service's name
	ServiceID   = "IoTEventsData"       // Service's identifier
	EndpointsID = "data.iotevents"      // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeInternalFailureException for service response error code
	// "InternalFailureException".
	//
	// An internal failure occured.
	ErrCodeInternalFailureException = "InternalFailureException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request was invalid.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The resource was not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The service is currently unavailable.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request could not be completed due to throttling.
	ErrCodeThrottlingException = "ThrottlingException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type BatchPutMessageErrorEntry 

type BatchPutMessageErrorEntry struct {

	// The code associated with the error.
	ErrorCode ErrorCode `locationName:"errorCode" type:"string" enum:"true"`

	// More information about the error.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`

	// The ID of the message that caused the error. (See the value corresponding
	// to the "messageId" key in the "message" object.)
	MessageId *string `locationName:"messageId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains information about the errors encountered.

func (BatchPutMessageErrorEntry) MarshalFields 

func (s BatchPutMessageErrorEntry) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchPutMessageErrorEntry) String 

func (s BatchPutMessageErrorEntry) String() string

String returns the string representation

type BatchPutMessageInput 

type BatchPutMessageInput struct {

	// The list of messages to send. Each message has the following format: '{ "messageId":
	// "string", "inputName": "string", "payload": "string"}'
	//
	// Messages is a required field
	Messages []Message `locationName:"messages" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchPutMessageInput) MarshalFields 

func (s BatchPutMessageInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchPutMessageInput) String 

func (s BatchPutMessageInput) String() string

String returns the string representation

func (*BatchPutMessageInput) Validate 

func (s *BatchPutMessageInput) Validate() error

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

type BatchPutMessageOutput 

type BatchPutMessageOutput struct {

	// A list of any errors encountered when sending the messages.
	BatchPutMessageErrorEntries []BatchPutMessageErrorEntry `type:"list"`
	// contains filtered or unexported fields
}

func (BatchPutMessageOutput) MarshalFields 

func (s BatchPutMessageOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchPutMessageOutput) String 

func (s BatchPutMessageOutput) String() string

String returns the string representation

type BatchPutMessageRequest 

type BatchPutMessageRequest struct {
	*aws.Request
	Input *BatchPutMessageInput
	Copy  func(*BatchPutMessageInput) BatchPutMessageRequest
}

BatchPutMessageRequest is the request type for the BatchPutMessage API operation.

func (BatchPutMessageRequest) Send 

func (r BatchPutMessageRequest) Send(ctx context.Context) (*BatchPutMessageResponse, error)

Send marshals and sends the BatchPutMessage API request.

type BatchPutMessageResponse 

type BatchPutMessageResponse struct {
	*BatchPutMessageOutput
	// contains filtered or unexported fields
}

BatchPutMessageResponse is the response type for the BatchPutMessage API operation.

func (*BatchPutMessageResponse) SDKResponseMetdata 

func (r *BatchPutMessageResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchPutMessage request.

type BatchUpdateDetectorErrorEntry 

type BatchUpdateDetectorErrorEntry struct {

	// The code of the error.
	ErrorCode ErrorCode `locationName:"errorCode" type:"string" enum:"true"`

	// A message describing the error.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`

	// The "messageId" of the update request that caused the error. (The value of
	// the "messageId" in the update request "Detector" object.)
	MessageId *string `locationName:"messageId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (BatchUpdateDetectorErrorEntry) MarshalFields 

func (s BatchUpdateDetectorErrorEntry) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchUpdateDetectorErrorEntry) String 

func (s BatchUpdateDetectorErrorEntry) String() string

String returns the string representation

type BatchUpdateDetectorInput 

type BatchUpdateDetectorInput struct {

	// The list of detectors (instances) to update, along with the values to update.
	//
	// Detectors is a required field
	Detectors []UpdateDetectorRequest `locationName:"detectors" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchUpdateDetectorInput) MarshalFields 

func (s BatchUpdateDetectorInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchUpdateDetectorInput) String 

func (s BatchUpdateDetectorInput) String() string

String returns the string representation

func (*BatchUpdateDetectorInput) Validate 

func (s *BatchUpdateDetectorInput) Validate() error

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

type BatchUpdateDetectorOutput 

type BatchUpdateDetectorOutput struct {

	// A list of those detector updates that resulted in errors. (If an error is
	// listed here, the specific update did not occur.)
	BatchUpdateDetectorErrorEntries []BatchUpdateDetectorErrorEntry `locationName:"batchUpdateDetectorErrorEntries" type:"list"`
	// contains filtered or unexported fields
}

func (BatchUpdateDetectorOutput) MarshalFields 

func (s BatchUpdateDetectorOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchUpdateDetectorOutput) String 

func (s BatchUpdateDetectorOutput) String() string

String returns the string representation

type BatchUpdateDetectorRequest 

type BatchUpdateDetectorRequest struct {
	*aws.Request
	Input *BatchUpdateDetectorInput
	Copy  func(*BatchUpdateDetectorInput) BatchUpdateDetectorRequest
}

BatchUpdateDetectorRequest is the request type for the BatchUpdateDetector API operation.

func (BatchUpdateDetectorRequest) Send 

func (r BatchUpdateDetectorRequest) Send(ctx context.Context) (*BatchUpdateDetectorResponse, error)

Send marshals and sends the BatchUpdateDetector API request.

type BatchUpdateDetectorResponse 

type BatchUpdateDetectorResponse struct {
	*BatchUpdateDetectorOutput
	// contains filtered or unexported fields
}

BatchUpdateDetectorResponse is the response type for the BatchUpdateDetector API operation.

func (*BatchUpdateDetectorResponse) SDKResponseMetdata 

func (r *BatchUpdateDetectorResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchUpdateDetector request.

type Client 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to AWS IoT Events Data. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := ioteventsdata.New(myConfig)

func (*Client) BatchPutMessageRequest 

func (c *Client) BatchPutMessageRequest(input *BatchPutMessageInput) BatchPutMessageRequest

BatchPutMessageRequest returns a request value for making API operation for AWS IoT Events Data.

Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify ("inputName") and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response. 

// Example sending a request using BatchPutMessageRequest.
req := client.BatchPutMessageRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-data-2018-10-23/BatchPutMessage

func (*Client) BatchUpdateDetectorRequest 

func (c *Client) BatchUpdateDetectorRequest(input *BatchUpdateDetectorInput) BatchUpdateDetectorRequest

BatchUpdateDetectorRequest returns a request value for making API operation for AWS IoT Events Data.

Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model. 

// Example sending a request using BatchUpdateDetectorRequest.
req := client.BatchUpdateDetectorRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-data-2018-10-23/BatchUpdateDetector

func (*Client) DescribeDetectorRequest 

func (c *Client) DescribeDetectorRequest(input *DescribeDetectorInput) DescribeDetectorRequest

DescribeDetectorRequest returns a request value for making API operation for AWS IoT Events Data.

Returns information about the specified detector (instance). 

// Example sending a request using DescribeDetectorRequest.
req := client.DescribeDetectorRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-data-2018-10-23/DescribeDetector

func (*Client) ListDetectorsRequest 

func (c *Client) ListDetectorsRequest(input *ListDetectorsInput) ListDetectorsRequest

ListDetectorsRequest returns a request value for making API operation for AWS IoT Events Data.

Lists detectors (the instances of a detector model). 

// Example sending a request using ListDetectorsRequest.
req := client.ListDetectorsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-data-2018-10-23/ListDetectors

type DescribeDetectorInput 

type DescribeDetectorInput struct {

	// The name of the detector model whose detectors (instances) you want information
	// about.
	//
	// DetectorModelName is a required field
	DetectorModelName *string `location:"uri" locationName:"detectorModelName" min:"1" type:"string" required:"true"`

	// A filter used to limit results to detectors (instances) created because of
	// the given key ID.
	KeyValue *string `location:"querystring" locationName:"keyValue" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDetectorInput) MarshalFields 

func (s DescribeDetectorInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeDetectorInput) String 

func (s DescribeDetectorInput) String() string

String returns the string representation

func (*DescribeDetectorInput) Validate 

func (s *DescribeDetectorInput) Validate() error

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

type DescribeDetectorOutput 

type DescribeDetectorOutput struct {

	// Information about the detector (instance).
	Detector *Detector `locationName:"detector" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDetectorOutput) MarshalFields 

func (s DescribeDetectorOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeDetectorOutput) String 

func (s DescribeDetectorOutput) String() string

String returns the string representation

type DescribeDetectorRequest 

type DescribeDetectorRequest struct {
	*aws.Request
	Input *DescribeDetectorInput
	Copy  func(*DescribeDetectorInput) DescribeDetectorRequest
}

DescribeDetectorRequest is the request type for the DescribeDetector API operation.

func (DescribeDetectorRequest) Send 

func (r DescribeDetectorRequest) Send(ctx context.Context) (*DescribeDetectorResponse, error)

Send marshals and sends the DescribeDetector API request.

type DescribeDetectorResponse 

type DescribeDetectorResponse struct {
	*DescribeDetectorOutput
	// contains filtered or unexported fields
}

DescribeDetectorResponse is the response type for the DescribeDetector API operation.

func (*DescribeDetectorResponse) SDKResponseMetdata 

func (r *DescribeDetectorResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDetector request.

type Detector 

type Detector struct {

	// The time the detector (instance) was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The name of the detector model that created this detector (instance).
	DetectorModelName *string `locationName:"detectorModelName" min:"1" type:"string"`

	// The version of the detector model that created this detector (instance).
	DetectorModelVersion *string `locationName:"detectorModelVersion" min:"1" type:"string"`

	// The value of the key (identifying the device or system) that caused the creation
	// of this detector (instance).
	KeyValue *string `locationName:"keyValue" min:"1" type:"string"`

	// The time the detector (instance) was last updated.
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`

	// The current state of the detector (instance).
	State *DetectorState `locationName:"state" type:"structure"`
	// contains filtered or unexported fields
}

Information about the detector (instance).

func (Detector) MarshalFields 

func (s Detector) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Detector) String 

func (s Detector) String() string

String returns the string representation

type DetectorState 

type DetectorState struct {

	// The name of the state.
	//
	// StateName is a required field
	StateName *string `locationName:"stateName" min:"1" type:"string" required:"true"`

	// The current state of the detector's timers.
	//
	// Timers is a required field
	Timers []Timer `locationName:"timers" type:"list" required:"true"`

	// The current values of the detector's variables.
	//
	// Variables is a required field
	Variables []Variable `locationName:"variables" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Information about the current state of the detector instance.

func (DetectorState) MarshalFields 

func (s DetectorState) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DetectorState) String 

func (s DetectorState) String() string

String returns the string representation

type DetectorStateDefinition 

type DetectorStateDefinition struct {

	// The name of the new state of the detector (instance).
	//
	// StateName is a required field
	StateName *string `locationName:"stateName" min:"1" type:"string" required:"true"`

	// The new values of the detector's timers. Any timer whose value isn't specified
	// is cleared, and its timeout event won't occur.
	//
	// Timers is a required field
	Timers []TimerDefinition `locationName:"timers" type:"list" required:"true"`

	// The new values of the detector's variables. Any variable whose value isn't
	// specified is cleared.
	//
	// Variables is a required field
	Variables []VariableDefinition `locationName:"variables" type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (DetectorStateDefinition) MarshalFields 

func (s DetectorStateDefinition) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DetectorStateDefinition) String 

func (s DetectorStateDefinition) String() string

String returns the string representation

func (*DetectorStateDefinition) Validate 

func (s *DetectorStateDefinition) Validate() error

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

type DetectorStateSummary 

type DetectorStateSummary struct {

	// The name of the state.
	StateName *string `locationName:"stateName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information about the detector state.

func (DetectorStateSummary) MarshalFields 

func (s DetectorStateSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DetectorStateSummary) String 

func (s DetectorStateSummary) String() string

String returns the string representation

type DetectorSummary 

type DetectorSummary struct {

	// The time the detector (instance) was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The name of the detector model that created this detector (instance).
	DetectorModelName *string `locationName:"detectorModelName" min:"1" type:"string"`

	// The version of the detector model that created this detector (instance).
	DetectorModelVersion *string `locationName:"detectorModelVersion" min:"1" type:"string"`

	// The value of the key (identifying the device or system) that caused the creation
	// of this detector (instance).
	KeyValue *string `locationName:"keyValue" min:"1" type:"string"`

	// The time the detector (instance) was last updated.
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`

	// The current state of the detector (instance).
	State *DetectorStateSummary `locationName:"state" type:"structure"`
	// contains filtered or unexported fields
}

Information about the detector (instance).

func (DetectorSummary) MarshalFields 

func (s DetectorSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DetectorSummary) String 

func (s DetectorSummary) String() string

String returns the string representation

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) MarshalValue 

func (enum ErrorCode) MarshalValue() (string, error)

func (ErrorCode) MarshalValueBuf 

func (enum ErrorCode) MarshalValueBuf(b []byte) ([]byte, error)

type ListDetectorsInput 

type ListDetectorsInput struct {

	// The name of the detector model whose detectors (instances) are listed.
	//
	// DetectorModelName is a required field
	DetectorModelName *string `location:"uri" locationName:"detectorModelName" min:"1" type:"string" required:"true"`

	// The maximum number of results to return at one time.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// A filter that limits results to those detectors (instances) in the given
	// state.
	StateName *string `location:"querystring" locationName:"stateName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDetectorsInput) MarshalFields 

func (s ListDetectorsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDetectorsInput) String 

func (s ListDetectorsInput) String() string

String returns the string representation

func (*ListDetectorsInput) Validate 

func (s *ListDetectorsInput) Validate() error

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

type ListDetectorsOutput 

type ListDetectorsOutput struct {

	// A list of summary information about the detectors (instances).
	DetectorSummaries []DetectorSummary `locationName:"detectorSummaries" type:"list"`

	// A token to retrieve the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDetectorsOutput) MarshalFields 

func (s ListDetectorsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDetectorsOutput) String 

func (s ListDetectorsOutput) String() string

String returns the string representation

type ListDetectorsRequest 

type ListDetectorsRequest struct {
	*aws.Request
	Input *ListDetectorsInput
	Copy  func(*ListDetectorsInput) ListDetectorsRequest
}

ListDetectorsRequest is the request type for the ListDetectors API operation.

func (ListDetectorsRequest) Send 

func (r ListDetectorsRequest) Send(ctx context.Context) (*ListDetectorsResponse, error)

Send marshals and sends the ListDetectors API request.

type ListDetectorsResponse 

type ListDetectorsResponse struct {
	*ListDetectorsOutput
	// contains filtered or unexported fields
}

ListDetectorsResponse is the response type for the ListDetectors API operation.

func (*ListDetectorsResponse) SDKResponseMetdata 

func (r *ListDetectorsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListDetectors request.

type Message 

type Message struct {

	// The name of the input into which the message payload is transformed.
	//
	// InputName is a required field
	InputName *string `locationName:"inputName" min:"1" type:"string" required:"true"`

	// The ID to assign to the message. Within each batch sent, each "messageId"
	// must be unique.
	//
	// MessageId is a required field
	MessageId *string `locationName:"messageId" min:"1" type:"string" required:"true"`

	// 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).
	//
	// Payload is automatically base64 encoded/decoded by the SDK.
	//
	// Payload is a required field
	Payload []byte `locationName:"payload" type:"blob" required:"true"`
	// contains filtered or unexported fields
}

Information about a message.

func (Message) MarshalFields 

func (s Message) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Message) String 

func (s Message) String() string

String returns the string representation

func (*Message) Validate 

func (s *Message) Validate() error

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

type Timer 

type Timer struct {

	// The name of the timer.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The number of seconds which have elapsed on the timer.
	//
	// Timestamp is a required field
	Timestamp *time.Time `locationName:"timestamp" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

The current state of a timer.

func (Timer) MarshalFields 

func (s Timer) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Timer) String 

func (s Timer) String() string

String returns the string representation

type TimerDefinition 

type TimerDefinition struct {

	// The name of the timer.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The new setting of the timer (the number of seconds before the timer elapses).
	//
	// Seconds is a required field
	Seconds *int64 `locationName:"seconds" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

The new setting of a timer.

func (TimerDefinition) MarshalFields 

func (s TimerDefinition) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TimerDefinition) String 

func (s TimerDefinition) String() string

String returns the string representation

func (*TimerDefinition) Validate 

func (s *TimerDefinition) Validate() error

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

type UpdateDetectorRequest 

type UpdateDetectorRequest struct {

	// The name of the detector model that created the detectors (instances).
	//
	// DetectorModelName is a required field
	DetectorModelName *string `locationName:"detectorModelName" min:"1" type:"string" required:"true"`

	// The value of the input key attribute (identifying the device or system) that
	// caused the creation of this detector (instance).
	KeyValue *string `locationName:"keyValue" min:"1" type:"string"`

	// The ID to assign to the detector update "message". Each "messageId" must
	// be unique within each batch sent.
	//
	// MessageId is a required field
	MessageId *string `locationName:"messageId" min:"1" type:"string" required:"true"`

	// The new state, variable values, and timer settings of the detector (instance).
	//
	// State is a required field
	State *DetectorStateDefinition `locationName:"state" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Information used to update the detector (instance).

func (UpdateDetectorRequest) MarshalFields 

func (s UpdateDetectorRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateDetectorRequest) String 

func (s UpdateDetectorRequest) String() string

String returns the string representation

func (*UpdateDetectorRequest) Validate 

func (s *UpdateDetectorRequest) Validate() error

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

type Variable 

type Variable struct {

	// The name of the variable.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The current value of the variable.
	//
	// Value is a required field
	Value *string `locationName:"value" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The current state of the variable.

func (Variable) MarshalFields 

func (s Variable) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Variable) String 

func (s Variable) String() string

String returns the string representation

type VariableDefinition 

type VariableDefinition struct {

	// The name of the variable.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The new value of the variable.
	//
	// Value is a required field
	Value *string `locationName:"value" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The new value of the variable.

func (VariableDefinition) MarshalFields 

func (s VariableDefinition) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (VariableDefinition) String 

func (s VariableDefinition) String() string

String returns the string representation

func (*VariableDefinition) Validate 

func (s *VariableDefinition) Validate() error

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

Source Files

View all Source files

Directories

Path Synopsis
Package ioteventsdataiface provides an interface to enable mocking the AWS IoT Events Data service client for testing your code.
 Package ioteventsdataiface provides an interface to enable mocking the AWS IoT Events Data service client for testing your code.

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.