aws-sdk-go: github.com/aws/aws-sdk-go/service/ioteventsdata Index | Files | Directories

package ioteventsdata

import "github.com/aws/aws-sdk-go/service/ioteventsdata"

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 contact 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 IoTEventsData for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/ioteventsdata/#New

Index

Package Files

api.go doc.go errors.go service.go

Constants

const (
    // ErrorCodeResourceNotFoundException is a ErrorCode enum value
    ErrorCodeResourceNotFoundException = "ResourceNotFoundException"

    // ErrorCodeInvalidRequestException is a ErrorCode enum value
    ErrorCodeInvalidRequestException = "InvalidRequestException"

    // ErrorCodeInternalFailureException is a ErrorCode enum value
    ErrorCodeInternalFailureException = "InternalFailureException"

    // ErrorCodeServiceUnavailableException is a ErrorCode enum value
    ErrorCodeServiceUnavailableException = "ServiceUnavailableException"

    // ErrorCodeThrottlingException is a ErrorCode enum value
    ErrorCodeThrottlingException = "ThrottlingException"
)
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"
)
const (
    ServiceName = "IoT Events Data" // Name of service.
    EndpointsID = "data.iotevents"  // ID to lookup a service endpoint with.
    ServiceID   = "IoT Events Data" // ServiceID is a unique identifer of a specific service.
)

Service information constants

type BatchPutMessageErrorEntry Uses

type BatchPutMessageErrorEntry struct {

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

    // 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) GoString Uses

func (s BatchPutMessageErrorEntry) GoString() string

GoString returns the string representation

func (*BatchPutMessageErrorEntry) SetErrorCode Uses

func (s *BatchPutMessageErrorEntry) SetErrorCode(v string) *BatchPutMessageErrorEntry

SetErrorCode sets the ErrorCode field's value.

func (*BatchPutMessageErrorEntry) SetErrorMessage Uses

func (s *BatchPutMessageErrorEntry) SetErrorMessage(v string) *BatchPutMessageErrorEntry

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchPutMessageErrorEntry) SetMessageId Uses

func (s *BatchPutMessageErrorEntry) SetMessageId(v string) *BatchPutMessageErrorEntry

SetMessageId sets the MessageId field's value.

func (BatchPutMessageErrorEntry) String Uses

func (s BatchPutMessageErrorEntry) String() string

String returns the string representation

type BatchPutMessageInput Uses

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) GoString Uses

func (s BatchPutMessageInput) GoString() string

GoString returns the string representation

func (*BatchPutMessageInput) SetMessages Uses

func (s *BatchPutMessageInput) SetMessages(v []*Message) *BatchPutMessageInput

SetMessages sets the Messages field's value.

func (BatchPutMessageInput) String Uses

func (s BatchPutMessageInput) String() string

String returns the string representation

func (*BatchPutMessageInput) Validate Uses

func (s *BatchPutMessageInput) Validate() error

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

type BatchPutMessageOutput Uses

type BatchPutMessageOutput struct {

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

func (BatchPutMessageOutput) GoString Uses

func (s BatchPutMessageOutput) GoString() string

GoString returns the string representation

func (*BatchPutMessageOutput) SetBatchPutMessageErrorEntries Uses

func (s *BatchPutMessageOutput) SetBatchPutMessageErrorEntries(v []*BatchPutMessageErrorEntry) *BatchPutMessageOutput

SetBatchPutMessageErrorEntries sets the BatchPutMessageErrorEntries field's value.

func (BatchPutMessageOutput) String Uses

func (s BatchPutMessageOutput) String() string

String returns the string representation

type BatchUpdateDetectorErrorEntry Uses

type BatchUpdateDetectorErrorEntry struct {

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

    // 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) GoString Uses

func (s BatchUpdateDetectorErrorEntry) GoString() string

GoString returns the string representation

func (*BatchUpdateDetectorErrorEntry) SetErrorCode Uses

func (s *BatchUpdateDetectorErrorEntry) SetErrorCode(v string) *BatchUpdateDetectorErrorEntry

SetErrorCode sets the ErrorCode field's value.

func (*BatchUpdateDetectorErrorEntry) SetErrorMessage Uses

func (s *BatchUpdateDetectorErrorEntry) SetErrorMessage(v string) *BatchUpdateDetectorErrorEntry

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchUpdateDetectorErrorEntry) SetMessageId Uses

func (s *BatchUpdateDetectorErrorEntry) SetMessageId(v string) *BatchUpdateDetectorErrorEntry

SetMessageId sets the MessageId field's value.

func (BatchUpdateDetectorErrorEntry) String Uses

func (s BatchUpdateDetectorErrorEntry) String() string

String returns the string representation

type BatchUpdateDetectorInput Uses

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) GoString Uses

