iotevents

package
v0.0.0-...-66c13d8 Latest Latest
Warning

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

Go to latest
Published: Nov 27, 2024 License: Apache-2.0, Apache-2.0 Imports: 10 Imported by: 0

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 operations 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 contact 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 IoTEvents 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 (
	// AlarmModelVersionStatusActive is a AlarmModelVersionStatus enum value
	AlarmModelVersionStatusActive = "ACTIVE"

	// AlarmModelVersionStatusActivating is a AlarmModelVersionStatus enum value
	AlarmModelVersionStatusActivating = "ACTIVATING"

	// AlarmModelVersionStatusInactive is a AlarmModelVersionStatus enum value
	AlarmModelVersionStatusInactive = "INACTIVE"

	// AlarmModelVersionStatusFailed is a AlarmModelVersionStatus enum value
	AlarmModelVersionStatusFailed = "FAILED"
)
View Source
const (
	// AnalysisResultLevelInfo is a AnalysisResultLevel enum value
	AnalysisResultLevelInfo = "INFO"

	// AnalysisResultLevelWarning is a AnalysisResultLevel enum value
	AnalysisResultLevelWarning = "WARNING"

	// AnalysisResultLevelError is a AnalysisResultLevel enum value
	AnalysisResultLevelError = "ERROR"
)
View Source
const (
	// AnalysisStatusRunning is a AnalysisStatus enum value
	AnalysisStatusRunning = "RUNNING"

	// AnalysisStatusComplete is a AnalysisStatus enum value
	AnalysisStatusComplete = "COMPLETE"

	// AnalysisStatusFailed is a AnalysisStatus enum value
	AnalysisStatusFailed = "FAILED"
)
View Source
const (
	// ComparisonOperatorGreater is a ComparisonOperator enum value
	ComparisonOperatorGreater = "GREATER"

	// ComparisonOperatorGreaterOrEqual is a ComparisonOperator enum value
	ComparisonOperatorGreaterOrEqual = "GREATER_OR_EQUAL"

	// ComparisonOperatorLess is a ComparisonOperator enum value
	ComparisonOperatorLess = "LESS"

	// ComparisonOperatorLessOrEqual is a ComparisonOperator enum value
	ComparisonOperatorLessOrEqual = "LESS_OR_EQUAL"

	// ComparisonOperatorEqual is a ComparisonOperator enum value
	ComparisonOperatorEqual = "EQUAL"

	// ComparisonOperatorNotEqual is a ComparisonOperator enum value
	ComparisonOperatorNotEqual = "NOT_EQUAL"
)
View Source
const (
	// DetectorModelVersionStatusActive is a DetectorModelVersionStatus enum value
	DetectorModelVersionStatusActive = "ACTIVE"

	// DetectorModelVersionStatusActivating is a DetectorModelVersionStatus enum value
	DetectorModelVersionStatusActivating = "ACTIVATING"

	// DetectorModelVersionStatusInactive is a DetectorModelVersionStatus enum value
	DetectorModelVersionStatusInactive = "INACTIVE"

	// DetectorModelVersionStatusDeprecated is a DetectorModelVersionStatus enum value
	DetectorModelVersionStatusDeprecated = "DEPRECATED"

	// DetectorModelVersionStatusDraft is a DetectorModelVersionStatus enum value
	DetectorModelVersionStatusDraft = "DRAFT"

	// DetectorModelVersionStatusPaused is a DetectorModelVersionStatus enum value
	DetectorModelVersionStatusPaused = "PAUSED"

	// DetectorModelVersionStatusFailed is a DetectorModelVersionStatus enum value
	DetectorModelVersionStatusFailed = "FAILED"
)
View Source
const (
	// EvaluationMethodBatch is a EvaluationMethod enum value
	EvaluationMethodBatch = "BATCH"

	// EvaluationMethodSerial is a EvaluationMethod enum value
	EvaluationMethodSerial = "SERIAL"
)
View Source
const (
	// InputStatusCreating is a InputStatus enum value
	InputStatusCreating = "CREATING"

	// InputStatusUpdating is a InputStatus enum value
	InputStatusUpdating = "UPDATING"

	// InputStatusActive is a InputStatus enum value
	InputStatusActive = "ACTIVE"

	// InputStatusDeleting is a InputStatus enum value
	InputStatusDeleting = "DELETING"
)
View Source
const (
	// LoggingLevelError is a LoggingLevel enum value
	LoggingLevelError = "ERROR"

	// LoggingLevelInfo is a LoggingLevel enum value
	LoggingLevelInfo = "INFO"

	// LoggingLevelDebug is a LoggingLevel enum value
	LoggingLevelDebug = "DEBUG"
)
View Source
const (
	// PayloadTypeString is a PayloadType enum value
	PayloadTypeString = "STRING"

	// PayloadTypeJson is a PayloadType enum value
	PayloadTypeJson = "JSON"
)
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"
)
View Source
const (
	ServiceName = "IoT Events" // Name of service.
	EndpointsID = "iotevents"  // ID to lookup a service endpoint with.
	ServiceID   = "IoT Events" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AlarmModelVersionStatus_Values

func AlarmModelVersionStatus_Values() []string

AlarmModelVersionStatus_Values returns all elements of the AlarmModelVersionStatus enum

func AnalysisResultLevel_Values

func AnalysisResultLevel_Values() []string

AnalysisResultLevel_Values returns all elements of the AnalysisResultLevel enum

func AnalysisStatus_Values

func AnalysisStatus_Values() []string

AnalysisStatus_Values returns all elements of the AnalysisStatus enum

func ComparisonOperator_Values

func ComparisonOperator_Values() []string

ComparisonOperator_Values returns all elements of the ComparisonOperator enum

func DetectorModelVersionStatus_Values

func DetectorModelVersionStatus_Values() []string

DetectorModelVersionStatus_Values returns all elements of the DetectorModelVersionStatus enum

func EvaluationMethod_Values

func EvaluationMethod_Values() []string

EvaluationMethod_Values returns all elements of the EvaluationMethod enum

func InputStatus_Values

func InputStatus_Values() []string

InputStatus_Values returns all elements of the InputStatus enum

func LoggingLevel_Values

func LoggingLevel_Values() []string

LoggingLevel_Values returns all elements of the LoggingLevel enum

func PayloadType_Values

func PayloadType_Values() []string

PayloadType_Values returns all elements of the PayloadType enum

Types

type AcknowledgeFlow

type AcknowledgeFlow struct {

	// The value must be TRUE or FALSE. If TRUE, you receive a notification when
	// the alarm state changes. You must choose to acknowledge the notification
	// before the alarm state can return to NORMAL. If FALSE, you won't receive
	// notifications. The alarm automatically changes to the NORMAL state when the
	// input property value returns to the specified range.
	//
	// Enabled is a required field
	Enabled *bool `locationName:"enabled" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Specifies whether to get notified for alarm state changes.

func (AcknowledgeFlow) GoString

func (s AcknowledgeFlow) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcknowledgeFlow) SetEnabled

func (s *AcknowledgeFlow) SetEnabled(v bool) *AcknowledgeFlow

SetEnabled sets the Enabled field's value.

func (AcknowledgeFlow) String

func (s AcknowledgeFlow) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcknowledgeFlow) Validate

func (s *AcknowledgeFlow) Validate() error

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

type Action

type Action 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"`

	// You can configure the action payload when you send a message to an AWS IoT
	// Events input.
	Payload *Payload `locationName:"payload" type:"structure"`
	// 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 (Action) GoString

func (s Action) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Action) SetInputName

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

SetInputName sets the InputName field's value.

func (*Action) SetPayload

func (s *Action) SetPayload(v *Payload) *Action

SetPayload sets the Payload field's value.

func (Action) String

func (s Action) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Action) Validate

func (s *Action) Validate() error

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

type ActionData

type ActionData struct {

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

	// Writes to the DynamoDB table that you created. The default action payload
	// contains all attribute-value pairs that have the information about the detector
	// model instance and the event that triggered the action. You can customize
	// the payload (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html).
	// One column of the DynamoDB table receives all attribute-value pairs in the
	// payload that you specify. For more information, see Actions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html)
	// in AWS IoT Events Developer Guide.
	DynamoDB *DynamoDBAction `locationName:"dynamoDB" type:"structure"`

	// Writes to the DynamoDB table that you created. The default action payload
	// contains all attribute-value pairs that have the information about the detector
	// model instance and the event that triggered the action. You can customize
	// the payload (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html).
	// A separate column of the DynamoDB table receives one attribute-value pair
	// in the payload that you specify. For more information, see Actions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html)
	// in AWS IoT Events Developer Guide.
	DynamoDBv2 *DynamoDBv2Action `locationName:"dynamoDBv2" 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 AWS IoT Events input, which passes information about the detector model
	// instance and the event that triggered the action.
	IotEvents *Action `locationName:"iotEvents" type:"structure"`

	// Sends information about the detector model instance and the event that triggered
	// the action to an asset property in AWS IoT SiteWise .
	IotSiteWise *IotSiteWiseAction `locationName:"iotSiteWise" 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 (ActionData) GoString

func (s ActionData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionData) SetClearTimer

func (s *ActionData) SetClearTimer(v *ClearTimerAction) *ActionData

SetClearTimer sets the ClearTimer field's value.

func (*ActionData) SetDynamoDB

func (s *ActionData) SetDynamoDB(v *DynamoDBAction) *ActionData

SetDynamoDB sets the DynamoDB field's value.

func (*ActionData) SetDynamoDBv2

func (s *ActionData) SetDynamoDBv2(v *DynamoDBv2Action) *ActionData

SetDynamoDBv2 sets the DynamoDBv2 field's value.

func (*ActionData) SetFirehose

func (s *ActionData) SetFirehose(v *FirehoseAction) *ActionData

SetFirehose sets the Firehose field's value.

func (*ActionData) SetIotEvents

func (s *ActionData) SetIotEvents(v *Action) *ActionData

SetIotEvents sets the IotEvents field's value.

func (*ActionData) SetIotSiteWise

func (s *ActionData) SetIotSiteWise(v *IotSiteWiseAction) *ActionData

SetIotSiteWise sets the IotSiteWise field's value.

func (*ActionData) SetIotTopicPublish

func (s *ActionData) SetIotTopicPublish(v *IotTopicPublishAction) *ActionData

SetIotTopicPublish sets the IotTopicPublish field's value.

func (*ActionData) SetLambda

func (s *ActionData) SetLambda(v *LambdaAction) *ActionData

SetLambda sets the Lambda field's value.

func (*ActionData) SetResetTimer

func (s *ActionData) SetResetTimer(v *ResetTimerAction) *ActionData

SetResetTimer sets the ResetTimer field's value.

func (*ActionData) SetSetTimer

func (s *ActionData) SetSetTimer(v *SetTimerAction) *ActionData

SetSetTimer sets the SetTimer field's value.

func (*ActionData) SetSetVariable

func (s *ActionData) SetSetVariable(v *SetVariableAction) *ActionData

SetSetVariable sets the SetVariable field's value.

func (*ActionData) SetSns

SetSns sets the Sns field's value.

func (*ActionData) SetSqs

func (s *ActionData) SetSqs(v *SqsAction) *ActionData

SetSqs sets the Sqs field's value.

func (ActionData) String

func (s ActionData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionData) Validate

func (s *ActionData) Validate() error

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

type AlarmAction

type AlarmAction struct {

	// Defines an action to write to the Amazon DynamoDB table that you created.
	// The standard action payload contains all the information about the detector
	// model instance and the event that triggered the action. You can customize
	// the payload (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html).
	// One column of the DynamoDB table receives all attribute-value pairs in the
	// payload that you specify.
	//
	// You must use expressions for all parameters in DynamoDBAction. The expressions
	// accept literals, operators, functions, references, and substitution templates.
	//
	// Examples
	//
	//    * For literal values, the expressions must contain single quotes. For
	//    example, the value for the hashKeyType parameter can be 'STRING'.
	//
	//    * For references, you must specify either variables or input values. For
	//    example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name.
	//
	//    * For a substitution template, you must use ${}, and the template must
	//    be in single quotes. A substitution template can also contain a combination
	//    of literals, operators, functions, references, and substitution templates.
	//    In the following example, the value for the hashKeyValue parameter uses
	//    a substitution template. '${$input.GreenhouseInput.temperature * 6 / 5
	//    + 32} in Fahrenheit'
	//
	//    * For a string concatenation, you must use +. A string concatenation can
	//    also contain a combination of literals, operators, functions, references,
	//    and substitution templates. In the following example, the value for the
	//    tableName parameter uses a string concatenation. 'GreenhouseTemperatureTable
	//    ' + $input.GreenhouseInput.date
	//
	// For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)
	// in the AWS IoT Events Developer Guide.
	//
	// If the defined payload type is a string, DynamoDBAction writes non-JSON data
	// to the DynamoDB table as binary data. The DynamoDB console displays the data
	// as Base64-encoded text. The value for the payloadField parameter is <payload-field>_raw.
	DynamoDB *DynamoDBAction `locationName:"dynamoDB" type:"structure"`

	// Defines an action to write to the Amazon DynamoDB table that you created.
	// The default action payload contains all the information about the detector
	// model instance and the event that triggered the action. You can customize
	// the payload (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html).
	// A separate column of the DynamoDB table receives one attribute-value pair
	// in the payload that you specify.
	//
	// You must use expressions for all parameters in DynamoDBv2Action. The expressions
	// accept literals, operators, functions, references, and substitution templates.
	//
	// Examples
	//
	//    * For literal values, the expressions must contain single quotes. For
	//    example, the value for the tableName parameter can be 'GreenhouseTemperatureTable'.
	//
	//    * For references, you must specify either variables or input values. For
	//    example, the value for the tableName parameter can be $variable.ddbtableName.
	//
	//    * For a substitution template, you must use ${}, and the template must
	//    be in single quotes. A substitution template can also contain a combination
	//    of literals, operators, functions, references, and substitution templates.
	//    In the following example, the value for the contentExpression parameter
	//    in Payload uses a substitution template. '{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\",
	//    \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'
	//
	//    * For a string concatenation, you must use +. A string concatenation can
	//    also contain a combination of literals, operators, functions, references,
	//    and substitution templates. In the following example, the value for the
	//    tableName parameter uses a string concatenation. 'GreenhouseTemperatureTable
	//    ' + $input.GreenhouseInput.date
	//
	// For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)
	// in the AWS IoT Events Developer Guide.
	//
	// The value for the type parameter in Payload must be JSON.
	DynamoDBv2 *DynamoDBv2Action `locationName:"dynamoDBv2" 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 *Action `locationName:"iotEvents" type:"structure"`

	// Sends information about the detector model instance and the event that triggered
	// the action to a specified asset property in AWS IoT SiteWise.
	//
	// You must use expressions for all parameters in IotSiteWiseAction. The expressions
	// accept literals, operators, functions, references, and substitutions templates.
	//
	// Examples
	//
	//    * For literal values, the expressions must contain single quotes. For
	//    example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature'.
	//
	//    * For references, you must specify either variables or input values. For
	//    example, the value for the assetId parameter can be $input.TurbineInput.assetId1.
	//
	//    * For a substitution template, you must use ${}, and the template must
	//    be in single quotes. A substitution template can also contain a combination
	//    of literals, operators, functions, references, and substitution templates.
	//    In the following example, the value for the propertyAlias parameter uses
	//    a substitution template. 'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/
	//    ${$input.TemperatureInput.sensorData.turbineID}/temperature'
	//
	// You must specify either propertyAlias or both assetId and propertyId to identify
	// the target asset property in AWS IoT SiteWise.
	//
	// For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html)
	// in the AWS IoT Events Developer Guide.
	IotSiteWise *IotSiteWiseAction `locationName:"iotSiteWise" type:"structure"`

	// Information required to publish the MQTT message through 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 required to publish the 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
}

Specifies one of the following actions to receive notifications when the alarm state changes.

func (AlarmAction) GoString

func (s AlarmAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlarmAction) SetDynamoDB

func (s *AlarmAction) SetDynamoDB(v *DynamoDBAction) *AlarmAction

SetDynamoDB sets the DynamoDB field's value.

func (*AlarmAction) SetDynamoDBv2

func (s *AlarmAction) SetDynamoDBv2(v *DynamoDBv2Action) *AlarmAction

SetDynamoDBv2 sets the DynamoDBv2 field's value.

func (*AlarmAction) SetFirehose

func (s *AlarmAction) SetFirehose(v *FirehoseAction) *AlarmAction

SetFirehose sets the Firehose field's value.

func (*AlarmAction) SetIotEvents

func (s *AlarmAction) SetIotEvents(v *Action) *AlarmAction

SetIotEvents sets the IotEvents field's value.

func (*AlarmAction) SetIotSiteWise

func (s *AlarmAction) SetIotSiteWise(v *IotSiteWiseAction) *AlarmAction

SetIotSiteWise sets the IotSiteWise field's value.

func (*AlarmAction) SetIotTopicPublish

func (s *AlarmAction) SetIotTopicPublish(v *IotTopicPublishAction) *AlarmAction

SetIotTopicPublish sets the IotTopicPublish field's value.

func (*AlarmAction) SetLambda

func (s *AlarmAction) SetLambda(v *LambdaAction) *AlarmAction

SetLambda sets the Lambda field's value.

func (*AlarmAction) SetSns

SetSns sets the Sns field's value.

func (*AlarmAction) SetSqs

func (s *AlarmAction) SetSqs(v *SqsAction) *AlarmAction

SetSqs sets the Sqs field's value.

func (AlarmAction) String

func (s AlarmAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlarmAction) Validate

func (s *AlarmAction) Validate() error

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

type AlarmCapabilities

type AlarmCapabilities struct {

	// Specifies whether to get notified for alarm state changes.
	AcknowledgeFlow *AcknowledgeFlow `locationName:"acknowledgeFlow" type:"structure"`

	// Specifies the default alarm state. The configuration applies to all alarms
	// that were created based on this alarm model.
	InitializationConfiguration *InitializationConfiguration `locationName:"initializationConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

Contains the configuration information of alarm state changes.

func (AlarmCapabilities) GoString

func (s AlarmCapabilities) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlarmCapabilities) SetAcknowledgeFlow

func (s *AlarmCapabilities) SetAcknowledgeFlow(v *AcknowledgeFlow) *AlarmCapabilities

SetAcknowledgeFlow sets the AcknowledgeFlow field's value.

func (*AlarmCapabilities) SetInitializationConfiguration

func (s *AlarmCapabilities) SetInitializationConfiguration(v *InitializationConfiguration) *AlarmCapabilities

SetInitializationConfiguration sets the InitializationConfiguration field's value.

func (AlarmCapabilities) String

func (s AlarmCapabilities) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlarmCapabilities) Validate

