func AlarmStateName_Values() []string
AlarmStateName_Values returns all elements of the AlarmStateName enum
func ComparisonOperator_Values() []string
ComparisonOperator_Values returns all elements of the ComparisonOperator enum
func CustomerActionName_Values() []string
CustomerActionName_Values returns all elements of the CustomerActionName enum
func ErrorCode_Values() []string
ErrorCode_Values returns all elements of the ErrorCode enum
func EventType_Values() []string
EventType_Values returns all elements of the EventType enum
func TriggerType_Values() []string
TriggerType_Values returns all elements of the TriggerType enum
type AcknowledgeActionConfiguration struct {
// The note that you can leave when you acknowledge the alarm.
Note *string `locationName:"note" type:"string"`
// contains filtered or unexported fields
}
Contains the configuration information of an acknowledge action.
func (s AcknowledgeActionConfiguration) 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 (s *AcknowledgeActionConfiguration) SetNote(v string) *AcknowledgeActionConfiguration
SetNote sets the Note field's value.
func (s AcknowledgeActionConfiguration) 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 AcknowledgeAlarmActionRequest struct {
// The name of the alarm model.
//
// AlarmModelName is a required field
AlarmModelName *string `locationName:"alarmModelName" min:"1" type:"string" required:"true"`
// The value of the key used as a filter to select only the alarms associated
// with the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key).
KeyValue *string `locationName:"keyValue" min:"1" type:"string"`
// The note that you can leave when you acknowledge the alarm.
Note *string `locationName:"note" type:"string"`
// The request ID. Each ID must be unique within each batch.
//
// RequestId is a required field
RequestId *string `locationName:"requestId" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
Information needed to acknowledge the alarm.
func (s AcknowledgeAlarmActionRequest) 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 (s *AcknowledgeAlarmActionRequest) SetAlarmModelName(v string) *AcknowledgeAlarmActionRequest
SetAlarmModelName sets the AlarmModelName field's value.
func (s *AcknowledgeAlarmActionRequest) SetKeyValue(v string) *AcknowledgeAlarmActionRequest
SetKeyValue sets the KeyValue field's value.
func (s *AcknowledgeAlarmActionRequest) SetNote(v string) *AcknowledgeAlarmActionRequest
SetNote sets the Note field's value.
func (s *AcknowledgeAlarmActionRequest) SetRequestId(v string) *AcknowledgeAlarmActionRequest
SetRequestId sets the RequestId field's value.
func (s AcknowledgeAlarmActionRequest) 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 (s *AcknowledgeAlarmActionRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Alarm struct {
// 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 the current state of the alarm.
AlarmState *AlarmState `locationName:"alarmState" type:"structure"`
// The time the alarm was created, in the Unix epoch format.
CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`
// The value of the key used as a filter to select only the alarms associated
// with the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key).
KeyValue *string `locationName:"keyValue" min:"1" type:"string"`
// The time the alarm was last updated, in the Unix epoch format.
LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`
// A non-negative integer that reflects the severity level of the alarm.
Severity *int64 `locationName:"severity" type:"integer"`
// contains filtered or unexported fields
}
Contains information about an alarm.
func (s Alarm) 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 (s *Alarm) SetAlarmModelName(v string) *Alarm
SetAlarmModelName sets the AlarmModelName field's value.
func (s *Alarm) SetAlarmModelVersion(v string) *Alarm
SetAlarmModelVersion sets the AlarmModelVersion field's value.
func (s *Alarm) SetAlarmState(v *AlarmState) *Alarm
SetAlarmState sets the AlarmState field's value.
func (s *Alarm) SetCreationTime(v time.Time) *Alarm
SetCreationTime sets the CreationTime field's value.
func (s *Alarm) SetKeyValue(v string) *Alarm
SetKeyValue sets the KeyValue field's value.
func (s *Alarm) SetLastUpdateTime(v time.Time) *Alarm
SetLastUpdateTime sets the LastUpdateTime field's value.
func (s *Alarm) SetSeverity(v int64) *Alarm
SetSeverity sets the Severity field's value.
func (s Alarm) 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 AlarmState struct {
// Contains information about the action that you can take to respond to the
// alarm.
CustomerAction *CustomerAction `locationName:"customerAction" type:"structure"`
// Information needed to evaluate data.
RuleEvaluation *RuleEvaluation `locationName:"ruleEvaluation" type:"structure"`
// The name of the alarm state. The state name can be one of the following values:
//
// * DISABLED - When the alarm is in the DISABLED state, it isn't ready to
// evaluate data. To enable the alarm, you must change the alarm to the NORMAL
// state.
//
// * NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate
// data.
//
// * ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.
//
// * ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm
// was invoked and you acknowledged the alarm.
//
// * SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the
// alarm is disabled for a specified period of time. After the snooze time,
// the alarm automatically changes to the NORMAL state.
//
// * LATCHED - When the alarm is in the LATCHED state, the alarm was invoked.
// However, the data that the alarm is currently evaluating is within the
// specified range. To change the alarm to the NORMAL state, you must acknowledge
// the alarm.
StateName *string `locationName:"stateName" type:"string" enum:"AlarmStateName"`
// Contains information about alarm state changes.
SystemEvent *SystemEvent `locationName:"systemEvent" type:"structure"`
// contains filtered or unexported fields
}
Contains information about the current state of the alarm.
func (s AlarmState) 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 (s *AlarmState) SetCustomerAction(v *CustomerAction) *AlarmState
SetCustomerAction sets the CustomerAction field's value.
func (s *AlarmState) SetRuleEvaluation(v *RuleEvaluation) *AlarmState
SetRuleEvaluation sets the RuleEvaluation field's value.
func (s *AlarmState) SetStateName(v string) *AlarmState
SetStateName sets the StateName field's value.
func (s *AlarmState) SetSystemEvent(v *SystemEvent) *AlarmState
SetSystemEvent sets the SystemEvent field's value.
func (s AlarmState) 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 AlarmSummary struct {
// 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 was created, in the Unix epoch format.
CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`
// The value of the key used as a filter to select only the alarms associated
// with the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key).
KeyValue *string `locationName:"keyValue" min:"1" type:"string"`
// The time the alarm was last updated, in the Unix epoch format.
LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`
// The name of the alarm state. The state name can be one of the following values:
//
// * DISABLED - When the alarm is in the DISABLED state, it isn't ready to
// evaluate data. To enable the alarm, you must change the alarm to the NORMAL
// state.
//
// * NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate
// data.
//
// * ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.
//
// * ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm
// was invoked and you acknowledged the alarm.
//
// * SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the
// alarm is disabled for a specified period of time. After the snooze time,
// the alarm automatically changes to the NORMAL state.
//
// * LATCHED - When the alarm is in the LATCHED state, the alarm was invoked.
// However, the data that the alarm is currently evaluating is within the
// specified range. To change the alarm to the NORMAL state, you must acknowledge
// the alarm.
StateName *string `locationName:"stateName" type:"string" enum:"AlarmStateName"`
// contains filtered or unexported fields
}
Contains a summary of an alarm.
func (s AlarmSummary) 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 (s *AlarmSummary) SetAlarmModelName(v string) *AlarmSummary
SetAlarmModelName sets the AlarmModelName field's value.
func (s *AlarmSummary) SetAlarmModelVersion(v string) *AlarmSummary
SetAlarmModelVersion sets the AlarmModelVersion field's value.
func (s *AlarmSummary) SetCreationTime(v time.Time) *AlarmSummary
SetCreationTime sets the CreationTime field's value.
func (s *AlarmSummary) SetKeyValue(v string) *AlarmSummary
SetKeyValue sets the KeyValue field's value.
func (s *AlarmSummary) SetLastUpdateTime(v time.Time) *AlarmSummary
SetLastUpdateTime sets the LastUpdateTime field's value.
func (s *AlarmSummary) SetStateName(v string) *AlarmSummary
SetStateName sets the StateName field's value.
func (s AlarmSummary) 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 BatchAcknowledgeAlarmInput struct {
// The list of acknowledge action requests. You can specify up to 10 requests
// per operation.
//
// AcknowledgeActionRequests is a required field
AcknowledgeActionRequests []*AcknowledgeAlarmActionRequest `locationName:"acknowledgeActionRequests" min:"1" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s BatchAcknowledgeAlarmInput) 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 (s *BatchAcknowledgeAlarmInput) SetAcknowledgeActionRequests(v []*AcknowledgeAlarmActionRequest) *BatchAcknowledgeAlarmInput
SetAcknowledgeActionRequests sets the AcknowledgeActionRequests field's value.
func (s BatchAcknowledgeAlarmInput) 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 (s *BatchAcknowledgeAlarmInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchAcknowledgeAlarmOutput struct {
// A list of errors associated with the request, or null if there are no errors.
// Each error entry contains an entry ID that helps you identify the entry that
// failed.
ErrorEntries []*BatchAlarmActionErrorEntry `locationName:"errorEntries" type:"list"`
// contains filtered or unexported fields
}
func (s BatchAcknowledgeAlarmOutput) 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 (s *BatchAcknowledgeAlarmOutput) SetErrorEntries(v []*BatchAlarmActionErrorEntry) *BatchAcknowledgeAlarmOutput
SetErrorEntries sets the ErrorEntries field's value.
func (s BatchAcknowledgeAlarmOutput) 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 BatchAlarmActionErrorEntry struct {
// The error code.
ErrorCode *string `locationName:"errorCode" type:"string" enum:"ErrorCode"`
// A message that describes the error.
ErrorMessage *string `locationName:"errorMessage" type:"string"`
// The request ID. Each ID must be unique within each batch.
RequestId *string `locationName:"requestId" min:"1" type:"string"`
// contains filtered or unexported fields
}
Contains error messages associated with one of the following requests:
BatchAcknowledgeAlarm (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchAcknowledgeAlarm.html)
BatchDisableAlarm (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchDisableAlarm.html)
BatchEnableAlarm (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchEnableAlarm.html)
BatchResetAlarm (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchResetAlarm.html)
BatchSnoozeAlarm (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchSnoozeAlarm.html)
func (s BatchAlarmActionErrorEntry) 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 (s *BatchAlarmActionErrorEntry) SetErrorCode(v string) *BatchAlarmActionErrorEntry
SetErrorCode sets the ErrorCode field's value.
func (s *BatchAlarmActionErrorEntry) SetErrorMessage(v string) *BatchAlarmActionErrorEntry
SetErrorMessage sets the ErrorMessage field's value.
func (s *BatchAlarmActionErrorEntry) SetRequestId(v string) *BatchAlarmActionErrorEntry
SetRequestId sets the RequestId field's value.
func (s BatchAlarmActionErrorEntry) 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 BatchDeleteDetectorErrorEntry struct {
// The error code.
ErrorCode *string `locationName:"errorCode" type:"string" enum:"ErrorCode"`
// A message that describes the error.
ErrorMessage *string `locationName:"errorMessage" type:"string"`
// The ID of the message that caused the error. (See the value of the "messageId"
// in the detectors (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchDeleteDetector.html#iotevents-iotevents-data_BatchDeleteDetector-request-detectors)
// object of the DeleteDetectorRequest.)
MessageId *string `locationName:"messageId" min:"1" type:"string"`
// contains filtered or unexported fields
}
Contains error messages associated with the deletion request.
func (s BatchDeleteDetectorErrorEntry) 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 (s *BatchDeleteDetectorErrorEntry) SetErrorCode(v string) *BatchDeleteDetectorErrorEntry
SetErrorCode sets the ErrorCode field's value.
func (s *BatchDeleteDetectorErrorEntry) SetErrorMessage(v string) *BatchDeleteDetectorErrorEntry
SetErrorMessage sets the ErrorMessage field's value.
func (s *BatchDeleteDetectorErrorEntry) SetMessageId(v string) *BatchDeleteDetectorErrorEntry
SetMessageId sets the MessageId field's value.
func (s BatchDeleteDetectorErrorEntry) 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 BatchDeleteDetectorInput struct {
// The list of one or more detectors to be deleted.
//
// Detectors is a required field
Detectors []*DeleteDetectorRequest `locationName:"detectors" min:"1" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s BatchDeleteDetectorInput) 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 (s *BatchDeleteDetectorInput) SetDetectors(v []*DeleteDetectorRequest) *BatchDeleteDetectorInput
SetDetectors sets the Detectors field's value.
func (s BatchDeleteDetectorInput) 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 (s *BatchDeleteDetectorInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchDeleteDetectorOutput struct {
// A list of errors associated with the request, or an empty array ([]) if there
// are no errors. Each error entry contains a messageId that helps you identify
// the entry that failed.
BatchDeleteDetectorErrorEntries []*BatchDeleteDetectorErrorEntry `locationName:"batchDeleteDetectorErrorEntries" type:"list"`
// contains filtered or unexported fields
}
func (s BatchDeleteDetectorOutput) 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 (s *BatchDeleteDetectorOutput) SetBatchDeleteDetectorErrorEntries(v []*BatchDeleteDetectorErrorEntry) *BatchDeleteDetectorOutput
SetBatchDeleteDetectorErrorEntries sets the BatchDeleteDetectorErrorEntries field's value.
func (s BatchDeleteDetectorOutput) 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 BatchDisableAlarmInput struct {
// The list of disable action requests. You can specify up to 10 requests per
// operation.
//
// DisableActionRequests is a required field
DisableActionRequests []*DisableAlarmActionRequest `locationName:"disableActionRequests" min:"1" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s BatchDisableAlarmInput) 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 (s *BatchDisableAlarmInput) SetDisableActionRequests(v []*DisableAlarmActionRequest) *BatchDisableAlarmInput
SetDisableActionRequests sets the DisableActionRequests field's value.
func (s BatchDisableAlarmInput) 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 (s *BatchDisableAlarmInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchDisableAlarmOutput struct {
// A list of errors associated with the request, or null if there are no errors.
// Each error entry contains an entry ID that helps you identify the entry that
// failed.
ErrorEntries []*BatchAlarmActionErrorEntry `locationName:"errorEntries" type:"list"`
// contains filtered or unexported fields
}
func (s BatchDisableAlarmOutput) 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 (s *BatchDisableAlarmOutput) SetErrorEntries(v []*BatchAlarmActionErrorEntry) *BatchDisableAlarmOutput
SetErrorEntries sets the ErrorEntries field's value.
func (s BatchDisableAlarmOutput) 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 BatchEnableAlarmInput struct {
// The list of enable action requests. You can specify up to 10 requests per
// operation.
//
// EnableActionRequests is a required field
EnableActionRequests []*EnableAlarmActionRequest `locationName:"enableActionRequests" min:"1" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s BatchEnableAlarmInput) 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 (s *BatchEnableAlarmInput) SetEnableActionRequests(v []*EnableAlarmActionRequest) *BatchEnableAlarmInput
SetEnableActionRequests sets the EnableActionRequests field's value.
func (s BatchEnableAlarmInput) 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 (s *BatchEnableAlarmInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchEnableAlarmOutput struct {
// A list of errors associated with the request, or null if there are no errors.
// Each error entry contains an entry ID that helps you identify the entry that
// failed.
ErrorEntries []*BatchAlarmActionErrorEntry `locationName:"errorEntries" type:"list"`
// contains filtered or unexported fields
}
func (s BatchEnableAlarmOutput) 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 (s *BatchEnableAlarmOutput) SetErrorEntries(v []*BatchAlarmActionErrorEntry) *BatchEnableAlarmOutput
SetErrorEntries sets the ErrorEntries field's value.
func (s BatchEnableAlarmOutput) 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 BatchPutMessageErrorEntry struct {
// The error code.
ErrorCode *string `locationName:"errorCode" type:"string" enum:"ErrorCode"`
// A message that describes the error.
ErrorMessage *string `locationName:"errorMessage" type:"string"`
// The ID of the message that caused the error. (See the value corresponding
// to the "messageId" key in the "message" object.)
MessageId *string `locationName:"messageId" min:"1" type:"string"`
// contains filtered or unexported fields
}
Contains information about the errors encountered.
func (s BatchPutMessageErrorEntry) 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 (s *BatchPutMessageErrorEntry) SetErrorCode(v string) *BatchPutMessageErrorEntry
SetErrorCode sets the ErrorCode field's value.
func (s *BatchPutMessageErrorEntry) SetErrorMessage(v string) *BatchPutMessageErrorEntry
SetErrorMessage sets the ErrorMessage field's value.
func (s *BatchPutMessageErrorEntry) SetMessageId(v string) *BatchPutMessageErrorEntry
SetMessageId sets the MessageId field's value.
func (s BatchPutMessageErrorEntry) 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 BatchPutMessageInput struct {
// The list of messages to send. Each message has the following format: '{ "messageId":
// "string", "inputName": "string", "payload": "string"}'
//
// Messages is a required field
Messages []*Message `locationName:"messages" min:"1" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s BatchPutMessageInput) 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 (s *BatchPutMessageInput) SetMessages(v []*Message) *BatchPutMessageInput
SetMessages sets the Messages field's value.
func (s BatchPutMessageInput) 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 (s *BatchPutMessageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchPutMessageOutput struct {
// A list of any errors encountered when sending the messages.
BatchPutMessageErrorEntries []*BatchPutMessageErrorEntry `type:"list"`
// contains filtered or unexported fields
}
func (s BatchPutMessageOutput) 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 (s *BatchPutMessageOutput) SetBatchPutMessageErrorEntries(v []*BatchPutMessageErrorEntry) *BatchPutMessageOutput
SetBatchPutMessageErrorEntries sets the BatchPutMessageErrorEntries field's value.
func (s BatchPutMessageOutput) 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 BatchResetAlarmInput struct {
// The list of reset action requests. You can specify up to 10 requests per
// operation.
//
// ResetActionRequests is a required field
ResetActionRequests []*ResetAlarmActionRequest `locationName:"resetActionRequests" min:"1" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s BatchResetAlarmInput) 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 (s *BatchResetAlarmInput) SetResetActionRequests(v []*ResetAlarmActionRequest) *BatchResetAlarmInput
SetResetActionRequests sets the ResetActionRequests field's value.
func (s BatchResetAlarmInput) 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 (s *BatchResetAlarmInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchResetAlarmOutput struct {
// A list of errors associated with the request, or null if there are no errors.
// Each error entry contains an entry ID that helps you identify the entry that
// failed.
ErrorEntries []*BatchAlarmActionErrorEntry `locationName:"errorEntries" type:"list"`
// contains filtered or unexported fields
}
func (s BatchResetAlarmOutput) 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 (s *BatchResetAlarmOutput) SetErrorEntries(v []*BatchAlarmActionErrorEntry) *BatchResetAlarmOutput
SetErrorEntries sets the ErrorEntries field's value.
func (s BatchResetAlarmOutput) 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 BatchSnoozeAlarmInput struct {
// The list of snooze action requests. You can specify up to 10 requests per
// operation.
//
// SnoozeActionRequests is a required field
SnoozeActionRequests []*SnoozeAlarmActionRequest `locationName:"snoozeActionRequests" min:"1" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s BatchSnoozeAlarmInput) 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 (s *BatchSnoozeAlarmInput) SetSnoozeActionRequests(v []*SnoozeAlarmActionRequest) *BatchSnoozeAlarmInput
SetSnoozeActionRequests sets the SnoozeActionRequests field's value.
func (s BatchSnoozeAlarmInput) 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 (s *BatchSnoozeAlarmInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchSnoozeAlarmOutput struct {
// A list of errors associated with the request, or null if there are no errors.
// Each error entry contains an entry ID that helps you identify the entry that
// failed.
ErrorEntries []*BatchAlarmActionErrorEntry `locationName:"errorEntries" type:"list"`
// contains filtered or unexported fields
}
func (s BatchSnoozeAlarmOutput) 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 (s *BatchSnoozeAlarmOutput) SetErrorEntries(v []*BatchAlarmActionErrorEntry) *BatchSnoozeAlarmOutput
SetErrorEntries sets the ErrorEntries field's value.
func (s BatchSnoozeAlarmOutput) 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 BatchUpdateDetectorErrorEntry struct {
// The error code.
ErrorCode *string `locationName:"errorCode" type:"string" enum:"ErrorCode"`
// A message that describes the error.
ErrorMessage *string `locationName:"errorMessage" type:"string"`
// The "messageId" of the update request that caused the error. (The value of
// the "messageId" in the update request "Detector" object.)
MessageId *string `locationName:"messageId" min:"1" type:"string"`
// contains filtered or unexported fields
}
Information about the error that occurred when attempting to update a detector.
func (s BatchUpdateDetectorErrorEntry) 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 (s *BatchUpdateDetectorErrorEntry) SetErrorCode(v string) *BatchUpdateDetectorErrorEntry
SetErrorCode sets the ErrorCode field's value.
func (s *BatchUpdateDetectorErrorEntry) SetErrorMessage(v string) *BatchUpdateDetectorErrorEntry
SetErrorMessage sets the ErrorMessage field's value.
func (s *BatchUpdateDetectorErrorEntry) SetMessageId(v string) *BatchUpdateDetectorErrorEntry
SetMessageId sets the MessageId field's value.
func (s BatchUpdateDetectorErrorEntry) 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 BatchUpdateDetectorInput struct {
// The list of detectors (instances) to update, along with the values to update.
//
// Detectors is a required field
Detectors []*UpdateDetectorRequest `locationName:"detectors" min:"1" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s BatchUpdateDetectorInput) 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 (s *BatchUpdateDetectorInput) SetDetectors(v []*UpdateDetectorRequest) *BatchUpdateDetectorInput
SetDetectors sets the Detectors field's value.
func (s BatchUpdateDetectorInput) 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 (s *BatchUpdateDetectorInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchUpdateDetectorOutput struct {
// A list of those detector updates that resulted in errors. (If an error is
// listed here, the specific update did not occur.)
BatchUpdateDetectorErrorEntries []*BatchUpdateDetectorErrorEntry `locationName:"batchUpdateDetectorErrorEntries" type:"list"`
// contains filtered or unexported fields
}
func (s BatchUpdateDetectorOutput) 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 (s *BatchUpdateDetectorOutput) SetBatchUpdateDetectorErrorEntries(v []*BatchUpdateDetectorErrorEntry) *BatchUpdateDetectorOutput
SetBatchUpdateDetectorErrorEntries sets the BatchUpdateDetectorErrorEntries field's value.
func (s BatchUpdateDetectorOutput) 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 CustomerAction struct {
// Contains the configuration information of an acknowledge action.
AcknowledgeActionConfiguration *AcknowledgeActionConfiguration `locationName:"acknowledgeActionConfiguration" type:"structure"`
// The name of the action. The action name can be one of the following values:
//
// * SNOOZE - When you snooze the alarm, the alarm state changes to SNOOZE_DISABLED.
//
// * ENABLE - When you enable the alarm, the alarm state changes to NORMAL.
//
// * DISABLE - When you disable the alarm, the alarm state changes to DISABLED.
//
// * ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes
// to ACKNOWLEDGED.
//
// * RESET - When you reset the alarm, the alarm state changes to NORMAL.
//
// For more information, see the AlarmState (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_AlarmState.html)
// API.
ActionName *string `locationName:"actionName" type:"string" enum:"CustomerActionName"`
// Contains the configuration information of a disable action.
DisableActionConfiguration *DisableActionConfiguration `locationName:"disableActionConfiguration" type:"structure"`
// Contains the configuration information of an enable action.
EnableActionConfiguration *EnableActionConfiguration `locationName:"enableActionConfiguration" type:"structure"`
// Contains the configuration information of a reset action.
ResetActionConfiguration *ResetActionConfiguration `locationName:"resetActionConfiguration" type:"structure"`
// Contains the configuration information of a snooze action.
SnoozeActionConfiguration *SnoozeActionConfiguration `locationName:"snoozeActionConfiguration" type:"structure"`
// contains filtered or unexported fields
}
Contains information about the action that you can take to respond to the alarm.
func (s CustomerAction) 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 (s *CustomerAction) SetAcknowledgeActionConfiguration(v *AcknowledgeActionConfiguration) *CustomerAction
SetAcknowledgeActionConfiguration sets the AcknowledgeActionConfiguration field's value.
func (s *CustomerAction) SetActionName(v string) *CustomerAction
SetActionName sets the ActionName field's value.
func (s *CustomerAction) SetDisableActionConfiguration(v *DisableActionConfiguration) *CustomerAction
SetDisableActionConfiguration sets the DisableActionConfiguration field's value.
func (s *CustomerAction) SetEnableActionConfiguration(v *EnableActionConfiguration) *CustomerAction
SetEnableActionConfiguration sets the EnableActionConfiguration field's value.
func (s *CustomerAction) SetResetActionConfiguration(v *ResetActionConfiguration) *CustomerAction
SetResetActionConfiguration sets the ResetActionConfiguration field's value.
func (s *CustomerAction) SetSnoozeActionConfiguration(v *SnoozeActionConfiguration) *CustomerAction
SetSnoozeActionConfiguration sets the SnoozeActionConfiguration field's value.
func (s CustomerAction) 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 DeleteDetectorRequest struct {
// The name of the detector model that was used to create the detector instance.
//
// DetectorModelName is a required field
DetectorModelName *string `locationName:"detectorModelName" min:"1" type:"string" required:"true"`
// The value of the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateDetectorModel.html#iotevents-CreateDetectorModel-request-key)
// used to identify the detector.
KeyValue *string `locationName:"keyValue" min:"1" type:"string"`
// The ID to assign to the DeleteDetectorRequest. Each "messageId" must be unique
// within each batch sent.
//
// MessageId is a required field
MessageId *string `locationName:"messageId" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
Information used to delete the detector model.
func (s DeleteDetectorRequest) 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 (s *DeleteDetectorRequest) SetDetectorModelName(v string) *DeleteDetectorRequest
SetDetectorModelName sets the DetectorModelName field's value.
func (s *DeleteDetectorRequest) SetKeyValue(v string) *DeleteDetectorRequest
SetKeyValue sets the KeyValue field's value.
func (s *DeleteDetectorRequest) SetMessageId(v string) *DeleteDetectorRequest
SetMessageId sets the MessageId field's value.
func (s DeleteDetectorRequest) 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 (s *DeleteDetectorRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAlarmInput 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 value of the key used as a filter to select only the alarms associated
// with the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key).
KeyValue *string `location:"querystring" locationName:"keyValue" min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s DescribeAlarmInput) 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 (s *DescribeAlarmInput) SetAlarmModelName(v string) *DescribeAlarmInput
SetAlarmModelName sets the AlarmModelName field's value.
func (s *DescribeAlarmInput) SetKeyValue(v string) *DescribeAlarmInput
SetKeyValue sets the KeyValue field's value.
func (s DescribeAlarmInput) 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 (s *DescribeAlarmInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAlarmOutput struct {
// Contains information about an alarm.
Alarm *Alarm `locationName:"alarm" type:"structure"`
// contains filtered or unexported fields
}
func (s DescribeAlarmOutput) 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 (s *DescribeAlarmOutput) SetAlarm(v *Alarm) *DescribeAlarmOutput
SetAlarm sets the Alarm field's value.
func (s DescribeAlarmOutput) 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 DescribeDetectorInput struct {
// The name of the detector model whose detectors (instances) you want information
// about.
//
// DetectorModelName is a required field
DetectorModelName *string `location:"uri" locationName:"detectorModelName" min:"1" type:"string" required:"true"`
// A filter used to limit results to detectors (instances) created because of
// the given key ID.
KeyValue *string `location:"querystring" locationName:"keyValue" min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s DescribeDetectorInput) 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 (s *DescribeDetectorInput) SetDetectorModelName(v string) *DescribeDetectorInput
SetDetectorModelName sets the DetectorModelName field's value.
func (s *DescribeDetectorInput) SetKeyValue(v string) *DescribeDetectorInput
SetKeyValue sets the KeyValue field's value.
func (s DescribeDetectorInput) 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 (s *DescribeDetectorInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDetectorOutput struct {
// Information about the detector (instance).
Detector *Detector `locationName:"detector" type:"structure"`
// contains filtered or unexported fields
}
func (s DescribeDetectorOutput) 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 (s *DescribeDetectorOutput) SetDetector(v *Detector) *DescribeDetectorOutput
SetDetector sets the Detector field's value.
func (s DescribeDetectorOutput) 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 Detector struct {
// The time the detector (instance) was created.
CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`
// The name of the detector model that created this detector (instance).
DetectorModelName *string `locationName:"detectorModelName" min:"1" type:"string"`
// The version of the detector model that created this detector (instance).
DetectorModelVersion *string `locationName:"detectorModelVersion" min:"1" type:"string"`
// The value of the key (identifying the device or system) that caused the creation
// of this detector (instance).
KeyValue *string `locationName:"keyValue" min:"1" type:"string"`
// The time the detector (instance) was last updated.
LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`
// The current state of the detector (instance).
State *DetectorState `locationName:"state" type:"structure"`
// contains filtered or unexported fields
}
Information about the detector (instance).
func (s Detector) 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 (s *Detector) SetCreationTime(v time.Time) *Detector
SetCreationTime sets the CreationTime field's value.
func (s *Detector) SetDetectorModelName(v string) *Detector
SetDetectorModelName sets the DetectorModelName field's value.
func (s *Detector) SetDetectorModelVersion(v string) *Detector
SetDetectorModelVersion sets the DetectorModelVersion field's value.
func (s *Detector) SetKeyValue(v string) *Detector
SetKeyValue sets the KeyValue field's value.
func (s *Detector) SetLastUpdateTime(v time.Time) *Detector
SetLastUpdateTime sets the LastUpdateTime field's value.
func (s *Detector) SetState(v *DetectorState) *Detector
SetState sets the State field's value.
func (s Detector) 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 DetectorState struct {
// The name of the state.
//
// StateName is a required field
StateName *string `locationName:"stateName" min:"1" type:"string" required:"true"`
// The current state of the detector's timers.
//
// Timers is a required field
Timers []*Timer `locationName:"timers" type:"list" required:"true"`
// The current values of the detector's variables.
//
// Variables is a required field
Variables []*Variable `locationName:"variables" type:"list" required:"true"`
// contains filtered or unexported fields
}
Information about the current state of the detector instance.
func (s DetectorState) 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 (s *DetectorState) SetStateName(v string) *DetectorState
SetStateName sets the StateName field's value.
func (s *DetectorState) SetTimers(v []*Timer) *DetectorState
SetTimers sets the Timers field's value.
func (s *DetectorState) SetVariables(v []*Variable) *DetectorState
SetVariables sets the Variables field's value.
func (s DetectorState) 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 DetectorStateDefinition struct {
// The name of the new state of the detector (instance).
//
// StateName is a required field
StateName *string `locationName:"stateName" min:"1" type:"string" required:"true"`
// The new values of the detector's timers. Any timer whose value isn't specified
// is cleared, and its timeout event won't occur.
//
// Timers is a required field
Timers []*TimerDefinition `locationName:"timers" type:"list" required:"true"`
// The new values of the detector's variables. Any variable whose value isn't
// specified is cleared.
//
// Variables is a required field
Variables []*VariableDefinition `locationName:"variables" type:"list" required:"true"`
// contains filtered or unexported fields
}
The new state, variable values, and timer settings of the detector (instance).
func (s DetectorStateDefinition) 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 (s *DetectorStateDefinition) SetStateName(v string) *DetectorStateDefinition
SetStateName sets the StateName field's value.
func (s *DetectorStateDefinition) SetTimers(v []*TimerDefinition) *DetectorStateDefinition
SetTimers sets the Timers field's value.
func (s *DetectorStateDefinition) SetVariables(v []*VariableDefinition) *DetectorStateDefinition
SetVariables sets the Variables field's value.
func (s DetectorStateDefinition) 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 (s *DetectorStateDefinition) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DetectorStateSummary struct {
// The name of the state.
StateName *string `locationName:"stateName" min:"1" type:"string"`
// contains filtered or unexported fields
}
Information about the detector state.
func (s DetectorStateSummary) 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 (s *DetectorStateSummary) SetStateName(v string) *DetectorStateSummary
SetStateName sets the StateName field's value.
func (s DetectorStateSummary) 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 DetectorSummary struct {
// The time the detector (instance) was created.
CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`
// The name of the detector model that created this detector (instance).
DetectorModelName *string `locationName:"detectorModelName" min:"1" type:"string"`
// The version of the detector model that created this detector (instance).
DetectorModelVersion *string `locationName:"detectorModelVersion" min:"1" type:"string"`
// The value of the key (identifying the device or system) that caused the creation
// of this detector (instance).
KeyValue *string `locationName:"keyValue" min:"1" type:"string"`
// The time the detector (instance) was last updated.
LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"`
// The current state of the detector (instance).
State *DetectorStateSummary `locationName:"state" type:"structure"`
// contains filtered or unexported fields
}
Information about the detector (instance).
func (s DetectorSummary) 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 (s *DetectorSummary) SetCreationTime(v time.Time) *DetectorSummary
SetCreationTime sets the CreationTime field's value.
func (s *DetectorSummary) SetDetectorModelName(v string) *DetectorSummary
SetDetectorModelName sets the DetectorModelName field's value.
func (s *DetectorSummary) SetDetectorModelVersion(v string) *DetectorSummary
SetDetectorModelVersion sets the DetectorModelVersion field's value.
func (s *DetectorSummary) SetKeyValue(v string) *DetectorSummary
SetKeyValue sets the KeyValue field's value.
func (s *DetectorSummary) SetLastUpdateTime(v time.Time) *DetectorSummary
SetLastUpdateTime sets the LastUpdateTime field's value.
func (s *DetectorSummary) SetState(v *DetectorStateSummary) *DetectorSummary
SetState sets the State field's value.
func (s DetectorSummary) 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 DisableActionConfiguration struct {
// The note that you can leave when you disable the alarm.
Note *string `locationName:"note" type:"string"`
// contains filtered or unexported fields
}
Contains the configuration information of a disable action.
func (s DisableActionConfiguration) 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 (s *DisableActionConfiguration) SetNote(v string) *DisableActionConfiguration
SetNote sets the Note field's value.
func (s DisableActionConfiguration) 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 DisableAlarmActionRequest struct {
// The name of the alarm model.
//
// AlarmModelName is a required field
AlarmModelName *string `locationName:"alarmModelName" min:"1" type:"string" required:"true"`
// The value of the key used as a filter to select only the alarms associated
// with the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key).
KeyValue *string `locationName:"keyValue" min:"1" type:"string"`
// The note that you can leave when you disable the alarm.
Note *string `locationName:"note" type:"string"`
// The request ID. Each ID must be unique within each batch.
//
// RequestId is a required field
RequestId *string `locationName:"requestId" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
Information used to disable the alarm.
func (s DisableAlarmActionRequest) 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 (s *DisableAlarmActionRequest) SetAlarmModelName(v string) *DisableAlarmActionRequest
SetAlarmModelName sets the AlarmModelName field's value.
func (s *DisableAlarmActionRequest) SetKeyValue(v string) *DisableAlarmActionRequest
SetKeyValue sets the KeyValue field's value.
func (s *DisableAlarmActionRequest) SetNote(v string) *DisableAlarmActionRequest
SetNote sets the Note field's value.
func (s *DisableAlarmActionRequest) SetRequestId(v string) *DisableAlarmActionRequest
SetRequestId sets the RequestId field's value.
func (s DisableAlarmActionRequest) 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 (s *DisableAlarmActionRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EnableActionConfiguration struct {
// The note that you can leave when you enable the alarm.
Note *string `locationName:"note" type:"string"`
// contains filtered or unexported fields
}
Contains the configuration information of an enable action.
func (s EnableActionConfiguration) 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 (s *EnableActionConfiguration) SetNote(v string) *EnableActionConfiguration
SetNote sets the Note field's value.
func (s EnableActionConfiguration) 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 EnableAlarmActionRequest struct {
// The name of the alarm model.
//
// AlarmModelName is a required field
AlarmModelName *string `locationName:"alarmModelName" min:"1" type:"string" required:"true"`
// The value of the key used as a filter to select only the alarms associated
// with the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key).
KeyValue *string `locationName:"keyValue" min:"1" type:"string"`
// The note that you can leave when you enable the alarm.
Note *string `locationName:"note" type:"string"`
// The request ID. Each ID must be unique within each batch.
//
// RequestId is a required field
RequestId *string `locationName:"requestId" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
Information needed to enable the alarm.
func (s EnableAlarmActionRequest) 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 (s *EnableAlarmActionRequest) SetAlarmModelName(v string) *EnableAlarmActionRequest
SetAlarmModelName sets the AlarmModelName field's value.
func (s *EnableAlarmActionRequest) SetKeyValue(v string) *EnableAlarmActionRequest
SetKeyValue sets the KeyValue field's value.
func (s *EnableAlarmActionRequest) SetNote(v string) *EnableAlarmActionRequest
SetNote sets the Note field's value.
func (s *EnableAlarmActionRequest) SetRequestId(v string) *EnableAlarmActionRequest
SetRequestId sets the RequestId field's value.
func (s EnableAlarmActionRequest) 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 (s *EnableAlarmActionRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s *InternalFailureException) Code() string
Code returns the exception type name.
func (s *InternalFailureException) Error() string
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 (s *InternalFailureException) Message() string
Message returns the exception's message.
func (s *InternalFailureException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalFailureException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InternalFailureException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *InvalidRequestException) Code() string
Code returns the exception type name.
func (s *InvalidRequestException) Error() string
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 (s *InvalidRequestException) Message() string
Message returns the exception's message.
func (s *InvalidRequestException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidRequestException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidRequestException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 IoTEventsData struct {
*client.Client
}
IoTEventsData provides the API operation methods for making requests to AWS IoT Events Data. See this package's package overview docs for details on the service.
IoTEventsData methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New(p client.ConfigProvider, cfgs ...*aws.Config) *IoTEventsData
New creates a new instance of the IoTEventsData client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession())
// Create a IoTEventsData client from just a session.
svc := ioteventsdata.New(mySession)
// Create a IoTEventsData client with additional configuration
svc := ioteventsdata.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *IoTEventsData) BatchAcknowledgeAlarm(input *BatchAcknowledgeAlarmInput) (*BatchAcknowledgeAlarmOutput, error)
BatchAcknowledgeAlarm API operation for AWS IoT Events Data.
Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you acknowledge them.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT Events Data's API operation BatchAcknowledgeAlarm for usage and error information.
Returned Error Types:
InvalidRequestException The request was invalid.
InternalFailureException An internal failure occurred.
ServiceUnavailableException The service is currently unavailable.
ThrottlingException The request could not be completed due to throttling.
func (c *IoTEventsData) BatchAcknowledgeAlarmRequest(input *BatchAcknowledgeAlarmInput) (req *request.Request, output *BatchAcknowledgeAlarmOutput)
BatchAcknowledgeAlarmRequest generates a "aws/request.Request" representing the client's request for the BatchAcknowledgeAlarm 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 BatchAcknowledgeAlarm for more information on using the BatchAcknowledgeAlarm 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 BatchAcknowledgeAlarmRequest method.
req, resp := client.BatchAcknowledgeAlarmRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *IoTEventsData) BatchAcknowledgeAlarmWithContext(ctx aws.Context, input *BatchAcknowledgeAlarmInput, opts ...request.Option) (*BatchAcknowledgeAlarmOutput, error)
BatchAcknowledgeAlarmWithContext is the same as BatchAcknowledgeAlarm with the addition of the ability to pass a context and additional request options.
See BatchAcknowledgeAlarm 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 (c *IoTEventsData) BatchDeleteDetector(input *BatchDeleteDetectorInput) (*BatchDeleteDetectorOutput, error)
BatchDeleteDetector API operation for AWS IoT Events Data.
Deletes one or more detectors that were created. When a detector is deleted, its state will be cleared and the detector will be removed from the list of detectors. The deleted detector will no longer appear if referenced in the ListDetectors (https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_ListDetectors.html) API call.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT Events Data's API operation BatchDeleteDetector for usage and error information.
Returned Error Types:
InvalidRequestException The request was invalid.
InternalFailureException An internal failure occurred.
ServiceUnavailableException The service is currently unavailable.
ThrottlingException The request could not be completed due to throttling.
func (c *IoTEventsData) BatchDeleteDetectorRequest(input *BatchDeleteDetectorInput) (req *request.Request, output *BatchDeleteDetectorOutput)
BatchDeleteDetectorRequest generates a "aws/request.Request" representing the client's request for the BatchDeleteDetector 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 BatchDeleteDetector for more information on using the BatchDeleteDetector 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 BatchDeleteDetectorRequest method.
req, resp := client.BatchDeleteDetectorRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *IoTEventsData) BatchDeleteDetectorWithContext(ctx aws.Context, input *BatchDeleteDetectorInput, opts ...request.Option) (*BatchDeleteDetectorOutput, error)
BatchDeleteDetectorWithContext is the same as BatchDeleteDetector with the addition of the ability to pass a context and additional request options.
See BatchDeleteDetector 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 (c *IoTEventsData) BatchDisableAlarm(input *BatchDisableAlarmInput) (*BatchDisableAlarmOutput, error)
BatchDisableAlarm API operation for AWS IoT Events Data.
Disables one or more alarms. The alarms change to the DISABLED state after you disable them.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT Events Data's API operation BatchDisableAlarm for usage and error information.
Returned Error Types:
InvalidRequestException The request was invalid.
InternalFailureException An internal failure occurred.
ServiceUnavailableException The service is currently unavailable.
ThrottlingException The request could not be completed due to throttling.
func (c *IoTEventsData) BatchDisableAlarmRequest(input *BatchDisableAlarmInput) (req *request.Request, output *BatchDisableAlarmOutput)
BatchDisableAlarmRequest generates a "aws/request.Request" representing the client's request for the BatchDisableAlarm 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 BatchDisableAlarm for more information on using the BatchDisableAlarm 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 BatchDisableAlarmRequest method.
req, resp := client.BatchDisableAlarmRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *IoTEventsData) BatchDisableAlarmWithContext(ctx aws.Context, input *BatchDisableAlarmInput, opts ...request.Option) (*BatchDisableAlarmOutput, error)
BatchDisableAlarmWithContext is the same as BatchDisableAlarm with the addition of the ability to pass a context and additional request options.
See BatchDisableAlarm 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 (c *IoTEventsData) BatchEnableAlarm(input *BatchEnableAlarmInput) (*BatchEnableAlarmOutput, error)
BatchEnableAlarm API operation for AWS IoT Events Data.
Enables one or more alarms. The alarms change to the NORMAL state after you enable them.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT Events Data's API operation BatchEnableAlarm for usage and error information.
Returned Error Types:
InvalidRequestException The request was invalid.
InternalFailureException An internal failure occurred.
ServiceUnavailableException The service is currently unavailable.
ThrottlingException The request could not be completed due to throttling.
func (c *IoTEventsData) BatchEnableAlarmRequest(input *BatchEnableAlarmInput) (req *request.Request, output *BatchEnableAlarmOutput)
BatchEnableAlarmRequest generates a "aws/request.Request" representing the client's request for the BatchEnableAlarm 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 BatchEnableAlarm for more information on using the BatchEnableAlarm 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 BatchEnableAlarmRequest method.
req, resp := client.BatchEnableAlarmRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *IoTEventsData) BatchEnableAlarmWithContext(ctx aws.Context, input *BatchEnableAlarmInput, opts ...request.Option) (*BatchEnableAlarmOutput, error)
BatchEnableAlarmWithContext is the same as BatchEnableAlarm with the addition of the ability to pass a context and additional request options.
See BatchEnableAlarm 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 (c *IoTEventsData) BatchPutMessage(input *BatchPutMessageInput) (*BatchPutMessageOutput, error)
BatchPutMessage API operation for AWS IoT Events Data.
Sends a set of messages to the IoT Events system. Each message payload is transformed into the input you specify ("inputName") and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT Events Data's API operation BatchPutMessage for usage and error information.
Returned Error Types:
InvalidRequestException The request was invalid.
InternalFailureException An internal failure occurred.
ServiceUnavailableException The service is currently unavailable.
ThrottlingException The request could not be completed due to throttling.
func (c *IoTEventsData) BatchPutMessageRequest(input *BatchPutMessageInput) (req *request.Request, output *BatchPutMessageOutput)
BatchPutMessageRequest generates a "aws/request.Request" representing the client's request for the BatchPutMessage operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchPutMessage for more information on using the BatchPutMessage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchPutMessageRequest method.
req, resp := client.BatchPutMessageRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *IoTEventsData) BatchPutMessageWithContext(ctx aws.Context, input *BatchPutMessageInput, opts ...request.Option) (*BatchPutMessageOutput, error)
BatchPutMessageWithContext is the same as BatchPutMessage with the addition of the ability to pass a context and additional request options.
See BatchPutMessage for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTEventsData) BatchResetAlarm(input *BatchResetAlarmInput) (*BatchResetAlarmOutput, error)
BatchResetAlarm API operation for AWS IoT Events Data.
Resets one or more alarms. The alarms return to the NORMAL state after you reset them.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT Events Data's API operation BatchResetAlarm for usage and error information.
Returned Error Types:
InvalidRequestException The request was invalid.
InternalFailureException An internal failure occurred.
ServiceUnavailableException The service is currently unavailable.
ThrottlingException The request could not be completed due to throttling.
func (c *IoTEventsData) BatchResetAlarmRequest(input *BatchResetAlarmInput) (req *request.Request, output *BatchResetAlarmOutput)
BatchResetAlarmRequest generates a "aws/request.Request" representing the client's request for the BatchResetAlarm 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 BatchResetAlarm for more information on using the BatchResetAlarm 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 BatchResetAlarmRequest method.
req, resp := client.BatchResetAlarmRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *IoTEventsData) BatchResetAlarmWithContext(ctx aws.Context, input *BatchResetAlarmInput, opts ...request.Option) (*BatchResetAlarmOutput, error)
BatchResetAlarmWithContext is the same as BatchResetAlarm with the addition of the ability to pass a context and additional request options.
See BatchResetAlarm 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 (c *IoTEventsData) BatchSnoozeAlarm(input *BatchSnoozeAlarmInput) (*BatchSnoozeAlarmOutput, error)
BatchSnoozeAlarm API operation for AWS IoT Events Data.
Changes one or more alarms to the snooze mode. The alarms change to the SNOOZE_DISABLED state after you set them to the snooze mode.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT Events Data's API operation BatchSnoozeAlarm for usage and error information.
Returned Error Types:
InvalidRequestException The request was invalid.
InternalFailureException An internal failure occurred.
ServiceUnavailableException The service is currently unavailable.
ThrottlingException The request could not be completed due to throttling.
func (c *IoTEventsData) BatchSnoozeAlarmRequest(input *BatchSnoozeAlarmInput) (req *request.Request, output *BatchSnoozeAlarmOutput)
BatchSnoozeAlarmRequest generates a "aws/request.Request" representing the client's request for the BatchSnoozeAlarm 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 BatchSnoozeAlarm for more information on using the BatchSnoozeAlarm 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 BatchSnoozeAlarmRequest method.
req, resp := client.BatchSnoozeAlarmRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *IoTEventsData) BatchSnoozeAlarmWithContext(ctx aws.Context, input *BatchSnoozeAlarmInput, opts ...request.Option) (*BatchSnoozeAlarmOutput, error)
BatchSnoozeAlarmWithContext is the same as BatchSnoozeAlarm with the addition of the ability to pass a context and additional request options.
See BatchSnoozeAlarm 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 (c *IoTEventsData) BatchUpdateDetector(input *BatchUpdateDetectorInput) (*BatchUpdateDetectorOutput, error)
BatchUpdateDetector API operation for AWS IoT Events Data.
Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT Events Data's API operation BatchUpdateDetector for usage and error information.
Returned Error Types:
InvalidRequestException The request was invalid.
InternalFailureException An internal failure occurred.
ServiceUnavailableException The service is currently unavailable.
ThrottlingException The request could not be completed due to throttling.
func (c *IoTEventsData) BatchUpdateDetectorRequest(input *BatchUpdateDetectorInput) (req *request.Request, output *BatchUpdateDetectorOutput)
BatchUpdateDetectorRequest generates a "aws/request.Request" representing the client's request for the BatchUpdateDetector operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchUpdateDetector for more information on using the BatchUpdateDetector API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchUpdateDetectorRequest method.
req, resp := client.BatchUpdateDetectorRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *IoTEventsData) BatchUpdateDetectorWithContext(ctx aws.Context, input *BatchUpdateDetectorInput, opts ...request.Option) (*BatchUpdateDetectorOutput, error)
BatchUpdateDetectorWithContext is the same as BatchUpdateDetector with the addition of the ability to pass a context and additional request options.
See BatchUpdateDetector for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTEventsData) DescribeAlarm(input *DescribeAlarmInput) (*DescribeAlarmOutput, error)
DescribeAlarm API operation for AWS IoT Events Data.
Retrieves information about an alarm.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT Events Data's API operation DescribeAlarm 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-data-2018-10-23/DescribeAlarm
func (c *IoTEventsData) DescribeAlarmRequest(input *DescribeAlarmInput) (req *request.Request, output *DescribeAlarmOutput)
DescribeAlarmRequest generates a "aws/request.Request" representing the client's request for the DescribeAlarm 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 DescribeAlarm for more information on using the DescribeAlarm 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 DescribeAlarmRequest method.
req, resp := client.DescribeAlarmRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-data-2018-10-23/DescribeAlarm
func (c *IoTEventsData) DescribeAlarmWithContext(ctx aws.Context, input *DescribeAlarmInput, opts ...request.Option) (*DescribeAlarmOutput, error)
DescribeAlarmWithContext is the same as DescribeAlarm with the addition of the ability to pass a context and additional request options.
See DescribeAlarm 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 (c *IoTEventsData) DescribeDetector(input *DescribeDetectorInput) (*DescribeDetectorOutput, error)
DescribeDetector API operation for AWS IoT Events Data.
Returns information about the specified detector (instance).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT Events Data's API operation DescribeDetector for usage and error information.
Returned Error 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.
func (c *IoTEventsData) DescribeDetectorRequest(input *DescribeDetectorInput) (req *request.Request, output *DescribeDetectorOutput)
DescribeDetectorRequest generates a "aws/request.Request" representing the client's request for the DescribeDetector operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeDetector for more information on using the DescribeDetector API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeDetectorRequest method.
req, resp := client.DescribeDetectorRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *IoTEventsData) DescribeDetectorWithContext(ctx aws.Context, input *DescribeDetectorInput, opts ...request.Option) (*DescribeDetectorOutput, error)
DescribeDetectorWithContext is the same as DescribeDetector with the addition of the ability to pass a context and additional request options.
See DescribeDetector for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTEventsData) ListAlarms(input *ListAlarmsInput) (*ListAlarmsOutput, error)
ListAlarms API operation for AWS IoT Events Data.
Lists one or more alarms. The operation returns only the metadata associated with each alarm.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT Events Data's API operation ListAlarms 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-data-2018-10-23/ListAlarms
func (c *IoTEventsData) ListAlarmsRequest(input *ListAlarmsInput) (req *request.Request, output *ListAlarmsOutput)
ListAlarmsRequest generates a "aws/request.Request" representing the client's request for the ListAlarms 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 ListAlarms for more information on using the ListAlarms 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 ListAlarmsRequest method.
req, resp := client.ListAlarmsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-data-2018-10-23/ListAlarms
func (c *IoTEventsData) ListAlarmsWithContext(ctx aws.Context, input *ListAlarmsInput, opts ...request.Option) (*ListAlarmsOutput, error)
ListAlarmsWithContext is the same as ListAlarms with the addition of the ability to pass a context and additional request options.
See ListAlarms 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 (c *IoTEventsData) ListDetectors(input *ListDetectorsInput) (*ListDetectorsOutput, error)
ListDetectors API operation for AWS IoT Events Data.
Lists detectors (the instances of a detector model).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT Events Data's API operation ListDetectors for usage and error information.
Returned Error 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-data-2018-10-23/ListDetectors
func (c *IoTEventsData) ListDetectorsRequest(input *ListDetectorsInput) (req *request.Request, output *ListDetectorsOutput)
ListDetectorsRequest generates a "aws/request.Request" representing the client's request for the ListDetectors operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListDetectors for more information on using the ListDetectors API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListDetectorsRequest method.
req, resp := client.ListDetectorsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/iotevents-data-2018-10-23/ListDetectors
func (c *IoTEventsData) ListDetectorsWithContext(ctx aws.Context, input *ListDetectorsInput, opts ...request.Option) (*ListDetectorsOutput, error)
ListDetectorsWithContext is the same as ListDetectors with the addition of the ability to pass a context and additional request options.
See ListDetectors for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type ListAlarmsInput 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 (s ListAlarmsInput) 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 (s *ListAlarmsInput) SetAlarmModelName(v string) *ListAlarmsInput
SetAlarmModelName sets the AlarmModelName field's value.
func (s *ListAlarmsInput) SetMaxResults(v int64) *ListAlarmsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListAlarmsInput) SetNextToken(v string) *ListAlarmsInput
SetNextToken sets the NextToken field's value.
func (s ListAlarmsInput) 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 (s *ListAlarmsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListAlarmsOutput struct {
// A list that summarizes each alarm.
AlarmSummaries []*AlarmSummary `locationName:"alarmSummaries" 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 (s ListAlarmsOutput) 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 (s *ListAlarmsOutput) SetAlarmSummaries(v []*AlarmSummary) *ListAlarmsOutput
SetAlarmSummaries sets the AlarmSummaries field's value.
func (s *ListAlarmsOutput) SetNextToken(v string) *ListAlarmsOutput
SetNextToken sets the NextToken field's value.
func (s ListAlarmsOutput) 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 ListDetectorsInput struct {
// The name of the detector model whose detectors (instances) are listed.
//
// DetectorModelName is a required field
DetectorModelName *string `location:"uri" locationName:"detectorModelName" min:"1" type:"string" required:"true"`
// The maximum number of results to 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"`
// A filter that limits results to those detectors (instances) in the given
// state.
StateName *string `location:"querystring" locationName:"stateName" min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s ListDetectorsInput) 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 (s *ListDetectorsInput) SetDetectorModelName(v string) *ListDetectorsInput
SetDetectorModelName sets the DetectorModelName field's value.
func (s *ListDetectorsInput) SetMaxResults(v int64) *ListDetectorsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListDetectorsInput) SetNextToken(v string) *ListDetectorsInput
SetNextToken sets the NextToken field's value.
func (s *ListDetectorsInput) SetStateName(v string) *ListDetectorsInput
SetStateName sets the StateName field's value.
func (s ListDetectorsInput) 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 (s *ListDetectorsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListDetectorsOutput struct {
// A list of summary information about the detectors (instances).
DetectorSummaries []*DetectorSummary `locationName:"detectorSummaries" 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 (s ListDetectorsOutput) 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 (s *ListDetectorsOutput) SetDetectorSummaries(v []*DetectorSummary) *ListDetectorsOutput
SetDetectorSummaries sets the DetectorSummaries field's value.
func (s *ListDetectorsOutput) SetNextToken(v string) *ListDetectorsOutput
SetNextToken sets the NextToken field's value.
func (s ListDetectorsOutput) 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 Message struct {
// The name of the input into which the message payload is transformed.
//
// InputName is a required field
InputName *string `locationName:"inputName" min:"1" type:"string" required:"true"`
// The ID to assign to the message. Within each batch sent, each "messageId"
// must be unique.
//
// MessageId is a required field
MessageId *string `locationName:"messageId" min:"1" type:"string" required:"true"`
// The payload of the message. This can be a JSON string or a Base-64-encoded
// string representing binary data (in which case you must decode it).
// Payload is automatically base64 encoded/decoded by the SDK.
//
// Payload is a required field
Payload []byte `locationName:"payload" type:"blob" required:"true"`
// The timestamp associated with the message.
Timestamp *TimestampValue `locationName:"timestamp" type:"structure"`
// contains filtered or unexported fields
}
Information about a message.
func (s Message) 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 (s *Message) SetInputName(v string) *Message
SetInputName sets the InputName field's value.
func (s *Message) SetMessageId(v string) *Message
SetMessageId sets the MessageId field's value.
func (s *Message) SetPayload(v []byte) *Message
SetPayload sets the Payload field's value.
func (s *Message) SetTimestamp(v *TimestampValue) *Message
SetTimestamp sets the Timestamp field's value.
func (s Message) 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 (s *Message) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ResetActionConfiguration struct {
// The note that you can leave when you reset the alarm.
Note *string `locationName:"note" type:"string"`
// contains filtered or unexported fields
}
Contains the configuration information of a reset action.
func (s ResetActionConfiguration) 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 (s *ResetActionConfiguration) SetNote(v string) *ResetActionConfiguration
SetNote sets the Note field's value.
func (s ResetActionConfiguration) 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 ResetAlarmActionRequest struct {
// The name of the alarm model.
//
// AlarmModelName is a required field
AlarmModelName *string `locationName:"alarmModelName" min:"1" type:"string" required:"true"`
// The value of the key used as a filter to select only the alarms associated
// with the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key).
KeyValue *string `locationName:"keyValue" min:"1" type:"string"`
// The note that you can leave when you reset the alarm.
Note *string `locationName:"note" type:"string"`
// The request ID. Each ID must be unique within each batch.
//
// RequestId is a required field
RequestId *string `locationName:"requestId" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
Information needed to reset the alarm.
func (s ResetAlarmActionRequest) 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 (s *ResetAlarmActionRequest) SetAlarmModelName(v string) *ResetAlarmActionRequest
SetAlarmModelName sets the AlarmModelName field's value.
func (s *ResetAlarmActionRequest) SetKeyValue(v string) *ResetAlarmActionRequest
SetKeyValue sets the KeyValue field's value.
func (s *ResetAlarmActionRequest) SetNote(v string) *ResetAlarmActionRequest
SetNote sets the Note field's value.
func (s *ResetAlarmActionRequest) SetRequestId(v string) *ResetAlarmActionRequest
SetRequestId sets the RequestId field's value.
func (s ResetAlarmActionRequest) 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 (s *ResetAlarmActionRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
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 (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 RuleEvaluation struct {
// Information needed to compare two values with a comparison operator.
SimpleRuleEvaluation *SimpleRuleEvaluation `locationName:"simpleRuleEvaluation" type:"structure"`
// contains filtered or unexported fields
}
Information needed to evaluate data.
func (s RuleEvaluation) 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 (s *RuleEvaluation) SetSimpleRuleEvaluation(v *SimpleRuleEvaluation) *RuleEvaluation
SetSimpleRuleEvaluation sets the SimpleRuleEvaluation field's value.
func (s RuleEvaluation) 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 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 (s *ServiceUnavailableException) Code() string
Code returns the exception type name.
func (s *ServiceUnavailableException) Error() string
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 (s *ServiceUnavailableException) Message() string
Message returns the exception's message.
func (s *ServiceUnavailableException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceUnavailableException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceUnavailableException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ServiceUnavailableException) 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 SimpleRuleEvaluation struct {
// The value of the input property, on the left side of the comparison operator.
InputPropertyValue *string `locationName:"inputPropertyValue" type:"string"`
// The comparison operator.
Operator *string `locationName:"operator" type:"string" enum:"ComparisonOperator"`
// The threshold value, on the right side of the comparison operator.
ThresholdValue *string `locationName:"thresholdValue" type:"string"`
// contains filtered or unexported fields
}
Information needed to compare two values with a comparison operator.
func (s SimpleRuleEvaluation) 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 (s *SimpleRuleEvaluation) SetInputPropertyValue(v string) *SimpleRuleEvaluation
SetInputPropertyValue sets the InputPropertyValue field's value.
func (s *SimpleRuleEvaluation) SetOperator(v string) *SimpleRuleEvaluation
SetOperator sets the Operator field's value.
func (s *SimpleRuleEvaluation) SetThresholdValue(v string) *SimpleRuleEvaluation
SetThresholdValue sets the ThresholdValue field's value.
func (s SimpleRuleEvaluation) 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 SnoozeActionConfiguration struct {
// The note that you can leave when you snooze the alarm.
Note *string `locationName:"note" type:"string"`
// The snooze time in seconds. The alarm automatically changes to the NORMAL
// state after this duration.
SnoozeDuration *int64 `locationName:"snoozeDuration" type:"integer"`
// contains filtered or unexported fields
}
Contains the configuration information of a snooze action.
func (s SnoozeActionConfiguration) 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 (s *SnoozeActionConfiguration) SetNote(v string) *SnoozeActionConfiguration
SetNote sets the Note field's value.
func (s *SnoozeActionConfiguration) SetSnoozeDuration(v int64) *SnoozeActionConfiguration
SetSnoozeDuration sets the SnoozeDuration field's value.
func (s SnoozeActionConfiguration) 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 SnoozeAlarmActionRequest struct {
// The name of the alarm model.
//
// AlarmModelName is a required field
AlarmModelName *string `locationName:"alarmModelName" min:"1" type:"string" required:"true"`
// The value of the key used as a filter to select only the alarms associated
// with the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key).
KeyValue *string `locationName:"keyValue" min:"1" type:"string"`
// The note that you can leave when you snooze the alarm.
Note *string `locationName:"note" type:"string"`
// The request ID. Each ID must be unique within each batch.
//
// RequestId is a required field
RequestId *string `locationName:"requestId" min:"1" type:"string" required:"true"`
// The snooze time in seconds. The alarm automatically changes to the NORMAL
// state after this duration.
//
// SnoozeDuration is a required field
SnoozeDuration *int64 `locationName:"snoozeDuration" type:"integer" required:"true"`
// contains filtered or unexported fields
}
Information needed to snooze the alarm.
func (s SnoozeAlarmActionRequest) 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 (s *SnoozeAlarmActionRequest) SetAlarmModelName(v string) *SnoozeAlarmActionRequest
SetAlarmModelName sets the AlarmModelName field's value.
func (s *SnoozeAlarmActionRequest) SetKeyValue(v string) *SnoozeAlarmActionRequest
SetKeyValue sets the KeyValue field's value.
func (s *SnoozeAlarmActionRequest) SetNote(v string) *SnoozeAlarmActionRequest
SetNote sets the Note field's value.
func (s *SnoozeAlarmActionRequest) SetRequestId(v string) *SnoozeAlarmActionRequest
SetRequestId sets the RequestId field's value.
func (s *SnoozeAlarmActionRequest) SetSnoozeDuration(v int64) *SnoozeAlarmActionRequest
SetSnoozeDuration sets the SnoozeDuration field's value.
func (s SnoozeAlarmActionRequest) 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 (s *SnoozeAlarmActionRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StateChangeConfiguration struct {
// The trigger type. If the value is SNOOZE_TIMEOUT, the snooze duration ends
// and the alarm automatically changes to the NORMAL state.
TriggerType *string `locationName:"triggerType" type:"string" enum:"TriggerType"`
// contains filtered or unexported fields
}
Contains the configuration information of alarm state changes.
func (s StateChangeConfiguration) 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 (s *StateChangeConfiguration) SetTriggerType(v string) *StateChangeConfiguration
SetTriggerType sets the TriggerType field's value.
func (s StateChangeConfiguration) 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 SystemEvent struct {
// The event type. If the value is STATE_CHANGE, the event contains information
// about alarm state changes.
EventType *string `locationName:"eventType" type:"string" enum:"EventType"`
// Contains the configuration information of alarm state changes.
StateChangeConfiguration *StateChangeConfiguration `locationName:"stateChangeConfiguration" type:"structure"`
// contains filtered or unexported fields
}
Contains information about alarm state changes.
func (s SystemEvent) 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 (s *SystemEvent) SetEventType(v string) *SystemEvent
SetEventType sets the EventType field's value.
func (s *SystemEvent) SetStateChangeConfiguration(v *StateChangeConfiguration) *SystemEvent
SetStateChangeConfiguration sets the StateChangeConfiguration field's value.
func (s SystemEvent) 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 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 (s *ThrottlingException) Code() string
Code returns the exception type name.
func (s *ThrottlingException) Error() string
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 (s *ThrottlingException) Message() string
Message returns the exception's message.
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 Timer struct {
// The name of the timer.
//
// Name is a required field
Name *string `locationName:"name" min:"1" type:"string" required:"true"`
// The expiration time for the timer.
//
// Timestamp is a required field
Timestamp *time.Time `locationName:"timestamp" type:"timestamp" required:"true"`
// contains filtered or unexported fields
}
The current state of a timer.
func (s Timer) 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 (s *Timer) SetName(v string) *Timer
SetName sets the Name field's value.
func (s *Timer) SetTimestamp(v time.Time) *Timer
SetTimestamp sets the Timestamp field's value.
func (s Timer) 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 TimerDefinition struct {
// The name of the timer.
//
// Name is a required field
Name *string `locationName:"name" min:"1" type:"string" required:"true"`
// The new setting of the timer (the number of seconds before the timer elapses).
//
// Seconds is a required field
Seconds *int64 `locationName:"seconds" type:"integer" required:"true"`
// contains filtered or unexported fields
}
The new setting of a timer.
func (s TimerDefinition) 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 (s *TimerDefinition) SetName(v string) *TimerDefinition
SetName sets the Name field's value.
func (s *TimerDefinition) SetSeconds(v int64) *TimerDefinition
SetSeconds sets the Seconds field's value.
func (s TimerDefinition) 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 (s *TimerDefinition) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TimestampValue struct {
// The value of the timestamp, in the Unix epoch format.
TimeInMillis *int64 `locationName:"timeInMillis" min:"1" type:"long"`
// contains filtered or unexported fields
}
Contains information about a timestamp.
func (s TimestampValue) 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 (s *TimestampValue) SetTimeInMillis(v int64) *TimestampValue
SetTimeInMillis sets the TimeInMillis field's value.
func (s TimestampValue) 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 (s *TimestampValue) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDetectorRequest struct {
// The name of the detector model that created the detectors (instances).
//
// DetectorModelName is a required field
DetectorModelName *string `locationName:"detectorModelName" min:"1" type:"string" required:"true"`
// The value of the input key attribute (identifying the device or system) that
// caused the creation of this detector (instance).
KeyValue *string `locationName:"keyValue" min:"1" type:"string"`
// The ID to assign to the detector update "message". Each "messageId" must
// be unique within each batch sent.
//
// MessageId is a required field
MessageId *string `locationName:"messageId" min:"1" type:"string" required:"true"`
// The new state, variable values, and timer settings of the detector (instance).
//
// State is a required field
State *DetectorStateDefinition `locationName:"state" type:"structure" required:"true"`
// contains filtered or unexported fields
}
Information used to update the detector (instance).
func (s UpdateDetectorRequest) 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 (s *UpdateDetectorRequest) SetDetectorModelName(v string) *UpdateDetectorRequest
SetDetectorModelName sets the DetectorModelName field's value.
func (s *UpdateDetectorRequest) SetKeyValue(v string) *UpdateDetectorRequest
SetKeyValue sets the KeyValue field's value.
func (s *UpdateDetectorRequest) SetMessageId(v string) *UpdateDetectorRequest
SetMessageId sets the MessageId field's value.
func (s *UpdateDetectorRequest) SetState(v *DetectorStateDefinition) *UpdateDetectorRequest
SetState sets the State field's value.
func (s UpdateDetectorRequest) 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 (s *UpdateDetectorRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Variable struct {
// The name of the variable.
//
// Name is a required field
Name *string `locationName:"name" min:"1" type:"string" required:"true"`
// The current value of the variable.
//
// Value is a required field
Value *string `locationName:"value" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
The current state of the variable.
func (s Variable) 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 (s *Variable) SetName(v string) *Variable
SetName sets the Name field's value.
func (s *Variable) SetValue(v string) *Variable
SetValue sets the Value field's value.
func (s Variable) 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 VariableDefinition struct {
// The name of the variable.
//
// Name is a required field
Name *string `locationName:"name" min:"1" type:"string" required:"true"`
// The new value of the variable.
//
// Value is a required field
Value *string `locationName:"value" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
The new value of the variable.
func (s VariableDefinition) 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 (s *VariableDefinition) SetName(v string) *VariableDefinition
SetName sets the Name field's value.
func (s *VariableDefinition) SetValue(v string) *VariableDefinition
SetValue sets the Value field's value.
func (s VariableDefinition) 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 (s *VariableDefinition) Validate() error
Validate inspects the fields of the type to determine if they are valid.