func (s BatchUpdateDetectorInput) GoString() string

GoString returns the string representation

func (*BatchUpdateDetectorInput) SetDetectors Uses

func (s *BatchUpdateDetectorInput) SetDetectors(v []*UpdateDetectorRequest) *BatchUpdateDetectorInput

SetDetectors sets the Detectors field's value.

func (BatchUpdateDetectorInput) String Uses

func (s BatchUpdateDetectorInput) String() string

String returns the string representation

func (*BatchUpdateDetectorInput) Validate Uses

func (s *BatchUpdateDetectorInput) Validate() error

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

type BatchUpdateDetectorOutput Uses

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) GoString Uses

func (s BatchUpdateDetectorOutput) GoString() string

GoString returns the string representation

func (*BatchUpdateDetectorOutput) SetBatchUpdateDetectorErrorEntries Uses

func (s *BatchUpdateDetectorOutput) SetBatchUpdateDetectorErrorEntries(v []*BatchUpdateDetectorErrorEntry) *BatchUpdateDetectorOutput

SetBatchUpdateDetectorErrorEntries sets the BatchUpdateDetectorErrorEntries field's value.

func (BatchUpdateDetectorOutput) String Uses

func (s BatchUpdateDetectorOutput) String() string

String returns the string representation

type DescribeDetectorInput Uses

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) GoString Uses

func (s DescribeDetectorInput) GoString() string

GoString returns the string representation

func (*DescribeDetectorInput) SetDetectorModelName Uses

func (s *DescribeDetectorInput) SetDetectorModelName(v string) *DescribeDetectorInput

SetDetectorModelName sets the DetectorModelName field's value.

func (*DescribeDetectorInput) SetKeyValue Uses

func (s *DescribeDetectorInput) SetKeyValue(v string) *DescribeDetectorInput

SetKeyValue sets the KeyValue field's value.

func (DescribeDetectorInput) String Uses

func (s DescribeDetectorInput) String() string

String returns the string representation

func (*DescribeDetectorInput) Validate Uses

func (s *DescribeDetectorInput) Validate() error

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

type DescribeDetectorOutput Uses

type DescribeDetectorOutput struct {

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

func (DescribeDetectorOutput) GoString Uses

func (s DescribeDetectorOutput) GoString() string

GoString returns the string representation

func (*DescribeDetectorOutput) SetDetector Uses

func (s *DescribeDetectorOutput) SetDetector(v *Detector) *DescribeDetectorOutput

SetDetector sets the Detector field's value.

func (DescribeDetectorOutput) String Uses

func (s DescribeDetectorOutput) String() string

String returns the string representation

type Detector Uses

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) GoString Uses

func (s Detector) GoString() string

GoString returns the string representation

func (*Detector) SetCreationTime Uses

func (s *Detector) SetCreationTime(v time.Time) *Detector

SetCreationTime sets the CreationTime field's value.

func (*Detector) SetDetectorModelName Uses

func (s *Detector) SetDetectorModelName(v string) *Detector

SetDetectorModelName sets the DetectorModelName field's value.

func (*Detector) SetDetectorModelVersion Uses

func (s *Detector) SetDetectorModelVersion(v string) *Detector