func (s *AlarmCapabilities) Validate() error

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

type AlarmEventActions

type AlarmEventActions struct {

	// Specifies one or more supported actions to receive notifications when the
	// alarm state changes.
	AlarmActions []*AlarmAction `locationName:"alarmActions" type:"list"`
	// contains filtered or unexported fields
}

Contains information about one or more alarm actions.

func (AlarmEventActions) GoString

func (s AlarmEventActions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlarmEventActions) SetAlarmActions

func (s *AlarmEventActions) SetAlarmActions(v []*AlarmAction) *AlarmEventActions

SetAlarmActions sets the AlarmActions field's value.

func (AlarmEventActions) String

func (s AlarmEventActions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlarmEventActions) Validate

func (s *AlarmEventActions) Validate() error

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

type AlarmModelSummary

type AlarmModelSummary struct {

	// The description of the alarm model.
	AlarmModelDescription *string `locationName:"alarmModelDescription" type:"string"`

	// The name of the alarm model.
	AlarmModelName *string `locationName:"alarmModelName" min:"1" type:"string"`

	// The time the alarm model was created, in the Unix epoch format.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`
	// contains filtered or unexported fields
}

Contains a summary of an alarm model.

func (AlarmModelSummary) GoString

func (s AlarmModelSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlarmModelSummary) SetAlarmModelDescription

func (s *AlarmModelSummary) SetAlarmModelDescription(v string) *AlarmModelSummary

SetAlarmModelDescription sets the AlarmModelDescription field's value.

func (*AlarmModelSummary) SetAlarmModelName

func (s *AlarmModelSummary) SetAlarmModelName(v string) *AlarmModelSummary

SetAlarmModelName sets the AlarmModelName field's value.

func (*AlarmModelSummary) SetCreationTime

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

SetCreationTime sets the CreationTime field's value.

func (AlarmModelSummary) String

func (s AlarmModelSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AlarmModelVersionSummary

type AlarmModelVersionSummary struct {

	// The ARN of the alarm model. For more information, see Amazon Resource Names
	// (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the AWS General Reference.
	AlarmModelArn *string `locationName:"alarmModelArn" type:"string"`

	// The name of the alarm model.
	AlarmModelName *string `locationName:"alarmModelName" min:"1" type:"string"`

	// The version of the alarm model.
	AlarmModelVersion *string `locationName:"alarmModelVersion" min:"1" type:"string"`

	// The time the alarm model was created, in the Unix epoch format.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The time the alarm model was last updated, in the Unix epoch format.
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`

	// The ARN of the IAM role that allows the alarm to perform actions and access
	// AWS resources. For more information, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the AWS General Reference.
	RoleArn *string `locationName:"roleArn" min:"1" type:"string"`

	// The status of the alarm model. The status can be one of the following values:
	//
	//    * ACTIVE - The alarm model is active and it's ready to evaluate data.
	//
	//    * ACTIVATING - AWS IoT Events is activating your alarm model. Activating
	//    an alarm model can take up to a few minutes.
	//
	//    * INACTIVE - The alarm model is inactive, so it isn't ready to evaluate
	//    data. Check your alarm model information and update the alarm model.
	//
	//    * FAILED - You couldn't create or update the alarm model. Check your alarm
	//    model information and try again.
	Status *string `locationName:"status" type:"string" enum:"AlarmModelVersionStatus"`

	// Contains information about the status of the alarm model version.
	StatusMessage *string `locationName:"statusMessage" type:"string"`
	// contains filtered or unexported fields
}

Contains a summary of an alarm model version.

func (AlarmModelVersionSummary) GoString

func (s AlarmModelVersionSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlarmModelVersionSummary) SetAlarmModelArn

SetAlarmModelArn sets the AlarmModelArn field's value.

func (*AlarmModelVersionSummary) SetAlarmModelName

func (s *AlarmModelVersionSummary) SetAlarmModelName(v string) *AlarmModelVersionSummary

SetAlarmModelName sets the AlarmModelName field's value.

func (*AlarmModelVersionSummary) SetAlarmModelVersion

func (s *AlarmModelVersionSummary) SetAlarmModelVersion(v string) *AlarmModelVersionSummary

SetAlarmModelVersion sets the AlarmModelVersion field's value.

func (*AlarmModelVersionSummary) SetCreationTime

SetCreationTime sets the CreationTime field's value.

func (*AlarmModelVersionSummary) SetLastUpdateTime

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*AlarmModelVersionSummary) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*AlarmModelVersionSummary) SetStatus

SetStatus sets the Status field's value.

func (*AlarmModelVersionSummary) SetStatusMessage

SetStatusMessage sets the StatusMessage field's value.

func (AlarmModelVersionSummary) String

func (s AlarmModelVersionSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AlarmNotification

type AlarmNotification struct {

	// Contains the notification settings of an alarm model. The settings apply
	// to all alarms that were created based on this alarm model.
	NotificationActions []*NotificationAction `locationName:"notificationActions" min:"1" type:"list"`
	// contains filtered or unexported fields
}

Contains information about one or more notification actions.

func (AlarmNotification) GoString

func (s AlarmNotification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlarmNotification) SetNotificationActions

func (s *AlarmNotification) SetNotificationActions(v []*NotificationAction) *AlarmNotification

SetNotificationActions sets the NotificationActions field's value.

func (AlarmNotification) String

func (s AlarmNotification) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlarmNotification) Validate

func (s *AlarmNotification) Validate() error

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

type AlarmRule

type AlarmRule struct {

	// A rule that compares an input property value to a threshold value with a
	// comparison operator.
	SimpleRule *SimpleRule `locationName:"simpleRule" type:"structure"`
	// contains filtered or unexported fields
}

Defines when your alarm is invoked.

func (AlarmRule) GoString

func (s AlarmRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlarmRule) SetSimpleRule

func (s *AlarmRule) SetSimpleRule(v *SimpleRule) *AlarmRule

SetSimpleRule sets the SimpleRule field's value.

func (AlarmRule) String

func (s AlarmRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlarmRule) Validate

func (s *AlarmRule) Validate() error

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

type AnalysisResult

type AnalysisResult struct {

	// The severity level of the analysis result. Based on the severity level, analysis
	// results fall into three general categories:
	//
	//    * INFO - An information result tells you about a significant field in
	//    your detector model. This type of result usually doesn't require immediate
	//    action.
	//
	//    * WARNING - A warning result draws special attention to fields that might
	//    cause issues for your detector model. We recommend that you review warnings
	//    and take necessary actions before you use your detector model in production
	//    environments. Otherwise, the detector model might not work as expected.
	//
	//    * ERROR - An error result notifies you about a problem found in your detector
	//    model. You must fix all errors before you can publish your detector model.
	Level *string `locationName:"level" type:"string" enum:"AnalysisResultLevel"`

	// Contains one or more locations that you can use to locate the fields in your
	// detector model that the analysis result references.
	Locations []*AnalysisResultLocation `locationName:"locations" type:"list"`

	// Contains additional information about the analysis result.
	Message *string `locationName:"message" type:"string"`

	// The type of the analysis result. Analyses fall into the following types based
	// on the validators used to generate the analysis result:
	//
	//    * supported-actions - You must specify AWS IoT Events supported actions
	//    that work with other AWS services in a supported AWS Region.
	//
	//    * service-limits - Resources or API operations can't exceed service quotas
	//    (also known as limits). Update your detector model or request a quota
	//    increase.
	//
	//    * structure - The detector model must follow a structure that AWS IoT
	//    Events supports.
	//
	//    * expression-syntax - Your expression must follow the required syntax.
	//
	//    * data-type - Data types referenced in the detector model must be compatible.
	//
	//    * referenced-data - You must define the data referenced in your detector
	//    model before you can use the data.
	//
	//    * referenced-resource - Resources that the detector model uses must be
	//    available.
	//
	// For more information, see Running detector model analyses (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html)
	// in the AWS IoT Events Developer Guide.
	Type *string `locationName:"type" type:"string"`
	// contains filtered or unexported fields
}

Contains the result of the analysis.

func (AnalysisResult) GoString

func (s AnalysisResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnalysisResult) SetLevel

func (s *AnalysisResult) SetLevel(v string) *AnalysisResult

SetLevel sets the Level field's value.

func (*AnalysisResult) SetLocations

func (s *AnalysisResult) SetLocations(v []*AnalysisResultLocation) *AnalysisResult

SetLocations sets the Locations field's value.

func (*AnalysisResult) SetMessage

func (s *AnalysisResult) SetMessage(v string) *AnalysisResult

SetMessage sets the Message field's value.

func (*AnalysisResult) SetType

func (s *AnalysisResult) SetType(v string) *AnalysisResult

SetType sets the Type field's value.

func (AnalysisResult) String

func (s AnalysisResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AnalysisResultLocation

type AnalysisResultLocation struct {

	// A JsonPath (https://github.com/json-path/JsonPath) expression that identifies
	// the error field in your detector model.
	Path *string `locationName:"path" type:"string"`
	// contains filtered or unexported fields
}

Contains information that you can use to locate the field in your detector model that the analysis result references.

func (AnalysisResultLocation) GoString

func (s AnalysisResultLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnalysisResultLocation) SetPath

SetPath sets the Path field's value.

func (AnalysisResultLocation) String

func (s AnalysisResultLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetPropertyTimestamp

type AssetPropertyTimestamp struct {

	// The nanosecond offset converted from timeInSeconds. The valid range is between
	// 0-999999999.
	OffsetInNanos *string `locationName:"offsetInNanos" type:"string"`

	// The timestamp, in seconds, in the Unix epoch format. The valid range is between
	// 1-31556889864403199.
	//
	// TimeInSeconds is a required field
	TimeInSeconds *string `locationName:"timeInSeconds" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A structure that contains timestamp information. For more information, see TimeInNanos (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the AWS IoT SiteWise API Reference.

You must use expressions for all parameters in AssetPropertyTimestamp. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the timeInSeconds parameter can be '1586400675'.

  • For references, you must specify either variables or input values. For example, the value for the offsetInNanos parameter can be $variable.time.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the timeInSeconds parameter uses a substitution template. '${$input.TemperatureInput.sensorData.timestamp / 1000}'

For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the AWS IoT Events Developer Guide.

func (AssetPropertyTimestamp) GoString

func (s AssetPropertyTimestamp) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetPropertyTimestamp) SetOffsetInNanos

func (s *AssetPropertyTimestamp) SetOffsetInNanos(v string) *AssetPropertyTimestamp

SetOffsetInNanos sets the OffsetInNanos field's value.

func (*AssetPropertyTimestamp) SetTimeInSeconds

func (s *AssetPropertyTimestamp) SetTimeInSeconds(v string) *AssetPropertyTimestamp

SetTimeInSeconds sets the TimeInSeconds field's value.

func (AssetPropertyTimestamp) String

func (s AssetPropertyTimestamp) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetPropertyTimestamp) Validate

func (s *AssetPropertyTimestamp) Validate() error

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

type AssetPropertyValue

type AssetPropertyValue struct {

	// The quality of the asset property value. The value must be 'GOOD', 'BAD',
	// or 'UNCERTAIN'.
	Quality *string `locationName:"quality" type:"string"`

	// The timestamp associated with the asset property value. The default is the
	// current event time.
	Timestamp *AssetPropertyTimestamp `locationName:"timestamp" type:"structure"`

	// The value to send to an asset property.
	Value *AssetPropertyVariant `locationName:"value" type:"structure"`
	// contains filtered or unexported fields
}

A structure that contains value information. For more information, see AssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the AWS IoT SiteWise API Reference.

You must use expressions for all parameters in AssetPropertyValue. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the quality parameter can be 'GOOD'.

  • For references, you must specify either variables or input values. For example, the value for the quality parameter can be $input.TemperatureInput.sensorData.quality.

For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the AWS IoT Events Developer Guide.

func (AssetPropertyValue) GoString

func (s AssetPropertyValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetPropertyValue) SetQuality

func (s *AssetPropertyValue) SetQuality(v string) *AssetPropertyValue

SetQuality sets the Quality field's value.

func (*AssetPropertyValue) SetTimestamp

SetTimestamp sets the Timestamp field's value.

func (*AssetPropertyValue) SetValue

SetValue sets the Value field's value.

func (AssetPropertyValue) String

func (s AssetPropertyValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetPropertyValue) Validate

func (s *AssetPropertyValue) Validate() error

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

type AssetPropertyVariant

type AssetPropertyVariant struct {

	// The asset property value is a Boolean value that must be 'TRUE' or 'FALSE'.
	// You must use an expression, and the evaluated result should be a Boolean
	// value.
	BooleanValue *string `locationName:"booleanValue" type:"string"`

	// The asset property value is a double. You must use an expression, and the
	// evaluated result should be a double.
	DoubleValue *string `locationName:"doubleValue" type:"string"`

	// The asset property value is an integer. You must use an expression, and the
	// evaluated result should be an integer.
	IntegerValue *string `locationName:"integerValue" type:"string"`

	// The asset property value is a string. You must use an expression, and the
	// evaluated result should be a string.
	StringValue *string `locationName:"stringValue" type:"string"`
	// contains filtered or unexported fields
}

A structure that contains an asset property value. For more information, see Variant (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the AWS IoT SiteWise API Reference.

You must use expressions for all parameters in AssetPropertyVariant. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the integerValue parameter can be '100'.

  • For references, you must specify either variables or parameters. For example, the value for the booleanValue parameter can be $variable.offline.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the doubleValue parameter uses a substitution template. '${$input.TemperatureInput.sensorData.temperature

  • 6 / 5 + 32}'

For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the AWS IoT Events Developer Guide.

You must specify one of the following value types, depending on the dataType of the specified asset property. For more information, see AssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html) in the AWS IoT SiteWise API Reference.

func (AssetPropertyVariant) GoString

func (s AssetPropertyVariant) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetPropertyVariant) SetBooleanValue

func (s *AssetPropertyVariant) SetBooleanValue(v string) *AssetPropertyVariant

SetBooleanValue sets the BooleanValue field's value.

func (*AssetPropertyVariant) SetDoubleValue

