...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/ioteventsdata"
Overview
Constants

Overview ▾

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

AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events Data API commands to send inputs to detectors, list detectors, and view or update a detector's status.

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

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

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

Using the Client

To contact AWS IoT Events Data with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS IoT Events Data client IoTEventsData for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/ioteventsdata/#New

The stub package, ioteventsdataiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type IoTEventsData
func New(p client.ConfigProvider, cfgs ...*aws.Config) *IoTEventsData
func (c *IoTEventsData) BatchAcknowledgeAlarm(input *BatchAcknowledgeAlarmInput) (*BatchAcknowledgeAlarmOutput, error)
func (c *IoTEventsData) BatchAcknowledgeAlarmRequest(input *BatchAcknowledgeAlarmInput) (req *request.Request, output *BatchAcknowledgeAlarmOutput)
func (c *IoTEventsData) BatchAcknowledgeAlarmWithContext(ctx aws.Context, input *BatchAcknowledgeAlarmInput, opts ...request.Option) (*BatchAcknowledgeAlarmOutput, error)
func (c *IoTEventsData) BatchDisableAlarm(input *BatchDisableAlarmInput) (*BatchDisableAlarmOutput, error)
func (c *IoTEventsData) BatchDisableAlarmRequest(input *BatchDisableAlarmInput) (req *request.Request, output *BatchDisableAlarmOutput)
func (c *IoTEventsData) BatchDisableAlarmWithContext(ctx aws.Context, input *BatchDisableAlarmInput, opts ...request.Option) (*BatchDisableAlarmOutput, error)
func (c *IoTEventsData) BatchEnableAlarm(input *BatchEnableAlarmInput) (*BatchEnableAlarmOutput, error)
func (c *IoTEventsData) BatchEnableAlarmRequest(input *BatchEnableAlarmInput) (req *request.Request, output *BatchEnableAlarmOutput)
func (c *IoTEventsData) BatchEnableAlarmWithContext(ctx aws.Context, input *BatchEnableAlarmInput, opts ...request.Option) (*BatchEnableAlarmOutput, error)
func (c *IoTEventsData) BatchPutMessage(input *BatchPutMessageInput) (*BatchPutMessageOutput, error)
func (c *IoTEventsData) BatchPutMessageRequest(input *BatchPutMessageInput) (req *request.Request, output *BatchPutMessageOutput)
func (c *IoTEventsData) BatchPutMessageWithContext(ctx aws.Context, input *BatchPutMessageInput, opts ...request.Option) (*BatchPutMessageOutput, error)
func (c *IoTEventsData) BatchResetAlarm(input *BatchResetAlarmInput) (*BatchResetAlarmOutput, error)
func (c *IoTEventsData) BatchResetAlarmRequest(input *BatchResetAlarmInput) (req *request.Request, output *BatchResetAlarmOutput)
func (c *IoTEventsData) BatchResetAlarmWithContext(ctx aws.Context, input *BatchResetAlarmInput, opts ...request.Option) (*BatchResetAlarmOutput, error)
func (c *IoTEventsData) BatchSnoozeAlarm(input *BatchSnoozeAlarmInput) (*BatchSnoozeAlarmOutput, error)
func (c *IoTEventsData) BatchSnoozeAlarmRequest(input *BatchSnoozeAlarmInput) (req *request.Request, output *BatchSnoozeAlarmOutput)
func (c *IoTEventsData) BatchSnoozeAlarmWithContext(ctx aws.Context, input *BatchSnoozeAlarmInput, opts ...request.Option) (*BatchSnoozeAlarmOutput, error)
func (c *IoTEventsData) BatchUpdateDetector(input *BatchUpdateDetectorInput) (*BatchUpdateDetectorOutput, error)
func (c *IoTEventsData) BatchUpdateDetectorRequest(input *BatchUpdateDetectorInput) (req *request.Request, output *BatchUpdateDetectorOutput)
func (c *IoTEventsData) BatchUpdateDetectorWithContext(ctx aws.Context, input *BatchUpdateDetectorInput, opts ...request.Option) (*BatchUpdateDetectorOutput, error)
func (c *IoTEventsData) DescribeAlarm(input *DescribeAlarmInput) (*DescribeAlarmOutput, error)
func (c *IoTEventsData) DescribeAlarmRequest(input *DescribeAlarmInput) (req *request.Request, output *DescribeAlarmOutput)
func (c *IoTEventsData) DescribeAlarmWithContext(ctx aws.Context, input *DescribeAlarmInput, opts ...request.Option) (*DescribeAlarmOutput, error)
func (c *IoTEventsData) DescribeDetector(input *DescribeDetectorInput) (*DescribeDetectorOutput, error)
func (c *IoTEventsData) DescribeDetectorRequest(input *DescribeDetectorInput) (req *request.Request, output *DescribeDetectorOutput)
func (c *IoTEventsData) DescribeDetectorWithContext(ctx aws.Context, input *DescribeDetectorInput, opts ...request.Option) (*DescribeDetectorOutput, error)
func (c *IoTEventsData) ListAlarms(input *ListAlarmsInput) (*ListAlarmsOutput, error)
func (c *IoTEventsData) ListAlarmsRequest(input *ListAlarmsInput) (req *request.Request, output *ListAlarmsOutput)
func (c *IoTEventsData) ListAlarmsWithContext(ctx aws.Context, input *ListAlarmsInput, opts ...request.Option) (*ListAlarmsOutput, error)
func (c *IoTEventsData) ListDetectors(input *ListDetectorsInput) (*ListDetectorsOutput, error)
func (c *IoTEventsData) ListDetectorsRequest(input *ListDetectorsInput) (req *request.Request, output *ListDetectorsOutput)
func (c *IoTEventsData) ListDetectorsWithContext(ctx aws.Context, input *ListDetectorsInput, opts ...request.Option) (*ListDetectorsOutput, error)
func AlarmStateName_Values() []string
func ComparisonOperator_Values() []string
func CustomerActionName_Values() []string
func ErrorCode_Values() []string
func EventType_Values() []string
func TriggerType_Values() []string
type AcknowledgeActionConfiguration
type AcknowledgeAlarmActionRequest
type Alarm
type AlarmState
type AlarmSummary
type BatchAcknowledgeAlarmInput
type BatchAcknowledgeAlarmOutput
type BatchAlarmActionErrorEntry
type BatchDisableAlarmInput
type BatchDisableAlarmOutput
type BatchEnableAlarmInput
type BatchEnableAlarmOutput
type BatchPutMessageErrorEntry
type BatchPutMessageInput
type BatchPutMessageOutput
type BatchResetAlarmInput
type BatchResetAlarmOutput
type BatchSnoozeAlarmInput
type BatchSnoozeAlarmOutput
type BatchUpdateDetectorErrorEntry
type BatchUpdateDetectorInput
type BatchUpdateDetectorOutput
type CustomerAction
type DescribeAlarmInput
type DescribeAlarmOutput
type DescribeDetectorInput
type DescribeDetectorOutput
type Detector
type DetectorState
type DetectorStateDefinition
type DetectorStateSummary
type DetectorSummary
type DisableActionConfiguration
type DisableAlarmActionRequest
type EnableActionConfiguration
type EnableAlarmActionRequest
type InternalFailureException
type InvalidRequestException
type ListAlarmsInput
type ListAlarmsOutput
type ListDetectorsInput
type ListDetectorsOutput
type Message
type ResetActionConfiguration
type ResetAlarmActionRequest
type ResourceNotFoundException
type RuleEvaluation
type ServiceUnavailableException
type SimpleRuleEvaluation
type SnoozeActionConfiguration
type SnoozeAlarmActionRequest
type StateChangeConfiguration
type SystemEvent
type ThrottlingException
type Timer
type TimerDefinition
type TimestampValue
type UpdateDetectorRequest
type Variable
type VariableDefinition