SetDetectorModelVersion sets the DetectorModelVersion field's value.

func (*Detector) SetKeyValue Uses

func (s *Detector) SetKeyValue(v string) *Detector

SetKeyValue sets the KeyValue field's value.

func (*Detector) SetLastUpdateTime Uses

func (s *Detector) SetLastUpdateTime(v time.Time) *Detector

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*Detector) SetState Uses

func (s *Detector) SetState(v *DetectorState) *Detector

SetState sets the State field's value.

func (Detector) String Uses

func (s Detector) String() string

String returns the string representation

type DetectorState Uses

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) GoString Uses

func (s DetectorState) GoString() string

GoString returns the string representation

func (*DetectorState) SetStateName Uses

func (s *DetectorState) SetStateName(v string) *DetectorState

SetStateName sets the StateName field's value.

func (*DetectorState) SetTimers Uses

func (s *DetectorState) SetTimers(v []*Timer) *DetectorState

SetTimers sets the Timers field's value.

func (*DetectorState) SetVariables Uses

func (s *DetectorState) SetVariables(v []*Variable) *DetectorState

SetVariables sets the Variables field's value.

func (DetectorState) String Uses

func (s DetectorState) String() string

String returns the string representation

type DetectorStateDefinition Uses

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) GoString Uses

func (s DetectorStateDefinition) GoString() string

GoString returns the string representation

func (*DetectorStateDefinition) SetStateName Uses

func (s *DetectorStateDefinition) SetStateName(v string) *DetectorStateDefinition

SetStateName sets the StateName field's value.

func (*DetectorStateDefinition) SetTimers Uses

func (s *DetectorStateDefinition) SetTimers(v []*TimerDefinition) *DetectorStateDefinition

SetTimers sets the Timers field's value.

func (*DetectorStateDefinition) SetVariables Uses

func (s *DetectorStateDefinition) SetVariables(v []*VariableDefinition) *DetectorStateDefinition

SetVariables sets the Variables field's value.

func (DetectorStateDefinition) String Uses

func (s DetectorStateDefinition) String() string

String returns the string representation

func (*DetectorStateDefinition) Validate Uses

func (s *DetectorStateDefinition) Validate() error

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

type DetectorStateSummary Uses

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) GoString Uses

func (s DetectorStateSummary) GoString() string

GoString returns the string representation

func (*DetectorStateSummary) SetStateName Uses

func (s *DetectorStateSummary) SetStateName(v string) *DetectorStateSummary

SetStateName sets the StateName field's value.

func (DetectorStateSummary) String Uses

func (s DetectorStateSummary) String() string

String returns the string representation

type DetectorSummary Uses

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) GoString Uses

func (s DetectorSummary) GoString() string

GoString returns the string representation

func (*DetectorSummary) SetCreationTime Uses

func (s *DetectorSummary) SetCreationTime(v time.Time) *DetectorSummary

SetCreationTime sets the CreationTime field's value.

func (*DetectorSummary) SetDetectorModelName Uses

func (s *DetectorSummary) SetDetectorModelName(v string) *DetectorSummary

SetDetectorModelName sets the DetectorModelName field's value.

func (*DetectorSummary) SetDetectorModelVersion Uses

func (s *DetectorSummary) SetDetectorModelVersion(v string) *DetectorSummary

SetDetectorModelVersion sets the DetectorModelVersion field's value.

func (*DetectorSummary) SetKeyValue Uses

func (s *DetectorSummary) SetKeyValue(v string) *DetectorSummary

SetKeyValue sets the KeyValue field's value.

func (*DetectorSummary) SetLastUpdateTime Uses

func (s *DetectorSummary) SetLastUpdateTime(v time.Time) *DetectorSummary

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*DetectorSummary) SetState Uses

func (s *DetectorSummary) SetState(v *DetectorStateSummary) *DetectorSummary

SetState sets the State field's value.

func (DetectorSummary) String Uses

func (s DetectorSummary) String() string

String returns the string representation

type IoTEventsData Uses