func (s *AssetPropertyVariant) SetDoubleValue(v string) *AssetPropertyVariant

SetDoubleValue sets the DoubleValue field's value.

func (*AssetPropertyVariant) SetIntegerValue

func (s *AssetPropertyVariant) SetIntegerValue(v string) *AssetPropertyVariant

SetIntegerValue sets the IntegerValue field's value.

func (*AssetPropertyVariant) SetStringValue

func (s *AssetPropertyVariant) SetStringValue(v string) *AssetPropertyVariant

SetStringValue sets the StringValue field's value.

func (AssetPropertyVariant) String

func (s AssetPropertyVariant) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s Attribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Attribute) SetJsonPath

func (s *Attribute) SetJsonPath(v string) *Attribute

SetJsonPath sets the JsonPath field's value.

func (Attribute) String

func (s Attribute) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ClearTimerAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClearTimerAction) SetTimerName

func (s *ClearTimerAction) SetTimerName(v string) *ClearTimerAction

SetTimerName sets the TimerName field's value.

func (ClearTimerAction) String

func (s ClearTimerAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClearTimerAction) Validate

func (s *ClearTimerAction) Validate() error

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

type CreateAlarmModelInput

type CreateAlarmModelInput struct {

	// Contains the configuration information of alarm state changes.
	AlarmCapabilities *AlarmCapabilities `locationName:"alarmCapabilities" type:"structure"`

	// Contains information about one or more alarm actions.
	AlarmEventActions *AlarmEventActions `locationName:"alarmEventActions" type:"structure"`

	// A description that tells you what the alarm model detects.
	AlarmModelDescription *string `locationName:"alarmModelDescription" type:"string"`

	// A unique name that helps you identify the alarm model. You can't change this
	// name after you create the alarm model.
	//
	// AlarmModelName is a required field
	AlarmModelName *string `locationName:"alarmModelName" min:"1" type:"string" required:"true"`

	// Contains information about one or more notification actions.
	AlarmNotification *AlarmNotification `locationName:"alarmNotification" type:"structure"`

	// Defines when your alarm is invoked.
	//
	// AlarmRule is a required field
	AlarmRule *AlarmRule `locationName:"alarmRule" type:"structure" required:"true"`

	// An input attribute used as a key to create an alarm. AWS IoT Events routes
	// inputs (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html)
	// associated with this key to the alarm.
	Key *string `locationName:"key" min:"1" type:"string"`

	// The ARN of the IAM role that allows the alarm to perform actions and access
	// AWS resources. For more information, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the AWS General Reference.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"`

	// A non-negative integer that reflects the severity level of the alarm.
	Severity *int64 `locationName:"severity" type:"integer"`

	// A list of key-value pairs that contain metadata for the alarm model. The
	// tags help you manage the alarm model. For more information, see Tagging your
	// AWS IoT Events resources (https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html)
	// in the AWS IoT Events Developer Guide.
	//
	// You can create up to 50 tags for one alarm model.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateAlarmModelInput) GoString

func (s CreateAlarmModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAlarmModelInput) SetAlarmCapabilities

func (s *CreateAlarmModelInput) SetAlarmCapabilities(v *AlarmCapabilities) *CreateAlarmModelInput

SetAlarmCapabilities sets the AlarmCapabilities field's value.

func (*CreateAlarmModelInput) SetAlarmEventActions

func (s *CreateAlarmModelInput) SetAlarmEventActions(v *AlarmEventActions) *CreateAlarmModelInput

SetAlarmEventActions sets the AlarmEventActions field's value.

func (*CreateAlarmModelInput) SetAlarmModelDescription

func (s *CreateAlarmModelInput) SetAlarmModelDescription(v string) *CreateAlarmModelInput

SetAlarmModelDescription sets the AlarmModelDescription field's value.

func (*CreateAlarmModelInput) SetAlarmModelName

func (s *CreateAlarmModelInput) SetAlarmModelName(v string) *CreateAlarmModelInput

SetAlarmModelName sets the AlarmModelName field's value.

func (*CreateAlarmModelInput) SetAlarmNotification

func (s *CreateAlarmModelInput) SetAlarmNotification(v *AlarmNotification) *CreateAlarmModelInput

SetAlarmNotification sets the AlarmNotification field's value.

func (*CreateAlarmModelInput) SetAlarmRule

SetAlarmRule sets the AlarmRule field's value.

func (*CreateAlarmModelInput) SetKey

SetKey sets the Key field's value.

func (*CreateAlarmModelInput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*CreateAlarmModelInput) SetSeverity

SetSeverity sets the Severity field's value.

func (*CreateAlarmModelInput) SetTags

SetTags sets the Tags field's value.

func (CreateAlarmModelInput) String

func (s CreateAlarmModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAlarmModelInput) Validate

func (s *CreateAlarmModelInput) Validate() error

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

type CreateAlarmModelOutput

type CreateAlarmModelOutput struct {

	// The ARN of the alarm model. For more information, see Amazon Resource Names
	// (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the AWS General Reference.
	AlarmModelArn *string `locationName:"alarmModelArn" type:"string"`

	// The version of the alarm model.
	AlarmModelVersion *string `locationName:"alarmModelVersion" min:"1" type:"string"`

	// The time the alarm model was created, in the Unix epoch format.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The time the alarm model was last updated, in the Unix epoch format.
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`

	// The status of the alarm model. The status can be one of the following values:
	//
	//    * ACTIVE - The alarm model is active and it's ready to evaluate data.
	//
	//    * ACTIVATING - AWS IoT Events is activating your alarm model. Activating
	//    an alarm model can take up to a few minutes.
	//
	//    * INACTIVE - The alarm model is inactive, so it isn't ready to evaluate
	//    data. Check your alarm model information and update the alarm model.
	//
	//    * FAILED - You couldn't create or update the alarm model. Check your alarm
	//    model information and try again.
	Status *string `locationName:"status" type:"string" enum:"AlarmModelVersionStatus"`
	// contains filtered or unexported fields
}

func (CreateAlarmModelOutput) GoString

func (s CreateAlarmModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAlarmModelOutput) SetAlarmModelArn

func (s *CreateAlarmModelOutput) SetAlarmModelArn(v string) *CreateAlarmModelOutput

SetAlarmModelArn sets the AlarmModelArn field's value.

func (*CreateAlarmModelOutput) SetAlarmModelVersion

func (s *CreateAlarmModelOutput) SetAlarmModelVersion(v string) *CreateAlarmModelOutput

SetAlarmModelVersion sets the AlarmModelVersion field's value.

func (*CreateAlarmModelOutput) SetCreationTime

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

SetCreationTime sets the CreationTime field's value.

func (*CreateAlarmModelOutput) SetLastUpdateTime

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

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*CreateAlarmModelOutput) SetStatus

SetStatus sets the Status field's value.

func (CreateAlarmModelOutput) String

func (s CreateAlarmModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `locationName:"evaluationMethod" type:"string" enum:"EvaluationMethod"`

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

func (s CreateDetectorModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDetectorModelInput) SetDetectorModelDefinition

SetDetectorModelDefinition sets the DetectorModelDefinition field's value.

func (*CreateDetectorModelInput) SetDetectorModelDescription

func (s *CreateDetectorModelInput) SetDetectorModelDescription(v string) *CreateDetectorModelInput

SetDetectorModelDescription sets the DetectorModelDescription field's value.

func (*CreateDetectorModelInput) SetDetectorModelName

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

SetDetectorModelName sets the DetectorModelName field's value.

func (*CreateDetectorModelInput) SetEvaluationMethod

func (s *CreateDetectorModelInput) SetEvaluationMethod(v string) *CreateDetectorModelInput

SetEvaluationMethod sets the EvaluationMethod field's value.

func (*CreateDetectorModelInput) SetKey

SetKey sets the Key field's value.

func (*CreateDetectorModelInput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*CreateDetectorModelInput) SetTags

SetTags sets the Tags field's value.

func (CreateDetectorModelInput) String

func (s CreateDetectorModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s CreateDetectorModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDetectorModelOutput) SetDetectorModelConfiguration

SetDetectorModelConfiguration sets the DetectorModelConfiguration field's value.

func (CreateDetectorModelOutput) String

func (s CreateDetectorModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s CreateInputInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateInputInput) SetInputDefinition

func (s *CreateInputInput) SetInputDefinition(v *InputDefinition) *CreateInputInput

SetInputDefinition sets the InputDefinition field's value.

func (*CreateInputInput) SetInputDescription

func (s *CreateInputInput) SetInputDescription(v string) *CreateInputInput

SetInputDescription sets the InputDescription field's value.

func (*CreateInputInput) SetInputName

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

SetInputName sets the InputName field's value.

func (*CreateInputInput) SetTags

func (s *CreateInputInput) SetTags(v []*Tag) *CreateInputInput

SetTags sets the Tags field's value.

func (CreateInputInput) String

func (s CreateInputInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s CreateInputOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateInputOutput) SetInputConfiguration

func (s *CreateInputOutput) SetInputConfiguration(v *InputConfiguration) *CreateInputOutput

SetInputConfiguration sets the InputConfiguration field's value.

func (CreateInputOutput) String

func (s CreateInputOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAlarmModelInput

type DeleteAlarmModelInput struct {

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

func (DeleteAlarmModelInput) GoString

func (s DeleteAlarmModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAlarmModelInput) SetAlarmModelName

func (s *DeleteAlarmModelInput) SetAlarmModelName(v string) *DeleteAlarmModelInput

SetAlarmModelName sets the AlarmModelName field's value.

func (DeleteAlarmModelInput) String

func (s DeleteAlarmModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAlarmModelInput) Validate

func (s *DeleteAlarmModelInput) Validate() error

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

type DeleteAlarmModelOutput

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

func (DeleteAlarmModelOutput) GoString

func (s DeleteAlarmModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAlarmModelOutput) String

func (s DeleteAlarmModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteDetectorModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDetectorModelInput) SetDetectorModelName

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

SetDetectorModelName sets the DetectorModelName field's value.

func (DeleteDetectorModelInput) String

func (s DeleteDetectorModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteDetectorModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDetectorModelOutput) String

func (s DeleteDetectorModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteInputInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInputInput) SetInputName

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

SetInputName sets the InputName field's value.

func (DeleteInputInput) String

func (s DeleteInputInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DeleteInputOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteInputOutput) String

func (s DeleteInputOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAlarmModelInput

type DescribeAlarmModelInput struct {

	// The name of the alarm model.
	//
	// AlarmModelName is a required field
	AlarmModelName *string `location:"uri" locationName:"alarmModelName" min:"1" type:"string" required:"true"`

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

func (DescribeAlarmModelInput) GoString

func (s DescribeAlarmModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAlarmModelInput) SetAlarmModelName

func (s *DescribeAlarmModelInput) SetAlarmModelName(v string) *DescribeAlarmModelInput

SetAlarmModelName sets the AlarmModelName field's value.

func (*DescribeAlarmModelInput) SetAlarmModelVersion

func (s *DescribeAlarmModelInput) SetAlarmModelVersion(v string) *DescribeAlarmModelInput

SetAlarmModelVersion sets the AlarmModelVersion field's value.

func (DescribeAlarmModelInput) String

func (s DescribeAlarmModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAlarmModelInput) Validate

func (s *DescribeAlarmModelInput) Validate() error

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

type DescribeAlarmModelOutput

type DescribeAlarmModelOutput struct {

	// Contains the configuration information of alarm state changes.
	AlarmCapabilities *AlarmCapabilities `locationName:"alarmCapabilities" type:"structure"`

	// Contains information about one or more alarm actions.
	AlarmEventActions *AlarmEventActions `locationName:"alarmEventActions" type:"structure"`

	// The ARN of the alarm model. For more information, see Amazon Resource Names
	// (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the AWS General Reference.
	AlarmModelArn *string `locationName:"alarmModelArn" type:"string"`

	// The description of the alarm model.
	AlarmModelDescription *string `locationName:"alarmModelDescription" type:"string"`

	// The name of the alarm model.
	AlarmModelName *string `locationName:"alarmModelName" min:"1" type:"string"`

	// The version of the alarm model.
	AlarmModelVersion *string `locationName:"alarmModelVersion" min:"1" type:"string"`

	// Contains information about one or more notification actions.
	AlarmNotification *AlarmNotification `locationName:"alarmNotification" type:"structure"`

	// Defines when your alarm is invoked.
	AlarmRule *AlarmRule `locationName:"alarmRule" type:"structure"`

	// The time the alarm model was created, in the Unix epoch format.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// An input attribute used as a key to create an alarm. AWS IoT Events routes
	// inputs (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html)
	// associated with this key to the alarm.
	Key *string `locationName:"key" min:"1" type:"string"`

	// The time the alarm model was last updated, in the Unix epoch format.
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`

	// The ARN of the IAM role that allows the alarm to perform actions and access
	// AWS resources. For more information, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the AWS General Reference.
	RoleArn *string `locationName:"roleArn" min:"1" type:"string"`

	// A non-negative integer that reflects the severity level of the alarm.
	Severity *int64 `locationName:"severity" type:"integer"`

	// The status of the alarm model. The status can be one of the following values:
	//
	//    * ACTIVE - The alarm model is active and it's ready to evaluate data.
	//
	//    * ACTIVATING - AWS IoT Events is activating your alarm model. Activating
	//    an alarm model can take up to a few minutes.
	//
	//    * INACTIVE - The alarm model is inactive, so it isn't ready to evaluate
	//    data. Check your alarm model information and update the alarm model.
	//
	//    * FAILED - You couldn't create or update the alarm model. Check your alarm
	//    model information and try again.
	Status *string `locationName:"status" type:"string" enum:"AlarmModelVersionStatus"`

	// Contains information about the status of the alarm model.
	StatusMessage *string `locationName:"statusMessage" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAlarmModelOutput) GoString

func (s DescribeAlarmModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAlarmModelOutput) SetAlarmCapabilities

SetAlarmCapabilities sets the AlarmCapabilities field's value.

func (*DescribeAlarmModelOutput) SetAlarmEventActions

SetAlarmEventActions sets the AlarmEventActions field's value.

func (*DescribeAlarmModelOutput) SetAlarmModelArn

SetAlarmModelArn sets the AlarmModelArn field's value.

func (*DescribeAlarmModelOutput) SetAlarmModelDescription

func (s *DescribeAlarmModelOutput) SetAlarmModelDescription(v string) *DescribeAlarmModelOutput

SetAlarmModelDescription sets the AlarmModelDescription field's value.

func (*DescribeAlarmModelOutput) SetAlarmModelName

func (s *DescribeAlarmModelOutput) SetAlarmModelName(v string) *DescribeAlarmModelOutput

SetAlarmModelName sets the AlarmModelName field's value.

func (*DescribeAlarmModelOutput) SetAlarmModelVersion

func (s *DescribeAlarmModelOutput) SetAlarmModelVersion(v string) *DescribeAlarmModelOutput

SetAlarmModelVersion sets the AlarmModelVersion field's value.

func (*DescribeAlarmModelOutput) SetAlarmNotification

SetAlarmNotification sets the AlarmNotification field's value.

func (*DescribeAlarmModelOutput) SetAlarmRule

SetAlarmRule sets the AlarmRule field's value.

func (*DescribeAlarmModelOutput) SetCreationTime

SetCreationTime sets the CreationTime field's value.

func (*DescribeAlarmModelOutput) SetKey

SetKey sets the Key field's value.

func (*DescribeAlarmModelOutput) SetLastUpdateTime

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*DescribeAlarmModelOutput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*DescribeAlarmModelOutput) SetSeverity

SetSeverity sets the Severity field's value.

func (*DescribeAlarmModelOutput) SetStatus

SetStatus sets the Status field's value.

func (*DescribeAlarmModelOutput) SetStatusMessage

SetStatusMessage sets the StatusMessage field's value.

func (DescribeAlarmModelOutput) String

func (s DescribeAlarmModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDetectorModelAnalysisInput

type DescribeDetectorModelAnalysisInput struct {

	// The ID of the analysis result that you want to retrieve.
	//
	// AnalysisId is a required field
	AnalysisId *string `location:"uri" locationName:"analysisId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDetectorModelAnalysisInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDetectorModelAnalysisInput) SetAnalysisId

SetAnalysisId sets the AnalysisId field's value.

func (DescribeDetectorModelAnalysisInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDetectorModelAnalysisInput) Validate

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

type DescribeDetectorModelAnalysisOutput

type DescribeDetectorModelAnalysisOutput struct {

	// The status of the analysis activity. The status can be one of the following
	// values:
	//
	//    * RUNNING - AWS IoT Events is analyzing your detector model. This process
	//    can take several minutes to complete.
	//
	//    * COMPLETE - AWS IoT Events finished analyzing your detector model.
	//
	//    * FAILED - AWS IoT Events couldn't analyze your detector model. Try again
	//    later.
	Status *string `locationName:"status" type:"string" enum:"AnalysisStatus"`
	// contains filtered or unexported fields
}

func (DescribeDetectorModelAnalysisOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDetectorModelAnalysisOutput) SetStatus

SetStatus sets the Status field's value.

func (DescribeDetectorModelAnalysisOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DescribeDetectorModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDetectorModelInput) SetDetectorModelName

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

SetDetectorModelName sets the DetectorModelName field's value.

func (*DescribeDetectorModelInput) SetDetectorModelVersion

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

SetDetectorModelVersion sets the DetectorModelVersion field's value.

func (DescribeDetectorModelInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DescribeDetectorModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDetectorModelOutput) SetDetectorModel

SetDetectorModel sets the DetectorModel field's value.

func (DescribeDetectorModelOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DescribeInputInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInputInput) SetInputName

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

SetInputName sets the InputName field's value.

func (DescribeInputInput) String

func (s DescribeInputInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DescribeInputOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeInputOutput) SetInput

SetInput sets the Input field's value.

func (DescribeInputOutput) String

func (s DescribeInputOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLoggingOptionsInput

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

func (DescribeLoggingOptionsInput) GoString

func (s DescribeLoggingOptionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeLoggingOptionsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DescribeLoggingOptionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLoggingOptionsOutput) SetLoggingOptions

SetLoggingOptions sets the LoggingOptions field's value.

func (DescribeLoggingOptionsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DetectorDebugOption) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectorDebugOption) SetDetectorModelName

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

SetDetectorModelName sets the DetectorModelName field's value.

func (*DetectorDebugOption) SetKeyValue

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

SetKeyValue sets the KeyValue field's value.

func (DetectorDebugOption) String

func (s DetectorDebugOption) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DetectorModel) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectorModel) SetDetectorModelConfiguration