Constants ▾

const (
    // AlarmStateNameDisabled is a AlarmStateName enum value
    AlarmStateNameDisabled = "DISABLED"

    // AlarmStateNameNormal is a AlarmStateName enum value
    AlarmStateNameNormal = "NORMAL"

    // AlarmStateNameActive is a AlarmStateName enum value
    AlarmStateNameActive = "ACTIVE"

    // AlarmStateNameAcknowledged is a AlarmStateName enum value
    AlarmStateNameAcknowledged = "ACKNOWLEDGED"

    // AlarmStateNameSnoozeDisabled is a AlarmStateName enum value
    AlarmStateNameSnoozeDisabled = "SNOOZE_DISABLED"

    // AlarmStateNameLatched is a AlarmStateName enum value
    AlarmStateNameLatched = "LATCHED"
)
const (
    // ComparisonOperatorGreater is a ComparisonOperator enum value
    ComparisonOperatorGreater = "GREATER"

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

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

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

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

    // ComparisonOperatorNotEqual is a ComparisonOperator enum value
    ComparisonOperatorNotEqual = "NOT_EQUAL"
)
const (
    // CustomerActionNameSnooze is a CustomerActionName enum value
    CustomerActionNameSnooze = "SNOOZE"

    // CustomerActionNameEnable is a CustomerActionName enum value
    CustomerActionNameEnable = "ENABLE"

    // CustomerActionNameDisable is a CustomerActionName enum value
    CustomerActionNameDisable = "DISABLE"

    // CustomerActionNameAcknowledge is a CustomerActionName enum value
    CustomerActionNameAcknowledge = "ACKNOWLEDGE"

    // CustomerActionNameReset is a CustomerActionName enum value
    CustomerActionNameReset = "RESET"
)
const (
    // ErrorCodeResourceNotFoundException is a ErrorCode enum value
    ErrorCodeResourceNotFoundException = "ResourceNotFoundException"

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

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

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

    // ErrorCodeThrottlingException is a ErrorCode enum value
    ErrorCodeThrottlingException = "ThrottlingException"
)
const (

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

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

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    //
    // The resource was not found.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"

    // ErrCodeServiceUnavailableException for service response error code
    // "ServiceUnavailableException".
    //
    // The service is currently unavailable.
    ErrCodeServiceUnavailableException = "ServiceUnavailableException"

    // ErrCodeThrottlingException for service response error code
    // "ThrottlingException".
    //
    // The request could not be completed due to throttling.
    ErrCodeThrottlingException = "ThrottlingException"
)
const (
    ServiceName = "IoT Events Data" // Name of service.
    EndpointsID = "data.iotevents"  // ID to lookup a service endpoint with.
    ServiceID   = "IoT Events Data" // ServiceID is a unique identifier of a specific service.
)

Service information constants

const (
    // EventTypeStateChange is a EventType enum value
    EventTypeStateChange = "STATE_CHANGE"
)
const (
    // TriggerTypeSnoozeTimeout is a TriggerType enum value
    TriggerTypeSnoozeTimeout = "SNOOZE_TIMEOUT"
)

func AlarmStateName_Values

func AlarmStateName_Values() []string

AlarmStateName_Values returns all elements of the AlarmStateName enum

func ComparisonOperator_Values

func ComparisonOperator_Values() []string

ComparisonOperator_Values returns all elements of the ComparisonOperator enum

func CustomerActionName_Values

func CustomerActionName_Values() []string

CustomerActionName_Values returns all elements of the CustomerActionName enum

func ErrorCode_Values

func ErrorCode_Values() []string

ErrorCode_Values returns all elements of the ErrorCode enum

func EventType_Values

func EventType_Values() []string

EventType_Values returns all elements of the EventType enum

func TriggerType_Values

func TriggerType_Values() []string

TriggerType_Values returns all elements of the TriggerType enum

type AcknowledgeActionConfiguration

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

func (s AcknowledgeActionConfiguration) GoString() string

GoString returns the string representation

func (*AcknowledgeActionConfiguration) SetNote

func (s *AcknowledgeActionConfiguration) SetNote(v string) *AcknowledgeActionConfiguration

SetNote sets the Note field's value.

func (AcknowledgeActionConfiguration) String

func (s AcknowledgeActionConfiguration) String() string

String returns the string representation

type AcknowledgeAlarmActionRequest

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

func (s AcknowledgeAlarmActionRequest) GoString() string

GoString returns the string representation

func (*AcknowledgeAlarmActionRequest) SetAlarmModelName

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

SetAlarmModelName sets the AlarmModelName field's value.

func (*AcknowledgeAlarmActionRequest) SetKeyValue

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

SetKeyValue sets the KeyValue field's value.

func (*AcknowledgeAlarmActionRequest) SetNote

func (s *AcknowledgeAlarmActionRequest) SetNote(v string) *AcknowledgeAlarmActionRequest

SetNote sets the Note field's value.

func (*AcknowledgeAlarmActionRequest) SetRequestId

func (s *AcknowledgeAlarmActionRequest) SetRequestId(v string) *AcknowledgeAlarmActionRequest

SetRequestId sets the RequestId field's value.

func (AcknowledgeAlarmActionRequest) String

func (s AcknowledgeAlarmActionRequest) String() string

String returns the string representation

func (*AcknowledgeAlarmActionRequest) Validate

func (s *AcknowledgeAlarmActionRequest) Validate() error

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

type Alarm

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

func (s Alarm) GoString() string

GoString returns the string representation

func (*Alarm) SetAlarmModelName

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

SetAlarmModelName sets the AlarmModelName field's value.

func (*Alarm) SetAlarmModelVersion

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

SetAlarmModelVersion sets the AlarmModelVersion field's value.

func (*Alarm) SetAlarmState

func (s *Alarm) SetAlarmState(v *AlarmState) *Alarm

SetAlarmState sets the AlarmState field's value.

func (*Alarm) SetCreationTime

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

SetCreationTime sets the CreationTime field's value.