type IoTEventsData struct {
    *client.Client
}

IoTEventsData 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.

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

func New Uses

func New(p client.ConfigProvider, cfgs ...*aws.Config) *IoTEventsData

New creates a new instance of the IoTEventsData client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a IoTEventsData client from just a session.
svc := ioteventsdata.New(mySession)

// Create a IoTEventsData client with additional configuration
svc := ioteventsdata.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*IoTEventsData) BatchPutMessage Uses

func (c *IoTEventsData) BatchPutMessage(input *BatchPutMessageInput) (*BatchPutMessageOutput, error)

BatchPutMessage 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Events Data's API operation BatchPutMessage for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request was invalid.

* ErrCodeInternalFailureException "InternalFailureException"
An internal failure occured.

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The service is currently unavailable.

* ErrCodeThrottlingException "ThrottlingException"
The request could not be completed due to throttling.

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

func (*IoTEventsData) BatchPutMessageRequest Uses

func (c *IoTEventsData) BatchPutMessageRequest(input *BatchPutMessageInput) (req *request.Request, output *BatchPutMessageOutput)

BatchPutMessageRequest generates a "aws/request.Request" representing the client's request for the BatchPutMessage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchPutMessage for more information on using the BatchPutMessage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchPutMessageRequest method.
req, resp := client.BatchPutMessageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*IoTEventsData) BatchPutMessageWithContext Uses

func (c *IoTEventsData) BatchPutMessageWithContext(ctx aws.Context, input *BatchPutMessageInput, opts ...request.Option) (*BatchPutMessageOutput, error)

BatchPutMessageWithContext is the same as BatchPutMessage with the addition of the ability to pass a context and additional request options.

See BatchPutMessage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTEventsData) BatchUpdateDetector Uses

func (c *IoTEventsData) BatchUpdateDetector(input *BatchUpdateDetectorInput) (*BatchUpdateDetectorOutput, error)

BatchUpdateDetector 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Events Data's API operation BatchUpdateDetector for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request was invalid.

* ErrCodeInternalFailureException "InternalFailureException"
An internal failure occured.

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The service is currently unavailable.

* ErrCodeThrottlingException "ThrottlingException"
The request could not be completed due to throttling.

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

func (*IoTEventsData) BatchUpdateDetectorRequest Uses

func (c *IoTEventsData) BatchUpdateDetectorRequest(input *BatchUpdateDetectorInput) (req *request.Request, output *BatchUpdateDetectorOutput)

BatchUpdateDetectorRequest generates a "aws/request.Request" representing the client's request for the BatchUpdateDetector operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchUpdateDetector for more information on using the BatchUpdateDetector API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchUpdateDetectorRequest method.
req, resp := client.BatchUpdateDetectorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*IoTEventsData) BatchUpdateDetectorWithContext Uses

func (c *IoTEventsData) BatchUpdateDetectorWithContext(ctx aws.Context, input *BatchUpdateDetectorInput, opts ...request.Option) (*BatchUpdateDetectorOutput, error)

BatchUpdateDetectorWithContext is the same as BatchUpdateDetector with the addition of the ability to pass a context and additional request options.

See BatchUpdateDetector for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTEventsData) DescribeDetector Uses

func (c *IoTEventsData) DescribeDetector(input *DescribeDetectorInput) (*DescribeDetectorOutput, error)

DescribeDetector API operation for AWS IoT Events Data.

Returns information about the specified detector (instance).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Events Data's API operation DescribeDetector for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request was invalid.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The resource was not found.

* ErrCodeThrottlingException "ThrottlingException"
The request could not be completed due to throttling.

* ErrCodeInternalFailureException "InternalFailureException"
An internal failure occured.

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The service is currently unavailable.

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

func (*IoTEventsData) DescribeDetectorRequest Uses

func (c *IoTEventsData) DescribeDetectorRequest(input *DescribeDetectorInput) (req *request.Request, output *DescribeDetectorOutput)

