iotevents

package
v0.20.0 Latest Latest
Warning

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

 Go to latest Published: Mar 17, 2020 License: Apache-2.0 Imports: 9 Imported by: 7

Documentation

Overview

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

AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events API commands to create, read, update, and delete inputs and detector models, and to list their versions.

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

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

Using the Client

To use AWS IoT Events 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 client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iotevents/#New

Index

Constants

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

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

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

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// A limit was exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// The resource already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The resource is in use.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// 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"

	// ErrCodeUnsupportedOperationException for service response error code
	// "UnsupportedOperationException".
	//
	// The requested operation is not supported.
	ErrCodeUnsupportedOperationException = "UnsupportedOperationException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Action 

type Action struct {

	// Information needed to clear the timer.
	ClearTimer *ClearTimerAction `locationName:"clearTimer" type:"structure"`

	// Sends information about the detector model instance and the event that triggered
	// the action to an Amazon Kinesis Data Firehose delivery stream.
	Firehose *FirehoseAction `locationName:"firehose" type:"structure"`

	// Sends an AWS IoT Events input, passing in information about the detector
	// model instance and the event that triggered the action.
	IotEvents *IotEventsAction `locationName:"iotEvents" type:"structure"`

	// Publishes an MQTT message with the given topic to the AWS IoT message broker.
	IotTopicPublish *IotTopicPublishAction `locationName:"iotTopicPublish" type:"structure"`

	// Calls a Lambda function, passing in information about the detector model
	// instance and the event that triggered the action.
	Lambda *LambdaAction `locationName:"lambda" type:"structure"`

	// Information needed to reset the timer.
	ResetTimer *ResetTimerAction `locationName:"resetTimer" type:"structure"`

	// Information needed to set the timer.
	SetTimer *SetTimerAction `locationName:"setTimer" type:"structure"`

	// Sets a variable to a specified value.
	SetVariable *SetVariableAction `locationName:"setVariable" type:"structure"`

	// Sends an Amazon SNS message.
	Sns *SNSTopicPublishAction `locationName:"sns" type:"structure"`

	// Sends information about the detector model instance and the event that triggered
	// the action to an Amazon SQS queue.
	Sqs *SqsAction `locationName:"sqs" type:"structure"`
	// contains filtered or unexported fields
}

An action to be performed when the condition is TRUE.

func (Action) MarshalFields 

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

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

func (Action) String 

func (s Action) String() string

String returns the string representation

func (*Action) Validate 

func (s *Action) Validate() error

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

type Attribute 