func (s *DetectorModel) SetDetectorModelConfiguration(v *DetectorModelConfiguration) *DetectorModel

SetDetectorModelConfiguration sets the DetectorModelConfiguration field's value.

func (*DetectorModel) SetDetectorModelDefinition

func (s *DetectorModel) SetDetectorModelDefinition(v *DetectorModelDefinition) *DetectorModel

SetDetectorModelDefinition sets the DetectorModelDefinition field's value.

func (DetectorModel) String

func (s DetectorModel) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `locationName:"evaluationMethod" type:"string" enum:"EvaluationMethod"`

	// The value used to identify a detector instance. When a device or system sends
	// input, a new detector instance with a unique key value is created. AWS IoT
	// Events can continue to route input to its corresponding detector instance
	// based on this identifying information.
	//
	// This parameter uses a JSON-path expression to select the attribute-value
	// pair in the message payload that is used for identification. To route the
	// message to the correct detector instance, the device must send a message
	// payload that contains the same attribute-value.
	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 *string `locationName:"status" type:"string" enum:"DetectorModelVersionStatus"`
	// contains filtered or unexported fields
}

Information about how the detector model is configured.

func (DetectorModelConfiguration) GoString

func (s DetectorModelConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectorModelConfiguration) SetCreationTime

SetCreationTime sets the CreationTime field's value.

func (*DetectorModelConfiguration) SetDetectorModelArn

SetDetectorModelArn sets the DetectorModelArn field's value.

func (*DetectorModelConfiguration) SetDetectorModelDescription

func (s *DetectorModelConfiguration) SetDetectorModelDescription(v string) *DetectorModelConfiguration

SetDetectorModelDescription sets the DetectorModelDescription field's value.

func (*DetectorModelConfiguration) SetDetectorModelName

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

SetDetectorModelName sets the DetectorModelName field's value.

func (*DetectorModelConfiguration) SetDetectorModelVersion

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

SetDetectorModelVersion sets the DetectorModelVersion field's value.

func (*DetectorModelConfiguration) SetEvaluationMethod

SetEvaluationMethod sets the EvaluationMethod field's value.

func (*DetectorModelConfiguration) SetKey

SetKey sets the Key field's value.

func (*DetectorModelConfiguration) SetLastUpdateTime

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*DetectorModelConfiguration) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*DetectorModelConfiguration) SetStatus

SetStatus sets the Status field's value.

func (DetectorModelConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DetectorModelDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectorModelDefinition) SetInitialStateName

func (s *DetectorModelDefinition) SetInitialStateName(v string) *DetectorModelDefinition

SetInitialStateName sets the InitialStateName field's value.

func (*DetectorModelDefinition) SetStates

SetStates sets the States field's value.

func (DetectorModelDefinition) String

func (s DetectorModelDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s DetectorModelSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectorModelSummary) SetCreationTime

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

SetCreationTime sets the CreationTime field's value.

func (*DetectorModelSummary) SetDetectorModelDescription

func (s *DetectorModelSummary) SetDetectorModelDescription(v string) *DetectorModelSummary

SetDetectorModelDescription sets the DetectorModelDescription field's value.

func (*DetectorModelSummary) SetDetectorModelName

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

SetDetectorModelName sets the DetectorModelName field's value.

func (DetectorModelSummary) String

func (s DetectorModelSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `locationName:"evaluationMethod" type:"string" enum:"EvaluationMethod"`

	// 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 *string `locationName:"status" type:"string" enum:"DetectorModelVersionStatus"`
	// contains filtered or unexported fields
}

Information about the detector model version.

func (DetectorModelVersionSummary) GoString

func (s DetectorModelVersionSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectorModelVersionSummary) SetCreationTime

SetCreationTime sets the CreationTime field's value.

func (*DetectorModelVersionSummary) SetDetectorModelArn

SetDetectorModelArn sets the DetectorModelArn field's value.

func (*DetectorModelVersionSummary) SetDetectorModelName

SetDetectorModelName sets the DetectorModelName field's value.

func (*DetectorModelVersionSummary) SetDetectorModelVersion

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

SetDetectorModelVersion sets the DetectorModelVersion field's value.

func (*DetectorModelVersionSummary) SetEvaluationMethod

SetEvaluationMethod sets the EvaluationMethod field's value.

func (*DetectorModelVersionSummary) SetLastUpdateTime

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*DetectorModelVersionSummary) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*DetectorModelVersionSummary) SetStatus

SetStatus sets the Status field's value.

func (DetectorModelVersionSummary) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DynamoDBAction

type DynamoDBAction struct {

	// The name of the hash key (also called the partition key). The hashKeyField
	// value must match the partition key of the target DynamoDB table.
	//
	// HashKeyField is a required field
	HashKeyField *string `locationName:"hashKeyField" type:"string" required:"true"`

	// The data type for the hash key (also called the partition key). You can specify
	// the following values:
	//
	//    * 'STRING' - The hash key is a string.
	//
	//    * 'NUMBER' - The hash key is a number.
	//
	// If you don't specify hashKeyType, the default value is 'STRING'.
	HashKeyType *string `locationName:"hashKeyType" type:"string"`

	// The value of the hash key (also called the partition key).
	//
	// HashKeyValue is a required field
	HashKeyValue *string `locationName:"hashKeyValue" type:"string" required:"true"`

	// The type of operation to perform. You can specify the following values:
	//
	//    * 'INSERT' - Insert data as a new item into the DynamoDB table. This item
	//    uses the specified hash key as a partition key. If you specified a range
	//    key, the item uses the range key as a sort key.
	//
	//    * 'UPDATE' - Update an existing item of the DynamoDB table with new data.
	//    This item's partition key must match the specified hash key. If you specified
	//    a range key, the range key must match the item's sort key.
	//
	//    * 'DELETE' - Delete an existing item of the DynamoDB table. This item's
	//    partition key must match the specified hash key. If you specified a range
	//    key, the range key must match the item's sort key.
	//
	// If you don't specify this parameter, AWS IoT Events triggers the 'INSERT'
	// operation.
	Operation *string `locationName:"operation" type:"string"`

	// Information needed to configure the payload.
	//
	// By default, AWS IoT Events generates a standard payload in JSON for any action.
	// This action payload contains all attribute-value pairs that have the information
	// about the detector model instance and the event triggered the action. To
	// configure the action payload, you can use contentExpression.
	Payload *Payload `locationName:"payload" type:"structure"`

	// The name of the DynamoDB column that receives the action payload.
	//
	// If you don't specify this parameter, the name of the DynamoDB column is payload.
	PayloadField *string `locationName:"payloadField" type:"string"`

	// The name of the range key (also called the sort key). The rangeKeyField value
	// must match the sort key of the target DynamoDB table.
	RangeKeyField *string `locationName:"rangeKeyField" type:"string"`

	// The data type for the range key (also called the sort key), You can specify
	// the following values:
	//
	//    * 'STRING' - The range key is a string.
	//
	//    * 'NUMBER' - The range key is number.
	//
	// If you don't specify rangeKeyField, the default value is 'STRING'.
	RangeKeyType *string `locationName:"rangeKeyType" type:"string"`

	// The value of the range key (also called the sort key).
	RangeKeyValue *string `locationName:"rangeKeyValue" type:"string"`

	// The name of the DynamoDB table. The tableName value must match the table
	// name of the target DynamoDB table.
	//
	// TableName is a required field
	TableName *string `locationName:"tableName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

You must use expressions for all parameters in DynamoDBAction. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the hashKeyType parameter can be 'STRING'.

  • For references, you must specify either variables or input values. For example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the hashKeyValue parameter uses a substitution template. '${$input.GreenhouseInput.temperature * 6 / 5

  • 32} in Fahrenheit'

  • For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the tableName parameter uses a string concatenation. 'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the AWS IoT Events Developer Guide.

If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the payloadField parameter is <payload-field>_raw.

func (DynamoDBAction) GoString

func (s DynamoDBAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DynamoDBAction) SetHashKeyField

func (s *DynamoDBAction) SetHashKeyField(v string) *DynamoDBAction

SetHashKeyField sets the HashKeyField field's value.

func (*DynamoDBAction) SetHashKeyType

func (s *DynamoDBAction) SetHashKeyType(v string) *DynamoDBAction

SetHashKeyType sets the HashKeyType field's value.

func (*DynamoDBAction) SetHashKeyValue

func (s *DynamoDBAction) SetHashKeyValue(v string) *DynamoDBAction

SetHashKeyValue sets the HashKeyValue field's value.

func (*DynamoDBAction) SetOperation

func (s *DynamoDBAction) SetOperation(v string) *DynamoDBAction

SetOperation sets the Operation field's value.

func (*DynamoDBAction) SetPayload

func (s *DynamoDBAction) SetPayload(v *Payload) *DynamoDBAction

SetPayload sets the Payload field's value.

func (*DynamoDBAction) SetPayloadField

func (s *DynamoDBAction) SetPayloadField(v string) *DynamoDBAction

SetPayloadField sets the PayloadField field's value.

func (*DynamoDBAction) SetRangeKeyField

func (s *DynamoDBAction) SetRangeKeyField(v string) *DynamoDBAction

SetRangeKeyField sets the RangeKeyField field's value.

func (*DynamoDBAction) SetRangeKeyType

func (s *DynamoDBAction) SetRangeKeyType(v string) *DynamoDBAction

SetRangeKeyType sets the RangeKeyType field's value.

func (*DynamoDBAction) SetRangeKeyValue

func (s *DynamoDBAction) SetRangeKeyValue(v string) *DynamoDBAction

SetRangeKeyValue sets the RangeKeyValue field's value.

func (*DynamoDBAction) SetTableName

func (s *DynamoDBAction) SetTableName(v string) *DynamoDBAction

SetTableName sets the TableName field's value.

func (DynamoDBAction) String

func (s DynamoDBAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DynamoDBAction) Validate

func (s *DynamoDBAction) Validate() error

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

type DynamoDBv2Action

type DynamoDBv2Action struct {

	// Information needed to configure the payload.
	//
	// By default, AWS IoT Events generates a standard payload in JSON for any action.
	// This action payload contains all attribute-value pairs that have the information
	// about the detector model instance and the event triggered the action. To
	// configure the action payload, you can use contentExpression.
	Payload *Payload `locationName:"payload" type:"structure"`

	// The name of the DynamoDB table.
	//
	// TableName is a required field
	TableName *string `locationName:"tableName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.

You must use expressions for all parameters in DynamoDBv2Action. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the tableName parameter can be 'GreenhouseTemperatureTable'.

  • For references, you must specify either variables or input values. For example, the value for the tableName parameter can be $variable.ddbtableName.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the contentExpression parameter in Payload uses a substitution template. '{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'

  • For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the tableName parameter uses a string concatenation. 'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the AWS IoT Events Developer Guide.

The value for the type parameter in Payload must be JSON.

func (DynamoDBv2Action) GoString

func (s DynamoDBv2Action) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DynamoDBv2Action) SetPayload

func (s *DynamoDBv2Action) SetPayload(v *Payload) *DynamoDBv2Action

SetPayload sets the Payload field's value.

func (*DynamoDBv2Action) SetTableName

func (s *DynamoDBv2Action) SetTableName(v string) *DynamoDBv2Action

SetTableName sets the TableName field's value.

func (DynamoDBv2Action) String

func (s DynamoDBv2Action) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DynamoDBv2Action) Validate

func (s *DynamoDBv2Action) Validate() error

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

type EmailConfiguration

type EmailConfiguration struct {

	// Contains the subject and message of an email.
	Content *EmailContent `locationName:"content" type:"structure"`

	// The email address that sends emails.
	//
	// If you use the AWS IoT Events managed AWS Lambda function to manage your
	// emails, you must verify the email address that sends emails in Amazon SES
	// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html).
	//
	// From is a required field
	From *string `locationName:"from" type:"string" required:"true"`

	// Contains the information of one or more recipients who receive the emails.
	//
	// You must add the users that receive emails to your AWS SSO store (https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html).
	//
	// Recipients is a required field
	Recipients *EmailRecipients `locationName:"recipients" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains the configuration information of email notifications.

func (EmailConfiguration) GoString

func (s EmailConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EmailConfiguration) SetContent

SetContent sets the Content field's value.

func (*EmailConfiguration) SetFrom

SetFrom sets the From field's value.

func (*EmailConfiguration) SetRecipients

SetRecipients sets the Recipients field's value.

func (EmailConfiguration) String

func (s EmailConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EmailConfiguration) Validate

func (s *EmailConfiguration) Validate() error

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

type EmailContent

type EmailContent struct {

	// The message that you want to send. The message can be up to 200 characters.
	AdditionalMessage *string `locationName:"additionalMessage" type:"string"`

	// The subject of the email.
	Subject *string `locationName:"subject" type:"string"`
	// contains filtered or unexported fields
}

Contains the subject and message of an email.

func (EmailContent) GoString

func (s EmailContent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EmailContent) SetAdditionalMessage

func (s *EmailContent) SetAdditionalMessage(v string) *EmailContent

SetAdditionalMessage sets the AdditionalMessage field's value.

func (*EmailContent) SetSubject

func (s *EmailContent) SetSubject(v string) *EmailContent

SetSubject sets the Subject field's value.

func (EmailContent) String

func (s EmailContent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EmailRecipients

type EmailRecipients struct {

	// Specifies one or more recipients who receive the email.
	To []*RecipientDetail `locationName:"to" min:"1" type:"list"`
	// contains filtered or unexported fields
}

Contains the information of one or more recipients who receive the emails.

You must add the users that receive emails to your AWS SSO store (https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html).

func (EmailRecipients) GoString

func (s EmailRecipients) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EmailRecipients) SetTo

SetTo sets the To field's value.

func (EmailRecipients) String

func (s EmailRecipients) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EmailRecipients) Validate

func (s *EmailRecipients) Validate() error

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

type Event

type Event struct {

	// The actions to be performed.
	Actions []*ActionData `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) GoString

func (s Event) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Event) SetActions

func (s *Event) SetActions(v []*ActionData) *Event

SetActions sets the Actions field's value.

func (*Event) SetCondition

func (s *Event) SetCondition(v string) *Event