DescribeDetectorRequest generates a "aws/request.Request" representing the client's request for the DescribeDetector operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDetector for more information on using the DescribeDetector API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDetectorRequest method.
req, resp := client.DescribeDetectorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*IoTEventsData) DescribeDetectorWithContext Uses

func (c *IoTEventsData) DescribeDetectorWithContext(ctx aws.Context, input *DescribeDetectorInput, opts ...request.Option) (*DescribeDetectorOutput, error)

DescribeDetectorWithContext is the same as DescribeDetector with the addition of the ability to pass a context and additional request options.

See DescribeDetector for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTEventsData) ListDetectors Uses

func (c *IoTEventsData) ListDetectors(input *ListDetectorsInput) (*ListDetectorsOutput, error)

ListDetectors API operation for AWS IoT Events Data.

Lists detectors (the instances of a detector model).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Events Data's API operation ListDetectors for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request was invalid.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The resource was not found.

* ErrCodeThrottlingException "ThrottlingException"
The request could not be completed due to throttling.

* ErrCodeInternalFailureException "InternalFailureException"
An internal failure occured.

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The service is currently unavailable.

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

func (*IoTEventsData) ListDetectorsRequest Uses

func (c *IoTEventsData) ListDetectorsRequest(input *ListDetectorsInput) (req *request.Request, output *ListDetectorsOutput)

ListDetectorsRequest generates a "aws/request.Request" representing the client's request for the ListDetectors operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDetectors for more information on using the ListDetectors API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDetectorsRequest method.
req, resp := client.ListDetectorsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*IoTEventsData) ListDetectorsWithContext Uses

func (c *IoTEventsData) ListDetectorsWithContext(ctx aws.Context, input *ListDetectorsInput, opts ...request.Option) (*ListDetectorsOutput, error)

ListDetectorsWithContext is the same as ListDetectors with the addition of the ability to pass a context and additional request options.

See ListDetectors for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ListDetectorsInput Uses

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) GoString Uses

func (s ListDetectorsInput) GoString() string

GoString returns the string representation

func (*ListDetectorsInput) SetDetectorModelName Uses

func (s *ListDetectorsInput) SetDetectorModelName(v string) *ListDetectorsInput

SetDetectorModelName sets the DetectorModelName field's value.

func (*ListDetectorsInput) SetMaxResults Uses

func (s *ListDetectorsInput) SetMaxResults(v int64) *ListDetectorsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDetectorsInput) SetNextToken Uses

func (s *ListDetectorsInput) SetNextToken(v string) *ListDetectorsInput

SetNextToken sets the NextToken field's value.

func (*ListDetectorsInput) SetStateName Uses

func (s *ListDetectorsInput) SetStateName(v string) *ListDetectorsInput

SetStateName sets the StateName field's value.

func (ListDetectorsInput) String Uses

func (s ListDetectorsInput) String() string

String returns the string representation

func (*ListDetectorsInput) Validate Uses

func (s *ListDetectorsInput) Validate() error

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

type ListDetectorsOutput Uses

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) GoString Uses

func (s ListDetectorsOutput) GoString() string

GoString returns the string representation

func (*ListDetectorsOutput) SetDetectorSummaries Uses

func (s *ListDetectorsOutput) SetDetectorSummaries(v []*DetectorSummary) *ListDetectorsOutput

SetDetectorSummaries sets the DetectorSummaries field's value.

func (*ListDetectorsOutput) SetNextToken Uses

func (s *ListDetectorsOutput) SetNextToken(v string) *ListDetectorsOutput

SetNextToken sets the NextToken field's value.

func (ListDetectorsOutput) String Uses

func (s ListDetectorsOutput) String() string

String returns the string representation

type Message Uses

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) GoString Uses

func (s Message) GoString() string

GoString returns the string representation

func (*Message) SetInputName Uses

func (s *Message) SetInputName(v string) *Message

SetInputName sets the InputName field's value.

func (*Message) SetMessageId Uses

func (s *Message) SetMessageId(v string) *Message