type Attribute struct {

	// An expression that specifies an attribute-value pair in a JSON structure.
	// Use this to specify an attribute from the JSON payload that is made available
	// by the input. Inputs are derived from messages sent to AWS IoT Events (BatchPutMessage).
	// Each such message contains a JSON payload. The attribute (and its paired
	// value) specified here are available for use in the condition expressions
	// used by detectors.
	//
	// Syntax: <field-name>.<field-name>...
	//
	// JsonPath is a required field
	JsonPath *string `locationName:"jsonPath" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload. Those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors.

func (Attribute) MarshalFields 

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

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

func (Attribute) String 

func (s Attribute) String() string

String returns the string representation

func (*Attribute) Validate 

func (s *Attribute) Validate() error

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

type ClearTimerAction 

type ClearTimerAction struct {

	// The name of the timer to clear.
	//
	// TimerName is a required field
	TimerName *string `locationName:"timerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information needed to clear the timer.

func (ClearTimerAction) MarshalFields 

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

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

func (ClearTimerAction) String 

func (s ClearTimerAction) String() string

String returns the string representation

func (*ClearTimerAction) Validate 

func (s *ClearTimerAction) Validate() error

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

type Client 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to AWS IoT Events. 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 := iotevents.New(myConfig)

func (*Client) CreateDetectorModelRequest 

func (c *Client) CreateDetectorModelRequest(input *CreateDetectorModelInput) CreateDetectorModelRequest

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

Creates a detector model. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/CreateDetectorModel

func (*Client) CreateInputRequest 

func (c *Client) CreateInputRequest(input *CreateInputInput) CreateInputRequest

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

Creates an input. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/CreateInput

func (*Client) DeleteDetectorModelRequest 

func (c *Client) DeleteDetectorModelRequest(input *DeleteDetectorModelInput) DeleteDetectorModelRequest

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

Deletes a detector model. Any active instances of the detector model are also deleted. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/DeleteDetectorModel

func (*Client) DeleteInputRequest 

func (c *Client) DeleteInputRequest(input *DeleteInputInput) DeleteInputRequest

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

Deletes an input. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/DeleteInput

func (*Client) DescribeDetectorModelRequest 

func (c *Client) DescribeDetectorModelRequest(input *DescribeDetectorModelInput) DescribeDetectorModelRequest

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

Describes a detector model. If the version parameter is not specified, information about the latest version is returned. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/DescribeDetectorModel

func (*Client) DescribeInputRequest 

func (c *Client) DescribeInputRequest(input *DescribeInputInput) DescribeInputRequest

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

Describes an input. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/DescribeInput

func (*Client) DescribeLoggingOptionsRequest 

func (c *Client) DescribeLoggingOptionsRequest(input *DescribeLoggingOptionsInput) DescribeLoggingOptionsRequest

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

Retrieves the current settings of the AWS IoT Events logging options. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/DescribeLoggingOptions

func (*Client) ListDetectorModelVersionsRequest 

func (c *Client) ListDetectorModelVersionsRequest(input *ListDetectorModelVersionsInput) ListDetectorModelVersionsRequest

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

Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/ListDetectorModelVersions

func (*Client) ListDetectorModelsRequest 

func (c *Client) ListDetectorModelsRequest(input *ListDetectorModelsInput) ListDetectorModelsRequest

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

Lists the detector models you have created. Only the metadata associated with each detector model is returned. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/ListDetectorModels

func (*Client) ListInputsRequest 

func (c *Client) ListInputsRequest(input *ListInputsInput) ListInputsRequest

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

Lists the inputs you have created. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/ListInputs

func (*Client) ListTagsForResourceRequest 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

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

Lists the tags (metadata) you have assigned to the resource. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/ListTagsForResource

func (*Client) PutLoggingOptionsRequest 

func (c *Client) PutLoggingOptionsRequest(input *PutLoggingOptionsInput) PutLoggingOptionsRequest

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

Sets or updates the AWS IoT Events logging options.

If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. If you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/PutLoggingOptions

func (*Client) TagResourceRequest 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

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

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/TagResource

func (*Client) UntagResourceRequest 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

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

Removes the given tags (metadata) from the resource. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/UntagResource

func (*Client) UpdateDetectorModelRequest 

func (c *Client) UpdateDetectorModelRequest(input *UpdateDetectorModelInput) UpdateDetectorModelRequest

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

Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/UpdateDetectorModel

func (*Client) UpdateInputRequest 

func (c *Client) UpdateInputRequest(input *UpdateInputInput) UpdateInputRequest

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

Updates an input. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/UpdateInput

type CreateDetectorModelInput 

type CreateDetectorModelInput struct {

	// Information that defines how the detectors operate.
	//
	// DetectorModelDefinition is a required field
	DetectorModelDefinition *DetectorModelDefinition `locationName:"detectorModelDefinition" type:"structure" required:"true"`

	// A brief description of the detector model.
	DetectorModelDescription *string `locationName:"detectorModelDescription" type:"string"`

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

	// Information about the order in which events are evaluated and how actions
	// are executed.
	EvaluationMethod EvaluationMethod `locationName:"evaluationMethod" type:"string" enum:"true"`

	// The input attribute key used to identify a device or system to create a detector
	// (an instance of the detector model) and then to route each input received
	// to the appropriate detector (instance). This parameter uses a JSON-path expression
	// in the message payload of each input to specify the attribute-value pair
	// that is used to identify the device associated with the input.
	Key *string `locationName:"key" min:"1" type:"string"`

	// The ARN of the role that grants permission to AWS IoT Events to perform its
	// operations.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"`

	// Metadata that can be used to manage the detector model.
	Tags []Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDetectorModelInput) MarshalFields 

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

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

func (CreateDetectorModelInput) String 

func (s CreateDetectorModelInput) String() string

String returns the string representation

func (*CreateDetectorModelInput) Validate 

func (s *CreateDetectorModelInput) Validate() error

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

type CreateDetectorModelOutput 

type CreateDetectorModelOutput struct {

	// Information about how the detector model is configured.
	DetectorModelConfiguration *DetectorModelConfiguration `locationName:"detectorModelConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDetectorModelOutput) MarshalFields 

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

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

func (CreateDetectorModelOutput) String 

func (s CreateDetectorModelOutput) String() string

String returns the string representation

type CreateDetectorModelRequest 

type CreateDetectorModelRequest struct {
	*aws.Request
	Input *CreateDetectorModelInput
	Copy  func(*CreateDetectorModelInput) CreateDetectorModelRequest
}

CreateDetectorModelRequest is the request type for the CreateDetectorModel API operation.

func (CreateDetectorModelRequest) Send 

func (r CreateDetectorModelRequest) Send(ctx context.Context) (*CreateDetectorModelResponse, error)

Send marshals and sends the CreateDetectorModel API request.

type CreateDetectorModelResponse 

type CreateDetectorModelResponse struct {
	*CreateDetectorModelOutput
	// contains filtered or unexported fields
}

CreateDetectorModelResponse is the response type for the CreateDetectorModel API operation.

func (*CreateDetectorModelResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the CreateDetectorModel request.

type CreateInputInput 

type CreateInputInput struct {

	// The definition of the input.
	//
	// InputDefinition is a required field
	InputDefinition *InputDefinition `locationName:"inputDefinition" type:"structure" required:"true"`

	// A brief description of the input.
	InputDescription *string `locationName:"inputDescription" type:"string"`

	// The name you want to give to the input.
	//
	// InputName is a required field
	InputName *string `locationName:"inputName" min:"1" type:"string" required:"true"`

	// Metadata that can be used to manage the input.
	Tags []Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateInputInput) MarshalFields 

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

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

func (CreateInputInput) String 

func (s CreateInputInput) String() string

String returns the string representation

func (*CreateInputInput) Validate 

func (s *CreateInputInput) Validate() error

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

type CreateInputOutput 

type CreateInputOutput struct {

	// Information about the configuration of the input.
	InputConfiguration *InputConfiguration `locationName:"inputConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateInputOutput) MarshalFields 

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

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

func (CreateInputOutput) String 

func (s CreateInputOutput) String() string

String returns the string representation

type CreateInputRequest 

type CreateInputRequest struct {
	*aws.Request
	Input *CreateInputInput
	Copy  func(*CreateInputInput) CreateInputRequest
}

CreateInputRequest is the request type for the CreateInput API operation.

func (CreateInputRequest) Send 

func (r CreateInputRequest) Send(ctx context.Context) (*CreateInputResponse, error)

Send marshals and sends the CreateInput API request.

type CreateInputResponse 

type CreateInputResponse struct {
	*CreateInputOutput
	// contains filtered or unexported fields
}

CreateInputResponse is the response type for the CreateInput API operation.

func (*CreateInputResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the CreateInput request.

type DeleteDetectorModelInput 

type DeleteDetectorModelInput struct {

	// The name of the detector model to be deleted.
	//
	// DetectorModelName is a required field
	DetectorModelName *string `location:"uri" locationName:"detectorModelName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDetectorModelInput) MarshalFields 

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

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

func (DeleteDetectorModelInput) String 

func (s DeleteDetectorModelInput) String() string

String returns the string representation

func (*DeleteDetectorModelInput) Validate 

func (s *DeleteDetectorModelInput) Validate() error

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

type DeleteDetectorModelOutput 

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

func (DeleteDetectorModelOutput) MarshalFields 

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

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

func (DeleteDetectorModelOutput) String 

func (s DeleteDetectorModelOutput) String() string

String returns the string representation

type DeleteDetectorModelRequest 

type DeleteDetectorModelRequest struct {
	*aws.Request
	Input *DeleteDetectorModelInput
	Copy  func(*DeleteDetectorModelInput) DeleteDetectorModelRequest
}

DeleteDetectorModelRequest is the request type for the DeleteDetectorModel API operation.

func (DeleteDetectorModelRequest) Send 

func (r DeleteDetectorModelRequest) Send(ctx context.Context) (*DeleteDetectorModelResponse, error)

Send marshals and sends the DeleteDetectorModel API request.

type DeleteDetectorModelResponse 

type DeleteDetectorModelResponse struct {
	*DeleteDetectorModelOutput
	// contains filtered or unexported fields
}

DeleteDetectorModelResponse is the response type for the DeleteDetectorModel API operation.

func (*DeleteDetectorModelResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the DeleteDetectorModel request.

type DeleteInputInput 

type DeleteInputInput struct {

	// The name of the input to delete.
	//
	// InputName is a required field
	InputName *string `location:"uri" locationName:"inputName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteInputInput) MarshalFields 

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

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

func (DeleteInputInput) String 

func (s DeleteInputInput) String() string

String returns the string representation

func (*DeleteInputInput) Validate 

func (s *DeleteInputInput) Validate() error

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

type DeleteInputOutput 

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

func (DeleteInputOutput) MarshalFields 

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

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

func (DeleteInputOutput) String 

func (s DeleteInputOutput) String() string

String returns the string representation

type DeleteInputRequest 

type DeleteInputRequest struct {
	*aws.Request
	Input *DeleteInputInput
	Copy  func(*DeleteInputInput) DeleteInputRequest
}

DeleteInputRequest is the request type for the DeleteInput API operation.

func (DeleteInputRequest) Send 

func (r DeleteInputRequest) Send(ctx context.Context) (*DeleteInputResponse, error)

Send marshals and sends the DeleteInput API request.

type DeleteInputResponse 

type DeleteInputResponse struct {
	*DeleteInputOutput
	// contains filtered or unexported fields
}

DeleteInputResponse is the response type for the DeleteInput API operation.

func (*DeleteInputResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the DeleteInput request.

type DescribeDetectorModelInput 

type DescribeDetectorModelInput struct {

	// The name of the detector model.
	//
	// DetectorModelName is a required field
	DetectorModelName *string `location:"uri" locationName:"detectorModelName" min:"1" type:"string" required:"true"`

	// The version of the detector model.
	DetectorModelVersion *string `location:"querystring" locationName:"version" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDetectorModelInput) MarshalFields 

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

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

func (DescribeDetectorModelInput) String 

func (s DescribeDetectorModelInput) String() string

String returns the string representation

func (*DescribeDetectorModelInput) Validate 

func (s *DescribeDetectorModelInput) Validate() error

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

type DescribeDetectorModelOutput 

type DescribeDetectorModelOutput struct {

	// Information about the detector model.
	DetectorModel *DetectorModel `locationName:"detectorModel" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDetectorModelOutput) MarshalFields 

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

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

func (DescribeDetectorModelOutput) String 

func (s DescribeDetectorModelOutput) String() string

String returns the string representation

type DescribeDetectorModelRequest 

type DescribeDetectorModelRequest struct {
	*aws.Request
	Input *DescribeDetectorModelInput
	Copy  func(*DescribeDetectorModelInput) DescribeDetectorModelRequest
}

DescribeDetectorModelRequest is the request type for the DescribeDetectorModel API operation.

func (DescribeDetectorModelRequest) Send 

func (r DescribeDetectorModelRequest) Send(ctx context.Context) (*DescribeDetectorModelResponse, error)

Send marshals and sends the DescribeDetectorModel API request.

type DescribeDetectorModelResponse 

type DescribeDetectorModelResponse struct {
	*DescribeDetectorModelOutput
	// contains filtered or unexported fields
}

DescribeDetectorModelResponse is the response type for the DescribeDetectorModel API operation.

func (*DescribeDetectorModelResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the DescribeDetectorModel request.

type DescribeInputInput 

type DescribeInputInput struct {

	// The name of the input.
	//
	// InputName is a required field
	InputName *string `location:"uri" locationName:"inputName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeInputInput) MarshalFields 

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

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

func (DescribeInputInput) String 

func (s DescribeInputInput) String() string

String returns the string representation

func (*DescribeInputInput) Validate 

func (s *DescribeInputInput) Validate() error

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

type DescribeInputOutput 

type DescribeInputOutput struct {

	// Information about the input.
	Input *Input `locationName:"input" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeInputOutput) MarshalFields 

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

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

func (DescribeInputOutput) String 

func (s DescribeInputOutput) String() string

String returns the string representation

type DescribeInputRequest 

type DescribeInputRequest struct {
	*aws.Request
	Input *DescribeInputInput
	Copy  func(*DescribeInputInput) DescribeInputRequest
}

DescribeInputRequest is the request type for the DescribeInput API operation.

func (DescribeInputRequest) Send 

func (r DescribeInputRequest) Send(ctx context.Context) (*DescribeInputResponse, error)

Send marshals and sends the DescribeInput API request.

type DescribeInputResponse 

type DescribeInputResponse struct {
	*DescribeInputOutput
	// contains filtered or unexported fields
}

DescribeInputResponse is the response type for the DescribeInput API operation.

func (*DescribeInputResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the DescribeInput request.

type DescribeLoggingOptionsInput 

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

func (DescribeLoggingOptionsInput) MarshalFields 

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

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

func (DescribeLoggingOptionsInput) String 

func (s DescribeLoggingOptionsInput) String() string

String returns the string representation

type DescribeLoggingOptionsOutput 

type DescribeLoggingOptionsOutput struct {

	// The current settings of the AWS IoT Events logging options.
	LoggingOptions *LoggingOptions `locationName:"loggingOptions" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeLoggingOptionsOutput) MarshalFields 

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

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

func (DescribeLoggingOptionsOutput) String 

func (s DescribeLoggingOptionsOutput) String() string

String returns the string representation

type DescribeLoggingOptionsRequest 

type DescribeLoggingOptionsRequest struct {
	*aws.Request
	Input *DescribeLoggingOptionsInput
	Copy  func(*DescribeLoggingOptionsInput) DescribeLoggingOptionsRequest
}

DescribeLoggingOptionsRequest is the request type for the DescribeLoggingOptions API operation.

func (DescribeLoggingOptionsRequest) Send 

func (r DescribeLoggingOptionsRequest) Send(ctx context.Context) (*DescribeLoggingOptionsResponse, error)

Send marshals and sends the DescribeLoggingOptions API request.

type DescribeLoggingOptionsResponse 

type DescribeLoggingOptionsResponse struct {
	*DescribeLoggingOptionsOutput
	// contains filtered or unexported fields
}

DescribeLoggingOptionsResponse is the response type for the DescribeLoggingOptions API operation.

func (*DescribeLoggingOptionsResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the DescribeLoggingOptions request.

type DetectorDebugOption 

type DetectorDebugOption struct {

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

	// The value of the input attribute key used to create the detector (the instance
	// of the detector model).
	KeyValue *string `locationName:"keyValue" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The detector model and the specific detectors (instances) for which the logging level is given.

func (DetectorDebugOption) MarshalFields 

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

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

func (DetectorDebugOption) String 

func (s DetectorDebugOption) String() string

String returns the string representation

func (*DetectorDebugOption) Validate 

func (s *DetectorDebugOption) Validate() error

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

type DetectorModel 

type DetectorModel struct {

	// Information about how the detector is configured.
	DetectorModelConfiguration *DetectorModelConfiguration `locationName:"detectorModelConfiguration" type:"structure"`

	// Information that defines how a detector operates.
	DetectorModelDefinition *DetectorModelDefinition `locationName:"detectorModelDefinition" type:"structure"`
	// contains filtered or unexported fields
}

Information about the detector model.

func (DetectorModel) MarshalFields 

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

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

func (DetectorModel) String 

func (s DetectorModel) String() string

String returns the string representation

type DetectorModelConfiguration 

type DetectorModelConfiguration struct {

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

	// The ARN of the detector model.
	DetectorModelArn *string `locationName:"detectorModelArn" type:"string"`

	// A brief description of the detector model.
	DetectorModelDescription *string `locationName:"detectorModelDescription" type:"string"`

	// The name of the detector model.
	DetectorModelName *string `locationName:"detectorModelName" min:"1" type:"string"`

	// The version of the detector model.
	DetectorModelVersion *string `locationName:"detectorModelVersion" min:"1" type:"string"`

	// Information about the order in which events are evaluated and how actions
	// are executed.
	EvaluationMethod EvaluationMethod `locationName:"evaluationMethod" type:"string" enum:"true"`

	// The input attribute key used to identify a device or system to create a detector
	// (an instance of the detector model) and then to route each input received
	// to the appropriate detector (instance). This parameter uses a JSON-path expression
	// in the message payload of each input to specify the attribute-value pair
	// that is used to identify the device associated with the input.
	Key *string `locationName:"key" min:"1" type:"string"`

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

	// The ARN of the role that grants permission to AWS IoT Events to perform its
	// operations.
	RoleArn *string `locationName:"roleArn" min:"1" type:"string"`

	// The status of the detector model.
	Status DetectorModelVersionStatus `locationName:"status" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Information about how the detector model is configured.

func (DetectorModelConfiguration) MarshalFields 

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

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

func (DetectorModelConfiguration) String 

func (s DetectorModelConfiguration) String() string

String returns the string representation

type DetectorModelDefinition 

type DetectorModelDefinition struct {

	// The state that is entered at the creation of each detector (instance).
	//
	// InitialStateName is a required field
	InitialStateName *string `locationName:"initialStateName" min:"1" type:"string" required:"true"`

	// Information about the states of the detector.
	//
	// States is a required field
	States []State `locationName:"states" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Information that defines how a detector operates.

func (DetectorModelDefinition) MarshalFields 

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

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

func (DetectorModelDefinition) String 

func (s DetectorModelDefinition) String() string

String returns the string representation

func (*DetectorModelDefinition) Validate 

func (s *DetectorModelDefinition) Validate() error

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

type DetectorModelSummary 

type DetectorModelSummary struct {

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

	// A brief description of the detector model.
	DetectorModelDescription *string `locationName:"detectorModelDescription" type:"string"`

	// The name of the detector model.
	DetectorModelName *string `locationName:"detectorModelName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information about the detector model.

func (DetectorModelSummary) MarshalFields 

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

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

func (DetectorModelSummary) String 

func (s DetectorModelSummary) String() string

String returns the string representation

type DetectorModelVersionStatus 

type DetectorModelVersionStatus string
const (
	DetectorModelVersionStatusActive     DetectorModelVersionStatus = "ACTIVE"
	DetectorModelVersionStatusActivating DetectorModelVersionStatus = "ACTIVATING"
	DetectorModelVersionStatusInactive   DetectorModelVersionStatus = "INACTIVE"
	DetectorModelVersionStatusDeprecated DetectorModelVersionStatus = "DEPRECATED"
	DetectorModelVersionStatusDraft      DetectorModelVersionStatus = "DRAFT"
	DetectorModelVersionStatusPaused     DetectorModelVersionStatus = "PAUSED"
	DetectorModelVersionStatusFailed     DetectorModelVersionStatus = "FAILED"
)

Enum values for DetectorModelVersionStatus

func (DetectorModelVersionStatus) MarshalValue 

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

func (DetectorModelVersionStatus) MarshalValueBuf 

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

type DetectorModelVersionSummary 

type DetectorModelVersionSummary struct {

	// The time the detector model version was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The ARN of the detector model version.
	DetectorModelArn *string `locationName:"detectorModelArn" type:"string"`

	// The name of the detector model.
	DetectorModelName *string `locationName:"detectorModelName" min:"1" type:"string"`

	// The ID of the detector model version.
	DetectorModelVersion *string `locationName:"detectorModelVersion" min:"1" type:"string"`

	// Information about the order in which events are evaluated and how actions
	// are executed.
	EvaluationMethod EvaluationMethod `locationName:"evaluationMethod" type:"string" enum:"true"`

	// The last time the detector model version was updated.
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`

	// The ARN of the role that grants the detector model permission to perform
	// its tasks.
	RoleArn *string `locationName:"roleArn" min:"1" type:"string"`

	// The status of the detector model version.
	Status DetectorModelVersionStatus `locationName:"status" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Information about the detector model version.

func (DetectorModelVersionSummary) MarshalFields 

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

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

func (DetectorModelVersionSummary) String 

func (s DetectorModelVersionSummary) String() string

String returns the string representation

type EvaluationMethod added in v0.16.0 

type EvaluationMethod string
const (
	EvaluationMethodBatch  EvaluationMethod = "BATCH"
	EvaluationMethodSerial EvaluationMethod = "SERIAL"
)

Enum values for EvaluationMethod

func (EvaluationMethod) MarshalValue added in v0.16.0 

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

func (EvaluationMethod) MarshalValueBuf added in v0.16.0 

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

type Event 

type Event struct {

	// The actions to be performed.
	Actions []Action `locationName:"actions" type:"list"`

	// Optional. The Boolean expression that, when TRUE, causes the actions to be
	// performed. If not present, the actions are performed (=TRUE). If the expression
	// result is not a Boolean value, the actions are not performed (=FALSE).
	Condition *string `locationName:"condition" type:"string"`

	// The name of the event.
	//
	// EventName is a required field
	EventName *string `locationName:"eventName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies the actions to be performed when the condition evaluates to TRUE.

func (Event) MarshalFields 

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

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

func (Event) String 

func (s Event) String() string

String returns the string representation

func (*Event) Validate 

func (s *Event) Validate() error

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

type FirehoseAction 

type FirehoseAction struct {

	// The name of the Kinesis Data Firehose delivery stream where the data is written.
	//
	// DeliveryStreamName is a required field
	DeliveryStreamName *string `locationName:"deliveryStreamName" type:"string" required:"true"`

	// A character separator that is used to separate records written to the Kinesis
	// Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab),
	// '\r\n' (Windows newline), ',' (comma).
	Separator *string `locationName:"separator" type:"string"`
	// contains filtered or unexported fields
}

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

func (FirehoseAction) MarshalFields 

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

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

func (FirehoseAction) String 

func (s FirehoseAction) String() string

String returns the string representation

func (*FirehoseAction) Validate 

func (s *FirehoseAction) Validate() error

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

type Input 

type Input struct {

	// Information about the configuration of an input.
	InputConfiguration *InputConfiguration `locationName:"inputConfiguration" type:"structure"`

	// The definition of the input.
	InputDefinition *InputDefinition `locationName:"inputDefinition" type:"structure"`
	// contains filtered or unexported fields
}

Information about the input.

func (Input) MarshalFields 

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

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

func (Input) String 

func (s Input) String() string

String returns the string representation

type InputConfiguration 

type InputConfiguration struct {

	// The time the input was created.
	//
	// CreationTime is a required field
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp" required:"true"`

	// The ARN of the input.
	//
	// InputArn is a required field
	InputArn *string `locationName:"inputArn" type:"string" required:"true"`

	// A brief description of the input.
	InputDescription *string `locationName:"inputDescription" type:"string"`

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

	// The last time the input was updated.
	//
	// LastUpdateTime is a required field
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp" required:"true"`

	// The status of the input.
	//
	// Status is a required field
	Status InputStatus `locationName:"status" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Information about the configuration of an input.

func (InputConfiguration) MarshalFields 

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

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

func (InputConfiguration) String 

func (s InputConfiguration) String() string

String returns the string representation

type InputDefinition 

type InputDefinition struct {

	// The attributes from the JSON payload that are made available by the input.
	// Inputs are derived from messages sent to the AWS IoT Events system using
	// BatchPutMessage. Each such message contains a JSON payload, and those attributes
	// (and their paired values) specified here are available for use in the condition
	// expressions used by detectors that monitor this input.
	//
	// Attributes is a required field
	Attributes []Attribute `locationName:"attributes" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The definition of the input.

func (InputDefinition) MarshalFields 

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

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

func (InputDefinition) String 

func (s InputDefinition) String() string

String returns the string representation

func (*InputDefinition) Validate 

func (s *InputDefinition) Validate() error

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

type InputStatus 

type InputStatus string
const (
	InputStatusCreating InputStatus = "CREATING"
	InputStatusUpdating InputStatus = "UPDATING"
	InputStatusActive   InputStatus = "ACTIVE"
	InputStatusDeleting InputStatus = "DELETING"
)

Enum values for InputStatus

func (InputStatus) MarshalValue 

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

func (InputStatus) MarshalValueBuf 

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

type InputSummary 

type InputSummary struct {

	// The time the input was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The ARN of the input.
	InputArn *string `locationName:"inputArn" type:"string"`

	// A brief description of the input.
	InputDescription *string `locationName:"inputDescription" type:"string"`

	// The name of the input.
	InputName *string `locationName:"inputName" min:"1" type:"string"`

	// The last time the input was updated.
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`

	// The status of the input.
	Status InputStatus `locationName:"status" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Information about the input.

func (InputSummary) MarshalFields 

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

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

func (InputSummary) String 

func (s InputSummary) String() string

String returns the string representation

type IotEventsAction 

type IotEventsAction struct {

	// The name of the AWS IoT Events input where the data is sent.
	//
	// InputName is a required field
	InputName *string `locationName:"inputName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.

func (IotEventsAction) MarshalFields 

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

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

func (IotEventsAction) String 

func (s IotEventsAction) String() string

String returns the string representation

func (*IotEventsAction) Validate 

func (s *IotEventsAction) Validate() error

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

type IotTopicPublishAction 

type IotTopicPublishAction struct {

	// The MQTT topic of the message. You can use a string expression that includes
	// variables ($variable.<variable-name>) and input values ($input.<input-name>.<path-to-datum>)
	// as the topic string.
	//
	// MqttTopic is a required field
	MqttTopic *string `locationName:"mqttTopic" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information required to publish the MQTT message through the AWS IoT message broker.

func (IotTopicPublishAction) MarshalFields 

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

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

func (IotTopicPublishAction) String 

func (s IotTopicPublishAction) String() string

String returns the string representation

func (*IotTopicPublishAction) Validate 

func (s *IotTopicPublishAction) Validate() error

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

type LambdaAction 

type LambdaAction struct {

	// The ARN of the Lambda function that is executed.
	//
	// FunctionArn is a required field
	FunctionArn *string `locationName:"functionArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.

func (LambdaAction) MarshalFields 

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

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

func (LambdaAction) String 

func (s LambdaAction) String() string

String returns the string representation

func (*LambdaAction) Validate 

func (s *LambdaAction) Validate() error

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

type ListDetectorModelVersionsInput 

type ListDetectorModelVersionsInput struct {

	// The name of the detector model whose versions are returned.
	//
	// 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"`
	// contains filtered or unexported fields
}

func (ListDetectorModelVersionsInput) MarshalFields 

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

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

func (ListDetectorModelVersionsInput) String 

func (s ListDetectorModelVersionsInput) String() string

String returns the string representation

func (*ListDetectorModelVersionsInput) Validate 

func (s *ListDetectorModelVersionsInput) Validate() error

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

type ListDetectorModelVersionsOutput 

type ListDetectorModelVersionsOutput struct {

	// Summary information about the detector model versions.
	DetectorModelVersionSummaries []DetectorModelVersionSummary `locationName:"detectorModelVersionSummaries" 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 (ListDetectorModelVersionsOutput) MarshalFields 

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

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

func (ListDetectorModelVersionsOutput) String 

func (s ListDetectorModelVersionsOutput) String() string

String returns the string representation

type ListDetectorModelVersionsRequest 

type ListDetectorModelVersionsRequest struct {
	*aws.Request
	Input *ListDetectorModelVersionsInput
	Copy  func(*ListDetectorModelVersionsInput) ListDetectorModelVersionsRequest
}

ListDetectorModelVersionsRequest is the request type for the ListDetectorModelVersions API operation.

func (ListDetectorModelVersionsRequest) Send 

func (r ListDetectorModelVersionsRequest) Send(ctx context.Context) (*ListDetectorModelVersionsResponse, error)

Send marshals and sends the ListDetectorModelVersions API request.

type ListDetectorModelVersionsResponse 

type ListDetectorModelVersionsResponse struct {
	*ListDetectorModelVersionsOutput
	// contains filtered or unexported fields
}

ListDetectorModelVersionsResponse is the response type for the ListDetectorModelVersions API operation.

func (*ListDetectorModelVersionsResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the ListDetectorModelVersions request.

type ListDetectorModelsInput 

type ListDetectorModelsInput struct {

	// 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"`
	// contains filtered or unexported fields
}

func (ListDetectorModelsInput) MarshalFields 

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

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

func (ListDetectorModelsInput) String 

func (s ListDetectorModelsInput) String() string

String returns the string representation

func (*ListDetectorModelsInput) Validate 

func (s *ListDetectorModelsInput) Validate() error

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

type ListDetectorModelsOutput 

type ListDetectorModelsOutput struct {

	// Summary information about the detector models.
	DetectorModelSummaries []DetectorModelSummary `locationName:"detectorModelSummaries" 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 (ListDetectorModelsOutput) MarshalFields 

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

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

func (ListDetectorModelsOutput) String 

func (s ListDetectorModelsOutput) String() string

String returns the string representation

type ListDetectorModelsRequest 

type ListDetectorModelsRequest struct {
	*aws.Request
	Input *ListDetectorModelsInput
	Copy  func(*ListDetectorModelsInput) ListDetectorModelsRequest
}

ListDetectorModelsRequest is the request type for the ListDetectorModels API operation.

func (ListDetectorModelsRequest) Send 

func (r ListDetectorModelsRequest) Send(ctx context.Context) (*ListDetectorModelsResponse, error)

Send marshals and sends the ListDetectorModels API request.

type ListDetectorModelsResponse 

type ListDetectorModelsResponse struct {
	*ListDetectorModelsOutput
	// contains filtered or unexported fields
}

ListDetectorModelsResponse is the response type for the ListDetectorModels API operation.

func (*ListDetectorModelsResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the ListDetectorModels request.

type ListInputsInput 

type ListInputsInput struct {

	// 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"`
	// contains filtered or unexported fields
}

func (ListInputsInput) MarshalFields 

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

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

func (ListInputsInput) String 

func (s ListInputsInput) String() string

String returns the string representation

func (*ListInputsInput) Validate 

func (s *ListInputsInput) Validate() error

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

type ListInputsOutput 

type ListInputsOutput struct {

	// Summary information about the inputs.
	InputSummaries []InputSummary `locationName:"inputSummaries" 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 (ListInputsOutput) MarshalFields 

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

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

func (ListInputsOutput) String 

func (s ListInputsOutput) String() string

String returns the string representation

type ListInputsRequest 

type ListInputsRequest struct {
	*aws.Request
	Input *ListInputsInput
	Copy  func(*ListInputsInput) ListInputsRequest
}

ListInputsRequest is the request type for the ListInputs API operation.

func (ListInputsRequest) Send 

func (r ListInputsRequest) Send(ctx context.Context) (*ListInputsResponse, error)

Send marshals and sends the ListInputs API request.

type ListInputsResponse 

type ListInputsResponse struct {
	*ListInputsOutput
	// contains filtered or unexported fields
}

ListInputsResponse is the response type for the ListInputs API operation.

func (*ListInputsResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the ListInputs request.

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"querystring" locationName:"resourceArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) MarshalFields 

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

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

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The list of tags assigned to the resource.
	Tags []Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) MarshalFields 

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

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

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type LoggingLevel 

type LoggingLevel string
const (
	LoggingLevelError LoggingLevel = "ERROR"
	LoggingLevelInfo  LoggingLevel = "INFO"
	LoggingLevelDebug LoggingLevel = "DEBUG"
)

Enum values for LoggingLevel

func (LoggingLevel) MarshalValue 

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

func (LoggingLevel) MarshalValueBuf 

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

type LoggingOptions 

type LoggingOptions struct {

	// Information that identifies those detector models and their detectors (instances)
	// for which the logging level is given.
	DetectorDebugOptions []DetectorDebugOption `locationName:"detectorDebugOptions" min:"1" type:"list"`

	// If TRUE, logging is enabled for AWS IoT Events.
	//
	// Enabled is a required field
	Enabled *bool `locationName:"enabled" type:"boolean" required:"true"`

	// The logging level.
	//
	// Level is a required field
	Level LoggingLevel `locationName:"level" type:"string" required:"true" enum:"true"`

	// The ARN of the role that grants permission to AWS IoT Events to perform logging.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The values of the AWS IoT Events logging options.

func (LoggingOptions) MarshalFields 

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

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

func (LoggingOptions) String 

func (s LoggingOptions) String() string

String returns the string representation

func (*LoggingOptions) Validate 

func (s *LoggingOptions) Validate() error

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

type OnEnterLifecycle 

type OnEnterLifecycle struct {

	// Specifies the actions that are performed when the state is entered and the
	// condition is TRUE.
	Events []Event `locationName:"events" type:"list"`
	// contains filtered or unexported fields
}

When entering this state, perform these actions if the condition is TRUE.

func (OnEnterLifecycle) MarshalFields 

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

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

func (OnEnterLifecycle) String 

func (s OnEnterLifecycle) String() string

String returns the string representation

func (*OnEnterLifecycle) Validate 

func (s *OnEnterLifecycle) Validate() error

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

type OnExitLifecycle 

type OnExitLifecycle struct {

	// Specifies the actions that are performed when the state is exited and the
	// condition is TRUE.
	Events []Event `locationName:"events" type:"list"`
	// contains filtered or unexported fields
}

When exiting this state, perform these actions if the specified condition is TRUE.

func (OnExitLifecycle) MarshalFields 

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

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

func (OnExitLifecycle) String 

func (s OnExitLifecycle) String() string

String returns the string representation

func (*OnExitLifecycle) Validate 

func (s *OnExitLifecycle) Validate() error

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

type OnInputLifecycle 

type OnInputLifecycle struct {

	// Specifies the actions performed when the condition evaluates to TRUE.
	Events []Event `locationName:"events" type:"list"`

	// Specifies the actions performed, and the next state entered, when a condition
	// evaluates to TRUE.
	TransitionEvents []TransitionEvent `locationName:"transitionEvents" type:"list"`
	// contains filtered or unexported fields
}

Specifies the actions performed when the condition evaluates to TRUE.

func (OnInputLifecycle) MarshalFields 

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

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

func (OnInputLifecycle) String 

func (s OnInputLifecycle) String() string

String returns the string representation

func (*OnInputLifecycle) Validate 

func (s *OnInputLifecycle) Validate() error

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

type PutLoggingOptionsInput 

type PutLoggingOptionsInput struct {

	// The new values of the AWS IoT Events logging options.
	//
	// LoggingOptions is a required field
	LoggingOptions *LoggingOptions `locationName:"loggingOptions" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutLoggingOptionsInput) MarshalFields 

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

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

func (PutLoggingOptionsInput) String 

func (s PutLoggingOptionsInput) String() string

String returns the string representation

func (*PutLoggingOptionsInput) Validate 

func (s *PutLoggingOptionsInput) Validate() error

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

type PutLoggingOptionsOutput 

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

func (PutLoggingOptionsOutput) MarshalFields 

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

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

func (PutLoggingOptionsOutput) String 

func (s PutLoggingOptionsOutput) String() string

String returns the string representation

type PutLoggingOptionsRequest 

type PutLoggingOptionsRequest struct {
	*aws.Request
	Input *PutLoggingOptionsInput
	Copy  func(*PutLoggingOptionsInput) PutLoggingOptionsRequest
}

PutLoggingOptionsRequest is the request type for the PutLoggingOptions API operation.

func (PutLoggingOptionsRequest) Send 

func (r PutLoggingOptionsRequest) Send(ctx context.Context) (*PutLoggingOptionsResponse, error)

Send marshals and sends the PutLoggingOptions API request.

type PutLoggingOptionsResponse 

type PutLoggingOptionsResponse struct {
	*PutLoggingOptionsOutput
	// contains filtered or unexported fields
}

PutLoggingOptionsResponse is the response type for the PutLoggingOptions API operation.

func (*PutLoggingOptionsResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the PutLoggingOptions request.

type ResetTimerAction 

type ResetTimerAction struct {

	// The name of the timer to reset.
	//
	// TimerName is a required field
	TimerName *string `locationName:"timerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information required to reset the timer. The timer is reset to the previously evaluated result of the duration.

func (ResetTimerAction) MarshalFields 

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

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

func (ResetTimerAction) String 

func (s ResetTimerAction) String() string

String returns the string representation

func (*ResetTimerAction) Validate 

func (s *ResetTimerAction) Validate() error

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

type SNSTopicPublishAction 

type SNSTopicPublishAction struct {

	// The ARN of the Amazon SNS target where the message is sent.
	//
	// TargetArn is a required field
	TargetArn *string `locationName:"targetArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information required to publish the Amazon SNS message.

func (SNSTopicPublishAction) MarshalFields 

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

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

func (SNSTopicPublishAction) String 

func (s SNSTopicPublishAction) String() string

String returns the string representation

func (*SNSTopicPublishAction) Validate 

func (s *SNSTopicPublishAction) Validate() error

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

type SetTimerAction 

type SetTimerAction struct {

	// The duration of the timer, in seconds. You can use a string expression that
	// includes numbers, variables ($variable.<variable-name>), and input values
	// ($input.<input-name>.<path-to-datum>) as the duration. The range of the duration
	// is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds.
	// The evaluated result of the duration is rounded down to the nearest whole
	// number.
	DurationExpression *string `locationName:"durationExpression" min:"1" type:"string"`

	// The number of seconds until the timer expires. The minimum value is 60 seconds
	// to ensure accuracy.
	Seconds *int64 `locationName:"seconds" min:"1" deprecated:"true" type:"integer"`

	// The name of the timer.
	//
	// TimerName is a required field
	TimerName *string `locationName:"timerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information needed to set the timer.

func (SetTimerAction) MarshalFields 

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

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

func (SetTimerAction) String 

func (s SetTimerAction) String() string

String returns the string representation

func (*SetTimerAction) Validate 

func (s *SetTimerAction) Validate() error

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

type SetVariableAction 

type SetVariableAction struct {

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

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

Information about the variable and its new value.

func (SetVariableAction) MarshalFields 

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

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

func (SetVariableAction) String 

func (s SetVariableAction) String() string

String returns the string representation

func (*SetVariableAction) Validate 

func (s *SetVariableAction) Validate() error

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

type SqsAction 

type SqsAction struct {

	// The URL of the SQS queue where the data is written.
	//
	// QueueUrl is a required field
	QueueUrl *string `locationName:"queueUrl" type:"string" required:"true"`

	// Set this to TRUE if you want the data to be base-64 encoded before it is
	// written to the queue.
	UseBase64 *bool `locationName:"useBase64" type:"boolean"`
	// contains filtered or unexported fields
}

Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

func (SqsAction) MarshalFields 

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

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

func (SqsAction) String 

func (s SqsAction) String() string

String returns the string representation

func (*SqsAction) Validate 

func (s *SqsAction) Validate() error

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

type State 

type State struct {

	// When entering this state, perform these actions if the condition is TRUE.
	OnEnter *OnEnterLifecycle `locationName:"onEnter" type:"structure"`

	// When exiting this state, perform these actions if the specified condition
	// is TRUE.
	OnExit *OnExitLifecycle `locationName:"onExit" type:"structure"`

	// When an input is received and the condition is TRUE, perform the specified
	// actions.
	OnInput *OnInputLifecycle `locationName:"onInput" type:"structure"`

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

Information that defines a state of a detector.

func (State) MarshalFields 

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

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

func (State) String 

func (s State) String() string

String returns the string representation

func (*State) Validate 

func (s *State) Validate() error

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

type Tag 

type Tag struct {

	// The tag's key.
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`

	// The tag's value.
	//
	// Value is a required field
	Value *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Metadata that can be used to manage the resource.

func (Tag) MarshalFields 

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

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

func (Tag) String 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate 

func (s *Tag) Validate() error

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

type TagResourceInput 

type TagResourceInput struct {

	// The ARN of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"querystring" locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// The new or modified tags for the resource.
	//
	// Tags is a required field
	Tags []Tag `locationName:"tags" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) MarshalFields 

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

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

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput 

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

func (TagResourceOutput) MarshalFields 

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

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

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the TagResource request.

type TransitionEvent 

type TransitionEvent struct {

	// The actions to be performed.
	Actions []Action `locationName:"actions" type:"list"`

	// Required. A Boolean expression that when TRUE causes the actions to be performed
	// and the nextState to be entered.
	//
	// Condition is a required field
	Condition *string `locationName:"condition" type:"string" required:"true"`

	// The name of the transition event.
	//
	// EventName is a required field
	EventName *string `locationName:"eventName" type:"string" required:"true"`

	// The next state to enter.
	//
	// NextState is a required field
	NextState *string `locationName:"nextState" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies the actions performed and the next state entered when a condition evaluates to TRUE.

func (TransitionEvent) MarshalFields 

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

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

func (TransitionEvent) String 

func (s TransitionEvent) String() string

String returns the string representation

func (*TransitionEvent) Validate 

func (s *TransitionEvent) Validate() error

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

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"querystring" locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// A list of the keys of the tags to be removed from the resource.
	//
	// TagKeys is a required field
	TagKeys []string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) MarshalFields 

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

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

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput 

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

func (UntagResourceOutput) MarshalFields 

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

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

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateDetectorModelInput 

type UpdateDetectorModelInput struct {

	// Information that defines how a detector operates.
	//
	// DetectorModelDefinition is a required field
	DetectorModelDefinition *DetectorModelDefinition `locationName:"detectorModelDefinition" type:"structure" required:"true"`

	// A brief description of the detector model.
	DetectorModelDescription *string `locationName:"detectorModelDescription" type:"string"`

	// The name of the detector model that is updated.
	//
	// DetectorModelName is a required field
	DetectorModelName *string `location:"uri" locationName:"detectorModelName" min:"1" type:"string" required:"true"`

	// Information about the order in which events are evaluated and how actions
	// are executed.
	EvaluationMethod EvaluationMethod `locationName:"evaluationMethod" type:"string" enum:"true"`

	// The ARN of the role that grants permission to AWS IoT Events to perform its
	// operations.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateDetectorModelInput) MarshalFields 

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

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

func (UpdateDetectorModelInput) String 

func (s UpdateDetectorModelInput) String() string

String returns the string representation

func (*UpdateDetectorModelInput) Validate 

func (s *UpdateDetectorModelInput) Validate() error

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

type UpdateDetectorModelOutput 

type UpdateDetectorModelOutput struct {

	// Information about how the detector model is configured.
	DetectorModelConfiguration *DetectorModelConfiguration `locationName:"detectorModelConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateDetectorModelOutput) MarshalFields 

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

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

func (UpdateDetectorModelOutput) String 

func (s UpdateDetectorModelOutput) String() string

String returns the string representation

type UpdateDetectorModelRequest 

type UpdateDetectorModelRequest struct {
	*aws.Request
	Input *UpdateDetectorModelInput
	Copy  func(*UpdateDetectorModelInput) UpdateDetectorModelRequest
}

UpdateDetectorModelRequest is the request type for the UpdateDetectorModel API operation.

func (UpdateDetectorModelRequest) Send 

func (r UpdateDetectorModelRequest) Send(ctx context.Context) (*UpdateDetectorModelResponse, error)

Send marshals and sends the UpdateDetectorModel API request.

type UpdateDetectorModelResponse 

type UpdateDetectorModelResponse struct {
	*UpdateDetectorModelOutput
	// contains filtered or unexported fields
}

UpdateDetectorModelResponse is the response type for the UpdateDetectorModel API operation.

func (*UpdateDetectorModelResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the UpdateDetectorModel request.

type UpdateInputInput 

type UpdateInputInput struct {

	// The definition of the input.
	//
	// InputDefinition is a required field
	InputDefinition *InputDefinition `locationName:"inputDefinition" type:"structure" required:"true"`

	// A brief description of the input.
	InputDescription *string `locationName:"inputDescription" type:"string"`

	// The name of the input you want to update.
	//
	// InputName is a required field
	InputName *string `location:"uri" locationName:"inputName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateInputInput) MarshalFields 

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

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

func (UpdateInputInput) String 

func (s UpdateInputInput) String() string

String returns the string representation

func (*UpdateInputInput) Validate 

func (s *UpdateInputInput) Validate() error

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

type UpdateInputOutput 

type UpdateInputOutput struct {

	// Information about the configuration of the input.
	InputConfiguration *InputConfiguration `locationName:"inputConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateInputOutput) MarshalFields 

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

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

func (UpdateInputOutput) String 

func (s UpdateInputOutput) String() string

String returns the string representation

type UpdateInputRequest 

type UpdateInputRequest struct {
	*aws.Request
	Input *UpdateInputInput
	Copy  func(*UpdateInputInput) UpdateInputRequest
}

UpdateInputRequest is the request type for the UpdateInput API operation.

func (UpdateInputRequest) Send 

func (r UpdateInputRequest) Send(ctx context.Context) (*UpdateInputResponse, error)

Send marshals and sends the UpdateInput API request.

type UpdateInputResponse 

type UpdateInputResponse struct {
	*UpdateInputOutput
	// contains filtered or unexported fields
}

UpdateInputResponse is the response type for the UpdateInput API operation.

func (*UpdateInputResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the UpdateInput request.

Source Files

View all Source files

Directories

Path Synopsis
Package ioteventsiface provides an interface to enable mocking the AWS IoT Events service client for testing your code.
 Package ioteventsiface provides an interface to enable mocking the AWS IoT Events 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.