func (*Alarm) SetKeyValue

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

SetKeyValue sets the KeyValue field's value.

func (*Alarm) SetLastUpdateTime

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

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*Alarm) SetSeverity

func (s *Alarm) SetSeverity(v int64) *Alarm

SetSeverity sets the Severity field's value.

func (Alarm) String

func (s Alarm) String() string

String returns the string representation

type AlarmState

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

func (s AlarmState) GoString() string

GoString returns the string representation

func (*AlarmState) SetCustomerAction

func (s *AlarmState) SetCustomerAction(v *CustomerAction) *AlarmState

SetCustomerAction sets the CustomerAction field's value.

func (*AlarmState) SetRuleEvaluation

func (s *AlarmState) SetRuleEvaluation(v *RuleEvaluation) *AlarmState

SetRuleEvaluation sets the RuleEvaluation field's value.

func (*AlarmState) SetStateName

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

SetStateName sets the StateName field's value.

func (*AlarmState) SetSystemEvent

func (s *AlarmState) SetSystemEvent(v *SystemEvent) *AlarmState

SetSystemEvent sets the SystemEvent field's value.

func (AlarmState) String

func (s AlarmState) String() string

String returns the string representation

type AlarmSummary

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

func (s AlarmSummary) GoString() string

GoString returns the string representation

func (*AlarmSummary) SetAlarmModelName

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

SetAlarmModelName sets the AlarmModelName field's value.

func (*AlarmSummary) SetAlarmModelVersion

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

SetAlarmModelVersion sets the AlarmModelVersion field's value.

func (*AlarmSummary) SetCreationTime

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

SetCreationTime sets the CreationTime field's value.

func (*AlarmSummary) SetKeyValue

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

SetKeyValue sets the KeyValue field's value.

func (*AlarmSummary) SetLastUpdateTime

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

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*AlarmSummary) SetStateName

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

SetStateName sets the StateName field's value.

func (AlarmSummary) String

func (s AlarmSummary) String() string

String returns the string representation

type BatchAcknowledgeAlarmInput

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

func (s BatchAcknowledgeAlarmInput) GoString() string

GoString returns the string representation

func (*BatchAcknowledgeAlarmInput) SetAcknowledgeActionRequests

func (s *BatchAcknowledgeAlarmInput) SetAcknowledgeActionRequests(v []*AcknowledgeAlarmActionRequest) *BatchAcknowledgeAlarmInput

SetAcknowledgeActionRequests sets the AcknowledgeActionRequests field's value.

func (BatchAcknowledgeAlarmInput) String

func (s BatchAcknowledgeAlarmInput) String() string

String returns the string representation

func (*BatchAcknowledgeAlarmInput) Validate

func (s *BatchAcknowledgeAlarmInput) Validate() error

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

type BatchAcknowledgeAlarmOutput

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

func (s BatchAcknowledgeAlarmOutput) GoString() string

GoString returns the string representation

func (*BatchAcknowledgeAlarmOutput) SetErrorEntries

func (s *BatchAcknowledgeAlarmOutput) SetErrorEntries(v []*BatchAlarmActionErrorEntry) *BatchAcknowledgeAlarmOutput

SetErrorEntries sets the ErrorEntries field's value.

func (BatchAcknowledgeAlarmOutput) String

func (s BatchAcknowledgeAlarmOutput) String() string

String returns the string representation

type BatchAlarmActionErrorEntry

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

func (s BatchAlarmActionErrorEntry) GoString() string

GoString returns the string representation

func (*BatchAlarmActionErrorEntry) SetErrorCode

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

SetErrorCode sets the ErrorCode field's value.

func (*BatchAlarmActionErrorEntry) SetErrorMessage

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

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchAlarmActionErrorEntry) SetRequestId

func (s *BatchAlarmActionErrorEntry) SetRequestId(v string) *BatchAlarmActionErrorEntry

SetRequestId sets the RequestId field's value.

func (BatchAlarmActionErrorEntry) String

func (s BatchAlarmActionErrorEntry) String() string

String returns the string representation

type BatchDisableAlarmInput

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

func (s BatchDisableAlarmInput) GoString() string

GoString returns the string representation

func (*BatchDisableAlarmInput) SetDisableActionRequests

func (s *BatchDisableAlarmInput) SetDisableActionRequests(v []*DisableAlarmActionRequest) *BatchDisableAlarmInput

SetDisableActionRequests sets the DisableActionRequests field's value.

func (BatchDisableAlarmInput) String

func (s BatchDisableAlarmInput) String() string

String returns the string representation

func (*BatchDisableAlarmInput) Validate

func (s *BatchDisableAlarmInput) Validate() error

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

type BatchDisableAlarmOutput

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

func (s BatchDisableAlarmOutput) GoString() string

GoString returns the string representation

func (*BatchDisableAlarmOutput) SetErrorEntries

func (s *BatchDisableAlarmOutput) SetErrorEntries(v []*BatchAlarmActionErrorEntry) *BatchDisableAlarmOutput

SetErrorEntries sets the ErrorEntries field's value.

func (BatchDisableAlarmOutput) String

func (s BatchDisableAlarmOutput) String() string

String returns the string representation

type BatchEnableAlarmInput

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

func (s BatchEnableAlarmInput) GoString() string

GoString returns the string representation

func (*BatchEnableAlarmInput) SetEnableActionRequests

func (s *BatchEnableAlarmInput) SetEnableActionRequests(v []*EnableAlarmActionRequest) *BatchEnableAlarmInput

SetEnableActionRequests sets the EnableActionRequests field's value.

func (BatchEnableAlarmInput) String

func (s BatchEnableAlarmInput) String() string

String returns the string representation

func (*BatchEnableAlarmInput) Validate

func (s *BatchEnableAlarmInput) Validate() error

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

type BatchEnableAlarmOutput

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

func (s BatchEnableAlarmOutput) GoString() string

GoString returns the string representation

func (*BatchEnableAlarmOutput) SetErrorEntries

func (s *BatchEnableAlarmOutput) SetErrorEntries(v []*BatchAlarmActionErrorEntry) *BatchEnableAlarmOutput

SetErrorEntries sets the ErrorEntries field's value.

func (BatchEnableAlarmOutput) String

func (s BatchEnableAlarmOutput) String() string

String returns the string representation

type BatchPutMessageErrorEntry

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

func (s BatchPutMessageErrorEntry) GoString() string

GoString returns the string representation

func (*BatchPutMessageErrorEntry) SetErrorCode

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

SetErrorCode sets the ErrorCode field's value.

func (*BatchPutMessageErrorEntry) SetErrorMessage

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

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchPutMessageErrorEntry) SetMessageId

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

SetMessageId sets the MessageId field's value.

func (BatchPutMessageErrorEntry) String

func (s BatchPutMessageErrorEntry) String() string

String returns the string representation

type BatchPutMessageInput