SetMessageId sets the MessageId field's value.

func (*Message) SetPayload Uses

func (s *Message) SetPayload(v []byte) *Message

SetPayload sets the Payload field's value.

func (Message) String Uses

func (s Message) String() string

String returns the string representation

func (*Message) Validate Uses

func (s *Message) Validate() error

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

type Timer Uses

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) GoString Uses

func (s Timer) GoString() string

GoString returns the string representation

func (*Timer) SetName Uses

func (s *Timer) SetName(v string) *Timer

SetName sets the Name field's value.

func (*Timer) SetTimestamp Uses

func (s *Timer) SetTimestamp(v time.Time) *Timer

SetTimestamp sets the Timestamp field's value.

func (Timer) String Uses

func (s Timer) String() string

String returns the string representation

type TimerDefinition Uses

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) GoString Uses

func (s TimerDefinition) GoString() string

GoString returns the string representation

func (*TimerDefinition) SetName Uses

func (s *TimerDefinition) SetName(v string) *TimerDefinition

SetName sets the Name field's value.

func (*TimerDefinition) SetSeconds Uses

func (s *TimerDefinition) SetSeconds(v int64) *TimerDefinition

SetSeconds sets the Seconds field's value.

func (TimerDefinition) String Uses

func (s TimerDefinition) String() string

String returns the string representation

func (*TimerDefinition) Validate Uses

func (s *TimerDefinition) Validate() error

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

type UpdateDetectorRequest Uses

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) GoString Uses

func (s UpdateDetectorRequest) GoString() string

GoString returns the string representation

func (*UpdateDetectorRequest) SetDetectorModelName Uses

func (s *UpdateDetectorRequest) SetDetectorModelName(v string) *UpdateDetectorRequest

SetDetectorModelName sets the DetectorModelName field's value.

func (*UpdateDetectorRequest) SetKeyValue Uses

func (s *UpdateDetectorRequest) SetKeyValue(v string) *UpdateDetectorRequest

SetKeyValue sets the KeyValue field's value.

func (*UpdateDetectorRequest) SetMessageId Uses

func (s *UpdateDetectorRequest) SetMessageId(v string) *UpdateDetectorRequest

SetMessageId sets the MessageId field's value.

func (*UpdateDetectorRequest) SetState Uses

func (s *UpdateDetectorRequest) SetState(v *DetectorStateDefinition) *UpdateDetectorRequest

SetState sets the State field's value.

func (UpdateDetectorRequest) String Uses

func (s UpdateDetectorRequest) String() string

String returns the string representation

func (*UpdateDetectorRequest) Validate Uses

func (s *UpdateDetectorRequest) Validate() error

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

type Variable Uses

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) GoString Uses

func (s Variable) GoString() string

GoString returns the string representation

func (*Variable) SetName Uses

func (s *Variable) SetName(v string) *Variable

SetName sets the Name field's value.

func (*Variable) SetValue Uses

func (s *Variable) SetValue(v string) *Variable

SetValue sets the Value field's value.

func (Variable) String Uses

func (s Variable) String() string

String returns the string representation

type VariableDefinition Uses

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) GoString Uses

func (s VariableDefinition) GoString() string

GoString returns the string representation

func (*VariableDefinition) SetName Uses

func (s *VariableDefinition) SetName(v string) *VariableDefinition

SetName sets the Name field's value.

func (*VariableDefinition) SetValue Uses

func (s *VariableDefinition) SetValue(v string) *VariableDefinition

SetValue sets the Value field's value.

func (VariableDefinition) String Uses

func (s VariableDefinition) String() string

String returns the string representation

func (*VariableDefinition) Validate Uses

func (s *VariableDefinition) Validate() error

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

Directories

PathSynopsis
ioteventsdataifacePackage ioteventsdataiface provides an interface to enable mocking the AWS IoT Events Data service client for testing your code.

Package ioteventsdata imports 9 packages (graph) and is imported by 6 packages. Updated 2019-06-22. Refresh now. Tools for package owners.