SetCondition sets the Condition field's value.

func (*Event) SetEventName

func (s *Event) SetEventName(v string) *Event

SetEventName sets the EventName field's value.

func (Event) String

func (s Event) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// You can configure the action payload when you send a message to an Amazon
	// Kinesis Data Firehose delivery stream.
	Payload *Payload `locationName:"payload" type:"structure"`

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

func (s FirehoseAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FirehoseAction) SetDeliveryStreamName

func (s *FirehoseAction) SetDeliveryStreamName(v string) *FirehoseAction

SetDeliveryStreamName sets the DeliveryStreamName field's value.

func (*FirehoseAction) SetPayload

func (s *FirehoseAction) SetPayload(v *Payload) *FirehoseAction

SetPayload sets the Payload field's value.

func (*FirehoseAction) SetSeparator

func (s *FirehoseAction) SetSeparator(v string) *FirehoseAction

SetSeparator sets the Separator field's value.

func (FirehoseAction) String

func (s FirehoseAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FirehoseAction) Validate

func (s *FirehoseAction) Validate() error

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

type GetDetectorModelAnalysisResultsInput

type GetDetectorModelAnalysisResultsInput struct {

	// The ID of the analysis result that you want to retrieve.
	//
	// AnalysisId is a required field
	AnalysisId *string `location:"uri" locationName:"analysisId" type:"string" required:"true"`

	// The maximum number of results to be returned per request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// The token that you can use to return the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetDetectorModelAnalysisResultsInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDetectorModelAnalysisResultsInput) SetAnalysisId

SetAnalysisId sets the AnalysisId field's value.

func (*GetDetectorModelAnalysisResultsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*GetDetectorModelAnalysisResultsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (GetDetectorModelAnalysisResultsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDetectorModelAnalysisResultsInput) Validate

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

type GetDetectorModelAnalysisResultsOutput

type GetDetectorModelAnalysisResultsOutput struct {

	// Contains information about one or more analysis results.
	AnalysisResults []*AnalysisResult `locationName:"analysisResults" type:"list"`

	// The token that you can use to return the next set of results, or null if
	// there are no more results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetDetectorModelAnalysisResultsOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDetectorModelAnalysisResultsOutput) SetAnalysisResults

SetAnalysisResults sets the AnalysisResults field's value.

func (*GetDetectorModelAnalysisResultsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (GetDetectorModelAnalysisResultsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InitializationConfiguration

type InitializationConfiguration struct {

	// The value must be TRUE or FALSE. If FALSE, all alarm instances created based
	// on the alarm model are activated. The default value is TRUE.
	//
	// DisabledOnInitialization is a required field
	DisabledOnInitialization *bool `locationName:"disabledOnInitialization" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.

func (InitializationConfiguration) GoString

func (s InitializationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InitializationConfiguration) SetDisabledOnInitialization

func (s *InitializationConfiguration) SetDisabledOnInitialization(v bool) *InitializationConfiguration

SetDisabledOnInitialization sets the DisabledOnInitialization field's value.

func (InitializationConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InitializationConfiguration) Validate

func (s *InitializationConfiguration) 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) GoString

func (s Input) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Input) SetInputConfiguration

func (s *Input) SetInputConfiguration(v *InputConfiguration) *Input

SetInputConfiguration sets the InputConfiguration field's value.

func (*Input) SetInputDefinition

func (s *Input) SetInputDefinition(v *InputDefinition) *Input

SetInputDefinition sets the InputDefinition field's value.

func (Input) String

func (s Input) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `locationName:"status" type:"string" required:"true" enum:"InputStatus"`
	// contains filtered or unexported fields
}

Information about the configuration of an input.

func (InputConfiguration) GoString

func (s InputConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputConfiguration) SetCreationTime

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

SetCreationTime sets the CreationTime field's value.

func (*InputConfiguration) SetInputArn

func (s *InputConfiguration) SetInputArn(v string) *InputConfiguration

SetInputArn sets the InputArn field's value.

func (*InputConfiguration) SetInputDescription

func (s *InputConfiguration) SetInputDescription(v string) *InputConfiguration

SetInputDescription sets the InputDescription field's value.

func (*InputConfiguration) SetInputName

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

SetInputName sets the InputName field's value.

func (*InputConfiguration) SetLastUpdateTime

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

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*InputConfiguration) SetStatus

func (s *InputConfiguration) SetStatus(v string) *InputConfiguration

SetStatus sets the Status field's value.

func (InputConfiguration) String

func (s InputConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s InputDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputDefinition) SetAttributes

func (s *InputDefinition) SetAttributes(v []*Attribute) *InputDefinition

SetAttributes sets the Attributes field's value.

func (InputDefinition) String

func (s InputDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputDefinition) Validate

func (s *InputDefinition) Validate() error

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

type InputIdentifier

type InputIdentifier struct {

	// The identifier of the input routed to AWS IoT Events.
	IotEventsInputIdentifier *IotEventsInputIdentifier `locationName:"iotEventsInputIdentifier" type:"structure"`

	// The identifer of the input routed from AWS IoT SiteWise.
	IotSiteWiseInputIdentifier *IotSiteWiseInputIdentifier `locationName:"iotSiteWiseInputIdentifier" type:"structure"`
	// contains filtered or unexported fields
}

The identifer of the input.

func (InputIdentifier) GoString

func (s InputIdentifier) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputIdentifier) SetIotEventsInputIdentifier

func (s *InputIdentifier) SetIotEventsInputIdentifier(v *IotEventsInputIdentifier) *InputIdentifier

SetIotEventsInputIdentifier sets the IotEventsInputIdentifier field's value.

func (*InputIdentifier) SetIotSiteWiseInputIdentifier

func (s *InputIdentifier) SetIotSiteWiseInputIdentifier(v *IotSiteWiseInputIdentifier) *InputIdentifier

SetIotSiteWiseInputIdentifier sets the IotSiteWiseInputIdentifier field's value.

func (InputIdentifier) String

func (s InputIdentifier) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputIdentifier) Validate

func (s *InputIdentifier) Validate() error

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

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 *string `locationName:"status" type:"string" enum:"InputStatus"`
	// contains filtered or unexported fields
}

Information about the input.

func (InputSummary) GoString

func (s InputSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputSummary) SetCreationTime

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

SetCreationTime sets the CreationTime field's value.

func (*InputSummary) SetInputArn

func (s *InputSummary) SetInputArn(v string) *InputSummary

SetInputArn sets the InputArn field's value.

func (*InputSummary) SetInputDescription

func (s *InputSummary) SetInputDescription(v string) *InputSummary

SetInputDescription sets the InputDescription field's value.

func (*InputSummary) SetInputName

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

SetInputName sets the InputName field's value.

func (*InputSummary) SetLastUpdateTime

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

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*InputSummary) SetStatus

func (s *InputSummary) SetStatus(v string) *InputSummary

SetStatus sets the Status field's value.

func (InputSummary) String

func (s InputSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalFailureException

type InternalFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An internal failure occurred.

func (*InternalFailureException) Code

func (s *InternalFailureException) Code() string

Code returns the exception type name.

func (*InternalFailureException) Error

func (s *InternalFailureException) Error() string

func (InternalFailureException) GoString

func (s InternalFailureException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalFailureException) Message

func (s *InternalFailureException) Message() string

Message returns the exception's message.

func (*InternalFailureException) OrigErr

func (s *InternalFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalFailureException) RequestID

func (s *InternalFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailureException) StatusCode

func (s *InternalFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalFailureException) String

func (s InternalFailureException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidRequestException

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request was invalid.

func (*InvalidRequestException) Code

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString

func (s InvalidRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRequestException) Message

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String

func (s InvalidRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IoTEvents

type IoTEvents struct {
	*client.Client
}

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

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

func New

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

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

Example:

mySession := session.Must(session.NewSession())

// Create a IoTEvents client from just a session.
svc := iotevents.New(mySession)

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

func (*IoTEvents) CreateAlarmModel

func (c *IoTEvents) CreateAlarmModel(input *CreateAlarmModelInput) (*CreateAlarmModelOutput, error)

CreateAlarmModel API operation for AWS IoT Events.

Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model (https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html) in the AWS IoT Events Developer Guide.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceInUseException The resource is in use.

  • ResourceAlreadyExistsException The resource already exists.

  • LimitExceededException A limit was exceeded.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/CreateAlarmModel

func (*IoTEvents) CreateAlarmModelRequest

func (c *IoTEvents) CreateAlarmModelRequest(input *CreateAlarmModelInput) (req *request.Request, output *CreateAlarmModelOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/CreateAlarmModel

func (*IoTEvents) CreateAlarmModelWithContext

func (c *IoTEvents) CreateAlarmModelWithContext(ctx aws.Context, input *CreateAlarmModelInput, opts ...request.Option) (*CreateAlarmModelOutput, error)

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

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

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

func (*IoTEvents) CreateDetectorModel

func (c *IoTEvents) CreateDetectorModel(input *CreateDetectorModelInput) (*CreateDetectorModelOutput, error)

CreateDetectorModel API operation for AWS IoT Events.

Creates a detector model.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceInUseException The resource is in use.

  • ResourceAlreadyExistsException The resource already exists.

  • LimitExceededException A limit was exceeded.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

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

func (*IoTEvents) CreateDetectorModelRequest

func (c *IoTEvents) CreateDetectorModelRequest(input *CreateDetectorModelInput) (req *request.Request, output *CreateDetectorModelOutput)

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

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

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

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

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

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

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

func (*IoTEvents) CreateDetectorModelWithContext

func (c *IoTEvents) CreateDetectorModelWithContext(ctx aws.Context, input *CreateDetectorModelInput, opts ...request.Option) (*CreateDetectorModelOutput, error)

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

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

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

func (*IoTEvents) CreateInput

func (c *IoTEvents) CreateInput(input *CreateInputInput) (*CreateInputOutput, error)

CreateInput API operation for AWS IoT Events.

Creates an input.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

  • ResourceAlreadyExistsException The resource already exists.

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

func (*IoTEvents) CreateInputRequest

func (c *IoTEvents) CreateInputRequest(input *CreateInputInput) (req *request.Request, output *CreateInputOutput)

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

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

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

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

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

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

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

func (*IoTEvents) CreateInputWithContext

func (c *IoTEvents) CreateInputWithContext(ctx aws.Context, input *CreateInputInput, opts ...request.Option) (*CreateInputOutput, error)

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

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

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

func (*IoTEvents) DeleteAlarmModel

func (c *IoTEvents) DeleteAlarmModel(input *DeleteAlarmModelInput) (*DeleteAlarmModelOutput, error)

DeleteAlarmModel API operation for AWS IoT Events.

Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceInUseException The resource is in use.

  • ResourceNotFoundException The resource was not found.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/DeleteAlarmModel

func (*IoTEvents) DeleteAlarmModelRequest

func (c *IoTEvents) DeleteAlarmModelRequest(input *DeleteAlarmModelInput) (req *request.Request, output *DeleteAlarmModelOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/DeleteAlarmModel

func (*IoTEvents) DeleteAlarmModelWithContext

func (c *IoTEvents) DeleteAlarmModelWithContext(ctx aws.Context, input *DeleteAlarmModelInput, opts ...request.Option) (*DeleteAlarmModelOutput, error)

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

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

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

func (*IoTEvents) DeleteDetectorModel

func (c *IoTEvents) DeleteDetectorModel(input *DeleteDetectorModelInput) (*DeleteDetectorModelOutput, error)

DeleteDetectorModel API operation for AWS IoT Events.

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

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceInUseException The resource is in use.

  • ResourceNotFoundException The resource was not found.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

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

func (*IoTEvents) DeleteDetectorModelRequest

func (c *IoTEvents) DeleteDetectorModelRequest(input *DeleteDetectorModelInput) (req *request.Request, output *DeleteDetectorModelOutput)

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

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

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

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

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

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

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

func (*IoTEvents) DeleteDetectorModelWithContext

func (c *IoTEvents) DeleteDetectorModelWithContext(ctx aws.Context, input *DeleteDetectorModelInput, opts ...request.Option) (*DeleteDetectorModelOutput, error)

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

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

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

func (*IoTEvents) DeleteInput

func (c *IoTEvents) DeleteInput(input *DeleteInputInput) (*DeleteInputOutput, error)

DeleteInput API operation for AWS IoT Events.

Deletes an input.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceNotFoundException The resource was not found.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

  • ResourceInUseException The resource is in use.

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

func (*IoTEvents) DeleteInputRequest

func (c *IoTEvents) DeleteInputRequest(input *DeleteInputInput) (req *request.Request, output *DeleteInputOutput)

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

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

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

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

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

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

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

func (*IoTEvents) DeleteInputWithContext

func (c *IoTEvents) DeleteInputWithContext(ctx aws.Context, input *DeleteInputInput, opts ...request.Option) (*DeleteInputOutput, error)

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

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

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

func (*IoTEvents) DescribeAlarmModel

func (c *IoTEvents) DescribeAlarmModel(input *DescribeAlarmModelInput) (*DescribeAlarmModelOutput, error)

DescribeAlarmModel API operation for AWS IoT Events.

Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion parameter, the latest version is returned.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceNotFoundException The resource was not found.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/DescribeAlarmModel

func (*IoTEvents) DescribeAlarmModelRequest

func (c *IoTEvents) DescribeAlarmModelRequest(input *DescribeAlarmModelInput) (req *request.Request, output *DescribeAlarmModelOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/DescribeAlarmModel

func (*IoTEvents) DescribeAlarmModelWithContext

func (c *IoTEvents) DescribeAlarmModelWithContext(ctx aws.Context, input *DescribeAlarmModelInput, opts ...request.Option) (*DescribeAlarmModelOutput, error)

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

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

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

func (*IoTEvents) DescribeDetectorModel

func (c *IoTEvents) DescribeDetectorModel(input *DescribeDetectorModelInput) (*DescribeDetectorModelOutput, error)

DescribeDetectorModel API operation for AWS IoT Events.

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

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceNotFoundException The resource was not found.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

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

func (*IoTEvents) DescribeDetectorModelAnalysis

func (c *IoTEvents) DescribeDetectorModelAnalysis(input *DescribeDetectorModelAnalysisInput) (*DescribeDetectorModelAnalysisOutput, error)

DescribeDetectorModelAnalysis API operation for AWS IoT Events.

Retrieves runtime information about a detector model analysis.

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceNotFoundException The resource was not found.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/DescribeDetectorModelAnalysis

func (*IoTEvents) DescribeDetectorModelAnalysisRequest

func (c *IoTEvents) DescribeDetectorModelAnalysisRequest(input *DescribeDetectorModelAnalysisInput) (req *request.Request, output *DescribeDetectorModelAnalysisOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/DescribeDetectorModelAnalysis

func (*IoTEvents) DescribeDetectorModelAnalysisWithContext

func (c *IoTEvents) DescribeDetectorModelAnalysisWithContext(ctx aws.Context, input *DescribeDetectorModelAnalysisInput, opts ...request.Option) (*DescribeDetectorModelAnalysisOutput, error)

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

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

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

func (*IoTEvents) DescribeDetectorModelRequest

func (c *IoTEvents) DescribeDetectorModelRequest(input *DescribeDetectorModelInput) (req *request.Request, output *DescribeDetectorModelOutput)

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

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

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

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

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

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

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

func (*IoTEvents) DescribeDetectorModelWithContext

func (c *IoTEvents) DescribeDetectorModelWithContext(ctx aws.Context, input *DescribeDetectorModelInput, opts ...request.Option) (*DescribeDetectorModelOutput, error)

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

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

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

func (*IoTEvents) DescribeInput

func (c *IoTEvents) DescribeInput(input *DescribeInputInput) (*DescribeInputOutput, error)

DescribeInput API operation for AWS IoT Events.

Describes an input.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceNotFoundException The resource was not found.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

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

func (*IoTEvents) DescribeInputRequest

func (c *IoTEvents) DescribeInputRequest(input *DescribeInputInput) (req *request.Request, output *DescribeInputOutput)

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

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

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

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

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

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

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

func (*IoTEvents) DescribeInputWithContext

func (c *IoTEvents) DescribeInputWithContext(ctx aws.Context, input *DescribeInputInput, opts ...request.Option) (*DescribeInputOutput, error)

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

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

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

func (*IoTEvents) DescribeLoggingOptions

func (c *IoTEvents) DescribeLoggingOptions(input *DescribeLoggingOptionsInput) (*DescribeLoggingOptionsOutput, error)

DescribeLoggingOptions API operation for AWS IoT Events.

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

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ResourceNotFoundException The resource was not found.

  • ServiceUnavailableException The service is currently unavailable.

  • UnsupportedOperationException The requested operation is not supported.

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

func (*IoTEvents) DescribeLoggingOptionsRequest

func (c *IoTEvents) DescribeLoggingOptionsRequest(input *DescribeLoggingOptionsInput) (req *request.Request, output *DescribeLoggingOptionsOutput)

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

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

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

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

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

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

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

func (*IoTEvents) DescribeLoggingOptionsWithContext

func (c *IoTEvents) DescribeLoggingOptionsWithContext(ctx aws.Context, input *DescribeLoggingOptionsInput, opts ...request.Option) (*DescribeLoggingOptionsOutput, error)

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

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

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

func (*IoTEvents) GetDetectorModelAnalysisResults

func (c *IoTEvents) GetDetectorModelAnalysisResults(input *GetDetectorModelAnalysisResultsInput) (*GetDetectorModelAnalysisResultsOutput, error)

GetDetectorModelAnalysisResults API operation for AWS IoT Events.

Retrieves one or more analysis results of the detector model.

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceNotFoundException The resource was not found.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/GetDetectorModelAnalysisResults

func (*IoTEvents) GetDetectorModelAnalysisResultsRequest

func (c *IoTEvents) GetDetectorModelAnalysisResultsRequest(input *GetDetectorModelAnalysisResultsInput) (req *request.Request, output *GetDetectorModelAnalysisResultsOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/GetDetectorModelAnalysisResults

func (*IoTEvents) GetDetectorModelAnalysisResultsWithContext

func (c *IoTEvents) GetDetectorModelAnalysisResultsWithContext(ctx aws.Context, input *GetDetectorModelAnalysisResultsInput, opts ...request.Option) (*GetDetectorModelAnalysisResultsOutput, error)

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

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

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

func (*IoTEvents) ListAlarmModelVersions

func (c *IoTEvents) ListAlarmModelVersions(input *ListAlarmModelVersionsInput) (*ListAlarmModelVersionsOutput, error)

ListAlarmModelVersions API operation for AWS IoT Events.

Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceNotFoundException The resource was not found.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/ListAlarmModelVersions

func (*IoTEvents) ListAlarmModelVersionsRequest

func (c *IoTEvents) ListAlarmModelVersionsRequest(input *ListAlarmModelVersionsInput) (req *request.Request, output *ListAlarmModelVersionsOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/ListAlarmModelVersions

func (*IoTEvents) ListAlarmModelVersionsWithContext

func (c *IoTEvents) ListAlarmModelVersionsWithContext(ctx aws.Context, input *ListAlarmModelVersionsInput, opts ...request.Option) (*ListAlarmModelVersionsOutput, error)

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

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

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

func (*IoTEvents) ListAlarmModels

func (c *IoTEvents) ListAlarmModels(input *ListAlarmModelsInput) (*ListAlarmModelsOutput, error)

ListAlarmModels API operation for AWS IoT Events.

Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/ListAlarmModels

func (*IoTEvents) ListAlarmModelsRequest

func (c *IoTEvents) ListAlarmModelsRequest(input *ListAlarmModelsInput) (req *request.Request, output *ListAlarmModelsOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/ListAlarmModels

func (*IoTEvents) ListAlarmModelsWithContext

func (c *IoTEvents) ListAlarmModelsWithContext(ctx aws.Context, input *ListAlarmModelsInput, opts ...request.Option) (*ListAlarmModelsOutput, error)

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

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

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

func (*IoTEvents) ListDetectorModelVersions

func (c *IoTEvents) ListDetectorModelVersions(input *ListDetectorModelVersionsInput) (*ListDetectorModelVersionsOutput, error)

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

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceNotFoundException The resource was not found.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

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

func (*IoTEvents) ListDetectorModelVersionsRequest

func (c *IoTEvents) ListDetectorModelVersionsRequest(input *ListDetectorModelVersionsInput) (req *request.Request, output *ListDetectorModelVersionsOutput)

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

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

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

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

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

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

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

func (*IoTEvents) ListDetectorModelVersionsWithContext

func (c *IoTEvents) ListDetectorModelVersionsWithContext(ctx aws.Context, input *ListDetectorModelVersionsInput, opts ...request.Option) (*ListDetectorModelVersionsOutput, error)

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

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

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

func (*IoTEvents) ListDetectorModels

func (c *IoTEvents) ListDetectorModels(input *ListDetectorModelsInput) (*ListDetectorModelsOutput, error)

ListDetectorModels API operation for AWS IoT Events.

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

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

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

func (*IoTEvents) ListDetectorModelsRequest

func (c *IoTEvents) ListDetectorModelsRequest(input *ListDetectorModelsInput) (req *request.Request, output *ListDetectorModelsOutput)

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

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

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

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

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

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

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

func (*IoTEvents) ListDetectorModelsWithContext

func (c *IoTEvents) ListDetectorModelsWithContext(ctx aws.Context, input *ListDetectorModelsInput, opts ...request.Option) (*ListDetectorModelsOutput, error)

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

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

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

func (*IoTEvents) ListInputRoutings

func (c *IoTEvents) ListInputRoutings(input *ListInputRoutingsInput) (*ListInputRoutingsOutput, error)

ListInputRoutings API operation for AWS IoT Events.

Lists one or more input routings.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

  • ResourceNotFoundException The resource was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/ListInputRoutings

func (*IoTEvents) ListInputRoutingsRequest

func (c *IoTEvents) ListInputRoutingsRequest(input *ListInputRoutingsInput) (req *request.Request, output *ListInputRoutingsOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/ListInputRoutings

func (*IoTEvents) ListInputRoutingsWithContext

func (c *IoTEvents) ListInputRoutingsWithContext(ctx aws.Context, input *ListInputRoutingsInput, opts ...request.Option) (*ListInputRoutingsOutput, error)

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

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

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

func (*IoTEvents) ListInputs

func (c *IoTEvents) ListInputs(input *ListInputsInput) (*ListInputsOutput, error)

ListInputs API operation for AWS IoT Events.

Lists the inputs you have created.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

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

func (*IoTEvents) ListInputsRequest

func (c *IoTEvents) ListInputsRequest(input *ListInputsInput) (req *request.Request, output *ListInputsOutput)

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

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

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

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

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

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

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

func (*IoTEvents) ListInputsWithContext

func (c *IoTEvents) ListInputsWithContext(ctx aws.Context, input *ListInputsInput, opts ...request.Option) (*ListInputsOutput, error)

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

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

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

func (*IoTEvents) ListTagsForResource

func (c *IoTEvents) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS IoT Events.

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

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceNotFoundException The resource was not found.

  • ResourceInUseException The resource is in use.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

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

func (*IoTEvents) ListTagsForResourceRequest

func (c *IoTEvents) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

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

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

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

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

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

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

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

func (*IoTEvents) ListTagsForResourceWithContext

func (c *IoTEvents) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

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

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

func (*IoTEvents) PutLoggingOptions

func (c *IoTEvents) PutLoggingOptions(input *PutLoggingOptionsInput) (*PutLoggingOptionsOutput, error)

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

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

  • UnsupportedOperationException The requested operation is not supported.

  • ResourceInUseException The resource is in use.

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

func (*IoTEvents) PutLoggingOptionsRequest

func (c *IoTEvents) PutLoggingOptionsRequest(input *PutLoggingOptionsInput) (req *request.Request, output *PutLoggingOptionsOutput)

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

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

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

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

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

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

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

func (*IoTEvents) PutLoggingOptionsWithContext

func (c *IoTEvents) PutLoggingOptionsWithContext(ctx aws.Context, input *PutLoggingOptionsInput, opts ...request.Option) (*PutLoggingOptionsOutput, error)

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

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

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

func (*IoTEvents) StartDetectorModelAnalysis

func (c *IoTEvents) StartDetectorModelAnalysis(input *StartDetectorModelAnalysisInput) (*StartDetectorModelAnalysisOutput, error)

StartDetectorModelAnalysis API operation for AWS IoT Events.

Performs an analysis of your detector model. For more information, see Troubleshooting a detector model (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html) in the AWS IoT Events Developer Guide.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • LimitExceededException A limit was exceeded.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/StartDetectorModelAnalysis

func (*IoTEvents) StartDetectorModelAnalysisRequest

func (c *IoTEvents) StartDetectorModelAnalysisRequest(input *StartDetectorModelAnalysisInput) (req *request.Request, output *StartDetectorModelAnalysisOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/StartDetectorModelAnalysis

func (*IoTEvents) StartDetectorModelAnalysisWithContext

func (c *IoTEvents) StartDetectorModelAnalysisWithContext(ctx aws.Context, input *StartDetectorModelAnalysisInput, opts ...request.Option) (*StartDetectorModelAnalysisOutput, error)

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

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

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

func (*IoTEvents) TagResource

func (c *IoTEvents) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

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

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceNotFoundException The resource was not found.

  • ResourceInUseException The resource is in use.

  • ThrottlingException The request could not be completed due to throttling.

  • LimitExceededException A limit was exceeded.

  • InternalFailureException An internal failure occurred.

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

func (*IoTEvents) TagResourceRequest

func (c *IoTEvents) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

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

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

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

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

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

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

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

func (*IoTEvents) TagResourceWithContext

func (c *IoTEvents) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

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

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

func (*IoTEvents) UntagResource

func (c *IoTEvents) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS IoT Events.

Removes the given tags (metadata) from the resource.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceNotFoundException The resource was not found.

  • ResourceInUseException The resource is in use.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

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

func (*IoTEvents) UntagResourceRequest

func (c *IoTEvents) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

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

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

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

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

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

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

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

func (*IoTEvents) UntagResourceWithContext

func (c *IoTEvents) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

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

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

func (*IoTEvents) UpdateAlarmModel

func (c *IoTEvents) UpdateAlarmModel(input *UpdateAlarmModelInput) (*UpdateAlarmModelOutput, error)

UpdateAlarmModel API operation for AWS IoT Events.

Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceInUseException The resource is in use.

  • ResourceNotFoundException The resource was not found.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/UpdateAlarmModel

func (*IoTEvents) UpdateAlarmModelRequest

func (c *IoTEvents) UpdateAlarmModelRequest(input *UpdateAlarmModelInput) (req *request.Request, output *UpdateAlarmModelOutput)

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/UpdateAlarmModel

func (*IoTEvents) UpdateAlarmModelWithContext

func (c *IoTEvents) UpdateAlarmModelWithContext(ctx aws.Context, input *UpdateAlarmModelInput, opts ...request.Option) (*UpdateAlarmModelOutput, error)

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

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

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

func (*IoTEvents) UpdateDetectorModel

func (c *IoTEvents) UpdateDetectorModel(input *UpdateDetectorModelInput) (*UpdateDetectorModelOutput, error)

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

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ResourceInUseException The resource is in use.

  • ResourceNotFoundException The resource was not found.

  • ThrottlingException The request could not be completed due to throttling.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

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

func (*IoTEvents) UpdateDetectorModelRequest

func (c *IoTEvents) UpdateDetectorModelRequest(input *UpdateDetectorModelInput) (req *request.Request, output *UpdateDetectorModelOutput)

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

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

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

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

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

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

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

func (*IoTEvents) UpdateDetectorModelWithContext

func (c *IoTEvents) UpdateDetectorModelWithContext(ctx aws.Context, input *UpdateDetectorModelInput, opts ...request.Option) (*UpdateDetectorModelOutput, error)

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

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

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

func (*IoTEvents) UpdateInput

func (c *IoTEvents) UpdateInput(input *UpdateInputInput) (*UpdateInputOutput, error)

UpdateInput API operation for AWS IoT Events.

Updates an input.

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

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

Returned Error Types:

  • InvalidRequestException The request was invalid.

  • ThrottlingException The request could not be completed due to throttling.

  • ResourceNotFoundException The resource was not found.

  • InternalFailureException An internal failure occurred.

  • ServiceUnavailableException The service is currently unavailable.

  • ResourceInUseException The resource is in use.

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

func (*IoTEvents) UpdateInputRequest

func (c *IoTEvents) UpdateInputRequest(input *UpdateInputInput) (req *request.Request, output *UpdateInputOutput)

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

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

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

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

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

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

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

func (*IoTEvents) UpdateInputWithContext

func (c *IoTEvents) UpdateInputWithContext(ctx aws.Context, input *UpdateInputInput, opts ...request.Option) (*UpdateInputOutput, error)

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

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

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

type IotEventsInputIdentifier

type IotEventsInputIdentifier struct {

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

The identifier of the input routed to AWS IoT Events.

func (IotEventsInputIdentifier) GoString

func (s IotEventsInputIdentifier) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IotEventsInputIdentifier) SetInputName

SetInputName sets the InputName field's value.

func (IotEventsInputIdentifier) String

func (s IotEventsInputIdentifier) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IotEventsInputIdentifier) Validate

func (s *IotEventsInputIdentifier) Validate() error

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

type IotSiteWiseAction

type IotSiteWiseAction struct {

	// The ID of the asset that has the specified property.
	AssetId *string `locationName:"assetId" type:"string"`

	// A unique identifier for this entry. You can use the entry ID to track which
	// data entry causes an error in case of failure. The default is a new unique
	// identifier.
	EntryId *string `locationName:"entryId" type:"string"`

	// The alias of the asset property.
	PropertyAlias *string `locationName:"propertyAlias" type:"string"`

	// The ID of the asset property.
	PropertyId *string `locationName:"propertyId" type:"string"`

	// The value to send to the asset property. This value contains timestamp, quality,
	// and value (TQV) information.
	PropertyValue *AssetPropertyValue `locationName:"propertyValue" type:"structure"`
	// contains filtered or unexported fields
}

Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.

You must use expressions for all parameters in IotSiteWiseAction. The expressions accept literals, operators, functions, references, and substitutions templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature'.

  • For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the propertyAlias parameter uses a substitution template. 'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'

You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise.

For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the AWS IoT Events Developer Guide.

func (IotSiteWiseAction) GoString

func (s IotSiteWiseAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IotSiteWiseAction) SetAssetId

func (s *IotSiteWiseAction) SetAssetId(v string) *IotSiteWiseAction

SetAssetId sets the AssetId field's value.

func (*IotSiteWiseAction) SetEntryId

func (s *IotSiteWiseAction) SetEntryId(v string) *IotSiteWiseAction

SetEntryId sets the EntryId field's value.

func (*IotSiteWiseAction) SetPropertyAlias

func (s *IotSiteWiseAction) SetPropertyAlias(v string) *IotSiteWiseAction

SetPropertyAlias sets the PropertyAlias field's value.

func (*IotSiteWiseAction) SetPropertyId

func (s *IotSiteWiseAction) SetPropertyId(v string) *IotSiteWiseAction

SetPropertyId sets the PropertyId field's value.

func (*IotSiteWiseAction) SetPropertyValue

func (s *IotSiteWiseAction) SetPropertyValue(v *AssetPropertyValue) *IotSiteWiseAction

SetPropertyValue sets the PropertyValue field's value.

func (IotSiteWiseAction) String

func (s IotSiteWiseAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IotSiteWiseAction) Validate

func (s *IotSiteWiseAction) Validate() error

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

type IotSiteWiseAssetModelPropertyIdentifier

type IotSiteWiseAssetModelPropertyIdentifier struct {

	// The ID of the AWS IoT SiteWise asset model.
	//
	// AssetModelId is a required field
	AssetModelId *string `locationName:"assetModelId" type:"string" required:"true"`

	// The ID of the AWS IoT SiteWise asset property.
	//
	// PropertyId is a required field
	PropertyId *string `locationName:"propertyId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The asset model property identifer of the input routed from AWS IoT SiteWise.

func (IotSiteWiseAssetModelPropertyIdentifier) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IotSiteWiseAssetModelPropertyIdentifier) SetAssetModelId

SetAssetModelId sets the AssetModelId field's value.

func (*IotSiteWiseAssetModelPropertyIdentifier) SetPropertyId

SetPropertyId sets the PropertyId field's value.

func (IotSiteWiseAssetModelPropertyIdentifier) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IotSiteWiseAssetModelPropertyIdentifier) Validate

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

type IotSiteWiseInputIdentifier

type IotSiteWiseInputIdentifier struct {

	// The identifier of the AWS IoT SiteWise asset model property.
	IotSiteWiseAssetModelPropertyIdentifier *IotSiteWiseAssetModelPropertyIdentifier `locationName:"iotSiteWiseAssetModelPropertyIdentifier" type:"structure"`
	// contains filtered or unexported fields
}

The identifer of the input routed from AWS IoT SiteWise.

func (IotSiteWiseInputIdentifier) GoString

func (s IotSiteWiseInputIdentifier) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IotSiteWiseInputIdentifier) SetIotSiteWiseAssetModelPropertyIdentifier

func (s *IotSiteWiseInputIdentifier) SetIotSiteWiseAssetModelPropertyIdentifier(v *IotSiteWiseAssetModelPropertyIdentifier) *IotSiteWiseInputIdentifier

SetIotSiteWiseAssetModelPropertyIdentifier sets the IotSiteWiseAssetModelPropertyIdentifier field's value.

func (IotSiteWiseInputIdentifier) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IotSiteWiseInputIdentifier) Validate

func (s *IotSiteWiseInputIdentifier) 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"`

	// You can configure the action payload when you publish a message to an AWS
	// IoT Core topic.
	Payload *Payload `locationName:"payload" type:"structure"`
	// contains filtered or unexported fields
}

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

func (IotTopicPublishAction) GoString

func (s IotTopicPublishAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IotTopicPublishAction) SetMqttTopic

SetMqttTopic sets the MqttTopic field's value.

func (*IotTopicPublishAction) SetPayload

SetPayload sets the Payload field's value.

func (IotTopicPublishAction) String

func (s IotTopicPublishAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// You can configure the action payload when you send a message to a Lambda
	// function.
	Payload *Payload `locationName:"payload" type:"structure"`
	// 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) GoString

func (s LambdaAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaAction) SetFunctionArn

func (s *LambdaAction) SetFunctionArn(v string) *LambdaAction

SetFunctionArn sets the FunctionArn field's value.

func (*LambdaAction) SetPayload

func (s *LambdaAction) SetPayload(v *Payload) *LambdaAction

SetPayload sets the Payload field's value.

func (LambdaAction) String

func (s LambdaAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LambdaAction) Validate

func (s *LambdaAction) Validate() error

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

type LimitExceededException

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A limit was exceeded.

func (*LimitExceededException) Code

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAlarmModelVersionsInput

type ListAlarmModelVersionsInput struct {

	// The name of the alarm model.
	//
	// AlarmModelName is a required field
	AlarmModelName *string `location:"uri" locationName:"alarmModelName" min:"1" type:"string" required:"true"`

	// The maximum number of results to be returned per request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token that you can use to return the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListAlarmModelVersionsInput) GoString

func (s ListAlarmModelVersionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAlarmModelVersionsInput) SetAlarmModelName

SetAlarmModelName sets the AlarmModelName field's value.

func (*ListAlarmModelVersionsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListAlarmModelVersionsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAlarmModelVersionsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAlarmModelVersionsInput) Validate

func (s *ListAlarmModelVersionsInput) Validate() error

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

type ListAlarmModelVersionsOutput

type ListAlarmModelVersionsOutput struct {

	// A list that summarizes each alarm model version.
	AlarmModelVersionSummaries []*AlarmModelVersionSummary `locationName:"alarmModelVersionSummaries" type:"list"`

	// The token that you can use to return the next set of results, or null if
	// there are no more results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListAlarmModelVersionsOutput) GoString

func (s ListAlarmModelVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAlarmModelVersionsOutput) SetAlarmModelVersionSummaries

SetAlarmModelVersionSummaries sets the AlarmModelVersionSummaries field's value.

func (*ListAlarmModelVersionsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAlarmModelVersionsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAlarmModelsInput

type ListAlarmModelsInput struct {

	// The maximum number of results to be returned per request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token that you can use to return the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListAlarmModelsInput) GoString

func (s ListAlarmModelsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAlarmModelsInput) SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

func (*ListAlarmModelsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListAlarmModelsInput) String

func (s ListAlarmModelsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAlarmModelsInput) Validate

func (s *ListAlarmModelsInput) Validate() error

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

type ListAlarmModelsOutput

type ListAlarmModelsOutput struct {

	// A list that summarizes each alarm model.
	AlarmModelSummaries []*AlarmModelSummary `locationName:"alarmModelSummaries" type:"list"`

	// The token that you can use to return the next set of results, or null if
	// there are no more results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListAlarmModelsOutput) GoString

func (s ListAlarmModelsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAlarmModelsOutput) SetAlarmModelSummaries

func (s *ListAlarmModelsOutput) SetAlarmModelSummaries(v []*AlarmModelSummary) *ListAlarmModelsOutput

SetAlarmModelSummaries sets the AlarmModelSummaries field's value.

func (*ListAlarmModelsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAlarmModelsOutput) String

func (s ListAlarmModelsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 be returned per request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token that you can use to return the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDetectorModelVersionsInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDetectorModelVersionsInput) SetDetectorModelName

SetDetectorModelName sets the DetectorModelName field's value.

func (*ListDetectorModelVersionsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListDetectorModelVersionsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDetectorModelVersionsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// The token that you can use to return the next set of results, or null if
	// there are no more results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDetectorModelVersionsOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDetectorModelVersionsOutput) SetDetectorModelVersionSummaries

SetDetectorModelVersionSummaries sets the DetectorModelVersionSummaries field's value.

func (*ListDetectorModelVersionsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDetectorModelVersionsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDetectorModelsInput

type ListDetectorModelsInput struct {

	// The maximum number of results to be returned per request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token that you can use to return the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDetectorModelsInput) GoString

func (s ListDetectorModelsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDetectorModelsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListDetectorModelsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDetectorModelsInput) String

func (s ListDetectorModelsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// The token that you can use to return the next set of results, or null if
	// there are no more results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDetectorModelsOutput) GoString

func (s ListDetectorModelsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDetectorModelsOutput) SetDetectorModelSummaries

func (s *ListDetectorModelsOutput) SetDetectorModelSummaries(v []*DetectorModelSummary) *ListDetectorModelsOutput

SetDetectorModelSummaries sets the DetectorModelSummaries field's value.

func (*ListDetectorModelsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDetectorModelsOutput) String

func (s ListDetectorModelsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListInputRoutingsInput

type ListInputRoutingsInput struct {

	// The identifer of the routed input.
	//
	// InputIdentifier is a required field
	InputIdentifier *InputIdentifier `locationName:"inputIdentifier" type:"structure" required:"true"`

	// The maximum number of results to be returned per request.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token that you can use to return the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListInputRoutingsInput) GoString

func (s ListInputRoutingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInputRoutingsInput) SetInputIdentifier

SetInputIdentifier sets the InputIdentifier field's value.

func (*ListInputRoutingsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListInputRoutingsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListInputRoutingsInput) String

func (s ListInputRoutingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInputRoutingsInput) Validate

func (s *ListInputRoutingsInput) Validate() error

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

type ListInputRoutingsOutput

type ListInputRoutingsOutput struct {

	// The token that you can use to return the next set of results, or null if
	// there are no more results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// Summary information about the routed resources.
	RoutedResources []*RoutedResource `locationName:"routedResources" type:"list"`
	// contains filtered or unexported fields
}

func (ListInputRoutingsOutput) GoString

func (s ListInputRoutingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInputRoutingsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListInputRoutingsOutput) SetRoutedResources

func (s *ListInputRoutingsOutput) SetRoutedResources(v []*RoutedResource) *ListInputRoutingsOutput

SetRoutedResources sets the RoutedResources field's value.

func (ListInputRoutingsOutput) String

func (s ListInputRoutingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListInputsInput

type ListInputsInput struct {

	// The maximum number of results to be returned per request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token that you can use to return the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListInputsInput) GoString

func (s ListInputsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInputsInput) SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

func (*ListInputsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListInputsInput) String

func (s ListInputsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// The token that you can use to return the next set of results, or null if
	// there are no more results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListInputsOutput) GoString

func (s ListInputsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListInputsOutput) SetInputSummaries

func (s *ListInputsOutput) SetInputSummaries(v []*InputSummary) *ListInputsOutput

SetInputSummaries sets the InputSummaries field's value.

func (*ListInputsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListInputsOutput) String

func (s ListInputsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `locationName:"level" type:"string" required:"true" enum:"LoggingLevel"`

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

func (s LoggingOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoggingOptions) SetDetectorDebugOptions

func (s *LoggingOptions) SetDetectorDebugOptions(v []*DetectorDebugOption) *LoggingOptions

SetDetectorDebugOptions sets the DetectorDebugOptions field's value.

func (*LoggingOptions) SetEnabled

func (s *LoggingOptions) SetEnabled(v bool) *LoggingOptions

SetEnabled sets the Enabled field's value.

func (*LoggingOptions) SetLevel

func (s *LoggingOptions) SetLevel(v string) *LoggingOptions

SetLevel sets the Level field's value.

func (*LoggingOptions) SetRoleArn

func (s *LoggingOptions) SetRoleArn(v string) *LoggingOptions

SetRoleArn sets the RoleArn field's value.

func (LoggingOptions) String

func (s LoggingOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoggingOptions) Validate

func (s *LoggingOptions) Validate() error

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

type NotificationAction

type NotificationAction struct {

	// Specifies an AWS Lambda function to manage alarm notifications. You can create
	// one or use the AWS Lambda function provided by AWS IoT Events (https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html).
	//
	// Action is a required field
	Action *NotificationTargetActions `locationName:"action" type:"structure" required:"true"`

	// Contains the configuration information of email notifications.
	EmailConfigurations []*EmailConfiguration `locationName:"emailConfigurations" min:"1" type:"list"`

	// Contains the configuration information of SMS notifications.
	SmsConfigurations []*SMSConfiguration `locationName:"smsConfigurations" min:"1" type:"list"`
	// contains filtered or unexported fields
}

Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.

func (NotificationAction) GoString

func (s NotificationAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotificationAction) SetAction

SetAction sets the Action field's value.

func (*NotificationAction) SetEmailConfigurations

func (s *NotificationAction) SetEmailConfigurations(v []*EmailConfiguration) *NotificationAction

SetEmailConfigurations sets the EmailConfigurations field's value.

func (*NotificationAction) SetSmsConfigurations

func (s *NotificationAction) SetSmsConfigurations(v []*SMSConfiguration) *NotificationAction

SetSmsConfigurations sets the SmsConfigurations field's value.

func (NotificationAction) String

func (s NotificationAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotificationAction) Validate

func (s *NotificationAction) Validate() error

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

type NotificationTargetActions

type NotificationTargetActions struct {

	// Calls a Lambda function, passing in information about the detector model
	// instance and the event that triggered the action.
	LambdaAction *LambdaAction `locationName:"lambdaAction" type:"structure"`
	// contains filtered or unexported fields
}

Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events (https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html).

func (NotificationTargetActions) GoString

func (s NotificationTargetActions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotificationTargetActions) SetLambdaAction

SetLambdaAction sets the LambdaAction field's value.

func (NotificationTargetActions) String

func (s NotificationTargetActions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotificationTargetActions) Validate

func (s *NotificationTargetActions) 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) GoString

func (s OnEnterLifecycle) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OnEnterLifecycle) SetEvents

func (s *OnEnterLifecycle) SetEvents(v []*Event) *OnEnterLifecycle

SetEvents sets the Events field's value.

func (OnEnterLifecycle) String

func (s OnEnterLifecycle) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s OnExitLifecycle) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OnExitLifecycle) SetEvents

func (s *OnExitLifecycle) SetEvents(v []*Event) *OnExitLifecycle

SetEvents sets the Events field's value.

func (OnExitLifecycle) String

func (s OnExitLifecycle) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s OnInputLifecycle) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OnInputLifecycle) SetEvents

func (s *OnInputLifecycle) SetEvents(v []*Event) *OnInputLifecycle

SetEvents sets the Events field's value.

func (*OnInputLifecycle) SetTransitionEvents

func (s *OnInputLifecycle) SetTransitionEvents(v []*TransitionEvent) *OnInputLifecycle

SetTransitionEvents sets the TransitionEvents field's value.

func (OnInputLifecycle) String

func (s OnInputLifecycle) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OnInputLifecycle) Validate

func (s *OnInputLifecycle) Validate() error

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

type Payload

type Payload struct {

	// The content of the payload. You can use a string expression that includes
	// quoted strings ('<string>'), variables ($variable.<variable-name>), input
	// values ($input.<input-name>.<path-to-datum>), string concatenations, and
	// quoted strings that contain ${} as the content. The recommended maximum size
	// of a content expression is 1 KB.
	//
	// ContentExpression is a required field
	ContentExpression *string `locationName:"contentExpression" min:"1" type:"string" required:"true"`

	// The value of the payload type can be either STRING or JSON.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"PayloadType"`
	// contains filtered or unexported fields
}

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.

func (Payload) GoString

func (s Payload) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Payload) SetContentExpression

func (s *Payload) SetContentExpression(v string) *Payload

SetContentExpression sets the ContentExpression field's value.

func (*Payload) SetType

func (s *Payload) SetType(v string) *Payload

SetType sets the Type field's value.

func (Payload) String

func (s Payload) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Payload) Validate

func (s *Payload) 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) GoString

func (s PutLoggingOptionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutLoggingOptionsInput) SetLoggingOptions

SetLoggingOptions sets the LoggingOptions field's value.

func (PutLoggingOptionsInput) String

func (s PutLoggingOptionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s PutLoggingOptionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutLoggingOptionsOutput) String

func (s PutLoggingOptionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecipientDetail

type RecipientDetail struct {

	// The AWS Single Sign-On (AWS SSO) authentication information.
	SsoIdentity *SSOIdentity `locationName:"ssoIdentity" type:"structure"`
	// contains filtered or unexported fields
}

The information that identifies the recipient.

func (RecipientDetail) GoString

func (s RecipientDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecipientDetail) SetSsoIdentity

func (s *RecipientDetail) SetSsoIdentity(v *SSOIdentity) *RecipientDetail

SetSsoIdentity sets the SsoIdentity field's value.

func (RecipientDetail) String

func (s RecipientDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecipientDetail) Validate

func (s *RecipientDetail) Validate() error

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

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. The duration expression isn't reevaluated when you reset the timer.

func (ResetTimerAction) GoString

func (s ResetTimerAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResetTimerAction) SetTimerName

func (s *ResetTimerAction) SetTimerName(v string) *ResetTimerAction

SetTimerName sets the TimerName field's value.

func (ResetTimerAction) String

func (s ResetTimerAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResetTimerAction) Validate

func (s *ResetTimerAction) Validate() error

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

type ResourceAlreadyExistsException

type ResourceAlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`

	// The ARN of the resource.
	ResourceArn *string `locationName:"resourceArn" type:"string"`

	// The ID of the resource.
	ResourceId *string `locationName:"resourceId" type:"string"`
	// contains filtered or unexported fields
}

The resource already exists.

func (*ResourceAlreadyExistsException) Code

Code returns the exception type name.

func (*ResourceAlreadyExistsException) Error

func (ResourceAlreadyExistsException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceAlreadyExistsException) Message

Message returns the exception's message.

func (*ResourceAlreadyExistsException) OrigErr

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistsException) RequestID

func (s *ResourceAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistsException) StatusCode

func (s *ResourceAlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceAlreadyExistsException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceInUseException

type ResourceInUseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resource is in use.

func (*ResourceInUseException) Code

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString

func (s ResourceInUseException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceInUseException) Message

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode

func (s *ResourceInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceInUseException) String

func (s ResourceInUseException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resource was not found.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RoutedResource

type RoutedResource struct {

	// The ARN of the routed resource. For more information, see Amazon Resource
	// Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the AWS General Reference.
	Arn *string `locationName:"arn" min:"1" type:"string"`

	// The name of the routed resource.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

Contains information about the routed resource.

func (RoutedResource) GoString

func (s RoutedResource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RoutedResource) SetArn

func (s *RoutedResource) SetArn(v string) *RoutedResource

SetArn sets the Arn field's value.

func (*RoutedResource) SetName

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

SetName sets the Name field's value.

func (RoutedResource) String

func (s RoutedResource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SMSConfiguration

type SMSConfiguration struct {

	// The message that you want to send. The message can be up to 200 characters.
	AdditionalMessage *string `locationName:"additionalMessage" type:"string"`

	// Specifies one or more recipients who receive the message.
	//
	// You must add the users that receive SMS messages to your AWS SSO store (https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html).
	//
	// Recipients is a required field
	Recipients []*RecipientDetail `locationName:"recipients" min:"1" type:"list" required:"true"`

	// The sender ID.
	SenderId *string `locationName:"senderId" type:"string"`
	// contains filtered or unexported fields
}

Contains the configuration information of SMS notifications.

func (SMSConfiguration) GoString

func (s SMSConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SMSConfiguration) SetAdditionalMessage

func (s *SMSConfiguration) SetAdditionalMessage(v string) *SMSConfiguration

SetAdditionalMessage sets the AdditionalMessage field's value.

func (*SMSConfiguration) SetRecipients

func (s *SMSConfiguration) SetRecipients(v []*RecipientDetail) *SMSConfiguration

SetRecipients sets the Recipients field's value.

func (*SMSConfiguration) SetSenderId

func (s *SMSConfiguration) SetSenderId(v string) *SMSConfiguration

SetSenderId sets the SenderId field's value.

func (SMSConfiguration) String

func (s SMSConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SMSConfiguration) Validate

func (s *SMSConfiguration) Validate() error

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

type SNSTopicPublishAction

type SNSTopicPublishAction struct {

	// You can configure the action payload when you send a message as an Amazon
	// SNS push notification.
	Payload *Payload `locationName:"payload" type:"structure"`

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

func (s SNSTopicPublishAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SNSTopicPublishAction) SetPayload

SetPayload sets the Payload field's value.

func (*SNSTopicPublishAction) SetTargetArn

SetTargetArn sets the TargetArn field's value.

func (SNSTopicPublishAction) String

func (s SNSTopicPublishAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SNSTopicPublishAction) Validate

func (s *SNSTopicPublishAction) Validate() error

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

type SSOIdentity

type SSOIdentity struct {

	// The ID of the AWS SSO identity store.
	//
	// IdentityStoreId is a required field
	IdentityStoreId *string `locationName:"identityStoreId" type:"string" required:"true"`

	// The user ID.
	UserId *string `locationName:"userId" type:"string"`
	// contains filtered or unexported fields
}

Contains information about your identity source in AWS Single Sign-On. For more information, see the AWS Single Sign-On User Guide (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html).

func (SSOIdentity) GoString

func (s SSOIdentity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SSOIdentity) SetIdentityStoreId

func (s *SSOIdentity) SetIdentityStoreId(v string) *SSOIdentity

SetIdentityStoreId sets the IdentityStoreId field's value.

func (*SSOIdentity) SetUserId

func (s *SSOIdentity) SetUserId(v string) *SSOIdentity

SetUserId sets the UserId field's value.

func (SSOIdentity) String

func (s SSOIdentity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SSOIdentity) Validate

func (s *SSOIdentity) Validate() error

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

type ServiceUnavailableException

type ServiceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The service is currently unavailable.

func (*ServiceUnavailableException) Code

Code returns the exception type name.

func (*ServiceUnavailableException) Error

func (ServiceUnavailableException) GoString

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceUnavailableException) Message

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode

func (s *ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. The maximum value is 31622400 seconds.
	//
	// Deprecated: seconds is deprecated. You can use durationExpression for SetTimerAction. The value of seconds can be used as a string expression for durationExpression.
	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) GoString

func (s SetTimerAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetTimerAction) SetDurationExpression

func (s *SetTimerAction) SetDurationExpression(v string) *SetTimerAction

SetDurationExpression sets the DurationExpression field's value.

func (*SetTimerAction) SetSeconds

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

SetSeconds sets the Seconds field's value.

func (*SetTimerAction) SetTimerName

func (s *SetTimerAction) SetTimerName(v string) *SetTimerAction

SetTimerName sets the TimerName field's value.

func (SetTimerAction) String

func (s SetTimerAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s SetVariableAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetVariableAction) SetValue

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

SetValue sets the Value field's value.

func (*SetVariableAction) SetVariableName

func (s *SetVariableAction) SetVariableName(v string) *SetVariableAction

SetVariableName sets the VariableName field's value.

func (SetVariableAction) String

func (s SetVariableAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetVariableAction) Validate

func (s *SetVariableAction) Validate() error

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

type SimpleRule

type SimpleRule struct {

	// The comparison operator.
	//
	// ComparisonOperator is a required field
	ComparisonOperator *string `locationName:"comparisonOperator" type:"string" required:"true" enum:"ComparisonOperator"`

	// The value on the left side of the comparison operator. You can specify an
	// AWS IoT Events input attribute as an input property.
	//
	// InputProperty is a required field
	InputProperty *string `locationName:"inputProperty" min:"1" type:"string" required:"true"`

	// The value on the right side of the comparison operator. You can enter a number
	// or specify an AWS IoT Events input attribute.
	//
	// Threshold is a required field
	Threshold *string `locationName:"threshold" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A rule that compares an input property value to a threshold value with a comparison operator.

func (SimpleRule) GoString

func (s SimpleRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SimpleRule) SetComparisonOperator

func (s *SimpleRule) SetComparisonOperator(v string) *SimpleRule

SetComparisonOperator sets the ComparisonOperator field's value.

func (*SimpleRule) SetInputProperty

func (s *SimpleRule) SetInputProperty(v string) *SimpleRule

SetInputProperty sets the InputProperty field's value.

func (*SimpleRule) SetThreshold

func (s *SimpleRule) SetThreshold(v string) *SimpleRule

SetThreshold sets the Threshold field's value.

func (SimpleRule) String

func (s SimpleRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SimpleRule) Validate

func (s *SimpleRule) Validate() error

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

type SqsAction

type SqsAction struct {

	// You can configure the action payload when you send a message to an Amazon
	// SQS queue.
	Payload *Payload `locationName:"payload" type:"structure"`

	// 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. Otherwise, set this to FALSE.
	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) GoString

func (s SqsAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SqsAction) SetPayload

func (s *SqsAction) SetPayload(v *Payload) *SqsAction

SetPayload sets the Payload field's value.

func (*SqsAction) SetQueueUrl

func (s *SqsAction) SetQueueUrl(v string) *SqsAction

SetQueueUrl sets the QueueUrl field's value.

func (*SqsAction) SetUseBase64

func (s *SqsAction) SetUseBase64(v bool) *SqsAction

SetUseBase64 sets the UseBase64 field's value.

func (SqsAction) String

func (s SqsAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SqsAction) Validate

func (s *SqsAction) Validate() error

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

type StartDetectorModelAnalysisInput

type StartDetectorModelAnalysisInput struct {

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

func (StartDetectorModelAnalysisInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDetectorModelAnalysisInput) SetDetectorModelDefinition

SetDetectorModelDefinition sets the DetectorModelDefinition field's value.

func (StartDetectorModelAnalysisInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDetectorModelAnalysisInput) Validate

func (s *StartDetectorModelAnalysisInput) Validate() error

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

type StartDetectorModelAnalysisOutput

type StartDetectorModelAnalysisOutput struct {

	// The ID that you can use to retrieve the analysis result.
	AnalysisId *string `locationName:"analysisId" type:"string"`
	// contains filtered or unexported fields
}

func (StartDetectorModelAnalysisOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDetectorModelAnalysisOutput) SetAnalysisId

SetAnalysisId sets the AnalysisId field's value.

func (StartDetectorModelAnalysisOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s State) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*State) SetOnEnter

func (s *State) SetOnEnter(v *OnEnterLifecycle) *State

SetOnEnter sets the OnEnter field's value.

func (*State) SetOnExit

func (s *State) SetOnExit(v *OnExitLifecycle) *State

SetOnExit sets the OnExit field's value.

func (*State) SetOnInput

func (s *State) SetOnInput(v *OnInputLifecycle) *State

SetOnInput sets the OnInput field's value.

func (*State) SetStateName

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

SetStateName sets the StateName field's value.

func (State) String

func (s State) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue

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

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request could not be completed due to throttling.

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TransitionEvent

type TransitionEvent struct {

	// The actions to be performed.
	Actions []*ActionData `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) GoString

func (s TransitionEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TransitionEvent) SetActions

func (s *TransitionEvent) SetActions(v []*ActionData) *TransitionEvent

SetActions sets the Actions field's value.

func (*TransitionEvent) SetCondition

func (s *TransitionEvent) SetCondition(v string) *TransitionEvent

SetCondition sets the Condition field's value.

func (*TransitionEvent) SetEventName

func (s *TransitionEvent) SetEventName(v string) *TransitionEvent

SetEventName sets the EventName field's value.

func (*TransitionEvent) SetNextState

func (s *TransitionEvent) SetNextState(v string) *TransitionEvent

SetNextState sets the NextState field's value.

func (TransitionEvent) String

func (s TransitionEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TransitionEvent) Validate

func (s *TransitionEvent) Validate() error

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

type UnsupportedOperationException

type UnsupportedOperationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The requested operation is not supported.

func (*UnsupportedOperationException) Code

Code returns the exception type name.

func (*UnsupportedOperationException) Error

func (UnsupportedOperationException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnsupportedOperationException) Message

Message returns the exception's message.

func (*UnsupportedOperationException) OrigErr

func (s *UnsupportedOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedOperationException) RequestID

func (s *UnsupportedOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedOperationException) StatusCode

func (s *UnsupportedOperationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnsupportedOperationException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAlarmModelInput

type UpdateAlarmModelInput struct {

	// Contains the configuration information of alarm state changes.
	AlarmCapabilities *AlarmCapabilities `locationName:"alarmCapabilities" type:"structure"`

	// Contains information about one or more alarm actions.
	AlarmEventActions *AlarmEventActions `locationName:"alarmEventActions" type:"structure"`

	// The description of the alarm model.
	AlarmModelDescription *string `locationName:"alarmModelDescription" type:"string"`

	// The name of the alarm model.
	//
	// AlarmModelName is a required field
	AlarmModelName *string `location:"uri" locationName:"alarmModelName" min:"1" type:"string" required:"true"`

	// Contains information about one or more notification actions.
	AlarmNotification *AlarmNotification `locationName:"alarmNotification" type:"structure"`

	// Defines when your alarm is invoked.
	//
	// AlarmRule is a required field
	AlarmRule *AlarmRule `locationName:"alarmRule" type:"structure" required:"true"`

	// The ARN of the IAM role that allows the alarm to perform actions and access
	// AWS resources. For more information, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the AWS General Reference.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"`

	// A non-negative integer that reflects the severity level of the alarm.
	Severity *int64 `locationName:"severity" type:"integer"`
	// contains filtered or unexported fields
}

func (UpdateAlarmModelInput) GoString

func (s UpdateAlarmModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAlarmModelInput) SetAlarmCapabilities

func (s *UpdateAlarmModelInput) SetAlarmCapabilities(v *AlarmCapabilities) *UpdateAlarmModelInput

SetAlarmCapabilities sets the AlarmCapabilities field's value.

func (*UpdateAlarmModelInput) SetAlarmEventActions

func (s *UpdateAlarmModelInput) SetAlarmEventActions(v *AlarmEventActions) *UpdateAlarmModelInput

SetAlarmEventActions sets the AlarmEventActions field's value.

func (*UpdateAlarmModelInput) SetAlarmModelDescription

func (s *UpdateAlarmModelInput) SetAlarmModelDescription(v string) *UpdateAlarmModelInput

SetAlarmModelDescription sets the AlarmModelDescription field's value.

func (*UpdateAlarmModelInput) SetAlarmModelName

func (s *UpdateAlarmModelInput) SetAlarmModelName(v string) *UpdateAlarmModelInput

SetAlarmModelName sets the AlarmModelName field's value.

func (*UpdateAlarmModelInput) SetAlarmNotification

func (s *UpdateAlarmModelInput) SetAlarmNotification(v *AlarmNotification) *UpdateAlarmModelInput

SetAlarmNotification sets the AlarmNotification field's value.

func (*UpdateAlarmModelInput) SetAlarmRule

SetAlarmRule sets the AlarmRule field's value.

func (*UpdateAlarmModelInput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*UpdateAlarmModelInput) SetSeverity

SetSeverity sets the Severity field's value.

func (UpdateAlarmModelInput) String

func (s UpdateAlarmModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAlarmModelInput) Validate

func (s *UpdateAlarmModelInput) Validate() error

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

type UpdateAlarmModelOutput

type UpdateAlarmModelOutput struct {

	// The ARN of the alarm model. For more information, see Amazon Resource Names
	// (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the AWS General Reference.
	AlarmModelArn *string `locationName:"alarmModelArn" type:"string"`

	// The version of the alarm model.
	AlarmModelVersion *string `locationName:"alarmModelVersion" min:"1" type:"string"`

	// The time the alarm model was created, in the Unix epoch format.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The time the alarm model was last updated, in the Unix epoch format.
	LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`

	// The status of the alarm model. The status can be one of the following values:
	//
	//    * ACTIVE - The alarm model is active and it's ready to evaluate data.
	//
	//    * ACTIVATING - AWS IoT Events is activating your alarm model. Activating
	//    an alarm model can take up to a few minutes.
	//
	//    * INACTIVE - The alarm model is inactive, so it isn't ready to evaluate
	//    data. Check your alarm model information and update the alarm model.
	//
	//    * FAILED - You couldn't create or update the alarm model. Check your alarm
	//    model information and try again.
	Status *string `locationName:"status" type:"string" enum:"AlarmModelVersionStatus"`
	// contains filtered or unexported fields
}

func (UpdateAlarmModelOutput) GoString

func (s UpdateAlarmModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAlarmModelOutput) SetAlarmModelArn

func (s *UpdateAlarmModelOutput) SetAlarmModelArn(v string) *UpdateAlarmModelOutput

SetAlarmModelArn sets the AlarmModelArn field's value.

func (*UpdateAlarmModelOutput) SetAlarmModelVersion

func (s *UpdateAlarmModelOutput) SetAlarmModelVersion(v string) *UpdateAlarmModelOutput

SetAlarmModelVersion sets the AlarmModelVersion field's value.

func (*UpdateAlarmModelOutput) SetCreationTime

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

SetCreationTime sets the CreationTime field's value.

func (*UpdateAlarmModelOutput) SetLastUpdateTime

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

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*UpdateAlarmModelOutput) SetStatus

SetStatus sets the Status field's value.

func (UpdateAlarmModelOutput) String

func (s UpdateAlarmModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `locationName:"evaluationMethod" type:"string" enum:"EvaluationMethod"`

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

func (s UpdateDetectorModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDetectorModelInput) SetDetectorModelDefinition

SetDetectorModelDefinition sets the DetectorModelDefinition field's value.

func (*UpdateDetectorModelInput) SetDetectorModelDescription

func (s *UpdateDetectorModelInput) SetDetectorModelDescription(v string) *UpdateDetectorModelInput

SetDetectorModelDescription sets the DetectorModelDescription field's value.

func (*UpdateDetectorModelInput) SetDetectorModelName

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

SetDetectorModelName sets the DetectorModelName field's value.

func (*UpdateDetectorModelInput) SetEvaluationMethod

func (s *UpdateDetectorModelInput) SetEvaluationMethod(v string) *UpdateDetectorModelInput

SetEvaluationMethod sets the EvaluationMethod field's value.

func (*UpdateDetectorModelInput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (UpdateDetectorModelInput) String

func (s UpdateDetectorModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UpdateDetectorModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDetectorModelOutput) SetDetectorModelConfiguration

SetDetectorModelConfiguration sets the DetectorModelConfiguration field's value.

func (UpdateDetectorModelOutput) String

func (s UpdateDetectorModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UpdateInputInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateInputInput) SetInputDefinition

func (s *UpdateInputInput) SetInputDefinition(v *InputDefinition) *UpdateInputInput

SetInputDefinition sets the InputDefinition field's value.

func (*UpdateInputInput) SetInputDescription

func (s *UpdateInputInput) SetInputDescription(v string) *UpdateInputInput

SetInputDescription sets the InputDescription field's value.

func (*UpdateInputInput) SetInputName

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

SetInputName sets the InputName field's value.

func (UpdateInputInput) String

func (s UpdateInputInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

func (s UpdateInputOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateInputOutput) SetInputConfiguration

func (s *UpdateInputOutput) SetInputConfiguration(v *InputConfiguration) *UpdateInputOutput

SetInputConfiguration sets the InputConfiguration field's value.

func (UpdateInputOutput) String

func (s UpdateInputOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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