type BatchPutMessageInput struct {

    // The list of messages to send. Each message has the following format: '{ "messageId":
    // "string", "inputName": "string", "payload": "string"}'
    //
    // Messages is a required field
    Messages []*Message `locationName:"messages" min:"1" type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (BatchPutMessageInput) GoString

func (s BatchPutMessageInput) GoString() string

GoString returns the string representation

func (*BatchPutMessageInput) SetMessages

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

SetMessages sets the Messages field's value.

func (BatchPutMessageInput) String

func (s BatchPutMessageInput) String() string

String returns the string representation

func (*BatchPutMessageInput) Validate

func (s *BatchPutMessageInput) Validate() error

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

type BatchPutMessageOutput

type BatchPutMessageOutput struct {

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

func (BatchPutMessageOutput) GoString

func (s BatchPutMessageOutput) GoString() string

GoString returns the string representation

func (*BatchPutMessageOutput) SetBatchPutMessageErrorEntries

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

SetBatchPutMessageErrorEntries sets the BatchPutMessageErrorEntries field's value.

func (BatchPutMessageOutput) String

func (s BatchPutMessageOutput) String() string

String returns the string representation

type BatchResetAlarmInput

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

func (s BatchResetAlarmInput) GoString() string

GoString returns the string representation

func (*BatchResetAlarmInput) SetResetActionRequests

func (s *BatchResetAlarmInput) SetResetActionRequests(v []*ResetAlarmActionRequest) *BatchResetAlarmInput

SetResetActionRequests sets the ResetActionRequests field's value.

func (BatchResetAlarmInput) String

func (s BatchResetAlarmInput) String() string

String returns the string representation

func (*BatchResetAlarmInput) Validate

func (s *BatchResetAlarmInput) Validate() error

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

type BatchResetAlarmOutput

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

func (s BatchResetAlarmOutput) GoString() string

GoString returns the string representation

func (*BatchResetAlarmOutput) SetErrorEntries

func (s *BatchResetAlarmOutput) SetErrorEntries(v []*BatchAlarmActionErrorEntry) *BatchResetAlarmOutput

SetErrorEntries sets the ErrorEntries field's value.

func (BatchResetAlarmOutput) String

func (s BatchResetAlarmOutput) String() string

String returns the string representation

type BatchSnoozeAlarmInput

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

func (s BatchSnoozeAlarmInput) GoString() string

GoString returns the string representation

func (*BatchSnoozeAlarmInput) SetSnoozeActionRequests

func (s *BatchSnoozeAlarmInput) SetSnoozeActionRequests(v []*SnoozeAlarmActionRequest) *BatchSnoozeAlarmInput

SetSnoozeActionRequests sets the SnoozeActionRequests field's value.

func (BatchSnoozeAlarmInput) String

func (s BatchSnoozeAlarmInput) String() string

String returns the string representation

func (*BatchSnoozeAlarmInput) Validate

func (s *BatchSnoozeAlarmInput) Validate() error

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

type BatchSnoozeAlarmOutput

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

func (s BatchSnoozeAlarmOutput) GoString() string

GoString returns the string representation

func (*BatchSnoozeAlarmOutput) SetErrorEntries

func (s *BatchSnoozeAlarmOutput) SetErrorEntries(v []*BatchAlarmActionErrorEntry) *BatchSnoozeAlarmOutput

SetErrorEntries sets the ErrorEntries field's value.

func (BatchSnoozeAlarmOutput) String

func (s BatchSnoozeAlarmOutput) String() string

String returns the string representation

type BatchUpdateDetectorErrorEntry

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

func (s BatchUpdateDetectorErrorEntry) GoString() string

GoString returns the string representation

func (*BatchUpdateDetectorErrorEntry) SetErrorCode

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

SetErrorCode sets the ErrorCode field's value.

func (*BatchUpdateDetectorErrorEntry) SetErrorMessage

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

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchUpdateDetectorErrorEntry) SetMessageId

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

SetMessageId sets the MessageId field's value.

func (BatchUpdateDetectorErrorEntry) String

func (s BatchUpdateDetectorErrorEntry) String() string

String returns the string representation

type BatchUpdateDetectorInput

type BatchUpdateDetectorInput struct {

    // The list of detectors (instances) to update, along with the values to update.
    //
    // Detectors is a required field
    Detectors []*UpdateDetectorRequest `locationName:"detectors" min:"1" type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (BatchUpdateDetectorInput) GoString

func (s BatchUpdateDetectorInput) GoString() string

GoString returns the string representation

func (*BatchUpdateDetectorInput) SetDetectors

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

SetDetectors sets the Detectors field's value.

func (BatchUpdateDetectorInput) String

func (s BatchUpdateDetectorInput) String() string

String returns the string representation

func (*BatchUpdateDetectorInput) Validate

func (s *BatchUpdateDetectorInput) Validate() error

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

type BatchUpdateDetectorOutput

type BatchUpdateDetectorOutput struct {

    // A list of those detector updates that resulted in errors. (If an error is
    // listed here, the specific update did not occur.)
    BatchUpdateDetectorErrorEntries []*BatchUpdateDetectorErrorEntry `locationName:"batchUpdateDetectorErrorEntries" type:"list"`
    // contains filtered or unexported fields
}

func (BatchUpdateDetectorOutput) GoString

func (s BatchUpdateDetectorOutput) GoString() string

GoString returns the string representation

func (*BatchUpdateDetectorOutput) SetBatchUpdateDetectorErrorEntries

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

SetBatchUpdateDetectorErrorEntries sets the BatchUpdateDetectorErrorEntries field's value.

func (BatchUpdateDetectorOutput) String

func (s BatchUpdateDetectorOutput) String() string

String returns the string representation

type CustomerAction

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

func (s CustomerAction) GoString() string

GoString returns the string representation

func (*CustomerAction) SetAcknowledgeActionConfiguration

func (s *CustomerAction) SetAcknowledgeActionConfiguration(v *AcknowledgeActionConfiguration) *CustomerAction

SetAcknowledgeActionConfiguration sets the AcknowledgeActionConfiguration field's value.

func (*CustomerAction) SetActionName

func (s *CustomerAction) SetActionName(v string) *CustomerAction

SetActionName sets the ActionName field's value.

func (*CustomerAction) SetDisableActionConfiguration

func (s *CustomerAction) SetDisableActionConfiguration(v *DisableActionConfiguration) *CustomerAction

SetDisableActionConfiguration sets the DisableActionConfiguration field's value.

func (*CustomerAction) SetEnableActionConfiguration

func (s *CustomerAction) SetEnableActionConfiguration(v *EnableActionConfiguration) *CustomerAction

SetEnableActionConfiguration sets the EnableActionConfiguration field's value.

func (*CustomerAction) SetResetActionConfiguration

func (s *CustomerAction) SetResetActionConfiguration(v *ResetActionConfiguration) *CustomerAction

SetResetActionConfiguration sets the ResetActionConfiguration field's value.

func (*CustomerAction) SetSnoozeActionConfiguration

func (s *CustomerAction) SetSnoozeActionConfiguration(v *SnoozeActionConfiguration) *CustomerAction

SetSnoozeActionConfiguration sets the SnoozeActionConfiguration field's value.

func (CustomerAction) String

func (s CustomerAction) String() string

String returns the string representation

type DescribeAlarmInput

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

func (s DescribeAlarmInput) GoString() string

GoString returns the string representation

func (*DescribeAlarmInput) SetAlarmModelName

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

SetAlarmModelName sets the AlarmModelName field's value.

func (*DescribeAlarmInput) SetKeyValue

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

SetKeyValue sets the KeyValue field's value.

func (DescribeAlarmInput) String

func (s DescribeAlarmInput) String() string

String returns the string representation

func (*DescribeAlarmInput) Validate

func (s *DescribeAlarmInput) Validate() error

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

type DescribeAlarmOutput

type DescribeAlarmOutput struct {

    // Contains information about an alarm.
    Alarm *Alarm `locationName:"alarm" type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeAlarmOutput) GoString

func (s DescribeAlarmOutput) GoString() string

GoString returns the string representation

func (*DescribeAlarmOutput) SetAlarm

func (s *DescribeAlarmOutput) SetAlarm(v *Alarm) *DescribeAlarmOutput

SetAlarm sets the Alarm field's value.

func (DescribeAlarmOutput) String

func (s DescribeAlarmOutput) String() string

String returns the string representation

type DescribeDetectorInput

type DescribeDetectorInput struct {

    // The name of the detector model whose detectors (instances) you want information
    // about.
    //
    // DetectorModelName is a required field
    DetectorModelName *string `location:"uri" locationName:"detectorModelName" min:"1" type:"string" required:"true"`

    // A filter used to limit results to detectors (instances) created because of
    // the given key ID.
    KeyValue *string `location:"querystring" locationName:"keyValue" min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (DescribeDetectorInput) GoString

func (s DescribeDetectorInput) GoString() string

GoString returns the string representation

func (*DescribeDetectorInput) SetDetectorModelName

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

SetDetectorModelName sets the DetectorModelName field's value.

func (*DescribeDetectorInput) SetKeyValue

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

SetKeyValue sets the KeyValue field's value.

func (DescribeDetectorInput) String

func (s DescribeDetectorInput) String() string

String returns the string representation

func (*DescribeDetectorInput) Validate

func (s *DescribeDetectorInput) Validate() error

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

type DescribeDetectorOutput

type DescribeDetectorOutput struct {

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

func (DescribeDetectorOutput) GoString

func (s DescribeDetectorOutput) GoString() string

GoString returns the string representation

func (*DescribeDetectorOutput) SetDetector

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

SetDetector sets the Detector field's value.

func (DescribeDetectorOutput) String

func (s DescribeDetectorOutput) String() string

String returns the string representation

type Detector

type Detector struct {

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

    // The name of the detector model that created this detector (instance).
    DetectorModelName *string `locationName:"detectorModelName" min:"1" type:"string"`

    // The version of the detector model that created this detector (instance).
    DetectorModelVersion *string `locationName:"detectorModelVersion" min:"1" type:"string"`

    // The value of the key (identifying the device or system) that caused the creation
    // of this detector (instance).
    KeyValue *string `locationName:"keyValue" min:"1" type:"string"`

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

    // The current state of the detector (instance).
    State *DetectorState `locationName:"state" type:"structure"`
    // contains filtered or unexported fields
}

Information about the detector (instance).

func (Detector) GoString

func (s Detector) GoString() string

GoString returns the string representation

func (*Detector) SetCreationTime

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

SetCreationTime sets the CreationTime field's value.

func (*Detector) SetDetectorModelName

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

SetDetectorModelName sets the DetectorModelName field's value.

func (*Detector) SetDetectorModelVersion

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

SetDetectorModelVersion sets the DetectorModelVersion field's value.

func (*Detector) SetKeyValue

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

SetKeyValue sets the KeyValue field's value.

func (*Detector) SetLastUpdateTime

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

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*Detector) SetState

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

SetState sets the State field's value.

func (Detector) String

func (s Detector) String() string

String returns the string representation

type DetectorState

type DetectorState struct {

    // The name of the state.
    //
    // StateName is a required field
    StateName *string `locationName:"stateName" min:"1" type:"string" required:"true"`

    // The current state of the detector's timers.
    //
    // Timers is a required field
    Timers []*Timer `locationName:"timers" type:"list" required:"true"`

    // The current values of the detector's variables.
    //
    // Variables is a required field
    Variables []*Variable `locationName:"variables" type:"list" required:"true"`
    // contains filtered or unexported fields
}

Information about the current state of the detector instance.

func (DetectorState) GoString

func (s DetectorState) GoString() string

GoString returns the string representation

func (*DetectorState) SetStateName

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

SetStateName sets the StateName field's value.

func (*DetectorState) SetTimers

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

SetTimers sets the Timers field's value.

func (*DetectorState) SetVariables

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

SetVariables sets the Variables field's value.

func (DetectorState) String

func (s DetectorState) String() string

String returns the string representation

type DetectorStateDefinition

type DetectorStateDefinition struct {

    // The name of the new state of the detector (instance).
    //
    // StateName is a required field
    StateName *string `locationName:"stateName" min:"1" type:"string" required:"true"`

    // The new values of the detector's timers. Any timer whose value isn't specified
    // is cleared, and its timeout event won't occur.
    //
    // Timers is a required field
    Timers []*TimerDefinition `locationName:"timers" type:"list" required:"true"`

    // The new values of the detector's variables. Any variable whose value isn't
    // specified is cleared.
    //
    // Variables is a required field
    Variables []*VariableDefinition `locationName:"variables" type:"list" required:"true"`
    // contains filtered or unexported fields
}

The new state, variable values, and timer settings of the detector (instance).

func (DetectorStateDefinition) GoString

func (s DetectorStateDefinition) GoString() string

GoString returns the string representation

func (*DetectorStateDefinition) SetStateName

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

SetStateName sets the StateName field's value.

func (*DetectorStateDefinition) SetTimers

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

SetTimers sets the Timers field's value.

func (*DetectorStateDefinition) SetVariables

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

SetVariables sets the Variables field's value.

func (DetectorStateDefinition) String

func (s DetectorStateDefinition) String() string

String returns the string representation

func (*DetectorStateDefinition) Validate

func (s *DetectorStateDefinition) Validate() error

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

type DetectorStateSummary

type DetectorStateSummary struct {

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

Information about the detector state.

func (DetectorStateSummary) GoString

func (s DetectorStateSummary) GoString() string

GoString returns the string representation

func (*DetectorStateSummary) SetStateName

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

SetStateName sets the StateName field's value.

func (DetectorStateSummary) String

func (s DetectorStateSummary) String() string

String returns the string representation

type DetectorSummary

type DetectorSummary struct {

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

    // The name of the detector model that created this detector (instance).
    DetectorModelName *string `locationName:"detectorModelName" min:"1" type:"string"`

    // The version of the detector model that created this detector (instance).
    DetectorModelVersion *string `locationName:"detectorModelVersion" min:"1" type:"string"`

    // The value of the key (identifying the device or system) that caused the creation
    // of this detector (instance).
    KeyValue *string `locationName:"keyValue" min:"1" type:"string"`

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

    // The current state of the detector (instance).
    State *DetectorStateSummary `locationName:"state" type:"structure"`
    // contains filtered or unexported fields
}

Information about the detector (instance).

func (DetectorSummary) GoString

func (s DetectorSummary) GoString() string

GoString returns the string representation

func (*DetectorSummary) SetCreationTime

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

SetCreationTime sets the CreationTime field's value.

func (*DetectorSummary) SetDetectorModelName

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

SetDetectorModelName sets the DetectorModelName field's value.

func (*DetectorSummary) SetDetectorModelVersion

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

SetDetectorModelVersion sets the DetectorModelVersion field's value.

func (*DetectorSummary) SetKeyValue

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

SetKeyValue sets the KeyValue field's value.

func (*DetectorSummary) SetLastUpdateTime

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

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*DetectorSummary) SetState

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

SetState sets the State field's value.

func (DetectorSummary) String

func (s DetectorSummary) String() string

String returns the string representation

type DisableActionConfiguration

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

func (s DisableActionConfiguration) GoString() string

GoString returns the string representation

func (*DisableActionConfiguration) SetNote

func (s *DisableActionConfiguration) SetNote(v string) *DisableActionConfiguration

SetNote sets the Note field's value.

func (DisableActionConfiguration) String

func (s DisableActionConfiguration) String() string

String returns the string representation

type DisableAlarmActionRequest

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

func (s DisableAlarmActionRequest) GoString() string

GoString returns the string representation

func (*DisableAlarmActionRequest) SetAlarmModelName

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

SetAlarmModelName sets the AlarmModelName field's value.

func (*DisableAlarmActionRequest) SetKeyValue

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

SetKeyValue sets the KeyValue field's value.

func (*DisableAlarmActionRequest) SetNote

func (s *DisableAlarmActionRequest) SetNote(v string) *DisableAlarmActionRequest

SetNote sets the Note field's value.

func (*DisableAlarmActionRequest) SetRequestId

func (s *DisableAlarmActionRequest) SetRequestId(v string) *DisableAlarmActionRequest

SetRequestId sets the RequestId field's value.

func (DisableAlarmActionRequest) String

func (s DisableAlarmActionRequest) String() string

String returns the string representation

func (*DisableAlarmActionRequest) Validate

func (s *DisableAlarmActionRequest) Validate() error

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

type EnableActionConfiguration

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

func (s EnableActionConfiguration) GoString() string

GoString returns the string representation

func (*EnableActionConfiguration) SetNote

func (s *EnableActionConfiguration) SetNote(v string) *EnableActionConfiguration

SetNote sets the Note field's value.

func (EnableActionConfiguration) String

func (s EnableActionConfiguration) String() string

String returns the string representation

type EnableAlarmActionRequest

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

func (s EnableAlarmActionRequest) GoString() string

GoString returns the string representation

func (*EnableAlarmActionRequest) SetAlarmModelName

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

SetAlarmModelName sets the AlarmModelName field's value.

func (*EnableAlarmActionRequest) SetKeyValue

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

SetKeyValue sets the KeyValue field's value.

func (*EnableAlarmActionRequest) SetNote

func (s *EnableAlarmActionRequest) SetNote(v string) *EnableAlarmActionRequest

SetNote sets the Note field's value.

func (*EnableAlarmActionRequest) SetRequestId

func (s *EnableAlarmActionRequest) SetRequestId(v string) *EnableAlarmActionRequest

SetRequestId sets the RequestId field's value.

func (EnableAlarmActionRequest) String

func (s EnableAlarmActionRequest) String() string

String returns the string representation

func (*EnableAlarmActionRequest) Validate

func (s *EnableAlarmActionRequest) Validate() error

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

type InternalFailureException

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

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

An internal failure occurred.

func (*InternalFailureException) Code

func (s *InternalFailureException) Code() string

Code returns the exception type name.

func (*InternalFailureException) Error

func (s *InternalFailureException) Error() string

func (InternalFailureException) GoString

func (s InternalFailureException) GoString() string

GoString returns the string representation

func (*InternalFailureException) Message

func (s *InternalFailureException) Message() string

Message returns the exception's message.

func (*InternalFailureException) OrigErr

func (s *InternalFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalFailureException) RequestID

func (s *InternalFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailureException) StatusCode

func (s *InternalFailureException) StatusCode() int

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

func (InternalFailureException) String

func (s InternalFailureException) String() string

String returns the string representation

type InvalidRequestException

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

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

The request was invalid.

func (*InvalidRequestException) Code

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString

func (s InvalidRequestException) GoString() string

GoString returns the string representation

func (*InvalidRequestException) Message

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode

func (s *InvalidRequestException) StatusCode() int

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

func (InvalidRequestException) String

func (s InvalidRequestException) String() string

String returns the string representation

type IoTEventsData

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

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 (*IoTEventsData) BatchAcknowledgeAlarm

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.

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

func (*IoTEventsData) BatchAcknowledgeAlarmRequest

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

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

func (*IoTEventsData) BatchAcknowledgeAlarmWithContext

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 (*IoTEventsData) BatchDisableAlarm

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.

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

func (*IoTEventsData) BatchDisableAlarmRequest

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

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

func (*IoTEventsData) BatchDisableAlarmWithContext

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 (*IoTEventsData) BatchEnableAlarm

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.

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

func (*IoTEventsData) BatchEnableAlarmRequest

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

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

func (*IoTEventsData) BatchEnableAlarmWithContext

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 (*IoTEventsData) BatchPutMessage

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

BatchPutMessage API operation for AWS IoT Events Data.

Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify ("inputName") and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response.

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

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

Returned Error 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.

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

func (*IoTEventsData) BatchPutMessageRequest

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

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

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

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

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

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

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

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

func (*IoTEventsData) BatchPutMessageWithContext

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

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

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

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

func (*IoTEventsData) BatchResetAlarm

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.

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

func (*IoTEventsData) BatchResetAlarmRequest

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

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

func (*IoTEventsData) BatchResetAlarmWithContext

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 (*IoTEventsData) BatchSnoozeAlarm

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.

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

func (*IoTEventsData) BatchSnoozeAlarmRequest

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

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

func (*IoTEventsData) BatchSnoozeAlarmWithContext

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 (*IoTEventsData) BatchUpdateDetector

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.

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

func (*IoTEventsData) BatchUpdateDetectorRequest

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

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

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

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

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

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

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

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

func (*IoTEventsData) BatchUpdateDetectorWithContext

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

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

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

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

func (*IoTEventsData) DescribeAlarm

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 (*IoTEventsData) DescribeAlarmRequest

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 (*IoTEventsData) DescribeAlarmWithContext

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 (*IoTEventsData) DescribeDetector

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.

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

func (*IoTEventsData) DescribeDetectorRequest

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

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

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

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

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

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

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

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

func (*IoTEventsData) DescribeDetectorWithContext

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

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

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

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

func (*IoTEventsData) ListAlarms

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 (*IoTEventsData) ListAlarmsRequest

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 (*IoTEventsData) ListAlarmsWithContext

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 (*IoTEventsData) ListDetectors

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 (*IoTEventsData) ListDetectorsRequest

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

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

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

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

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

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

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

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

func (*IoTEventsData) ListDetectorsWithContext

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

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

func (s ListAlarmsInput) GoString() string

GoString returns the string representation

func (*ListAlarmsInput) SetAlarmModelName

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

SetAlarmModelName sets the AlarmModelName field's value.

func (*ListAlarmsInput) SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

func (*ListAlarmsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListAlarmsInput) String

func (s ListAlarmsInput) String() string

String returns the string representation

func (*ListAlarmsInput) Validate

func (s *ListAlarmsInput) Validate() error

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

type ListAlarmsOutput

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

func (s ListAlarmsOutput) GoString() string

GoString returns the string representation

func (*ListAlarmsOutput) SetAlarmSummaries

func (s *ListAlarmsOutput) SetAlarmSummaries(v []*AlarmSummary) *ListAlarmsOutput

SetAlarmSummaries sets the AlarmSummaries field's value.

func (*ListAlarmsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListAlarmsOutput) String

func (s ListAlarmsOutput) String() string

String returns the string representation

type ListDetectorsInput

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

func (s ListDetectorsInput) GoString() string

GoString returns the string representation

func (*ListDetectorsInput) SetDetectorModelName

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

SetDetectorModelName sets the DetectorModelName field's value.

func (*ListDetectorsInput) SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

func (*ListDetectorsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListDetectorsInput) SetStateName

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

SetStateName sets the StateName field's value.

func (ListDetectorsInput) String

func (s ListDetectorsInput) String() string

String returns the string representation

func (*ListDetectorsInput) Validate

func (s *ListDetectorsInput) Validate() error

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

type ListDetectorsOutput

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

func (s ListDetectorsOutput) GoString() string

GoString returns the string representation

func (*ListDetectorsOutput) SetDetectorSummaries

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

SetDetectorSummaries sets the DetectorSummaries field's value.

func (*ListDetectorsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListDetectorsOutput) String

func (s ListDetectorsOutput) String() string

String returns the string representation

type Message

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

func (s Message) GoString() string

GoString returns the string representation

func (*Message) SetInputName

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

SetInputName sets the InputName field's value.

func (*Message) SetMessageId

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

SetMessageId sets the MessageId field's value.

func (*Message) SetPayload

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

SetPayload sets the Payload field's value.

func (*Message) SetTimestamp

func (s *Message) SetTimestamp(v *TimestampValue) *Message

SetTimestamp sets the Timestamp field's value.

func (Message) String

func (s Message) String() string

String returns the string representation

func (*Message) Validate

func (s *Message) Validate() error

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

type ResetActionConfiguration

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

func (s ResetActionConfiguration) GoString() string

GoString returns the string representation

func (*ResetActionConfiguration) SetNote

func (s *ResetActionConfiguration) SetNote(v string) *ResetActionConfiguration

SetNote sets the Note field's value.

func (ResetActionConfiguration) String

func (s ResetActionConfiguration) String() string

String returns the string representation

type ResetAlarmActionRequest

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

func (s ResetAlarmActionRequest) GoString() string

GoString returns the string representation

func (*ResetAlarmActionRequest) SetAlarmModelName

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

SetAlarmModelName sets the AlarmModelName field's value.

func (*ResetAlarmActionRequest) SetKeyValue

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

SetKeyValue sets the KeyValue field's value.

func (*ResetAlarmActionRequest) SetNote

func (s *ResetAlarmActionRequest) SetNote(v string) *ResetAlarmActionRequest

SetNote sets the Note field's value.

func (*ResetAlarmActionRequest) SetRequestId

func (s *ResetAlarmActionRequest) SetRequestId(v string) *ResetAlarmActionRequest

SetRequestId sets the RequestId field's value.

func (ResetAlarmActionRequest) String

func (s ResetAlarmActionRequest) String() string

String returns the string representation

func (*ResetAlarmActionRequest) Validate

func (s *ResetAlarmActionRequest) Validate() error

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

type ResourceNotFoundException

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

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

The resource was not found.

func (*ResourceNotFoundException) Code

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation

type RuleEvaluation

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

func (s RuleEvaluation) GoString() string

GoString returns the string representation

func (*RuleEvaluation) SetSimpleRuleEvaluation

func (s *RuleEvaluation) SetSimpleRuleEvaluation(v *SimpleRuleEvaluation) *RuleEvaluation

SetSimpleRuleEvaluation sets the SimpleRuleEvaluation field's value.

func (RuleEvaluation) String

func (s RuleEvaluation) String() string

String returns the string representation

type ServiceUnavailableException

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

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

The service is currently unavailable.

func (*ServiceUnavailableException) Code

func (s *ServiceUnavailableException) Code() string

Code returns the exception type name.

func (*ServiceUnavailableException) Error

func (s *ServiceUnavailableException) Error() string

func (ServiceUnavailableException) GoString

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation

func (*ServiceUnavailableException) Message

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode

func (s *ServiceUnavailableException) StatusCode() int

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

func (ServiceUnavailableException) String

func (s ServiceUnavailableException) String() string

String returns the string representation

type SimpleRuleEvaluation

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

func (s SimpleRuleEvaluation) GoString() string

GoString returns the string representation

func (*SimpleRuleEvaluation) SetInputPropertyValue

func (s *SimpleRuleEvaluation) SetInputPropertyValue(v string) *SimpleRuleEvaluation

SetInputPropertyValue sets the InputPropertyValue field's value.

func (*SimpleRuleEvaluation) SetOperator

func (s *SimpleRuleEvaluation) SetOperator(v string) *SimpleRuleEvaluation

SetOperator sets the Operator field's value.

func (*SimpleRuleEvaluation) SetThresholdValue

func (s *SimpleRuleEvaluation) SetThresholdValue(v string) *SimpleRuleEvaluation

SetThresholdValue sets the ThresholdValue field's value.

func (SimpleRuleEvaluation) String

func (s SimpleRuleEvaluation) String() string

String returns the string representation

type SnoozeActionConfiguration

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

func (s SnoozeActionConfiguration) GoString() string

GoString returns the string representation

func (*SnoozeActionConfiguration) SetNote

func (s *SnoozeActionConfiguration) SetNote(v string) *SnoozeActionConfiguration

SetNote sets the Note field's value.

func (*SnoozeActionConfiguration) SetSnoozeDuration

func (s *SnoozeActionConfiguration) SetSnoozeDuration(v int64) *SnoozeActionConfiguration

SetSnoozeDuration sets the SnoozeDuration field's value.

func (SnoozeActionConfiguration) String

func (s SnoozeActionConfiguration) String() string

String returns the string representation

type SnoozeAlarmActionRequest

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

func (s SnoozeAlarmActionRequest) GoString() string

GoString returns the string representation

func (*SnoozeAlarmActionRequest) SetAlarmModelName

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

SetAlarmModelName sets the AlarmModelName field's value.

func (*SnoozeAlarmActionRequest) SetKeyValue

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

SetKeyValue sets the KeyValue field's value.

func (*SnoozeAlarmActionRequest) SetNote

func (s *SnoozeAlarmActionRequest) SetNote(v string) *SnoozeAlarmActionRequest

SetNote sets the Note field's value.

func (*SnoozeAlarmActionRequest) SetRequestId

func (s *SnoozeAlarmActionRequest) SetRequestId(v string) *SnoozeAlarmActionRequest

SetRequestId sets the RequestId field's value.

func (*SnoozeAlarmActionRequest) SetSnoozeDuration

func (s *SnoozeAlarmActionRequest) SetSnoozeDuration(v int64) *SnoozeAlarmActionRequest

SetSnoozeDuration sets the SnoozeDuration field's value.

func (SnoozeAlarmActionRequest) String

func (s SnoozeAlarmActionRequest) String() string

String returns the string representation

func (*SnoozeAlarmActionRequest) Validate

func (s *SnoozeAlarmActionRequest) Validate() error

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

type StateChangeConfiguration

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

func (s StateChangeConfiguration) GoString() string

GoString returns the string representation

func (*StateChangeConfiguration) SetTriggerType

func (s *StateChangeConfiguration) SetTriggerType(v string) *StateChangeConfiguration

SetTriggerType sets the TriggerType field's value.

func (StateChangeConfiguration) String

func (s StateChangeConfiguration) String() string

String returns the string representation

type SystemEvent

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

func (s SystemEvent) GoString() string

GoString returns the string representation

func (*SystemEvent) SetEventType

func (s *SystemEvent) SetEventType(v string) *SystemEvent

SetEventType sets the EventType field's value.

func (*SystemEvent) SetStateChangeConfiguration

func (s *SystemEvent) SetStateChangeConfiguration(v *StateChangeConfiguration) *SystemEvent

SetStateChangeConfiguration sets the StateChangeConfiguration field's value.

func (SystemEvent) String

func (s SystemEvent) String() string

String returns the string representation

type ThrottlingException

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

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

The request could not be completed due to throttling.

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

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

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation

type Timer

type Timer struct {

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

    // The number of seconds which have elapsed on the timer.
    //
    // Timestamp is a required field
    Timestamp *time.Time `locationName:"timestamp" type:"timestamp" required:"true"`
    // contains filtered or unexported fields
}

The current state of a timer.

func (Timer) GoString

func (s Timer) GoString() string

GoString returns the string representation

func (*Timer) SetName

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

SetName sets the Name field's value.

func (*Timer) SetTimestamp

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

SetTimestamp sets the Timestamp field's value.

func (Timer) String

func (s Timer) String() string

String returns the string representation

type TimerDefinition

type TimerDefinition struct {

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

    // The new setting of the timer (the number of seconds before the timer elapses).
    //
    // Seconds is a required field
    Seconds *int64 `locationName:"seconds" type:"integer" required:"true"`
    // contains filtered or unexported fields
}

The new setting of a timer.

func (TimerDefinition) GoString

func (s TimerDefinition) GoString() string

GoString returns the string representation

func (*TimerDefinition) SetName

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

SetName sets the Name field's value.

func (*TimerDefinition) SetSeconds

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

SetSeconds sets the Seconds field's value.

func (TimerDefinition) String

func (s TimerDefinition) String() string

String returns the string representation

func (*TimerDefinition) Validate

func (s *TimerDefinition) Validate() error

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

type TimestampValue

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

func (s TimestampValue) GoString() string

GoString returns the string representation

func (*TimestampValue) SetTimeInMillis

func (s *TimestampValue) SetTimeInMillis(v int64) *TimestampValue

SetTimeInMillis sets the TimeInMillis field's value.

func (TimestampValue) String

func (s TimestampValue) String() string

String returns the string representation

func (*TimestampValue) Validate

func (s *TimestampValue) Validate() error

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

type UpdateDetectorRequest

type UpdateDetectorRequest struct {

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

    // The value of the input key attribute (identifying the device or system) that
    // caused the creation of this detector (instance).
    KeyValue *string `locationName:"keyValue" min:"1" type:"string"`

    // The ID to assign to the detector update "message". Each "messageId" must
    // be unique within each batch sent.
    //
    // MessageId is a required field
    MessageId *string `locationName:"messageId" min:"1" type:"string" required:"true"`

    // The new state, variable values, and timer settings of the detector (instance).
    //
    // State is a required field
    State *DetectorStateDefinition `locationName:"state" type:"structure" required:"true"`
    // contains filtered or unexported fields
}

Information used to update the detector (instance).

func (UpdateDetectorRequest) GoString

func (s UpdateDetectorRequest) GoString() string

GoString returns the string representation

func (*UpdateDetectorRequest) SetDetectorModelName

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

SetDetectorModelName sets the DetectorModelName field's value.

func (*UpdateDetectorRequest) SetKeyValue

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

SetKeyValue sets the KeyValue field's value.

func (*UpdateDetectorRequest) SetMessageId

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

SetMessageId sets the MessageId field's value.

func (*UpdateDetectorRequest) SetState

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

SetState sets the State field's value.

func (UpdateDetectorRequest) String

func (s UpdateDetectorRequest) String() string

String returns the string representation

func (*UpdateDetectorRequest) Validate

func (s *UpdateDetectorRequest) Validate() error

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

type Variable

type Variable struct {

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

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

The current state of the variable.

func (Variable) GoString

func (s Variable) GoString() string

GoString returns the string representation

func (*Variable) SetName

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

SetName sets the Name field's value.

func (*Variable) SetValue

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

SetValue sets the Value field's value.

func (Variable) String

func (s Variable) String() string

String returns the string representation

type VariableDefinition

type VariableDefinition struct {

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

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

The new value of the variable.

func (VariableDefinition) GoString

func (s VariableDefinition) GoString() string

GoString returns the string representation

func (*VariableDefinition) SetName

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

SetName sets the Name field's value.

func (*VariableDefinition) SetValue

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

SetValue sets the Value field's value.

func (VariableDefinition) String

func (s VariableDefinition) String() string

String returns the string representation

func (*VariableDefinition) Validate

func (s *VariableDefinition) Validate() error

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