Documentation

Overview

    Package ioteventsdata provides the API client, operations, and parameter types for 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.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2018-10-23"
    View Source
    const ServiceID = "IoT Events Data"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type BatchPutMessageInput

          type BatchPutMessageInput struct {
          
          	// The list of messages to send. Each message has the following format: '{
          	// "messageId": "string", "inputName": "string", "payload": "string"}'
          	//
          	// This member is required.
          	Messages []types.Message
          }

          type BatchPutMessageOutput

          type BatchPutMessageOutput struct {
          
          	// A list of any errors encountered when sending the messages.
          	BatchPutMessageErrorEntries []types.BatchPutMessageErrorEntry
          
          	// Metadata pertaining to the operation's result.
          	ResultMetadata middleware.Metadata
          }

          type BatchUpdateDetectorInput

          type BatchUpdateDetectorInput struct {
          
          	// The list of detectors (instances) to update, along with the values to update.
          	//
          	// This member is required.
          	Detectors []types.UpdateDetectorRequest
          }

          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 []types.BatchUpdateDetectorErrorEntry
          
          	// Metadata pertaining to the operation's result.
          	ResultMetadata middleware.Metadata
          }

          type Client

          type Client struct {
          	// contains filtered or unexported fields
          }

            Client provides the API client to make operations call for AWS IoT Events Data.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) BatchPutMessage

                func (c *Client) BatchPutMessage(ctx context.Context, params *BatchPutMessageInput, optFns ...func(*Options)) (*BatchPutMessageOutput, error)

                  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.

                  func (*Client) BatchUpdateDetector

                  func (c *Client) BatchUpdateDetector(ctx context.Context, params *BatchUpdateDetectorInput, optFns ...func(*Options)) (*BatchUpdateDetectorOutput, error)

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

                    func (*Client) DescribeDetector

                    func (c *Client) DescribeDetector(ctx context.Context, params *DescribeDetectorInput, optFns ...func(*Options)) (*DescribeDetectorOutput, error)

                      Returns information about the specified detector (instance).

                      func (*Client) ListDetectors

                      func (c *Client) ListDetectors(ctx context.Context, params *ListDetectorsInput, optFns ...func(*Options)) (*ListDetectorsOutput, error)

                        Lists detectors (the instances of a detector model).

                        type DescribeDetectorInput

                        type DescribeDetectorInput struct {
                        
                        	// The name of the detector model whose detectors (instances) you want information
                        	// about.
                        	//
                        	// This member is required.
                        	DetectorModelName *string
                        
                        	// A filter used to limit results to detectors (instances) created because of the
                        	// given key ID.
                        	KeyValue *string
                        }

                        type DescribeDetectorOutput

                        type DescribeDetectorOutput struct {
                        
                        	// Information about the detector (instance).
                        	Detector *types.Detector
                        
                        	// Metadata pertaining to the operation's result.
                        	ResultMetadata middleware.Metadata
                        }

                        type EndpointResolver

                        type EndpointResolver interface {
                        	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                        }

                          EndpointResolver interface for resolving service endpoints.

                          func EndpointResolverFromURL

                          func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                            EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                            type EndpointResolverFunc

                            type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                              EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                              func (EndpointResolverFunc) ResolveEndpoint

                              func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                              type EndpointResolverOptions

                              type EndpointResolverOptions = internalendpoints.Options

                                EndpointResolverOptions is the service endpoint resolver options

                                type HTTPClient

                                type HTTPClient interface {
                                	Do(*http.Request) (*http.Response, error)
                                }

                                type HTTPSignerV4

                                type HTTPSignerV4 interface {
                                	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                }

                                type ListDetectorsInput

                                type ListDetectorsInput struct {
                                
                                	// The name of the detector model whose detectors (instances) are listed.
                                	//
                                	// This member is required.
                                	DetectorModelName *string
                                
                                	// The maximum number of results to return at one time.
                                	MaxResults *int32
                                
                                	// The token for the next set of results.
                                	NextToken *string
                                
                                	// A filter that limits results to those detectors (instances) in the given state.
                                	StateName *string
                                }

                                type ListDetectorsOutput

                                type ListDetectorsOutput struct {
                                
                                	// A list of summary information about the detectors (instances).
                                	DetectorSummaries []types.DetectorSummary
                                
                                	// A token to retrieve the next set of results, or null if there are no additional
                                	// results.
                                	NextToken *string
                                
                                	// Metadata pertaining to the operation's result.
                                	ResultMetadata middleware.Metadata
                                }

                                type Options

                                type Options struct {
                                	// Set of options to modify how an operation is invoked. These apply to all
                                	// operations invoked for this client. Use functional options on operation call to
                                	// modify this list for per operation behavior.
                                	APIOptions []func(*middleware.Stack) error
                                
                                	// Configures the events that will be sent to the configured logger.
                                	ClientLogMode aws.ClientLogMode
                                
                                	// The credentials object to use when signing requests.
                                	Credentials aws.CredentialsProvider
                                
                                	// The endpoint options to be used when attempting to resolve an endpoint.
                                	EndpointOptions EndpointResolverOptions
                                
                                	// The service endpoint resolver.
                                	EndpointResolver EndpointResolver
                                
                                	// Signature Version 4 (SigV4) Signer
                                	HTTPSignerV4 HTTPSignerV4
                                
                                	// The logger writer interface to write logging messages to.
                                	Logger logging.Logger
                                
                                	// The region to send requests to. (Required)
                                	Region string
                                
                                	// Retryer guides how HTTP requests should be retried in case of recoverable
                                	// failures. When nil the API client will use a default retryer.
                                	Retryer aws.Retryer
                                
                                	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                	// implementation if nil.
                                	HTTPClient HTTPClient
                                }

                                func (Options) Copy

                                func (o Options) Copy() Options

                                  Copy creates a clone where the APIOptions list is deep copied.

                                  type ResolveEndpoint

                                  type ResolveEndpoint struct {
                                  	Resolver EndpointResolver
                                  	Options  EndpointResolverOptions
                                  }

                                  func (*ResolveEndpoint) HandleSerialize

                                  func (*ResolveEndpoint) ID

                                  func (*ResolveEndpoint) ID() string

                                  Directories

                                  Path Synopsis
                                  internal